urkel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 311dc5de5b7bf0ebd836ee315414a2c594c2c0df
-  data.tar.gz: 6c133eb60ef35c725f721be483547d45e0822312
+  metadata.gz: 8b08306b3d170888b2b58b76345259f58f9fba77
+  data.tar.gz: 2bc42556fcf321d81bb90da96dadf71d3923d8fd
 SHA512:
-  metadata.gz: af96d90f5c0f9fddbe6691b024cd4c4fa0b6ef71bf872d490b79e53f4b2f4eaf5f178341e43de2511c42e27ee82bf5db1954ca28d506acb273c5cb8b4eb5dd0b
-  data.tar.gz: 9020a5e613be0272290d0991ea82745e13a08527e6340452eaf9e83094cd3d88950e7f5f4ec43925074fec5663a148b0068337b04014047addcd77589ed1af54
+  metadata.gz: e884504114aacd5e5647eb48e6975fb1d117d149f09cc839831a851de7e19d7565fc170be5137196ce5deff1b4903f1cbac1910c659e03974b95daa08fb34254
+  data.tar.gz: 5164ad3fa4d5a9248fcaad3acef16ecbb7627ea01f92ff2bba7584d1e8c7520fcae038245041bba90d7d678d91c85ed5795d619b7baa86d1252b2ce3bb912ccd

data/README.md

@@ -1,6 +1,11 @@
 # Urkel
 
-TODO: Write a gem description
+![Steve Urkel](http://upload.wikimedia.org/wikipedia/en/d/da/2005_0308_urkel.jpg)
+
+Ooops... did I do that?
+
+The urkel gem is a client library that allows you to publish errors
+to an [urkel](https://github.com/mokhan/urkel-api) instance.
 
 ## Installation
 
@@ -20,11 +25,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+  # place in initializer
+  Urkel.configure do |configuration|
+    configuration.api_host = 'http://localhost:3000'
+    configuration.api_key = '02513a35-b875-40a1-a1fc-f2d2582bdcc5'
+  end
+
+  # usage
+  begin 
+    0/1
+  rescue StandardError => error
+    Urkel.oops(error)
+  end
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/urkel/fork )
+1. Fork it ( https://github.com/mokhan/urkel/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`)

data/lib/urkel.rb

@@ -1,5 +1,29 @@
 require "urkel/version"
+require 'net/http'
+require 'urkel/configuration'
+require 'urkel/connection'
 
 module Urkel
-  # Your code goes here...
+  class InvalidConfigurationError < StandardError; end
+  class InvalidAPITokenError < StandardError; end
+
+  def self.configure
+    configuration = Configuration.new
+    yield configuration
+    @connection = Connection.new(configuration)
+  end
+
+  def self.oops(error)
+    raise InvalidConfigurationError.new unless @connection
+    @connection.publish(error)
+  end
+
+  def self.oops!(error)
+    raise InvalidConfigurationError.new unless @connection
+    @connection.publish!(error)
+  end
+
+  def self.reset
+    @connection = nil
+  end
 end

data/lib/urkel/configuration.rb

@@ -0,0 +1,24 @@
+module Urkel
+  class Configuration
+    attr_accessor :api_host, :api_key
+
+    def initialize(api_host = '', api_key = '')
+      @api_host = api_host
+      @api_key = api_key
+    end
+
+    def request(request)
+      request['authorization'] = "Token token=#{api_key}"
+      http_connection.request(request)
+    end
+
+    private
+
+    def http_connection
+      uri = URI.parse(api_host)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == "https")
+      http
+    end
+  end
+end

data/lib/urkel/connection.rb

@@ -0,0 +1,42 @@
+module Urkel
+  class Connection
+    API_ENDPOINT="/api/v1/failures"
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def publish(error)
+      response = @configuration.request(request_for(error))
+      response.is_a?(Net::HTTPOK)
+    end
+
+    def publish!(error)
+      response = @configuration.request(request_for(error))
+      if response.is_a? Net::HTTPOK
+        true
+      elsif response.is_a? Net::HTTPUnauthorized
+        raise InvalidAPITokenError.new
+      else
+        false
+      end
+    end
+
+    private
+
+    def request_for(error)
+      Net::HTTP::Post.new(API_ENDPOINT).tap do |request|
+        request.set_form_data(form_payload_for(error))
+      end
+    end
+
+    def form_payload_for(error)
+      {
+        "error[message]" => error.message,
+        "error[hostname]" => Socket.gethostname,
+        "error[error_type]" => error.class.name,
+        "error[backtrace][]" => error.backtrace,
+      }
+    end
+  end
+end

data/lib/urkel/version.rb

@@ -1,3 +1,3 @@
 module Urkel
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/urkel/connection_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Urkel
+  describe Connection do
+    subject { Connection.new(configuration) }
+
+    describe "#publish" do
+      let(:hostname) { Socket.gethostname }
+      let(:error_hash) do  
+        { 
+          "error"=> 
+          { 
+            "message" => error.message, 
+            "hostname" => hostname, 
+            "error_type" => error.class.name, 
+            "backtrace" => error.backtrace
+          } 
+        } 
+      end
+      let(:error) do
+        begin
+          1/0
+        rescue => error
+          error
+        end
+      end
+
+      context "given proper credentials" do
+        let(:configuration) { Configuration.new('http://localhost:3000', '02513a35-b875-40a1-a1fc-f2d2582bdcc5') }
+
+        it 'publishes a new error' do
+          stub_request(:post, "http://localhost:3000/api/v1/failures")
+            .with(body: error_hash, headers: { 'Authorization'=>'Token token=02513a35-b875-40a1-a1fc-f2d2582bdcc5' })
+            .to_return(status: 200, body: "", headers: {})
+          expect(subject.publish(error)).to be_truthy
+          expect(subject.publish!(error)).to be_truthy
+        end
+      end
+
+      context "when invalid credentials" do
+        let(:configuration) { Configuration.new('http://localhost:3000', 'blah') }
+
+        it 'raises a meaningful error' do
+          stub_request(:post, "http://localhost:3000/api/v1/failures")
+            .with(body: error_hash, headers: { 'Authorization' => 'Token token=blah' })
+            .to_return(status: 401, body: "HTTP Token: Access denied.", headers: {})
+
+          expect(subject.publish(error)).to be_falsey
+          expect(-> { subject.publish!(error) }).to raise_error(InvalidAPITokenError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'urkel'
+require 'webmock/rspec'

data/spec/urkel_spec.rb

@@ -5,7 +5,21 @@ describe Urkel do
     expect(Urkel::VERSION).not_to be nil
   end
 
-  it 'does something useful' do
-    expect(false).to eq(true)
+  describe ".oops" do
+    let(:error) { StandardError.new("Ooops... did i do that?") }
+
+    it 'publishes a new error' do
+      stub_request(:post, "http://localhost:3000/api/v1/failures").to_return(status: 200)
+      Urkel.configure do |configuration|
+        configuration.api_host = 'http://localhost:3000'
+        configuration.api_key = '02513a35-b875-40a1-a1fc-f2d2582bdcc5'
+      end
+      expect(Urkel.oops(error)).to be_truthy
+    end
+
+    it 'raises an error when not configured' do
+      Urkel.reset
+      expect(-> { Urkel.oops(error) }).to raise_error(Urkel::InvalidConfigurationError)
+    end
   end
 end

data/urkel.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urkel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mo khan
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: A client gem for posting errors to an urkel server.
 email:
 - mo@mokhan.ca
@@ -69,7 +83,10 @@ files:
 - Rakefile
 - bin/urkel
 - lib/urkel.rb
+- lib/urkel/configuration.rb
+- lib/urkel/connection.rb
 - lib/urkel/version.rb
+- spec/lib/urkel/connection_spec.rb
 - spec/spec_helper.rb
 - spec/urkel_spec.rb
 - urkel.gemspec
@@ -98,5 +115,6 @@ signing_key:
 specification_version: 4
 summary: A client gem for posting errors to an urkel server.
 test_files:
+- spec/lib/urkel/connection_spec.rb
 - spec/spec_helper.rb
 - spec/urkel_spec.rb