grape 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19ace46ada09b1ab69918bf173940735acde0bbe
-  data.tar.gz: 58f1a9cc4503974439dc28d496ecaab1668d0479
+  metadata.gz: a10ed4eece4262170f1bdd034e27829f5da0976c
+  data.tar.gz: 71ede66f37c08766ad1c978f0bbc42cb7ecc5ea9
 SHA512:
-  metadata.gz: ead945737e0a4e6acf57803f1a86c19c43b999ea58c71cd7a07a8dc30e826e25515017ccf60714992c7a2a0e66a0f58789bcbff549bb65c92bc8fef4d06c762d
-  data.tar.gz: 6d509b5dc49fd2f083cdb5a97e70fa17a43ad5bb6f282afa3e7ce23bd0fa73f85cf5417d6ed703e1747111b5ab3491376748a73d007df9387d9c2f5ace3ac553
+  metadata.gz: ab6b58872ecdd19c14ee84980de47e7984edabeb95ea4de0491ee72b5c2eff6aa9f18e4c961751c338638c77f90b86fe21abb58e71e10ae574fce308b14305ac
+  data.tar.gz: e101543915e945736dbeb2f92f198941197b5b9abd0613961af6a955e9782d9e70ea522a1e27aa93799bd227c3db7837fd35a66dec412dc63d1633f32cca3193

data/CHANGELOG.md

@@ -1,14 +1,33 @@
+0.18.0 (10/7/2016)
+==================
+
+#### Features
+
+* [#1480](https://github.com/ruby-grape/grape/pull/1480): Use the ruby-grape-danger gem for PR linting - [@dblock](https://github.com/dblock).
+* [#1486](https://github.com/ruby-grape/grape/pull/1486): Implemented except in values validator - [@jonmchan](https://github.com/jonmchan).
+* [#1470](https://github.com/ruby-grape/grape/pull/1470): Drop support for ruby-2.0 - [@namusyaka](https://github.com/namusyaka).
+* [#1490](https://github.com/ruby-grape/grape/pull/1490): Switch to Ruby-2.x+ syntax - [@namusyaka](https://github.com/namusyaka).
+* [#1499](https://github.com/ruby-grape/grape/pull/1499): Support fail_fast param validation option - [@dgasper](https://github.com/dgasper).
+
+#### Fixes
+
+* [#1498](https://github.com/ruby-grape/grape/pull/1498): Skip validations in inactive given blocks - [@jlfaber](https://github.com/jlfaber).
+* [#1479](https://github.com/ruby-grape/grape/pull/1479): Support inserting middleware before/after anonymous classes in the middleware stack - [@rosa](https://github.com/rosa).
+* [#1488](https://github.com/ruby-grape/grape/pull/1488): Ensure calling before filters when receiving OPTIONS request - [@namusyaka](https://github.com/namusyaka), [@jlfaber](https://github.com/jlfaber).
+* [#1493](https://github.com/ruby-grape/grape/pull/1493): Coercion and lambda fails params validation - [@jonmchan](https://github.com/jonmchan).
+
 0.17.0 (7/29/2016)
 ==================
 
 #### Features
 
 * [#1393](https://github.com/ruby-grape/grape/pull/1393): Middleware can be inserted before or after default Grape middleware - [@ridiculous](https://github.com/ridiculous).
-* [#1390](https://github.com/ruby-grape/grape/pull/1390): Allow inserting middleware at arbitrary points in the middleware stack - [@Rosa](https://github.com/Rosa).
+* [#1390](https://github.com/ruby-grape/grape/pull/1390): Allow inserting middleware at arbitrary points in the middleware stack - [@rosa](https://github.com/rosa).
 * [#1366](https://github.com/ruby-grape/grape/pull/1366): Store `message_key` on `Grape::Exceptions::Validation` - [@mkou](https://github.com/mkou).
 * [#1398](https://github.com/ruby-grape/grape/pull/1398): Add `rescue_from :grape_exceptions` - allow Grape to use the built-in `Grape::Exception` handing and use `rescue :all` behavior for everything else - [@mmclead](https://github.com/mmclead).
 * [#1443](https://github.com/ruby-grape/grape/pull/1443): Extend `given` to receive a `Proc` - [@glaucocustodio](https://github.com/glaucocustodio).
 * [#1455](https://github.com/ruby-grape/grape/pull/1455): Add an automated PR linter - [@orta](https://github.com/orta).
+* Your contribution here.
 
 #### Fixes
 
@@ -311,7 +330,7 @@
 
 #### Features
 
-* Grape is no longer tested against Ruby 1.8.7.
+* Grape is no longer tested against Ruby 1.8.7 - [@dblock](https://github.com/dblock).
 * [#442](https://github.com/ruby-grape/grape/issues/442): Enable incrementally building on top of a previous API version - [@dblock](https://github.com/dblock).
 * [#442](https://github.com/ruby-grape/grape/issues/442): API `version` can now take an array of multiple versions - [@dblock](https://github.com/dblock).
 * [#444](https://github.com/ruby-grape/grape/issues/444): Added `:en` as fallback locale for I18n - [@aew](https://github.com/aew).
@@ -460,7 +479,7 @@
 * [#204](https://github.com/ruby-grape/grape/pull/204): Added ability to declare shared `params` at `namespace` level - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
 * [#234](https://github.com/ruby-grape/grape/pull/234): Added a DSL for creating entities via mixin - [@mbleigh](https://github.com/mbleigh).
 * [#240](https://github.com/ruby-grape/grape/pull/240): Define API response format from a query string `format` parameter, if specified - [@neetiraj](https://github.com/neetiraj).
-* Adds Endpoint#declared to easily filter out unexpected params. - [@mbleigh](https://github.com/mbleigh)
+* Adds Endpoint#declared to easily filter out unexpected params - [@mbleigh](https://github.com/mbleigh).
 
 #### Fixes
 

data/Dangerfile

@@ -1,80 +1 @@
-# --------------------------------------------------------------------------------------------------------------------
-# Has any changes happened inside the actual library code?
-# --------------------------------------------------------------------------------------------------------------------
-has_app_changes = !git.modified_files.grep(/lib/).empty?
-has_spec_changes = !git.modified_files.grep(/spec/).empty?
-
-# --------------------------------------------------------------------------------------------------------------------
-# You've made changes to lib, but didn't write any tests?
-# --------------------------------------------------------------------------------------------------------------------
-if has_app_changes && !has_spec_changes
-  raise("There're library changes, but not tests. That's OK as long as you're refactoring existing code.", sticky: false)
-end
-
-# --------------------------------------------------------------------------------------------------------------------
-# You've made changes to specs, but no library code has changed?
-# --------------------------------------------------------------------------------------------------------------------
-if !has_app_changes && has_spec_changes
-  message('We really appreciate pull requests that demonstrate issues, even without a fix. That said, the next step is to try and fix the failing tests!', sticky: false)
-end
-
-# --------------------------------------------------------------------------------------------------------------------
-# Have you updated CHANGELOG.md?
-# --------------------------------------------------------------------------------------------------------------------
-if !git.modified_files.include?('CHANGELOG.md') && has_app_changes
-  pr_number = github.pr_json['number']
-  markdown <<-MARKDOWN
-Here's an example of a CHANGELOG.md entry:
-
-```markdown
-* [##{pr_number}](https://github.com/ruby-grape/grape/pull/#{pr_number}): #{github.pr_title} - [@#{github.pr_author}](https://github.com/#{github.pr_author}).
-```
-MARKDOWN
-  raise('Please update CHANGELOG.md.', sticky: false)
-end
-
-# --------------------------------------------------------------------------------------------------------------------
-# Is the CHANGELOG.md format correct?
-# --------------------------------------------------------------------------------------------------------------------
-
-your_contribution_here = false
-releases = 0
-errors = 0
-File.open('CHANGELOG.md').each_line do |line|
-  # only look at the top releases, we entered a lot of changes without a PR before
-  if line == "==================\n"
-    releases += 1
-    break if releases == 5
-  end
-  # ignore lines that aren't changes
-  next unless line[0] == '*'
-  # notice your contribution here
-  if line == "* Your contribution here.\n"
-    your_contribution_here = true
-    next
-  end
-  # match the PR format
-  next if line =~ %r{^\*\s\[\#\d+\]\(https:\/\/github\.com\/.*\d+\)\: [\`[:upper:]].* \- \[\@[\w\d\-\_]+\]\(https:\/\/github\.com\/.*[\w\d\-\_]+\)\.$}
-  errors += 1
-  markdown <<-MARKDOWN
-```markdown
-#{line}```
-  MARKDOWN
-end
-
-raise("One of the lines below found in CHANGELOG.md doesn't match the expected format. Please make it look like the other lines, pay attention to periods and spaces.", sticky: false) if errors > 0
-raise('Please put back the `* Your contribution here.` line into CHANGELOG.md.', sticky: false) unless your_contribution_here
-
-# --------------------------------------------------------------------------------------------------------------------
-# Don't let testing shortcuts get into master by accident,
-# ensuring that we don't get green builds based on a subset of tests.
-# --------------------------------------------------------------------------------------------------------------------
-
-(git.modified_files + git.added_files - %w(Dangerfile)).each do |file|
-  next unless File.file?(file)
-  contents = File.read(file)
-  if file.start_with?('spec')
-    raise("`xit` or `fit` left in tests (#{file})") if contents =~ /^\w*[xf]it/
-    raise("`fdescribe` left in tests (#{file})") if contents =~ /^\w*fdescribe/
-  end
-end
+danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -28,5 +28,5 @@ group :test do
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'
   gem 'mime-types', '< 3.0'
-  gem 'danger', '~> 2.0'
+  gem 'ruby-grape-danger', '~> 0.1.0', require: false
 end

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    grape (0.17.0)
+    grape (0.18.0)
       activesupport
       builder
       hashie (>= 2.1.0)
       multi_json (>= 1.3.2)
       multi_xml (>= 0.5.2)
-      mustermann19 (~> 0.4.3)
+      mustermann-grape (~> 0.4.0)
       rack (>= 1.3.0)
       rack-accept
       virtus (>= 1.0.0)
@@ -15,26 +15,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.6)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.4.0)
     appraisal (2.1.0)
       bundler
       rake
       thor (>= 0.14.0)
-    ast (2.2.0)
+    ast (2.3.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    benchmark-ips (2.6.1)
+    benchmark-ips (2.7.2)
     builder (3.2.2)
     claide (1.0.0)
-    claide-plugins (0.9.1)
+    claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
@@ -42,38 +41,46 @@ GEM
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     colored (1.2)
+    concurrent-ruby (1.0.2)
     cookiejar (0.3.3)
-    cork (0.1.0)
+    cork (0.2.0)
       colored (~> 1.2)
-    danger (2.0.1)
+    danger (3.2.2)
       claide (~> 1.0)
       claide-plugins (> 0.9.0)
       colored (~> 1.2)
       cork (~> 0.1)
-      faraday (~> 0)
+      faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
       git (~> 1)
+      gitlab (~> 3.7.0)
+      kramdown (~> 1.5)
       octokit (~> 4.2)
-      redcarpet (~> 3.3)
       terminal-table (~> 1)
+    danger-changelog (0.1.0)
+      danger-plugin-api (~> 1.0)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
-    enumerable-lazy (0.0.1)
     equalizer (0.0.11)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.0)
+    faraday-http-cache (1.3.1)
       faraday (~> 0.8)
-    ffi (1.9.10)
+    ffi (1.9.14)
     formatador (0.2.5)
     git (1.3.0)
+    gitlab (3.7.0)
+      httparty (~> 0.13.0)
+      terminal-table
     grape-entity (0.5.0)
       activesupport
       multi_json (>= 1.3.2)
-    guard (2.13.0)
+    guard (2.14.0)
       formatador (>= 0.2.4)
-      listen (>= 2.7, <= 4.0)
+      listen (>= 2.7, < 4.0)
       lumberjack (~> 1.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
@@ -81,47 +88,53 @@ GEM
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    guard-rspec (4.6.5)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     guard-rubocop (1.2.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
-    hashie (3.4.4)
+    hashie (3.4.6)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
     i18n (0.7.0)
     ice_nine (0.11.2)
     json (1.8.3)
-    listen (3.1.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9.7)
-      ruby_dep (~> 1.1)
+    kramdown (1.12.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
     lumberjack (1.0.10)
     maruku (0.7.2)
     method_source (0.8.2)
-    mime-types (2.99.1)
-    minitest (5.8.4)
-    multi_json (1.11.3)
+    mime-types (2.99.3)
+    minitest (5.9.1)
+    multi_json (1.12.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    mustermann19 (0.4.4)
-      enumerable-lazy
+    mustermann (0.4.0)
+      tool (~> 0.2)
+    mustermann-grape (0.4.0)
+      mustermann (= 0.4.0)
     nap (1.1.0)
     nenv (0.3.0)
-    notiffany (0.0.8)
+    notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
     octokit (4.3.0)
       sawyer (~> 0.7.0, >= 0.5.3)
     open4 (1.3.4)
-    parser (2.3.1.0)
+    parser (2.3.1.4)
       ast (~> 2.2)
     powerpack (0.1.1)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.6.4)
+    rack (2.0.1)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-jsonp (1.3.1)
@@ -129,49 +142,54 @@ GEM
     rack-test (0.6.3)
       rack (>= 1.0)
     rainbow (2.1.0)
-    rake (11.1.2)
+    rake (11.3.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
     redcarpet (3.3.4)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
     rubocop (0.39.0)
       parser (>= 2.3.0.7, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.0)
-    ruby_dep (1.1.0)
+    ruby-grape-danger (0.1.0)
+      danger (~> 3.2.0)
+      danger-changelog (~> 0.1.0)
+    ruby-progressbar (1.8.1)
+    ruby_dep (1.4.0)
     sawyer (0.7.0)
       addressable (>= 2.3.5, < 2.5)
       faraday (~> 0.8, < 0.10)
     shellany (0.0.1)
     slop (3.6.0)
-    terminal-table (1.6.0)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
     thor (0.19.1)
     thread_safe (0.3.5)
+    tool (0.2.3)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    unicode-display_width (1.0.5)
+    unicode-display_width (1.1.1)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
-    yard (0.8.7.6)
+    yard (0.9.5)
 
 PLATFORMS
   ruby
@@ -181,7 +199,6 @@ DEPENDENCIES
   benchmark-ips
   bundler
   cookiejar
-  danger (~> 2.0)
   grape!
   grape-entity (= 0.5.0)
   guard
@@ -195,7 +212,8 @@ DEPENDENCIES
   redcarpet
   rspec (~> 3.0)
   rubocop (= 0.39.0)
+  ruby-grape-danger (~> 0.1.0)
   yard
 
 BUNDLED WITH
-   1.12.1
+   1.12.5

data/README.md

@@ -5,6 +5,7 @@
 [![Dependency Status](https://gemnasium.com/ruby-grape/grape.svg)](https://gemnasium.com/ruby-grape/grape)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape.svg)](https://codeclimate.com/github/ruby-grape/grape)
 [![Inline docs](http://inch-ci.org/github/ruby-grape/grape.svg)](http://inch-ci.org/github/ruby-grape/grape)
+[![git.legal](https://git.legal/projects/1364/badge.svg "Number of libraries approved")](https://git.legal/projects/1364)
 [![Join the chat at https://gitter.im/ruby-grape/grape](https://badges.gitter.im/ruby-grape/grape.svg)](https://gitter.im/ruby-grape/grape?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Table of Contents
@@ -1063,6 +1064,26 @@ params do
 end
 ```
 
+The values validator can also validate that the value is explicitly not within a specific
+set of values by passing ```except```. ```except``` accepts the same types of parameters as
+values (Procs, ranges, etc.).
+
+```ruby
+params do
+  requires :browsers, values: { except: [ 'ie6', 'ie7', 'ie8' ] }
+end
+```
+
+Values and except can be combined to define a range of accepted values while not allowing
+certain values within the set. Custom error messages can be defined for both when the parameter 
+passed falls within the ```except``` list or when it falls entirely outside the ```value``` list. 
+
+```ruby
+params do
+  requires :number, type: Integer, values: { value: 1..20 except: [4,13], except_message: 'includes unsafe numbers', message: 'is outside the range of numbers allowed' }
+end
+```
+
 #### `regexp`
 
 Parameters can be restricted to match a specific regular expression with the `:regexp` option. If the value
@@ -1333,6 +1354,25 @@ subject.rescue_from Grape::Exceptions::ValidationErrors do |e|
 end
 ```
 
+Grape returns all validation and coercion errors found by default.
+To skip all subsequent validation checks when a specific param is found invalid, use `fail_fast: true`.
+
+The following example will not check if `:wine` is present unless it finds `:beer`.
+```ruby
+params do
+  required :beer, fail_fast: true
+  required :wine
+end
+```
+The result of empty params would be a single `Grape::Exceptions::ValidationErrors` error.
+
+Similarly, no regular expression test will be performed if `:blah` is blank in the following example.
+```ruby
+params do
+  required :blah, allow_blank: false, regexp: /blah/, fail_fast: true
+end
+```
+
 ### I18n
 
 Grape supports I18n for parameter-related error messages, but will fallback to English if
@@ -1866,7 +1906,7 @@ end
 ```
 
 Grape can also rescue from all exceptions and still use the built-in exception handing.
-This will give the same behavior as `rescue_from :all` with the addition that Grape will use the exception handling defined by all Exception classes that inherit Grape::Exceptions::Base.
+This will give the same behavior as `rescue_from :all` with the addition that Grape will use the exception handling defined by all Exception classes that inherit `Grape::Exceptions::Base`.
 
 The intent of this setting is to provide a simple way to cover the most common exceptions and return any unexpected exceptions in the API format.
 
@@ -3214,6 +3254,7 @@ Grape integrates with following third-party tools:
 * **New Relic** - [built-in support](https://docs.newrelic.com/docs/agents/ruby-agent/frameworks/grape-instrumentation) from v3.10.0 of the official [newrelic_rpm](https://github.com/newrelic/rpm) gem, also [newrelic-grape](https://github.com/xinminlabs/newrelic-grape) gem
 * **Librato Metrics** - [grape-librato](https://github.com/seanmoon/grape-librato) gem
 * **[Skylight](https://www.skylight.io/)** - [skylight](https://github.com/skylightio/skylight-ruby) gem, [documentation](https://docs.skylight.io/grape/)
+* **[AppSignal](https://www.appsignal.com)** - [appsignal-ruby](https://github.com/appsignal/appsignal-ruby) gem, [documentation](http://docs.appsignal.com/getting-started/supported-frameworks.html#grape)
 
 ## Contributing to Grape