bugsnag-api 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4616f90142beb5163ce325dee92a393d3b990bac
-  data.tar.gz: 0e1f46dd0c4543abaf73fd39a6bd63fc9028ab80
+  metadata.gz: f1a072712b9388b873f8159b1da219c8cdb56e88
+  data.tar.gz: 7094b51bf0f0565b52e04515007dd0456b8766c4
 SHA512:
-  metadata.gz: c5b44534d8d0b639c054ad67402fcd4d25bb8c2f985e06019135c36868cdddc518d2915a88eefc7fed3e0b5da76dc4cba79473fd92ab68f28ea54b7002362557
-  data.tar.gz: fd9c7470df57b829520e4deb9609e1e3414da9e6d4f7e261ca8cb2b1253a596e3bef1668621cc2411eae805d4a765379056092423cd94e4dcaeec9763b37536a
+  metadata.gz: 505c72dc46ca8a41bcc3772e765508b0d26c6610810a73e7bc542ea7a3ed903c7622aa6e41bfd86a4322ee41e940678e53f1ee0ee3ebcbf302e1145c6cfbb7af
+  data.tar.gz: c187d9eb7dd6fe2f234652e9bf85e324ac5c0a1f436b0b35e528ae670d8fb8d520347a433fd23dea7a48af2988833a41f170d3fb66a8aa95a7c985099f8d8498

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,271 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-02-20 14:31:40 +0000 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundAccessModifier:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/comments.rb'
+    - 'lib/bugsnag/api/client/currentuser.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/events.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/pivots.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+    - 'lib/bugsnag/api/error.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/configuration.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  Exclude:
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/pivots.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: no_space
+
+# Offense count: 34
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/comments.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+
+# Offense count: 17
+# Cop supports --auto-correct.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/currentuser.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/events.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/pivots.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+
+# Offense count: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/error.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+
+# Offense count: 1
+Lint/UriEscapeUnescape:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 27
+
+# Offense count: 1
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 127
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 18
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 23
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/comments.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+
+# Offense count: 2
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty, nil, both
+Style/EmptyElse:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 26
+# Cop supports --auto-correct.
+# Configuration parameters: UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+
+# Offense count: 1
+Style/MethodMissing:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+    - 'lib/bugsnag/api/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+
+# Offense count: 31
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/currentuser.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/configuration.rb'
+    - 'lib/bugsnag/api/error.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+    - 'lib/bugsnag/api/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/UnneededInterpolation:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 80
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 146

data/.travis.yml

@@ -7,11 +7,14 @@ rvm:
 - 1.9.3
 - jruby-19mode
 
-before_install:
-- echo YOLO
-
 install:
 - bundle install --with "$GEMSETS"
 
+jobs:
+  include:
+    - stage: test
+      rvm: 2.4.1
+      script: bundle exec rubocop lib/
+
 script:
 - bundle exec rake spec

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## 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

data/bugsnag-api.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "rubocop", RUBY_VERSION <= '2.1.0' ? '0.41.2': '~>0.52.1'
 end

data/lib/bugsnag/api/client.rb

@@ -143,6 +143,18 @@ 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

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/errors.rb

@@ -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

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,10 +27,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_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

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/version.rb

@@ -1,5 +1,5 @@
 module Bugsnag
   module Api
-    VERSION = "2.0.1"
+    VERSION = "2.0.2"
   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