bugsnag-api 2.0.0 → 2.1.0

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

@@ -26,7 +26,7 @@ module Bugsnag
         #
         # @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 
+        # @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 = {})
@@ -40,4 +40,3 @@ module Bugsnag
     end
   end
 end
-  

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

@@ -42,7 +42,7 @@ module Bugsnag
 
         # Regenerate a Project's notifier API key
         #
-        # @return 
+        # @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
@@ -50,7 +50,7 @@ module Bugsnag
 
         # Delete a Project
         #
-        # @return 
+        # @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
@@ -59,4 +59,3 @@ module Bugsnag
     end
   end
 end
-  

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

@@ -0,0 +1,38 @@
+module Bugsnag
+  module Api
+    class Client
+      # Methods for the Releases API
+      module Releases
+        # List the Releases in a Project
+        #
+        # @option release_stage [String] Only Releases with this release stage will be returned
+        # @option base [String] Only Releases created before this time will be returned
+        # @option sort [String] How to sort the results, one of: timestamp, percent_of_sessions
+        # @option offset [Number] The pagination offset
+        # @option per_page [Number] The number of results to return per page
+        # @return [Array<Sawyer::Resource>] List of Events for the specified Error
+        # @see https://bugsnagapiv2.docs.apiary.io/#reference/projects/releases/list-releases-on-a-project
+        def releases(project_id, options = {})
+          get "projects/#{project_id}/releases", options
+        end
+
+        # View a single Release
+        #
+        # @see https://bugsnagapiv2.docs.apiary.io/#reference/projects/releases/view-a-release
+        def release(project_id, release_id, options = {})
+          get "projects/#{project_id}/releases/#{release_id}", options
+        end
+
+        # List the Releases in a Release Group
+        #
+        # @option per_page [Number] The number of results to return per page
+        # @option page_token [String] Value from the next relation in the Link response header to obtain the next page of results
+        # @return [Array<Sawyer::Resource>] List of Releases for the specified Release Group
+        # @see https://bugsnagapiv2.docs.apiary.io/#reference/projects/releases/list-releases-on-a-release-group
+        def releases_in_group(release_group_id, options = {})
+          get "release_groups/#{release_group_id}/releases", options
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Bugsnag
+  module Api
+    class Client
+      # Methods for the Stability API
+      module Stability
+        # View the stability trend for a project
+        #
+        # @return [Sawyer::Resource] Stability trend
+        # @see https://bugsnagapiv2.docs.apiary.io/#reference/projects/stability-trend/view-the-stability-trend-for-a-project
+        def stability_trend(id, options = {})
+          get "projects/#{id}/stability_trend", options
+        end
+      end
+    end
+  end
+end

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

@@ -12,10 +12,12 @@ module Bugsnag
         # @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 = {})
+          defaults = {:query => {:buckets_count => buckets_count}}
+          merged_opts = deep_merge(defaults, options)
           if !error_id.nil?
-            get "projects/#{project_id}/errors/#{error_id}/trend", options.merge({:query => {:buckets_count => buckets_count}})
+            get "projects/#{project_id}/errors/#{error_id}/trend", merged_opts
           else
-            get "projects/#{project_id}/trend", options.merge({:query => {:buckets_count => buckets_count}})
+            get "projects/#{project_id}/trend", merged_opts
           end
         end
 
@@ -25,14 +27,15 @@ module Bugsnag
         # @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 = {})
+          defaults = {:query => {:resolution => resolution}}
+          merged_opts = deep_merge(defaults, options)
           if !error_id.nil?
-            get "projects/#{project_id}/errors/#{error_id}/trend", options.merge({:query => {:resolution => resolution}})
+            get "projects/#{project_id}/errors/#{error_id}/trend", merged_opts
           else
-            get "projects/#{project_id}/trend", options.merge({:query => {:resolution => resolution}})
+            get "projects/#{project_id}/trend", merged_opts
           end
         end
       end
     end
   end
 end
-  

data/lib/bugsnag/api/configuration.rb

@@ -45,7 +45,7 @@ module Bugsnag
 
       # Load configuration from hash
       def load(options = {})
-        options.each {|k,v| self.send("#{k}=", v) if self.respond_to?("#{k}=") && !v.nil?}
+        options.each { |k,v| self.send("#{k}=", v) if self.respond_to?("#{k}=") && !v.nil?}
       end
     end
   end

data/lib/bugsnag/api/error.rb

@@ -3,7 +3,7 @@ module Bugsnag
     # Custom error class for rescuing from all Bugsnag API errors
     class Error < StandardError
 
-      # Returns the appropriate Bugnsag::Api::Error subclass based
+      # Returns the appropriate Bugsnag::Api::Error subclass based
       # on status and response message
       #
       # @param [Hash] response HTTP response

data/lib/bugsnag/api/response/raise_error.rb

@@ -9,8 +9,6 @@ module Bugsnag
       # This class raises an Bugsnag-flavored exception based
       # HTTP status codes returned by the API
       class RaiseError < Faraday::Response::Middleware
-
-        private
         def on_complete(response)
           if error = Bugsnag::Api::Error.from_response(response)
             raise error

data/lib/bugsnag/api/version.rb

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

data/scripts/license_finder.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+curl https://raw.githubusercontent.com/bugsnag/license-audit/master/config/decision_files/global.yml -o config/global.yml
+bundle install
+license_finder --decisions-file=config/global.yml

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

@@ -0,0 +1,184 @@
+require "spec_helper"
+
+describe Bugsnag::Api::Client::Releases do
+  before do
+    @client = auth_token_client
+    @project_id = test_bugsnag_project_id
+    @release_id = test_bugsnag_release_id
+    @release_group_id = test_bugsnag_release_group_id
+
+    Bugsnag::Api.reset!
+  end
+
+  describe ".releases", :vcr do
+    it "gets as list of releases" do
+      releases = @client.releases(@project_id)
+
+      expect(releases).to be_an_instance_of(Array)
+
+      releases.map!(&:to_h)
+
+      expect(releases.first[:id]).to eq(@release_id)
+      expect(releases.first[:project_id]).to eq(@project_id)
+      expect(releases.first[:release_group_id]).to eq(@release_group_id)
+
+      expect(releases).to all have_key(:id)
+      expect(releases).to all have_key(:project_id)
+      expect(releases).to all have_key(:release_group_id)
+      expect(releases).to all have_key(:release_time)
+      expect(releases).to all have_key(:release_source)
+      expect(releases).to all have_key(:app_version)
+      expect(releases).to all have_key(:app_version_code)
+      expect(releases).to all have_key(:app_bundle_version)
+      expect(releases).to all have_key(:build_label)
+      expect(releases).to all have_key(:builder_name)
+      expect(releases).to all have_key(:build_tool)
+      expect(releases).to all have_key(:errors_introduced_count)
+      expect(releases).to all have_key(:errors_seen_count)
+      expect(releases).to all have_key(:sessions_count_in_last_24h)
+      expect(releases).to all have_key(:total_sessions_count)
+      expect(releases).to all have_key(:unhandled_sessions_count)
+      expect(releases).to all have_key(:accumulative_daily_users_seen)
+      expect(releases).to all have_key(:accumulative_daily_users_with_unhandled)
+      expect(releases).to all have_key(:metadata)
+      expect(releases).to all have_key(:release_stage)
+    end
+
+    it "accepts parameters" do
+      releases = @client.releases(
+        @project_id,
+        {
+          release_stage: 'development',
+          base: '2021-07-21T12:00:00Z',
+          sort: 'percent_of_sessions',
+          offset: 0,
+          per_page: 1
+        }
+      )
+
+      expect(releases).to be_an_instance_of(Array)
+
+      releases.map!(&:to_h)
+
+      expect(releases.first[:id]).to eq(@release_id)
+      expect(releases.first[:project_id]).to eq(@project_id)
+      expect(releases.first[:release_group_id]).to eq(@release_group_id)
+
+      expect(releases).to all have_key(:id)
+      expect(releases).to all have_key(:project_id)
+      expect(releases).to all have_key(:release_group_id)
+      expect(releases).to all have_key(:release_time)
+      expect(releases).to all have_key(:release_source)
+      expect(releases).to all have_key(:app_version)
+      expect(releases).to all have_key(:app_version_code)
+      expect(releases).to all have_key(:app_bundle_version)
+      expect(releases).to all have_key(:build_label)
+      expect(releases).to all have_key(:builder_name)
+      expect(releases).to all have_key(:build_tool)
+      expect(releases).to all have_key(:errors_introduced_count)
+      expect(releases).to all have_key(:errors_seen_count)
+      expect(releases).to all have_key(:sessions_count_in_last_24h)
+      expect(releases).to all have_key(:total_sessions_count)
+      expect(releases).to all have_key(:unhandled_sessions_count)
+      expect(releases).to all have_key(:accumulative_daily_users_seen)
+      expect(releases).to all have_key(:accumulative_daily_users_with_unhandled)
+      expect(releases).to all have_key(:metadata)
+      expect(releases).to all have_key(:release_stage)
+    end
+  end
+
+  describe ".release", :vcr do
+    it "gets a single release" do
+      release = @client.release(@project_id, @release_id)
+
+      expect(release.id).to eq(@release_id)
+      expect(release.project_id).to eq(@project_id)
+      expect(release.release_group_id).to eq(@release_group_id)
+      expect(release.release_time).not_to be_nil
+      expect(release.release_source).not_to be_nil
+      expect(release.app_version).not_to be_nil
+      expect(release.app_version_code).not_to be_nil
+      expect(release.app_bundle_version).not_to be_nil
+      expect(release.build_label).not_to be_nil
+      expect(release.builder_name).not_to be_nil
+      expect(release.build_tool).not_to be_nil
+      expect(release.errors_introduced_count).not_to be_nil
+      expect(release.errors_seen_count).not_to be_nil
+      expect(release.sessions_count_in_last_24h).not_to be_nil
+      expect(release.total_sessions_count).not_to be_nil
+      expect(release.unhandled_sessions_count).not_to be_nil
+      expect(release.accumulative_daily_users_seen).not_to be_nil
+      expect(release.accumulative_daily_users_with_unhandled).not_to be_nil
+      expect(release.metadata).not_to be_nil
+      expect(release.release_stage).not_to be_nil
+    end
+  end
+
+  describe ".release_groups", :vcr do
+    it "gets releases in a release group" do
+      releases = @client.releases_in_group(@release_group_id)
+
+      expect(releases).to be_an_instance_of(Array)
+
+      releases.map!(&:to_h)
+
+      expect(releases.first[:id]).to eq(@release_id)
+      expect(releases.first[:project_id]).to eq(@project_id)
+      expect(releases.first[:release_group_id]).to eq(@release_group_id)
+
+      expect(releases).to all have_key(:id)
+      expect(releases).to all have_key(:project_id)
+      expect(releases).to all have_key(:release_group_id)
+      expect(releases).to all have_key(:release_time)
+      expect(releases).to all have_key(:release_source)
+      expect(releases).to all have_key(:app_version)
+      expect(releases).to all have_key(:app_version_code)
+      expect(releases).to all have_key(:app_bundle_version)
+      expect(releases).to all have_key(:build_label)
+      expect(releases).to all have_key(:builder_name)
+      expect(releases).to all have_key(:build_tool)
+      expect(releases).to all have_key(:errors_introduced_count)
+      expect(releases).to all have_key(:errors_seen_count)
+      expect(releases).to all have_key(:sessions_count_in_last_24h)
+      expect(releases).to all have_key(:total_sessions_count)
+      expect(releases).to all have_key(:unhandled_sessions_count)
+      expect(releases).to all have_key(:accumulative_daily_users_seen)
+      expect(releases).to all have_key(:accumulative_daily_users_with_unhandled)
+      expect(releases).to all have_key(:metadata)
+      expect(releases).to all have_key(:release_stage)
+    end
+
+    it "accepts parameters" do
+      releases = @client.releases_in_group(@release_group_id, { per_page: 1 })
+
+      expect(releases).to be_an_instance_of(Array)
+
+      releases.map!(&:to_h)
+
+      expect(releases.first[:id]).to eq(@release_id)
+      expect(releases.first[:project_id]).to eq(@project_id)
+      expect(releases.first[:release_group_id]).to eq(@release_group_id)
+
+      expect(releases).to all have_key(:id)
+      expect(releases).to all have_key(:project_id)
+      expect(releases).to all have_key(:release_group_id)
+      expect(releases).to all have_key(:release_time)
+      expect(releases).to all have_key(:release_source)
+      expect(releases).to all have_key(:app_version)
+      expect(releases).to all have_key(:app_version_code)
+      expect(releases).to all have_key(:app_bundle_version)
+      expect(releases).to all have_key(:build_label)
+      expect(releases).to all have_key(:builder_name)
+      expect(releases).to all have_key(:build_tool)
+      expect(releases).to all have_key(:errors_introduced_count)
+      expect(releases).to all have_key(:errors_seen_count)
+      expect(releases).to all have_key(:sessions_count_in_last_24h)
+      expect(releases).to all have_key(:total_sessions_count)
+      expect(releases).to all have_key(:unhandled_sessions_count)
+      expect(releases).to all have_key(:accumulative_daily_users_seen)
+      expect(releases).to all have_key(:accumulative_daily_users_with_unhandled)
+      expect(releases).to all have_key(:metadata)
+      expect(releases).to all have_key(:release_stage)
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Bugsnag::Api::Client::Stability do
+  before do
+    @client = auth_token_client
+    @project_id = test_bugsnag_project_id
+
+    Bugsnag::Api.reset!
+  end
+
+  describe ".stability_trend", :vcr do
+    it "gets the stability trend" do
+      stability_trend = @client.stability_trend(@project_id)
+
+      expect(stability_trend.project_id).to eq(@project_id)
+      expect(stability_trend.release_stage_name).not_to be_nil
+      expect(stability_trend.timeline_points).to be_an_instance_of(Array)
+
+      # convert each "Sawyer::Resource" to a hash so we can use the "have_key" matcher
+      timeline_points = stability_trend.timeline_points.map(&:to_h)
+
+      expect(timeline_points).to all have_key(:bucket_start)
+      expect(timeline_points).to all have_key(:bucket_end)
+      expect(timeline_points).to all have_key(:total_sessions_count)
+      expect(timeline_points).to all have_key(:unhandled_sessions_count)
+      expect(timeline_points).to all have_key(:users_seen)
+      expect(timeline_points).to all have_key(:users_with_unhandled)
+
+      assert_requested(:get, bugsnag_url("/projects/#{@project_id}/stability_trend"))
+    end
+  end
+end

data/spec/bugsnag/api/client_spec.rb

@@ -1,3 +1,4 @@
+require "spec_helper"
 require "json"
 
 describe Bugsnag::Api::Client do
@@ -45,7 +46,7 @@ describe Bugsnag::Api::Client do
 
     it "handles query params", :vcr do
       Bugsnag::Api.get bugsnag_url("/"), :foo => "bar"
-      assert_requested :get, "https://api.bugsnag.com?foo=bar"
+      assert_requested :get, bugsnag_url("?foo=bar")
     end
 
     it "handles headers" do
@@ -81,20 +82,81 @@ describe Bugsnag::Api::Client do
     end
   end
 
+  describe ".deep_merge" do
+    it "returns a merged hash" do
+      client = Bugsnag::Api::Client.new(:auth_token => "example")
+      lhs = {
+        :foo => "foo"
+      }
+      rhs = {
+        :bar => "bar"
+      }
+      merged = client.deep_merge(lhs, rhs)
+      expect(merged).to_not eq(lhs)
+      expect(merged).to_not eq(rhs)
+      expect(merged).to eq({
+        :foo => "foo",
+        :bar => "bar"
+      })
+    end
+
+    it "favors rhs over lhs" do
+      client = Bugsnag::Api::Client.new(:auth_token => "example")
+      lhs = {
+        :foo => "foo"
+      }
+      rhs = {
+        :foo => "bar"
+      }
+      merged = client.deep_merge(lhs, rhs)
+      expect(merged).to eq({:foo => "bar"})
+    end
+
+    it "recursively merges hashes" do
+      client = Bugsnag::Api::Client.new(:auth_token => "example")
+      lhs = {
+        :foo => {
+          :bar => "bar"
+        }
+      }
+      rhs = {
+        :foo => {
+          :foobar => "foobar"
+        }
+      }
+      merged = client.deep_merge(lhs, rhs)
+      expect(merged).to eq(
+        {:foo => {
+          :bar => "bar",
+          :foobar => "foobar"
+        }
+      })
+    end
+  end
+
   context "error handling" do
+
+    before do
+      VCR.turn_off!
+    end
+
+    after do
+      VCR.turn_on!
+    end
+
     it "raises on 404" do
       stub_get('/booya').to_return(:status => 404)
-      expect { Bugsnag::Api.get('/booya') }.to raise_error(Bugsnag::Api::NotFound)
+      expect { Bugsnag::Api.get(bugsnag_url('/booya')) }.to raise_error(Bugsnag::Api::NotFound)
     end
 
     it "raises on 429" do
       stub_get('/test').to_return(:status => 429)
-      expect { Bugsnag::Api.get('/test') }.to raise_error(Bugsnag::Api::RateLimitExceeded)
+      expect { Bugsnag::Api.get(bugsnag_url('/test')) }.to raise_error(Bugsnag::Api::RateLimitExceeded)
     end
 
     it "raises on 500" do
       stub_get('/boom').to_return(:status => 500)
-      expect { Bugsnag::Api.get('/boom') }.to raise_error(Bugsnag::Api::InternalServerError)
+      expect { Bugsnag::Api.get(bugsnag_url('/boom')) }.to raise_error(Bugsnag::Api::InternalServerError)
     end
 
     it "includes an error" do
@@ -106,7 +168,7 @@ describe Bugsnag::Api::Client do
         },
         :body => {:error => "Comments must contain a message"}.to_json
       begin
-        Bugsnag::Api.get('/boom')
+        Bugsnag::Api.get(bugsnag_url('/boom'))
       rescue Bugsnag::Api::UnprocessableEntity => e
         expect(e.message).to include("Error: Comments must contain a message")
       end
@@ -119,7 +181,7 @@ describe Bugsnag::Api::Client do
           :content_type => "application/json",
         },
         :body => {:message => "I'm a teapot"}.to_json
-      expect { Bugsnag::Api.get('/user') }.to raise_error(Bugsnag::Api::ClientError)
+      expect { Bugsnag::Api.get(bugsnag_url('/user')) }.to raise_error(Bugsnag::Api::ClientError)
     end
 
     it "raises on unknown server errors" do
@@ -129,7 +191,7 @@ describe Bugsnag::Api::Client do
           :content_type => "application/json",
         },
         :body => {:message => "Bandwidth exceeded"}.to_json
-      expect { Bugsnag::Api.get('/user') }.to raise_error(Bugsnag::Api::ServerError)
+      expect { Bugsnag::Api.get(bugsnag_url('/user')) }.to raise_error(Bugsnag::Api::ServerError)
     end
   end
 end