rory 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df765583fa4f315b7f217e8324523d7dd4b3c2ba
-  data.tar.gz: f977ad97a93566d606319301ea03a06447c2a260
+  metadata.gz: 87f7aad3ae233e7193f17c7766db1cc3c551793b
+  data.tar.gz: 8c5ac24faba7ab853b087af9dbea31100d966fc8
 SHA512:
-  metadata.gz: 3c2dd88f139db2931ebe7fdb9153c6ca4180d65f36622fdc51e18859ae55f6661636fe5c5b525564b9ac6973f9980a2e6266b8508317579f87bce4218b68bf83
-  data.tar.gz: 152c81f7ab8498553a4d4e1dce0d583c25d29bd882c8c776178e8b73815b3a3f9a08e2ab3e2300b8c95f50d0b2efc034348522125a0089efac00574ebc5c8a4f
+  metadata.gz: df8251d088994de0b6333c6ac67daa1c260aa69e7f8aee39f2b59a8234b68cfb096b301664d0c6440e0cf32173160cd5ba4ecd5ee7482d80a3613190148c21c1
+  data.tar.gz: 3146ba610b2b6e80178f417bbde883acfdb9a560f57aa85157a2db819d8140137fa8431299bc0e421ae05cf498788896f49d4738a0578de1677c5fe3f09f5c8d

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/rory.svg)](http://badge.fury.io/rb/rory)
 rory
 ====
 

data/lib/rory.rb

@@ -2,6 +2,7 @@ ENV['RORY_ENV'] ||= ENV['RACK_ENV'] || 'development'
 
 require 'yaml'
 require 'sequel'
+require 'thread/inheritable_attributes'
 require 'rack/contrib'
 require 'rory/application'
 require 'rory/dispatcher'

data/lib/rory/application.rb

@@ -1,5 +1,6 @@
 require 'pathname'
-require 'logger'
+require 'rory/logger'
+require 'rory/request_id'
 require 'rory/route_mapper'
 require 'rack/commonlogger'
 require_relative 'request_parameter_logger'
@@ -39,7 +40,7 @@ module Rory
       end
 
       def root=(root_path)
-        @root = Pathname.new(root_path).expand_path
+        $:.unshift @root = Pathname.new(root_path).realpath
       end
     end
 
@@ -137,6 +138,7 @@ module Rory
 
     def use_default_middleware
       if request_logging_on?
+        use_middleware Rory::RequestId, :uuid_prefix => self.class.name
         use_middleware Rack::PostBodyContentTypeParser
         use_middleware Rack::CommonLogger, logger
         use_middleware Rory::RequestParameterLogger, logger, :filters => parameters_to_filter

data/lib/rory/dispatcher.rb

@@ -11,7 +11,7 @@ module Rory
 
     def self.rack_app(app)
       Proc.new { |env|
-        new(Rack::Request.new(env), app).dispatch
+        new(Rory::Request.new(env), app).dispatch
       }
     end
 

data/lib/rory/logger.rb

@@ -0,0 +1,46 @@
+require "rory/request"
+require "logger"
+
+module Rory
+  class Logger < ::Logger
+    def initialize(io, options={})
+      super(io)
+      @default_formatter = Formatter.new
+      @tagged            = options.fetch(:tagged, [:request_id])
+    end
+
+    def <<(msg)
+      super([tagged, msg].reject(&:empty?).join(" "))
+    end
+
+    alias_method :write, :<<
+
+    def request_id
+      Thread.current.get_inheritable_attribute(:rory_request_id)
+    end
+
+    def tagged
+      @tagged.map do |key|
+        "#{key}=#{quoted_string(public_send(key))}"
+      end.join(" ").rstrip
+    end
+
+    private
+
+    def quoted_string(str)
+      str =~ /\s/ ? %["#{str}"] : str
+    end
+
+    def format_message(severity, datetime, progname, msg)
+      (@formatter || @default_formatter).call(severity, datetime, progname, msg, tagged)
+    end
+
+    class Formatter < ::Logger::Formatter
+      FORMAT = "%s, [%s - %s#%d] %5s -- %s: %s\n"
+
+      def call(severity, time, progname, msg, tagged)
+        FORMAT % [severity[0..0], tagged, format_datetime(time), $$, severity, progname, msg2str(msg)]
+      end
+    end
+  end
+end

data/lib/rory/request.rb

@@ -0,0 +1,13 @@
+module Rory
+  class Request < ::Rack::Request
+    # Returns the unique request id, which is based off either the X-Request-Id header that can
+    # be generated by a firewall, load balancer, or web server or by the RequestId middleware
+    # (which sets the rory.request_id environment variable).
+    #
+    # This unique ID is useful for tracing a request from end-to-end as part of logging or debugging.
+    # This relies on the rack variable set by the Rory::RequestId middleware.
+    def uuid
+      @uuid ||= env["rory.request_id"]
+    end
+  end
+end

data/lib/rory/request_id.rb

@@ -0,0 +1,40 @@
+module Rory
+  # Makes a unique request id available to the rory.request_id env variable (which is then accessible through
+  # Rory::Request#uuid) and sends the same id to the client via the X-Request-Id header.
+  #
+  # The unique request id is either based off the X-Request-Id header in the request, which would typically be generated
+  # by a firewall, load balancer, or the web server, or, if this header is not available, a random uuid. If the
+  # header is accepted from the outside world, we sanitize it to a max of 255 chars and alphanumeric and dashes only.
+  #
+  # The unique request id can be used to trace a request end-to-end and would typically end up being part of log files
+  # from multiple pieces of the stack.
+  class RequestId
+    def initialize(app, options={})
+      @app          = app
+      @uuid_creator = options.fetch(:uuid_creator, SecureRandom)
+      @uuid_prefix  = options[:uuid_prefix]
+    end
+
+    def call(env)
+      env["rory.request_id"] = external_request_id(env) || internal_request_id
+      Thread.current.set_inheritable_attribute(:rory_request_id, env["rory.request_id"])
+      @app.call(env).tap { |_status, headers, _body| headers["X-Request-Id"] = env["rory.request_id"] }
+    end
+
+    private
+
+    def external_request_id(env)
+      if (request_id = env["HTTP_X_REQUEST_ID"])
+        request_id.gsub(/[^\w\-]/, "")[0..254]
+      end
+    end
+
+    def internal_request_id
+      "#{uuid_prefix}#{@uuid_creator.uuid}"
+    end
+
+    def uuid_prefix
+      @uuid_prefix ? "#{Support.tokenize(@uuid_prefix)}-" : ""
+    end
+  end
+end

data/lib/rory/request_parameter_logger.rb

@@ -1,5 +1,4 @@
 require_relative 'parameter_filter'
-
 module Rory
   class RequestParameterLogger
 

data/lib/rory/version.rb

@@ -1,3 +1,3 @@
 module Rory
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/rory.gemspec

@@ -32,14 +32,16 @@ EOF
   s.add_runtime_dependency 'rack-contrib', '~> 1.2'
   s.add_runtime_dependency 'sequel', '~> 4.0'
   s.add_runtime_dependency 'thin', '~> 1.0'
+  s.add_runtime_dependency 'thread-inheritable_attributes', '~> 0.1'
 
   s.add_development_dependency 'rake', '~> 10.4'
   s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'mime-types', '~> 2.6'
   s.add_development_dependency 'capybara', '~> 2.4'
   s.add_development_dependency 'yard', '~> 0.8'
   s.add_development_dependency 'reek', '~> 2.2'
   s.add_development_dependency 'simplecov', '~> 0.10'
-  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'bundler', '~> 1.10'
   s.add_development_dependency 'pry', '~> 0.10'
 end
 

data/spec/lib/rory/application_spec.rb

@@ -1,11 +1,38 @@
 describe Rory::Application do
   let(:subject) {
-    Class.new(Rory::Application).tap { |app|
-      app.root = "whatever"
+    Object.const_set(test_rory_app_name, Class.new(Rory::Application).tap { |app|
+      app.root = root
       app.turn_off_request_logging!
-    }
+    })
+    Object.const_get(test_rory_app_name)
   }
 
+  let(:test_rory_app_name){
+    "TestRory#{('a'..'z').to_a.sample(5).join}"
+  }
+  let(:root){"spec/fixture_app"}
+
+  describe ".root=" do
+    let(:root) { "current_app" }
+    before { `ln -s spec/fixture_app current_app` }
+    after { `rm current_app` }
+
+    it 'appends to the load path' do
+      expect($:).to receive(:unshift).with(Pathname("current_app").realpath)
+      subject
+    end
+  end
+
+  describe ".root" do
+    let(:root) { "current_app" }
+    before { `ln -s spec/fixture_app current_app` }
+    after { `rm current_app` }
+
+    it "returns the realpath" do
+      expect(subject.root.to_s).to match(/spec\/fixture_app/)
+    end
+  end
+
   describe ".configure" do
     it 'yields the given block to self' do
       subject.configure do |c|
@@ -156,6 +183,7 @@ describe Rory::Application do
       allow(subject.instance).to receive(:request_logging_on?).and_return(true)
       allow(subject.instance).to receive(:parameters_to_filter).and_return([:horses])
       allow(subject.instance).to receive(:logger).and_return(:the_logger)
+      expect(subject.instance).to receive(:use_middleware).with(Rory::RequestId, :uuid_prefix => test_rory_app_name)
       expect(subject.instance).to receive(:use_middleware).with(Rack::PostBodyContentTypeParser)
       expect(subject.instance).to receive(:use_middleware).with(Rack::CommonLogger, :the_logger)
       expect(subject.instance).to receive(:use_middleware).with(Rory::RequestParameterLogger, :the_logger, :filters => [:horses])
@@ -263,4 +291,4 @@ describe Rory::Application do
       end
     end
   end
-end
+end

data/spec/lib/rory/logger_spec.rb

@@ -0,0 +1,90 @@
+require "logger"
+require "thread/inheritable_attributes"
+require "rory/logger"
+
+describe Rory::Logger do
+  subject { described_class.new(string_io) }
+  let(:string_io) { StringIO.new }
+  let(:result) { string_io.tap(&:rewind).read }
+
+  let(:simple_format) {
+    subject.formatter = Proc.new do |severity, _, _, msg, tagged|
+      "#{severity} #{tagged} - #{msg}"
+    end
+  }
+
+  let(:rory_request_id) { "1111-2222" }
+
+  before { Thread.current[:inheritable_attributes] = {:rory_request_id => rory_request_id} }
+  after { Thread.current[:inheritable_attributes] = nil }
+
+  context "when tagged is empty" do
+    subject { described_class.new(string_io, tagged: []) }
+    it "does not tag anything" do
+      simple_format
+      subject.<< "Hello"
+      expect(result).to eq "Hello"
+    end
+  end
+
+  context "creating custom tags" do
+    subject { described_class.new(string_io, tagged: [:custom_tag, :request_id]) }
+    it "needs an instance method go along with new tag" do
+      def subject.custom_tag
+        "Words.."
+      end
+      simple_format
+      subject.<< "Hello"
+      expect(result).to eq "custom_tag=Words.. request_id=1111-2222 Hello"
+    end
+  end
+
+  describe "#<<" do
+    it "tags are present with this form" do
+      simple_format
+      subject.<< "Hello"
+      expect(result).to eq "request_id=1111-2222 Hello"
+    end
+  end
+
+  context "when a tagged values has spaces" do
+    let(:rory_request_id) { "1111 2222" }
+    it "is quoted" do
+      simple_format
+      subject.<< "Good Morning"
+      expect(result).to eq 'request_id="1111 2222" Good Morning'
+    end
+  end
+
+  describe "#info" do
+    it "severity level is set to INFO" do
+      simple_format
+      subject.info "Hello"
+      expect(result).to eq "INFO request_id=1111-2222 - Hello"
+    end
+  end
+
+  describe "#formatter" do
+    it "define a custom formatting" do
+      subject.formatter = Proc.new do |_, _, _, msg, tagged|
+        "This is formatted: #{tagged} - #{msg}"
+      end
+      subject.info "Hello"
+      expect(result).to eq "This is formatted: request_id=1111-2222 - Hello"
+    end
+
+    it "has default formatting" do
+      subject.info "Goodbye"
+      expect(result).to match /request_id=1111-2222.*INFO -- : Goodbye\n/
+    end
+  end
+
+  describe "integration with Rack::CommonLogger" do
+    it "only prepends tags" do
+      [200, { "REMOTE_ADDR" => "127.0.0.1", "HTTP_VERSION" => "1.1" }, ""]
+      Rack::CommonLogger.new(Proc.new { |a| a }, subject).send(:log, { "REMOTE_ADDR" => "127.0.0.1", "HTTP_VERSION" => "1.1", Rack::QUERY_STRING => "abc" }, 200, {}, 1)
+      "I, [1111-2222 - 2016-01-20T16:30:52.193516 #5341]  INFO -- : 127.0.0.1 - - [20/Jan/2016:16:30:52 -0800] \" ?abc 1.1\" 200 - 1453336251.1934\n\n"
+      expect(result).to match /request_id=1111-2222 127.0.0.1 - - /
+    end
+  end
+end

data/spec/lib/rory/request_id_spec.rb

@@ -0,0 +1,56 @@
+RSpec.describe Rory::RequestId do
+  subject { described_class.new(Proc.new {|env|[200, headers, ""] },
+                                uuid_prefix:  uuid_prefix,
+                                uuid_creator: class_double(SecureRandom, uuid: "1234")) }
+  after { Thread.current[:inheritable_attributes] = nil }
+  let(:headers) { {} }
+  let(:env) { {} }
+  let(:uuid_prefix) { nil }
+
+  context "when no external_request_id is set" do
+    before { subject.call(env) }
+
+    it "sets env['rory.request_id']" do
+      expect(env["rory.request_id"]).to eq "1234"
+    end
+
+    it "sets header['X-Request-Id']" do
+      expect(headers["X-Request-Id"]).to eq "1234"
+    end
+
+    it "sets Thread.current[:rory_request_id]" do
+      expect(Thread.current.get_inheritable_attribute(:rory_request_id)).to eq "1234"
+    end
+
+    context "the uuid can be given a prefixed to know where it was created" do
+      let(:uuid_prefix) { "AppName" }
+      it { expect(Thread.current.get_inheritable_attribute(:rory_request_id)).to eq "app_name-1234" }
+    end
+  end
+
+  context "when external_request_id is set" do
+    before { subject.call(env) }
+    let(:env) { { "HTTP_X_REQUEST_ID" => "4321" } }
+
+    it "sets env['rory.request_id']" do
+      expect(env["rory.request_id"]).to eq "4321"
+    end
+
+    it "sets header['X-Request-Id']" do
+      expect(headers["X-Request-Id"]).to eq "4321"
+    end
+
+    it "sets Thread.current[:rory_request_id]" do
+      expect(Thread.current.get_inheritable_attribute(:rory_request_id)).to eq "4321"
+    end
+  end
+
+  context "use default SecureRandom" do
+    subject { described_class.new(Proc.new {|env|[200, headers, ""] },
+                                  uuid_prefix:  uuid_prefix).call({}) }
+    it "call uuid on SecureRandom" do
+      expect(SecureRandom).to receive(:uuid).once
+      subject
+    end
+  end
+end

data/spec/lib/rory/request_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe Rory::Request do
+  describe "#uuid" do
+    it "returns the value set by env['rory.request_id']" do
+      env = { "rory.request_id" => "uuid-from_rory_request" }
+      expect(described_class.new(env).uuid).to eq "uuid-from_rory_request"
+    end
+
+    context "when no key exists" do
+      it "returns nil" do
+        expect(described_class.new({}).uuid).to eq nil
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rory
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Ravi Gadad
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -68,6 +68,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thread-inheritable_attributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +110,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -158,14 +186,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -201,10 +229,13 @@ files:
 - lib/rory/application.rb
 - lib/rory/controller.rb
 - lib/rory/dispatcher.rb
+- lib/rory/logger.rb
 - lib/rory/parameter_filter.rb
 - lib/rory/path_generation.rb
 - lib/rory/renderer.rb
 - lib/rory/renderer/context.rb
+- lib/rory/request.rb
+- lib/rory/request_id.rb
 - lib/rory/request_parameter_logger.rb
 - lib/rory/route.rb
 - lib/rory/route_mapper.rb
@@ -237,10 +268,13 @@ files:
 - spec/lib/rory/application_spec.rb
 - spec/lib/rory/controller_spec.rb
 - spec/lib/rory/dispatcher_spec.rb
+- spec/lib/rory/logger_spec.rb
 - spec/lib/rory/parameter_filter_spec.rb
 - spec/lib/rory/renderer/context_spec.rb
 - spec/lib/rory/renderer_spec.rb
+- spec/lib/rory/request_id_spec.rb
 - spec/lib/rory/request_parameter_logger_spec.rb
+- spec/lib/rory/request_spec.rb
 - spec/lib/rory/route_spec.rb
 - spec/lib/rory/support_spec.rb
 - spec/lib/rory_spec.rb
@@ -267,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Another Ruby web framework. Just what the world needs.