log_spy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3109d5c0b67ca1205a4c268d3d00a2c14551823
+  data.tar.gz: 1ee795e98a6c2b25fa610fe74b7e6538127aa28b
+SHA512:
+  metadata.gz: 739791004933ab3e1079d18a44813bb4765e0a517ef20f36243f2612bf69bef1a175fd0af392f6e953bf95192d1080f3ae6488433ced5829619d687d9469b2b2
+  data.tar.gz: 377744523bcb6bc2268ca28427836d3cf03eea916f39545bc685bdfe1d51fd71eab5f7c69007aaa9556c7ed652b890acede8427dd0aad0ddbad9c2d8556da4ce

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-I ./spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in log_spy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yang-Hsing Lin
+
+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,82 @@
+# LogSpy
+
+LogSpy is a Rack middleware sending request log to [Amazon SQS](http://aws.amazon.com/sqs/).
+After each request, `log_spy` opens a new thread and sends the request log payload as a `json` string onto [AWS SQS](http://aws.amazon.com/sqs/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'log_spy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log_spy
+
+## Usage
+
+require and use the middleware:
+
+- bare rack:
+
+```ruby
+require 'log_spy'
+use LogSpy::Spy, 'aws-sqs-url'
+```
+
+- rails:
+```ruby
+# application.rb
+config.middleware.use LogSpy::Spy, 'aws-sqs-url', :reigon => 'ap-southeast-1'
+```
+
+## API Documents:
+
+### to `use` the middleware:
+- usage: `use LogSpy::Spy, <aws-sqs-url>[, <options>]`
+- params:
+  - `aws-sqs-url`(required): the [Queue URL](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) of SQS, which identifies the queue.
+  - `options`(optional): if given, `log_spy` would pass it to initialize [`AWS::SQS`](http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SQS.html)
+
+### the payload format sends to AWS SQS:
+
+```json
+{
+  "path": "/the/request/path",
+  "status": 200,
+  "execution_time": 145.3, // in ms
+  "request": {
+    "content_type": "application/json",
+    "request_method": "post",
+    "ip": "123.1.1.1",
+    "query_string": "query-key=query-val&hello=world",
+    "body": "body-key=body-val"
+  },
+
+  // if got exception
+  "error": {
+    "message": "the exception message",
+    "backtrace": [ "exception back trace" ]
+  }
+}
+```
+
+- `error`: `error` would not be included in the payload if no exception was raised
+- `request.body`: if the request `Content-Type` is of `multipart`, the body would be an empty string
+
+## Testing:
+`$ bundle install`
+`$ bundle exec rspec spec/`
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/log_spy/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/lib/log_spy/payload.rb

@@ -0,0 +1,31 @@
+require 'json'
+class LogSpy::Payload
+  def initialize req, res, error = nil
+    @req = req
+    @res = res
+    @error = error
+  end
+
+  def to_json
+    req_body = @req.content_type =~ /multipart/ ? '' : @req.body.read
+
+    hash = {
+      :path => @req.path,
+      :status => @res.status,
+      :execution_time => @res.duration,
+      :request => {
+        :content_type => @req.content_type,
+        :request_method => @req.request_method,
+        :ip => @req.ip,
+        :query_string => @req.query_string,
+        :body => req_body
+      }
+    }
+
+    if @error
+      hash[:error] = { :message => @error.message, :backtrace => @error.backtrace }
+    end
+
+    hash.to_json
+  end
+end

data/lib/log_spy/spy.rb

@@ -0,0 +1,43 @@
+require 'aws-sdk'
+require 'rack'
+require 'log_spy/payload'
+require 'json'
+require 'ostruct'
+
+class LogSpy::Spy
+  attr_reader :sqs_thread
+  def initialize(app, sqs_url, options = {})
+    @app = app
+    @sqs_url = sqs_url
+    @options = options
+  end
+
+  def call env
+    @start_time = Time.now.to_f
+    @req = Rack::Request.new env
+    @status, @header, @body = @app.call(env)
+
+    @sqs_thread = send_sqs_async
+    [ @status, @header, @body ]
+  rescue Exception => err
+    @sqs_thread = send_sqs_async(err)
+
+    raise err
+  end
+
+  def send_sqs_async(err = nil)
+    @sqs_thread = Thread.new do
+      status = err ? 500 : @status
+      sqs = AWS::SQS.new(@options)
+      duration = ( (Time.now.to_f - @start_time) * 1000 ).round(0)
+      res = OpenStruct.new({
+        :duration => duration,
+        :status => status
+      })
+      payload = ::LogSpy::Payload.new(@req, res, err)
+
+      sqs.queues[@sqs_url].send_message(payload.to_json)
+    end
+  end
+  private :send_sqs_async
+end

data/lib/log_spy/version.rb

@@ -0,0 +1,3 @@
+module LogSpy
+  VERSION = "0.0.1"
+end

data/lib/log_spy.rb

@@ -0,0 +1,6 @@
+require "log_spy/version"
+require "log_spy/spy"
+
+module LogSpy
+  # Your code goes here...
+end

data/log_spy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_spy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log_spy"
+  spec.version       = LogSpy::VERSION
+  spec.authors       = ["Yang-Hsing Lin"]
+  spec.email         = ["yanghsing.lin@gmail.com"]
+  spec.summary       = %q{ send rack application log to Amazon SQS }
+  spec.description   = %q{ LogSpy is a rack middleware sending request log to Amazon SQS }
+  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 "aws-sdk"
+  spec.add_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/payload_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'log_spy/payload'
+
+describe LogSpy::Payload do
+  let(:path) { '/the/request/path' }
+  let(:request_method) { 'post' }
+  let(:ip) { '123.1.1.1' }
+  let(:query_string) { 'query-key=query-val' }
+  let(:status) { 200 }
+  let(:duration) { 335 }
+  let(:body) { double(:body, :read => 'the-raw-body') }
+  let(:content_type) { 'application/json' }
+
+  let(:request) do 
+    double(:request,
+           :path => path,
+           :content_type => content_type,
+           :request_method => request_method,
+           :ip => ip,
+           :query_string => query_string,
+           :body => body)
+  end
+
+  let(:response) do
+    double(:response,
+           :status => status,
+           :duration => duration)
+  end
+
+  let(:error) { Exception.new 'the-message' }
+
+  describe '::new(request, response[, error = nil])' do
+    it 'takes a request, response and an optional error to init' do
+      payload = LogSpy::Payload.new request, response
+      payload_with_err = LogSpy::Payload.new(request, response, error)
+    end
+  end
+
+  describe '#to_json' do
+    let(:expected_hash) do
+      {
+        :path => path,
+        :status => status,
+        :execution_time => duration,
+        :request => {
+          :content_type => content_type,
+          :request_method => request_method,
+          :ip => ip,
+          :query_string => query_string,
+          :body => body.read
+        }
+      }
+    end
+
+    context "if no error" do
+      let(:payload) { LogSpy::Payload.new request, response }
+      it 'returns correct format' do
+        expect(payload.to_json).to eq(expected_hash.to_json)
+      end
+
+      it 'returns no body if request content_type is multipart' do
+        allow(request).to receive_messages(:content_type => 'multipart/form-data')
+        expected_hash[:request][:content_type] = 'multipart/form-data'
+        expected_hash[:request][:body] = ''
+        expect(payload.to_json).to eq(expected_hash.to_json) 
+      end
+    end
+
+    context "if with error" do
+      let(:payload) { LogSpy::Payload.new request, response, error }
+      it 'returns error with message and backtrace' do
+        expected_hash[:error] = {
+          :message => error.message,
+          :backtrace => error.backtrace
+        }
+
+        expect(payload.to_json).to eq(expected_hash.to_json) 
+      end
+      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

data/spec/spy_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'log_spy/spy'
+
+describe LogSpy::Spy do
+  let(:app) { double(:app) }
+  let(:sqs_url) { 'the-sqs-url' }
+  let(:options) { { :reigon => 'ap-southeast-1' } }
+
+  describe '#new(app, sqs_url [, options = {}])' do
+    it 'takes an app, an sqs_url, and an optional options to init' do
+      middleware = LogSpy::Spy.new(app, sqs_url)
+      middleware_w_options = LogSpy::Spy.new(app, sqs_url, options)
+    end
+  end
+
+  describe 'call' do
+    let(:sqs) { double(:sqs, :queues => double(:[] => queue)) }
+    let(:queue) { double(:queue, :send_message => true) }
+    let(:call_result) { [200, { 'Content-Type' => 'application/json' }, [ 'body' ]] }
+    let(:env) { {} }
+
+    let(:request) { double(:request) }
+    let(:payload) { double(:payload, :to_json => {'key' => 'val'}.to_json) }
+
+    let(:middleware) { LogSpy::Spy.new(app, sqs_url, options) }
+    let(:duration) { 20.12345 }
+    let(:now) { Time.now }
+    let(:three_sec_later) { now + duration }
+
+    before :each do
+      allow(AWS::SQS).to receive_messages(:new => sqs)
+      allow(app).to receive_messages(:call => call_result)
+      allow(Rack::Request).to receive_messages(:new => request)
+      allow(LogSpy::Payload).to receive_messages(:new => payload)
+      allow(Time).to receive(:now).and_return(now, three_sec_later)
+    end
+
+    it 'config sqs with options' do
+      expect(AWS::SQS).to receive(:new).with(options)
+
+      middleware.call env
+      middleware.sqs_thread.join
+    end
+
+    it 'sends payload json json to sqs' do
+      expect(Rack::Request).to receive(:new).with(env)
+
+      expect(queue).to receive(:send_message).with(payload.to_json)
+      middleware.call env
+      middleware.sqs_thread.join
+    end
+
+    it 'builds payload with request, status, request_time' do
+      expect(LogSpy::Payload).to receive(:new) do |req, res|
+        expect(req).to be(request)
+        expect(res.status).to eq(200)
+        expect(res.duration).to eq((duration * 1000).round(0))
+      end
+
+      middleware.call env
+      middleware.sqs_thread.join
+    end
+
+    it 'returns original result' do
+      expect(middleware.call(env)).to eq(call_result)
+      middleware.sqs_thread.join
+    end
+
+    context "if `app.call raises`" do
+      let(:error) { Exception.new }
+
+      before :each do
+        allow(app).to receive(:call).and_raise(error)
+      end
+      
+      it 'build payload with error' do
+        expect(LogSpy::Payload).to receive(:new) do |req, res, err|
+          expect(req).to be(request)
+          expect(res.status).to eq(500)
+          expect(res.duration).to eq(( duration * 1000 ).round(0))
+          expect(err).to eq(error)
+        end
+
+        begin
+          middleware.call(env)
+        rescue Exception => e
+        end
+
+        middleware.sqs_thread.join
+      end
+
+      it 'forward to error' do
+        expect {
+          middleware.call(env)
+        }.to raise_error(error)
+
+        middleware.sqs_thread.join
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: log_spy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yang-Hsing Lin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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: rack
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ' LogSpy is a rack middleware sending request log to Amazon SQS '
+email:
+- yanghsing.lin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/log_spy.rb
+- lib/log_spy/payload.rb
+- lib/log_spy/spy.rb
+- lib/log_spy/version.rb
+- log_spy.gemspec
+- spec/payload_spec.rb
+- spec/spec_helper.rb
+- spec/spy_spec.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: send rack application log to Amazon SQS
+test_files:
+- spec/payload_spec.rb
+- spec/spec_helper.rb
+- spec/spy_spec.rb