jersey 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c73c2c478b36fbd1a0574323dcbb7f023264517d
-  data.tar.gz: d7f9a1f7e5cd742a9de16d62c12b8b9cce788137
+  metadata.gz: 8917e3fd5a219b1f47d717b67c220309e0099e53
+  data.tar.gz: 877d58392cf2c2ed29f0c716be9ae96e013624d0
 SHA512:
-  metadata.gz: 81638bfb73758bf758ae0245c163f88c2bf01c9214736a036c74f00e4a8f3a6309888588e07be9878783835f4ebad5bf02c348be1ec5dbb2adcdac72637d095e
-  data.tar.gz: 49fc8716d35f5e8b8d1cffb85d912e391c5325b22e8e72a751b9aedebaee14a94f82d9e27727b92773808d660790bcd4f0f9f95914845ac1d002adb499efced3
+  metadata.gz: d79189492a2066fc625ad5b89c6fd68874d7c820d65a5def6f506b5de8a9f404cb5e8c1d2cb39db9d83db1c42dfae57668100f2f1883951e150d9c6b3105cc6c
+  data.tar.gz: b3321888bd62a38ea83d8552be66df3fc28ec1a64179340cfa1eced4f5ad0da42d9af13b7a0a53ba2dfcd9cd1acc9972a1c1add634471404b95de5f2dc8b48ac

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.0
+  - 2.1.5

data/jersey.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "sinatra", "~> 1.4"
   spec.add_dependency 'sinatra-contrib', "~> 1.4"
-  spec.add_dependency 'env-conf'
+  spec.add_dependency 'env-conf', '0.0.4'
   spec.add_dependency 'request_store'
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/jersey/api.rb

@@ -1,3 +1,5 @@
+require 'request_store'
+
 module Jersey
   module API
     module Middleware
@@ -8,5 +10,17 @@ module Jersey
 
     module Helpers
     end
+
+    module HTTP
+    end
   end
 end
+
+# jersey
+require 'jersey/http_errors'
+require 'jersey/middleware/request_id'
+require 'jersey/middleware/error_handler'
+require 'jersey/middleware/request_logger'
+require 'jersey/extensions/route_signature'
+require 'jersey/helpers/log'
+require 'jersey/helpers/success'

data/lib/jersey/base.rb

@@ -1,22 +1,17 @@
 require "sinatra/base"
 require 'sinatra/json'
 require 'json'
-require 'request_store'
 
-# jersey
-require 'jersey/http_errors'
-require 'jersey/middleware/request_id'
-require 'jersey/middleware/request_logger'
-require 'jersey/extensions/route_signature'
-require 'jersey/extensions/error_handler'
-require 'jersey/helpers/log'
+# Take over Sinatra's NotFound so we don't have to deal with the
+# not_found block and can raise our own NotFound error
+::Sinatra.send(:remove_const, :NotFound)
+::Sinatra.const_set(:NotFound, ::Jersey::HTTP::Errors::NotFound)
 
 module Jersey::API
   class Base < Sinatra::Base
     include Jersey::HTTP::Errors
 
     register Jersey::Extensions::RouteSignature
-    register Jersey::Extensions::ErrorHandler
 
     use Rack::Deflater
     use Rack::ConditionalGet
@@ -24,8 +19,14 @@ module Jersey::API
 
     use Jersey::Middleware::RequestID
     use Jersey::Middleware::RequestLogger
+    use Jersey::Middleware::ErrorHandler
 
     helpers Sinatra::JSON
     helpers Jersey::Helpers::Log
+    helpers Jersey::Helpers::Success
+
+    set :dump_errors, false
+    set :raise_errors, true
+    set :show_exceptions, false
   end
 end

data/lib/jersey/extensions/error_handler.rb

@@ -21,6 +21,7 @@ module Jersey::Extensions
 
         json(error: {
           type: e.class.name.split('::').last,
+          request_id: env['REQUEST_ID'],
           message: e.message,
           backtrace: e.backtrace
         })

data/lib/jersey/helpers/success.rb

@@ -0,0 +1,17 @@
+module Jersey::Helpers
+  module Success
+    def created(*args)
+      status(201)
+      json(*args)
+    end
+
+    def accepted(*args)
+      status(202)
+      json(*args)
+    end
+
+    def no_content(*args)
+      status(204)
+    end
+  end
+end

data/lib/jersey/http_errors.rb

@@ -1,62 +1,57 @@
-module Jersey
-  module HTTP
-    module Errors
-      HTTPError = Class.new(StandardError)
-      ClientError = Class.new(HTTPError)
-      ServerError = Class.new(HTTPError)
+module Jersey::HTTP
+  module Errors
+    HTTPError = Class.new(StandardError)
+    ClientError = Class.new(HTTPError)
+    ServerError = Class.new(HTTPError)
 
-      # Define ALL the HTTP errors as constants
-      FOUR_HUNDRED = [
-        [400, 'BadRequest', :bad_request],
-        [401, 'Unauthorized', :unauthorized],
-        [402, 'PaymentRequired', :payment_required],
-        [403, 'Forbidden', :forbidden],
-        [404, 'NotFound', :not_found],
-        [405, 'MethodNotAllowed', :method_not_allowed],
-        [406, 'NotAcceptable', :not_acceptable],
-        [407, 'ProxyAuthenticationRequired', :proxy_authentication_required],
-        [408, 'RequestTimeout', :request_timeout],
-        [409, 'Conflict', :conflict],
-        [410, 'Gone', :gone],
-        [411, 'LengthRequired', :length_required],
-        [412, 'PreconditionFailed', :precondition_failed],
-        [413, 'RequestEntityTooLarge', :request_entity_too_large],
-        [414, 'RequestURITooLong', :request_uri_too_long],
-        [415, 'UnsupportedMediaType', :unsupported_media_type],
-        [416, 'RequestedRangeNotSatisfiable', :requested_range_not_satisfiable],
-        [417, 'ExpectationFailed', :expectation_failed],
-        [422, 'UnprocessableEntity', :unprocessable_entity],
-        [423, 'Locked', :locked],
-        [424, 'FailedDependency', :failed_dependency],
-        [426, 'UpgradeRequired', :upgrade_required],
-      ]
+    # Define ALL the HTTP errors as constants
+    FOUR_HUNDRED = [
+      [400, 'BadRequest', :bad_request],
+      [401, 'Unauthorized', :unauthorized],
+      [402, 'PaymentRequired', :payment_required],
+      [403, 'Forbidden', :forbidden],
+      [404, 'NotFound', :not_found],
+      [405, 'MethodNotAllowed', :method_not_allowed],
+      [406, 'NotAcceptable', :not_acceptable],
+      [407, 'ProxyAuthenticationRequired', :proxy_authentication_required],
+      [408, 'RequestTimeout', :request_timeout],
+      [409, 'Conflict', :conflict],
+      [410, 'Gone', :gone],
+      [411, 'LengthRequired', :length_required],
+      [412, 'PreconditionFailed', :precondition_failed],
+      [413, 'RequestEntityTooLarge', :request_entity_too_large],
+      [414, 'RequestURITooLong', :request_uri_too_long],
+      [415, 'UnsupportedMediaType', :unsupported_media_type],
+      [416, 'RequestedRangeNotSatisfiable', :requested_range_not_satisfiable],
+      [417, 'ExpectationFailed', :expectation_failed],
+      [422, 'UnprocessableEntity', :unprocessable_entity],
+      [423, 'Locked', :locked],
+      [424, 'FailedDependency', :failed_dependency],
+      [426, 'UpgradeRequired', :upgrade_required],
+    ]
 
-      FIVE_HUNDRED = [
-        [500, 'InternalServerError', :internal_server_error],
-        [501, 'NotImplemented', :not_implemented],
-        [502, 'BadGateway', :bad_gateway],
-        [503, 'ServiceUnavailable', :service_unavailable],
-        [504, 'GatewayTimeout', :gateway_timeout],
-        [505, 'HTTPVersionNotSupported', :http_version_not_supported],
-        [507, 'InsufficientStorage', :insufficient_storage],
-        [510, 'NotExtended', :not_extended],
-      ]
+    FIVE_HUNDRED = [
+      [500, 'InternalServerError', :internal_server_error],
+      [501, 'NotImplemented', :not_implemented],
+      [502, 'BadGateway', :bad_gateway],
+      [503, 'ServiceUnavailable', :service_unavailable],
+      [504, 'GatewayTimeout', :gateway_timeout],
+      [505, 'HTTPVersionNotSupported', :http_version_not_supported],
+      [507, 'InsufficientStorage', :insufficient_storage],
+      [510, 'NotExtended', :not_extended],
+    ]
 
-      (FOUR_HUNDRED + FIVE_HUNDRED).each do |s|
-        code, const_name, symbol = s[0],s[1],s[2]
-        if code >= 500
-          klass = Class.new(ServerError)
-        else
-          klass = Class.new(ClientError)
-        end
-        klass.const_set(:STATUS_CODE, code)
-        const_set(const_name,klass)
+    # Dynamically Create all the necessary HTTP errors
+    # with appropriate status codes
+    (FOUR_HUNDRED + FIVE_HUNDRED).each do |s|
+      code, const_name, symbol = s[0],s[1],s[2]
+      if code >= 500
+        klass = Class.new(ServerError)
+      else
+        klass = Class.new(ClientError)
       end
-
-      # Take over Sinatra's NotFound so we don't have to deal with the
-      # not_found block and can raise our own NotFound error
-      ::Sinatra.send(:remove_const, :NotFound)
-      ::Sinatra.const_set(:NotFound, ::Jersey::HTTP::Errors::NotFound)
+      klass.const_set(:STATUS_CODE, code)
+      const_set(const_name,klass)
     end
   end
 end

data/lib/jersey/log.rb

@@ -9,6 +9,11 @@ module Jersey
     include Logging::LogError
   end
 
+  class JsonLogger < JSONLogger
+    include Logging::LogTime
+    include Logging::LogError
+  end
+
   module LoggingSingleton
     attr_writer :logger
 

data/lib/jersey/middleware/error_handler.rb

@@ -0,0 +1,40 @@
+module Jersey::Middleware
+  class ErrorHandler
+    def initialize(app, options = {})
+      @app = app
+      ib = options[:include_backtrace]
+      @include_backtrace = (ib.nil? && ENV['RACK_ENV'] == 'development') || ib
+    end
+
+    def call(env)
+      begin
+        @app.call(env)
+      rescue => e
+        # get status code from Jersey Errors
+        if e.class.const_defined?(:STATUS_CODE)
+          status = e.class::STATUS_CODE
+        elsif e.respond_to?(:status_code)
+          status = e.status_code
+        else
+          status = 500
+        end
+
+        headers = {
+          'Content-Type' => 'application/json'
+        }
+
+        body = {error: {
+          type: e.class.name.split('::').last,
+          request_id: env['REQUEST_ID'] || env['HTTP_REQUEST_ID'],
+          message: e.message
+        }}
+
+        if @include_backtrace
+          body[:error][:backtrace] = e.backtrace
+        end
+
+        [status, headers, [body.to_json]]
+      end
+    end
+  end
+end

data/lib/jersey/version.rb

@@ -1,3 +1,3 @@
 module Jersey
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/test/errors_test.rb

@@ -1,7 +1,7 @@
 require_relative 'helper'
 
 class ErrorsTest < ApiTest
-  class SimpleApi < Jersey::API::Base
+  class App < Jersey::API::Base
     get '/test-409' do
       raise Conflict, "bad"
     end
@@ -15,10 +15,6 @@ class ErrorsTest < ApiTest
     end
   end
 
-  def app
-    SimpleApi
-  end
-
   def test_not_found
     get '/not-found'
     assert_equal(404, last_response.status)
@@ -30,6 +26,7 @@ class ErrorsTest < ApiTest
     assert_equal(409, last_response.status)
     assert_equal('Conflict', json['error']['type'])
     assert_equal('bad', json['error']['message'])
+    assert(json['error']['request_id'])
   end
 
   def test_http_errors_500
@@ -37,6 +34,7 @@ class ErrorsTest < ApiTest
     assert_equal(500, last_response.status)
     assert_equal('InternalServerError', json['error']['type'])
     assert_equal('bad', json['error']['message'])
+    assert(json['error']['request_id'])
   end
 
   def test_http_errors_Undefined
@@ -44,5 +42,18 @@ class ErrorsTest < ApiTest
     assert_equal(500, last_response.status)
     assert_equal('RuntimeError', json['error']['type'])
     assert_equal('boom!', json['error']['message'])
+    assert(json['error']['request_id'])
+  end
+
+  def test_errors_are_logged
+    Jersey.logger.stream = StringIO.new
+    get '/test-500'
+    loglines = logs.lines
+    assert_equal(2, loglines.size)
+    logdata = Logfmt.parse(loglines[0])
+    assert(logdata['at'], 'started')
+    logdata = Logfmt.parse(loglines[1])
+    assert(logdata['at'], 'finished')
+    assert(logdata['status'], '500')
   end
 end

data/test/success_test.rb

@@ -0,0 +1,35 @@
+require_relative 'helper'
+
+class SuccessTest < ApiTest
+  class App < Jersey::API::Base
+    get '/test-201' do
+      created({foo: 'baz'})
+    end
+
+    get '/test-202' do
+      accepted({foo: 'bar'})
+    end
+
+    get '/test-204' do
+      no_content
+    end
+  end
+
+  def test_created
+    get '/test-201'
+    assert_equal(201, last_response.status)
+    assert_equal('baz', json['foo'])
+  end
+
+  def test_accepted
+    get '/test-202'
+    assert_equal(202, last_response.status)
+    assert_equal('bar', json['foo'])
+  end
+
+  def test_no_content
+    get '/test-204'
+    assert_equal(204, last_response.status)
+    assert_equal('', last_response.body)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jersey
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - csquared
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -42,16 +42,16 @@ dependencies:
   name: env-conf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,12 +115,14 @@ files:
 - lib/jersey/extensions/error_handler.rb
 - lib/jersey/extensions/route_signature.rb
 - lib/jersey/helpers/log.rb
+- lib/jersey/helpers/success.rb
 - lib/jersey/http_errors.rb
 - lib/jersey/log.rb
 - lib/jersey/logging/base_logger.rb
 - lib/jersey/logging/json_logger.rb
 - lib/jersey/logging/logfmt_logger.rb
 - lib/jersey/logging/mixins.rb
+- lib/jersey/middleware/error_handler.rb
 - lib/jersey/middleware/request_id.rb
 - lib/jersey/middleware/request_logger.rb
 - lib/jersey/setup.rb
@@ -130,6 +133,7 @@ files:
 - test/log_test.rb
 - test/request_logger_test.rb
 - test/setup_test.rb
+- test/success_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -150,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Write APIs in the New Jersey Style
@@ -160,3 +164,4 @@ test_files:
 - test/log_test.rb
 - test/request_logger_test.rb
 - test/setup_test.rb
+- test/success_test.rb