grape 0.3.0 → 0.7.0

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/Rakefile

@@ -15,29 +15,50 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
 end
 
 task :spec
-task :default => :spec
+
+require 'rainbow/ext/string' unless String.respond_to?(:color)
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]
 
 begin
   require 'yard'
-  DOC_FILES = ['lib/**/*.rb', 'README.markdown']
-  
+  DOC_FILES = ['lib/**/*.rb', 'README.md']
+
   YARD::Rake::YardocTask.new(:doc) do |t|
     t.files   = DOC_FILES
   end
-  
+
   namespace :doc do
     YARD::Rake::YardocTask.new(:pages) do |t|
       t.files   = DOC_FILES
-      t.options = ['-o', '../grape.doc']
+      t.options = ['-o', '../grape.doc/docs']
     end
-    
+
     namespace :pages do
+
+      desc "Check out gh-pages."
+      task :checkout do
+        dir = File.dirname(__FILE__) + '/../grape.doc'
+        unless Dir.exist?(dir)
+          Dir.mkdir(dir)
+          Dir.chdir(dir) do
+            system("git init")
+            system("git remote add origin git@github.com:intridea/grape.git")
+            system("git pull")
+            system("git checkout gh-pages")
+          end
+        end
+      end
+
       desc 'Generate and publish YARD docs to GitHub pages.'
-      task :publish => ['doc:pages'] do
+      task :publish => ['doc:pages:checkout', 'doc:pages'] do
         Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
+          system("git checkout gh-pages")
           system("git add .")
           system("git add -u")
-          system("git commit -m 'Generating docs for version #{version}.'")
+          system("git commit -m 'Generating docs for version #{Grape::VERSION}.'")
           system("git push origin gh-pages")
         end
       end

data/UPGRADING.md

@@ -0,0 +1,124 @@
+Upgrading Grape
+===============
+
+### Upgrading to 0.7.0
+
+#### Changes in Exception Handling
+
+Assume you have the following exception classes defined.
+
+```ruby
+class ParentError < StandardError; end
+class ChildError < ParentError; end
+```
+
+In Grape <= 0.6.1, the `rescue_from` keyword only handled the exact exception being raised. The following code would rescue `ParentError`, but not `ChildError`.
+
+```ruby
+rescue_from ParentError do |e|
+  # only rescue ParentError
+end
+```
+
+This made it impossible to rescue an exception hieararchy, which is a more sensible default. In Grape 0.7.0 or newer, both `ParentError` and `ChildError` are rescued.
+
+```ruby
+rescue_from ParentError do |e|
+  # rescue both ParentError and ChildError
+end
+```
+
+To only rescue the base exception class, set `rescue_subclasses: false`.
+
+```ruby
+rescue_from ParentError, rescue_subclasses: false do |e|
+  # only rescue ParentError
+end
+```
+
+See [#544](https://github.com/intridea/grape/pull/544) for more information.
+
+
+#### Changes in the Default HTTP Status Code
+
+In Grape <= 0.6.1, the default status code returned from `error!` was 403.
+
+```ruby
+error! "You may not reticulate this spline!" # yields HTTP error 403
+```
+
+This was a bad default value, since 403 means "Forbidden". Change any call to `error!` that does not specify a status code to specify one. The new default value is a more sensible default of 500, which is "Internal Server Error".
+
+```ruby
+error! "You may not reticulate this spline!", 403 # yields HTTP error 403
+```
+
+You may also use `default_error_status` to change the global default.
+
+```ruby
+default_error_status 400
+```
+
+See [#525](https://github.com/intridea/Grape/pull/525) for more information.
+
+
+#### Changes in Parameter Declaration and Validation
+
+In Grape <= 0.6.1, `group`, `optional` and `requires` keywords with a block accepted either an `Array` or a `Hash`.
+
+```ruby
+params do
+  requires :id, type: Integer
+  group :name do
+    requires :first_name
+    requires :last_name
+  end
+end
+```
+
+This caused the ambiguity and unexpected errors described in [#543](https://github.com/intridea/Grape/issues/543).
+
+In Grape 0.6.2, the `group`, `optional` and `requires` keywords take an additional `type` attribute which defaults to `Array`. This means that without a `type` attribute, these nested parameters will no longer accept a single hash, only an array (of hashes).
+
+Whereas in 0.6.1 the API above accepted the following json, it no longer does in 0.6.2.
+
+```json
+{
+  "id": 1,
+  "name": {
+    "first_name": "John",
+    "last_name" : "Doe"
+  }
+}
+```
+
+The `params` block should now read as follows.
+
+```ruby
+params do
+  requires :id, type: Integer
+  requires :name, type: Hash do
+    requires :first_name
+    requires :last_name
+  end
+end
+```
+
+See [#545](https://github.com/intridea/Grape/pull/545) for more information.
+
+
+### Upgrading to 0.6.0
+
+In Grape <= 0.5.0, only the first validation error was raised and processing aborted. Validation errors are now collected and a single `Grape::Exceptions::ValidationErrors` exception is raised. You can access the collection of validation errors as `.errors`.
+
+```ruby
+rescue_from Grape::Exceptions::Validations do |e|
+  Rack::Response.new({
+    status: 422,
+    message: e.message,
+    errors: e.errors
+  }.to_json, 422)
+end
+```
+
+For more information see [#462](https://github.com/intridea/grape/issues/462).

data/grape.gemspec

@@ -14,14 +14,14 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "grape"
 
-  s.add_runtime_dependency 'rack'
+  s.add_runtime_dependency 'rack', '>= 1.3.0'
   s.add_runtime_dependency 'rack-mount'
   s.add_runtime_dependency 'rack-accept'
   s.add_runtime_dependency 'activesupport'
   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'
-  s.add_runtime_dependency 'virtus'
+  s.add_runtime_dependency 'hashie', '>= 1.2.0'
+  s.add_runtime_dependency 'virtus', '>= 1.0.0'
   s.add_runtime_dependency 'builder'
 
   s.add_development_dependency 'grape-entity', '>= 0.2.0'