bugsnag-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f70dd5425512569c5778aa3a89d852326195967
-  data.tar.gz: 254567403bf2c32834d25a7b4c23696f33748467
+  metadata.gz: ae6a214efafc2a17097c3ce489c079d76205c098
+  data.tar.gz: 931212dfa15eeaedd848e7c7a4ef836690e7f777
 SHA512:
-  metadata.gz: 67c60e4aae21b293ad5b75b2cb60d26ba2774c43d512c49d3a140fd82b6f43d10de5739eec93ac7edceb481939bd86b1bdb80c92a952b5030f01e111ec6b1f29
-  data.tar.gz: 4b154b2bc908b61db969e19afc53a3f09f12a756d66292562d9d8a6a9fc9f2e7b60a0b1ac173404cb1d5099120dde7b41c5f0aadfa8641d771e247efefa4e357
+  metadata.gz: efbe6b07725c95659ac675856d9f59db7cdc851151c3606f1362aa36841d7924acf1403fb70061ea4c7fbe8a54732a574104456a736e01ca74be57d143d48ce9
+  data.tar.gz: 3a574921af5aaef6ca79cb04d0b646cc1f1f552c68ee5844d37d5d2fb0da874138fc21fcc9c3307d0b7d4e6c485a5717da0f813f0e3c41596c4f502949bfd5a2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3
+- jruby-18mode
+- jruby-19mode
+- 1.8.7

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--title=""
+--markup=markdown
+--exclude lib/bugsnag/api/response

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Changelog
+=========
+
+1.0.1
+-----
+-   Added test suite
+-   Fixed a few bugs
+
+1.0.0
+-----
+-   Initial release

data/README.md

@@ -1,7 +1,9 @@
-Bugsnag API Ruby Toolkit
-========================
+Bugsnag API Toolkit for Ruby
+============================
 
-The library allows for quick read-write access to the [Bugsnag API](https://bugsnag.com/docs/api) from Ruby applications. Use this library if you want to build your own applications which leverage data found in your Bugsnag dashboard. 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.
+The library allows for quick read/write access to the [Bugsnag API](https://bugsnag.com/docs/api) from your Ruby applications. You can use this library to build your own applications which leverage data found in your Bugsnag dashboard.
+
+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.
 
@@ -26,7 +28,7 @@ Or install it yourself as:
 ```ruby
 # Configure a Bugsnag API client
 Bugsnag::Api.configure do |config|
-  config.api_token = "your-account-api-token"
+  config.auth_token = "your-account-api-token"
 end
 
 # Fetch information about the authenticated account
@@ -43,6 +45,12 @@ errors = Bugsnag::Api.errors(projects.first.id)
 ```
 
 
+## Documentation
+
+Full documentation of available methods can be found here:
+<http://rubydoc.info/github/bugsnag/bugsnag-api-ruby>
+
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,10 @@
 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
+
+task :default  => :spec

data/bugsnag-api.gemspec

@@ -22,4 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  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 "json"
 end

data/lib/bugsnag/api.rb

@@ -4,18 +4,34 @@ require "bugsnag/api/error"
 require "bugsnag/api/version"
 
 module Bugsnag
+
+  # Static access to a Bugsnag API Client
   module Api
     class << self
-      def configure
-        yield(configuration) if block_given?
+      # Set configuration options using a block
+      def configure(&block)
+        client.configure(&block) if block_given?
       end
 
+      # Get the static client's configuration options
+      #
+      # @return [Bugsnag::Api::Configuration] configuration wrapper
       def configuration
-        @configuration ||= Bugsnag::Api::Configuration.new
+        client.configuration
       end
 
+      # Get the static API client
+      #
+      # @return [Bugsnag::Api::Client] API client
       def client
-        @client ||= Bugsnag::Api::Client.new(configuration)
+        @client ||= Bugsnag::Api::Client.new
+      end
+
+      # Reset the static API client
+      #
+      # @return [Bugsnag::Api::Client] API client
+      def reset!
+        @client = nil
       end
 
 

data/lib/bugsnag/api/client.rb

@@ -24,14 +24,20 @@ module Bugsnag
       # Header keys that can be passed in options hash to {#get},{#head}
       CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
 
-      def initialize(options = {})
-        if options.is_a?(Bugsnag::Api::Configuration)
-          @configuration = options
-        else
-          configuration.load(options)
-        end
+      def initialize(options = {}, &block)
+        configuration.load(options)
+        yield(configuration) if block_given?
+      end
+
+      # Set configuration options using a block
+      def configure
+        yield(configuration) if block_given?
+        reset_agent
       end
 
+      # Get client's configuration options
+      #
+      # @return [Bugsnag::Api::Configuration] configuration wrapper
       def configuration
         @configuration ||= Configuration.new
       end
@@ -54,15 +60,6 @@ module Bugsnag
         request :post, url, options
       end
 
-      # Make a HTTP PUT request
-      #
-      # @param url [String] The path, relative to {#endpoint}
-      # @param options [Hash] Body and header params for request
-      # @return [Sawyer::Resource]
-      def put(url, options = {})
-        request :put, url, options
-      end
-
       # Make a HTTP PATCH request
       #
       # @param url [String] The path, relative to {#endpoint}
@@ -81,15 +78,6 @@ module Bugsnag
         request :delete, url, options
       end
 
-      # Make a HTTP HEAD request
-      #
-      # @param url [String] The path, relative to {#endpoint}
-      # @param options [Hash] Query and header params for request
-      # @return [Sawyer::Resource]
-      def head(url, options = {})
-        request :head, url, parse_query_and_convenience_headers(options)
-      end
-
       # Make one or more HTTP GET requests, optionally fetching
       # the next page of results from URL in Link response header based
       # on value in {#auto_paginate}.
@@ -123,22 +111,6 @@ module Bugsnag
         data
       end
 
-      # Hypermedia agent for the Bugsnag API
-      #
-      # @return [Sawyer::Agent]
-      def agent
-        @agent ||= Sawyer::Agent.new(configuration.endpoint, sawyer_options) do |http|
-          http.headers[:content_type] = "application/json"
-          http.headers[:user_agent] = configuration.user_agent
-
-          if basic_authenticated?
-            http.basic_auth configuration.email, configuration.password
-          elsif token_authenticated?
-            http.authorization "token", configuration.api_token
-          end
-        end
-      end
-
       # Response for last HTTP request
       #
       # @return [Sawyer::Response]
@@ -146,16 +118,42 @@ module Bugsnag
         @last_response if defined? @last_response
       end
 
+      # Indicates if the client was supplied Basic Auth
+      # username and password
+      #
+      # @see https://bugsnag.com/docs/api#user-authentication
+      # @return [Boolean]
       def basic_authenticated?
         !!(configuration.email && configuration.password)
       end
 
+      # Indicates if the client was supplied an auth token
+      #
+      # @see https://bugsnag.com/docs/api#account-authentication
+      # @return [Boolean]
       def token_authenticated?
-        !!configuration.api_token
+        !!configuration.auth_token
       end
 
 
       private
+      def agent
+        @agent ||= Sawyer::Agent.new(configuration.endpoint, sawyer_options) do |http|
+          http.headers[:content_type] = "application/json"
+          http.headers[:user_agent] = configuration.user_agent
+
+          if basic_authenticated?
+            http.basic_auth configuration.email, configuration.password
+          elsif token_authenticated?
+            http.authorization "token", configuration.auth_token
+          end
+        end
+      end
+
+      def reset_agent
+        @agent = nil
+      end
+
       def request(method, path, data, options = {})
         if data.is_a?(Hash)
           options[:query]   = data.delete(:query) || {}
@@ -165,10 +163,17 @@ module Bugsnag
           end
         end
 
-        @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+        @last_response = response = agent.call(method, URI.escape(path.to_s), data, options)
         response.data
       end
 
+      def boolean_from_response(method, path, options = {})
+        request(method, path, options)
+        @last_response.status == 204
+      rescue Bugsnag::Api::NotFound
+        false
+      end
+
       def sawyer_options
         opts = {
           :links_parser => Sawyer::LinkParsers::Simple.new

data/lib/bugsnag/api/client/accounts.rb

@@ -25,7 +25,14 @@ module Bugsnag
         # @example
         #   Bugsnag::Api.account("515fb9337c1074f6fd000009")
         def account(account=nil, options = {})
-          if account.nil?
+          if account.nil? || account.is_a?(Hash)
+            options = account || {}
+
+            raise Bugsnag::Api::AccountCredentialsRequired.new(
+              "Fetching account without an id is only possible when using "\
+              "an account auth token."
+            ) unless token_authenticated?
+
             get "account", options
           else
             get "accounts/#{account}", options

data/lib/bugsnag/api/client/comments.rb

@@ -56,7 +56,7 @@ module Bugsnag
         # @return [Boolean] `true` if comment was deleted
         # @see https://bugsnag.com/docs/api/comments#delete-a-comment
         def delete_comment(comment, options = {})
-          delete "comments/#{comment}", options
+          boolean_from_response :delete, "comments/#{comment}", options
         end
       end
     end

data/lib/bugsnag/api/client/errors.rb

@@ -67,7 +67,7 @@ module Bugsnag
         # @return [Boolean] `true` if error was deleted
         # @see https://bugsnag.com/docs/api/errors#delete-an-error
         def delete_error(error, options = {})
-          delete "errors/#{error}", options
+          boolean_from_response :delete, "errors/#{error}", options
         end
       end
     end

data/lib/bugsnag/api/client/events.rb

@@ -26,7 +26,7 @@ module Bugsnag
         # @example
         #   Bugsnag::Api.error_events("518031bcd775355c48a1cd4e")
         def error_events(error, options = {})
-          paginate "error/#{error}/events", options
+          paginate "errors/#{error}/events", options
         end
 
         # Get a single event
@@ -36,7 +36,7 @@ module Bugsnag
         # @see https://bugsnag.com/docs/api/events#get-event-details
         # @example
         #   Bugsnag::Api.event("51f5d152f002c6686d013a22")
-        def event(error, options = {})
+        def event(event, options = {})
           get "events/#{event}", options
         end
 
@@ -46,7 +46,7 @@ module Bugsnag
         # @return [Boolean] `true` if event was deleted
         # @see https://bugsnag.com/docs/api/events#delete-an-event
         def delete_event(event, options = {})
-          delete "events/#{event}", options
+          boolean_from_response :delete, "events/#{event}", options
         end
       end
     end

data/lib/bugsnag/api/client/projects.rb

@@ -13,8 +13,19 @@ module Bugsnag
         # @see https://bugsnag.com/docs/api/projects#list-an-account-s-projects
         # @example
         #   Bugsnag::Api.projects("515fb9337c1074f6fd000009")
-        def projects(account, options = {})
-          paginate "accounts/#{account}/projects", options
+        def projects(account=nil, options = {})
+          if account.nil? || account.is_a?(Hash)
+            options = account || {}
+
+            raise Bugsnag::Api::AccountCredentialsRequired.new(
+              "Fetching projects without an account id is only possible when "\
+              "using an account auth token."
+            ) unless token_authenticated?
+
+            paginate "account/projects", options
+          else
+            paginate "accounts/#{account}/projects", options
+          end
         end
         alias :account_projects :projects
 
@@ -26,7 +37,7 @@ module Bugsnag
         # @example
         #   Bugsnag::Api.user_projects("515fb9337c1074f6fd000007")
         def user_projects(user, options = {})
-          paginate "user/#{user}/projects", options
+          paginate "users/#{user}/projects", options
         end
 
         # Get a single project
@@ -69,7 +80,7 @@ module Bugsnag
         # @return [Boolean] `true` if project was deleted
         # @see https://bugsnag.com/docs/api/projects#delete-a-project
         def delete_project(project, options = {})
-          delete "projects/#{project}", options
+          boolean_from_response :delete, "projects/#{project}", options
         end
       end
     end

data/lib/bugsnag/api/client/users.rb

@@ -11,8 +11,19 @@ module Bugsnag
         # @param account [String] Bugsnag account for which to list users
         # @return [Array<Sawyer::Resource>] List of users
         # @see https://bugsnag.com/docs/api/users#list-an-account-s-users
-        def users(account, options = {})
-          paginate "accounts/#{account}/users", options
+        def users(account=nil, options = {})
+          if account.nil? || account.is_a?(Hash)
+            options = account || {}
+
+            raise Bugsnag::Api::AccountCredentialsRequired.new(
+              "Fetching users without an account id is only possible when "\
+              "using an account auth token."
+            ) unless token_authenticated?
+
+            paginate "account/users", options
+          else
+            paginate "accounts/#{account}/users", options
+          end
         end
         alias :account_users :users
 
@@ -34,7 +45,14 @@ module Bugsnag
         # @example
         #   Bugsnag::Api.user("515fb9337c1074f6fd000007")
         def user(user=nil, options = {})
-          if user.nil?
+          if user.nil? || user.is_a?(Hash)
+            options = user || {}
+
+            raise Bugsnag::Api::UserCredentialsRequired.new(
+              "Fetching user without an id is only possible when using "\
+              "user auth credentials."
+            ) unless basic_authenticated?
+
             get "user", options
           else
             get "users/#{user}", options
@@ -73,7 +91,7 @@ module Bugsnag
         # @example
         #   Bugsnag::Api.remove_user("515fb9337c1074f6fd000009", "515fb9337c1074f6fd000007")
         def remove_user(account, user, options = {})
-          delete "accounts/#{account}/users/#{user}", options
+          boolean_from_response :delete, "accounts/#{account}/users/#{user}", options
         end
       end
     end

data/lib/bugsnag/api/configuration.rb

@@ -5,7 +5,6 @@ module Bugsnag
 
     # Configuration storage and defaults for {Client}
     class Configuration
-
       # Default API endpoint
       DEFAULT_ENDPOINT = "https://api.bugsnag.com"
 
@@ -22,12 +21,14 @@ module Bugsnag
       end
 
       # Configuration options
-      attr_accessor :email, :password, :api_token, :endpoint, :user_agent,
-                    :proxy, :middleware, :connection_options, :auto_paginate,
-                    :per_page
+      KEYS = [:email, :password, :auth_token, :endpoint, :user_agent,
+              :proxy, :middleware, :connection_options, :auto_paginate,
+              :per_page]
+
+      attr_accessor *KEYS
 
       # Set up configuration defaults
-      def initialize
+      def initialize(options = {})
         @endpoint = DEFAULT_ENDPOINT
         @user_agent = DEFAULT_USER_AGENT
         @middleware = DEFAULT_MIDDLEWARE
@@ -37,11 +38,13 @@ module Bugsnag
             :user_agent => DEFAULT_USER_AGENT
           }
         }
+
+        load(options)
       end
 
       # Load configuration from hash
       def load(options = {})
-        options.each {|k,v| self.send("#{k}=", v) if self.respond_to?("#{k}=")}
+        options.each {|k,v| self.send("#{k}=", v) if self.respond_to?("#{k}=") && !v.nil?}
       end
     end
   end