bugsnag_data 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac8615b617f8c31635dbc4eb943116a7d80636e3
+  data.tar.gz: fb24581a43c2ce1f5f8f38a7f3023a803d74abf5
+SHA512:
+  metadata.gz: 0a45fc32a28f163b5db09b4b6fbc6cf9a7e65bbb5943a9dea09dd379ce4766c2a5848f4fae45bde8dcfb2115e6b14e70447b1de24277f1d4f993c45848a202cb
+  data.tar.gz: dad0aac41af7918d38895427d06784deafa3b6762173a11f6b636e00e1f3dd37dbec7910e2c2a6106cbd155521fc0fb7dac8412fd14a13e1cb41f70a3c8f3dda

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2014 Tim Hilliard
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/README.md

@@ -0,0 +1,33 @@
+# bugsnag-data-client
+
+Interact with the Bugsnag Data REST API.
+
+[![Build Status](https://travis-ci.org/timhilliard/bugsnag-data-client.svg?branch=master)](https://travis-ci.org/timhilliard/bugsnag-data-client)
+
+## API calls
+
+    require 'bugsnag_data'
+    bugsnag = BugsnagData.new("BUGSNAG_API_KEY")
+    bugsnag.account
+    bugsnag.users
+    bugsnag.project_users(PROJECT_ID)
+    bugsnag.user(USER_ID)
+    bugsnag.projects
+    bugsnag.user_projects(USER_ID)
+    bugsnag.project(PROJECT_ID)
+    bugsnag.project_errors(PROJECT_ID)
+    bugsnag.project_events(PROJECT_ID)
+    bugsnag.error_events(ERROR_ID)
+
+## Use the API docs
+
+For more - you should be able to find the latest at
+[https://bugsnag.com/docs/api](https://bugsnag.com/docs/api) if you are a
+Bugsnag customer.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Commit.
+* Send me a pull request. Bonus points for topic branches.

data/example.rb

@@ -0,0 +1,14 @@
+require 'bugsnag_data'
+
+bugsnag = BugsnagData.new("BUGSNAG_API_KEY")
+
+bugsnag.account
+bugsnag.users
+bugsnag.project_users(PROJECT_ID)
+bugsnag.user(USER_ID)
+bugsnag.projects
+bugsnag.user_projects(USER_ID)
+bugsnag.project(PROJECT_ID)
+bugsnag.project_errors(PROJECT_ID)
+bugsnag.project_events(PROJECT_ID)
+bugsnag.error_events(ERROR_ID)

data/lib/bugsnag_data.rb

@@ -0,0 +1,240 @@
+#
+# Author:: Tim Hilliard (<timhilliard@gmail.com>)
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'httparty'
+
+# Top level class for dealing with Bugsnag specific exceptions
+class BugsnagDataExceptions
+  # Exception class for dealing with failed requests
+  class RequestFailed < RuntimeError; end
+  # Exception class for dealing with requests that return not found by the API
+  class NotFound < RequestFailed; end
+  # Exception class for dealing with authorization failed requests
+  class AuthorizationFailed < RequestFailed; end
+  # Exception class for dealing with poorly formatted requests
+  class BadRequest < RequestFailed; end
+end
+
+# Class for retrieving data from the Bugsnag API.
+class BugsnagData
+  include HTTParty
+
+  attr_accessor :options
+
+  base_uri 'https://api.bugsnag.com'
+
+  # Creates a new base object for interacting with Bugnsags's REST API
+  #
+  # @param [String] api_key
+  #   Your Bugsnag API key
+  #
+  def initialize(api_key)
+    @options = { headers: { 'Authorization' => "token #{api_key}" } }
+  end
+
+  ##
+  # Get Account details
+  ##
+  # Get details for the currently authenticated Account.
+  #
+  # See: https://bugsnag.com/docs/api/accounts#get-account-details
+  #
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def account(params = {})
+    make_get_request('/account', params)
+  end
+
+  ##
+  # List your Account's Users
+  ##
+  # Get a list of all Users with access to the currently authenticated Bugsnag
+  # Account.
+  #
+  # See: https://bugsnag.com/docs/api/users#list-your-account-s-users
+  #
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def users(params = {})
+    make_get_request('/account/users', params)
+  end
+
+  ##
+  # List a Project's Users
+  ##
+  # Get a list of Users with access to the specified Project.
+  #
+  # See: https://bugsnag.com/docs/api/users#list-a-project-s-users
+  #
+  # @param [String] project_id
+  #   A project ID
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def project_users(project_id, params = {})
+    make_get_request("/projects/#{project_id}/users", params)
+  end
+
+  ##
+  # Get User details
+  ##
+  # Get the details about a Bugsnag user, including name and email address.
+  #
+  # See: https://bugsnag.com/docs/api/users#get-user-details
+  #
+  # @param [String] user_id
+  #   A user ID
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def user(user_id, params = {})
+    make_get_request("/users/#{user_id}", params)
+  end
+
+  ##
+  # List your Account's Projects
+  ##
+  # Get the details about a Bugsnag user, including name and email address.
+  #
+  # See: https://bugsnag.com/docs/api/projects#list-your-account-s-projects
+  #
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def projects(params = {})
+    make_get_request('/account/projects', params)
+  end
+
+  ##
+  # List a User's Projects
+  ##
+  # Get a list of Projects that the specified Bugsnag User has access to.
+  #
+  # See: https://bugsnag.com/docs/api/projects#list-a-user-s-projects
+  #
+  # @param [String] user_id
+  #   A user ID
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def users_projects(user_id, params = {})
+    make_get_request("/user/#{user_id}/projects", params)
+  end
+
+  ##
+  # Get Project Details
+  ##
+  # Get the details of the given Bugsnag Project.
+  #
+  # See: https://bugsnag.com/docs/api/projects#get-project-details
+  #
+  # @param [String] project_id
+  #   A project ID
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def project(project_id, params = {})
+    make_get_request("/projects/#{project_id}", params)
+  end
+
+  ##
+  # List a Project's Errors
+  ##
+  # Get a list of all errors (grouped exceptions) for the given Bugsnag Project.
+  #
+  # See: https://bugsnag.com/docs/api/errors#list-a-project-s-errors
+  #
+  # @param [String] project_id
+  #   A project ID
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def project_errors(project_id, params = {})
+    make_get_request("/projects/#{project_id}/errors", params)
+  end
+
+  ##
+  # List a Project's Events
+  ##
+  # Get a list of all events (individual crashes) for the given Bugsnag Project.
+  #
+  # See: https://bugsnag.com/docs/api/events#list-a-project-s-events
+  #
+  # @param [String] project_id
+  #   A project ID
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def project_events(project_id, params = {})
+    make_get_request("/projects/#{project_id}/events", params)
+  end
+
+  ##
+  # List an Error's Events
+  ##
+  # Get a list of all events (individual crashes) grouped under the given
+  # Bugsnag Error.
+  #
+  # See: https://bugsnag.com/docs/api/events#list-an-error-s-events
+  #
+  # @param [String] error_id
+  #   An error ID
+  # @param [Hash] params
+  #   A hash of parameters to pass to the request.
+  #
+  def error_events(error_id, params = {})
+    make_get_request("/errors/#{error_id}/events", params)
+  end
+
+  private
+
+  def make_get_request(path, params = {})
+    parse_response(self.class.get(path, prepare_params(params)))
+  end
+
+  def make_post_request(path, params = {})
+    parse_response(self.class.post(path, prepare_params(params)))
+  end
+
+  def make_put_request(path, params = {})
+    parse_response(self.class.put(path, prepare_params(params)))
+  end
+
+  def make_delete_request(path, params = {})
+    parse_response(self.class.delete(path, prepare_params(params)))
+  end
+
+  def prepare_params(params = {})
+    params[:headers] ||= {}
+    params[:headers].merge!(options[:headers])
+    params
+  end
+
+  def parse_response(response)
+    case response.headers['status']
+    when '404 Not Found'
+      fail BugsnagDataExceptions::NotFound, 'Not Found'
+    when '401 Unauthorized'
+      fail BugsnagDataExceptions::AuthorizationFailed, 'Authorization Failed'
+    when '400 Bad Request'
+      fail BugsnagDataExceptions::BadRequest, 'Bad Request'
+    end
+    response.parsed_response
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: bugsnag_data
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Hilliard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+description: Use the Bugsnag Data REST API
+email: timhilliard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- example.rb
+files:
+- Gemfile
+- LICENSE
+- README.md
+- example.rb
+- lib/bugsnag_data.rb
+homepage: http://github.com/timhilliard/bugsnag-data-client
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Bugsnag Data API Client library
+test_files: []
+has_rdoc: