restfulness 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed8387e688a8bb336c27f341003bdf225fb439c0
-  data.tar.gz: 02cef9941b4153e68215fb1497885a4472d28071
+  metadata.gz: 8b7f899ce27987a0fc7cd6bfd1d272e999921b4a
+  data.tar.gz: 4c37afe53ef267decffc2d72b7fab1b5407bc2ae
 SHA512:
-  metadata.gz: 51d5acf131c42af07a033ef3e579bb2246fcbd4461b3b5accb9a98de7359d9267dbf0ae0e41db7aea0769520b8d7cd510f9f11e053902fe66fbf41f98b8c7411
-  data.tar.gz: 7c9890e63ccc7a98fb40e9f98ce42fe69168e94d7099a3e892df0e5a7862553ed6763ae3eff012ddd89fd64025fc2dacc05ae5c8f537e016e11a184ae52d617b
+  metadata.gz: 099b1309377a645b8fad3c13116aa5e65d87a43dc0caa4987a05e1b7aefce60a6265e6f0911c7728675e99d5bed40ec2b7c9aab5d717618261f45b23413c23b9
+  data.tar.gz: 0fa3111acd852dfec3d0b3fe14ab02eae9b3288dcd7e32e81da062072f4e6ac3888aebe6b63c958652ea2beac1954d322f16ae60b6ac4d5a185e28cbe0cf7256

data/README.md

@@ -318,9 +318,8 @@ Here's an example with the authentication details in the code, you'd obviously w
 ```ruby
 def authorized?
   authenticate_with_http_basic do |username, password|
-    return (username == 'user' && password == 'pass')
+    username == 'user' && password == 'pass'
   end
-  false
 end
 ```
 
@@ -329,16 +328,31 @@ The `request` object provided in the resource, described below, provides access
 ```ruby
 def authorized?
   auth = request.authorization
-  if auth && auth.schema == 'Token'
-    if our_secret_token == auth.params
-      return true
-    end
+  auth && (auth.schema == 'Token') && (auth.params == our_secret_token)
+end
+```
+
+We don't yet provide support for Digest authentication, but your contributions would be more than welcome. Checkout the [HttpAuthentication/basic.rb](https://github.com/samlown/restfulness/blob/master/lib/restfulness/http_authentication/basic.rb) source for an example.
+
+Restfulness doesn't make any provisions for requesting authentication from the client as most APIs don't really need to offer this functionality. You can acheive the same effect however by providing the `WWW-Authenticate` header in the response. For example:
+
+```ruby
+def authorized?
+  authorize_with_http_basic || request_authentication
+end
+
+def authorize_with_http_basic
+  authenticate_with_http_basic do |username, password|
+    username == 'user' && password == 'pass'
   end
+end
+
+def request_authentication
+  response.headers['WWW-Authenticate'] = 'Basic realm="My Realm"'
   false
 end
 ```
 
-We don't yet provide support for Digest authentication, but your contributions would be more than welcome. Checkout the [HttpAuthentication/basic.rb](https://github.com/samlown/restfulness/blob/master/lib/restfulness/http_authentication/basic.rb) source for an example.
 
 ### Requests
 
@@ -649,6 +663,12 @@ Restfulness is still a work in progress but at Cabify we are using it in product
 
 ## History
 
+### 0.3.2 - February 9, 2015
+
+ * Added support for application/x-www-form-urlencoded parameter decoding (@samlown)
+ * Support for empty StringIOs when accessing Request#params (@samlown)
+ * Fixing at Rack ~> 1.5.0 due to issues with Rack 1.6 (@samlown)
+
 ### 0.3.1 - September 19, 2014
 
  * Added support for HTTP Basic Authentication, no breaking changes. (@samlown)

data/lib/restfulness/request.rb

@@ -56,16 +56,19 @@ module Restfulness
     end
 
     def params
-      return @params if @params || body.nil?
-      case headers[:content_type]
-        when /application\/json/
-          begin
-            @params = MultiJson.decode(body)
-          rescue MultiJson::LoadError
-            raise HTTPException.new(400)
+      @params ||= begin
+        if body.nil? || body.length == 0
+          {}
+        else
+          case headers[:content_type]
+          when /application\/json/
+            @params = params_from_json(body)
+          when /application\/x\-www\-form\-urlencoded/
+            @params = params_from_form(body)
+          else
+            raise HTTPException.new(406)
           end
-      else
-        raise HTTPException.new(406)
+        end
       end
     end
 
@@ -85,5 +88,18 @@ module Restfulness
       end
     end
 
+    protected
+
+    def params_from_json(body)
+      MultiJson.decode(body)
+    rescue MultiJson::LoadError
+      raise HTTPException.new(400)
+    end
+
+    def params_from_form(body)
+      # Sometimes the body can be a StringIO
+      Rack::Utils.parse_query(body.is_a?(StringIO) ? body.read : body)
+    end
+
   end
 end

data/lib/restfulness/version.rb

@@ -1,3 +1,3 @@
 module Restfulness
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/restfulness.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rack", "~> 1.4"
+  spec.add_dependency "rack", "~> 1.5.0"
   spec.add_dependency "multi_json", "~> 1.8"
   spec.add_dependency "activesupport", ">= 3.1"
   spec.add_dependency "http_accept_language", "~> 2.0"

data/spec/unit/request_spec.rb

@@ -116,7 +116,7 @@ describe Restfulness::Request do
   describe "#params" do
     it "should not return anything for empty body" do
       obj.stub(:body).and_return(nil)
-      obj.params.should be_nil
+      obj.params.should be_empty
     end
 
     it "should raise 400 bad request for invalid json body" do
@@ -152,6 +152,38 @@ describe Restfulness::Request do
       obj.body = "{\"foo\":\"bar\"}"
       obj.params['foo'].should eql('bar')
     end
+
+    it "should decode a WWW Form body" do
+      obj.headers[:content_type] = "application/x-www-form-urlencoded"
+      obj.body = "grant_type=password&username=johndoe&password=A3ddj3w"
+      obj.params['grant_type'].should eql('password')
+      obj.params['username'].should eql('johndoe')
+    end
+
+    it "should deal with empty WWW Form body" do
+      obj.headers[:content_type] = "application/x-www-form-urlencoded"
+      obj.body = ""
+      obj.params.should be_empty
+    end
+
+    it "should deal with a StringIO WWW form body" do
+      obj.headers[:content_type] = "application/x-www-form-urlencoded"
+      obj.body = StringIO.new("grant_type=password&username=johndoe&password=A3ddj3w")
+      obj.params['grant_type'].should eql('password')
+      obj.params['username'].should eql('johndoe')
+    end
+
+    it "should deal with empty JSON String body" do
+      obj.headers[:content_type] = "application/json"
+      obj.body = ""
+      obj.params.should be_empty
+    end
+
+    it "should deal with empty JSON StringIO body" do
+      obj.headers[:content_type] = "application/json"
+      obj.body = StringIO.new("")
+      obj.params.should be_empty
+    end
   end
 
   describe "#sanitized_params" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement