grape 0.6.0 → 0.6.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2ZhNWZiZWQ4YjIwNmY5MDk1NmQxODgxM2FiZDA0NTE3ZDlmZmNiYQ==
+    N2JkMzEwZGIyN2M4ZWVkMjczNmU1OTZiNTQzYTA3Yjc1YWI1MzRiNw==
   data.tar.gz: !binary |-
-    MTE5MjU2MWY2MWZlNGI1ODQzNDExMDZjOTNmZjRiYzc3ZDY4ODZlMg==
+    ODE0MmI1YjY3YjZlNjdhOGY0ZGI1OTdjMWRhYmI3N2JiZjJmNWMwYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDlhYjA4YWQ1OThhMGFhNTc3ZjUwNzI4N2FiNmY2ZmNlOGM3MjQ5YjE2OWMy
-    NzcxODEwZmY3Y2I5ZmVkOTk5ZWViMTNkZmE3NGM3MjMyOTAzZTdmMTg5MWZm
-    ZmI1Njk0ZjRlMGIwOGFkY2EzZDJhZTMxMDQ0MzcyMDM4Y2UxMGY=
+    NWYxMGEyMWE0NWE4ZTlkMjczMmY3ZjA1NGUwZjNhZmJlYjk3MGQ5NTE0NDk3
+    OGUyOWU5YmVhNzMwMWJkOTIxYjgwZmU0ODk1YWU4Yzc1ZTdkMWY4NTc0MDlh
+    ODQ4NjczZWRhMGVmMmQ1MDg3Njk5MjBjMTk5N2VjYmM0Y2ZiZDE=
   data.tar.gz: !binary |-
-    OWU4MGUxOGJkYzRjYzhkZmQyMzFkMWU1NTk3ZTllMTRkZDkyOTA0YjcwODg3
-    YWNiNWY0ZDQzZWUxNmI4MmYxZGQzOWJmMTFiZDg0YTFiNzMyYzA5ODBhMDYz
-    ZWRiN2FmY2FhM2FjNjQ1ZWM2NjMwNWI1YmU1Y2NhYjA1NGI2MDg=
+    OTI1ZDU2ZDViNjc2YWE4MTczMThmN2I5ZGYwZGZlYmE0YjZlMDI3NjVlNTE5
+    NjcwOTRkNTg2NTgwODFhMTg3YjZkM2Y3NzYwYzkwNTYxMGEzMzU2NDBiYzBk
+    ZGJlYTRmMDEwNGJkNDc3YzNiMmUyM2IyMDUwMGM3MGFhMDhiYTg=

data/.rubocop.yml

@@ -0,0 +1,65 @@
+AllCops:
+  Excludes:
+    - vendor/**
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  # don't require classes to be documented
+  Enabled: false
+
+CollectionMethods:
+  # don't prefer map to collect, recuce to inject
+  Enabled: false
+
+Encoding:
+  # no need to always specify encoding
+  Enabled: false
+
+HashMethods:
+  # key? instead of has_key?
+  # value? instead of has_value?
+  Enabled: false
+
+StringLiterals:
+  # use single or double-quoted strings, as you please
+  Enabled: false
+
+Void:
+  # == operator used in void context in specs
+  Enabled: false
+
+SignalException:
+  # prefer raise to fail
+  EnforcedStyle: only_raise
+
+RaiseArgs:
+  # don't care for what kind of raise
+  Enabled: false
+
+PerlBackrefs:
+  # TODO: regular expression matching with $1, $2, etc.
+  Enabled: false
+
+BlockNesting:
+  # TODO: fix too much nesting
+  Max: 4
+
+Lambda:
+  # TODO: replace all lambda with -> or Proc
+  Enabled: false
+
+Blocks:
+  # allow multi-line blocks like expect { }
+  Enabled: false
+
+WordArray:
+  # %w vs. [ '', ... ]
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,9 @@
+language: ruby
+cache: bundler
 rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode
   - rbx-19mode
+script:
+ - "bundle exec rubocop"

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+0.6.1
+=====
+
+#### Features
+
+* [#475](https://github.com/intridea/grape/pull/475): Added support for the `:jsonapi`, `application/vnd.api+json` media type registered at http://jsonapi.org - [@bcm](https://github.com/bcm).
+* [#471](https://github.com/intridea/grape/issues/471): Added parameter validator for a list of allowed values - [@vickychijwani](https://github.com/vickychijwani).
+* [#488](https://github.com/intridea/grape/issues/488): Upgraded to Virtus 1.0 - [@dblock](https://github.com/dblock).
+
+#### Fixes
+
+* [#477](https://github.com/intridea/grape/pull/477): Fixed `default_error_formatter` which takes a format symbol - [@vad4msiu](https://github.com/vad4msiu).
+
+#### Development
+
+* Implemented Rubocop, a Ruby code static code analyzer - [@dblock](https://github.com/dblock).
+
 0.6.0 (9/16/2013)
 =================
 
@@ -12,7 +29,6 @@
 * [#443](https://github.com/intridea/grape/pull/443): Let `requires` and `optional` take blocks that initialize new scopes - [@asross](https://github.com/asross).
 * [#452](https://github.com/intridea/grape/pull/452): Added `with` as a hash option to specify handlers for `rescue_from` and `error_formatter` [@robertopedroso](https://github.com/robertopedroso).
 * [#433](https://github.com/intridea/grape/issues/433), [#462](https://github.com/intridea/grape/issues/462): API change: validation errors are now collected and `Grape::Exceptions::ValidationErrors` is raised - [@stevschmid](https://github.com/stevschmid).
-* Your contribution here.
 
 #### Fixes
 

data/Gemfile

@@ -16,4 +16,5 @@ group :development, :test do
   gem 'cookiejar'
   gem 'rack-contrib'
   gem 'redcarpet', :platforms => :ruby
+  gem 'rubocop', '~> 0.14.1'
 end

data/README.md

@@ -12,7 +12,7 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape, 0.6.0.
+You're reading the documentation for the stable release of Grape, 0.6.1.
 
 ## Project Resources
 
@@ -334,7 +334,7 @@ params do
     requires :url
   end
   optional :audio do
-    requires :mp3
+    requires :format, type: Symbol, values: [:mp3, :wav, :aac, :ogg], default: :mp3
   end
 end
 put ':id' do
@@ -353,6 +353,14 @@ params do
 end
 ```
 
+Parameters can be restricted to a specific set of values with the `:values` option.
+
+```ruby
+params do
+  requires :status, type: Symbol, values: [:not_started, :processing, :done]
+end
+```
+
 Parameters can be nested using `group` or by calling `requires` or `optional` with a block.
 In the above example, this means `params[:media][:url]` is required along with `params[:id]`,
 and `params[:audio][:mp3]` is required only if `params[:audio]` is present.
@@ -706,13 +714,13 @@ class Twitter::API < Grape::API
 end
 ```
 
-You can rescue all exceptions with a code block. The `rack_response` wrapper
+You can rescue all exceptions with a code block. The `error_response` wrapper
 automatically sets the default error code and content-type.
 
 ```ruby
 class Twitter::API < Grape::API
   rescue_from :all do |e|
-    rack_response({ message: "rescued from #{e.class.name}" })
+    error_response({ message: "rescued from #{e.class.name}" })
   end
 end
 ```
@@ -871,7 +879,7 @@ end
 
 Built-in formats are the following.
 
-* `:json`: use object's `to_json` when available, otherwise call `MultiJson.dump`
+* `:json` and `:jsonapi`: use object's `to_json` when available, otherwise call `MultiJson.dump`
 * `:xml`: use object's `to_xml` when available, usually via `MultiXml`, otherwise call `to_s`
 * `:txt`: use object's `to_txt` when available, otherwise `to_s`
 * `:serializable_hash`: use object's `serializable_hash` when available, otherwise fallback to `:json`
@@ -896,7 +904,7 @@ The order for choosing the format is the following.
 
 ### JSONP
 
-Grape suports JSONP via [Rack::JSONP](https://github.com/rack/rack-contrib), part of the
+Grape supports JSONP via [Rack::JSONP](https://github.com/rack/rack-contrib), part of the
 [rack-contrib](https://github.com/rack/rack-contrib) gem. Add `rack-contrib` to your `Gemfile`.
 
 ```ruby
@@ -993,7 +1001,7 @@ hash may include `:with`, which defines the entity to expose.
 ### Grape Entities
 
 Add the [grape-entity](https://github.com/intridea/grape-entity) gem to your Gemfile.
-Please refer to the [grape-entity documentation](https://github.com/intridea/grape-entity/blob/master/README.markdown)
+Please refer to the [grape-entity documentation](https://github.com/intridea/grape-entity/blob/master/README.md)
 for more details.
 
 The following example exposes statuses.
@@ -1006,7 +1014,7 @@ module API
       expose :user_name
       expose :text, documentation: { type: "string", desc: "Status update text." }
       expose :ip, if: { type: :full }
-      expose :user_type, user_id, if: lambda{ |status, options| status.user.public? }
+      expose :user_type, user_id, if: lambda { |status, options| status.user.public? }
       expose :digest { |status, options| Digest::MD5.hexdigest(status.txt) }
       expose :replies, using: API::Status, as: :replies
     end

data/RELEASING.md

@@ -0,0 +1,105 @@
+Releasing Grape
+===============
+
+There're no particular rules about when to release Grape. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/intridea/grape) for all supported platforms.
+
+Those with r/w permissions to the [master Intridea repository](https://github.com/intridea/grape) generally have large Grape-based projects. Point one to Grape HEAD and run all your API tests to catch any obvious regressions.
+
+```
+gem grape, github: 'intridea/grape'
+```
+
+Increment the version, modify [lib/grape/version.rb](lib/grape/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.6.0`).
+
+Modify the "Stable Release" section in [README.md](README.md). Change the text to reflect that this is going to be the documentation for a stable release. Remove references to the previous release of Grape. Keep the file open, you'll have to undo this change after the release.
+
+```
+## Stable Release
+
+You're reading the documentation for the stable release of Grape, 0.6.0.
+```
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+0.6.0 (9/16/2013)
+=================
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md lib/grape/version.rb
+git commit -m "Preparing for release, 0.6.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+grape 0.6.0 built to pkg/grape-0.6.0.gem.
+Tagged v0.6.0.
+Pushed git commits and tags.
+Pushed grape 0.6.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Modify the "Stable Release" section in [README.md](README.md). Change the text to reflect that this is going to be the next release.
+
+```
+## Stable Release
+
+You're reading the documentation for the next release of Grape, which should be 0.6.1.
+The current stable release is [0.6.0](https://github.com/intridea/grape/blob/v0.6.0/README.md).
+```
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Comit your changes.
+
+```
+git add CHANGELOG.md README.md
+git commit -m "Preparing for next release."
+git push origin master
+```
+
+### Make an Announcement
+
+Make an announcement on the [ruby-grape@googlegroups.com](mailto:ruby-grape@googlegroups.com) mailing list. The general format is as follows.
+
+```
+Grape 0.6.0 has been released.
+
+There were 8 contributors to this release, not counting documentation.
+
+Please note the breaking API change in ...
+
+[copy/paste CHANGELOG here]
+
+```

data/grape.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'
   s.add_runtime_dependency 'multi_xml', '>= 0.5.2'
   s.add_runtime_dependency 'hashie', '>= 1.2.0'
-  s.add_runtime_dependency 'virtus'
+  s.add_runtime_dependency 'virtus', '>= 1.0.0'
   s.add_runtime_dependency 'builder'
 
   s.add_development_dependency 'grape-entity', '>= 0.2.0'

data/lib/grape.rb

@@ -44,6 +44,7 @@ module Grape
     autoload :UnknownValidator,               'grape/exceptions/unknown_validator'
     autoload :UnknownOptions,                 'grape/exceptions/unknown_options'
     autoload :InvalidWithOptionForRepresent,  'grape/exceptions/invalid_with_option_for_represent'
+    autoload :IncompatibleOptionValues,       'grape/exceptions/incompatible_option_values'
   end
 
   module ErrorFormatter

data/lib/grape/api.rb

@@ -26,7 +26,7 @@ module Grape
       end
 
       def compile
-        @instance = self.new
+        @instance = new
       end
 
       def change!
@@ -81,12 +81,12 @@ module Grape
       #     version 'v2'
       #
       #     get '/main' do
-      #       {:some => 'data'}
+      #       {some: 'data'}
       #     end
       #
       #     version 'v1' do
       #       get '/main' do
-      #         {:legacy => 'data'}
+      #         {legacy: 'data'}
       #       end
       #     end
       #   end
@@ -95,7 +95,7 @@ module Grape
         if args.any?
           options = args.pop if args.last.is_a? Hash
           options ||= {}
-          options = {:using => :path}.merge!(options)
+          options = { using: :path }.merge(options)
 
           raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.has_key?(:vendor)
 
@@ -111,7 +111,7 @@ module Grape
 
       # Add a description to the next namespace or function.
       def desc(description, options = {})
-        @last_description = options.merge(:description => description)
+        @last_description = options.merge(description: description)
       end
 
       # Specify the default format for the API's serializers.
@@ -147,8 +147,13 @@ module Grape
       end
 
       # Specify a default error formatter.
-      def default_error_formatter(new_formatter = nil)
-        new_formatter ? set(:default_error_formatter, new_formatter) : settings[:default_error_formatter]
+      def default_error_formatter(new_formatter_name = nil)
+        if new_formatter_name
+          new_formatter = Grape::ErrorFormatter::Base.formatter_for(new_formatter_name, {})
+          set(:default_error_formatter, new_formatter)
+        else
+          settings[:default_error_formatter]
+        end
       end
 
       def error_formatter(format, options)
@@ -204,9 +209,7 @@ module Grape
         end
 
         options = args.last.is_a?(Hash) ? args.pop : {}
-        if options.has_key?(:with)
-          handler ||= proc { options[:with] }
-        end
+        handler ||= proc { options[:with] } if options.has_key?(:with)
 
         if handler
           args.each do |arg|
@@ -215,8 +218,12 @@ module Grape
         end
 
         imbue(:rescue_options, options)
-        set(:rescue_all, true) and return if args.include?(:all)
-        imbue(:rescued_errors, args)
+
+        if args.include?(:all)
+          set(:rescue_all, true)
+        else
+          imbue(:rescued_errors, args)
+        end
       end
 
       # Allows you to specify a default representation entity for a
@@ -225,10 +232,10 @@ module Grape
       #
       # @example
       #   class ExampleAPI < Grape::API
-      #     represent User, :with => Entity::User
+      #     represent User, with: Entity::User
       #
       #     get '/me' do
-      #       present current_user # :with => Entity::User is assumed
+      #       present current_user # with: Entity::User is assumed
       #     end
       #   end
       #
@@ -271,7 +278,7 @@ module Grape
               include new_mod
             end
           end
-          mod.class_eval &block if block_given?
+          mod.class_eval(&block) if block_given?
           set(:helpers, mod)
         else
           mod = Module.new
@@ -287,7 +294,7 @@ module Grape
       # only `:http_basic`, `:http_digest` and `:oauth2` are supported.
       def auth(type = nil, options = {}, &block)
         if type
-          set(:auth, {:type => type.to_sym, :proc => block}.merge(options))
+          set(:auth, { type: type.to_sym, proc: block }.merge(options))
         else
           settings[:auth]
         end
@@ -313,14 +320,14 @@ module Grape
         mounts.each_pair do |app, path|
           if app.respond_to?(:inherit_settings, true)
             app_settings = settings.clone
-            mount_path = Rack::Mount::Utils.normalize_path([ settings[:mount_path], path ].compact.join("/"))
+            mount_path = Rack::Mount::Utils.normalize_path([settings[:mount_path], path].compact.join("/"))
             app_settings.set :mount_path, mount_path
             app.inherit_settings(app_settings)
           end
           endpoints << Grape::Endpoint.new(settings.clone, {
-            :method => :any,
-            :path => path,
-            :app => app
+            method: :any,
+            path: path,
+            app: app
           })
         end
       end
@@ -334,14 +341,14 @@ module Grape
       # @example Defining a basic route.
       #   class MyAPI < Grape::API
       #     route(:any, '/hello') do
-      #       {:hello => 'world'}
+      #       {hello: 'world'}
       #     end
       #   end
       def route(methods, paths = ['/'], route_options = {}, &block)
         endpoint_options = {
-          :method => methods,
-          :path => paths,
-          :route_options => (@namespace_description || {}).deep_merge(@last_description || {}).deep_merge(route_options || {})
+          method: methods,
+          path: paths,
+          route_options: (@namespace_description || {}).deep_merge(@last_description || {}).deep_merge(route_options || {})
         }
         endpoints << Grape::Endpoint.new(settings.clone, endpoint_options, &block)
 
@@ -361,13 +368,33 @@ module Grape
         imbue(:afters, [block])
       end
 
-      def get(paths = ['/'], options = {}, &block); route('GET', paths, options, &block) end
-      def post(paths = ['/'], options = {}, &block); route('POST', paths, options, &block) end
-      def put(paths = ['/'], options = {}, &block); route('PUT', paths, options, &block) end
-      def head(paths = ['/'], options = {}, &block); route('HEAD', paths, options, &block) end
-      def delete(paths = ['/'], options = {}, &block); route('DELETE', paths, options, &block) end
-      def options(paths = ['/'], options = {}, &block); route('OPTIONS', paths, options, &block) end
-      def patch(paths = ['/'], options = {}, &block); route('PATCH', paths, options, &block) end
+      def get(paths = ['/'], options = {}, &block)
+        route('GET', paths, options, &block)
+      end
+
+      def post(paths = ['/'], options = {}, &block)
+        route('POST', paths, options, &block)
+      end
+
+      def put(paths = ['/'], options = {}, &block)
+        route('PUT', paths, options, &block)
+      end
+
+      def head(paths = ['/'], options = {}, &block)
+        route('HEAD', paths, options, &block)
+      end
+
+      def delete(paths = ['/'], options = {}, &block)
+        route('DELETE', paths, options, &block)
+      end
+
+      def options(paths = ['/'], options = {}, &block)
+        route('OPTIONS', paths, options, &block)
+      end
+
+      def patch(paths = ['/'], options = {}, &block)
+        route('PATCH', paths, options, &block)
+      end
 
       def namespace(space = nil, options = {},  &block)
         if space || block_given?
@@ -422,7 +449,10 @@ module Grape
       # and arguments that are currently applied to the
       # application.
       def middleware
-        settings.stack.inject([]){|a,s| a += s[:middleware] if s[:middleware]; a}
+        settings.stack.inject([]) do |a, s|
+          a += s[:middleware] if s[:middleware]
+          a
+        end
       end
 
       # An array of API routes.
@@ -435,9 +465,11 @@ module Grape
       end
 
       def cascade(value = nil)
-        value.nil? ?
-          (settings.has_key?(:cascade) ? !! settings[:cascade] : true) :
+        if value.nil?
+          settings.has_key?(:cascade) ? !!settings[:cascade] : true
+        else
           set(:cascade, value)
+        end
       end
 
       protected
@@ -454,15 +486,15 @@ module Grape
       # block passed in. Allows for simple 'before' setups
       # of settings stack pushes.
       def nest(*blocks, &block)
-        blocks.reject!{|b| b.nil?}
+        blocks.reject! { |b| b.nil? }
         if blocks.any?
           settings.push  # create a new context to eval the follow
-          instance_eval &block if block_given?
-          blocks.each{|b| instance_eval &b}
-          settings.pop   # when finished, we pop the context
+          instance_eval(&block) if block_given?
+          blocks.each { |b| instance_eval(&b) }
+          settings.pop # when finished, we pop the context
           reset_validations!
         else
-          instance_eval &block
+          instance_eval(&block)
         end
       end
 
@@ -492,7 +524,7 @@ module Grape
     def call(env)
       status, headers, body = @route_set.call(env)
       headers.delete('X-Cascade') unless cascade?
-      [ status, headers, body ]
+      [status, headers, body]
     end
 
     # Some requests may return a HTTP 404 error if grape cannot find a matching
@@ -504,8 +536,8 @@ module Grape
     # errors from reaching upstream. This is effectivelly done by unsetting
     # X-Cascade. Default :cascade is true.
     def cascade?
-      return !! self.class.settings[:cascade] if self.class.settings.has_key?(:cascade)
-      return !! self.class.settings[:version_options][:cascade] if self.class.settings[:version_options] && self.class.settings[:version_options].has_key?(:cascade)
+      return !!self.class.settings[:cascade] if self.class.settings.has_key?(:cascade)
+      return !!self.class.settings[:version_options][:cascade] if self.class.settings[:version_options] && self.class.settings[:version_options].has_key?(:cascade)
       true
     end
 
@@ -518,32 +550,34 @@ module Grape
     # will return an HTTP 405 response for any HTTP method that the resource
     # cannot handle.
     def add_head_not_allowed_methods
-      allowed_methods = Hash.new{|h,k| h[k] = [] }
-      resources       = self.class.endpoints.map do |endpoint|
-        endpoint.options[:app] && endpoint.options[:app].respond_to?(:endpoints) ?
-          endpoint.options[:app].endpoints.map(&:routes) :
+      allowed_methods = Hash.new { |h, k| h[k] = [] }
+      resources = self.class.endpoints.map do |endpoint|
+        if endpoint.options[:app] && endpoint.options[:app].respond_to?(:endpoints)
+          endpoint.options[:app].endpoints.map(&:routes)
+        else
           endpoint.routes
+        end
       end
       resources.flatten.each do |route|
         allowed_methods[route.route_compiled] << route.route_method
       end
       allowed_methods.each do |path_info, methods|
-        if methods.include?('GET') && ! methods.include?("HEAD") && ! self.class.settings[:do_not_route_head]
-          methods = methods | [ 'HEAD' ]
+        if methods.include?('GET') && !methods.include?("HEAD") && !self.class.settings[:do_not_route_head]
+          methods = methods | ['HEAD']
         end
         allow_header = (["OPTIONS"] | methods).join(", ")
         unless methods.include?("OPTIONS") || self.class.settings[:do_not_route_options]
-          @route_set.add_route( proc { [204, { 'Allow' => allow_header }, []]}, {
-            :path_info      => path_info,
-            :request_method => "OPTIONS"
+          @route_set.add_route(proc { [204, { 'Allow' => allow_header }, []] }, {
+            path_info: path_info,
+            request_method: "OPTIONS"
           })
         end
         not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - methods
         not_allowed_methods << "OPTIONS" if self.class.settings[:do_not_route_options]
         not_allowed_methods.each do |bad_method|
-          @route_set.add_route( proc { [405, { 'Allow' => allow_header, 'Content-Type' => 'text/plain' }, []]}, {
-            :path_info      => path_info,
-            :request_method => bad_method
+          @route_set.add_route(proc { [405, { 'Allow' => allow_header, 'Content-Type' => 'text/plain' }, []] }, {
+            path_info: path_info,
+            request_method: bad_method
           })
         end
       end