pactas_itero 0.7.0 → 0.8.0

data/CHANGELOG.md

@@ -11,6 +11,21 @@
 
 ### 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

data/Gemfile

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

data/Rakefile

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

data/lib/pactas_itero/api/contracts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PactasItero
   module Api
     module Contracts
@@ -40,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,3 +1,5 @@
+# frozen_string_literal: true
+
 module PactasItero
   module Api
     module Invoices

data/lib/pactas_itero/api/oauth.rb

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

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,12 +1,21 @@
+# 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,
           price_per_unit: price_per_unit,
-          tax_policy_id: tax_policy_id,
+          tax_policy_id: tax_policy_id
         )
         options = options.camelize_keys
         post "api/v1/contracts/#{contract_id}/ratedItems", options

data/lib/pactas_itero/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pactas_itero/ext/hash/camelize_keys"
 require "pactas_itero/api/oauth"
 require "pactas_itero/api/rated_items"

data/lib/pactas_itero/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "base64"
 require "rash"
 require "pactas_itero/configurable"
@@ -14,7 +16,7 @@ module PactasItero
       PactasItero::Configurable.keys.each do |key|
         instance_variable_set(
           :"@#{key}",
-          options[key] || PactasItero.instance_variable_get(:"@#{key}"),
+          options[key] || PactasItero.instance_variable_get(:"@#{key}")
         )
       end
     end
@@ -50,21 +52,21 @@ 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
@@ -76,16 +78,16 @@ module PactasItero
     end
 
     def connection_options
-      @connection_options ||= {
+      @_connection_options ||= {
         builder: middleware,
         headers: {
           accept: default_media_type,
-          user_agent: user_agent,
+          user_agent: user_agent
         },
         request: {
           open_timeout: 10,
-          timeout: 30,
-        },
+          timeout: 30
+        }
       }
     end
 

data/lib/pactas_itero/configurable.rb

@@ -1,13 +1,15 @@
+# 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
       # List of configurable keys for PactasItero::Client
       def keys
-        @keys ||= [
+        @_keys ||= [
           :bearer_token,
           :api_endpoint,
           :client_id,
@@ -15,7 +17,7 @@ module PactasItero
           :user_agent,
           :default_media_type,
           :middleware,
-          :production,
+          :production
         ]
       end
     end
@@ -32,11 +34,11 @@ module PactasItero
       end
       self
     end
-    alias setup reset!
+    alias_method :setup, :reset!
 
     def api_endpoint
       endpoint = @api_endpoint ||
-        production && production_api_endpoint ||
+        (production && production_api_endpoint) ||
         sandbox_api_endpoint
       File.join(endpoint, "")
     end
@@ -52,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,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pactas_itero/response/raise_error"
 require "pactas_itero/version"
 require "faraday_middleware"
@@ -5,15 +7,15 @@ require "faraday_middleware"
 module PactasItero
   # Default configuration options for {Client}
   module Default
-    SANDBOX_API_ENDPOINT = "https://sandbox.billwerk.com".freeze
+    SANDBOX_API_ENDPOINT = "https://sandbox.billwerk.com"
 
-    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
@@ -27,7 +29,7 @@ module PactasItero
 
     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

data/lib/pactas_itero/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PactasItero
   # Custom error class for rescuing from all Pactas errors
   class Error < StandardError
@@ -7,28 +9,27 @@ module PactasItero
     # @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)
@@ -38,7 +39,7 @@ module PactasItero
 
     # 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
@@ -48,10 +49,11 @@ module PactasItero
 
     # Returns most appropriate error for 403 HTTP status code
     # @private
-    def self.error_for_403(body)
-      if /rate limit exceeded/i.match?(body)
+    def self.error_for403(body)
+      case body
+      when /rate limit exceeded/i
         PactasItero::TooManyRequests
-      elsif /login attempts exceeded/i.match?(body)
+      when /login attempts exceeded/i
         PactasItero::TooManyLoginAttempts
       else
         PactasItero::Forbidden
@@ -61,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
         []
@@ -71,11 +73,11 @@ 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][:content_type].include?("json")
 
             Sawyer::Agent.serializer.decode(body)
           else
@@ -111,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.to_s unless response_message.nil?
-      message << response_error.to_s unless response_error.nil?
-      message << response_error_summary.to_s 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
@@ -152,13 +156,13 @@ module PactasItero
     #
     # @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,10 +1,12 @@
+# 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)] }]
+      value.to_h { |k, v| [camelize_key(k), camelize_keys(v)] }
     else
       value
     end
@@ -13,9 +15,10 @@ class Hash
   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

data/lib/pactas_itero/response/raise_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 require "pactas_itero/error"
 
@@ -8,7 +10,7 @@ module PactasItero
     # HTTP status codes returned by the API
     class RaiseError < Faraday::Middleware
       def on_complete(response)
-        if error = PactasItero::Error.from_response(response)
+        if (error = PactasItero::Error.from_response(response))
           raise error
         end
       end

data/lib/pactas_itero/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PactasItero
-  VERSION = "0.7.0".freeze
+  VERSION = "0.8.0"
 end

data/lib/pactas_itero.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pactas_itero/client"
 require "pactas_itero/default"
 
@@ -13,7 +15,7 @@ module PactasItero
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      method_name != :client && client.respond_to?(method_name, include_private) || super
+      (method_name != :client && client.respond_to?(method_name, include_private)) || super
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pactas_itero
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Simon Fröhler
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.11.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.25.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.13.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.13.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -141,18 +127,17 @@ description: |-
       the Pactas Itero API, making it easy to post your data to, and read your
       data from your Pactas account.
 email: simon@shipcloud.io
-executables:
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/setup
 - lib/pactas_itero.rb
 - lib/pactas_itero/api.rb
 - lib/pactas_itero/api/contracts.rb
@@ -169,40 +154,11 @@ files:
 - lib/pactas_itero/ext/hash/camelize_keys.rb
 - lib/pactas_itero/response/raise_error.rb
 - lib/pactas_itero/version.rb
-- pactas_itero.gemspec
-- spec/fixtures/bearer_token.json
-- spec/fixtures/commit_order_response.json
-- spec/fixtures/contract.json
-- spec/fixtures/contract_cancellation_preview_response.json
-- spec/fixtures/contract_changes.json
-- spec/fixtures/contract_termination_response.json
-- spec/fixtures/contracts.json
-- spec/fixtures/create_order_response.json
-- spec/fixtures/create_rated_item.json
-- spec/fixtures/customer.json
-- spec/fixtures/customers.json
-- spec/fixtures/invoice.json
-- spec/fixtures/invoice_download.pdf
-- spec/fixtures/invoices.json
-- spec/fixtures/order.json
-- spec/fixtures/payment_transaction.json
-- spec/fixtures/rated_items.json
-- spec/fixtures/self_service_token.json
-- spec/pactas_itero/api/contracts_spec.rb
-- spec/pactas_itero/api/customers_spec.rb
-- spec/pactas_itero/api/invoices_spec.rb
-- spec/pactas_itero/api/oauth_spec.rb
-- spec/pactas_itero/api/orders_spec.rb
-- spec/pactas_itero/api/payment_transactions_spec.rb
-- spec/pactas_itero/api/rated_items_spec.rb
-- spec/pactas_itero/client_spec.rb
-- spec/pactas_itero_spec.rb
-- spec/spec_helper.rb
-- yarn-error.log
 homepage: https://github.com/webionate/pactas_itero
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -218,36 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: pactas_itero provides a client mapping for accessing the Pactas Itero API.
-test_files:
-- spec/fixtures/bearer_token.json
-- spec/fixtures/commit_order_response.json
-- spec/fixtures/contract.json
-- spec/fixtures/contract_cancellation_preview_response.json
-- spec/fixtures/contract_changes.json
-- spec/fixtures/contract_termination_response.json
-- spec/fixtures/contracts.json
-- spec/fixtures/create_order_response.json
-- spec/fixtures/create_rated_item.json
-- spec/fixtures/customer.json
-- spec/fixtures/customers.json
-- spec/fixtures/invoice.json
-- spec/fixtures/invoice_download.pdf
-- spec/fixtures/invoices.json
-- spec/fixtures/order.json
-- spec/fixtures/payment_transaction.json
-- spec/fixtures/rated_items.json
-- spec/fixtures/self_service_token.json
-- spec/pactas_itero/api/contracts_spec.rb
-- spec/pactas_itero/api/customers_spec.rb
-- spec/pactas_itero/api/invoices_spec.rb
-- spec/pactas_itero/api/oauth_spec.rb
-- spec/pactas_itero/api/orders_spec.rb
-- spec/pactas_itero/api/payment_transactions_spec.rb
-- spec/pactas_itero/api/rated_items_spec.rb
-- spec/pactas_itero/client_spec.rb
-- spec/pactas_itero_spec.rb
-- spec/spec_helper.rb
+test_files: []