chordate-ruby 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+.idea
+.idea/*
+/.bundle
+*.rdb
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p327@chordate-ruby --create

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Norton
+
+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.
+
+The above License is for PERSONAL USE ONLY, when used in COMMERCIAL or CORPORATE
+software release (YES EVEN FOR AN INTERNAL BOARDS AS INTENDED),
+the COMM-LICENSE applies to that and all COMMERCIAL scenarios.

data/README.md

@@ -0,0 +1 @@
+Official Ruby Gem for the Chordate Error Reporting Service.

data/chordate-ruby.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/chordate-ruby/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors     = %w(bnorton)
+  gem.email       = 'brian.nort@gmail.com'
+  gem.summary     = ''
+  gem.description = ''
+  gem.homepage    = 'http://github.com/chordate/chordate-ruby'
+  gem.license     = 'MIT'
+  gem.require_paths = %w(lib)
+
+  gem.version     = Chordate::Version::STRING
+  gem.name        = 'chordate-ruby'
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- spec/*`.split("\n")
+
+  gem.add_dependency             'typhoeus', '> 0.5.0'
+  gem.add_dependency             'celluloid'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+end

data/lib/chordate-ruby.rb

@@ -0,0 +1,13 @@
+require 'chordate-ruby/chordate'
+
+['typhoeus',
+ 'celluloid',
+ 'chordate-ruby/version',
+ 'chordate-ruby/http',
+ 'chordate-ruby/error',
+ 'chordate-ruby/runner',
+].each do |file|
+  require file
+end
+
+Celluloid.logger = nil

data/lib/chordate-ruby/chordate.rb

@@ -0,0 +1,45 @@
+require 'chordate-ruby/config'
+require 'chordate-ruby/runner/event'
+require 'chordate-ruby/error'
+
+module Chordate
+  class << self
+    def configure
+      (@config ||= Chordate::Config.new).tap do |config|
+        yield config
+      end
+    end
+
+    def config
+      @config
+    end
+
+    def run!
+      unless running?
+        (@event_runner ||= Runner::Event.new).tap do |runner|
+          runner.start
+        end
+
+        @running = true
+      end
+    end
+
+    def running?
+      !!@running
+    end
+
+    def error(*args)
+      @event_runner.async.push(
+        Chordate::Error.new(*args).as_json
+      )
+    end
+
+    private
+
+    def clear
+      @event_runner && @event_runner.terminate
+
+      @running = @event_runner = nil
+    end
+  end
+end

data/lib/chordate-ruby/config.rb

@@ -0,0 +1,43 @@
+module Chordate
+  class Config
+    def initialize
+      @config = {
+        'env' => rails(:env) || 'default',
+        'proto' => 'https://',
+        'host' => "chordate.io",
+        'server' => {
+          :root => rails(:root) || `pwd`.chomp,
+          :hostname => `hostname`.chomp,
+          :gem_version => Chordate::Version::STRING
+        }
+      }
+    end
+
+    def [](key)
+      @config[key.to_s]
+    end
+
+    def token=(token)
+      token = token.split(':')
+
+      (@config['token'] = token[1]).tap do
+        @config['base_url'] ||= "/v1/applications/#{token[0]}"
+      end
+    end
+
+    def method_missing(meth, *args)
+      case meth
+      when /=$/
+        @config[meth.to_s[0..-2]] = args.first
+      else
+        @config[meth.to_s]
+      end
+    end
+
+    private
+
+    def rails(method)
+      defined?(Rails) ? Rails.send(method).to_s : nil
+    end
+  end
+end

data/lib/chordate-ruby/error.rb

@@ -0,0 +1,30 @@
+module Chordate
+  class Error
+    def initialize(*args)
+      @ex = args.shift
+
+      @json = {
+        :env => Chordate.config.env,
+        :generated_at => Time.now,
+        :klass => @ex.class.name,
+        :message => @ex.message,
+        :backtrace => @ex.backtrace,
+        :server => Chordate.config.server
+      }
+
+      merge!(args.shift)
+    end
+
+    def merge!(other)
+      other.each do |(k, v)|
+        v.nil? ? @json.delete(k) : @json[k] = v
+      end
+
+      self
+    end
+
+    def as_json(*)
+      @json
+    end
+  end
+end

data/lib/chordate-ruby/http.rb

@@ -0,0 +1,15 @@
+module Chordate
+  class HTTP
+    class << self
+      def post(path, body = {})
+        Typhoeus.post(url_for(path), :body => body.merge(:token => Chordate.config.token))
+      end
+
+      private
+
+      def url_for(path)
+        "#{Chordate.config.proto}#{Chordate.config.host}#{Chordate.config.base_url}/#{path}.json"
+      end
+    end
+  end
+end

data/lib/chordate-ruby/runner.rb

@@ -0,0 +1 @@
+require 'chordate-ruby/runner/event'

data/lib/chordate-ruby/runner/event.rb

@@ -0,0 +1,40 @@
+require 'celluloid'
+
+module Chordate
+  module Runner
+    class Event
+      include Celluloid
+
+      attr_reader :errors
+
+      def initialize
+        @errors = []
+        @exit = false
+      end
+
+      def start
+        if errors.any?
+          HTTP.post(:events, :batch => errors)
+
+          @errors = []
+        end
+
+        return if exit?
+
+        after(5) { start }
+      end
+
+      def push(e)
+        @errors << e
+      end
+
+      def exit
+        @exit = true
+      end
+
+      def exit?
+        @exit
+      end
+    end
+  end
+end

data/lib/chordate-ruby/version.rb

@@ -0,0 +1,10 @@
+module Chordate
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/spec/lib/chordate_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe Chordate do
+  describe '.configure' do
+    it 'should yield a Config object' do
+      Chordate.configure {|c| c.class.should == Chordate::Config }
+    end
+
+    it 'should cache the object' do
+      configs = []
+      Chordate.configure {|c| configs << c }
+      Chordate.configure {|c| configs << c }
+
+      configs[0].should == configs[1]
+    end
+  end
+
+  describe '.config' do
+    before do
+      Chordate.configure {|c| c.foo = 'bar' }
+    end
+
+    it 'should be the config object' do
+      Chordate.config.class.should == Chordate::Config
+    end
+
+    it 'should have the options' do
+      Chordate.config.foo.should == 'bar'
+    end
+  end
+
+  describe '.run!' do
+    before do
+      @event_runner = mock(Chordate::Runner::Event, :start => nil, :terminate => nil)
+      Chordate::Runner::Event.stub(:new).and_return(@event_runner)
+    end
+
+    after do
+      Chordate.send(:clear)
+    end
+
+    it 'should build the runner' do
+      Chordate::Runner::Event.should_receive(:new).and_return(@event_runner)
+
+      Chordate.run!
+    end
+
+    it 'should start the runner' do
+      @event_runner.should_receive(:start)
+
+      Chordate.run!
+    end
+
+    it "should be running" do
+      Chordate.run!
+
+      Chordate.should be_running
+    end
+  end
+
+  describe '.error' do
+    let(:exception) { make_exception }
+    let(:options) { {} }
+
+    def error
+      Chordate.error(exception, options)
+    end
+
+    before do
+      @async = mock(Celluloid::ActorProxy, :push => nil)
+      @runner = mock(Chordate::Runner::Event, :start => nil, :async => @async, :terminate => nil)
+      Chordate::Runner::Event.stub(:new).and_return(@runner)
+
+      Chordate.run!
+
+      @json = mock("JSON")
+      @error = mock(Chordate::Error, :as_json => @json)
+      Chordate::Error.stub(:new).and_return(@error)
+    end
+
+    after do
+      Chordate.send(:clear)
+    end
+
+    it 'should init an error' do
+      Chordate::Error.should_receive(:new).with(exception, options).and_return(@error)
+
+      error
+    end
+
+    it 'should push the error to the runner' do
+      @async.should_receive(:push).with(@json)
+
+      error
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Chordate::Config do
+  [[:a_key, '123:abcdef']].each do |(method, value)|
+    describe "##{method}" do
+      before do
+        subject.send("#{method}=", value)
+      end
+
+      it 'should store the given value' do
+        subject[method].should == value
+      end
+
+      it "should have the value at ##{method}" do
+        subject.send(method).should == value
+      end
+    end
+  end
+
+  describe '#token=' do
+    before do
+      subject.token = '789:the-token'
+    end
+
+    it 'should have the token' do
+      subject.token.should == 'the-token'
+    end
+
+    it 'should have the id in the base url' do
+      subject.base_url.should match(/applications\/789$/)
+    end
+  end
+
+  describe 'defaults' do
+    subject { Chordate.config }
+
+    it 'should have the gem version' do
+      subject.server[:gem_version].should == Chordate::Version::STRING
+    end
+
+    it 'should have the hostname' do
+      subject.server[:hostname].should == `hostname`.chomp
+    end
+
+    it 'should have the root' do
+      subject.server[:root].should == `pwd`.chomp
+    end
+
+    it 'should have the environment' do
+      subject.env.should == 'the-environment'
+    end
+
+    it 'should have the base_url' do
+      subject.base_url.should == '/v1/applications/123'
+    end
+  end
+end

data/spec/lib/error_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Chordate::Error do
+  describe '#as_json' do
+    let(:options) { {} }
+
+    describe "for an exception" do
+      let(:exception) { make_exception }
+
+      def json
+        Chordate::Error.new(exception, options).as_json
+      end
+
+      it 'should extract the error class' do
+        json[:klass].should == 'RuntimeError'
+      end
+
+      it 'should extract the error message' do
+        json[:message].should == 'BOOM!'
+      end
+
+      it 'should extract the error backtrace' do
+        json[:backtrace].should == exception.backtrace
+      end
+
+      describe 'server' do
+        it 'should have the gem version' do
+          json[:server][:gem_version].should == Chordate::Version::STRING
+        end
+
+        it 'should have the hostname' do
+          json[:server][:hostname].should == Chordate.config.server[:hostname]
+        end
+
+        it 'should have the app root' do
+          json[:server][:root].should == Chordate.config.server[:root]
+        end
+      end
+
+      describe 'when given options' do
+        before do
+          options[:extra] = { :data => 'attr' }
+        end
+
+        it 'should have the options' do
+          json[:extra][:data].should == 'attr'
+        end
+      end
+    end
+  end
+
+  describe "merge!" do
+    let(:options) { { :key => 'value', :other => 3, :env => nil } }
+    let(:exception) { make_exception }
+
+    subject { Chordate::Error.new(exception, {}) }
+
+    def merge!
+      subject.merge!(options)
+    end
+
+    it 'should return itself' do
+      merge!.should == subject
+    end
+
+    it 'should add to the keys' do
+      merge!.as_json[:key].should == 'value'
+      merge!.as_json[:other].should == 3
+    end
+
+    it 'should remove keys with nil values' do
+      merge!.as_json.keys.should_not include(:env)
+    end
+  end
+end

data/spec/lib/http_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Chordate::HTTP do
+  describe '.post' do
+    let(:body) { { :key => 'value' } }
+
+    def post
+      Chordate::HTTP.post(:something_special, body)
+    end
+
+    before do
+      Chordate::HTTP.rspec_reset
+    end
+
+    it 'should post to the given path' do
+      Typhoeus.should_receive(:post).with('https://chordate.io/v1/applications/123/something_special.json', anything)
+
+      post
+    end
+
+    it 'should pass the given body' do
+      Typhoeus.should_receive(:post) do |_, options|
+        options[:body][:key].should  == 'value'
+      end
+
+      post
+    end
+
+    describe 'defaults' do
+      it 'should send the token' do
+        Typhoeus.should_receive(:post) do |_, options|
+          options[:body][:token].should == Chordate.config.token
+        end
+
+        post
+      end
+    end
+  end
+end

data/spec/lib/runner/event_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Chordate::Runner::Event do
+  describe '#start' do
+    def start
+      subject.exit; subject.start
+    end
+
+    describe 'when there are waiting errors' do
+      let(:errors) do
+        [
+          { :klass => 'RuntimeError' },
+          { :klass => 'OtherError' }
+        ]
+      end
+
+      before do
+        subject.push(errors.first)
+        subject.push(errors.last)
+      end
+
+      it 'should have the errors' do
+        subject.errors.should == errors
+      end
+
+      it 'should post to events' do
+        Chordate::HTTP.should_receive(:post).with(:events, anything)
+
+        start
+      end
+
+      it 'should process the errors' do
+        Chordate::HTTP.should_receive(:post).with(anything, :batch => errors)
+
+        start
+      end
+
+      it 'should clear the errors' do
+        start
+
+        subject.errors.should == []
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'rspec'
+require 'webmock'
+require 'chordate-ruby'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  config.order = 'random'
+
+  config.before :all do
+    WebMock.disable_net_connect!
+  end
+
+  config.before :each do
+    Chordate::HTTP.stub(:post)
+  end
+end
+
+module Rails
+  def self.root
+    `pwd`.chomp
+  end
+
+  def self.env
+    'the-environment'
+  end
+end
+
+Chordate.configure do |config|
+  config.token = '123:abcdef'
+end
+
+def make_exception(type = RuntimeError, message = 'BOOM!')
+  raise type.new message
+rescue => e
+  e
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: chordate-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- bnorton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: webmock
+  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: ''
+email: brian.nort@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.md
+- README.md
+- chordate-ruby.gemspec
+- lib/chordate-ruby.rb
+- lib/chordate-ruby/chordate.rb
+- lib/chordate-ruby/config.rb
+- lib/chordate-ruby/error.rb
+- lib/chordate-ruby/http.rb
+- lib/chordate-ruby/runner.rb
+- lib/chordate-ruby/runner/event.rb
+- lib/chordate-ruby/version.rb
+- spec/lib/chordate_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/error_spec.rb
+- spec/lib/http_spec.rb
+- spec/lib/runner/event_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/chordate/chordate-ruby
+licenses:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/lib/chordate_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/error_spec.rb
+- spec/lib/http_spec.rb
+- spec/lib/runner/event_spec.rb
+- spec/spec_helper.rb