grape 0.16.1 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14025980d9a1ead68f6864f6794d94cb4a070b8c
-  data.tar.gz: 0cb0c1aa236b361ff803d2534f545542016503dc
+  metadata.gz: 5c0353f686611ae4c8f0b58a8cbe67a8a75517b2
+  data.tar.gz: 4df3e13972d076ebc707112bc5a8a837a022ef77
 SHA512:
-  metadata.gz: 0530cb22cb08ab580a4450a0b4e7d9337cb5d0ae920cdd6c00124d8c238e4b4be24f0cdfc759caf343135c479c45da64fba8f8214ddb88a7ec88aa709a7392c1
-  data.tar.gz: d467e07232bc21fe849ec5a122126f119e1fee53cebfc5691a1ce8c9b6f90c75072dfae88ff50f116457f0e0c4cb7100e75358415a549d14b37d1e46aca3e3ea
+  metadata.gz: 5617f40d20408389c2cac83277cf87865bf3103d7606fff84c0dfd6349d577fe3aea9b1649dc716b929e4631d1a45ad15df96a4e8d1766f8c16e66333a97668c
+  data.tar.gz: c761206de05d16b81b4875dd3c57aa62b5ea5b0c0e301b53321f308ff45ba19c2e9437734020d0ad3a52c7f56763cb81a390f82fb50dc70d537c0cb0edfee883

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+0.16.2 (4/12/2016)
+==================
+
+#### Features
+
+* [#1348](https://github.com/ruby-grape/grape/pull/1348): Fix global functions polluting Grape::API scope - [@dblock](https://github.com/dblock).
+* [#1357](https://github.com/ruby-grape/grape/pull/1357): Expose Route#options - [@namusyaka](https://github.com/namusyaka).
+
+#### Fixes
+
+* [#1357](https://github.com/ruby-grape/grape/pull/1357): Don't include fixed named captures as route params - [@namusyaka](https://github.com/namusyaka).
+* [#1359](https://github.com/ruby-grape/grape/pull/1359): Avoid evaluating the same route twice - [@namusyaka](https://github.com/namusyaka), [@dblock](https://github.com/dblock).
+* [#1361](https://github.com/ruby-grape/grape/pull/1361): Return 405 correctly even if version is using as header and wrong request method - [@namusyaka](https://github.com/namusyaka), [@dblock](https://github.com/dblock).
+
 0.16.1 (4/3/2016)
 =================
 
@@ -43,6 +57,7 @@
 * [#1197](https://github.com/ruby-grape/grape/pull/1290): Fix using JSON and Array[JSON] as groups when parameter is optional - [@lukeivers](https://github.com/lukeivers).
 
 0.14.0 (12/07/2015)
+=================
 
 #### Features
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape (0.16.1)
+    grape (0.16.2)
       activesupport
       builder
       hashie (>= 2.1.0)
@@ -150,7 +150,7 @@ DEPENDENCIES
   bundler
   cookiejar
   grape!
-  grape-entity (>= 0.4.4)
+  grape-entity (= 0.5.0)
   guard
   guard-rspec
   guard-rubocop

data/README.md

@@ -103,7 +103,7 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape, 0.16.1.
+You're reading the documentation for the stable release of Grape, 0.16.2.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Project Resources
@@ -2566,6 +2566,11 @@ Note that `Route#route_xyz` methods have been deprecated since 0.15.0.
 
 Please use `Route#xyz` instead.
 
+Note that difference of `Route#options` and `Route#settings`.
+
+The `options` can be referred from your route, it should be set by specifing key and value on verb methods such as `get`, `post` and `put`.
+The `settings` can also be referred from your route, but it should be set by specifing key and value on `route_setting`.
+
 ## Current Route and Endpoint
 
 It's possible to retrieve the information about the current route from within an API call with `route`.

data/grape.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'virtus', '>= 1.0.0'
   s.add_runtime_dependency 'builder'
 
-  s.add_development_dependency 'grape-entity', '>= 0.4.4'
+  s.add_development_dependency 'grape-entity', '0.5.0'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'maruku'
   s.add_development_dependency 'yard'

data/lib/grape/endpoint.rb

@@ -231,7 +231,7 @@ module Grape
 
         run_filters before_validations, :before_validation
 
-        run_validators validations, request unless @method_not_allowed
+        run_validators validations, request unless env[Grape::Env::GRAPE_METHOD_NOT_ALLOWED]
 
         run_filters after_validations, :after_validation
 

data/lib/grape/middleware/versioner/header.rb

@@ -32,7 +32,7 @@ module Grape
         def before
           strict_header_checks if strict?
 
-          if media_type
+          if media_type || env[Grape::Env::GRAPE_METHOD_NOT_ALLOWED]
             media_type_header_handler
           elsif headers_contain_wrong_vendor?
             fail_with_invalid_accept_header!('API vendor not found.')

data/lib/grape/router.rb

@@ -41,7 +41,8 @@ module Grape
 
     def call(env)
       with_optimization do
-        identity(env) || rotation(env) { |route| route.exec(env) }
+        response, route = identity(env)
+        response || rotation(env, route)
       end
     end
 
@@ -54,26 +55,28 @@ module Grape
     private
 
     def identity(env)
-      transaction(env) do |input, method, routing_args|
+      route = nil
+      response = transaction(env) do |input, method, routing_args|
         route = match?(input, method)
         if route
           env[Grape::Env::GRAPE_ROUTING_ARGS] = make_routing_args(routing_args, route, input)
           route.exec(env)
         end
       end
+      [response, route]
     end
 
-    def rotation(env)
-      transaction(env) do |input, method, routing_args|
-        response = nil
-        routes_for(method).each do |route|
-          next unless route.match?(input)
-          env[Grape::Env::GRAPE_ROUTING_ARGS] = make_routing_args(routing_args, route, input)
-          response = yield(route)
-          break unless cascade?(response)
-        end
-        response
+    def rotation(env, exact_route = nil)
+      response = nil
+      input, method, routing_args = *extract_required_args(env)
+      routes_for(method).each do |route|
+        next if exact_route == route
+        next unless route.match?(input)
+        env[Grape::Env::GRAPE_ROUTING_ARGS] = make_routing_args(routing_args, route, input)
+        response = route.exec(env)
+        break unless cascade?(response)
       end
+      response
     end
 
     def transaction(env)
@@ -122,10 +125,12 @@ module Grape
     end
 
     def method_not_allowed(env, methods, endpoint)
+      env[Grape::Env::GRAPE_METHOD_NOT_ALLOWED] = true
       current = endpoint.dup
       current.instance_eval do
+        @lazy_initialized = false
+        lazy_initialize!
         run_filters befores, :before
-        @method_not_allowed = true
         @block = proc do
           fail Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => methods)
         end

data/lib/grape/router/attribute_translator.rb

@@ -1,39 +1,29 @@
-require 'delegate'
-require 'ostruct'
-
 module Grape
   class Router
-    class AttributeTranslator < DelegateClass(OpenStruct)
-      def self.register(*attributes)
-        AttributeTranslator.supported_attributes.concat(attributes)
-      end
-
-      def self.supported_attributes
-        @supported_attributes ||= []
-      end
-
+    # this could be an OpenStruct, but doesn't work in Ruby 2.3.0, see https://bugs.ruby-lang.org/issues/12251
+    class AttributeTranslator
       def initialize(attributes = {})
-        ostruct = OpenStruct.new(attributes)
-        super ostruct
         @attributes = attributes
-        self.class.supported_attributes.each do |name|
-          ostruct.send(:"#{name}=", nil) unless ostruct.respond_to?(name)
-          self.class.instance_eval do
-            define_method(name) { instance_variable_get(:"@#{name}") }
-          end if name == :format
-        end
       end
 
       def to_h
-        @attributes.each_with_object({}) do |(key, _), attributes|
-          attributes[key.to_sym] = send(:"#{key}")
-        end
+        @attributes
       end
 
-      private
+      def method_missing(m, *args)
+        if m[-1] == '='
+          @attributes[m[0..-1]] = *args
+        else
+          @attributes[m]
+        end
+      end
 
-      def accessor_available?(name)
-        respond_to?(name) && respond_to?(:"#{name}=")
+      def respond_to_missing?(method_name, _include_private = false)
+        if method_name[-1] == '='
+          true
+        else
+          @attributes.key?(method_name)
+        end
       end
     end
   end

data/lib/grape/router/route.rb

@@ -8,35 +8,15 @@ module Grape
     class Route
       ROUTE_ATTRIBUTE_REGEXP = /route_([_a-zA-Z]\w*)/.freeze
       SOURCE_LOCATION_REGEXP = /^(.*?):(\d+?)(?::in `.+?')?$/.freeze
-      TRANSLATION_ATTRIBUTES = [
-        :prefix,
-        :version,
-        :namespace,
-        :settings,
-        :format,
-        :description,
-        :http_codes,
-        :headers,
-        :entity,
-        :details,
-        :requirements,
-        :request_method
-      ].freeze
+      FIXED_NAMED_CAPTURES = %w(format version).freeze
 
-      attr_accessor :pattern, :translator, :app, :index, :regexp
+      attr_accessor :pattern, :translator, :app, :index, :regexp, :options
 
       alias_method :attributes, :translator
 
       extend Forwardable
       def_delegators :pattern, :path, :origin
 
-      def self.translate(*attributes)
-        AttributeTranslator.register(*attributes)
-        def_delegators :@translator, *attributes
-      end
-
-      translate(*TRANSLATION_ATTRIBUTES)
-
       def method_missing(method_id, *arguments)
         match = ROUTE_ATTRIBUTE_REGEXP.match(method_id.to_s)
         if match
@@ -48,6 +28,25 @@ module Grape
         end
       end
 
+      [
+        :prefix,
+        :version,
+        :settings,
+        :format,
+        :description,
+        :http_codes,
+        :headers,
+        :entity,
+        :details,
+        :requirements,
+        :request_method,
+        :namespace
+      ].each do |method_name|
+        define_method method_name do
+          attributes.public_send method_name
+        end
+      end
+
       def route_method
         warn_route_methods(:method, caller(1).shift, :request_method)
         request_method
@@ -80,10 +79,9 @@ module Grape
 
       def params(input = nil)
         if input.nil?
-          default = pattern.named_captures.keys.each_with_object({}) do |key, defaults|
-            defaults[key] = ''
+          pattern.named_captures.keys.each_with_object(translator.params) do |(key), defaults|
+            defaults[key] ||= '' unless FIXED_NAMED_CAPTURES.include?(key) || defaults.key?(key)
           end
-          default.delete_if { |key, _| key == 'format' }.merge(translator.params)
         else
           parsed = pattern.params(input)
           parsed ? parsed.delete_if { |_, value| value.nil? }.symbolize_keys : {}

data/lib/grape/util/env.rb

@@ -18,5 +18,6 @@ module Grape
     GRAPE_REQUEST_HEADERS = 'grape.request.headers'.freeze
     GRAPE_REQUEST_PARAMS = 'grape.request.params'.freeze
     GRAPE_ROUTING_ARGS = 'grape.routing_args'.freeze
+    GRAPE_METHOD_NOT_ALLOWED = 'grape.method_not_allowed'.freeze
   end
 end

data/lib/grape/version.rb

@@ -1,4 +1,4 @@
 module Grape
   # The current version of Grape.
-  VERSION = '0.16.1'
+  VERSION = '0.16.2'
 end

data/pkg/patch.diff

@@ -0,0 +1,24 @@
+diff --git lib/grape/router/route.rb lib/grape/router/route.rb
+index 643960d..1074c01 100644
+--- lib/grape/router/route.rb
++++ lib/grape/router/route.rb
+@@ -20,7 +20,9 @@ module Grape
+         :entity,
+         :details,
+         :requirements,
+-        :request_method
++        :request_method,
++        :hidden,
++        :params
+       ].freeze
+ 
+       attr_accessor :pattern, :translator, :app, :index, :regexp
+@@ -42,7 +44,7 @@ module Grape
+         if match
+           method_name = match.captures.last.to_sym
+           warn_route_methods(method_name, caller(1).shift)
+-          @options[method_name]
++          respond_to?(method_name) ? send(method_name) : @options[method_name]
+         else
+           super
+         end

data/spec/grape/api/patch_method_helpers_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Grape::API::Helpers do
+  module PatchHelpersSpec
+    class PatchPublic < Grape::API
+      format :json
+      version 'public-v1', using: :header, vendor: 'grape'
+
+      get do
+        { ok: 'public' }
+      end
+    end
+
+    module AuthMethods
+      def authenticate!
+      end
+    end
+
+    class PatchPrivate < Grape::API
+      format :json
+      version 'private-v1', using: :header, vendor: 'grape'
+
+      helpers AuthMethods
+
+      before do
+        authenticate!
+      end
+
+      get do
+        { ok: 'private' }
+      end
+    end
+
+    class Main < Grape::API
+      mount PatchPublic
+      mount PatchPrivate
+    end
+  end
+
+  def app
+    PatchHelpersSpec::Main
+  end
+
+  context 'patch' do
+    it 'public' do
+      patch '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-public-v1+json'
+      expect(last_response.status).to eq 405
+    end
+
+    it 'private' do
+      patch '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-private-v1+json'
+      expect(last_response.status).to eq 405
+    end
+
+    it 'default' do
+      patch '/'
+      expect(last_response.status).to eq 405
+    end
+  end
+
+  context 'default' do
+    it 'public' do
+      get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-public-v1+json'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ ok: 'public' }.to_json)
+    end
+
+    it 'private' do
+      get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-private-v1+json'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ ok: 'private' }.to_json)
+    end
+
+    it 'default' do
+      get '/'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ ok: 'public' }.to_json)
+    end
+  end
+end

data/spec/grape/api_spec.rb

@@ -2256,6 +2256,14 @@ XML
       expect(route.description).to eq('first method')
       expect(route.route_foo).to be_nil
       expect(route.params).to eq({})
+      expect(route.options).to be_a_kind_of(Hash)
+    end
+    it 'has params which does not include format and version as named captures' do
+      subject.version :v1, using: :path
+      subject.get :first do; end
+      param_keys = subject.routes.first.params.keys
+      expect(param_keys).not_to include('format')
+      expect(param_keys).not_to include('version')
     end
     it 'describes methods separately' do
       subject.desc 'first method'

data/spec/grape/integration/global_namespace_function_spec.rb

@@ -0,0 +1,29 @@
+# see https://github.com/ruby-grape/grape/issues/1348
+
+require 'spec_helper'
+
+def namespace
+  fail
+end
+
+describe Grape::API do
+  subject do
+    Class.new(Grape::API) do
+      format :json
+      get do
+        { ok: true }
+      end
+    end
+  end
+
+  def app
+    subject
+  end
+
+  context 'with a global namespace function' do
+    it 'works' do
+      get '/'
+      expect(last_response.status).to eq 200
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.16.2
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-02 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -140,16 +140,16 @@ dependencies:
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -453,12 +453,15 @@ files:
 - lib/grape/validations/validators/regexp.rb
 - lib/grape/validations/validators/values.rb
 - lib/grape/version.rb
+- pkg/grape-0.16.1.gem
+- pkg/patch.diff
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/invalid_format_spec.rb
 - spec/grape/api/namespace_parameters_in_route_spec.rb
 - spec/grape/api/nested_helpers_spec.rb
 - spec/grape/api/optional_parameters_in_route_spec.rb
+- spec/grape/api/patch_method_helpers_spec.rb
 - spec/grape/api/recognize_path_spec.rb
 - spec/grape/api/required_parameters_in_route_spec.rb
 - spec/grape/api/required_parameters_with_invalid_method_spec.rb
@@ -489,6 +492,7 @@ files:
 - spec/grape/exceptions/unknown_validator_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/validation_spec.rb
+- spec/grape/integration/global_namespace_function_spec.rb
 - spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/rack_spec.rb
 - spec/grape/loading_spec.rb
@@ -556,7 +560,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
@@ -567,6 +571,7 @@ test_files:
 - spec/grape/api/namespace_parameters_in_route_spec.rb
 - spec/grape/api/nested_helpers_spec.rb
 - spec/grape/api/optional_parameters_in_route_spec.rb
+- spec/grape/api/patch_method_helpers_spec.rb
 - spec/grape/api/recognize_path_spec.rb
 - spec/grape/api/required_parameters_in_route_spec.rb
 - spec/grape/api/required_parameters_with_invalid_method_spec.rb
@@ -597,6 +602,7 @@ test_files:
 - spec/grape/exceptions/unknown_validator_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/validation_spec.rb
+- spec/grape/integration/global_namespace_function_spec.rb
 - spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/rack_spec.rb
 - spec/grape/loading_spec.rb