require 'spec_helper'

describe Grape::Middleware::Formatter do
  subject{ Grape::Middleware::Formatter.new(app) }
  before{ subject.stub!(:dup).and_return(subject) }

  let(:app){ lambda{|env| [200, {}, [@body || { "foo" => "bar" }]]} }

  context 'serialization' do
    it 'looks at the bodies for possibly serializable data' do
      @body = {"abc" => "def"}
      status, headers, bodies = *subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'})
      bodies.each{|b| b.should == MultiJson.dump(@body) }
    end

    it 'calls #to_json since default format is json' do
      @body = ['foo']
      @body.instance_eval do
        def to_json
          "\"bar\""
        end
      end

      subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'}).last.each{|b| b.should == '"bar"'}
    end

    it 'calls #to_xml if the content type is xml' do
      @body = "string"
      @body.instance_eval do
        def to_xml
          "<bar/>"
        end
      end

      subject.call({'PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json'}).last.each{|b| b.should == '<bar/>'}
    end
  end

  context 'error handling' do
    let(:formatter) { stub(:formatter) }
    before do
      Grape::Formatter::Base.stub(:formatter_for) { formatter }
    end

    it 'rescues formatter-specific exceptions' do
      formatter.stub(:call) { raise Grape::Exceptions::InvalidFormatter.new(String, 'xml') }

      expect {
        catch(:error){subject.call({'PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json'})}
      }.to_not raise_error
    end

    it 'does not rescue other exceptions' do
      formatter.stub(:call) { raise StandardError }

      expect {
        catch(:error){subject.call({'PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json'})}
      }.to raise_error
    end
  end

  context 'detection' do

    it 'uses the extension if one is provided' do
      subject.call({'PATH_INFO' => '/info.xml'})
      subject.env['api.format'].should == :xml
      subject.call({'PATH_INFO' => '/info.json'})
      subject.env['api.format'].should == :json
    end

    it 'uses the format parameter if one is provided' do
      subject.call({'PATH_INFO' => '/info','QUERY_STRING' => 'format=json'})
      subject.env['api.format'].should == :json
      subject.call({'PATH_INFO' => '/info','QUERY_STRING' => 'format=xml'})
      subject.env['api.format'].should == :xml
    end

    it 'uses the default format if none is provided' do
      subject.call({'PATH_INFO' => '/info'})
      subject.env['api.format'].should == :txt
    end

    it 'uses the requested format if provided in headers' do
      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json'})
      subject.env['api.format'].should == :json
    end

    it 'uses the file extension format if provided before headers' do
      subject.call({'PATH_INFO' => '/info.txt', 'HTTP_ACCEPT' => 'application/json'})
      subject.env['api.format'].should == :txt
    end
  end

  context 'accept header detection' do
    it 'detects from the Accept header' do
      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/xml'})
      subject.env['api.format'].should == :xml
    end

    it 'looks for case-indifferent headers' do
      subject.call({'PATH_INFO' => '/info', 'http_accept' => 'application/xml'})
      subject.env['api.format'].should == :xml
    end

    it 'uses quality rankings to determine formats' do
      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; q=0.3,application/xml; q=1.0'})
      subject.env['api.format'].should == :xml
      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; q=1.0,application/xml; q=0.3'})
      subject.env['api.format'].should == :json
    end

    it 'handles quality rankings mixed with nothing' do
      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json,application/xml; q=1.0'})
      subject.env['api.format'].should == :xml
    end

    it 'parses headers with other attributes' do
      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; abc=2.3; q=1.0,application/xml; q=0.7'})
      subject.env['api.format'].should == :json
    end

    it 'parses headers with vendor and api version' do
      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test-v1+xml'})
      subject.env['api.format'].should == :xml
    end

    it 'parses headers with symbols as hash keys' do
      subject.call({'PATH_INFO' => '/info', 'http_accept' => 'application/xml', :system_time => '091293'})
      subject.env[:system_time].should == '091293'
    end
  end

  context 'content-type' do
    it 'is set for json' do
      _, headers, _ = subject.call({'PATH_INFO' => '/info.json'})
      headers['Content-type'].should == 'application/json'
    end
    it 'is set for xml' do
      _, headers, _ = subject.call({'PATH_INFO' => '/info.xml'})
      headers['Content-type'].should == 'application/xml'
    end
    it 'is set for txt' do
      _, headers, _ = subject.call({'PATH_INFO' => '/info.txt'})
      headers['Content-type'].should == 'text/plain'
    end
    it 'is set for custom' do
      subject.options[:content_types] = {}
      subject.options[:content_types][:custom] = 'application/x-custom'
      _, headers, _ = subject.call({'PATH_INFO' => '/info.custom'})
      headers['Content-type'].should == 'application/x-custom'
    end
  end

  context 'format' do
    it 'uses custom formatter' do
      subject.options[:content_types] = {}
      subject.options[:content_types][:custom] = "don't care"
      subject.options[:formatters][:custom] = lambda { |obj, env| 'CUSTOM FORMAT' }
      _, _, body = subject.call({'PATH_INFO' => '/info.custom'})
      body.body.should == ['CUSTOM FORMAT']
    end
    it 'uses default json formatter' do
      @body = ['blah']
      _, _, body = subject.call({'PATH_INFO' => '/info.json'})
      body.body.should == ['["blah"]']
    end
    it 'uses custom json formatter' do
      subject.options[:formatters][:json] = lambda { |obj, env| 'CUSTOM JSON FORMAT' }
      _, _, body = subject.call({'PATH_INFO' => '/info.json'})
      body.body.should == ['CUSTOM JSON FORMAT']
    end
  end

  context 'input' do
    [ "POST", "PATCH", "PUT" ].each do |method|
      [ "application/json", "application/json; charset=utf-8" ].each do |content_type|
        context content_type do
          it 'parses the body from #{method} and copies values into rack.request.form_hash' do
            io = StringIO.new('{"is_boolean":true,"string":"thing"}')
            subject.call({
              'PATH_INFO' => '/info',
              'REQUEST_METHOD' => method,
              'CONTENT_TYPE' => content_type,
              'rack.input' => io,
              'CONTENT_LENGTH' => io.length
            })
            subject.env['rack.request.form_hash']['is_boolean'].should be_true
            subject.env['rack.request.form_hash']['string'].should == 'thing'
          end
        end
      end
      it "parses the chunked body from #{method} and copies values into rack.request.from_hash" do
        io = StringIO.new('{"is_boolean":true,"string":"thing"}')
        subject.call({
          'PATH_INFO' => '/infol',
          'REQUEST_METHOD' => method,
          'CONTENT_TYPE' => 'application/json',
          'rack.input' => io,
          'HTTP_TRANSFER_ENCODING' => 'chunked'
        })
        subject.env['rack.request.form_hash']['is_boolean'].should be_true
        subject.env['rack.request.form_hash']['string'].should == 'thing'
      end
      it "rewinds IO" do
        io = StringIO.new('{"is_boolean":true,"string":"thing"}')
        io.read
        subject.call({
          'PATH_INFO' => '/infol',
          'REQUEST_METHOD' => method,
          'CONTENT_TYPE' => 'application/json',
          'rack.input' => io,
          'HTTP_TRANSFER_ENCODING' => 'chunked'
        })
        subject.env['rack.request.form_hash']['is_boolean'].should be_true
        subject.env['rack.request.form_hash']['string'].should == 'thing'
      end
      it 'parses the body from an xml #{method} and copies values into rack.request.from_hash' do
        io = StringIO.new('<thing><name>Test</name></thing>')
        subject.call({
          'PATH_INFO' => '/info.xml',
          'REQUEST_METHOD' => method,
          'CONTENT_TYPE' => 'application/xml',
          'rack.input' => io,
          'CONTENT_LENGTH' => io.length
        })
        subject.env['rack.request.form_hash']['thing']['name'].should == 'Test'
      end
      [ Rack::Request::FORM_DATA_MEDIA_TYPES, Rack::Request::PARSEABLE_DATA_MEDIA_TYPES ].flatten.each do |content_type|
        it "ignores #{content_type}" do
          io = StringIO.new('name=Other+Test+Thing')
          subject.call({
            'PATH_INFO' => '/info',
            'REQUEST_METHOD' => method,
            'CONTENT_TYPE' => content_type,
            'rack.input' => io,
            'CONTENT_LENGTH' => io.length
          })
          subject.env['rack.request.form_hash'].should be_nil
        end
      end
    end
  end

end