limbo 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log/development.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anders Carlsson and Anders Törnqvist
+
+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,29 @@
+# Limbo
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'limbo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install limbo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = true
+  t.verbose = true
+  t.rspec_opts ||= []
+  t.rspec_opts << "-r ./spec/spec_helper"
+  t.rspec_opts << "--color"
+  t.rspec_opts << "-fd"
+end
+
+task default: :spec
+task test: :spec
+
+desc "open console (require limbo)"
+task :c do
+  system "irb -I lib -r limbo"
+end

data/lib/limbo/client.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+require "json"
+
+module Limbo
+  class Client
+    def self.post(hash)
+      new(hash).post
+    end
+
+    def valid_data?
+      @valid_data
+    end
+
+    def posted?
+      200 == response.code.to_i
+    end
+
+    def response
+      @response
+    end
+
+    def post
+      headers =  { "X-LIMBO-KEY" => Limbo.key,
+                   "content-type" => "application/json"}
+      path = '/log'
+      request = Net::HTTP::Post.new(path, headers)
+
+      uri = URI(Limbo.uri)
+      port = uri.port || 80
+      @response = Net::HTTP.start(uri.host, port) do |http|
+        http.open_timeout = 5
+        http.request(request, body)
+      end
+
+      self
+    end
+
+    private
+
+    def body
+      begin
+        JSON.generate(@body)
+      rescue JSON::GeneratorError
+        @valid_data = false
+        '{"client-error": "error generating JSON"}'
+      end
+    end
+
+    def initialize(body)
+      @body = body
+      @valid_data = true
+    end
+  end
+end

data/lib/limbo/rails/data.rb

@@ -0,0 +1,35 @@
+require 'limbo/rails/parameter_filter'
+require 'limbo/rails/request'
+
+module Limbo
+  module Rails
+    class Data
+      def initialize(hash)
+        fail ArgumentError, 'Argument must be a hash' unless hash.is_a?(Hash)
+
+        message = 'Required keys are: :params, :session, :exception, :request'
+
+        @params = hash.delete(:params) { fail ArgumentError, message }
+        @session = hash.delete(:session) { fail ArgumentError, message }
+        @exception = hash.delete(:exception) { fail ArgumentError, message }
+        request = hash.delete(:request) { fail ArgumentError, message }
+        @request = Limbo::Rails::Request.new(request)
+
+        @hash = hash
+      end
+
+      def transform
+        {
+          controller:  @params[:controller],
+          action:      @params[:action],
+          parameters:  Limbo::Rails::ParameterFilter.filter(@params),
+          url:         @request.url,
+          session:     Limbo::Rails::ParameterFilter.filter(@session.to_hash),
+          # TODO: We must filter this better.
+          # request_env: Limbo::RailsParameterFilter.filter(@request.env)
+          backtrace:    @exception.backtrace
+        }.merge(@hash)
+      end
+    end
+  end
+end

data/lib/limbo/rails/parameter_filter.rb

@@ -0,0 +1,14 @@
+module Limbo
+  module Rails
+    class ParameterFilter
+      def self.filter(hash)
+        if hash.is_a?(Hash)
+          filter = ::Rails.application.config.filter_parameters
+          ActionDispatch::Http::ParameterFilter.new(filter).filter(hash)
+        else
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/limbo/rails/request.rb

@@ -0,0 +1,13 @@
+module Limbo
+  module Rails
+    class Request
+      def initialize(request)
+        @request = request
+      end
+
+      def url
+        "#{@request.protocol}#{@request.host_with_port}#{@request.fullpath}"
+      end
+    end
+  end
+end

data/lib/limbo/version.rb

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

data/lib/limbo.rb

@@ -0,0 +1,24 @@
+require "limbo/version"
+require "limbo/rails/data"
+require "limbo/client"
+
+module Limbo
+
+  class << self
+    attr_accessor :uri, :key
+
+    def configure
+      yield self
+    end
+
+    def rails_post(hash)
+      transformed_hash = Rails::Data.new(hash).transform
+      post(transformed_hash)
+    end
+
+    def post(hash)
+      Client.post(hash)
+    end
+  end
+end
+

data/limbo.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/limbo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Anders Carlsson and Anders Törnqvist"]
+  gem.email         = ["dev+ankor+unders@elabs.se"]
+  gem.description   = %q{Limbo exception client.}
+  gem.summary       = %q{Limbo client post exception to the Limbo exception service.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "limbo"
+  gem.require_paths = ["lib"]
+  gem.version       = Limbo::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "fakeweb"
+  gem.add_development_dependency "rails"
+end

data/spec/cassettes/limbo_client_post.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://limbo-listener-staging.herokuapp.com/log
+    body:
+      encoding: UTF-8
+      string: ! '{"data":"info"}'
+    headers:
+      x-limbo-key:
+      - test-key
+      content-type:
+      - application/json
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/html;charset=utf-8
+      server:
+      - thin 1.3.1 codename Triple Espresso
+      x-frame-options:
+      - sameorigin
+      x-xss-protection:
+      - 1; mode=block
+      content-length:
+      - '0'
+      connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: '1.1'
+  recorded_at: Fri, 29 Jun 2012 15:17:12 GMT
+recorded_with: VCR 2.2.2

data/spec/cassettes/limbo_client_post_invalid_uri.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://example.com/log
+    body:
+      encoding: UTF-8
+      string: ! '{"data":"info"}'
+    headers:
+      x-limbo-key:
+      - test-key
+      content-type:
+      - application/json
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 302
+      message: Found
+    headers:
+      location:
+      - http://www.iana.org/domains/example/
+      server:
+      - BigIP
+      connection:
+      - Keep-Alive
+      content-length:
+      - '0'
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: '1.0'
+  recorded_at: Fri, 29 Jun 2012 15:17:12 GMT
+recorded_with: VCR 2.2.2

data/spec/cassettes/limbo_post.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://limbo-listener-staging.herokuapp.com/log
+    body:
+      encoding: UTF-8
+      string: ! '{"a":"b"}'
+    headers:
+      x-limbo-key:
+      - test-key
+      content-type:
+      - application/json
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/html;charset=utf-8
+      server:
+      - thin 1.3.1 codename Triple Espresso
+      x-frame-options:
+      - sameorigin
+      x-xss-protection:
+      - 1; mode=block
+      content-length:
+      - '0'
+      connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: '1.1'
+  recorded_at: Fri, 29 Jun 2012 15:17:11 GMT
+recorded_with: VCR 2.2.2

data/spec/cassettes/limbo_rails_post.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://limbo-listener-staging.herokuapp.com/log
+    body:
+      encoding: UTF-8
+      string: ! '{"a":"b"}'
+    headers:
+      x-limbo-key:
+      - test-key
+      content-type:
+      - application/json
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/html;charset=utf-8
+      server:
+      - thin 1.3.1 codename Triple Espresso
+      x-frame-options:
+      - sameorigin
+      x-xss-protection:
+      - 1; mode=block
+      content-length:
+      - '0'
+      connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: '1.1'
+  recorded_at: Fri, 29 Jun 2012 15:17:12 GMT
+recorded_with: VCR 2.2.2

data/spec/limbo/client_spec.rb

@@ -0,0 +1,47 @@
+describe Limbo::Client do
+  use_vcr_cassette 'limbo.client.post'
+
+  before do
+    Limbo.configure do |config|
+      config.key = "test-key"
+      config.uri = "http://limbo-listener-staging.herokuapp.com"
+    end
+  end
+
+  describe ".post" do
+    it "returns a client instance" do
+      Limbo::Client.post(data: "info").should be_an_instance_of(Limbo::Client)
+    end
+  end
+
+  describe "#valid_data?" do
+
+    context "valid data" do
+      specify { Limbo::Client.post(data: "info").should be_valid_data }
+    end
+
+    context "invalid data" do
+      use_vcr_cassette 'limbo.client.post.invalid_data'
+
+      specify { Limbo::Client.post("info").should_not be_valid_data }
+    end
+  end
+
+  describe "#posted?" do
+    context "valid uri" do
+      specify { Limbo::Client.post(data: "info").should be_posted }
+    end
+
+    context "invalid uri" do
+      use_vcr_cassette 'limbo.client.post.invalid_uri'
+
+      before do
+        Limbo.configure do |config|
+          config.uri = "http://example.com"
+        end
+      end
+
+      specify { Limbo::Client.post(data: "info").should_not be_posted }
+    end
+  end
+end

data/spec/limbo/rails/data_spec.rb

@@ -0,0 +1,68 @@
+describe Limbo::Rails::Data do
+  describe ".new" do
+    context "non-hash argument" do
+      it "raises ArgumentError" do
+        expect { Limbo::Rails::Data.new(nil) }.to raise_error ArgumentError
+      end
+    end
+
+    context "missing required key" do
+      it "raises ArgumentError" do
+        hash = { params: {}, session: {}, exception: {} }
+
+        expect { Limbo::Rails::Data.new(hash) }.to raise_error ArgumentError
+      end
+    end
+
+    context "valid hash argument" do
+      it "returns an instance" do
+        hash = { params: {}, session: {}, exception: {}, request: {} }
+
+        rails_data = Limbo::Rails::Data.new(hash)
+        rails_data.should be_instance_of(Limbo::Rails::Data)
+      end
+    end
+  end
+
+  describe "#transform" do
+    let(:exception) { double("exception") }
+    let(:hash) do
+      {
+        params:     { controller: "c", action: "a", password: "pass"},
+        session:    { user_id: "2"},
+        exception:  exception,
+        request:    request,
+        custom:     "I am added by the user"
+      }
+    end
+    before { exception.should_receive(:backtrace).exactly(1) { "backtrace" } }
+
+    it "returns a transformed hash" do
+      transformed_hash = Limbo::Rails::Data.new(hash).transform
+      transformed_hash[:controller].should eq("c")
+      transformed_hash[:action].should eq("a")
+      transformed_hash[:parameters].should eq({ controller: "c",
+                                                action: "a",
+                                                password: "pass"})
+      transformed_hash[:url].should eq("http://example.com/blog")
+      transformed_hash[:session].should eq({user_id: "2"})
+      transformed_hash[:backtrace].should eq("backtrace")
+    end
+
+    it "applies filter on some keys" do
+      Rails.application.config.filter_parameters = [:password, :user_id]
+
+      transformed_hash = Limbo::Rails::Data.new(hash).transform
+      transformed_hash[:parameters].should eq({ controller: "c",
+                                                action: "a",
+                                                password: "[FILTERED]" })
+      transformed_hash[:session].should eq({ user_id: "[FILTERED]" })
+    end
+
+    it "return parameters added by user" do
+      transformed_hash = Limbo::Rails::Data.new(hash).transform
+      transformed_hash[:custom].should eq("I am added by the user")
+    end
+
+  end
+end

data/spec/limbo/rails/parameter_filter_spec.rb

@@ -0,0 +1,24 @@
+describe Limbo::Rails::ParameterFilter do
+  before do
+    Rails.application.config.filter_parameters = [:password, :secret]
+  end
+
+  describe ".filter" do
+    context "is a hash" do
+      it "filters specified parameters" do
+        hash = { password: "secret", other: "visible", secret: "d" }
+        filtered_hash = Limbo::Rails::ParameterFilter.filter(hash)
+        filtered_hash[:password].should == "[FILTERED]"
+        filtered_hash[:secret].should == "[FILTERED]"
+        filtered_hash[:other].should == "visible"
+      end
+    end
+
+    context "not a hash" do
+      it "returns the object" do
+        Limbo::Rails::ParameterFilter.filter("test").should == "test"
+      end
+    end
+  end
+
+end

data/spec/limbo/rails/request_spec.rb

@@ -0,0 +1,17 @@
+describe Limbo::Rails::Request do
+  describe "#url" do
+    context "URL with a standard port" do
+      it "returns a formatted URL without port" do
+        rails_request = Limbo::Rails::Request.new(request(port: 80))
+        rails_request.url.should == "http://example.com/blog"
+      end
+    end
+
+    context "URL with non-standard port" do
+      it "returns a formatted URL with the port included" do
+        rails_request = Limbo::Rails::Request.new(request(port: 1337))
+        rails_request.url.should == "http://example.com:1337/blog"
+      end
+    end
+  end
+end

data/spec/limbo_spec.rb

@@ -0,0 +1,35 @@
+describe Limbo do
+  before do
+    Limbo.configure do |config|
+      config.key = "test-key"
+      config.uri = "http://limbo-listener-staging.herokuapp.com"
+    end
+  end
+
+  describe ".post" do
+    use_vcr_cassette 'limbo.post'
+
+    it "returns a valid Client object" do
+      client = Limbo.post(a: "b")
+      client.should be_valid_data
+      client.should be_posted
+    end
+  end
+
+  describe ".rails_post" do
+    use_vcr_cassette 'limbo.rails_post'
+
+    before do
+      rails_data = double("rails_data")
+      rails_data.should_receive(:transform).and_return({ a: "b" })
+      Limbo::Rails::Data.stub(:new).and_return(rails_data)
+    end
+
+    it "returns a valid Client object" do
+      client = Limbo.rails_post(a: "b")
+      client.should be_valid_data
+      client.should be_posted
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'limbo'
+require 'rails/all'
+require 'vcr'
+
+module Dummy
+  class Application < Rails::Application
+  end
+end
+
+Dummy::Application.configure do
+  config.active_support.deprecation = :log
+end
+
+Dummy::Application.initialize!
+
+RSpec.configure do |config|
+  config.fail_fast = true
+  config.extend VCR::RSpec::Macros
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/cassettes'
+  config.hook_into :fakeweb
+end
+
+def request(options = {})
+  port = options.fetch(:port) { 80 }
+  env = {
+    'HTTP_HOST' => "example.com:#{port}",
+    'rack.url_scheme' => 'http',
+    'SCRIPT_NAME' => '',
+    'PATH_INFO' => '/blog'
+  }
+  ActionDispatch::Request.new(env)
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: limbo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Anders Carlsson and Anders Törnqvist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Limbo exception client.
+email:
+- dev+ankor+unders@elabs.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/limbo.rb
+- lib/limbo/client.rb
+- lib/limbo/rails/data.rb
+- lib/limbo/rails/parameter_filter.rb
+- lib/limbo/rails/request.rb
+- lib/limbo/version.rb
+- limbo.gemspec
+- spec/cassettes/limbo_client_post.yml
+- spec/cassettes/limbo_client_post_invalid_uri.yml
+- spec/cassettes/limbo_post.yml
+- spec/cassettes/limbo_rails_post.yml
+- spec/limbo/client_spec.rb
+- spec/limbo/rails/data_spec.rb
+- spec/limbo/rails/parameter_filter_spec.rb
+- spec/limbo/rails/request_spec.rb
+- spec/limbo_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Limbo client post exception to the Limbo exception service.
+test_files:
+- spec/cassettes/limbo_client_post.yml
+- spec/cassettes/limbo_client_post_invalid_uri.yml
+- spec/cassettes/limbo_post.yml
+- spec/cassettes/limbo_rails_post.yml
+- spec/limbo/client_spec.rb
+- spec/limbo/rails/data_spec.rb
+- spec/limbo/rails/parameter_filter_spec.rb
+- spec/limbo/rails/request_spec.rb
+- spec/limbo_spec.rb
+- spec/spec_helper.rb