my_api_client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3ada9d2c8dbfadb9462b2cff381e9ccaf822a543f63672f6e5fdcd99f9ce4ed
-  data.tar.gz: b00cc646de8c05bc5378645940732e7dec5fc80d0dd4380e816f0a228e8b6f00
+  metadata.gz: e0499ab884898c6a2b95fc688c095b7a3682f91dc1b5668b24bfb821a4d0a1c3
+  data.tar.gz: bc2d95d4973ef859aa5d95dba8adfa1f2378dfe396e53a303e223a480d93af34
 SHA512:
-  metadata.gz: 977d55b39c0a35d56d4ff2ddc142765a7807f2b027471186d947cda8ea4f606d81fbfc842524318c9630f48a88aeb5adea5cc7e948233323f3072200e624d034
-  data.tar.gz: e8d4f395990d049afddc3e380044e5f65ad57d0130da1b08114d4bf28965a0d53fe756d147ebf17c7ffac3b236fc8c3f9e7fc7c74edfb90e9f57b0ed94b10930
+  metadata.gz: 8ceb42331cb908e84d9555d33fffcbed248260d7b06345edc13effbfad2d13db213b1f1b37db40060b6d32792066821ab7c703720998c8e0bb91ea92bfa7599d
+  data.tar.gz: 560c704e9545c3ba16a04dabddd1ecc027b6c16591f710fc288bb7343d599c63c9dfb18ee142a3269ce87f95ea7a4f2ff9ee47ae72d8adb422886c6f772dbb8d

data/.circleci/config.yml

@@ -4,6 +4,10 @@
 #
 version: 2.1
 
+orbs:
+  ruby-orbs: sue445/ruby-orbs@1.4.3
+  code-climate: rvla/code-climate@0.0.2
+
 references:
   - &ruby_version
     ruby_version:
@@ -15,6 +19,10 @@ references:
       type: enum
       enum: ['4.2', '5.0', '5.1', '5.2']
       default: '4.2'
+  - &bundler_options
+    bundler_options:
+      type: string
+      default: ''
 
 executors:
   default:
@@ -25,30 +33,6 @@ executors:
     working_directory: ~/repo
 
 commands:
-  download_cc_test_reporter:
-    description: 'Download cc-test-reporter'
-    steps:
-      - run: |
-          mkdir -p tmp/
-          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
-          chmod +x ./tmp/cc-test-reporter
-  setup_bundle:
-    description: Setup Bundle
-    parameters:
-      <<: *ruby_version
-    steps:
-      - restore_cache:
-          keys:
-          - v1-dependencies-<< parameters.ruby_version >>-{{ checksum "Gemfile.lock" }}
-          - v1-dependencies-
-      - run:
-          name: Bundle Install
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-<< parameters.ruby_version >>-{{ checksum "Gemfile.lock" }}
   modify_active_support_version:
     description: Modify ActiveSupport Version
     parameters:
@@ -65,13 +49,13 @@ commands:
           command: |
             mkdir /tmp/test-results
             TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
-            ./tmp/cc-test-reporter before-build
+            cc-test-reporter before-build
             bundle exec rspec --format documentation \
                               --color \
                               --format RspecJunitFormatter \
                               --out /tmp/test-results/rspec.xml \
                               $TEST_FILES
-            ./tmp/cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
+            cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
       - store_test_results:
           path: /tmp/test-results
       - store_artifacts:
@@ -106,7 +90,7 @@ commands:
       - run:
           name: Create Rubygems Credentials
           command: |
-            mkdir ~/.gem
+            mkdir ~/.gem || true
             echo -e "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials
             chmod 0600 ~/.gem/credentials
       - run:
@@ -116,21 +100,22 @@ commands:
             bundle exec rake release --trace
   setup:
     description: Setup for Job Working
+    parameters:
+      <<: *ruby_version
+      <<: *bundler_options
     steps:
       - checkout
-      - setup_bundle
-  build:
+      - ruby-orbs/bundle-install:
+          cache_key_prefix: v1-dependencies-<< parameters.ruby_version >>
+          bundle_extra_args: << parameters.bundler_options >>
+  test_and_build:
     description: Build the RubyGem
     parameters:
-      <<: *ruby_version
       <<: *rails_version
     steps:
-      - checkout
-      - download_cc_test_reporter
-      - setup_bundle:
-          ruby_version: << parameters.ruby_version >>
       - modify_active_support_version:
           rails_version: << parameters.rails_version >>
+      - code-climate/install
       - run_rspec
       - rake_build
 
@@ -139,12 +124,15 @@ jobs:
     parameters:
       <<: *ruby_version
       <<: *rails_version
+      <<: *bundler_options
     executor:
       name: default
       ruby_version: << parameters.ruby_version >>
     steps:
-      - build:
+      - setup:
           ruby_version: << parameters.ruby_version >>
+          bundler_options: << parameters.bundler_options >>
+      - test_and_build:
           rails_version: << parameters.rails_version >>
   rubocop:
     executor:
@@ -220,9 +208,15 @@ workflows:
           ruby_version:  '2.6'
           rails_version: '5.1'
       - build:
-          name: build_on_ruby_2_6_and_rails_5_2
+          name: build_on_ruby_2_6_and_rails_5_2_with_integrations
           ruby_version:  '2.6'
           rails_version: '5.2'
+          bundler_options: '--with integrations'
+      - build:
+          name: build_on_ruby_2_6_and_rails_5_2_without_integrations
+          ruby_version:  '2.6'
+          rails_version: '5.2'
+          bundler_options: '--without integrations'
       - rubocop
       - yardoc
       - release:
@@ -239,7 +233,8 @@ workflows:
             - build_on_ruby_2_6_and_rails_4_2
             - build_on_ruby_2_6_and_rails_5_0
             - build_on_ruby_2_6_and_rails_5_1
-            - build_on_ruby_2_6_and_rails_5_2
+            - build_on_ruby_2_6_and_rails_5_2_with_integrations
+            - build_on_ruby_2_6_and_rails_5_2_without_integrations
             - rubocop
           filters:
             branches:
@@ -256,3 +251,10 @@ workflows:
                 - master
     jobs:
       - rubocop_challenge
+
+experimental:
+  notify:
+    branches:
+      only:
+        - master
+        - production

data/.rubocop.yml

@@ -37,6 +37,7 @@ RSpec/ExampleLength:
 
 RSpec/FilePath:
   Exclude:
+    - 'spec/lib/my_api_client/integrations/**/*'
     - 'spec/lib/my_api_client/errors/**/*'
     - 'spec/lib/my_api_client/rspec/**/*'
 

data/Gemfile

@@ -4,5 +4,9 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+group :integrations, optional: true do
+  gem 'bugsnag', '>= 6.11.0'
+end
+
 # Specify your gem's dependencies in my_api_client.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.4.0)
+    my_api_client (0.5.0)
       activesupport (>= 4.2.0)
       jsonpath
       sawyer
@@ -17,13 +17,15 @@ GEM
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
+    bugsnag (6.11.1)
+      concurrent-ruby (~> 1.0)
     byebug (11.0.1)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.2)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     hashdiff (0.4.0)
@@ -31,7 +33,7 @@ GEM
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
     json (2.2.0)
-    jsonpath (1.0.3)
+    jsonpath (1.0.4)
       multi_json
       to_regexp (~> 0.2.1)
     method_source (0.9.2)
@@ -43,8 +45,9 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    pr_comet (0.1.1)
+    pr_comet (0.2.0)
       octokit
+      rainbow
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -58,15 +61,15 @@ GEM
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.1)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.71.0)
@@ -95,16 +98,17 @@ GEM
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
-    webmock (3.5.1)
+    webmock (3.6.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.19)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bugsnag (>= 6.11.0)
   bundler (~> 1.16)
   my_api_client!
   pr_comet

data/gemfiles/rails_4.2.gemfile

@@ -8,4 +8,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 4.2.0'
 
+group :integrations, optional: true do
+  gem 'bugsnag', '>= 6.11.0'
+end
+
 gemspec

data/gemfiles/rails_5.0.gemfile

@@ -8,4 +8,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 5.0.0'
 
+group :integrations, optional: true do
+  gem 'bugsnag', '>= 6.11.0'
+end
+
 gemspec

data/gemfiles/rails_5.1.gemfile

@@ -8,4 +8,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 5.1.0'
 
+group :integrations, optional: true do
+  gem 'bugsnag', '>= 6.11.0'
+end
+
 gemspec

data/gemfiles/rails_5.2.gemfile

@@ -8,4 +8,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 5.2.0'
 
+group :integrations, optional: true do
+  gem 'bugsnag', '>= 6.11.0'
+end
+
 gemspec

data/lib/my_api_client.rb

@@ -18,6 +18,14 @@ require 'my_api_client/params/request'
 require 'my_api_client/request'
 require 'my_api_client/base'
 
+# Loads gems for feature of integrations
+begin
+  require 'bugsnag'
+  require 'my_api_client/integrations/bugsnag' if defined?(Bugsnag) && Bugsnag::VERSION >= '6.11.0'
+rescue LoadError
+  nil
+end
+
 if Sawyer::VERSION < '0.8.2'
   module Sawyer
     # NOTE: Old sawyer does not have attribute reader for response body.

data/lib/my_api_client/errors.rb

@@ -4,12 +4,15 @@ module MyApiClient
   # The ancestor class for all API request error
   class Error < StandardError
     attr_reader :params
-    delegate :to_bugsnag, to: :params
+    delegate :metadata, to: :params
+    alias to_bugsnag metadata
 
-    # Description of #initialize
+    # Initialize the error class
     #
-    # @param params [MyApiClient::Params::Params] describe_params_here
-    # @param error_message [String] default: nil
+    # @param params [MyApiClient::Params::Params]
+    #   The request and response parameters
+    # @param error_message [String]
+    #   The error description
     def initialize(params, error_message = nil)
       @params = params
       super error_message
@@ -35,10 +38,12 @@ module MyApiClient
   class NetworkError < Error
     attr_reader :original_error
 
-    # Description of #initialize
+    # Initialize the error class
     #
-    # @param params [MyApiClient::Params::Params] describe_params_here
-    # @param original_error [StandardError] Some network error
+    # @param params [MyApiClient::Params::Params]
+    #   The request and response parameters
+    # @param original_error [StandardError]
+    #   Some network error
     def initialize(params, original_error)
       @original_error = original_error
       super params, original_error.message
@@ -50,6 +55,13 @@ module MyApiClient
     def inspect
       { error: original_error, params: params }.inspect
     end
+
+    # Generate metadata for bugsnag.
+    #
+    # @return [Hash] Metadata for bugsnag
+    def metadata
+      super.merge(original_error: original_error.inspect)
+    end
   end
 
   # NOTE: The built-in error classes are following. Although they are prepared

data/lib/my_api_client/integrations/bugsnag.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  # Override lib/my_api_client/errors.rb for supporting Bugsnag breadcrumbs
+  class Error < StandardError
+    alias _original_initialize initialize
+
+    # Override MyApiClient::Error#initialize
+    def initialize(params, error_message = nil)
+      _original_initialize(params, error_message)
+
+      Bugsnag.leave_breadcrumb(
+        "#{self.class.name} occurred",
+        metadata,
+        Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
+      )
+    end
+  end
+end

data/lib/my_api_client/params/params.rb

@@ -20,9 +20,10 @@ module MyApiClient
       # Blank parameter will be omitted.
       #
       # @return [Hash] Metadata for bugsnag
-      def to_bugsnag
+      def metadata
         request_metadata.merge(response_metadata)
       end
+      alias to_bugsnag metadata
 
       # Returns contents as string for to be readable for human
       #
@@ -39,7 +40,7 @@ module MyApiClient
       # @return [Hash] Metadata for bugsnag
       def request_metadata
         if request.present?
-          request.to_bugsnag.each_with_object({}) do |(key, value), memo|
+          request.metadata.each_with_object({}) do |(key, value), memo|
             memo[:"request_#{key}"] = value
           end
         else

data/lib/my_api_client/params/request.rb

@@ -32,7 +32,7 @@ module MyApiClient
       # Blank parameter will be omitted.
       #
       # @return [Hash] Metadata for bugsnag
-      def to_bugsnag
+      def metadata
         {
           line: "#{method.upcase} #{pathname}",
           headers: headers,
@@ -40,6 +40,7 @@ module MyApiClient
           body: body,
         }.compact
       end
+      alias to_bugsnag metadata
 
       # Returns contents as string for to be readable for human
       #

data/lib/my_api_client/rspec/stub.rb

@@ -46,7 +46,7 @@ module MyApiClient
     def process_raise_option(exception)
       case exception
       when Class
-        params = instance_double(MyApiClient::Params::Params, to_bugsnag: {})
+        params = instance_double(MyApiClient::Params::Params, metadata: {})
         if exception == MyApiClient::NetworkError
           exception.new(params, Net::OpenTimeout.new)
         else

data/lib/my_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2019-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -260,6 +260,7 @@ files:
 - lib/my_api_client/error_handling.rb
 - lib/my_api_client/errors.rb
 - lib/my_api_client/exceptions.rb
+- lib/my_api_client/integrations/bugsnag.rb
 - lib/my_api_client/logger.rb
 - lib/my_api_client/params/params.rb
 - lib/my_api_client/params/request.rb