jersey 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c73c2c478b36fbd1a0574323dcbb7f023264517d
+  data.tar.gz: d7f9a1f7e5cd742a9de16d62c12b8b9cce788137
+SHA512:
+  metadata.gz: 81638bfb73758bf758ae0245c163f88c2bf01c9214736a036c74f00e4a8f3a6309888588e07be9878783835f4ebad5bf02c348be1ec5dbb2adcdac72637d095e
+  data.tar.gz: 49fc8716d35f5e8b8d1cffb85d912e391c5325b22e8e72a751b9aedebaee14a94f82d9e27727b92773808d660790bcd4f0f9f95914845ac1d002adb499efced3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jersey.gemspec
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'rack-test', require: 'rack/test'
+  gem 'logfmt'
+  gem 'puma'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 csquared
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,233 @@
+# Jersey
+
+<img src="http://geology.com/state-map/maps/new-jersey-physical-map.gif" height="200px" />
+
+Because [worse is better](http://en.wikipedia.org/wiki/Worse_is_better).
+
+Jersey is a gem for people who want to write excellent APIs but have their
+own opinions on how to structure their code and projects.
+
+Jersey provides sensible defaults that are composed with sensible pieces, making
+it easy to compose your own stack or use Jesery's compositions.
+
+## Features
+  - env-conf for easy ENV based configuration
+  - request context aware request logging
+  - structured data loggers - json and logfmt
+  - unified exception handling
+
+### `Jersey.setup`
+
+Setup embodies a few opinions we have about apps:
+- Having a notion of 'environment' where the configuration lives
+- Using a dependency manager
+- Always using UTC for the Time zone
+- Always printing times in ISO8601 format
+
+`Jersey.setup` allows any app that has Gemfiles and `.env` files to
+"just work" in development *and* production with just:
+
+```ruby
+require 'jersey'
+Jersey.setup
+```
+
+Which is usually included as the first line of code in a library consuming
+Jersey.  For tests, you will want to set `RACK_ENV` to `test` before
+requiring your library that uses the above.
+
+### `Jersey::API::Base`
+
+Combines all of the Jersey middleware with a few standard middleware
+from Rack and sinatra-contrib.
+
+```ruby
+class API < Jersey::API::Base
+  get '/hello' do
+    Jersey.log(at: "hello")
+    'hello'
+  end
+
+  get '/not_found' do
+    raise NotFound, "y u no here?"
+  end
+end
+```
+
+
+```
+$ curl http://localhost:9292/hello
+```
+
+Server logs:
+```
+at=start method=GET path=/hello request_id=2c018557-d246-4b04-a7d7-fc74bae67ec0 now=2014-11-11T18:04:25+00:00
+at=hello now=2014-11-11T18:04:25+00:00 request_id=2c018557-d246-4b04-a7d7-fc74bae67ec0
+at=finish method=GET path=/hello status=200 size#bytes=5 route_signature=/hello elapsed=0.000 request_id=2c018557-d246-4b04-a7d7-fc74bae67ec0 now=2014-11-11T18:04:25+00:00
+```
+
+Unified, structured logging with all the info you will wish you had:
+
+```
+$ curl http://localhost:9292/not_found | jq '.'
+```
+
+Server logs:
+```
+at=start method=GET path=/not_found request_id=f3085630-05cf-4314-a7dd-5855e752594b now=2014-11-11T18:05:15+00:00
+at=finish method=GET path=/not_found status=404 size#bytes=6212 route_signature=/not_found elapsed=0.001 request_id=f3085630-05cf-4314-a7dd-5855e752594b now=2014-11-11T18:05:15+00:00
+```
+
+Response:
+```json
+{
+  "error": {
+    "type": "NotFound",
+    "message": "y u no here?",
+    "backtrace": [
+      "/Users/csquared/projects/jersey/examples/readme.ru:11:in `block in <class:API>'",
+      "/Users/csquared/projects/jersey/.bundle/bundle/ruby/2.1.0/gems/sinatra-1.4.5/lib/sinatra/base.rb:1603:in `call'",
+      ....
+    ]
+ }
+}
+```
+
+Unified, strucutred error handling. Notice how all we needed to do was raise `NotFound`
+and we get a 404 response code (in the server logs) and our error message as part of the JSON payload.
+
+#### `Jersey::HTTP::Errors`
+
+Includes Ruby `Error` objects named with camel case for all of the HTTP 4xx and 5xx
+errors. This allows you to raise `NotFound` as an error that has the `STATUS_CODE`
+defined.
+
+Allows uniform HTTP error handling when combined with the `ErrorHandler` sinatra extension.
+
+#### Usage
+Mix-in to any class that wants to raise HTTP errors, usually an API class.
+
+```ruby
+class API < Sinatra::Base
+  include Jersey::HTTP::Errors
+end
+```
+
+### `Jersey::Extensions::ErrorHandler`
+
+Unifies error responses. If the error object's class has a `STATUS_CODE` defined (such as the
+errors in `Jersey::HTTP::Errors`), this will use that as the HTTP return status. The error
+message and backtraces are included in responses assuming that this in for an internal API
+over secured channels and therefore favors ease of debugging over the security risk of
+including the backtrace. This is something I may want to configure.
+
+#### Usage
+Register as a Sinatra extension
+
+```ruby
+class API < Sinatra::Base
+  register Jersey::Extensions::ErrorHandler
+end
+```
+
+#### `Jersey::Extensions::RouteSignature`
+Adds a `ROUTE_SIGNATURE` to the `env` for each request, which is the name of an api endpoint
+as it is *defined* versus the path that reaches your app.
+For example, when you define a route such as ` get "/hello/:id"`, the `ROUTE_SIGNATURE` would
+equal `"/hello/:id"`.
+When combined with the `RequestLogger`,
+it greatly simplifies creating aggregate statistics about the traffic hitting various api endpoints.
+
+*Note:* this is considered a hack and something that sinatra should, but does not, handle.
+
+#### Usage
+Register as a Sinatra extension
+
+```ruby
+class API < Sinatra::Base
+  register Jersey::Extensions::RouteSignature
+end
+```
+
+#### `Jersey::Middleware::RequestID`
+
+Creates a random request id for every http request, stored both in thread local storage
+via the `RequestStore` and in the Rack `env`.
+
+
+Works with or without explicitly including `RequestStore::Middleware`.
+
+#### Usage
+Use as a Rack middleware
+
+```ruby
+class API < Sinatra::Base
+  use Jersey::Middleware::RequestID
+end
+```
+
+#### `Jersey::Middleware::RequestLogger`
+
+Logs http start and finish and errors in a structured logging format.
+
+It defaults to using the `Jersey.logger` singleton which is `RequestStore`-aware.
+Anything in `RequestStore[:log]` will get appended to the log data. (This is how request ids
+are made available to logger calls outside of HTTP blocks but within HTTP request lifecycles).
+
+Because I think request_ids are important, the logger will try to get them from either the
+`RequestStore` or the `env`.
+
+Logs at request start:
+
+    at:              "start",
+    request_id:      env['REQUEST_ID'],
+    method:          request.request_method,
+    path:            request.path_info,
+    content_type:    request.content_type,
+    content_length:  request.content_length
+
+Logs at request finish:
+
+    at:              "finish",
+    method:          request.request_method,
+    path:            request.path_info,
+    status:          status,
+    content_length:  headers['Content-Length'],
+    route_signature: env['ROUTE_SIGNATURE'],
+    elapsed:         (Time.now - @request_start).to_f,
+    request_id:      env['REQUEST_ID']
+
+
+#### Usage
+Use as a Rack middleware
+
+```ruby
+class API < Sinatra::Base
+  use Jersey::Middleware::RequestLogger
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jersey'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jersey
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jersey/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/examples/readme.ru

@@ -0,0 +1,15 @@
+require 'jersey'
+Jersey.setup
+
+class API < Jersey::API::Base
+  get '/hello' do
+    Jersey.log(at: "hello")
+    'hello'
+  end
+
+  get '/not_found' do
+    raise NotFound, "y u no here?"
+  end
+end
+
+run API

data/jersey.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jersey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jersey"
+  spec.version       = Jersey::VERSION
+  spec.authors       = ["csquared"]
+  spec.email         = ["christopher.continanza@gmail.com"]
+  spec.summary       = %q{Write APIs in the New Jersey Style}
+  spec.description   = %q{Set of composable middleware and helpers for production sinatra APIs}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sinatra", "~> 1.4"
+  spec.add_dependency 'sinatra-contrib', "~> 1.4"
+  spec.add_dependency 'env-conf'
+  spec.add_dependency 'request_store'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/jersey.rb

@@ -0,0 +1,10 @@
+require "jersey/version"
+require 'jersey/log'
+
+module Jersey
+end
+
+require 'jersey/setup'
+require 'jersey/api'
+require 'jersey/base'
+require 'jersey/time'

data/lib/jersey/api.rb

@@ -0,0 +1,12 @@
+module Jersey
+  module API
+    module Middleware
+    end
+
+    module Extensions
+    end
+
+    module Helpers
+    end
+  end
+end

data/lib/jersey/base.rb

@@ -0,0 +1,31 @@
+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'
+
+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
+    use Rack::ETag
+
+    use Jersey::Middleware::RequestID
+    use Jersey::Middleware::RequestLogger
+
+    helpers Sinatra::JSON
+    helpers Jersey::Helpers::Log
+  end
+end

data/lib/jersey/extensions/error_handler.rb

@@ -0,0 +1,30 @@
+module Jersey::Extensions
+  module ErrorHandler
+    def self.registered(app)
+      app.set :dump_errors, false
+      app.set :raise_errors, false
+      app.set :show_exceptions, false
+
+      # APIS should always return meaningful standardized errors
+      # with statuses that best match HTTP conventions
+      #
+      # Places nicely with Jersey::HTTP::Errors
+      app.error do
+        content_type(:json)
+        e = env['sinatra.error']
+        # get status code from Jersey Errors
+        if e.class.const_defined?(:STATUS_CODE)
+          status(e.class::STATUS_CODE)
+        else
+          status(500)
+        end
+
+        json(error: {
+          type: e.class.name.split('::').last,
+          message: e.message,
+          backtrace: e.backtrace
+        })
+      end
+    end
+  end
+end

data/lib/jersey/extensions/route_signature.rb

@@ -0,0 +1,16 @@
+module Jersey::Extensions
+  module RouteSignature
+    def self.registered(app)
+      app.helpers do
+        def route_signature
+          env["ROUTE_SIGNATURE"]
+        end
+      end
+    end
+
+    def route(verb, path, *)
+      condition { env["ROUTE_SIGNATURE"] = path.to_s }
+      super
+    end
+  end
+end