restfulness 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6461108ff8796134694c51592c8ccefc8053647e
-  data.tar.gz: 22405556949ce5d69f7192f2c402038ca8b08802
+  metadata.gz: 5c7504fc661a80914cd4f3e3ad81918799de7b0b
+  data.tar.gz: a6b3d22e6fc9c30ba6010043550d37e3c651be0a
 SHA512:
-  metadata.gz: 9bebef2fdf368de74cfb3f63e4acb15c087575fe76e34f24be3e62e47718f9f02c7b82b57993e81778483eaf3289244338620848e49027feb316504c0cffa743
-  data.tar.gz: 867d7656b3e93b340ecd362ca7965b65741fb53af3a45e714eb770f9cef879214786bd472605d221a9258cc8d8d2d33305075dda37e410cc145d6c94e3f03af7
+  metadata.gz: d21da3dc7f1db2dd8b1259c36e710aa31698f31f5b39b37af0ecca2abc433fa15833941359efabcd9d74681b0570e63a1f4c651d0fb309b1b62c2fc656eb031f
+  data.tar.gz: e7fe0be99de3fcf1947e5fc75bfe2fce76bbd629e9b5cdf3b0370db2ae9e6a1f08a4353130392c3aa83770f37f0c00c0d67e67c4c024046eac142b6897b0ab68

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/README.md

@@ -2,6 +2,8 @@
 
 Because REST APIs are all about resources, not routes.
 
+[![Build Status](https://travis-ci.org/samlown/restfulness.png)](https://travis-ci.org/samlown/restfulness)
+
 ## Introduction
 
 Restfulness is an attempt to create a Ruby library that helps create truly REST based APIs to your services. The focus is placed on performing HTTP actions on resources via specific routes, as opposed to the current convention of assigning routes and HTTP actions to methods or blocks of code. The difference is subtle, but makes for a much more natural approach to building APIs.
@@ -116,7 +118,6 @@ class MyAppAPI < Restfulness::Application
     add 'projects', ProjectsResource
   end
 end
-
 ```
 
 An application is designed to be included in your Rails, Sinatra, or other Rack project, simply include a new instance of your application in the `config.ru` file:
@@ -397,11 +398,12 @@ If you're adding Restfulness to a Rails project, you can take advantage of the `
 ```ruby
 class MyAPI < Restfulness::Application
   if Rails.env.development?
-    middlewares << ActionDispatch::Relaoder
+    middlewares << ActionDispatch::Reloader
   end
   routes do
     # etc. etc.
   end
+end
 ```
 
 We're still working on ways to improve this. If you have any ideas, please send me a pull request!
@@ -422,6 +424,11 @@ Restfulness was created by Sam Lown <me@samlown.com> as a solution for building
 
 ## History
 
+### 0.2.2 - October 31, 2013
+
+ * Refactoring logging support to not depend on Rack CommonLogger nor ShowExceptions.
+ * Using ActiveSupport::Logger instead of MonoLogger.
+
 ### 0.2.1 - October 22, 2013
 
  * Removing some unnecessary logging and using Rack::CommonLogger.

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/example/README.md

@@ -14,7 +14,7 @@ By default, bundler will expect to find the restfulness gem provided in the pare
 
 ## Running
 
-    bundle exec runit
+    bundle exec rackup
 
 ## Testing
 

data/lib/restfulness.rb

@@ -1,15 +1,14 @@
 
 require 'uri'
 require 'multi_json'
-require 'mono_logger'
 require 'active_support/core_ext'
 require 'active_support/dependencies'
+require 'active_support/logger'
 require 'rack/utils'
 require 'rack/commonlogger'
 require 'rack/showexceptions'
 require 'rack/builder'
 
-
 require "restfulness/resources/events"
 
 require "restfulness/application"
@@ -26,15 +25,11 @@ require "restfulness/version"
 
 require "restfulness/dispatchers/rack"
 
-require "restfulness/log_formatters/quiet_formatter"
-require "restfulness/log_formatters/verbose_formatter"
-
 module Restfulness
   extend self
 
   attr_accessor :logger
 end
 
-Restfulness.logger = MonoLogger.new(STDOUT)
-Restfulness.logger.formatter = Restfulness::VerboseFormatter.new
+Restfulness.logger = ActiveSupport::Logger.new(STDOUT)
 

data/lib/restfulness/application.rb

@@ -62,10 +62,7 @@ module Restfulness
       #    middlewares << ActiveDispatch::Reloader
       #
       def middlewares
-        @middlewares ||= [
-          Rack::CommonLogger,
-          Rack::ShowExceptions
-        ]
+        @middlewares ||= [ ]
       end
 
       # Quick access to the Restfulness logger.

data/lib/restfulness/dispatchers/rack.rb

@@ -20,12 +20,14 @@ module Restfulness
       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)
 
+        # Useful info
         request.remote_ip  = rack_req.ip
         request.user_agent = rack_req.user_agent
 

data/lib/restfulness/response.rb

@@ -6,18 +6,23 @@ module Restfulness
     # Incoming data
     attr_reader :request
 
+    # The generated resource object
+    attr_reader :resource
+
     # Outgoing data
     attr_reader :status, :headers, :payload
 
+
     def initialize(request)
       @request = request
       @headers = {}
     end
 
     def run
+      @log_begin_at = Time.now
       route = request.route
       if route
-        resource = route.build_resource(request, self)
+        self.resource = route.build_resource(request, self)
 
         # run callbacks, if any fail, they'll raise an error
         resource.check_callbacks
@@ -33,10 +38,26 @@ module Restfulness
     rescue HTTPException => e # Deal with HTTP exceptions
       headers.update(e.headers)
       update_status_and_payload(e.status, e.payload)
+
+    rescue StandardError, LoadError, SyntaxError => e
+      # Useful coding error handling, with backtrace
+      log_exception(e)
+      update_status_and_payload(500, e.message + "\n")
+
+    ensure
+      log! if status
+    end
+
+    def content_length
+      payload.to_s.bytesize.to_s
     end
 
     protected
 
+    def resource=(obj)
+      @resource = obj
+    end
+
     def update_status_and_payload(status, payload = "")
       self.status  = status
       self.payload = payload
@@ -63,9 +84,37 @@ module Restfulness
       else # Assume text
         headers['Content-Type'] = 'text/plain; charset=utf-8'
       end
-      headers['Content-Length'] = payload.to_s.bytesize.to_s
+      headers['Content-Length'] = content_length
     end
 
-  end
+    def log!
+      dur = @log_begin_at ? Time.now - @log_begin_at : 0.0
+      uri = request.uri
+
+      resource_name = resource ? resource.class.to_s : 'Error'
+      # We're only interested in parsed parameters.
+      params = request.instance_variable_get(:@params)
+
+      msg = %{%s "%s %s%s" %s %d %s %s %0.4fs %s} % [
+        request.remote_ip,
+        request.action.to_s.upcase,
+        uri.path,
+        uri.query ? "?#{uri.query}" : '',
+        resource_name,
+        status.to_s[0..3],
+        STATUSES[status],
+        content_length,
+        dur,
+        params ? params.inspect : ''
+      ]
+      Restfulness.logger.info(msg)
+    end
 
+    def log_exception(e)
+      string = "#{e.class}: #{e.message}\n"
+      string << e.backtrace.map { |l| "\t#{l}" }.join("\n")
+      Restfulness.logger.error(string)
+    end
+
+  end
 end

data/lib/restfulness/version.rb

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

data/restfulness.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack", "~> 1.4"
   spec.add_dependency "multi_json", "~> 1.8"
   spec.add_dependency "activesupport", ">= 3.1"
-  spec.add_dependency "mono_logger", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/unit/application_spec.rb

@@ -32,6 +32,7 @@ describe Restfulness::Application do
   describe "#build_rack_app (protected)" do
     it "should build a new rack app with middlewares" do
       obj = klass.new
+      obj.class.middlewares << Rack::ShowExceptions
       app = obj.send(:build_rack_app)
       app.should be_a(Rack::Builder)
       # Note, this might brake if Rack changes!
@@ -65,9 +66,9 @@ describe Restfulness::Application do
   end
 
   describe ".middlewares" do
-    it "should provide simple array of middlewares" do
+    it "should provide empty array of middlewares" do
       klass.middlewares.should be_a(Array)
-      klass.middlewares.should include(Rack::ShowExceptions)
+      klass.middlewares.should be_empty
     end
   end
 

data/spec/unit/resource_spec.rb

@@ -50,7 +50,10 @@ describe Restfulness::Resource do
     it "should return list of supported methods" do
       obj = resource.new(request, response)
       obj.options.should be_nil
-      response.headers['Allow'].should eql('GET, POST, OPTIONS')
+      acts = response.headers['Allow'].split(/, /)
+      ['GET', 'POST', 'OPTIONS'].each do |act|
+        acts.should include(act)
+      end
     end
   end
 

data/spec/unit/response_spec.rb

@@ -36,6 +36,7 @@ describe Restfulness::Response do
     context "without route" do
       it "should not do anything" do
         request.stub(:route).and_return(nil)
+        request.stub(:uri).and_return(URI('http://test.com/test'))
         obj.run
         obj.status.should eql(404)
         obj.payload.should be_empty
@@ -51,6 +52,7 @@ describe Restfulness::Response do
       it "should try to build resource and run it" do
         request.stub(:route).and_return(route)
         request.action = :get
+        request.stub(:uri).and_return(URI('http://test.com/test'))
         resource = double(:Resource)
         resource.should_receive(:check_callbacks)
         resource.should_receive(:call).and_return({:foo => 'bar'})
@@ -66,6 +68,7 @@ describe Restfulness::Response do
       it "should call resource and set 204 result if no content" do
         request.stub(:route).and_return(route)
         request.action = :get
+        request.stub(:uri).and_return(URI('http://test.com/test'))
         resource = double(:Resource)
         resource.should_receive(:check_callbacks)
         resource.should_receive(:call).and_return(nil)
@@ -78,6 +81,7 @@ describe Restfulness::Response do
       it "should set string content type if payload is a string" do
         request.stub(:route).and_return(route)
         request.action = :get
+        request.stub(:uri).and_return(URI('http://test.com/test'))
         resource = double(:Resource)
         resource.should_receive(:check_callbacks)
         resource.should_receive(:call).and_return("This is a text message")
@@ -96,6 +100,7 @@ describe Restfulness::Response do
       it "should update the status and payload" do
         request.stub(:route).and_return(route)
         request.action = :get
+        request.stub(:uri).and_return(URI('http://test.com/test'))
         resource = double(:Resource)
         txt = "This is a text error"
         resource.stub(:check_callbacks) do
@@ -111,6 +116,7 @@ describe Restfulness::Response do
       it "should update the status and provide JSON payload" do
         request.stub(:route).and_return(route)
         request.action = :get
+        request.stub(:uri).and_return(URI('http://test.com/test'))
         resource = double(:Resource)
         err = {:error => "This is a text error"}
         resource.stub(:check_callbacks) do
@@ -123,6 +129,22 @@ describe Restfulness::Response do
         obj.payload.should eql(err.to_json)
       end
 
+      context "for non http errors" do
+
+        it "should catch error and provide result" do
+          request.stub(:route).and_return(route)
+          request.action = :get
+          request.stub(:uri).and_return(URI('http://test.com/test'))
+          resource = double(:Resource)
+          resource.stub(:check_callbacks) do
+            raise SyntaxError, 'Bad writing'
+          end
+          route.stub(:build_resource).and_return(resource)
+          obj.run
+          obj.status.should eql(500)
+        end
+
+      end
 
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -52,20 +52,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: mono_logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -129,8 +116,6 @@ files:
 - lib/restfulness/dispatcher.rb
 - lib/restfulness/dispatchers/rack.rb
 - lib/restfulness/exceptions.rb
-- lib/restfulness/log_formatters/quiet_formatter.rb
-- lib/restfulness/log_formatters/verbose_formatter.rb
 - lib/restfulness/path.rb
 - lib/restfulness/request.rb
 - lib/restfulness/resource.rb

data/lib/restfulness/log_formatters/quiet_formatter.rb

@@ -1,7 +0,0 @@
-module Restfulness
-  class QuietFormatter
-    def call(serverity, datetime, progname, msg)
-      ""
-    end
-  end
-end

data/lib/restfulness/log_formatters/verbose_formatter.rb

@@ -1,16 +0,0 @@
-module Restfulness
-  class VerboseFormatter
-    def call(serverity, datetime, progname, msg)
-      time = Time.now.strftime('%Y-%m-%d %H:%M:%S.%L')
-      sym = case serverity
-            when 'ERROR'
-              'EE'
-            when 'INFO'
-              '--'
-            else
-              '**'
-            end
-      "#{sym} #{time}: #{msg}\n"
-    end
-  end
-end