my_api_client 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a1616750cd4557d71f53dcc9fedbedf674836c636d34c981c46103f8d34b7e1
-  data.tar.gz: 26853ecf8accdda262b74be4f194a0a1cb525fb7968d8e14093f67c274e91001
+  metadata.gz: eb13e4cf8d1a3d9b3a1bbb5154b695493384c1d94377d8260f0ababa59d42c55
+  data.tar.gz: 52df7eb8caa4ad533ce6130078da94da6ff59924efbb5f52c441225114c03fcb
 SHA512:
-  metadata.gz: '01836b11189eeaef1b7fa7d641d8d7fdc2c34ccf3d454723dc4668327353a94e653921b14c1ec71dd9983973bfb81ccc61b1c8b2540851fb01dc77a67ca56792'
-  data.tar.gz: 72181a7e168dc37747dbfe03c6ac974b023490c726735be059357bb9f9a6ccc18ac4734fa5945e0d8fe5e3c0235b303053633f567cc8860395b9bedf14e44f95
+  metadata.gz: b073a7464c97c5d2b9181cb0ed5e1de4296a808a0668d3bb9bf1357f4bad591a24c30ff7935e88383a934fe6867bca86878b673ca51898678ec057e36404413d
+  data.tar.gz: 7bba09a981e3e71a5de194a84cae6fb19cafa3631b283e1f778072837a354db67b555d80f13329b8895496de886393494155427ad0a8050d97b9a36b61171015

data/.circleci/config.yml

@@ -4,12 +4,22 @@
 #
 version: 2.1
 
+references:
+  - &ruby_version
+    ruby_version:
+      type: enum
+      enum: ['2.4', '2.5', '2.6']
+      default: '2.4'
+  - &rails_version
+    rails_version:
+      type: enum
+      enum: ['4.2', '5.0', '5.1', '5.2']
+      default: '4.2'
+
 executors:
   default:
     parameters:
-      ruby_version:
-        type: enum
-        enum: ['2.4', '2.5', '2.6']
+      <<: *ruby_version
     docker:
        - image: circleci/ruby:<< parameters.ruby_version >>-node-browsers
     working_directory: ~/repo
@@ -25,26 +35,28 @@ commands:
   setup_bundle:
     description: Setup Bundle
     parameters:
-      rails_version:
-        type: string
+      <<: *ruby_version
     steps:
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          - v1-dependencies-<< parameters.ruby_version >>-{{ checksum "Gemfile.lock" }}
           - v1-dependencies-
       - run:
           name: Bundle Install
           command: |
             bundle install --jobs=4 --retry=3 --path vendor/bundle
-      - run:
-          name: Modify ActiveSupport Version
-          command: |
-            cp gemfiles/rails_<< parameters.rails_version >>.gemfile Gemfile
-            bundle update activesupport
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+          key: v1-dependencies-<< parameters.ruby_version >>-{{ checksum "Gemfile.lock" }}
+  modify_active_support_version:
+    description: Modify ActiveSupport Version
+    parameters:
+      <<: *rails_version
+    steps:
+      - run: |
+          cp gemfiles/rails_<< parameters.rails_version >>.gemfile Gemfile
+          bundle update activesupport
   run_rspec:
     description: 'Run RSpec'
     steps:
@@ -104,22 +116,20 @@ commands:
             bundle exec rake release --trace
   setup:
     description: Setup for Job Working
-    parameters:
-      rails_version:
-        type: string
     steps:
       - checkout
-      - setup_bundle:
-          rails_version: << parameters.rails_version >>
+      - setup_bundle
   build:
     description: Build the RubyGem
     parameters:
-      rails_version:
-        type: string
+      <<: *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 >>
       - run_rspec
       - rake_build
@@ -127,47 +137,37 @@ commands:
 jobs:
   build:
     parameters:
-      ruby_version:
-        type: enum
-        enum: ['2.4', '2.5', '2.6']
-      rails_version:
-        type: enum
-        enum: ['4.2', '5.0', '5.1', '5.2']
+      <<: *ruby_version
+      <<: *rails_version
     executor:
       name: default
       ruby_version: << parameters.ruby_version >>
     steps:
       - build:
+          ruby_version: << parameters.ruby_version >>
           rails_version: << parameters.rails_version >>
   rubocop:
     executor:
       name: default
-      ruby_version: '2.4'
     steps:
-      - setup:
-          rails_version: '4.2'
+      - setup
       - rubocop
   yardoc:
     executor:
       name: default
-      ruby_version: '2.4'
     steps:
-      - setup:
-          rails_version: '4.2'
+      - setup
       - yardoc
   rubocop_challenge:
     executor:
       name: default
-      ruby_version: '2.4'
     steps:
       - rubocop_challenge
   release:
     executor:
       name: default
-      ruby_version: '2.4'
     steps:
-      - setup:
-          rails_version: '5.2'
+      - setup
       - release
 
 workflows:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.1.4)
+    my_api_client (0.2.0)
       activesupport (>= 4.2.0)
       jsonpath
       sawyer
@@ -26,7 +26,7 @@ GEM
     docile (1.3.1)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    hashdiff (0.3.9)
+    hashdiff (0.4.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)

data/lib/my_api_client/error_handling.rb

@@ -56,7 +56,7 @@ module MyApiClient
         when Regexp
           operator =~ target.to_s
         else
-          false
+          raise "Unexpected operator type was given: #{operator.inspect}"
         end
       end
 

data/lib/my_api_client/errors.rb

@@ -4,6 +4,7 @@ module MyApiClient
   # The ancestor class for all API request error
   class Error < StandardError
     attr_reader :params
+    delegate :to_bugsnag, to: :params
 
     # Description of #initialize
     #

data/lib/my_api_client/params/params.rb

@@ -15,12 +15,55 @@ module MyApiClient
         @response = response
       end
 
+      # Generate metadata for bugsnag.
+      # It will integrate request and response params.
+      # Blank parameter will be omitted.
+      #
+      # @return [Hash] Metadata for bugsnag
+      def to_bugsnag
+        request_metadata.merge(response_metadata)
+      end
+
       # Returns contents as string for to be readable for human
       #
       # @return [String] Contents as string
       def inspect
         { request: request, response: response }.inspect
       end
+
+      private
+
+      # Generate metadata from request params.
+      # It will be added prefix "request_".
+      #
+      # @return [Hash] Metadata for bugsnag
+      def request_metadata
+        if request.present?
+          request.to_bugsnag.each_with_object({}) do |(key, value), memo|
+            memo[:"request_#{key}"] = value
+          end
+        else
+          {}
+        end
+      end
+
+      # Generate metadata from response params.
+      # It will be added prefix "response_".
+      #
+      # @return [Hash] Metadata for bugsnag
+      def response_metadata
+        if response.present?
+          data = response.data
+          body = data.respond_to?(:to_h) ? data.to_h : data
+          {
+            response_status: response.status,
+            response_headers: response.headers,
+            response_body: body,
+          }.compact
+        else
+          {}
+        end
+      end
     end
   end
 end

data/lib/my_api_client/params/request.rb

@@ -6,6 +6,13 @@ module MyApiClient
     class Request
       attr_reader :method, :pathname, :headers, :query, :body
 
+      # Description of #initialize
+      #
+      # @param method [Symbol] describe_method_here
+      # @param pathname [String] describe_pathname_here
+      # @param headers [Hash, nil] describe_headers_here
+      # @param query [Hash, nil] describe_query_here
+      # @param body [Hash, nil] describe_body_here
       def initialize(method, pathname, headers, query, body)
         @method = method
         @pathname = pathname
@@ -14,10 +21,26 @@ module MyApiClient
         @body = body
       end
 
+      # Description of #to_sawyer_args
+      #
+      # @return [Array<Object>] Arguments for Sawyer::Agent#call
       def to_sawyer_args
         [method, pathname, body, { headers: headers, query: query }]
       end
 
+      # Generate metadata for bugsnag.
+      # Blank parameter will be omitted.
+      #
+      # @return [Hash] Metadata for bugsnag
+      def to_bugsnag
+        {
+          line: "#{method.upcase} #{pathname}",
+          headers: headers,
+          query: query,
+          body: body,
+        }.compact
+      end
+
       # Returns contents as string for to be readable for human
       #
       # @return [String] Contents as string

data/lib/my_api_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport