bugsnag-api 1.0.3 → 2.0.0

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

@@ -4,51 +4,57 @@ module Bugsnag
 
       # Methods for the Events API
       #
-      # @see https://bugsnag.com/docs/api/events
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/events
       module Events
-        # List a project's events
+        # View an Event
         #
-        # @param project [String] Bugsnag project for which to list events
-        # @return [Array<Sawyer::Resource>] List of events
-        # @see https://bugsnag.com/docs/api/events#list-a-project-s-events
-        # @example
-        #   Bugsnag::Api.events("50baed119bf39c1431000004")
-        def events(project, options = {})
-          paginate "projects/#{project}/events", options
+        # @return [Sawyer::Resource] Requested Event
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/events/view-an-event
+        def event(project_id, id, options = {})
+          get "projects/#{project_id}/events/#{id}", options
         end
-        alias :project_events :events
 
-        # List an error's events
+        # Delete an Event
         #
-        # @param error [String] Bugsnag error for which to list events
-        # @return [Array<Sawyer::Resource>] List of events
-        # @see https://bugsnag.com/docs/api/events#list-an-error-s-events
-        # @example
-        #   Bugsnag::Api.error_events("518031bcd775355c48a1cd4e")
-        def error_events(error, options = {})
-          paginate "errors/#{error}/events", options
+        # @return 
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/events/delete-an-event
+        def delete_event(project_id, id, options = {})
+          boolean_from_response :delete, "projects/#{project_id}/events/#{id}", options
         end
 
-        # Get a single event
+        # List the Events on an Error
         #
-        # @param event [String] A Bugsnag event id
-        # @return [Sawyer::Resource] The event you requested, if it exists
-        # @see https://bugsnag.com/docs/api/events#get-event-details
-        # @example
-        #   Bugsnag::Api.event("51f5d152f002c6686d013a22")
-        def event(event, options = {})
-          get "events/#{event}", options
+        # @option base [String] Only Error Events occuring before this time will be returned
+        # @option sort [String] Which field to sort the results by, one of: last_seen, first_seen, users, events
+        # @option direction [String] Which direction to sort the results by, one of: asc, desc
+        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
+        # @return [Array<Sawyer::Resource>] List of Events for the specified Error
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/events/list-the-events-on-an-error
+        def error_events(project_id, error_id, options = {})
+          paginate "projects/#{project_id}/errors/#{error_id}/events", options
         end
 
-        # Delete an event
+        # View the latest Event on an Error
         #
-        # @param event [String] A Bugsnag event
-        # @return [Boolean] `true` if event was deleted
-        # @see https://bugsnag.com/docs/api/events#delete-an-event
-        def delete_event(event, options = {})
-          boolean_from_response :delete, "events/#{event}", options
+        # @return [Sawyer::Resource] Last event reported Event
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/events/view-the-latest-event-on-an-error
+        def latest_event(error_id, options = {})
+          get "errors/#{error_id}/latest_event", options
+        end
+
+        # List the Events on a Project
+        #
+        # @option base [String] Only Project Events occuring before this time will be returned
+        # @option sort [String] Which field to sort the results by, one of: last_seen, first_seen, users, events
+        # @option direction [String] Which direction to sort the results by, one of: asc, desc
+        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
+        # @return [Array<Sawyer::Resource>] List of Events for the specified Project
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/events/list-the-events-on-a-project
+        def events(project_id, options = {})
+          get "projects/#{project_id}/events", options
         end
       end
     end
   end
 end
+  

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

@@ -0,0 +1,46 @@
+module Bugsnag
+  module Api
+    class Client
+
+      # Methods for the Organizations API
+      #
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations
+      module Organizations
+        # Create an Organization
+        #
+        # @return [Sawyer::Resource] New Organization
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/organizations/create-an-organization
+        def create_organization(name, options = {})
+          post "organizations", options.merge({:name => name})
+        end
+
+        # View an Organization
+        #
+        # @return [Sawyer::Resource] Requested Organization
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/organizations/view-an-organization
+        def organization(id, options = {})
+          get "organizations/#{id}", options
+        end
+
+        # Update an Organization
+        #
+        # @option invoice_address [String] Additional information to print on your invoice
+        # @option billing_emails [Array<String>] List of billing emails
+        # @return [Sawyer::Resource] Updated Organization
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/organizations/update-an-organization
+        def update_organization(id, name, auto_upgrade, options = {})
+          patch "organizations/#{id}", options.merge({:name => name, :auto_upgrade => auto_upgrade})
+        end
+
+        # Delete an Organization
+        #
+        # @return 
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/organizations/delete-an-organization
+        def delete_organization(id, options = {})
+          boolean_from_response :delete, "organizations/#{id}", options
+        end
+      end
+    end
+  end
+end
+  

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

@@ -0,0 +1,43 @@
+module Bugsnag
+  module Api
+    class Client
+
+      # Methods for the Pivots API
+      #
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/pivots
+      module Pivots
+        # List Pivots on an Error
+        #
+        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
+        # @option summary_size [Number] The number of elements to include in the list
+        # @option pivots [Array] EventField display_ids to identify pivots to return
+        # @option per_page [Number] Number of results to be returned per page
+        # @return [Array<Sawyer::Resource>] List of Pivots for the Error specified
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/pivots/list-pivots-on-an-error
+        def pivots(project_id, error_id=nil, options = {})
+          if error_id.nil?
+            get "projects/#{project_id}/pivots", options
+          else
+            paginate "projects/#{project_id}/errors/#{error_id}/pivots", options
+          end
+        end
+
+        # List values of a Pivot on an Error
+        #
+        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
+        # @option sort [String] Sorting method
+        # @option base [String] Only Events occuring before this time will be used 
+        # @return [Array<Sawyer::Resource>] List of values for the Pivots requested
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/pivots/list-values-of-a-pivot-on-an-error
+        def pivot_values(project_id, ef_display_id, error_id=nil, options = {})
+          if error_id.nil?
+            paginate "projects/#{project_id}/pivots/#{ef_display_id}/values", options
+          else
+            paginate "projects/#{project_id}/errors/#{error_id}/pivots/#{ef_display_id}/values", options
+          end
+        end
+      end
+    end
+  end
+end
+  

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

@@ -4,85 +4,59 @@ module Bugsnag
 
       # Methods for the Projects API
       #
-      # @see https://bugsnag.com/docs/api/projects
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects
       module Projects
-        # List account projects
+        # Create a Project in an Organization
         #
-        # @param account [String] Bugsnag account for which to list projects
-        # @return [Array<Sawyer::Resource>] List of projects
-        # @see https://bugsnag.com/docs/api/projects#list-an-account-s-projects
-        # @example
-        #   Bugsnag::Api.projects("515fb9337c1074f6fd000009")
-        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
-
-        # List user projects
-        #
-        # @param account [String] Bugsnag user for which to list projects
-        # @return [Array<Sawyer::Resource>] List of projects
-        # @see https://bugsnag.com/docs/api/projects#list-a-user-s-projects
-        # @example
-        #   Bugsnag::Api.user_projects("515fb9337c1074f6fd000007")
-        def user_projects(user, options = {})
-          paginate "users/#{user}/projects", options
+        # @return [Sawyer::Resource] New Project
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/projects/create-a-project-in-an-organization
+        def create_project(org_id, name, type, options = {})
+          post "organizations/#{org_id}/projects", options.merge({:name => name, :type => type})
         end
 
-        # Get a single project
+        # View a Project
         #
-        # @param project [String] A Bugsnag project
-        # @return [Sawyer::Resource] The project you requested, if it exists
-        # @see https://bugsnag.com/docs/api/projects#get-project-details
-        # @example
-        #   Bugsnag::Api.project("50baed119bf39c1431000004")
-        def project(project, options = {})
-          get "projects/#{project}", options
+        # @return [Sawyer::Resource] Requested Project
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/projects/view-a-project
+        def project(id, options = {})
+          get "projects/#{id}", options
         end
 
-        # Create a project
+        # Update a Project
         #
-        # @param account [String] The Bugsnag account to create project on
-        # @option name [String] The project's name
-        # @option type [String] The type of the project
-        # @see https://bugsnag.com/docs/api/projects#create-a-project
-        # @example
-        #   Bugsnag::Api.create_project("515fb9337c1074f6fd000009", name: "Website")
-        def create_project(account, options = {})
-          post "accounts/#{account}/projects", options
+        # @option name [String] A name for the project
+        # @option global_grouping [Array<String>] A list of error classes, which will be grouped by class
+        # @option location_grouping [Array<String>] A list of error classes, which will be grouped by context
+        # @option discarded_app_versions [Array<String>] A list of app versions whose events will be ignored
+        # @option discarded_errors [Array<String>] A list of error classes that will be ignored
+        # @option url_whitelist [Array<String>] If configured only errors from whitelisted URLs will be processed
+        # @option ignore_old_browsers [Boolean] Set to ignore events from old web browsers
+        # @option ignored_browser_versions [Object] A mapping of browser name to ignored versions
+        # @option resolve_on_deploy [Boolean] Set all errors to resolved once a new deployment has been notified
+        # @option collaborator_ids [Array<String>] Update the collaborators in the project to only these ids
+        # @return [Sawyer::Resource] Updated Project
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/projects/update-a-project
+        def update_project(id, options = {})
+          patch "projects/#{id}", options
         end
 
-        # Update a project
+        # Regenerate a Project's notifier API key
         #
-        # @param project [String] A Bugsnag project
-        # @return [Sawyer::Resource] The updated project
-        # @see https://bugsnag.com/docs/api/projects#update-a-project
-        # @example
-        #   Bugsnag::Api.update_project("50baed119bf39c1431000004", name: "Dashboard")
-        def update_project(project, options = {})
-          patch "projects/#{project}", options
+        # @return 
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/projects/projects/regenerate-a-project's-notifier-api-key
+        def regenerate_api_key(id, options = {})
+          delete "projects/#{id}/api_key", options
         end
 
-        # Delete a project
+        # Delete a Project
         #
-        # @param project [String] A Bugsnag project
-        # @return [Boolean] `true` if project was deleted
-        # @see https://bugsnag.com/docs/api/projects#delete-a-project
-        def delete_project(project, options = {})
-          boolean_from_response :delete, "projects/#{project}", options
+        # @return 
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/organizations/organizations/delete-an-organization
+        def delete_project(id, options = {})
+          boolean_from_response :delete, "projects/#{id}", options
         end
       end
     end
   end
 end
+  

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

@@ -0,0 +1,38 @@
+module Bugsnag
+  module Api
+    class Client
+
+      # Methods for the Pivots API
+      #
+      # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/trends
+      module Trends
+        # List Trends for an Error in bucket form
+        #
+        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
+        # @return [Array<Sawyer::Resource>] List of Trends as requested
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/trends/list-the-trends-for-an-error-(buckets)
+        def trends_buckets(project_id, buckets_count, error_id=nil, options = {})
+          if !error_id.nil?
+            get "projects/#{project_id}/errors/#{error_id}/trend", options.merge({:query => {:buckets_count => buckets_count}})
+          else
+            get "projects/#{project_id}/trend", options.merge({:query => {:buckets_count => buckets_count}})
+          end
+        end
+
+        # List Trends for an Error in resolution form
+        #
+        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
+        # @return [Array<Sawyer::Resource>] List of Trends as requested
+        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/trends/list-the-trends-for-an-error-(buckets)
+        def trends_resolution(project_id, resolution, error_id=nil, options = {})
+          if !error_id.nil?
+            get "projects/#{project_id}/errors/#{error_id}/trend", options.merge({:query => {:resolution => resolution}})
+          else
+            get "projects/#{project_id}/trend", options.merge({:query => {:resolution => resolution}})
+          end
+        end
+      end
+    end
+  end
+end
+  

data/lib/bugsnag/api/error.rb

@@ -23,6 +23,7 @@ module Bugsnag
                     when 409      then Bugsnag::Api::Conflict
                     when 415      then Bugsnag::Api::UnsupportedMediaType
                     when 422      then Bugsnag::Api::UnprocessableEntity
+                    when 429      then Bugsnag::Api::RateLimitExceeded
                     when 400..499 then Bugsnag::Api::ClientError
                     when 500      then Bugsnag::Api::InternalServerError
                     when 501      then Bugsnag::Api::NotImplemented
@@ -102,6 +103,9 @@ module Bugsnag
     # Raised when Bugsnag returns a 422 HTTP status code
     class UnprocessableEntity < ClientError; end
 
+    # Raised when the api limit has been exceeded
+    class RateLimitExceeded < ClientError; end
+
     # Raised on errors in the 500-599 range
     class ServerError < Error; end
 

data/lib/bugsnag/api/version.rb

@@ -1,5 +1,5 @@
 module Bugsnag
   module Api
-    VERSION = "1.0.3"
+    VERSION = "2.0.0"
   end
 end

data/spec/bugsnag/api/client/collaborators_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+describe Bugsnag::Api::Client::Collaborators do
+  before do
+    @client = auth_token_client
+    @organization_id = test_bugsnag_org_id
+    @project_id = test_bugsnag_project_id
+    @collaborator_email = test_bugsnag_collaborator
+    @admin_email = test_bugsnag_email
+    Bugsnag::Api.reset!
+  end
+
+  describe ".invitecollaborator", :vcr do
+    it "creates and returns a collaborator" do
+      collaborator = @client.invite_collaborators @organization_id, @collaborator_email
+      expect(collaborator.email).to eq(@collaborator_email)
+
+      assert_requested :post, bugsnag_url("/organizations/#{@organization_id}/collaborators")
+    end
+    
+    it "invites multiple collaborators" do
+      collaborators = @client.invite_collaborators @organization_id, [@collaborator_email, @admin_email] 
+      expect(collaborators).to be_a_kind_of(Array)
+      expect(collaborators.length).to eq(2)
+
+      assert_requested :post, bugsnag_url("/organizations/#{@organization_id}/collaborators/bulk_invite")
+    end
+  end
+
+  context "given a collaborator exists", :vcr do
+    before do
+      @collaborator = @client.invite_collaborators @organization_id, @collaborator_email, {:project_ids => [@project_id]}
+    end
+
+    describe ".collaborator", :vcr do
+      it "returns a collaborator" do
+        collaborator = @client.collaborator @organization_id, @collaborator.id
+        expect(collaborator.id).to eq(@collaborator.id)
+        expect(collaborator.name).to eq(@collaborator.name)
+
+        assert_requested :get, bugsnag_url("/organizations/#{@organization_id}/collaborators/#{@collaborator.id}")
+      end
+    end
+
+    describe ".collaborators", :vcr do
+      it "returns a list of all organization collaborators" do
+        collaborators = @client.collaborators @organization_id
+        expect(collaborators).to be_a_kind_of(Array)
+        expect(collaborators.length).to be > 1
+    
+        assert_requested :get, bugsnag_url("/organizations/#{@organization_id}/collaborators")
+      end
+
+      it "returns a list of all project collaborators" do
+        collaborators = @client.collaborators(nil, @project_id)
+        expect(collaborators).to be_a_kind_of(Array)
+        expect(collaborators.length).to be > 1
+
+        assert_requested :get, bugsnag_url("/projects/#{@project_id}/collaborators")
+      end
+
+      it "throws an argument error if neither org_id or project_id are provided" do
+        begin
+          @client.collaborators
+        rescue Exception => ex
+          expect(ex).to be_a_kind_of(ArgumentError)
+        end
+      end
+    end
+
+    describe ".view_collaborator_projects", :vcr do
+      it "returns a list of projects belonging to the collaborator" do
+        projects = @client.view_collaborator_projects @organization_id, @collaborator.id
+        expect(projects).to be_a_kind_of(Array)
+        expect(projects.length).to be > 0
+
+        assert_requested :get, bugsnag_url("/organizations/#{@organization_id}/collaborators/#{@collaborator.id}/projects")
+      end
+    end
+
+    describe ".update_collaborator_permissions", :vcr do
+      it "updates and returns the collaborator" do
+        collaborator = @client.update_collaborator_permissions @organization_id, @collaborator.id, {:admin => true}
+        expect(collaborator.id).to eq(@collaborator.id)
+        expect(collaborator.is_admin).to be true
+
+        assert_requested :patch, bugsnag_url("/organizations/#{@organization_id}/collaborators/#{@collaborator.id}")
+      end
+    end
+
+    describe ".delete_collaborator", :vcr do
+      it "deletes a collaborator" do
+        stub_request(:delete, bugsnag_url("/organizations/#{@organization_id}/collaborators/#{@collaborator.id}")).to_return(:status => [204, "No Content"])
+        collaborator = @client.delete_collaborator @organization_id, @collaborator.id
+        expect(collaborator).to be true
+
+        assert_requested :delete, bugsnag_url("/organizations/#{@organization_id}/collaborators/#{@collaborator.id}")
+      end
+    end
+  end
+end