bugsnag-api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae6a214efafc2a17097c3ce489c079d76205c098
-  data.tar.gz: 931212dfa15eeaedd848e7c7a4ef836690e7f777
+  metadata.gz: 3342f6cc4325b1835c5846f1afa9bd63fef42fb6
+  data.tar.gz: 28ea193213ca5423515f5347041b05cdeae9e439
 SHA512:
-  metadata.gz: efbe6b07725c95659ac675856d9f59db7cdc851151c3606f1362aa36841d7924acf1403fb70061ea4c7fbe8a54732a574104456a736e01ca74be57d143d48ce9
-  data.tar.gz: 3a574921af5aaef6ca79cb04d0b646cc1f1f552c68ee5844d37d5d2fb0da874138fc21fcc9c3307d0b7d4e6c485a5717da0f813f0e3c41596c4f502949bfd5a2
+  metadata.gz: b023d4477ac3c8353c45e0f305eda52deda433d4b7ab69df4699636c67d7e6c4472ecff76755a3a500c7920afb341eaff0df024c2fb2e157f8b2736105fbe704
+  data.tar.gz: c7d0bba29e231b9bed1826a7ebb6f9f37beca66c282c2e315d78f13a6e52f469be708f369f94b63301456415ee33cce18bea7319f3379586e5a4ac6e36cbb83f

data/.travis.yml

@@ -6,3 +6,4 @@ rvm:
 - jruby-18mode
 - jruby-19mode
 - 1.8.7
+- rbx-2

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+1.0.2
+-----
+-   Fix load-order bug when requiring from certain environments
+
 1.0.1
 -----
 -   Added test suite

data/LICENSE.txt

@@ -1,6 +1,7 @@
-Copyright (c) 2014 Bugsnag Inc.
+Parts of this software are derived from Octokit.rb, Copyright (c) 2009-2014
+Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober.
 
-MIT License
+The remaining parts are Copyright (c) 2014 Bugsnag Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,50 +5,323 @@ The library allows for quick read/write access to the [Bugsnag API](https://bugs
 
 If you are looking to automatically detect crashes in your Ruby apps, you should take a look at the [Bugsnag Ruby Detection Library](https://bugsnag.com/docs/notifiers/ruby) instead.
 
-This library shares code and philosophies with the fantastic [Octokit](https://github.com/octokit/octokit.rb) library.
+This library borrows heavily from the code and philosophies of the fantastic [Octokit](https://github.com/octokit/octokit.rb) library. A big thanks to [@pengwynn](https://github.com/pengwynn) and the rest of the Octokit team!
+
+
+## Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Making Requests](#making-requests)
+  - [Consuming Resources](#consuming-resources)
+  - [Accessing Related Resources](#accessing-related-resources)
+  - [Authentication](#authentication)
+  - [Pagination](#pagination)
+  - [Accessing HTTP responses](#accessing-http-responses)
+- [API Methods](#api-methods)
+  - [Accounts](#accounts)
+  - [Comments](#comments)
+  - [Errors](#errors)
+  - [Events](#events)
+  - [Projects](#projects)
+  - [Users](#users)
+- [Advanced Configuration](#advanced-configuration)
 
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem "bugsnag-api"
+```ruby
+gem "bugsnag-api"
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install bugsnag-api
+```
+$ gem install bugsnag-api
+```
 
 
 ## Usage
 
+### Making Requests
+
+API methods are available as module methods or as client instance methods.
+
 ```ruby
-# Configure a Bugsnag API client
+# Provide authentication credentials
 Bugsnag::Api.configure do |config|
   config.auth_token = "your-account-api-token"
 end
 
-# Fetch information about the authenticated account
+# Fetch the current account
+account = Bugsnag::Api.account
+```
+
+or...
+
+```ruby
+# Create an non-static API client
+client = Bugsnag::Api::Client.new(auth_token: "your-account-api-token")
+
+# Access API methods on the client
+accounts = client.accounts
+```
+
+### Consuming Resources
+
+Most methods return a `Resource` object which provides dot notation and [] access for fields returned in the API response.
+
+```ruby
+# Fetch the current account
 account = Bugsnag::Api.account
 
-# Get a list of users on this account
-users = Bugsnag::Api.users(account.id)
+puts account.name
+# => "Acme Co"
+
+puts account.fields
+# => #<Set: {:id, :name, :created_at, :updated_at, :url, :users_url, :projects_url, :account_creator, :billing_contact}>
+
+puts account[:id]
+# => "50baed0d9bf39c1431000003"
 
-# Get a list of the projects on this account
-projects = Bugsnag::Api.projects(account.id)
+account.rels[:users].href
+# => "https://api.bugsnag.com/accounts/50baed0d9bf39c1431000003/users"
+```
+
+### Accessing Related Resources
+
+Resources returned by Bugsnag API methods contain not only data but hypermedia link relations:
+
+```ruby
+account = Bugsnag::Api.account
 
-# Get a list of errors on a project
-errors = Bugsnag::Api.errors(projects.first.id)
+# Get the users rel, returned from the API as users_url in the resource
+account.rels[:users].href
+# => "https://api.bugsnag.com/accounts/50baed0d9bf39c1431000003/users"
+
+users = account.rels[:users].get.data
+users.last.name
+# => "James Smith"
 ```
 
+When processing API responses, all `*_url` attributes are culled in to the link relations collection. Any `url` attribute becomes `.rels[:self]`.
+
 
-## Documentation
+### Authentication
 
-Full documentation of available methods can be found here:
-<http://rubydoc.info/github/bugsnag/bugsnag-api-ruby>
+API usage requires authentication. You can authenticate using either your
+Bugsnag account's [auth token](https://bugsnag.com/docs/api#account-authentication)
+or with your Bugsnag [user credentials](https://bugsnag.com/docs/api#user-authentication).
+
+```ruby
+# Authenticate with your Bugsnag account's auth token
+Bugsnag::Api.configure do |config|
+  config.auth_token = "your-account-api-token"
+end
+
+# Authenticate using your Bugsnag email address and password
+Bugsnag::Api.configure do |config|
+  config.email = "example@example.com"
+  config.password = "password"
+end
+```
+
+### Pagination
+
+Many Bugsnag API resources are paginated. While you may be tempted to start adding :page parameters to your calls, the API returns links to the next and previous pages for you in the `Link` response header, which we expose in `rels`:
+
+```ruby
+errors = Bugsnag::Api.errors("project-id", per_page: 100)
+errors.concat Bugsnag::Api.last_response.rels[:next].get.data
+```
+
+
+### Accessing HTTP responses
+
+While most methods return a `Resource` object or a `Boolean`, sometimes you may need access to the raw HTTP response headers. You can access the last HTTP response with `Client#last_response`:
+
+```ruby
+account   = Bugsnag::Api.account
+response  = Bugsnag::Api.last_response
+status    = response.headers[:status]
+```
+
+## API Methods
+
+### Account
+
+```ruby
+# List your accounts
+accounts = Bugsnag::Api.accounts
+
+# Get a single account
+account = Bugsnag::Api.account("account-id")
+
+# Get authenticated account (requires account auth)
+account = Bugsnag::Api.account
+```
+
+### Comments
+
+```ruby
+# List error comments
+comments = Bugsnag::Api.comments("error-id")
+
+# Get a single comment
+comment = Bugsnag::Api.comment("comment-id")
+
+# Create a comment
+comment = Bugsnag::Api.create_comment("error-id", "comment message")
+
+# Update a comment
+comment = Bugsnag::Api.update_comment("comment-id", "new comment message")
+
+# Delete a comment
+Bugsnag::Api.delete_comment("comment-id")
+```
+
+### Errors
+
+```ruby
+# List project errors
+errors = Bugsnag::Api.errors("project-id")
+
+# Get a single error
+error = Bugsnag::Api.error("error-id")
+
+# Resolve an error
+error = Bugsnag::Api.resolve_error("error-id")
+
+# Re-open an error
+error = Bugsnag::Api.reopen_error("error-id")
+
+# Update an error
+error = Bugsnag::Api.update_error("error-id", {
+  resolved: true
+})
+
+# Delete an error
+error = Bugsnag::Api.delete_error("error-id")
+```
+
+### Events
+
+```ruby
+# List project events
+events = Bugsnag::Api.events("project-id")
+
+# List error events
+events = Bugsnag::Api.error_events("error-id")
+
+# Get a single event
+event = Bugsnag::Api.event("event-id")
+
+# Delete an event
+Bugsnag::Api.delete_event("event-id")
+```
+
+### Projects
+
+```ruby
+# List account projects
+projects = Bugsnag::Api.projects("account-id")
+
+# List authenticated account's projects (requires account auth)
+projects = Bugsnag::Api.projects
+
+# List user projects
+projects = Bugsnag::Api.user_projects("user-id")
+
+# Get a single project
+project = Bugsnag::Api.project("project-id")
+
+# Create a project
+project = Bugsnag::Api.create_project("account-id", {
+  name: "Name",
+  type: "rails"
+})
+
+# Update a project
+project = Bugsnag::Api.update_project("project-id", {
+  name: "New Name"
+})
+
+# Delete a project
+Bugsnag::Api.delete_project("project-id")
+```
+
+### Users
+
+```ruby
+# List account users
+users = Bugsnag::Api.users("account-id")
+
+# List authenticated account's users (requires account auth)
+users = Bugsnag::Api.users
+
+# List project users
+users = Bugsnag::Api.project_users("project-id")
+
+# Get a single user
+user = Bugsnag::Api.user("user-id")
+
+# Get authenticated user (requires user auth)
+user = Bugsnag::Api.user
+
+# Invite a user to an account
+user = Bugsnag::Api.invite_user("account-id", "example@example.com", {
+  admin: true
+})
+
+# Update a user's account permissions
+user = Bugsnag::Api.update_user_permissions("account-id", "user-id", {
+  admin: false
+})
+
+# Remove a user from an account
+Bugsnag::Api.remove_user("account-id", "user-id")
+```
+
+
+## Advanced Configuration
+
+### Endpoint
+
+By default, `https://api.bugsnag.com` is used for API access, if you are using
+Bugsnag Enterprise, you can configure a custom endpoint.
+
+```ruby
+Bugsnag.Api.configure do |config|
+  config.endpoint = "http://api.bugsnag.example.com"
+end
+```
+
+### Proxy
+
+If you are using a proxy, you can configure the API client to use it.
+
+```ruby
+Bugsnag.Api.configure do |config|
+  config.proxy = {
+    uri:        "http://proxy.example.com",
+    user:       "foo",
+    password:   "bar"
+  }
+end
+```
+
+
+## Build Status
+
+![Build status](https://travis-ci.org/bugsnag/bugsnag-api-ruby.svg?branch=master)
 
 
 ## Contributing
@@ -58,3 +331,8 @@ Full documentation of available methods can be found here:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## License
+
+The Bugsnag API Toolkit for Ruby is free software released under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -1,10 +1,6 @@
 require "bundler/gem_tasks"
 
 # RSpec tasks
-require 'rspec/core'
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
+RSpec::Core::RakeTask.new(:spec)
 task :default  => :spec

data/bugsnag-api.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "faker"
-  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "vcr", "~> 2.9"
   spec.add_development_dependency "json"
 end

data/lib/bugsnag/api/configuration.rb

@@ -1,3 +1,4 @@
+require "bugsnag/api/version"
 require "bugsnag/api/response/raise_error"
 
 module Bugsnag

data/lib/bugsnag/api/version.rb

@@ -1,5 +1,5 @@
 module Bugsnag
   module Api
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - James Smith
@@ -98,16 +98,16 @@ dependencies:
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement