bugsnag-api 1.0.3 → 2.0.0

data/bugsnag-api.gemspec

@@ -18,13 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sawyer", '>= 0.5.3'
+  spec.add_dependency "sawyer", '~> 0.8.1'
 
   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 "webmock", RUBY_VERSION <= '2.0.0' ? '2.3.2': '>2.3.2'
+  spec.add_development_dependency "addressable", RUBY_VERSION <= '2.0.0' ? '2.3.6': '>2.3.6'
+  spec.add_development_dependency "faker", RUBY_VERSION <= '2.0.0' ? '1.3.0' : '>1.7.3'
   spec.add_development_dependency "vcr", "~> 2.9"
   spec.add_development_dependency "json"
 end

data/lib/bugsnag/api/client.rb

@@ -1,25 +1,33 @@
 require "sawyer"
 
-require "bugsnag/api/client/accounts"
-require "bugsnag/api/client/comments"
+require "bugsnag/api/client/organizations"
+require "bugsnag/api/client/collaborators"
+require "bugsnag/api/client/projects"
+require "bugsnag/api/client/eventfields"
+require "bugsnag/api/client/currentuser"
 require "bugsnag/api/client/errors"
 require "bugsnag/api/client/events"
-require "bugsnag/api/client/projects"
-require "bugsnag/api/client/users"
+require "bugsnag/api/client/pivots"
+require "bugsnag/api/client/trends"
+require "bugsnag/api/client/comments"
 
 module Bugsnag
   module Api
 
     # Client for the Bugsnag API
     #
-    # @see https://bugsnag.com/docs/api
+    # @see http://docs.bugsnagapiv2.apiary.io/
     class Client
-      include Bugsnag::Api::Client::Accounts
-      include Bugsnag::Api::Client::Comments
+      include Bugsnag::Api::Client::Organizations
+      include Bugsnag::Api::Client::Collaborators
+      include Bugsnag::Api::Client::Projects
+      include Bugsnag::Api::Client::EventFields
+      include Bugsnag::Api::Client::CurrentUser
       include Bugsnag::Api::Client::Errors
       include Bugsnag::Api::Client::Events
-      include Bugsnag::Api::Client::Projects
-      include Bugsnag::Api::Client::Users
+      include Bugsnag::Api::Client::Pivots
+      include Bugsnag::Api::Client::Trends
+      include Bugsnag::Api::Client::Comments
 
       # Header keys that can be passed in options hash to {#get},{#head}
       CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
@@ -140,6 +148,7 @@ module Bugsnag
       def agent
         @agent ||= Sawyer::Agent.new(configuration.endpoint, sawyer_options) do |http|
           http.headers[:content_type] = "application/json"
+          http.headers[:'X-Version'] = "2"
           http.headers[:user_agent] = configuration.user_agent
 
           if basic_authenticated?

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

@@ -0,0 +1,87 @@
+module Bugsnag
+  module Api
+    class Client
+
+      # Methods for the Organizations Collaborators API
+      #
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators
+      module Collaborators
+        # View a Collaborator
+        #
+        # @return [Sawyer::Resource] Collaborator
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators/view-a-collaborator
+        def collaborator(org_id, collaborator_id, options = {})
+          get "organizations/#{org_id}/collaborators/#{collaborator_id}", options
+        end
+
+        # List Collaborators
+        #
+        # @argument project_id [String] ID of project to get collaborators from (conflicts with org_id)
+        # @argument org_id [String] ID of organization to get collaborators from (conflicts with project_id)
+        #
+        # @option per_page [Number] Amount of results per-page             
+        # @return [Array<Sawyer::Resource>] List of Collaborators
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators/list-collaborators
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators/list-collaborators-on-a-project
+        def collaborators(org_id = nil, project_id = nil, options = {})
+          if !org_id.nil?
+            paginate "organizations/#{org_id}/collaborators", options
+          elsif !project_id.nil?
+            paginate "projects/#{project_id}/collaborators", options
+          else
+            raise ArgumentError, "Must supply either an org_id or a project_id"
+          end
+        end
+
+        # Invite Collaborators
+        #
+        # @argument emails [(Array<String>/String)] A (list of emails/singular email) to invite
+        #
+        # @option project_ids [Array<String>] The ids in the organization the user(s) should have access to
+        # @option admin [Boolean] Whether to give admin permissions. Admins have access to all projects
+        # @return [Array<Sawyer::Resource>] Collaborator details
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators/bulk-invite-collaborators
+        def invite_collaborators(org_id, emails, options = {})
+          case emails
+          when String
+            post "organizations/#{org_id}/collaborators", options.merge({:email => emails})
+          when Array
+            post "organizations/#{org_id}/collaborators/bulk_invite", options.merge({:emails => emails})
+          else
+            raise ArgumentError, "Emails must be a String or an Array"
+          end
+        end
+
+        # Update a Collaborator's permissions
+        #
+        # @option project_ids [Array<String>] Ids in the organziation the user should have access to
+        # @option admin [Boolean]  Whether to give admin permissions. Admins have access to all projects
+        # @return [Sawyer::Resource] Collaborator details
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators/update-a-collaborator's-permissions
+        def update_collaborator_permissions(org_id, id, options = {})
+          patch "organizations/#{org_id}/collaborators/#{id}", options
+        end
+
+        # Delete a Collaborator
+        #
+        # @return
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators/delete-a-collaborator
+        def delete_collaborator(org_id, id, options = {})
+          boolean_from_response :delete, "organizations/#{org_id}/collaborators/#{id}", options
+        end
+
+        # View Projects a Collaborator has access to
+        #
+        # @option sort [String] Which field to sort the results by.  Possible values: created_at
+        # @option direction [String] Which direction to sort the results by.  Possible values: asc, desc
+        # @option per_page [Number] Number of results per page
+        # @return [Array<Sawyer::Resource>] A list of projects the collaborator belongs to
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/collaborators/view-projects-a-collaborator-has-access-to
+        def view_collaborator_projects(org_id, id, options = {})
+          paginate "organizations/#{org_id}/collaborators/#{id}/projects", options
+        end
+      end
+    end
+  end
+end
+  

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

@@ -2,61 +2,52 @@ module Bugsnag
   module Api
     class Client
 
-      # Methods for the Comments API
+      # Methods for the Errors API
       #
-      # @see https://bugsnag.com/docs/api/comments
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/comments
       module Comments
-        # List an error's comments
+        # List Comments on an Error
         #
-        # @param error [String] Bugsnag error for which to list comments
-        # @return [Array<Sawyer::Resource>] List of comments
-        # @see https://bugsnag.com/docs/api/comments#list-an-error-s-comments
-        # @example
-        #   Bugsnag::Api.comments("515fb9337c1074f6fd000009")
-        def comments(error, options = {})
-          paginate "errors/#{error}/comments", options
+        # @option offset [Number] The pagination offset (not required for general use)
+        # @option sort [String] Comments are only sortable by creation time e.g. "created_at"
+        # @option direction [String] Which direction to sort the result by, one of: asc, desc
+        # @option per_page [Number] How many results to return per page
+        # @return [Array<Sawyer::Resource>] List of Error Comments
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/list-comments-on-an-error
+        def comments(project_id, error_id, options = {})
+          paginate "projects/#{project_id}/errors/#{error_id}/comments", options
         end
 
-        # Get a single comment
+        # View an Comment
         #
-        # @param comment [String] A Bugsnag comment ID
-        # @return [Sawyer::Resource] The comment you requested, if it exists
-        # @see https://bugsnag.com/docs/api/comments#get-comment-details
-        # @example
-        #   Bugsnag::Api.comment("50baed119bf39c1431000004")
-        def comment(comment, options = {})
-          get "comments/#{comment}", options
+        # @return [Sawyer::Resource] Requested Comment
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/view-a-comment
+        def comment(id, options = {})
+          get "comments/#{id}", options
         end
 
-        # Create a comment
+        # Create a Comment on an Error
         #
-        # @param error [String] The Bugsnag error to create the comment on
-        # @option message [String] The comment's message
-        # @see https://bugsnag.com/docs/api/comments#create-a-comment
-        # @example
-        #   Bugsnag::Api.create_comment("515fb9337c1074f6fd000009", message: "Oops!")
-        def create_comment(error, message, options = {})
-          post "errors/#{error}/comments", options.merge({:message => message})
+        # @return [Sawyer::Resource] The new Comment
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/create-a-comment-on-an-error
+        def create_comment(project_id, error_id, message, options = {})
+          post "projects/#{project_id}/errors/#{error_id}/comments", options.merge({:message => message})
         end
 
-        # Update a comment
+        # Update a Comment
         #
-        # @param error [String] The Bugsnag comment to update
-        # @return [Sawyer::Resource] The updated comment
-        # @see https://bugsnag.com/docs/api/comments#update-a-comment
-        # @example
-        #   Bugsnag::Api.update_comment("50baed119bf39c1431000004", message: "Fixed!")
-        def update_comment(comment, message, options = {})
-          patch "comments/#{comment}", options.merge({:message => message})
+        # @return [Sawyer::Resource] The updated Comment
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/update-a-comment
+        def update_comment(id, message, options = {})
+          patch "comments/#{id}", options.merge({:message => message})
         end
 
-        # Delete a comment
+        # Delete a Comment
         #
-        # @param comment [String] The Bugsnag comment to delete
-        # @return [Boolean] `true` if comment was deleted
-        # @see https://bugsnag.com/docs/api/comments#delete-a-comment
-        def delete_comment(comment, options = {})
-          boolean_from_response :delete, "comments/#{comment}", options
+        # @return 
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/delete-a-comment
+        def delete_comment(id, options = {})
+          boolean_from_response :delete, "comments/#{id}", options
         end
       end
     end

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

@@ -0,0 +1,33 @@
+module Bugsnag
+  module Api
+    class Client
+
+      # Methods for theCurrent User API
+      #
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/current-user
+      module CurrentUser
+        # List the Current User's Organizations
+        #
+        # @option admin [Boolean] If only Organizations the user is an admin of should be returned
+        # @option per_page [Number] Number of results to return per-page
+        # @return [Array<Sawyer::Resource>] List of Organizations
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/current-user/organizations/list-the-current-user's-organizations
+        def organizations(options = {})
+          paginate "user/organizations", options
+        end
+
+        # List the Current User's Projects
+        #
+        # @option sort [String] Which field to sort the results by, one of: created_at
+        # @option direction [String] Which direction to sort the results by, on of: asc, desc
+        # @option per_page [Number] Number of results to return per-page
+        # @return [Array<Sawyer::Resource>] List of Projects
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/current-user/organizations/list-the-current-user's-projects
+        def projects(org_id, options = {})
+          paginate "organizations/#{org_id}/projects", options
+        end
+      end
+    end
+  end
+end
+  

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

@@ -4,72 +4,66 @@ module Bugsnag
 
       # Methods for the Errors API
       #
-      # @see https://bugsnag.com/docs/api/errors
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors
       module Errors
-        # List a project's errors
+        # List the Errors on a Project
         #
-        # @param project [String] Bugsnag project for which to list errors
-        # @return [Array<Sawyer::Resource>] List of errors
-        # @see https://bugsnag.com/docs/api/errors#list-a-project-s-errors
-        # @example
-        #   Bugsnag::Api.errors("50baed119bf39c1431000004")
-        def errors(project, options = {})
-          paginate "projects/#{project}/errors", options
+        # @option base [String] Only Error Events occuring before this time will be returned
+        # @option sort [String] Which field to sort by, one of: last_seen, first_seen, users, events, unsorted
+        # @option direction [String] Which direction to sort the result by, one of: asc, desc
+        # @option filters [Filters] An optional filters object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
+        # @return [Array<Sawyer::Resource>] List of Project Errors
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/errors/list-the-errors-on-a-project
+        def errors(project_id, id=nil, options = {})
+          paginate "projects/#{project_id}/errors", options
         end
 
-        # Get a single error
+        # View an Error
         #
-        # @param error [String] A Bugsnag error
-        # @return [Sawyer::Resource] The error you requested, if it exists
-        # @see https://bugsnag.com/docs/api/errors#get-error-details
-        # @example
-        #   Bugsnag::Api.error("518031bcd775355c48a1cd4e")
-        def error(error, options = {})
-          get "errors/#{error}", options
+        # @return [Sawyer::Resource] Requested Error
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/errors/view-an-error
+        def error(project_id, id, options = {})
+          get "projects/#{project_id}/errors/#{id}", options
         end
 
-        # Resolve an error
+        # Update an Error
         #
-        # @param error [String] A Bugsnag error
-        # @return [Sawyer::Resource] The updated error
-        # @see https://bugsnag.com/docs/api/errors#update-an-error-s-status
-        # @example
-        #   Bugsnag::Api.resolve_error("518031bcd775355c48a1cd4e")
-        def resolve_error(error, options = {})
-          patch "errors/#{error}", options.merge({:resolved => true})
-        end
-
-        # Re-open an error
+        # @argument ids [(Array<String>/String)] An Id, or array of Ids to update
         #
-        # @param error [String] A Bugsnag error
-        # @return [Sawyer::Resource] The updated error
-        # @see https://bugsnag.com/docs/api/errors#update-an-error-s-status
-        # @example
-        #   Bugsnag::Api.reopen_error("518031bcd775355c48a1cd4e")
-        def reopen_error(error, options = {})
-          patch "errors/#{error}", options.merge({:resolved => false})
+        # @option severity [String] The Error's new severity. One of: info, warning, error
+        # @option assigned_collaborator_id [String] THe collaborator to assign to the Error
+        # @option issue_url [String] Updates to link to an existing 3rd party issue
+        # @option issue_title [String] Updates the issues title
+        # @option reopen_rules [Object] Snooze rules for automatically reopening the Error
+        # @return [Sawyer::Resource] Updated Error
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/errors/update-an-error
+        def update_errors(project_id, ids, operation, options = {})
+          case ids
+          when String
+            patch "projects/#{project_id}/errors/#{ids}", options.merge({:operation => operation})
+          when Array
+            patch "projects/#{project_id}/errors", options.merge({:operation => operation, :query => {:error_ids => ids.join(' ')}})
+          else
+            raise ArgumentError, "ids must be a String or an Array"
+          end
         end
 
-        # Update an error
+        # Delete an Error
         #
-        # @param error [String] A Bugsnag error
-        # @return [Sawyer::Resource] The updated error
-        # @see https://bugsnag.com/docs/api/errors#update-an-error-s-status
-        # @example
-        #   Bugsnag::Api.update_error("518031bcd775355c48a1cd4e")
-        def update_error(error, options = {})
-          patch "errors/#{error}", options
-        end
-
-        # Delete an error
+        # @argument error_id [String] ID of error to delete (conflicts with project_id)
+        # @argument project_id [String] Id of project to delete all errors from (conflicts with error_id)
         #
-        # @param error [String] A Bugsnag error
-        # @return [Boolean] `true` if error was deleted
-        # @see https://bugsnag.com/docs/api/errors#delete-an-error
-        def delete_error(error, options = {})
-          boolean_from_response :delete, "errors/#{error}", options
+        # @return 
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/errors/delete-an-error
+        def delete_errors(project_id, error_id=nil, options = {})
+          if !error_id.nil?
+            boolean_from_response :delete, "projects/#{project_id}/errors/#{error_id}", options
+          else
+            boolean_from_response :delete, "projects/#{project_id}/errors", options
+          end
         end
       end
     end
   end
 end
+  

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

@@ -0,0 +1,50 @@
+module Bugsnag
+  module Api
+    class Client
+
+      # Methods for the Project Event Fields API
+      #
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/event-fields
+      module EventFields
+        # List the Event Fields for a Project
+        #
+        # @option per_page []Number] Number of results required per page
+        # @return [Array<Sawyer::Resource>] List of event fields
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/event-fields/list-the-event-fields-for-a-project
+        def event_fields(project_id, options = {})
+          paginate "projects/#{project_id}/event_fields", options
+        end
+
+        # Create a custom Event Field
+        #
+        # @option reindex [Boolean] Whether to reindex historical events
+        # @option pivot_options [Object] Configuration for how this field will appear in pivots
+        # @return [Sawyer::Resource] New Event Field
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/event-fields/create-a-custom-event-field
+        def create_event_field(project_id, display_id, path, filter_options, options = {})
+          post "projects/#{project_id}/event_fields", options.merge({:display_id => display_id, :path => path, :filter_options => filter_options})
+        end
+
+        # Update a custom Event Field
+        #
+        # @option reindex [Boolean] Whether to reindex historical events
+        # @option filter_options [Object] Configuration for how the field will appear in the Filter Bar
+        # @option pivot_options [Object] Configuration for how this field will appear in pivots
+        # @return [Sawyer::Resource] Updated Event Field
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/event-fields/update-a-custom-event-field
+        def update_event_field(project_id, display_id, path, options = {})
+          patch "projects/#{id}/event_fields/#{display_id}", options.merge({:display_id => display_id, :path => path})
+        end
+
+        # Delete a custom Event Field
+        #
+        # @return 
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/event-fields/delete-a-custom-event-field
+        def delete_event_field(project_id, display_id, options = {})
+          boolean_from_resposne :delete, "project/#{project_id}/event_fields/#{display_id}", options
+        end
+      end
+    end
+  end
+end
+