arthur 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51eb37332f248a9befa3f6b8038d7609dd5ff246
+  data.tar.gz: c71e6d4356acb00c7120432c2083b11d3b67ed32
+SHA512:
+  metadata.gz: ae68a8046225cefc7dd01f0d1292cb5a40955d25826e732165ec216cd747aad18968378d451d9b35f4d6ae30ea2c30cadbae38ac58ef13df2d064c02dc03d3f8
+  data.tar.gz: 801afaa2aefc825ab683e7e0346ac24d443d7784f704d5eb0f07ca5f130371ba527c8fd0a26fe5999ac9e68676a2bbaedc5d94fafe83f6d349c23eedd9ca4370

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.2

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+Contributing
+============
+
+If you would like to contribute code to Arthur you can do so through GitHub by
+forking the repository and sending a pull request.
+
+When submitting code, please make every effort to follow existing conventions
+and style in order to keep the code as readable as possible. Please also make
+sure tests pass by running `rake`.
+
+Before your code can be accepted into the project you must also sign the
+[Individual Contributor License Agreement (CLA)][1]. We're sorry.
+
+ [1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://www.rubygems.org'
+
+gem 'rest-client'
+gem 'rake'
+
+group :test do
+  gem 'webmock'
+  gem 'rspec'
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    mime-types (2.3)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    safe_yaml (1.0.3)
+    slop (3.5.0)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  rest-client
+  rspec
+  webmock

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Square, Inc.
+
+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,22 @@
+Arthur eats bugs! Specifically, it consumes Bugsnag's API to allow you to view project details, errors,
+error details etc.
+
+####Initial setup
+	Arthur::Api.configure(base_url, auth_token)
+
+####Get project details
+	Arthur::Project.fetch(project_id)
+
+####Get project errors
+	Arthur::Project.fetch(project_id).errors
+
+####Get error details
+	Arthur::Error.fetch(error_id)
+
+####Get error count in environment
+	Arthur::Error.fetch(error_id).count_in_environment(env)
+
+####Run tests
+    rake
+
+Arthur is released under the MIT License (http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/arthur.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "arthur"
+  spec.version       = "1.0.0"
+  spec.authors       = ['Bella Norvig', 'Danny Spencer']
+  spec.email         = %w(bella@squareup.com dspencer@squareup.com)
+  spec.description   = 'Consumes the Bugsnag API.'
+  spec.summary       = 'Consumes the Bugsnag API, for real!'
+  spec.homepage      = "https://github.com/square/arthur"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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('rest-client')
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('pry')
+  spec.add_development_dependency('rspec', '>= 3.0')
+  spec.add_development_dependency('webmock', '>= 1.18')
+end

data/lib/arthur.rb

@@ -0,0 +1,3 @@
+require_relative 'arthur/api'
+require_relative 'arthur/project'
+require_relative 'arthur/error'

data/lib/arthur/api.rb

@@ -0,0 +1,60 @@
+require 'json'
+require 'open-uri'
+require 'rest-client'
+
+module Arthur
+  module Api
+    # return JSON parsed response
+    def self.get(path, opts = {})
+      all_elements = []
+      next_offset = nil
+
+      loop do
+        response = RestClient.get(full_path(path), 'params' => prune_options(opts.merge(offset: next_offset)))
+
+        next_offset = nil
+        if response.headers[:link]
+          rel_next = response.headers[:link].match(/\<(.*)\>; rel=\"next\"/)
+          if rel_next
+            next_offset = URI.unescape(rel_next[1].match(/[&?]offset=([^&>]*)/)[1])
+          end
+        end
+        json_parsed_response = JSON.parse(response.body)
+
+        if json_parsed_response.is_a?(Array)
+          all_elements += json_parsed_response
+        else
+          return json_parsed_response
+        end
+        break unless next_offset
+      end
+
+      all_elements
+    end
+
+    def self.prune_options(options={})
+      options.merge(auth_token: auth_token).delete_if{ |_, value| value.nil? }
+    end
+
+    def self.full_path(path)
+      "#{base_path}#{path}"
+    end
+
+    def self.configure(path, token)
+      @base_path = path
+      @auth_token = token
+    end
+
+    def self.base_path
+      if @base_path
+        @base_path
+      else
+        'https://api.bugsnag.com'
+      end
+    end
+
+    def self.auth_token
+      @auth_token
+    end
+  end
+end

data/lib/arthur/error.rb

@@ -0,0 +1,19 @@
+require_relative 'api'
+
+module Arthur
+  class Error
+    def self.fetch(error_id)
+      Arthur::Error.new(Arthur::Api.get("/errors/#{error_id}"))
+    end
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def count_in_environment(env)
+      @data['release_stages'].fetch(env, 0)
+    end
+  end
+end

data/lib/arthur/project.rb

@@ -0,0 +1,27 @@
+require_relative 'api'
+
+module Arthur
+  class Project
+    def self.list
+      Arthur::Api.get("/account/projects").map do |project|
+        Arthur::Project.new(project)
+      end
+    end
+
+    def self.fetch(project_id)
+      Arthur::Project.new(Arthur::Api.get("/projects/#{project_id}"))
+    end
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def errors
+      Arthur::Api.get("/projects/#{@data['id']}/errors").map do |project|
+        Arthur::Error.new(project)
+      end
+    end
+  end
+end

data/lib/arthur/version.rb

@@ -0,0 +1,3 @@
+module Arthur
+  VERSION = '1.0.0'
+end

data/spec/arthur/error_spec.rb

@@ -0,0 +1,63 @@
+require 'arthur/error'
+
+require 'spec_helper'
+
+describe Arthur::Error do
+  before do
+    stub_request(:get, full_url(path)).to_return(:body => api_response)
+  end
+
+  let(:api_response) do
+    %({
+      "id": "518031bcd775355c48a1cd4f",
+      "class": "NoMethodError",
+      "last_message": "undefined method `name' for nil:NilClass",
+      "last_context": "mailer#admin",
+      "resolved": false,
+      "occurrences": 8,
+      "users_affected": 8,
+      "contexts": {
+        "mailer#admin": 8
+      },
+      "release_stages": {
+        "production": 8
+      },
+      "first_received": "2013-04-30T21:03:56Z",
+      "last_received": "2013-07-29T10:42:05Z",
+      "comments_url": "bugsnag-host/errors/518031bcd775355c48a1cd4f/comments",
+      "events_url": "bugsnag-host/errors/518031bcd775355c48a1cd4f/events",
+      "html_url": "https://bugsnag.com/errors/518031bcd775355c48a1cd4f",
+      "url": "bugsnag-host/errors/518031bcd775355c48a1cd4f"
+    })
+  end
+
+  let(:error_id) { "518031bcd775355c48a1cd4f" }
+
+  let(:error) do
+    Arthur::Error.fetch(error_id)
+  end
+
+  let(:path) { "/errors/#{error_id}"}
+
+  describe '.fetch' do
+    it "fetches the correct data from the API" do
+      expect(error.data['id']).to eq(error_id)
+      expect(error.data['occurrences']).to eq(8)
+    end
+  end
+
+  describe '#count_in_environment' do
+    context 'production environment' do
+      subject do
+        error.count_in_environment('production')
+      end
+      it { should eq(8) }
+    end
+    context 'staging environment' do
+      subject do
+        error.count_in_environment('staging')
+      end
+      it { should eq(0) }
+    end
+  end
+end

data/spec/arthur/project_spec.rb

@@ -0,0 +1,178 @@
+require 'arthur/project'
+require 'arthur/error'
+
+require 'spec_helper'
+
+describe Arthur::Project do
+  describe '.list' do
+    let(:path) do
+      '/account/projects'
+    end
+    let(:api_response) do
+      '[
+        {
+          "id": "50baed119bf39c1431000004",
+          "name": "Website",
+          "api_key": "a0f5e56c125d2eeac31fd66e4f0cbd79",
+          "errors": 78,
+          "icon": "https://bugsnag.com/assets/frameworks/rails.png",
+          "release_stages": ["production", "development"],
+          "type": "rails",
+          "created_at": "2012-12-02T05:54:25Z",
+          "updated_at": "2013-06-17T19:57:49Z",
+          "errors_url": "bugsnag-host/projects/50baed119bf39c1431000004/errors",
+          "events_url": "bugsnag-host/projects/50baed119bf39c1431000004/events",
+          "html_url": "https://bugsnag.com/dashboard/website",
+          "url": "bugsnag-host/projects/50baed119bf39c1431000004"
+        },
+        {
+          "id": "50baed119bf39c1431000007",
+          "name": "Another Website",
+          "api_key": "a0f5e56c125d2eeac31fd66e4f0cbd79",
+          "errors": 25,
+          "icon": "https://bugsnag.com/assets/frameworks/rails.png",
+          "release_stages": ["production", "development"],
+          "type": "rails",
+          "created_at": "2012-12-02T05:54:25Z",
+          "updated_at": "2013-06-17T19:57:49Z",
+          "errors_url": "bugsnag-host/projects/50baed119bf39c1431000004/errors",
+          "events_url": "bugsnag-host/projects/50baed119bf39c1431000004/events",
+          "html_url": "https://bugsnag.com/dashboard/website",
+          "url": "bugsnag-host/projects/50baed119bf39c1431000004"
+        }
+      ]'
+    end
+
+    it "returns the correct list" do
+      # stub_api_response(api_response)
+      stub_request(:get, full_url(path)).to_return(:body => api_response)
+      responses = Arthur::Project.list
+      expect(responses.first.data['id']).to eq("50baed119bf39c1431000004")
+      expect(responses.first.data['name']).to eq("Website")
+      expect(responses.last.data['id']).to eq("50baed119bf39c1431000007")
+      expect(responses.last.data['name']).to eq("Another Website")
+    end
+  end
+
+
+  describe '.fetch' do
+    let(:project_id) { "50baed119bf39c1431000004" }
+    let(:path) { "/projects/#{project_id}" }
+
+    let(:api_response) do
+      '{
+        "id": "50baed119bf39c1431000004",
+        "name": "Website",
+        "api_key": "a0f5e56c125d2eeac31fd66e4f0cbd79",
+        "errors": 78,
+        "icon": "https://bugsnag.com/assets/frameworks/rails.png",
+        "release_stages": ["production", "development"],
+        "type": "rails",
+        "created_at": "2012-12-02T05:54:25Z",
+        "updated_at": "2013-06-17T19:57:49Z",
+        "errors_url": "bugsnag-host/projects/50baed119bf39c1431000004/errors",
+        "events_url": "bugsnag-host/projects/50baed119bf39c1431000004/events",
+        "html_url": "https://bugsnag.com/dashboard/website",
+        "url": "bugsnag-host/projects/50baed119bf39c1431000004"
+      }'
+    end
+
+    it "returns the correct project" do
+      stub_request(:get, full_url(path)).to_return(:body => api_response)
+      response = Arthur::Project.fetch(project_id)
+      expect(response.data['id']).to eq(project_id)
+      expect(response.data['name']).to eq("Website")
+    end
+  end
+
+  context '#errors' do
+    let(:path) { "/projects/#{example_project.data['id']}/errors" }
+    let(:example_project) do
+      Arthur::Project.new(
+        "id" => "50baed119bf39c1431000004",
+        "name" => "Website",
+        "api_key" => "a0f5e56c125d2eeac31fd66e4f0cbd79",
+        "errors" => 78,
+        "icon" => "https://bugsnag.com/assets/frameworks/rails.png",
+        "release_stages" => ["production", "development"],
+        "type" => "rails",
+        "created_at" => "2012-12-02T05:54:25Z",
+        "updated_at" => "2013-06-17T19:57:49Z",
+        "errors_url" => "bugsnag-host/projects/50baed119bf39c1431000004/errors",
+        "events_url" => "bugsnag-host/projects/50baed119bf39c1431000004/events",
+        "html_url" => "https://bugsnag.com/dashboard/website",
+        "url" => "bugsnag-host/projects/50baed119bf39c1431000004"
+      )
+    end
+
+    let(:api_response) do
+      %([
+        {
+          "id": "518031bcd775355c48a1cd4e",
+          "class": "NoMethodError",
+          "last_message": "undefined method `name' for nil:NilClass",
+          "last_context": "mailer#admin",
+          "resolved": false,
+          "occurrences": 12,
+          "users_affected": 13,
+          "contexts": {
+            "mailer#admin": 12
+          },
+          "release_stages": {
+            "production": 12
+          },
+          "first_received": "2013-04-30T21:03:56Z",
+          "last_received": "2013-07-29T10:42:05Z",
+          "comments_url": "bugsnag-host/errors/518031bcd775355c48a1cd4e/comments",
+          "events_url": "bugsnag-host/errors/518031bcd775355c48a1cd4e/events",
+          "html_url": "https://bugsnag.com/errors/518031bcd775355c48a1cd4e",
+          "url": "bugsnag-host/errors/518031bcd775355c48a1cd4e"
+        },
+        {
+          "id": "518031bcd775355c48a1cd4f",
+          "class": "NoMethodError",
+          "last_message": "undefined method `name' for nil:NilClass",
+          "last_context": "mailer#admin",
+          "resolved": false,
+          "occurrences": 8,
+          "users_affected": 8,
+          "contexts": {
+            "mailer#admin": 8
+          },
+          "release_stages": {
+            "production": 8
+          },
+          "first_received": "2013-04-30T21:03:56Z",
+          "last_received": "2013-07-29T10:42:05Z",
+          "comments_url": "bugsnag-host/errors/518031bcd775355c48a1cd4f/comments",
+          "events_url": "bugsnag-host/errors/518031bcd775355c48a1cd4f/events",
+          "html_url": "https://bugsnag.com/errors/518031bcd775355c48a1cd4f",
+          "url": "bugsnag-host/errors/518031bcd775355c48a1cd4f"
+        }
+      ])
+    end
+
+    it "returns the correct list" do
+      stub_request(:get, full_url(path)).to_return(:body => api_response)
+      responses = example_project.errors
+      expect(responses.first.data['id']).to eq("518031bcd775355c48a1cd4e")
+      expect(responses.last.data['id']).to  eq("518031bcd775355c48a1cd4f")
+    end
+
+    context "with a longer list of errors" do
+      let(:first_api_response) do
+        Array.new(30){ {} }.to_json
+      end
+      let(:second_api_response) do
+        Array.new(20){ {'second' => true} }.to_json
+      end
+      let(:offset) { "herpderpderp" }
+      it "returns the correct list" do
+        stub_request(:get, full_url(path)).to_return(:body => first_api_response, :headers => {:link => "<http://localhost/projects/537ab6c3f697833600000001/errors?direction=desc&offset=#{offset}&per_page=30&sort=last_received>; rel=\"next\""})
+        stub_request(:get, full_url(path, offset: offset)).to_return(:body => second_api_response)
+        responses = example_project.errors
+        expect(responses.length).to eq(50)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'webmock/rspec'
+require 'pry'
+
+RSpec.configure do |c|
+  c.before do
+    Arthur::Api.configure('https://api.custombugsnaghost.com:1234', 'auth-token')
+  end
+end
+
+def full_url(url, params={})
+  RestClient::Request.new({:method => :get, :url => ""}).process_url_params(Arthur::Api.full_path(url), {'params' => params.merge(auth_token: Arthur::Api.auth_token)})
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: arthur
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bella Norvig
+- Danny Spencer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: 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: pry
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: Consumes the Bugsnag API.
+email:
+- bella@squareup.com
+- dspencer@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- arthur.gemspec
+- lib/arthur.rb
+- lib/arthur/api.rb
+- lib/arthur/error.rb
+- lib/arthur/project.rb
+- lib/arthur/version.rb
+- spec/arthur/error_spec.rb
+- spec/arthur/project_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/square/arthur
+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: Consumes the Bugsnag API, for real!
+test_files:
+- spec/arthur/error_spec.rb
+- spec/arthur/project_spec.rb
+- spec/spec_helper.rb
+has_rdoc: