bugsnag-api 2.0.0 → 2.1.0

data/CHANGELOG.md

@@ -1,6 +1,40 @@
 Changelog
 =========
 
+## 2.1.0 (28 July 2021)
+
+### Enhancements
+
+* Add stability and release endpoints
+    |  [#34](https://github.com/bugsnag/bugsnag-api-ruby/pull/34)
+
+## 2.0.3 (11 May 2021)
+
+### Fixes
+
+* Fix error handling middleware compatibility with Faraday v1.2.0 and above
+    | [askreet](https://github.com/askreet)
+    | [#30](https://github.com/bugsnag/bugsnag-api-ruby/pull/30)
+
+* Remove call to deprecated `URI.escape`
+    | [askreet](https://github.com/askreet)
+    | [#28](https://github.com/bugsnag/bugsnag-api-ruby/pull/28)
+
+## 2.0.2 (21 Feb 2018)
+
+### Fixes
+
+* Fixes issue with custom query parameters being overridden
+    | [#13](https://github.com/bugsnag/bugsnag-api-ruby/pull/13)
+
+## 2.0.1 (15 Nov 2017)
+
+### Fixes
+
+* Adds `X-Bugsnag-Api` header so that on-prem clients may use this tool
+    | [tremlab](https://github.com/tremlab)
+    | [#14](https://github.com/bugsnag/bugsnag-api-ruby/pull/14)
+
 ## 2.0.0 (10 Oct 2017)
 
 This release changes the gem to access v2 of the [Bugsnag data-access API](https://docs.bugsnag.com/api/data-access/), with full API documentation found [here](http://docs.bugsnagapiv2.apiary.io/).

data/CONTRIBUTING.md

@@ -26,7 +26,7 @@ If you're a member of the core team, follow these instructions for releasing bug
 ### Every time
 
 * Update `CHANGELOG.md`
-* Update the version number in `bugsnag-api.gemspec`
+* Update the version number in [`lib/bugsnag/api/version.rb`](./lib/bugsnag/api/version.rb)
 * Update `README.md` if necessary with changes to the interface or configuration
 * Commit/push your changes
 * Release to rubygems

data/Gemfile

@@ -1,4 +1,13 @@
 source 'https://rubygems.org'
 
+# Any :development dependencies are ignored for license auditing purposes
+group :development do
+end
+
+# Any :test dependencies are ignored for license auditing purposes
+group :test do
+end
+
 # Specify your gem's dependencies in bugsnag-api.gemspec
 gemspec
+

data/README.md

@@ -20,6 +20,7 @@ This library borrows heavily from the code and philosophies of the fantastic [Oc
   - [Accessing Related Resources](#accessing-related-resources)
   - [Authentication](#authentication)
   - [Pagination](#pagination)
+  - [Filtering](#filtering)
   - [Accessing HTTP responses](#accessing-http-responses)
 - [API Methods](#api-methods)
   - [Organizations](#organizations)
@@ -31,6 +32,8 @@ This library borrows heavily from the code and philosophies of the fantastic [Oc
   - [Pivots](#pivots)
   - [Projects](#projects)
   - [Trends](#trends)
+  - [Stability](#stability)
+  - [Releases](#releases)
 - [Advanced Configuration](#advanced-configuration)
 
 
@@ -162,6 +165,33 @@ until last_response.rels[:next].nil?
 end
 ```
 
+### Filtering
+
+Events and Errors can be filtered to return a subset of data. Any of the filters usable in the Bugsnag dashoard can be used in this API. The filter object is a hash of Event Field keys containing an array of filter values. Each filter value has a `type` and a `value` to filter on. The type determines the type of comparison that will be performed.
+
+| `type` | Description | Multiple value combination logic |
+|-|-|-|
+| `eq` | Filter for items that 'match' the value. Some fields require an exact match and some support substring matching. | OR |
+| `ne` | Filter for items that don't match the value. | AND |
+
+:warning: Note that the Event Field `search` can not be used more than once in a call.
+
+You can see the filterable fields for a project using the following snippet, after setting the `project-id` value.
+
+```ruby
+fields = Bugsnag::Api.event_fields("project-id")
+
+puts "List of the searchable fields for this project:"
+fields.each_with_index do |field,idx|
+  puts "  [#{idx}] #{field.display_id}"
+end
+# => List of the searchable fields for this project:
+# =>   [0] event
+# =>   [1] error
+# =>   [2] search
+# =>   [3] user.id
+# => ...
+```
 
 ### Accessing HTTP responses
 
@@ -186,7 +216,7 @@ documentation](http://www.rubydoc.info/gems/bugsnag-api/Bugsnag/Api/Client)
 orgs = Bugsnag::Api.organizations
 
 # Get a single organization
-org = Bugsnag::Api.organizations("organization-id")
+org = Bugsnag::Api.organization("organization-id")
 ```
 
 ### Collaborators
@@ -236,7 +266,13 @@ Bugsnag::Api.delete_comment("comment-id")
 
 ```ruby
 # List project errors
-errors = Bugsnag::Api.errors("project-id", "project-id")
+errors = Bugsnag::Api.errors("project-id", nil)
+
+# List errors with a filter (see Filtering section for more information)
+# Returns errors that match `EXC_BAD_INSTRUCTION`, this could be from the error class, message, context, or stack trace.
+errors = Bugsnag::Api.errors("project-id", nil, direction:"desc", filters: {
+  "search": [{ "type":"eq", "value":"EXC_BAD_INSTRUCTION" }]
+})
 
 # Get a single error
 error = Bugsnag::Api.error("project-id", "error-id")
@@ -261,6 +297,15 @@ events = Bugsnag::Api.events("project-id")
 # List error events
 events = Bugsnag::Api.error_events("project-id", "error-id")
 
+# List events with a filter (see Filtering section for more information)
+# Returns events with
+#   class `EXC_BAD_INSTRUCTION` OR `EXC_BAD_ACCESS`
+#   AND where the device is jailbroken
+events = Bugsnag::Api.events(PROJECT_ID, direction:"desc", filters: {
+  "event.class": [{ "type":"eq", "value":"EXC_BAD_INSTRUCTION" }, { "type":"eq", "value":"EXC_BAD_ACCESS"  }],
+  "device.jailbroken": [{ "type":"eq", "value":"false"}]
+})
+
 # Get the latest event
 event = Bugsnag::Api.latest_event("project-id", "error-id")
 
@@ -321,6 +366,36 @@ Bugsnag::Api.pivots("project-id")
 Bugsnag::Api.pivot_values("project-id", "display id")
 ```
 
+### Trends
+
+```ruby
+# list an error's trends in 5 buckets
+Bugsnag::Api.trends_buckets("project-id", 5, "error-id")
+
+# list a project's trends by resolution
+Bugsnag::Api.trends_resolution("project-id", "2h")
+```
+
+### Stability
+
+```ruby
+# view a project's stability trend
+Bugsnag::Api.stability_trend("project-id")
+```
+
+### Releases
+
+```ruby
+# list the releases in a project
+Bugsnag::Api.releases("project-id")
+
+# view a single release
+Bugsnag::Api.release("project-id", "release-id")
+
+# list the releases in a release group
+Bugsnag::Api.releases_in_group("release-group-id")
+```
+
 ## Advanced Configuration
 
 ### Endpoint

data/bugsnag-api.gemspec

@@ -18,14 +18,49 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sawyer", '~> 0.8.1'
+  if RUBY_VERSION < "2.2.0"
+    spec.add_dependency "sawyer", '0.8.1'
+
+    spec.add_development_dependency "rake", "< 12.0.0"
+    spec.add_development_dependency "rubocop", "0.41.2"
+    spec.add_development_dependency "faker", "1.3.0"
+
+    # i18n is used by faker
+    spec.add_development_dependency "i18n", "< 1.0.0"
+
+    # crack is used by webmock
+    spec.add_development_dependency "crack", "< 0.4.5"
+  else
+    spec.add_dependency "sawyer", '~> 0.8.1'
+
+    spec.add_development_dependency "rake"
+    spec.add_development_dependency "rubocop", "~> 0.52.1"
+    spec.add_development_dependency "faker", "> 1.7.3"
+  end
+
+  if RUBY_VERSION < "2.0.0"
+    spec.add_development_dependency "json", "< 2.0.0"
+    spec.add_development_dependency "webmock", "2.3.2"
+    spec.add_development_dependency "addressable", "2.3.6"
+
+    # hashdiff is used by webmock
+    spec.add_development_dependency "hashdiff", "< 0.3.8"
+
+    # parser is used by rubocop
+    spec.add_development_dependency "parser", "< 2.5.0"
+  else
+    spec.add_development_dependency "json"
+    spec.add_development_dependency "webmock", "> 2.3.2"
+    spec.add_development_dependency "addressable", "> 2.3.6"
+  end
+
+  # public_suffix is used by addressable & sawyer
+  if RUBY_VERSION < "2.0.0"
+    spec.add_development_dependency "public_suffix", "< 1.5.0"
+  elsif RUBY_VERSION < "2.1.0"
+    spec.add_development_dependency "public_suffix", "< 3.0.0"
+  end
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
-  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/config/.gitignore

@@ -0,0 +1 @@
+global.yml

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3.6'
+services:
+
+  license_finder:
+    build:
+      dockerfile: dockerfiles/Dockerfile.audit
+      context: .
+    volumes:
+      - ./:/scan

data/dockerfiles/Dockerfile.audit

@@ -0,0 +1,5 @@
+FROM licensefinder/license_finder
+
+WORKDIR /scan
+
+CMD /scan/scripts/license_finder.sh

data/lib/bugsnag/api/client.rb

@@ -10,6 +10,8 @@ require "bugsnag/api/client/events"
 require "bugsnag/api/client/pivots"
 require "bugsnag/api/client/trends"
 require "bugsnag/api/client/comments"
+require "bugsnag/api/client/stability"
+require "bugsnag/api/client/releases"
 
 module Bugsnag
   module Api
@@ -28,6 +30,8 @@ module Bugsnag
       include Bugsnag::Api::Client::Pivots
       include Bugsnag::Api::Client::Trends
       include Bugsnag::Api::Client::Comments
+      include Bugsnag::Api::Client::Stability
+      include Bugsnag::Api::Client::Releases
 
       # Header keys that can be passed in options hash to {#get},{#head}
       CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
@@ -143,12 +147,25 @@ module Bugsnag
         !!configuration.auth_token
       end
 
+      # Merges hashes together cleanly, favouring RHS values
+      #
+      # @return [Hash]
+      def deep_merge(l_hash, r_hash)
+        l_hash.merge(r_hash) do |_key, l_val, r_val|
+          if l_val.is_a?(Hash) && r_val.is_a?(Hash)
+            deep_merge(l_val, r_val)
+          else
+            r_val
+          end
+        end
+      end
 
       private
       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[:'X-Bugsnag-Api'] = "true"
           http.headers[:user_agent] = configuration.user_agent
 
           if basic_authenticated?
@@ -172,7 +189,7 @@ module Bugsnag
           end
         end
 
-        @last_response = response = agent.call(method, URI.escape(path.to_s), data, options)
+        @last_response = response = agent.call(method, path.to_s, data, options)
         response.data
       end
 

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

@@ -19,7 +19,7 @@ module Bugsnag
         # @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             
+        # @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
@@ -84,4 +84,3 @@ module Bugsnag
     end
   end
 end
-  

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

@@ -44,7 +44,7 @@ module Bugsnag
 
         # Delete a Comment
         #
-        # @return 
+        # @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

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

@@ -30,4 +30,3 @@ module Bugsnag
     end
   end
 end
-  

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

@@ -8,6 +8,8 @@ module Bugsnag
       module Errors
         # List the Errors on a Project
         #
+        # @argument id [String] optional ID of error to retrieve
+        #
         # @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
@@ -15,16 +17,14 @@ module Bugsnag
         # @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
+          if id.nil?
+            paginate "projects/#{project_id}/errors", options
+          else
+            get "projects/#{project_id}/errors/#{id}", options
+          end
         end
 
-        # View an Error
-        #
-        # @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
+        alias error errors
 
         # Update an Error
         #
@@ -42,7 +42,9 @@ module Bugsnag
           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(' ')}})
+            defaults = {:operation => operation, :query => {:error_ids => ids.join(' ')}}
+            merged_opts = deep_merge(defaults, options)
+            patch "projects/#{project_id}/errors", merged_opts
           else
             raise ArgumentError, "ids must be a String or an Array"
           end
@@ -53,7 +55,7 @@ module Bugsnag
         # @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)
         #
-        # @return 
+        # @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?
@@ -66,4 +68,3 @@ module Bugsnag
     end
   end
 end
-  

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

@@ -38,7 +38,7 @@ module Bugsnag
 
         # Delete a custom Event Field
         #
-        # @return 
+        # @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
@@ -47,4 +47,3 @@ module Bugsnag
     end
   end
 end
-  

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

@@ -16,7 +16,7 @@ module Bugsnag
 
         # Delete an Event
         #
-        # @return 
+        # @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
@@ -57,4 +57,3 @@ module Bugsnag
     end
   end
 end
-  

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

@@ -34,7 +34,7 @@ module Bugsnag
 
         # Delete an Organization
         #
-        # @return 
+        # @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
@@ -43,4 +43,3 @@ module Bugsnag
     end
   end
 end
-