bugsnag-api 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0de7c6d92a7d28e2e96de5506e2ecb7e6edd60a087e949b955325628aa93358d
-  data.tar.gz: 61831b2e22916700edc08be34557d2b01f3fb0a23220436297236d8b413d5d72
+  metadata.gz: cb92be973f329fc0b534281572a49ac0bfc82d4a5effd917d7b10f2eb9d9a19c
+  data.tar.gz: 6bfb6147eb71be5cb1673c8a550b28af198e63dbd024eb1c1e8da40ec46e14b2
 SHA512:
-  metadata.gz: 9465be48ec9a6bb9a0ec5d1278c8e16a5a296ad5bd802d2e3a839df2e2e3be5a1ecf9eb4dc0c841f3e78e8444b4dc81504e9efbad6cb58e6fecb423817e2db93
-  data.tar.gz: 2edd21ddbe339ef9f00147c6d398a1ba1013f8c7df9e78d6244a722fcd72c94d962495e1514231ff46421695aa5423ecb561d6478dcab4e936dab986499c7335
+  metadata.gz: d021963f0b0b663ced606dd48b8beef0d1b92cac78452ef582bcc10c46e96f3cffbdbeed6bfad82699cac1c207d0b9b26d19f6ac71380dd938f9af8d4ca56bb0
+  data.tar.gz: c3e14c300c70fa0fd80f498819f9e1f9ae59ec31b6ba5a2344e85b8eda87b66b163e21ad0eacb36686d9452a26b9396a03957b925979d590054e37cebde5fe73

data/.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['2.1', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
 
     steps:
       - uses: actions/checkout@v2
@@ -34,20 +34,3 @@ jobs:
           bundler-cache: true
 
       - run: bundle exec rubocop lib/
-
-  # Ruby 1.9 and 2.0 aren't supported by setup-ruby so we have to use Docker instead
-  legacy:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: ['1.9', '2.0']
-
-    container: ruby:${{ matrix.ruby-version }}
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - run: bundle install
-
-      - run: bundle exec rake spec

data/CHANGELOG.md

@@ -1,6 +1,25 @@
 Changelog
 =========
 
+## 3.0.0 (3 November 2022)
+
+### Enhancements
+
+* Update required Sawyer version to `~> 0.9.2`
+    | [ilvez](https://github.com/ilvez)
+    | [#43](https://github.com/bugsnag/bugsnag-api-ruby/pull/43)
+
+* Require Ruby 2.6+
+    | [#44](https://github.com/bugsnag/bugsnag-api-ruby/pull/44)
+
+## 2.1.1 (2 November 2021)
+
+### Fixes
+
+* Fix Faraday deprecation warning
+    | [sambostock](https://github.com/sambostock)
+    | [#36](https://github.com/bugsnag/bugsnag-api-ruby/pull/36)
+
 ## 2.1.0 (28 July 2021)
 
 ### Enhancements

data/README.md

@@ -1,10 +1,9 @@
 Bugsnag API Toolkit for Ruby
 ============================
-![Build status](https://travis-ci.org/bugsnag/bugsnag-api-ruby.svg?branch=master)
 
 The library allows for quick read/write access to the [Bugsnag Data Access API](https://docs.bugsnag.com/api/data-access/) from your Ruby applications. You can use this library to build your own applications which leverage data found in your Bugsnag dashboard.
 
-Version 2.x (current) of this gem corresponds to v2 of the Data Access API, while [1.x](https://github.com/bugsnag/bugsnag-api-ruby/tree/v1.0.3) uses the (deprecated) v1 of the Data Access API.
+Version 3.x (current) and 2.x of this gem corresponds to v2 of the Data Access API, while [1.x](https://github.com/bugsnag/bugsnag-api-ruby/tree/v1.0.3) uses the (deprecated) v1 of the Data Access API.
 
 If you are looking to automatically detect crashes in your Ruby apps, you should take a look at the [Bugsnag Ruby Detection Library](https://docs.bugsnag.com/platforms/ruby) instead.
 

data/bugsnag-api.gemspec

@@ -18,49 +18,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  if RUBY_VERSION < "2.2.0"
-    spec.add_dependency "sawyer", '0.8.1'
+  spec.required_ruby_version = ">= 2.6"
 
-    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_dependency "sawyer", '~> 0.9.2'
 
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop", "~> 0.52.1"
+  spec.add_development_dependency "faker", "> 1.7.3"
+  spec.add_development_dependency "webmock", "> 2.3.2"
+  spec.add_development_dependency "addressable", "> 2.3.6"
+  spec.add_development_dependency "json"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "vcr", "~> 2.9"
 end

data/lib/bugsnag/api/client.rb

@@ -13,6 +13,8 @@ require "bugsnag/api/client/comments"
 require "bugsnag/api/client/stability"
 require "bugsnag/api/client/releases"
 
+require "base64"
+
 module Bugsnag
   module Api
 
@@ -169,9 +171,11 @@ module Bugsnag
           http.headers[:user_agent] = configuration.user_agent
 
           if basic_authenticated?
-            http.basic_auth configuration.email, configuration.password
+            credentials = Base64.strict_encode64("#{configuration.email}:#{configuration.password}")
+
+            http.headers[:Authorization] = "Basic #{credentials}"
           elsif token_authenticated?
-            http.authorization "token", configuration.auth_token
+            http.headers[:Authorization] = "token #{configuration.auth_token}"
           end
         end
       end

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

@@ -8,7 +8,7 @@ module Bugsnag
 
       # This class raises an Bugsnag-flavored exception based
       # HTTP status codes returned by the API
-      class RaiseError < Faraday::Response::Middleware
+      class RaiseError < Faraday::Response::RaiseError
         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.1.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/bugsnag/api.rb

@@ -20,7 +20,10 @@ module Bugsnag
         client.configuration
       end
 
-      # Get the static API client
+      # Get the static API client. Note that using the static API
+      # client may not work as expected in a multithreaded environment
+      # (e.g. when using the {#paginate} or {#last_response} instance
+      # methods)
       #
       # @return [Bugsnag::Api::Client] API client
       def client

data/spec/cassettes/Bugsnag_Api_Client_CurrentUser/_list_organizations/when_using_user_credentials/returns_users_organizations.yml

@@ -16,7 +16,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/spec/cassettes/Bugsnag_Api_Client_CurrentUser/_list_projects/when_using_user_credentials/lists_current_user_s_projects_in_the_organization.yml

@@ -16,7 +16,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/spec/cassettes/Bugsnag_Api_Client_Organizations/_create_organization/creates_a_new_organization.yml

@@ -16,7 +16,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/spec/cassettes/Bugsnag_Api_Client_Organizations/with_organization/_delete_organization/deletes_the_organization.yml

@@ -16,7 +16,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -84,7 +84,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/spec/cassettes/Bugsnag_Api_Client_Organizations/with_organization/_organization/returns_the_requested_organization.yml

@@ -16,7 +16,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -84,7 +84,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/spec/cassettes/Bugsnag_Api_Client_Organizations/with_organization/_update_organization/updates_and_returns_the_organization.yml

@@ -16,7 +16,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -84,7 +84,7 @@ http_interactions:
       X-Bugsnag-Api:
       - 'true'
       Authorization:
-      - Basic c3VwcG9ydEBidWdzbmFnLmNvbTpwYXNzd29yZA==
+      - Basic QlVHU05BR19VU0VSX0VNQUlMOkJVR1NOQUdfUEFTU1dPUkQ=
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:

data/spec/spec_helper.rb

@@ -23,9 +23,28 @@ VCR.configure do |c|
   c.cassette_library_dir = "spec/cassettes"
   c.hook_into :webmock
   c.configure_rspec_metadata!
+
+  USER_AGENT_REGEX = /\ABugsnag API Ruby Gem \d+\.\d+\.\d+\z/
+  HEADERS_SET_BY_BUGSNAG = ["Content-Type", "X-Version", "X-Bugsnag-Api", "Authorization"]
+
+  user_agent_valid = lambda do |values|
+    return false if values.length != 1
+
+    values.first.match(USER_AGENT_REGEX)
+  end
+
+  header_matcher = lambda do |request_a, request_b|
+    return false unless user_agent_valid.(request_a.headers["User-Agent"])
+    return false unless user_agent_valid.(request_b.headers["User-Agent"])
+
+    HEADERS_SET_BY_BUGSNAG.all? do |header|
+      request_a.headers[header] == request_b.headers[header]
+    end
+  end
+
   c.default_cassette_options = {
-    :record => ENV['TRAVIS'] ? :none : :once,
-    :match_requests_on => [:method, :path]
+    :record => ENV['CI'] ? :none : :once,
+    :match_requests_on => [:method, :path, header_matcher]
   }
 
   c.filter_sensitive_data("https://api.bugsnag.com") { test_bugsnag_endpoint }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-api
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,47 +67,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.3
 - !ruby/object:Gem::Dependency
-  name: json
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 2.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 2.3.6
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -257,14 +257,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Bugsnag API toolkit for ruby