log_spy 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2dc87b4c4a64a5e9cca30f4274c31b5410b7658
-  data.tar.gz: dd24f18962e75a3efc5c029a9445593e3d7b693e
+  metadata.gz: 327b18418456c929af2ee0f996f04c6477d04ddf
+  data.tar.gz: 54d57335489f6098d68f06538f262e1bc62591b3
 SHA512:
-  metadata.gz: 4fffa272cda3094c4c41763040ca61adf3b117628b4cb7be8f399046771a8869bc7e7de0ad8732c6a2f57a52a84d09e64210fec7dce8d9fa02fd163705deb83d
-  data.tar.gz: fc708c4642da96e831e8bf4f09ea661e5b5b4d20b25d8c896144aab8031a99e0bb6ddaf4a674760b280b0bd8b84ba886312b92d7051bd787cd8375bb1a6ea2fa
+  metadata.gz: 8d4589ceef28e7659e8901004c532e9c3a2272305799c305c473904a20a022ada571a96c93c0d517df0027372b85ad3416455427c2fd81756e880506530bc5f9
+  data.tar.gz: f697729d31e5bcba32c221a3fa07a18fe212129330b1cd95f293cbfdb565ae69c2b84f055c2ee58b3b79f9b732e3450a0e4253bb296991207070d5e21c063d15

data/{History.md → CHANGELOG.md}

@@ -1,5 +1,18 @@
 
-0.0.4 / 2014-09-23 
+1.0.0 / 2016-02-09
+==================
+
+[Changed]
+ * upgrade `aws-sdk` to 2.x.x and restrict its dependency version
+
+[Added]
+ * add `cookies` to payload
+
+[Fixed]
+ * `rewind` body before read in payload
+
+
+0.0.4 / 2014-09-23
 ==================
  * add `controller_action` to payload, if `env['action_dispatch.request.parameter']` exists
 

data/README.md

@@ -1,8 +1,16 @@
 # LogSpy
 
-LogSpy is a Rack middleware sending request log to [Amazon SQS](http://aws.amazon.com/sqs/).
+LogSpy is a Rack middleware sending request log to [Amazon SQS](http://aws.amazon.com/sqs/) on each request.
+
+## How it works
+
 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/).
 
+## Why not use Papertrail or other log collector?
+
+Logspy does not intend to replace the log collectors like Papertrail or something similar.
+The purpose of Logspy is to record each request and its params so that we can easily analyse even replay requests within a certain period.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,17 +29,19 @@ Or install it yourself as:
 
 require and use the middleware:
 
-- bare rack:
+- Bare Rack:
 
 ```ruby
 require 'log_spy'
 use LogSpy::Spy, 'aws-sqs-url'
 ```
 
-- rails:
+- Rails:
 ```ruby
-# application.rb
-config.middleware.use LogSpy::Spy, 'aws-sqs-url', :reigon => 'ap-southeast-1'
+# config/application.rb
+config.middleware.use LogSpy::Spy, 'aws-sqs-url', :reigon => 'ap-southeast-1',
+                                                  :access_key_id => 'the-key-id',
+                                                  :secret_access_key => 'the-secret'
 ```
 
 ## API Documents:
@@ -40,21 +50,25 @@ config.middleware.use LogSpy::Spy, 'aws-sqs-url', :reigon => 'ap-southeast-1'
 - 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)
+  - `options`(optional): if given, `log_spy` would pass it to initialize [`Aws::SQS`](http://docs.aws.amazon.com/sdkforruby/api/Aws/SQS.html)
 
 ### the payload format sends to AWS SQS:
 
-```json
+```javascript
 {
   "path": "/the/request/path",
   "status": 200,
   "execution_time": 145.3, // in ms
+  "controller_action": "users#show", // if env['action_dispatch.request.parameters'] exists
   "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"
+    "body": "body-key=body-val",
+    "cookies": {
+      "cookie_key": "cookie_val"
+    }
   },
 
   // if got exception

data/lib/log_spy/payload.rb

@@ -18,25 +18,37 @@ class LogSpy::Payload
         :request_method => @req.request_method,
         :ip => @req.ip,
         :query_string => @req.query_string,
+        :cookies => @req.cookies,
         :body => request_body
       }
     }
 
+    append_error_if_exists(hash)
+    append_controller_action_if_exists(hash)
+
+    hash.to_json
+  end
+
+  def append_error_if_exists hash
     if @error
       hash[:error] = { :message => @error.message, :backtrace => @error.backtrace }
     end
+  end
+  private :append_error_if_exists
 
+  def append_controller_action_if_exists hash
     if controller_params = @req.env['action_dispatch.request.parameters']
       hash[:controller_action] = "#{controller_params['controller']}##{controller_params['action']}"
     end
-
-    hash.to_json
   end
+  private :append_controller_action_if_exists
 
   def request_body
     return '' if @req.content_type =~ /multipart/
+    @req.body.rewind
     @req.body.read
-  rescue Exception => e
+  rescue IOError
     @req.env['RAW_POST_BODY']
   end
+  private :request_body
 end

data/lib/log_spy/spy.rb

@@ -15,8 +15,8 @@ class LogSpy::Spy
   def call env
     @env = env
     @start_time = Time.now.to_f
-    @status, header, body = @app.call(env)
 
+    @status, header, body = @app.call(env)
     @sqs_thread = send_sqs_async
 
     [ @status, header, body ]
@@ -33,7 +33,7 @@ class LogSpy::Spy
   def send_sqs_async(err = nil)
     @sqs_thread = Thread.new do
       status = err ? 500 : @status
-      sqs = AWS::SQS.new(@options)
+      sqs_client = Aws::SQS::Client.new(@options)
       duration = ( (Time.now.to_f - @start_time) * 1000 ).round(0)
       res = OpenStruct.new({
         :duration => duration,
@@ -41,7 +41,10 @@ class LogSpy::Spy
       })
       payload = ::LogSpy::Payload.new(req, res, @start_time.to_i, err)
 
-      sqs.queues[@sqs_url].send_message(payload.to_json)
+      sqs_client.send_message({
+        queue_url: @sqs_url,
+        message_body: payload.to_json
+      })
     end
   end
   private :send_sqs_async

data/lib/log_spy/version.rb

@@ -1,3 +1,3 @@
 module LogSpy
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/log_spy.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "aws-sdk"
+  spec.add_dependency "aws-sdk", [">= 2.2.14", "< 3.0"]
   spec.add_dependency "rack"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/spec/payload_spec.rb

@@ -11,7 +11,11 @@ describe LogSpy::Payload do
   let(:body) { double(:body) }
   let(:content_type) { 'application/json' }
 
-  let(:request) do 
+  before :each do
+    allow(body).to receive_messages(:rewind => body)
+  end
+
+  let(:request) do
     double(:request,
            :path => path,
            :content_type => content_type,
@@ -19,6 +23,7 @@ describe LogSpy::Payload do
            :ip => ip,
            :query_string => query_string,
            :env => {},
+           :cookies => { :key => 'val' },
            :body => body)
   end
 
@@ -33,8 +38,8 @@ describe LogSpy::Payload do
 
   describe '::new(request, response, begin_at[, error = nil])' do
     it 'takes a request, response and an optional error to init' do
-      payload = LogSpy::Payload.new(request, response, begin_at) 
-      payload_with_err = LogSpy::Payload.new(request, response, begin_at, error)
+      LogSpy::Payload.new(request, response, begin_at)
+      LogSpy::Payload.new(request, response, begin_at, error)
     end
   end
 
@@ -49,7 +54,8 @@ describe LogSpy::Payload do
           :content_type => content_type,
           :request_method => request_method,
           :ip => ip,
-          :query_string => query_string
+          :query_string => query_string,
+          :cookies => request.cookies
         }
       }
     end
@@ -63,27 +69,28 @@ describe LogSpy::Payload 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) 
+        expect(payload.to_json).to eq(expected_hash.to_json)
       end
     end
 
     shared_context "if_body_readable" do
       before(:each) do
-        allow(body).to receive_messages(:read => 'the-raw-body') 
+        allow(body).to receive_messages(:rewind => 0)
+        allow(body).to receive_messages(:read => 'the-raw-body')
         expected_hash[:request][:body] = 'the-raw-body'
       end
     end
 
     shared_context 'if_body_unreadable' do
       before(:each) do
-        allow(body).to receive(:read).and_raise(Exception, 'closed stream')
+        allow(body).to receive(:rewind).and_raise(IOError, 'closed stream')
         allow(request).to receive_messages(:env => { 'RAW_POST_BODY' => 'raw-post-body' })
         expected_hash[:request][:body] = 'raw-post-body'
       end
 
     end
 
-    shared_examples "if env['action_dispatch.request.parameters']" do
+    shared_examples "ensure_action_dispatch_controller_params" do
       before :each do
         controller_params = { 'controller' => 'users', 'action' => 'show' }
         env = { 'action_dispatch.request.parameters' => controller_params }
@@ -92,7 +99,6 @@ describe LogSpy::Payload do
 
       it 'returns hash with `controller_action`' do
         expected_hash[:controller_action] = "users#show"
-        expected_hash[:request][:body] = nil
 
         expect(payload.to_json).to eq(expected_hash.to_json)
       end
@@ -102,7 +108,8 @@ describe LogSpy::Payload do
       let(:payload) { LogSpy::Payload.new request, response, begin_at }
 
       context "if env['action_dispatch.request.parameters']" do
-        include_examples "if env['action_dispatch.request.parameters']"
+        include_context "if_body_readable"
+        include_examples "ensure_action_dispatch_controller_params"
       end
 
       context "if body can be read" do
@@ -127,7 +134,8 @@ describe LogSpy::Payload do
       end
 
       context "if env['action_dispatch.request.parameters']" do
-        include_examples "if env['action_dispatch.request.parameters']"
+        include_context "if_body_readable"
+        include_examples "ensure_action_dispatch_controller_params"
       end
 
       context "if request body can be read" do

data/spec/spy_spec.rb

@@ -8,14 +8,15 @@ describe LogSpy::Spy do
 
   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)
+      LogSpy::Spy.new(app, sqs_url)
+      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) }
+  describe '#call' do
+    let(:sqs) { double(:sqs, :send_message => true) }
+    # 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) { {} }
 
@@ -28,29 +29,22 @@ describe LogSpy::Spy do
     let(:three_sec_later) { now + duration }
 
     before :each do
-      allow(AWS::SQS).to receive_messages(:new => sqs)
+      allow(Aws::SQS::Client).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)
+    it 'creates a sqs client with options' do
+      expect(Aws::SQS::Client).to receive(:new).with(options)
 
       middleware.call env
       middleware.sqs_thread.join
     end
 
-    it 'sends payload json json to sqs' do
+    it 'creates payload with request, status, request_time' 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, begin_at|
         expect(req).to be(request)
         expect(res.status).to eq(200)
@@ -62,6 +56,16 @@ describe LogSpy::Spy do
       middleware.sqs_thread.join
     end
 
+    it 'sends payload json to sqs with queue url' do
+      expect(sqs).to receive(:send_message).with({
+        queue_url: sqs_url,
+        message_body: payload.to_json
+      })
+      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
@@ -73,7 +77,7 @@ describe LogSpy::Spy do
       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, begin_at, err|
           expect(req).to be(request)
@@ -85,7 +89,7 @@ describe LogSpy::Spy do
 
         begin
           middleware.call(env)
-        rescue Exception => e
+        rescue Exception
         end
 
         middleware.sqs_thread.join
@@ -100,6 +104,6 @@ describe LogSpy::Spy do
       end
 
     end
-    
+
   end
 end

metadata

@@ -1,96 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: log_spy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Yang-Hsing Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2016-02-09 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'
+        version: 2.2.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.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 '
+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
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
 - Gemfile
-- History.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -112,17 +118,17 @@ 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
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: send rack application log to Amazon SQS