jersey 0.0.3

data/test/helper.rb

@@ -0,0 +1,39 @@
+# Need this so we load up .env.test
+ENV['RACK_ENV'] = 'test'
+
+# Requies all the Gems
+require_relative '../lib/jersey'
+Jersey.setup
+
+# require test runner
+require 'minitest/autorun'
+require 'minitest/pride' # :)
+
+# load the test helpers
+# Dir["./test/helpers/**/*.rb"].sort.each { |f| require f }
+
+module JsonHelpers
+  def json; JSON.parse(last_response.body); end
+end
+
+class UnitTest < Minitest::Test
+  def setup
+    super
+    Jersey.logger.reset!
+    Jersey.logger.stream = StringIO.new unless ENV['LOG']
+  end
+
+  def logs
+    Jersey.logger.stream.string
+  end
+end
+
+class ApiTest < UnitTest
+  include Rack::Test::Methods
+  include JsonHelpers
+
+  # default app method to return an app named `App`
+  def app
+    self.class.const_get(:App)
+  end
+end

data/test/log_test.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+class LogTest < UnitTest
+  def setup
+    super
+    Jersey.logger.stream = StringIO.new
+  end
+
+  def test_log_json
+    logger = Jersey::JSONLogger.new(stream: StringIO.new)
+    logger.log(foo: "bar")
+    logdata = JSON.parse(logger.stream.string)
+    assert_equal('bar', logdata['foo'])
+  end
+
+  def test_log_nothing_logs_time
+    Jersey.log()
+    logdata = Logfmt.parse(logs)
+    assert(logdata['now'], 'must log time')
+  end
+
+  def test_log_hash
+    Jersey.log(foo: 'bar')
+    logdata = Logfmt.parse(logs)
+    assert_equal('bar', logdata['foo'])
+    assert(logdata['now'], 'must log time')
+  end
+
+  def test_log_error
+    begin
+      raise "boom!"
+    rescue => e
+      Jersey.log(e)
+      loglines = logs.lines
+      logdata = Logfmt.parse(loglines[0])
+      assert_equal('boom!', logdata['message'])
+      assert_equal(e.object_id, logdata['id'])
+      assert(logdata['now'], 'must log time')
+
+      logdata = Logfmt.parse(loglines[1])
+      assert_equal(1, logdata['line_number'])
+      assert_equal(e.object_id, logdata['id'])
+
+      logdata = Logfmt.parse(loglines[2])
+      assert_equal(2, logdata['line_number'])
+      assert_equal(e.object_id, logdata['id'])
+
+      logdata = Logfmt.parse(loglines.last)
+      assert_equal(10, logdata['line_number'])
+      assert_equal(e.object_id, logdata['id'])
+
+      assert_equal(11, loglines.size)
+    end
+  end
+end

data/test/request_logger_test.rb

@@ -0,0 +1,161 @@
+require 'helper'
+
+class RequestLoggerTest < ApiTest
+  class App < Sinatra::Base
+    use Jersey::Middleware::RequestLogger
+
+    get('/get')  { 'OK' }
+    post('/') { 'OK' }
+    put('/')  { status(201); 'OK' }
+    delete('/')  { 'OK' }
+  end
+
+  def setup
+    super
+    Jersey.logger.stream = StringIO.new
+  end
+
+  def test_logs_GET_request_method_path_and_time
+    get '/get'
+    loglines = logs.lines
+    logdata = Logfmt.parse(loglines[0])
+    assert_equal('start', logdata['at'])
+    assert_equal('GET', logdata['method'])
+    assert_equal('/get', logdata['path'])
+    assert(logdata['now'], 'must log time')
+
+    logdata = Logfmt.parse(loglines[1])
+    assert_equal('finish', logdata['at'])
+    assert_equal('GET', logdata['method'])
+    assert_equal('/get', logdata['path'])
+    assert_equal(200, logdata['status'])
+    assert_equal(2, logdata['content_length'])
+    assert(logdata['now'], 'must log time')
+    assert(logdata['elapsed'], 'must log duration')
+  end
+
+  def test_logs_POST_request_method_path_and_time
+    post '/'
+    logdata = Logfmt.parse(logs.lines[0])
+    assert_equal('POST', logdata['method'])
+    assert_equal('/', logdata['path'])
+  end
+
+  def test_logs_PUT_request_method_path_and_time
+    put '/'
+    logdata = Logfmt.parse(logs.lines[0])
+    assert_equal('PUT', logdata['method'])
+
+    logdata = Logfmt.parse(logs.lines[1])
+    assert_equal('PUT', logdata['method'])
+    assert_equal(201, logdata['status'])
+  end
+end
+
+class RequestLoggerWithRequestIDsTest < ApiTest
+  class App < Sinatra::Base
+    use RequestStore::Middleware
+    use Jersey::Middleware::RequestID
+    use Jersey::Middleware::RequestLogger
+
+    get('/') do
+      Jersey.log(at: 'mid-request')
+      'OK'
+    end
+  end
+
+  def setup
+    super
+    Jersey.logger.stream = StringIO.new
+  end
+
+  # Testing a few things here
+  def test_logs_request_id
+    get '/'
+    loglines = logs.lines
+
+    logdata = Logfmt.parse(loglines[0])
+    request_id = logdata['request_id']
+    assert_equal('start', logdata['at'])
+    assert(request_id, 'must log request id')
+
+    logdata = Logfmt.parse(loglines[1])
+    assert_equal('mid-request', logdata['at'])
+    assert_equal(request_id, logdata['request_id'])
+
+    logdata = Logfmt.parse(loglines[2])
+    assert_equal('finish', logdata['at'])
+    assert_equal(request_id, logdata['request_id'])
+
+  end
+
+
+  def test_doesnt_persist_request_id
+    get '/'
+    logdata = Logfmt.parse(logs.lines[0])
+    request_id = logdata['request_id']
+
+    Jersey.log(foo: 'bar')
+    logdata = Logfmt.parse(logs.lines.last)
+    assert_equal('bar', logdata['foo'])
+    refute(logdata['request_id'], 'should not have request id')
+  end
+
+  def test_doesnt_clear_everything
+    Jersey.logger << {app_name: 'hotness'}
+    get '/'
+    logdata = Logfmt.parse(logs.lines[0])
+    assert_equal('hotness', logdata['app_name'])
+
+    get '/'
+    logdata = Logfmt.parse(logs.lines[3])
+    assert_equal('hotness', logdata['app_name'])
+  end
+end
+
+class RequestLoggerNoRequestStore < ApiTest
+  class App < Sinatra::Base
+    use Jersey::Middleware::RequestID
+    use Jersey::Middleware::RequestLogger
+
+    get('/') do
+      Jersey.log(at: 'mid-request')
+      'OK'
+    end
+  end
+
+  def setup
+    super
+    Jersey.logger.stream = StringIO.new
+  end
+
+  # Testing a few things here
+  def test_logs_request_id
+    get '/'
+    loglines = logs.lines
+
+    logdata = Logfmt.parse(loglines[0])
+    request_id = logdata['request_id']
+    assert_equal('start', logdata['at'])
+    assert(request_id, 'must log request id')
+
+    logdata = Logfmt.parse(loglines[1])
+    assert_equal('mid-request', logdata['at'])
+    assert_equal(request_id, logdata['request_id'])
+
+    logdata = Logfmt.parse(loglines[2])
+    assert_equal('finish', logdata['at'])
+    assert_equal(request_id, logdata['request_id'])
+  end
+
+  def test_doesnt_persist_request_id
+    get '/'
+    logdata = Logfmt.parse(logs.lines[0])
+    request_id = logdata['request_id']
+
+    Jersey.log(foo: 'bar')
+    logdata = Logfmt.parse(logs.lines.last)
+    assert_equal('bar', logdata['foo'])
+    refute(logdata['request_id'], 'should not have request id')
+  end
+end

data/test/setup_test.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class SetupTest < UnitTest
+  def test_time_zone
+    t = Time.now
+    assert_equal('UTC', t.zone)
+  end
+
+  def test_time_to_s
+    t = Time.now
+    assert_equal(t.iso8601, t.to_s)
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: jersey
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- csquared
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: env-conf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Set of composable middleware and helpers for production sinatra APIs
+email:
+- christopher.continanza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/readme.ru
+- jersey.gemspec
+- lib/jersey.rb
+- lib/jersey/api.rb
+- lib/jersey/base.rb
+- lib/jersey/extensions/error_handler.rb
+- lib/jersey/extensions/route_signature.rb
+- lib/jersey/helpers/log.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/request_id.rb
+- lib/jersey/middleware/request_logger.rb
+- lib/jersey/setup.rb
+- lib/jersey/time.rb
+- lib/jersey/version.rb
+- test/errors_test.rb
+- test/helper.rb
+- test/log_test.rb
+- test/request_logger_test.rb
+- test/setup_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Write APIs in the New Jersey Style
+test_files:
+- test/errors_test.rb
+- test/helper.rb
+- test/log_test.rb
+- test/request_logger_test.rb
+- test/setup_test.rb