airbrake-api 3.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+*.gem
+pkg/*
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - jruby
+  - rbx
+  - ree
+  - ruby-head

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+end
+
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+Airbrake API [![Build Status](https://secure.travis-ci.org/spagalloco/airbrake-api.png)](http://travis-ci.org/spagalloco/airbrake-api)
+======================================================================================================================================
+
+A ruby wrapper for the [Airbrake API](http://airbrakeapp.com/pages/api)
+
+Usage
+-----
+
+The first thing you need to set is the account name.  This is the same as the web address for your account.
+
+    AirbrakeAPI.account = 'myaccount'
+
+Then, you should set the authentication token.
+
+    AirbrakeAPI.auth_token = 'abcdefg'
+
+If your account uses ssl then turn it on:
+
+    AirbrakeAPI.secure = true
+
+Optionally, you can configure through a single method:
+
+    AirbrakeAPI.configure(:account => 'anapp', :auth_token => 'abcdefg', :secure => true)
+
+Once you've configured authentication, you can make calls against the API.  If no token or authentication is given, an AirbrakeError exception will be raised.
+
+Finding Errors
+--------------
+
+Errors are paginated, the API responds with 25 at a time, pass an optional params hash for additional pages:
+
+    AirbrakeAPI::Error.find(:all)
+    AirbrakeAPI::Error.find(:all, :page => 2)
+
+To find an individual error, you can find by ID:
+
+    AirbrakeAPI::Error.find(error_id)
+
+Find *all* notices of an error:
+
+    AirbrakeAPI::Notice.find_all_by_error_id(error_id)
+
+Find an individual notice:
+
+    AirbrakeAPI::Notice.find(notice_id, error_id)
+
+To resolve an error via the API:
+
+    AirbrakeAPI::Error.update(1696170, :group => { :resolved => true})
+
+Recreate an error:
+
+    STDOUT.sync = true
+    AirbrakeAPI::Notice.find_all_by_error_id(error_id) do |batch|
+      batch.each do |notice|
+        result = system "curl --silent '#{notice.request.url}' > /dev/null"
+        print (result ? '.' : 'F')
+      end
+    end
+
+Projects
+--------
+
+To retrieve a list of projects:
+
+    AirbrakeAPI::Project.find(:all)
+
+Responses
+---------
+
+If an error is returned from the API, an AirbrakeError will be raised.  Successful responses will return a Hashie::Mash object based on the data from the response.
+
+
+Contributors
+------------
+
+* [Matias Käkelä](https://github.com/massive) - SSL Support
+* [Jordan Brough](https://github.com/jordan-brough) - Notices
+* [Michael Grosser](https://github.com/grosser) - Numerous performance improvements and bug fixes
+* [Brad Greenlee](https://github.com/bgreenlee) - Switch from Hoptoad to Airbrake

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/airbrake-api.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "airbrake-api/version"
+
+Gem::Specification.new do |s|
+  s.name      = 'airbrake-api'
+  s.version   = AirbrakeAPI::VERSION
+  s.platform  = Gem::Platform::RUBY
+
+  s.summary = "A ruby wrapper for the Airbrake API"
+  s.description = "A ruby wrapper for the Airbrake API"
+
+  s.authors   = ['Steve Agalloco']
+  s.email     = ['steve.agalloco@gmail.com']
+  s.homepage  = 'https://github.com/spagalloco/airbrake-api'
+
+  s.add_dependency 'httparty', '~> 0.8.0'
+  s.add_dependency 'hashie', '~> 1.1.0'
+  s.add_dependency 'parallel', '~> 0.5.0'
+
+  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'yard', '~> 0.7.2'
+  s.add_development_dependency 'maruku', '~> 0.6'
+  s.add_development_dependency 'simplecov', '~> 0.4.2'
+  s.add_development_dependency 'fakeweb', '~> 1.3.0'
+  s.add_development_dependency 'nokogiri', '~> 1.4'
+  s.add_development_dependency 'airbrake', '~> 3.0'
+  s.add_development_dependency 'i18n', '~> 0.6.0'
+
+  # ensure the gem is built out of versioned files
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/airbrake-api.rb

@@ -0,0 +1,30 @@
+require 'hashie'
+require 'httparty'
+
+module AirbrakeAPI
+  extend self
+  attr_accessor :account, :auth_token, :secure
+
+  class AirbrakeError < StandardError; end
+
+  def configure(options={})
+    @account = options[:account] if options.has_key?(:account)
+    @auth_token = options[:auth_token] if options.has_key?(:auth_token)
+    @secure = options[:secure] if options.has_key?(:secure)
+  end
+
+  def account_path
+    "#{protocol}://#{@account}.airbrakeapp.com"
+  end
+
+  def protocol
+    secure ? "https" : "http"
+  end
+
+end
+
+require 'airbrake-api/core_extensions'
+require 'airbrake-api/client'
+require 'airbrake-api/error'
+require 'airbrake-api/notice'
+require 'airbrake-api/project'

data/lib/airbrake-api/client.rb

@@ -0,0 +1,41 @@
+module AirbrakeAPI
+  class Base
+    include HTTParty
+    format :xml
+
+    private
+
+    def self.setup
+      base_uri AirbrakeAPI.account_path
+      default_params :auth_token => AirbrakeAPI.auth_token
+
+      check_configuration
+    end
+
+    def self.check_configuration
+      raise AirbrakeError.new('API Token cannot be nil') if default_options.nil? || default_options[:default_params].nil? || !default_options[:default_params].has_key?(:auth_token)
+      raise AirbrakeError.new('Account cannot be nil') unless default_options.has_key?(:base_uri)
+    end
+
+    def self.fetch(path, options)
+      response = get(path, { :query => options })
+      if response.code == 403
+        raise AirbrakeError.new('SSL should be enabled - use AirbrakeAPI.secure = true in configuration')
+      end
+
+      Hashie::Mash.new(response)
+    end
+
+  end
+end
+
+# airbrake sometimes returns broken xml with invalid xml tag names
+# so we remove them
+require 'httparty/parser'
+class HTTParty::Parser
+  def xml
+    body.gsub!(/<__utmz>.*?<\/__utmz>/m,'')
+    body.gsub!(/<[0-9]+.*?>.*?<\/[0-9]+.*?>/m,'')
+    MultiXml.parse(body)
+  end
+end

data/lib/airbrake-api/core_extensions.rb

@@ -0,0 +1,5 @@
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end

data/lib/airbrake-api/error.rb

@@ -0,0 +1,59 @@
+module AirbrakeAPI
+  class Error < AirbrakeAPI::Base
+
+    def self.find(*args)
+      setup
+
+      results = case args.first
+        when Fixnum
+          find_individual(args)
+        when :all
+          find_all(args)
+        else
+          raise AirbrakeError.new('Invalid argument')
+      end
+
+      raise AirbrakeError.new('No results found.') if results.nil?
+      raise AirbrakeError.new(results.errors.error) if results.errors
+
+      results.group || results.groups
+    end
+
+    def self.update(error, options)
+      setup
+
+      response = put(error_path(error), { :query => options })
+      if response.code == 403
+        raise AirbrakeError.new('SSL should be enabled - use Airbrake.secure = true in configuration')
+      end
+      results = Hashie::Mash.new(response)
+
+      raise AirbrakeError.new(results.errors.error) if results.errors
+      results.group
+    end
+
+    private
+
+    def self.find_all(args)
+      options = args.extract_options!
+
+      fetch(collection_path, options)
+    end
+
+    def self.find_individual(args)
+      id = args.shift
+      options = args.extract_options!
+
+      fetch(error_path(id), options)
+    end
+
+    def self.collection_path
+      '/errors.xml'
+    end
+
+    def self.error_path(error_id)
+      "/errors/#{error_id}.xml"
+    end
+
+  end
+end

data/lib/airbrake-api/notice.rb

@@ -0,0 +1,66 @@
+require 'parallel'
+
+module AirbrakeAPI
+  class Notice < AirbrakeAPI::Base
+    PER_PAGE = 30
+    PARALLEL_WORKERS = 10
+
+    def self.find(id, error_id, options={})
+      setup
+
+      hash = fetch(find_path(id, error_id), options)
+
+      if hash.errors
+        raise AirbrakeError.new(results.errors.error)
+      end
+
+      hash.notice
+    end
+
+    def self.find_all_by_error_id(error_id, notice_options = {})
+      setup
+
+      options = {}
+      notices = []
+      page = 1
+      while !notice_options[:pages] || page <= notice_options[:pages]
+        options[:page] = page
+        hash = fetch(all_path(error_id), options)
+        if hash.errors
+          raise AirbrakeError.new(results.errors.error)
+        end
+
+        batch = Parallel.map(hash.notices, :in_threads => PARALLEL_WORKERS) do |notice_stub|
+          find(notice_stub.id, error_id)
+        end
+        yield batch if block_given?
+        batch.each{|n| notices << n }
+
+        break if batch.size < PER_PAGE
+        page += 1
+      end
+      notices
+    end
+
+    def self.find_by_error_id(error_id, options={ 'page' => 1})
+      setup
+
+      hash = fetch(all_path(error_id), options)
+      if hash.errors
+        raise AirbrakeError.new(results.errors.error)
+      end
+
+      hash.notices
+    end
+
+    private
+
+    def self.find_path(id, error_id)
+      "/errors/#{error_id}/notices/#{id}.xml"
+    end
+
+    def self.all_path(error_id)
+      "/errors/#{error_id}/notices.xml"
+    end
+  end
+end

data/lib/airbrake-api/project.rb

@@ -0,0 +1,19 @@
+module AirbrakeAPI
+  class Project < AirbrakeAPI::Base
+
+    def self.find(*args)
+      setup
+      options = args.extract_options!
+
+      results = fetch(collection_path, options)
+
+      raise AirbrakeError.new(results.errors.error) if results.errors
+      results.projects.project
+    end
+
+    def self.collection_path
+      '/data_api/v1/projects.xml'
+    end
+
+  end
+end

data/lib/airbrake-api/version.rb

@@ -0,0 +1,3 @@
+module AirbrakeAPI
+  VERSION = '3.2.0'
+end

data/lib/airbrake_api.rb

@@ -0,0 +1 @@
+require 'airbrake-api'

data/spec/airbrake_api/error_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe AirbrakeAPI::Error do
+  before(:all) do
+    AirbrakeAPI.account = 'myapp'
+    AirbrakeAPI.auth_token = 'abcdefg123456'
+    AirbrakeAPI.secure = false
+  end
+
+  it "should have correct collection path" do
+    AirbrakeAPI::Error.collection_path.should == "/errors.xml"
+  end
+
+  it "should generate correct error path given an id" do
+    AirbrakeAPI::Error.error_path(1234).should == "/errors/1234.xml"
+  end
+
+  describe '.find' do
+    it "should find a page of the 30 most recent errors" do
+      errors = AirbrakeAPI::Error.find(:all)
+      ordered = errors.sort_by(&:most_recent_notice_at).reverse
+      ordered.should == errors
+      errors.size.should == 30
+    end
+
+    it "should paginate errors" do
+      errors = AirbrakeAPI::Error.find(:all, :page => 2)
+      ordered = errors.sort_by(&:most_recent_notice_at).reverse
+      ordered.should == errors
+      errors.size.should == 2
+    end
+
+    it "should find an individual error" do
+      error = AirbrakeAPI::Error.find(1696170)
+      error.action.should == 'index'
+      error.id.should == 1696170
+    end
+
+    it "should raise an error when not passed an id" do
+      lambda do
+        AirbrakeAPI::Error.find
+      end.should raise_error(AirbrakeAPI::AirbrakeError)
+    end
+  end
+
+  describe '.update' do
+    it 'should update the status of an error' do
+      error = AirbrakeAPI::Error.update(1696170, :group => { :resolved => true})
+      error.resolved.should be_true
+    end
+  end
+
+end