ey-logger 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91dc69daebff7bb091ae258a0a3765992d926858
+  data.tar.gz: 165cd1b6a487c826b470fdf842b22769951703d3
+SHA512:
+  metadata.gz: 4ef0782ce54228ec7910ca6e160274df90035a5e9bedff473a35c11a2ba8aa819bc7cc50158bf63011c8ec7079de3701a5235f5fc07e08bd07ae5b3ae584f534
+  data.tar.gz: 8683940f8f23dbae363c5a7ba559af00a9297ee482560768466e4c5db0e0f6f632629d97a8a9f3a7658ee27fb2a922abefd4b4c1b4d10356242c8f80bdb1a912

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 ey-logger.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'faraday', '~> 0.9'
+  gem 'rack-test'
+  gem 'pry-nav'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Michelle Noorali & Josh Lane
+
+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,31 @@
+# Ey::Logger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ey-logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ey-logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ey-logger/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,2 @@
+require "bundler/gem_tasks"
+

data/ey-logger.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ey/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ey-logger"
+  spec.version       = Ey::Logger::VERSION
+  spec.authors       = ["Michelle Noorali & Josh Lane"]
+  spec.email         = ["mnoorali@engineyard.com"]
+  spec.summary       = %q{Standardized logging helpers for EngineYard}
+  spec.description   = %q{}
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "awesome_print", "~> 1.0"
+end

data/lib/ey/logger.rb

@@ -0,0 +1,30 @@
+require "ey/logger/version"
+
+require "awesome_print"
+require "json"
+
+require "logger"
+
+module Ey
+  class Logger
+
+    attr_reader :device, :formatter, :default_level, :prefix
+
+    def initialize(options={})
+      @device        = options.fetch(:device)
+      @default_level = options[:default_level]  || :info
+      @prefix        = options[:prefix] || nil
+      @formatter     = Ey::Logger::Formatter.for(options[:format] || :human).new(prefix)
+    end
+
+    def call(options)
+      level = options[:level] || default_level
+      output = formatter.call(options.fetch(:tag), options.fetch(:data))
+
+      device.public_send(level, output)
+    end
+  end
+end
+
+require 'ey/logger/formatter'
+require 'ey/logger/machine_parser'

data/lib/ey/logger/faraday.rb

@@ -0,0 +1,41 @@
+class Ey::Logger::Faraday
+
+  attr_reader :adapter
+
+  def initialize(app, options={})
+    @app = app
+
+    options[:prefix] ||= "ey.faraday"
+
+    @adapter = Ey::Logger.new(options)
+  end
+
+  def call(request_env)
+    # request phase
+    # :method - :get, :post, ...
+    # :url    - URI for the current request; also contains GET parameters
+    # :body   - POST parameters for :post/:put requests
+    # :request_headers
+    adapter.call(tag: "request", data: {
+      :method  => request_env.method,
+      :url     => request_env.url.to_s,
+      :headers => request_env.request_headers,
+      :body    => request_env.body,
+    })
+
+    @app.call(request_env).on_complete do |response_env|
+      # response phase
+      # :status - HTTP response status code, such as 200
+      # :body   - the response body
+      # :response_headers
+
+      adapter.call(tag: "response", data: {
+        :method  => request_env.method,
+        :url     => request_env.url.to_s,
+        :status  => response_env.status,
+        :body    => response_env.body,
+        :headers => response_env.response_headers,
+      })
+    end
+  end
+end

data/lib/ey/logger/formatter.rb

@@ -0,0 +1,26 @@
+class Ey::Logger::Formatter
+  def self.types
+    @@types ||= {}
+  end
+
+  def self.for(type)
+    types.fetch(type)
+  end
+
+  attr_reader :prefix
+
+  def initialize(prefix)
+    @prefix = prefix
+  end
+
+  def call(_tag, data)
+    raise NotImplementedError
+  end
+
+  def tag_for(tag)
+    [prefix, tag].compact.join(".")
+  end
+end
+
+require 'ey/logger/machine_formatter'
+require 'ey/logger/human_formatter'

data/lib/ey/logger/human_formatter.rb

@@ -0,0 +1,10 @@
+class Ey::Logger::HumanFormatter < Ey::Logger::Formatter
+
+  Ey::Logger::Formatter.types[:human] = self
+
+  def call(tag, data)
+    prefixed_tag = tag_for(tag)
+
+    {tag: prefixed_tag}.merge(data).ai
+  end
+end

data/lib/ey/logger/machine_formatter.rb

@@ -0,0 +1,9 @@
+class Ey::Logger::MachineFormatter < Ey::Logger::Formatter
+
+  Ey::Logger::Formatter.types[:machine] = self
+
+  def call(tag, data)
+    prefixed_tag = tag_for(tag)
+    "[#{prefixed_tag}] #{JSON.dump(data)}"
+  end
+end

data/lib/ey/logger/machine_parser.rb

@@ -0,0 +1,12 @@
+class Ey::Logger::MachineParser
+  def self.parse(line)
+    tag, data = line.match(/\A\[(\S+)\]\s+(\{.*\})\z/).captures
+    new(tag, JSON.load(data))
+  end
+
+  attr_reader :tag, :data
+
+  def initialize(tag, data)
+    @tag, @data = tag, data
+  end
+end

data/lib/ey/logger/version.rb

@@ -0,0 +1,5 @@
+module Ey
+  class Logger
+    VERSION = "0.0.4"
+  end
+end

data/spec/faraday_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'ey/logger/faraday'
+
+describe 'Ey::Logger::Farday' do
+  let!(:output) { StringIO.new }
+  let!(:device) {
+    logger = Logger.new(output)
+    logger.formatter = proc { |_, _, _, msg| "#{msg}\n" }
+    logger
+  }
+  let!(:connection) {
+    Faraday.new { |builder|
+      builder.use Ey::Logger::Faraday, device: device, format: format
+      builder.adapter(:rack, lambda { |env| [200, {"Content-Type" => "application/json"}, ["{}"]] })
+    }
+  }
+
+  context "with machine formatting" do
+    let(:format) { :machine }
+
+    it "should record request data" do
+      connection.post do |req|
+        req.url 'http://nigiri'
+        req.headers['Content-Type'] = 'application/json'
+        req.body = '{ "name": "Unagi" }'
+      end
+      request_line, response_line = output.tap(&:rewind).read.split("\n")
+
+      request_output  = Ey::Logger::MachineParser.parse(request_line)
+
+      expect(request_output.tag).to eq("ey.faraday.request")
+      expect(request_output.data).to eq({
+        "method"  => "post",
+        "url"     => "http://nigiri",
+        "headers" => {"User-Agent" => "Faraday v0.9.1", "Content-Type" => "application/json"},
+        "body"    => "{ \"name\": \"Unagi\" }",
+      })
+
+      response_output = Ey::Logger::MachineParser.parse(response_line)
+
+      expect(response_output.tag).to eq("ey.faraday.response")
+      expect(response_output.data).to eq({
+        "status"  => 200,
+        "method"  => "post",
+        "url"     => "http://nigiri",
+        "body"    => "{}",
+        "headers" => {"Content-Type"  => "application/json", "Content-Length" => "2"},
+      })
+    end
+  end
+
+  context "with human formatting" do
+    let(:format) { :human }
+
+    it "should record request data" do
+      connection.post do |req|
+        req.url 'http://nigiri'
+        req.headers['Content-Type'] = 'application/json'
+        req.body = '{ "name": "Unagi" }'
+      end
+
+      # hard to parse this
+      expect(output.tap(&:rewind).read).not_to be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'tempfile'
+
+Bundler.require(:default, :test)
+
+require File.expand_path("../../lib/ey/logger", __FILE__)
+Dir[File.expand_path("../{shared,support}/*.rb", __FILE__)].each{|f| require(f)}
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: ey-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Michelle Noorali & Josh Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+description: ''
+email:
+- mnoorali@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ey-logger.gemspec
+- lib/ey/logger.rb
+- lib/ey/logger/faraday.rb
+- lib/ey/logger/formatter.rb
+- lib/ey/logger/human_formatter.rb
+- lib/ey/logger/machine_formatter.rb
+- lib/ey/logger/machine_parser.rb
+- lib/ey/logger/version.rb
+- spec/faraday_spec.rb
+- spec/spec_helper.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.2
+signing_key: 
+specification_version: 4
+summary: Standardized logging helpers for EngineYard
+test_files:
+- spec/faraday_spec.rb
+- spec/spec_helper.rb
+has_rdoc: