pactas_itero 0.6.0 → 0.8.0

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## [UNRELEASED]
-### Added
 
+### Added
 ### Changed
 
 ### Deprecated
@@ -11,6 +11,39 @@
 
 ### Security
 
+## [0.8.0] - 2022-02-22
+
+# What's Changed
+
+## Added
+
+- Add Metered Usage call by @3wille in https://github.com/shipcloud/billwerk/pull/146
+
+## Changed
+
+- Fix current Rubocop Issues by @mortik in https://github.com/shipcloud/billwerk/pull/111
+- update ruby and introduce standardrb by @3wille in https://github.com/shipcloud/billwerk/pull/147
+
+**Diff**: https://github.com/shipcloud/billwerk/compare/v0.7.0...v0.8.0
+
+## [0.7.0] - 2022-02-22
+
+### Added
+
+- get contract_changes
+
+### Changed
+
+- Set required ruby version to >= 2.6
+- Replace Travis CI with CircleCI
+- `rubocop` version is specified to be `~> 1.8.1`
+- `performance` version is specified to be `~> 1.7.0`
+
+### Removed
+
+- Drop support for Ruby <= 2.5
+- Drop support for JRuby
+
 ## [0.6.0] - 2021-03-03
 ### Changed
 - `faraday_middleware` version is specified to be `>= 1.0.0`

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in pactas_itero.gemspec
 gemspec

data/README.md

@@ -1,4 +1,6 @@
-[![Build Status](https://travis-ci.org/shipcloud/pactas_itero.svg)](https://travis-ci.org/shipcloud/pactas_itero)
+[![CircleCI](https://circleci.com/gh/shipcloud/billwerk/tree/master.svg?style=svg)](https://circleci.com/gh/shipcloud/billwerk/tree/master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/cfbdd07da1f178c7fa9a/maintainability)](https://codeclimate.com/github/shipcloud/billwerk/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/cfbdd07da1f178c7fa9a/test_coverage)](https://codeclimate.com/github/shipcloud/billwerk/test_coverage)
 
 # PactasItero
 

data/Rakefile

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
+desc "start an irb console with pactas_itero required"
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require 'pactas_itero'
+  require "irb"
+  require "irb/completion"
+  require "pactas_itero"
   ARGV.clear
   IRB.start
 end

data/lib/pactas_itero/api/contracts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PactasItero
   module Api
     module Contracts
@@ -6,6 +8,11 @@ module PactasItero
         get "api/v1/customers/#{customer_id}/contracts", options
       end
 
+      def contract_changes(contract_id, options = {})
+        options = options.camelize_keys
+        get "api/v1/contractChanges", options.merge(contractId: contract_id)
+      end
+
       def contracts(options = {})
         options = options.camelize_keys
         get "api/v1/contracts", options
@@ -35,6 +42,11 @@ module PactasItero
         options = options.camelize_keys
         post "api/v1/contracts/#{contract_id}/end", options
       end
+
+      def contract_metered_usage(contract_id, options = {})
+        options = options.camelize_keys
+        post "api/v1/contracts/#{contract_id}/usage", options
+      end
     end
   end
 end

data/lib/pactas_itero/api/customers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PactasItero
   module Api
     module Customers

data/lib/pactas_itero/api/invoices.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 module PactasItero
   module Api
     module Invoices
-
       def invoices(options = {})
         options = options.camelize_keys
         get "api/v1/invoices", options
       end
 
-      def invoices_from(from_id=nil, options = {})
+      def invoices_from(from_id = nil, options = {})
         if from_id
           options = options.camelize_keys
           get "api/v1/invoices?from=#{from_id}", options

data/lib/pactas_itero/api/oauth.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 
 module PactasItero
   module Api
     module OAuth
       def token(options = {})
         options[:bearer_token_request] = true
-        options[:grant_type] ||= 'client_credentials'
-        post '/oauth/token', options
+        options[:grant_type] ||= "client_credentials"
+        post "/oauth/token", options
       end
     end
   end

data/lib/pactas_itero/api/orders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PactasItero
   module Api
     module Orders

data/lib/pactas_itero/api/rated_items.rb

@@ -1,7 +1,16 @@
+# frozen_string_literal: true
+
 module PactasItero
   module Api
     module RatedItems
-      def create_rated_item(contract_id, quantity, description, price_per_unit, tax_policy_id, options = {})
+      def create_rated_item(
+        contract_id,
+        quantity,
+        description,
+        price_per_unit,
+        tax_policy_id,
+        options = {}
+      )
         options.merge!(
           quantity: quantity,
           description: description,

data/lib/pactas_itero/api.rb

@@ -1,10 +1,12 @@
-require 'pactas_itero/ext/hash/camelize_keys'
-require 'pactas_itero/api/oauth'
-require 'pactas_itero/api/rated_items'
-require 'pactas_itero/api/customers'
-require 'pactas_itero/api/contracts'
-require 'pactas_itero/api/orders'
-require 'pactas_itero/api/invoices'
+# frozen_string_literal: true
+
+require "pactas_itero/ext/hash/camelize_keys"
+require "pactas_itero/api/oauth"
+require "pactas_itero/api/rated_items"
+require "pactas_itero/api/customers"
+require "pactas_itero/api/contracts"
+require "pactas_itero/api/orders"
+require "pactas_itero/api/invoices"
 require "pactas_itero/api/payment_transactions"
 
 module PactasItero

data/lib/pactas_itero/client.rb

@@ -1,7 +1,9 @@
-require 'base64'
-require 'rash'
-require 'pactas_itero/configurable'
-require 'pactas_itero/api'
+# frozen_string_literal: true
+
+require "base64"
+require "rash"
+require "pactas_itero/configurable"
+require "pactas_itero/api"
 
 module PactasItero
   class Client
@@ -12,7 +14,10 @@ module PactasItero
 
     def initialize(options = {})
       PactasItero::Configurable.keys.each do |key|
-        instance_variable_set(:"@#{key}", options[key] || PactasItero.instance_variable_get(:"@#{key}"))
+        instance_variable_set(
+          :"@#{key}",
+          options[key] || PactasItero.instance_variable_get(:"@#{key}")
+        )
       end
     end
 
@@ -47,42 +52,42 @@ module PactasItero
     private
 
     def connection
-      @connection ||= Faraday.new(api_endpoint, connection_options)
+      @_connection ||= Faraday.new(api_endpoint, connection_options)
     end
 
     def request(method, path, params = {})
       headers = params.delete(:headers) || {}
-      if accept = params.delete(:accept)
+      if (accept = params.delete(:accept))
         headers[:accept] = accept
       end
 
       bearer_token_request = params.delete(:bearer_token_request)
 
       if bearer_token_request
-        headers[:accept]        = '*/*'
+        headers[:accept] = "*/*"
         headers[:authorization] = bearer_token_credentials_auth_header
-        headers[:content_type]  = 'application/x-www-form-urlencoded; charset=UTF-8'
+        headers[:content_type] = "application/x-www-form-urlencoded; charset=UTF-8"
       else
         headers[:authorization] = auth_header
       end
 
-      response = connection.send(method.to_sym, path, params) {
-        |request| request.headers.update(headers)
-      }.env
+      response = connection.send(method.to_sym, path, params) do |request|
+        request.headers.update(headers)
+      end.env
       response.body
     end
 
     def connection_options
-      @connection_options ||= {
-        :builder => middleware,
-        :headers => {
-          :accept => default_media_type,
-          :user_agent => user_agent,
-        },
-        :request => {
-          :open_timeout => 10,
-          :timeout => 30,
+      @_connection_options ||= {
+        builder: middleware,
+        headers: {
+          accept: default_media_type,
+          user_agent: user_agent
         },
+        request: {
+          open_timeout: 10,
+          timeout: 30
+        }
       }
     end
 
@@ -92,11 +97,12 @@ module PactasItero
     end
 
     def bearer_auth_header
-      token = if bearer_token.respond_to?(:access_token)
-        bearer_token.access_token
-      else
-        bearer_token
-      end
+      token =
+        if bearer_token.respond_to?(:access_token)
+          bearer_token.access_token
+        else
+          bearer_token
+        end
       "Bearer #{token}"
     end
 

data/lib/pactas_itero/configurable.rb

@@ -1,14 +1,15 @@
-module PactasItero
+# frozen_string_literal: true
 
+module PactasItero
   module Configurable
     attr_accessor :bearer_token, :client_id, :client_secret, :user_agent,
-                  :default_media_type, :middleware, :production
+      :default_media_type, :middleware, :production
     attr_writer :api_endpoint
-    class << self
 
+    class << self
       # List of configurable keys for PactasItero::Client
       def keys
-        @keys ||= [
+        @_keys ||= [
           :bearer_token,
           :api_endpoint,
           :client_id,
@@ -33,12 +34,12 @@ module PactasItero
       end
       self
     end
-    alias setup reset!
+    alias_method :setup, :reset!
 
     def api_endpoint
       endpoint = @api_endpoint ||
-       production && production_api_endpoint ||
-       sandbox_api_endpoint
+        (production && production_api_endpoint) ||
+        sandbox_api_endpoint
       File.join(endpoint, "")
     end
 
@@ -53,7 +54,7 @@ module PactasItero
     private
 
     def options
-      Hash[PactasItero::Configurable.keys.map{|key| [key, send(:"#{key}")]}]
+      PactasItero::Configurable.keys.to_h { |key| [key, send(:"#{key}")] }
     end
   end
 end

data/lib/pactas_itero/default.rb

@@ -1,40 +1,39 @@
-require 'pactas_itero/response/raise_error'
-require 'pactas_itero/version'
-require 'faraday_middleware'
+# frozen_string_literal: true
 
-module PactasItero
+require "pactas_itero/response/raise_error"
+require "pactas_itero/version"
+require "faraday_middleware"
 
+module PactasItero
   # Default configuration options for {Client}
   module Default
+    SANDBOX_API_ENDPOINT = "https://sandbox.billwerk.com"
 
-    SANDBOX_API_ENDPOINT = "https://sandbox.billwerk.com".freeze
-
-    PRODUCTION_API_ENDPOINT = "https://app.billwerk.com".freeze
+    PRODUCTION_API_ENDPOINT = "https://app.billwerk.com"
 
     PRODUCTION = false
 
-    USER_AGENT   = "Pactas.Itero Ruby Gem #{PactasItero::VERSION}".freeze
+    USER_AGENT = "Pactas.Itero Ruby Gem #{PactasItero::VERSION}"
 
-    MEDIA_TYPE   = "application/json"
+    MEDIA_TYPE = "application/json"
 
     MIDDLEWARE = Faraday::RackBuilder.new do |builder|
       builder.request :json
       builder.use PactasItero::Response::RaiseError
       builder.response :rashify
       builder.request :url_encoded
-      builder.response :json, :content_type => /\bjson$/
+      builder.response :json, content_type: /\bjson$/
 
       builder.adapter Faraday.default_adapter
     end
 
     class << self
-
       def options
-        Hash[PactasItero::Configurable.keys.map{|key| [key, send(key)]}]
+        PactasItero::Configurable.keys.to_h { |key| [key, send(key)] }
       end
 
       def api_endpoint
-        ENV['PACTAS_ITERO_ENDPOINT']
+        ENV["PACTAS_ITERO_ENDPOINT"]
       end
 
       def sandbox_api_endpoint
@@ -50,19 +49,19 @@ module PactasItero
       end
 
       def client_id
-        ENV['PACTAS_ITERO_CLIENT_ID']
+        ENV["PACTAS_ITERO_CLIENT_ID"]
       end
 
       def client_secret
-        ENV['PACTAS_ITERO_CLIENT_SECRET']
+        ENV["PACTAS_ITERO_CLIENT_SECRET"]
       end
 
       def bearer_token
-        ENV['PACTAS_ITERO_BEARER_TOKEN']
+        ENV["PACTAS_ITERO_BEARER_TOKEN"]
       end
 
       def default_media_type
-        ENV['PACTAS_ITERO_CLIENT_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
+        ENV["PACTAS_ITERO_CLIENT_DEFAULT_MEDIA_TYPE"] || MEDIA_TYPE
       end
 
       def middleware
@@ -70,7 +69,7 @@ module PactasItero
       end
 
       def user_agent
-        ENV['PACTAS_ITERO_USER_AGENT'] || USER_AGENT
+        ENV["PACTAS_ITERO_USER_AGENT"] || USER_AGENT
       end
     end
   end

data/lib/pactas_itero/error.rb

@@ -1,45 +1,45 @@
+# frozen_string_literal: true
+
 module PactasItero
   # Custom error class for rescuing from all Pactas errors
   class Error < StandardError
-
     # Returns the appropriate PactasItero::Error sublcass based
     # on status and response message
     #
     # @param [Hash] response HTTP response
     # @return [PactasItero::Error]
     def self.from_response(response)
-      status  = response[:status].to_i
-      body    = response[:body].to_s
+      status = response[:status].to_i
+      body = response[:body].to_s
       headers = response[:response_headers]
 
-      if klass =  case status
-                  when 400      then PactasItero::BadRequest
-                  when 401      then error_for_401(headers)
-                  when 403      then error_for_403(body)
-                  when 404      then PactasItero::NotFound
-                  when 406      then PactasItero::NotAcceptable
-                  when 409      then PactasItero::Conflict
-                  when 415      then PactasItero::UnsupportedMediaType
-                  when 422      then PactasItero::UnprocessableEntity
-                  when 400..499 then PactasItero::ClientError
-                  when 500      then PactasItero::InternalServerError
-                  when 501      then PactasItero::NotImplemented
-                  when 502      then PactasItero::BadGateway
-                  when 503      then PactasItero::ServiceUnavailable
-                  when 500..599 then PactasItero::ServerError
-                  end
-        klass.new(response)
+      klass = case status
+      when 400 then PactasItero::BadRequest
+      when 401 then error_for401(headers)
+      when 403 then error_for403(body)
+      when 404 then PactasItero::NotFound
+      when 406 then PactasItero::NotAcceptable
+      when 409 then PactasItero::Conflict
+      when 415 then PactasItero::UnsupportedMediaType
+      when 422 then PactasItero::UnprocessableEntity
+      when 400..499 then PactasItero::ClientError
+      when 500 then PactasItero::InternalServerError
+      when 501 then PactasItero::NotImplemented
+      when 502 then PactasItero::BadGateway
+      when 503 then PactasItero::ServiceUnavailable
+      when 500..599 then PactasItero::ServerError
       end
+      klass&.new(response)
     end
 
-    def initialize(response=nil)
+    def initialize(response = nil)
       @response = response
       super(build_error_message)
     end
 
     # Returns most appropriate error for 401 HTTP status code
     # @private
-    def self.error_for_401(headers)
+    def self.error_for401(headers)
       if PactasItero::OneTimePasswordRequired.required_header(headers)
         PactasItero::OneTimePasswordRequired
       else
@@ -49,10 +49,11 @@ module PactasItero
 
     # Returns most appropriate error for 403 HTTP status code
     # @private
-    def self.error_for_403(body)
-      if body =~ /rate limit exceeded/i
+    def self.error_for403(body)
+      case body
+      when /rate limit exceeded/i
         PactasItero::TooManyRequests
-      elsif body =~ /login attempts exceeded/i
+      when /login attempts exceeded/i
         PactasItero::TooManyLoginAttempts
       else
         PactasItero::Forbidden
@@ -62,7 +63,7 @@ module PactasItero
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
-      if data && data.is_a?(Hash)
+      if data.is_a?(Hash)
         data[:errors] || []
       else
         []
@@ -72,18 +73,16 @@ module PactasItero
     private
 
     def data
-      @data ||=
+      @_data ||=
         if (body = @response[:body]) && !body.empty?
           if body.is_a?(String) &&
-            @response[:response_headers] &&
-            @response[:response_headers][:content_type] =~ /json/
+              @response[:response_headers] &&
+              @response[:response_headers][:content_type].include?("json")
 
             Sawyer::Agent.serializer.decode(body)
           else
             body
           end
-        else
-          nil
         end
     end
 
@@ -105,7 +104,7 @@ module PactasItero
 
       summary = "\nError summary:\n"
       summary << data[:errors].map do |hash|
-        hash.map { |k,v| "  #{k}: #{v}" }
+        hash.map { |k, v| "  #{k}: #{v}" }
       end.join("\n")
 
       summary
@@ -114,19 +113,21 @@ module PactasItero
     def build_error_message
       return nil if @response.nil?
 
-      message =  "#{@response[:method].to_s.upcase} "
-      message << redact_url(@response[:url].to_s) + ": "
-      message << "#{@response[:status]} - "
-      message << "#{response_message}" unless response_message.nil?
-      message << "#{response_error}" unless response_error.nil?
-      message << "#{response_error_summary}" unless response_error_summary.nil?
-      message
+      [
+        "#{@response[:method].to_s.upcase} ",
+        "#{redact_url(@response[:url].to_s)}: ",
+        "#{@response[:status]} - ",
+        (response_message.to_s unless response_message.nil?),
+        (response_error.to_s unless response_error.nil?),
+        (response_error_summary.to_s unless response_error_summary.nil?)
+      ].compact.join
     end
 
     def redact_url(url_string)
       %w[client_secret access_token].each do |token|
         url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
       end
+
       url_string
     end
   end
@@ -143,25 +144,25 @@ module PactasItero
   # Raised when Pactas returns a 401 HTTP status code
   # and headers include "X-Pactas-OTP"
   class OneTimePasswordRequired < ClientError
-    #@private
+    # @private
     OTP_DELIVERY_PATTERN = /required; (\w+)/i
 
-    #@private
+    # @private
     def self.required_header(headers)
-      OTP_DELIVERY_PATTERN.match headers['X-Pactas-OTP'].to_s
+      OTP_DELIVERY_PATTERN.match headers["X-Pactas-OTP"].to_s
     end
 
     # Delivery method for the user's OTP
     #
     # @return [String]
     def password_delivery
-      @password_delivery ||= delivery_method_from_header
+      @_password_delivery ||= delivery_method_from_header
     end
 
     private
 
     def delivery_method_from_header
-      if match = self.class.required_header(@response[:response_headers])
+      if (match = self.class.required_header(@response[:response_headers]))
         match[1]
       end
     end

data/lib/pactas_itero/ext/hash/camelize_keys.rb

@@ -1,22 +1,24 @@
-class Hash
+# frozen_string_literal: true
 
+class Hash
   def camelize_keys(value = self)
     case value
-      when Array
-        value.map { |v| camelize_keys(v) }
-      when Hash
-        Hash[value.map { |k, v| [camelize_key(k), camelize_keys(v)] }]
-      else
-        value
+    when Array
+      value.map { |v| camelize_keys(v) }
+    when Hash
+      value.to_h { |k, v| [camelize_key(k), camelize_keys(v)] }
+    else
+      value
     end
   end
 
   private
 
   def camelize_key(key)
-    if key.is_a? Symbol
+    case key
+    when Symbol
       camelize(key.to_s).to_sym
-    elsif key.is_a? String
+    when String
       camelize(key)
     else
       key
@@ -27,6 +29,6 @@ class Hash
   def camelize(term)
     string = term.to_s
     string = string.sub(/^[a-z\d]*/) { $&.capitalize }
-    string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+    string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
   end
 end