grape 0.2.0 → 0.2.1

data/spec/grape/endpoint_spec.rb

@@ -107,7 +107,7 @@ describe Grape::Endpoint do
       ]
     end
   end
-  
+
   describe '#params' do
     it 'should be available to the caller' do
       subject.get('/hey') do
@@ -134,6 +134,80 @@ describe Grape::Endpoint do
       get '/location?location[city]=Dallas'
       last_response.body.should == 'Dallas'
     end
+
+    context 'with special requirements' do
+      it 'should parse email param with provided requirements for params' do
+        subject.get('/:person_email', :requirements => { :person_email => /.*/ }) do
+        params[:person_email]
+        end
+
+        get '/rodzyn@grape.com'
+        last_response.body.should == 'rodzyn@grape.com'
+
+        get 'rodzyn@grape.com.pl'
+        last_response.body.should == 'rodzyn@grape.com.pl'
+      end
+
+      it 'should parse many params with provided regexps' do
+        subject.get('/:person_email/test/:number',
+          :requirements => {
+            :person_email => /rodzyn@(.*).com/,
+            :number => /[0-9]/ }) do
+        params[:person_email] << params[:number]
+        end
+
+        get '/rodzyn@grape.com/test/1'
+        last_response.body.should == 'rodzyn@grape.com1'
+
+        get '/rodzyn@testing.wrong/test/1'
+        last_response.status.should == 404
+
+        get 'rodzyn@test.com/test/wrong_number'
+        last_response.status.should == 404
+
+        get 'rodzyn@test.com/wrong_middle/1'
+        last_response.status.should == 404
+      end
+    end
+
+    context 'from body parameters' do
+      before(:each) do
+        subject.post '/request_body' do
+          params[:user]
+        end
+
+        subject.put '/request_body' do
+          params[:user]
+        end
+      end
+
+      it 'should convert JSON bodies to params' do
+        post '/request_body', MultiJson.encode(:user => 'Bobby T.'), {'CONTENT_TYPE' => 'application/json'}
+        last_response.body.should == 'Bobby T.'
+      end
+
+      it 'should convert JSON bodies to params' do
+        put '/request_body', MultiJson.encode(:user => 'Bobby T.'), {'CONTENT_TYPE' => 'application/json'}
+        last_response.body.should == 'Bobby T.'
+      end
+
+      it 'should convert XML bodies to params' do
+        post '/request_body', '<user>Bobby T.</user>', {'CONTENT_TYPE' => 'application/xml'}
+        last_response.body.should == 'Bobby T.'
+      end
+
+      it 'should convert XML bodies to params' do
+        put '/request_body', '<user>Bobby T.</user>', {'CONTENT_TYPE' => 'application/xml'}
+        last_response.body.should == 'Bobby T.'
+      end
+
+      it 'does not include parameters not defined by the body' do
+        subject.post '/omitted_params' do
+          body_params[:version].should == nil
+        end
+        post '/omitted_params', MultiJson.encode(:user => 'Blah'), {'CONTENT_TYPE' => 'application/json'}
+      end
+    end
   end
 
   describe '#error!' do
@@ -168,6 +242,37 @@ describe Grape::Endpoint do
       last_response.body.should == '{"dude":"rad"}'
     end
   end
+  
+  describe "#redirect" do
+    it "should redirect to a url with status 302" do
+      subject.get('/hey') do
+        redirect "/ha"
+      end
+      get '/hey'
+      last_response.status.should eq 302
+      last_response.headers['Location'].should eq "/ha"
+      last_response.body.should eq ""
+    end
+
+    it "should have status code 303 if it is not get request and it is http 1.1" do
+      subject.post('/hey') do
+        redirect "/ha"
+      end
+      post '/hey', {}, 'HTTP_VERSION' => 'HTTP/1.1'
+      last_response.status.should eq 303
+      last_response.headers['Location'].should eq "/ha"
+    end
+
+    it "support permanent redirect" do
+      subject.get('/hey') do
+        redirect "/ha", :permanent => true
+      end
+      get '/hey'
+      last_response.status.should eq 304
+      last_response.headers['Location'].should eq "/ha"
+      last_response.body.should eq ""
+    end
+  end
 
   it 'should not persist params between calls' do
     subject.post('/new') do
@@ -304,8 +409,8 @@ describe Grape::Endpoint do
           verb
         end
         send(verb, '/example/and/some/more')
-        last_response.status.should eql (verb == "post" ? 201 : 200)
-        last_response.body.should eql verb
+        last_response.status.should eql verb == "post" ? 201 : 200
+        last_response.body.should eql verb == 'head' ? '' : verb
       end
     end
   end

data/spec/grape/entity_spec.rb

@@ -24,6 +24,10 @@ describe Grape::Entity do
           expect{ subject.expose :name, :email, :as => :foo }.to raise_error(ArgumentError)
           expect{ subject.expose :name, :as => :foo }.not_to raise_error
         end
+
+        it 'should make sure that :format_with as a proc can not be used with a block' do
+          expect { subject.expose :name, :format_with => Proc.new {} do |object,options| end }.to raise_error(ArgumentError)
+        end
       end
 
       context 'with a block' do
@@ -67,6 +71,38 @@ describe Grape::Entity do
           child_class.exposures[:name].should have_key :proc
         end
       end
+
+      context 'register formatters' do
+        let(:date_formatter) { lambda {|date| date.strftime('%m/%d/%Y') }}
+
+        it 'should register a formatter' do
+          subject.format_with :timestamp, &date_formatter
+
+          subject.formatters[:timestamp].should_not be_nil
+        end
+
+        it 'should inherit formatters from ancestors' do
+          subject.format_with :timestamp, &date_formatter
+          child_class = Class.new(subject)
+
+          child_class.formatters.should == subject.formatters
+        end
+
+        it 'should not allow registering a formatter without a block' do
+          expect{ subject.format_with :foo }.to raise_error(ArgumentError)
+        end
+
+        it 'should format an exposure with a registered formatter' do
+          subject.format_with :timestamp do |date|
+            date.strftime('%m/%d/%Y')
+          end
+
+          subject.expose :birthday, :format_with => :timestamp
+
+          model  = { :birthday => Time.gm(2012, 2, 27) }
+          subject.new(mock(model)).as_json[:birthday].should == '02/27/2012'
+        end
+      end
     end
 
     describe '.represent' do
@@ -201,11 +237,13 @@ describe Grape::Entity do
   context 'instance methods' do
     let(:model){ mock(attributes) }
     let(:attributes){ {
-      :name => 'Bob Bobson',
+      :name => 'Bob Bobson', 
       :email => 'bob@example.com',
+      :birthday => Time.gm(2012, 2, 27),
+      :fantasies => ['Unicorns', 'Double Rainbows', 'Nessy'],
       :friends => [
-        mock(:name => "Friend 1", :email => 'friend1@example.com', :friends => []),
-        mock(:name => "Friend 2", :email => 'friend2@example.com', :friends => [])
+        mock(:name => "Friend 1", :email => 'friend1@example.com', :fantasies => [], :birthday => Time.gm(2012, 2, 27), :friends => []), 
+        mock(:name => "Friend 2", :email => 'friend2@example.com', :fantasies => [], :birthday => Time.gm(2012, 2, 27), :friends => [])
       ]
     } }
     subject{ fresh_class.new(model) }
@@ -229,6 +267,14 @@ describe Grape::Entity do
           expose :computed do |object, options|
             options[:awesome]
           end
+
+          expose :birthday, :format_with => :timestamp
+
+          def timestamp(date)
+            date.strftime('%m/%d/%Y')
+          end
+
+          expose :fantasies, :format_with => lambda {|f| f.reverse }
         end
       end
 
@@ -261,6 +307,31 @@ describe Grape::Entity do
       it 'should call through to the proc if there is one' do
         subject.send(:value_for, :computed, :awesome => 123).should == 123
       end
+
+      it 'should return a formatted value if format_with is passed' do
+        subject.send(:value_for, :birthday).should == '02/27/2012'
+      end
+
+      it 'should return a formatted value if format_with is passed a lambda' do
+        subject.send(:value_for, :fantasies).should == ['Nessy', 'Double Rainbows', 'Unicorns']
+      end
+    end
+
+    describe '#documentation' do
+      it 'should return an empty hash is no documentation is provided' do
+        fresh_class.expose :name
+
+        subject.documentation.should == {}
+      end
+
+      it 'should return each defined documentation hash' do
+        doc = {:type => "foo", :desc => "bar"}
+        fresh_class.expose :name, :documentation => doc
+        fresh_class.expose :email, :documentation => doc
+        fresh_class.expose :birthday
+
+        subject.documentation.should == {:name  => doc, :email => doc}
+      end
     end
 
     describe '#key_for' do

data/spec/grape/middleware/formatter_spec.rb

@@ -10,7 +10,7 @@ describe Grape::Middleware::Formatter do
     it 'should look 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.encode(@body) }
+      bodies.each{|b| b.should == MultiJson.dump(@body) }
     end
 
     it 'should call #to_json first if it is available' do
@@ -82,11 +82,6 @@ describe Grape::Middleware::Formatter do
       subject.call({'PATH_INFO' => '/info.txt', 'HTTP_ACCEPT' => 'application/json'})
       subject.env['api.format'].should == :txt
     end
-    
-    it 'should throw an error on an unrecognized format' do
-      err = catch(:error){ subject.call({'PATH_INFO' => '/info.barklar'}) }
-      err.should == {:status => 406, :message => "The requested format is not supported."}
-    end
   end
 
   context 'Accept header detection' do
@@ -121,6 +116,11 @@ describe Grape::Middleware::Formatter do
       subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test-v1+xml'})
       subject.env['api.format'].should == :xml
     end
+
+    it 'should properly parse 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

data/spec/grape/middleware/versioner/param_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Grape::Middleware::Versioner::Param do
+
+  let(:app) { lambda{|env| [200, env, env['api.version']]} }
+  subject { Grape::Middleware::Versioner::Param.new(app, @options || {}) }
+
+  it 'should set the API version based on the default param (apiver)' do
+    env = Rack::MockRequest.env_for("/awesome", {:params => {"apiver" => "v1"}})
+    subject.call(env)[1]["api.version"].should == 'v1'
+  end
+
+  it 'should cut (only) the version out of the params', :focus => true do
+    env = Rack::MockRequest.env_for("/awesome", {:params => {"apiver" => "v1", "other_param" => "5"}})
+    subject.call(env)[1]['rack.request.query_hash']["apiver"].should be_nil
+    subject.call(env)[1]['rack.request.query_hash']["other_param"].should == "5"
+  end
+
+  it 'should provide a nil version if no version is given' do
+    env = Rack::MockRequest.env_for("/")
+    subject.call(env).last.should be_nil
+  end
+
+  context 'with specified parameter name' do
+    before{ @options = {:parameter => ['v']}}
+    it 'should set the API version based on the custom parameter name' do
+      env = Rack::MockRequest.env_for("/awesome", {:params => {"v" => "v1"}})
+      s = subject.call(env)[1]["api.version"] == "v1"
+    end
+    it 'should not set the API version based on the default param' do
+      env = Rack::MockRequest.env_for("/awesome", {:params => {"apiver" => "v1"}})
+      s = subject.call(env)[1]["api.version"] == nil
+    end
+  end
+
+  context 'with specified versions' do
+    before{ @options = {:versions => ['v1', 'v2']}}
+    it 'should throw an error if a non-allowed version is specified' do
+      env = Rack::MockRequest.env_for("/awesome", {:params => {"apiver" => "v3"}})
+      catch(:error){subject.call(env)}[:status].should == 404
+    end
+
+    it 'should allow versions that have been specified' do
+      env = Rack::MockRequest.env_for("/awesome", {:params => {"apiver" => "v1"}})
+      subject.call(env)[1]["api.version"].should == 'v1'
+    end
+  end
+
+  it 'should return a 200 when no version is set (matches the first version found)' do
+    @options = {
+      :versions => ['v1'],
+      :version_options => {:using => :header}
+    }
+    env = Rack::MockRequest.env_for("/awesome", {:params => {}})
+    subject.call(env).first.should == 200
+  end
+
+end

data/spec/grape/middleware/versioner_spec.rb

@@ -9,4 +9,8 @@ describe Grape::Middleware::Versioner do
   it 'should recognize :header' do
     klass.using(:header).should == Grape::Middleware::Versioner::Header
   end
+
+  it 'should recognize :param' do
+    klass.using(:param).should == Grape::Middleware::Versioner::Param
+  end
 end

data/spec/support/versioned_helpers.rb

@@ -6,6 +6,8 @@ def versioned_path(options = {})
   case options[:using]
   when :path
     File.join('/', options[:prefix] || '', options[:version], options[:path])
+  when :param
+    File.join('/', options[:prefix] || '', options[:path])
   when :header
     File.join('/', options[:prefix] || '', options[:path])
   else
@@ -17,6 +19,8 @@ def versioned_headers(options)
   case options[:using]
   when :path
     {}  # no-op
+  when :param
+    {}  # no-op
   when :header
     {
       'HTTP_ACCEPT' => "application/vnd.#{options[:vendor]}-#{options[:version]}+#{options[:format]}"
@@ -29,6 +33,10 @@ end
 def versioned_get(path, version_name, version_options = {})
   path    = versioned_path(version_options.merge(:version => version_name, :path => path))
   headers = versioned_headers(version_options.merge(:version => version_name))
-  get path, {}, headers
+  params = {}
+  if version_options[:using] == :param
+    params = { version_options[:parameter] => version_name } 
+  end
+  get path, params, headers
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70235092969660 !ruby/object:Gem::Requirement
+  requirement: &70130298033500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70235092969660
+  version_requirements: *70130298033500
 - !ruby/object:Gem::Dependency
   name: rack-mount
-  requirement: &70235092968600 !ruby/object:Gem::Requirement
+  requirement: &70130298033080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70235092968600
+  version_requirements: *70130298033080
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70235092967620 !ruby/object:Gem::Requirement
+  requirement: &70130298032660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70235092967620
+  version_requirements: *70130298032660
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &70235092998440 !ruby/object:Gem::Requirement
+  requirement: &70130298032240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70235092998440
+  version_requirements: *70130298032240
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70235092992580 !ruby/object:Gem::Requirement
+  requirement: &70130298031740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70235092992580
+  version_requirements: *70130298031740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70235093020680 !ruby/object:Gem::Requirement
+  requirement: &70130298031320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235093020680
+  version_requirements: *70130298031320
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70235093014740 !ruby/object:Gem::Requirement
+  requirement: &70130298030860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235093014740
+  version_requirements: *70130298030860
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70235093028820 !ruby/object:Gem::Requirement
+  requirement: &70130298030440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235093028820
+  version_requirements: *70130298030440
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70235093028060 !ruby/object:Gem::Requirement
+  requirement: &70130298030020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235093028060
+  version_requirements: *70130298030020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70235093027200 !ruby/object:Gem::Requirement
+  requirement: &70130298029520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *70235093027200
+  version_requirements: *70130298029520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70235093025280 !ruby/object:Gem::Requirement
+  requirement: &70130298029100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235093025280
+  version_requirements: *70130298029100
 description: A Ruby framework for rapid API development with great conventions.
 email:
 - michael@intridea.com
@@ -143,6 +143,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.markdown
 - Gemfile
 - Guardfile
 - LICENSE
@@ -164,6 +165,7 @@ files:
 - lib/grape/middleware/prefixer.rb
 - lib/grape/middleware/versioner.rb
 - lib/grape/middleware/versioner/header.rb
+- lib/grape/middleware/versioner/param.rb
 - lib/grape/middleware/versioner/path.rb
 - lib/grape/route.rb
 - lib/grape/util/hash_stack.rb
@@ -180,6 +182,7 @@ files:
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner/header_spec.rb
+- spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/util/hash_stack_spec.rb
@@ -204,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1598569611300110668
+      hash: 2226649609976967092
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -213,10 +216,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1598569611300110668
+      hash: 2226649609976967092
 requirements: []
 rubyforge_project: grape
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A simple Ruby framework for building REST-like APIs.
@@ -233,6 +236,7 @@ test_files:
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner/header_spec.rb
+- spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/util/hash_stack_spec.rb