airbox 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fleetbit.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,8 @@
+----------------------------------------------------------------------------
+"THE BEER-WARE LICENSE" (Revision 42):
+<anulman@gmail.com> wrote this file. As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer in return. --Aidan Nulman
+----------------------------------------------------------------------------
+[thanks to phk@FreeBSD.ORG for the license]
+

data/README.md

@@ -0,0 +1,83 @@
+airbox
+======
+
+ActiveResource extension to easily access and manipulate objects from Airbrake's reporting API.
+
+----
+## Usage
+
+In your app, define Airbox.site & Airbox.auth_token to initialize the extension:
+
+```ruby
+Airbox.site = "site_url"
+Airbox.auth_token = "token"
+```
+
+(Airbox will automatically scan for airbox.rb in the project's root directory; feel free to stash an initializer anywhere else).
+
+----
+Most of the time, you'll want to start with a collection of resources:
+
+```ruby
+@resources = Airbox::Group.find :all
+@resources = @resources.first.notices(:page => 2)
+@resources = Airbox::Error.all(show_resolved: true)
+```
+
+Collections are paginated, with 30 objects per page. Airbox offers convenient ways to access other pages:
+
+```ruby
+@p1 = @resources
+@p2 = @p1.next_page
+prest = @p2.next_pages
+```
+
+While collecting _all_ pages can be done from any page, it's most efficient from the first:
+```ruby
+p1all = @p1.all_pages
+p2all = @p2.all_pages
+p1all == p2all
+```
+
+You can access most related resources through simple object methods:
+
+```ruby
+project = Airbox::Project.first
+errors = project.errors  #Will return all errors associated to the project
+group = errors.first.group  #Will return the group object associated to the first error
+notices = group.notices  #Will return the notices associated to the group object
+```
+
+Finally, some objects (looking at you, Error and Group::Notice) don't return with full information on collection calls. So sometimes, you need to request the full object:
+
+```ruby
+project = Airbox::Project.first
+errors = project.errors(show_resolved: true)
+error = errors.first
+error.request.url  #Will error out, since the request object is not
+available here
+full_error = error.full_obj
+full_error.request.url  #Will return the URL for the requested error
+```
+
+## Resources
+
+Resources are defined by [Airbrake's API](http://help.airbrake.io/kb/api-2/api-overview). Collections are paginated, with 30 objects per page.
+
+Valid resources are Project, Error, Group, and Group::Notice.
+
+## To Do
+
+This gem is brand new, so there's still work to be done. The current list includes:
+
+* Write test suite
+* Move nested resources (e.g. Group::Notice) to use prefix options vs. hard-coded from
+* Split resource types into their own files
+* Look for and patch holes in functionality between Airbrake's reporting API and Airbox
+* Remove ActiveRecord dependency
+
+All contributions appreciated; just issue a pull request!
+
+## License
+
+This gem is distributed as Beerware. Full text in the LICENSE file, but it's yours to do with as you wish (so long as you keep the LICENSE file around). If you like it, and we meet one day, consider buying me a drink.

data/airbox.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "airbox/version"
+
+Gem::Specification.new do |s|
+  s.name        = "airbox"
+  s.version     = Airbox::VERSION
+  s.authors     = ["Aidan Nulman"]
+  s.email       = ["anulman@gmail.com"]
+  s.homepage    = "https://github.com/anulman/airbox"
+  s.summary     = %q{Airbrake's missing "black box"}
+  s.description = %q{ActiveResource extension to easily access and manipulate objects from Airbrake's reporting API.}
+  s.license     = "Beerware"
+  s.required_ruby_version = '>= 1.9.0'
+
+  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"]
+
+  s.add_dependency('activeresource', '< 4')
+end

data/lib/airbox.rb

@@ -0,0 +1,200 @@
+# *************************************************
+#
+# USAGE
+# 
+# *************************************************
+#
+# Define Airbox.site & Airbox.auth_token
+# (Automatically scans for init.rb in same dir)
+#
+# *************************************************
+#
+# Resources are paginated. You get 30 at a time.
+#
+# @resources = Airbox::Group.find :all
+# @resources = @resources.first.notices(:page => 2)
+# @resources = Airbox::Error.all(show_resolved: true)
+#
+# *************************************************
+
+require "active_resource"
+
+module Airbox
+  # Accessor methods for site/auth_token settings
+  # H/T to Instagram gem team for the inspiration
+  def self.site
+    Resource.site
+  end
+
+  def self.site=(site)
+    Resource.site = site
+  end
+
+  def self.auth_token
+    Resource.auth_token
+  end
+
+  def self.auth_token=(tok)
+    Resource.auth_token=(tok)
+  end
+
+  class Resource < ::ActiveResource::Base
+    # Airbrake's API responds with XML objects
+    self.format = ActiveResource::Formats::XmlFormat
+
+    class << self
+      # Store auth_token as class variable
+      def auth_token=(tok)
+        @@auth_token = tok
+      end
+
+      # Before standard ActiveResource::Base.find, prep params for request
+      def find(*arguments)
+        if !site
+          err = "No site defined. Please run Airbox.site = 'site_url'"
+          raise ConfigError, err
+        end
+        arguments = prepare_params(*arguments)
+        super(*arguments)
+      end
+
+      # Move opts (except for "from") into params hash
+      # Add auth_token to params hash
+      def prepare_params(*arguments)
+        if !class_variable_defined?(:@@auth_token)
+          err = "No auth token. Please run Airbox.auth_token = 'token'"
+          raise ConfigError, err
+        end
+
+        opts = arguments.last.is_a?(Hash) ? arguments.pop : {}
+
+        # Store pre-transformed opts in instance var
+        # Later accessed to ensure continuity on paged results
+        @opts = opts.dup
+
+        opts[:params] = add_relevant_opts_to_params(opts.except(:from))
+        opts[:params].merge!(auth_token: @@auth_token)
+        arguments << opts
+        arguments
+      end
+
+      # Method to move opts into params hash
+      def add_relevant_opts_to_params(opts)
+        params = opts[:params] || {}
+        opts.except(:params).each do |k,v|
+          params[k] = v
+        end
+        params
+      end
+
+      # After standard ActiveResource::Base.instantiate_collection,
+      # ensure collection is returned as Airbox::Array for easier use
+      #
+      # TODO - needs update to ActiveResource4 + backwards compatibility
+      # (Currently conforms to ActiveResource 3.2.13 spec)
+      def instantiate_collection(collection, original_params = {})
+        ary = super(collection, original_params)
+        ary = Array.new(ary)
+        ary.opts = @opts
+        ary
+      end
+
+      def ensure_collection(coll)
+        klass = self.class.to_s.split('::').last.downcase
+        if coll.has_key?(klass)
+          coll = coll[klass]
+        end
+        coll
+      end
+    end
+  end
+
+  # Airbrake project resources
+  class Project < Resource
+    # For some reason, these return as JSON?
+    self.format = ActiveResource::Formats::JsonFormat
+
+    # Return project's errors
+    def errors(opts={})
+      Error.all(opts.merge(project_id: id))
+    end
+  end
+
+  # Airbrake error resources
+  class Error < Resource
+
+    # Collect all associated data
+    def full_obj(opts={})
+      self.class.find(id, opts)
+    end
+
+    # Return related group
+    def group(opts={})
+      Group.find(id)
+    end
+  end
+
+  # Airbrake group resources
+  class Group < Resource
+
+    # Return group's notices
+    def notices(opts={})
+       Notice.all(opts.merge(from: "/groups/#{id}/notices"))
+    end
+
+    # Airbrake notice resources
+    class Notice < Resource
+
+      # Collect all associated data
+      def full_obj(opts={})
+        self.class.find :one, opts.merge(from: "/groups/#{group_id}/notices/#{id}")
+      end
+    end
+  end
+
+  # Extend Array class for module use
+  # When Airbox returns collections of resources, give them paging methods
+  class Array < ::Array
+    # Store/retrieve query in opts instance variable
+    attr_accessor :opts
+
+    # Return next page of results for current query
+    def next_page
+      @opts ||= {}
+      @opts[:page] ||= 1
+      return first.class.all(@opts.merge(page: @opts[:page] + 1).dup)
+    end
+
+    # Return all future pages of results for current query
+    def next_pages
+      collection = []
+      current = self
+      while(current.count == 30)
+        current = current.next_page
+        collection += current
+      end
+      collection
+    end
+
+    # Return all pages of results for current query
+    def all_pages
+      if !self.opts || self.opts[:page] == 1 || !self.opts[:page]
+        self + self.next_pages
+      else
+        collection = first.class.all(@opts.except(:page))
+        collection + collection.next_pages
+      end
+    end
+  end
+
+  class ConfigError < ::StandardError
+  end
+end
+
+# Load init file in same folder
+# Rescue if no initialization found
+begin
+  require "./airbox"
+rescue LoadError
+end
+

data/lib/airbox/version.rb

@@ -0,0 +1,3 @@
+module Airbox
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: airbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aidan Nulman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+description: ActiveResource extension to easily access and manipulate objects from
+  Airbrake's reporting API.
+email:
+- anulman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- airbox.gemspec
+- lib/airbox.rb
+- lib/airbox/version.rb
+homepage: https://github.com/anulman/airbox
+licenses:
+- Beerware
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Airbrake's missing "black box"
+test_files: []
+has_rdoc: