restfulness 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 656fc9b27618b6b00f0cdc31dff51fc59081881b
-  data.tar.gz: eed7ea6153eb14c67d0888643287ed911bfb477a
+  metadata.gz: 6461108ff8796134694c51592c8ccefc8053647e
+  data.tar.gz: 22405556949ce5d69f7192f2c402038ca8b08802
 SHA512:
-  metadata.gz: d06a2ee69944bfd705f22516c246ec49293488e69bc7bc5f7357cbe3830ac1b283e5e5046063c4e22e427d5ddf2541811c2d49b0e285eb742c63c0f132b64564
-  data.tar.gz: b297d63290e7df33142641c2c8d072d97bb4494ece946b8ec6f2ddb4c44e10ac6cd997729689ede5fefb299f492c77b74e82b9646f04793ca49f77c473a99e70
+  metadata.gz: 9bebef2fdf368de74cfb3f63e4acb15c087575fe76e34f24be3e62e47718f9f02c7b82b57993e81778483eaf3289244338620848e49027feb316504c0cffa743
+  data.tar.gz: 867d7656b3e93b340ecd362ca7965b65741fb53af3a45e714eb770f9cef879214786bd472605d221a9258cc8d8d2d33305075dda37e410cc145d6c94e3f03af7

data/README.md

@@ -422,9 +422,16 @@ Restfulness was created by Sam Lown <me@samlown.com> as a solution for building
 
 ## History
 
+### 0.2.1 - October 22, 2013
+
+ * Removing some unnecessary logging and using Rack::CommonLogger.
+ * Improving some test coverage. 
+ * Supporting user agent in requests.
+ * Supporting PATCH method in resources.
+
 ### 0.2.0 - October 17, 2013
 
-Refactoring error handling and reporting so that it is easier to use and simpler.
+ * Refactoring error handling and reporting so that it is easier to use and simpler.
 
 ### 0.1.0 - October 16, 2013
 

data/lib/restfulness.rb

@@ -5,6 +5,7 @@ require 'mono_logger'
 require 'active_support/core_ext'
 require 'active_support/dependencies'
 require 'rack/utils'
+require 'rack/commonlogger'
 require 'rack/showexceptions'
 require 'rack/builder'
 

data/lib/restfulness/application.rb

@@ -10,7 +10,7 @@ module Restfulness
   #   class MyApp < Restfulness::Application
   #
   #     routes do
-  #       scope 'api' do
+  #       scope 'api' do # scope not supported yet!
   #         add 'journey', JourneyResource
   #         add 'journeys', JourneyCollectionResource
   #       end
@@ -63,6 +63,7 @@ module Restfulness
       #
       def middlewares
         @middlewares ||= [
+          Rack::CommonLogger,
           Rack::ShowExceptions
         ]
       end

data/lib/restfulness/dispatchers/rack.rb

@@ -5,59 +5,45 @@ module Restfulness
     class Rack < Dispatcher
 
       def call(env)
-        rack_req = ::Rack::Request.new(env)
-
         # Make sure we understand the request
-        request = Request.new(app)
-        prepare_request(env, rack_req, request)
+        request = prepare_request(env)
 
         # Prepare a suitable response
         response = Response.new(request)
         response.run
 
-        log_response(response.status)
         [response.status, response.headers, [response.payload || ""]]
       end
 
       protected
 
-      def prepare_request(env, rack_req, request)
-        request.uri       = rack_req.url
-        request.action    = parse_action(rack_req.request_method)
-        request.query     = rack_req.GET
-        request.body      = rack_req.body
-        request.remote_ip = rack_req.ip
-        request.headers   = prepare_headers(env)
+      def prepare_request(env)
+        rack_req = ::Rack::Request.new(env)
+        request = Request.new(app)
+        request.uri        = rack_req.url
+        request.action     = parse_action(rack_req.request_method)
+        request.query      = rack_req.GET
+        request.body       = rack_req.body
+        request.headers    = prepare_headers(env)
+
+        request.remote_ip  = rack_req.ip
+        request.user_agent = rack_req.user_agent
 
         # Sometimes rack removes content type from headers
         request.headers[:content_type] ||= rack_req.content_type
+
+        request
       end
 
       def parse_action(action)
         case action
-        when 'DELETE'
-          :delete
-        when 'GET'
-          :get
-        when 'HEAD'
-          :head
-        when 'POST'
-          :post
-        when 'PUT'
-          :put
-        when 'PATCH'
-          :patch
-        when 'OPTIONS'
-          :options
+        when 'DELETE', 'GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'OPTIONS'
+          action.downcase.to_sym
         else
           raise HTTPException.new(501)
         end
       end
 
-      def log_response(status)
-        logger.info("Completed #{status} #{STATUSES[status]}")
-      end
-
       def prepare_headers(env)
         res = {}
         env.each do |k,v|
@@ -67,10 +53,6 @@ module Restfulness
         res
       end
 
-      def logger
-        Restfulness.logger
-      end
-
     end
 
   end

data/lib/restfulness/request.rb

@@ -30,8 +30,8 @@ module Restfulness
     # Raw HTTP body, for POST and PUT requests.
     attr_accessor :body
 
-    # IP address of requester
-    attr_accessor :remote_ip
+    # Additional useful fields
+    attr_accessor :remote_ip, :user_agent
 
     def initialize(app)
       @app = app

data/lib/restfulness/resource.rb

@@ -57,8 +57,7 @@ module Restfulness
       forbidden!          unless allowed?
 
       # The following callbacks only make sense for certain methods
-      if [:head, :get, :put, :delete].include?(request.action)
-
+      if [:head, :get, :put, :patch, :delete].include?(request.action)
         resource_not_found! unless exists?
 
         if [:get, :head].include?(request.action)

data/lib/restfulness/response.rb

@@ -15,11 +15,8 @@ module Restfulness
     end
 
     def run
-      logger.info("Responding to #{request.action.to_s.upcase} #{request.uri.to_s} from #{request.remote_ip}")
-
       route = request.route
       if route
-        logger.info("Using resource: #{route.resource_name}")
         resource = route.build_resource(request, self)
 
         # run callbacks, if any fail, they'll raise an error
@@ -34,15 +31,10 @@ module Restfulness
       end
 
     rescue HTTPException => e # Deal with HTTP exceptions
-      logger.error(e.message)
       headers.update(e.headers)
       update_status_and_payload(e.status, e.payload)
     end
 
-    def logger
-      Restfulness.logger
-    end
-
     protected
 
     def update_status_and_payload(status, payload = "")

data/lib/restfulness/version.rb

@@ -1,3 +1,3 @@
 module Restfulness
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/unit/dispatchers/rack_spec.rb

@@ -3,12 +3,22 @@ require 'spec_helper'
 
 describe Restfulness::Dispatchers::Rack do
 
+  class RackExampleResource < Restfulness::Resource
+    def get
+      'rack_example_result'
+    end
+  end
+
   let :klass do
     Restfulness::Dispatchers::Rack
   end
 
   let :app do
-    Class.new(Restfulness::Application).new
+    Class.new(Restfulness::Application) {
+      routes do
+        add 'projects', RackExampleResource 
+      end
+    }.new
   end
 
   let :obj do
@@ -17,17 +27,75 @@ describe Restfulness::Dispatchers::Rack do
 
   let :env do
     {
-      'REQUEST_METHOD' => 'GET',
-      'SCRIPT_NAME'    => 'projects',
-      'PATH_INFO'      => 'projects',
-      'QUERY_STRING'   => '',
-      'SERVER_NAME'    => 'localhost',
-      'SERVER_PORT'    => '3000',
-      'HTTP_CONTENT_TYPE' => 'application/json'
+      'REQUEST_METHOD'  => 'GET',
+      'SCRIPT_NAME'     => '',
+      'PATH_INFO'       => '/projects',
+      'QUERY_STRING'    => '',
+      'SERVER_NAME'     => 'localhost',
+      'SERVER_PORT'     => '3000',
+      'SERVER_PROTOCOL' => 'HTTP/1.1',
+      'rack.url_scheme' => 'http',
+      'REMOTE_ADDR'     => '192.168.1.23',
+      'HTTP_CONTENT_TYPE' => 'application/json',
+      'HTTP_X_AUTH_TOKEN' => 'foobartoken',
+      'HTTP_USER_AGENT'   => 'Some Navigator',
     }
   end
 
-  describe "#" do
+  describe "#call" do
+
+    it "should handle basic call and return response" do
+      res = obj.call(env)
+      res[0].should eql(200)
+      res[1].should be_a(Hash)
+      res[2].first.should eql('rack_example_result')
+    end
+
+
+  end
+
+  describe "#parse_action (protected)" do
+
+    it "should convert main actions to symbols" do
+      actions = ['DELETE', 'GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'OPTIONS']
+      actions.each do |action|
+        val = obj.send(:parse_action, action)
+        val.should eql(action.downcase.to_sym)
+      end
+    end
+
+    it "should raise error if action unrecognised" do
+      expect {
+        obj.send(:parse_action, 'FOOO')
+      }.to raise_error(Restfulness::HTTPException)
+    end
+
+  end
+
+  describe "#prepare_headers (protected)" do
+
+    it "should parse headers from environment" do
+      res = obj.send(:prepare_headers, env)
+      res[:content_type].should eql('application/json')
+      res[:x_auth_token].should eql('foobartoken')
+    end
+  end
+
+  describe "#prepare_request (protected)" do
+
+    it "should prepare request object with main fields" do
+      req = obj.send(:prepare_request, env)
+
+      req.uri.should be_a(URI)
+      req.action.should eql(:get)
+      req.query.should be_empty
+      req.body.should be_nil
+      req.headers.keys.should include(:x_auth_token)
+      req.remote_ip.should eql('192.168.1.23')
+      req.user_agent.should eql('Some Navigator')
+
+      req.headers[:content_type].should eql('application/json')
+    end
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack