restfulness 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce9b42d05b92e2107f89ce16f36a5f1bbfabe6e7
-  data.tar.gz: b9cb7bdc241661ab063b45f20a81a967f43eeee6
+  metadata.gz: 44dda2a03759ad284a1ab8a77565c243228a4f71
+  data.tar.gz: ef7033d6a4fa26f6918a2c6fbabedf11e866f681
 SHA512:
-  metadata.gz: 7809aad851643407a59b3d376a75d39c4a1f703cf18cc647817e018971434e547dd8fbfcbd6b01e6dafb3aa7e510eee7233ca5a75ecf839239b52596e5bac5ca
-  data.tar.gz: f8fbe0c48f0a05bd5f50f48ccb56545afed3408ed5d4941ffd7db5303dbb107203b6656de0c7f13cf937bb88ee716dd2b7d8a7499681abdfbdc2492dc3f14206
+  metadata.gz: 07f9fadd9d7ac37a8a98a15bb1f1725044804ab4aad388de85399eca7253936167df1533ccd84ff17f2e05aa1122997e336d2dcb1c5aa07ce42c1e03e25d5743
+  data.tar.gz: 56e7173fce55cfc34d2168bbe42ee346fc9357fa5d1fc2438a5e3679df40439f4307f4fa1a1732fcc060eac5198f7306ce9fae0e209bc21d1d74bafea2a161f8

data/.gitignore

@@ -4,7 +4,7 @@
 .idea
 .config
 .yardoc
-Gemfile.lock
+*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -1,10 +1,23 @@
 language: ruby
+gemfile:
+  - Gemfile.activesupport-4.x
+  - Gemfile.activesupport-5.x
 rvm:
-  - 2.3.0
-  - 2.2.2
-  - 2.1.5
   - 2.0.0
-  - jruby-19mode # JRuby in 1.9 mode
+  - 2.1.10
+  - 2.2.4
+  - 2.3.0
+  - jruby
   - rbx
 before_install:
   - gem install bundler
+env:
+  - JRUBY_OPTS=--2.0
+matrix:
+  allow_failures:
+    - rvm: 2.0.0
+      gemfile: Gemfile.activesupport-5.x
+    - rvm: 2.1.10
+      gemfile: Gemfile.activesupport-5.x
+    - rvm: jruby
+      gemfile: Gemfile.activesupport-5.x

data/Gemfile.activesupport-4.x

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'activesupport', '~> 4.0'

data/Gemfile.activesupport-5.x

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'activesupport', '~> 5.0'

data/README.md

@@ -414,11 +414,36 @@ By default, any parameter with key prefix `password` will be sanitized in the lo
 Restfulness.sensitive_params = [:password, :secretkey]
 ```
 
-## Error Handling
+## Status Code and Error Handling
 
-If you'd like your application to return anything other than a 200 (or 202) status, you have a couple of options that allow you to send codes back to the client.
+If you'd like your application to return anything other than a 200 status (or 204 for an empty payload), you can set it directly on the response object:
 
-One of the easiest approaches is to update the `response` code. Take the following example where we set a 403 response and the model's errors object in the payload:
+```ruby
+class ProjectResource < Restfulness::Resource
+  def get
+    response.status = 203
+    project
+  end
+end
+```
+
+The recommended approach in Restfulness however is to use the success status code helpers, for example:
+
+```ruby
+class ProjectResource < Restfulness::Resource
+  def get
+    non_authoritative(project) # Respond with 203
+  end
+  def put
+    build_project
+    created(project) # Respond with 201
+  end
+end
+```
+
+Any payload passed into the helper will be returned after setting the code.
+
+Dealing with error responses (3XX, or 4XX codes) can also be dealt with using the `response` object. Take the following example where we set a 403 response and the model's errors object in the payload:
 
 ```ruby
 class ProjectResource < Restfulness::Resource
@@ -433,7 +458,7 @@ class ProjectResource < Restfulness::Resource
 end
 ```
 
-The favourite method in Restfulness however is to use the `HTTPException` class and helper methods that will raise the error for you. For example:
+Continuing from the recommended approach for success helpers, Restfulness provides a `HTTPException` class and "bang" helper methods that will raise the error for you. For example:
 
 ```ruby
 class ProjectResource < Restfulness::Resource
@@ -446,7 +471,7 @@ class ProjectResource < Restfulness::Resource
 end
 ```
 
-The `forbidden!` bang method will call the `error!` method, which in turn will raise an `HTTPException` with the appropriate status code. Exceptions are permitted to include a payload also, so you could override the `error!` method if you wished with code that will automatically re-format the payload. Another example:
+The `forbidden!` bang method will call the `error!` method, which in turn will raise an `HTTPException` containing the appropriate status code. Exceptions are permitted to include a payload also, so you can override the `error!` method if you wished with code that will automatically re-format the payload. Another example:
 
 ```ruby
 # Regular resource
@@ -478,7 +503,17 @@ end
 
 This can be a really nice way to mold your errors into a standard format. All HTTP exceptions generated inside resources will pass through `error!`, even those that a triggered by a callback. It gives a great way to provide your own JSON error payload, or even just resort to a simple string.
 
-The currently built in exception methods are:
+The current built in success methods are:
+
+ * `ok` - code 200, the default.
+ * `created` - code 201.
+ * `accepted` - code 202.
+ * `non_authoritative_information` - code 203.
+ * `non_authoritative` - code 203, same as previous, but a shorter method name.
+ * `no_content` - code 204, default when no payload provided.
+ * `reset_content` - code 205.
+
+The current built in exception methods are:
 
  * `not_modified!`
  * `bad_request!`
@@ -671,6 +706,11 @@ Restfulness is still a work in progress but at Cabify we are using it in product
 
 ## History
 
+### 0.3.4 - August 8, 2016
+
+ * Added helper methods for success responses (@samlown)
+ * Don't initialize AuthorizationHeader when authorization is blank. (@arctarus)
+
 ### 0.3.3 - January 19, 2016
 
  * Basic support for handling large request bodies received as Tempfile (@lauramorillo)

data/lib/restfulness/requests/authorization.rb

@@ -6,7 +6,7 @@ module Restfulness
       def authorization
         @authorization ||= begin
           payload = authorization_header_payload
-          AuthorizationHeader.new(payload) unless payload.nil?
+          AuthorizationHeader.new(payload) unless payload.blank?
         end
       end
 
@@ -15,8 +15,6 @@ module Restfulness
       def authorization_header_payload
         headers[:authorization]
       end
-
     end
-
   end
 end

data/lib/restfulness/resources/events.rb

@@ -6,10 +6,20 @@ module Restfulness
     # resources.
     module Events
 
+      SUCCESS_EVENTS = [
+        [200, :ok],
+        [201, :created],
+        [202, :accepted],
+        [203, :non_authoritative],
+        [203, :non_authoritative_information],
+        [204, :no_content],
+        [205, :reset_content]
+      ]
+
       # Event definitions go here. We only support a limited subset
       # so that we don't end up with loads of methods that are not used.
       # If you'd like to see another, please send us a pull request!
-      SUPPORTED_EVENTS = [
+      EXCEPTION_EVENTS = [
         # 300 Events
         [304, :not_modified],
 
@@ -31,7 +41,7 @@ module Restfulness
         raise HTTPException.new(code, payload, opts)
       end
 
-      SUPPORTED_EVENTS.each do |row|
+      EXCEPTION_EVENTS.each do |row|
         define_method("#{row[1]}!") do |*args|
           payload = args.shift || ""
           opts    = args.shift || {}
@@ -39,6 +49,13 @@ module Restfulness
         end
       end
 
+      SUCCESS_EVENTS.each do |row|
+        define_method("#{row[1]}") do |*args|
+          response.status = row[0]
+          return args.first
+        end
+      end
+
     end
 
   end

data/lib/restfulness/response.rb

@@ -52,6 +52,11 @@ module Restfulness
       payload.to_s.bytesize.to_s
     end
 
+    # Override the status of this response.
+    def status=(code)
+      @status = code.to_i
+    end
+
     protected
 
     def resource=(obj)
@@ -59,14 +64,10 @@ module Restfulness
     end
 
     def update_status_and_payload(status, payload = "")
-      self.status  = status
+      self.status  = status unless self.status.present?
       self.payload = payload
     end
 
-    def status=(code)
-      @status = code
-    end
-
     def payload=(body)
       if body.nil? || body.is_a?(String)
         @payload = body.to_s

data/lib/restfulness/version.rb

@@ -1,3 +1,3 @@
 module Restfulness
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/restfulness.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rack", "~> 1.5.0"
   spec.add_dependency "multi_json", "~> 1.8"
-  spec.add_dependency "activesupport", ">= 3.1"
+  spec.add_dependency "activesupport", ">= 4.0", "< 6.0"
   spec.add_dependency "http_accept_language", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/spec/unit/requests/authorization_spec.rb

@@ -14,11 +14,16 @@ describe Restfulness::Requests::Authorization do
   end
 
   describe "#authorization" do
-
     it "should be nil if no authorization header resent" do
       auth = request.authorization
       expect(auth).to be_nil
     end
+
+    it "should be nil if authorization header is blank" do
+      request.headers[:authorization] = ""
+      auth = request.authorization
+      expect(auth).to be_nil
+    end
  
     it "should build new authorization header when present" do
       request.headers[:authorization] = "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
@@ -26,7 +31,5 @@ describe Restfulness::Requests::Authorization do
       expect(auth).to be_a(Restfulness::Requests::AuthorizationHeader)
       expect(auth.schema).to eql("Basic")
     end
-
- end
-
+  end
 end

data/spec/unit/resources/events_spec.rb

@@ -17,7 +17,6 @@ describe Restfulness::Resources::Events do
     Restfulness::Response.new(request)
   end
 
-
   describe "#error" do
 
     class Get418Resource < Restfulness::Resource
@@ -35,7 +34,7 @@ describe Restfulness::Resources::Events do
     end
   end
 
-  describe "generic bang error events" do
+  describe "events" do
 
     let :klass do
       Class.new(Restfulness::Resource)
@@ -45,24 +44,43 @@ describe Restfulness::Resources::Events do
       klass.new(request, response)
     end
 
-    it "should support bad_request!" do
-      expect {
+    describe "generic bang error events" do
+      it "should support bad_request!" do
+        expect {
+          obj.instance_eval do
+            bad_request!
+          end
+        }.to raise_error(Restfulness::HTTPException, "Bad Request")
+      end
+
+      it "should support bad_request! with paramters" do
+        expect(obj).to receive(:error!).with(400, {:pay => 'load'}, {})
         obj.instance_eval do
-          bad_request!
+          bad_request!({:pay => 'load'}, {})
         end
-      }.to raise_error(Restfulness::HTTPException, "Bad Request")
+      end
     end
 
-    it "should support bad_request! with paramters" do
-      expect(obj).to receive(:error!).with(400, {:pay => 'load'}, {})
-      obj.instance_eval do
-        bad_request!({:pay => 'load'}, {})
+    describe "success callbacks" do
+      
+      it "should set status for #ok" do
+        obj.instance_eval do
+          no_content
+        end
+        expect(response.status).to eql(204)
+      end
+
+      it "should pass through any payload" do
+        payload = "foo"
+        res = nil
+        obj.instance_eval do
+          res = created(payload)
+        end
+        expect(res).to eql(payload)
       end
-    end
 
+    end
 
   end
 
-  
-
 end

data/spec/unit/response_spec.rb

@@ -32,6 +32,25 @@ describe Restfulness::Response do
     end
   end
 
+  describe "#status=" do
+    it "should allow status to be forced" do
+      obj.status = 204
+      expect(obj.status).to eql(204)
+    end
+    it "should convert non-integer status to integer" do
+      obj.status = "203"
+      expect(obj.status).to eql(203)
+    end
+    it "should not overwrite on execution" do
+      route = app.router.routes.first
+      allow(request).to receive(:route).and_return(route)
+      allow(request).to receive(:uri).and_return(URI('http://test.com/test'))
+      obj.status = 205
+      obj.run
+      expect(obj.status).to eql(205)
+    end
+  end
+
   describe "#run" do
     context "without route" do
       it "should not do anything" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,14 +44,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: http_accept_language
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +124,8 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- Gemfile.activesupport-4.x
+- Gemfile.activesupport-5.x
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -186,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Use to create a powerful, yet simple REST API in your application.