dear_inventory 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9c77cee55f30ac5aa4b5484b178363db30d6663eb172ba429d3be826ac37219
-  data.tar.gz: 115c30635a886a41f6c93d3e8bb063679a97c39ae9d336c839105d396a5bc0bb
+  metadata.gz: 71b2b64af358567bd4f1a475d081aafd3c00150872a11fb7628fdbfbb97dc2c7
+  data.tar.gz: 0c4caf15c3e4b827f08062219c903e33110e01576f3c7cbce7baa7f834299a6c
 SHA512:
-  metadata.gz: e1765c2d3e0a524c3c5a1227f78771277e8b9638b0437e036d3ece6f2a543e583e72b6b90026aa61a96b4569e944b3bd13223ca06a5722da19e364a427405c10
-  data.tar.gz: b117b2fde79191b2a5f160088093b35b8d6941652fcd2bc4c2efe3265689ee3e6374b35e25b2c3de5e1332bd5c7dfddcf6c03cdc889670c0a7e21d7ce7babdf0
+  metadata.gz: 0b4196a33a0f47a82bee9dd375e30d24ffd560fd9f122dc88a3cd24278edd118a5bb729ee1fe8e71077b7b290561fbdd857cad0656f15a3a783fbedf272f0250
+  data.tar.gz: 59c6329f0930b9d1e8ca0324fb00171172cc5bb05f6bf0b90dd441d8701a4eecc2b378fa1c1e7a35546bf919b39e293572766e79dd78b52a6ee8f7c221781122

data/.rubocop.yml

@@ -1,9 +1,10 @@
-require:
+plugins:
   - rubocop-performance
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.4
+  NewCops: enable
   Exclude:
     - bin/**/*
 
@@ -30,6 +31,9 @@ Lint/AmbiguousBlockAssociation:
   Exclude:
     - spec/**/*
 
+Lint/MissingSuper:
+  Enabled: false
+
 Lint/RaiseException:
   Enabled: true
 
@@ -42,9 +46,14 @@ Metrics/BlockLength:
     - spec/**/*
 
 Metrics/ClassLength:
-  Max: 150
+  Max: 115
   Exclude:
     - lib/dear_inventory/models/**/*
+    - lib/dear_inventory/parameters.rb
+    - lib/dear_inventory/parameters/**/*
+
+Naming/VariableNumber:
+  Enabled: false
 
 RSpec/BeforeAfterAll:
   Enabled: false
@@ -58,7 +67,7 @@ RSpec/MultipleExpectations:
 RSpec/NestedGroups:
   Max: 4
 
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Enabled: false
 
 Security/Eval:

data/Gemfile

@@ -4,3 +4,17 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in dear_inventory.gemspec
 gemspec
+
+group :development, :test do
+  gem "bundler", "~> 2.0"
+  gem "byebug"
+  gem "dotenv"
+  gem "pry-byebug"
+  gem "rake", ">= 13.0.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.81"
+  gem "rubocop-performance"
+  gem "rubocop-rspec"
+  gem "vcr"
+  gem "webmock"
+end

data/README.md

@@ -20,21 +20,12 @@ Or install it yourself as:
 
     $ gem install dear_inventory
 
-## N.B for Ruby 2.7
-
-At time of writing, the Sorbet team has not yet accepted my pull request to fix deprecation warnings due to the use of the single splat operator. It can be quite frustrating to have your console flooded with warnings and so it may be worth your while specifying my fork of sorbet-runtime in your project's Gemfile:
-```
-gem "sorbet-runtime",
-    git: "https://github.com/HashNotAdam/sorbet.git",
-    branch: "feature/ruby_2_7_keyword_arguments",
-    glob: "gems/sorbet-runtime/sorbet-runtime.gemspec"
-```
-
 ## Configuration
 
 Before you begin, you will need to setup API credentials in DEAR Inventory at https://inventory.dearsystems.com/ExternalApi
 
 Next you need to supply your API credentials:
+
 ```ruby
 require "dear_inventory"
 

data/dear_inventory.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://morningcoffee.com.au"
   spec.license = "MIT"
 
-  spec.required_ruby_version = ">= 2.5.0"
-  spec.required_rubygems_version = ">= 1.8.11"
+  spec.required_ruby_version = ">= 3.4.0"
+  spec.required_rubygems_version = ">= 3.6.0"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.
@@ -28,19 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
   spec.add_dependency "http", ">= 5.0", "< 6.0"
-  spec.add_dependency "sorbet-runtime"
+  spec.add_dependency "logger"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.71"
-  spec.add_development_dependency "rubocop-performance"
-  spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "sorbet"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/dear_inventory/config.rb

@@ -1,38 +1,24 @@
-# typed: ignore
 # frozen_string_literal: true
 
 require "logger"
 
 module DearInventory
   class Config
-    extend T::Sig
+    attr_accessor :account_id, :key, :logger
 
-    sig { returns(T.nilable(String)) }
-    attr_accessor :account_id
-
-    sig { returns(T.nilable(String)) }
-    attr_accessor :key
-
-    sig { returns(T.untyped) }
-    attr_accessor :logger
-
-    sig { void }
     def initialize
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
       @logger.level = Logger::WARN
     end
 
-    sig { returns(DearInventory::Environment.class) }
     def environment
       DearInventory::Environment
     end
 
-    sig { params(value: Symbol).void }
     def environment=(value)
       DearInventory::Environment.set(value)
     end
 
-    sig { params(param: Symbol).returns(String) }
     def require(param)
       value = public_send(param)
       return value unless value.nil? || value.empty?
@@ -40,26 +26,27 @@ module DearInventory
       require_error(param)
     end
 
-    sig { params(param: Symbol).returns(String) }
     def require_parameter(param)
       require(param)
     rescue ArgumentError => e
-      message = e.message + "\n" \
-        "Alternatively, you can pass dynamic values with your request " \
-        "parameters"
+      message = <<~MESSAGE
+        #{e.message}
+        Alternatively, you can pass dynamic values with your request parameters
+      MESSAGE
       raise ArgumentError, message
     end
 
     private
 
-    sig { params(param: Symbol).void }
     def require_error(param)
       raise(
         ArgumentError,
-        "#{param} is required but hasn't been set.\n" \
-          "DearInventory.configure do |config|\n" +
-          %(  config.#{param} = "value") + "\n" \
-          "end"
+        <<~MESSAGE
+          #{param} is required but hasn't been set.
+          DearInventory.configure do |config|
+            config.#{param} = "value"
+          end
+        MESSAGE
       )
     end
   end

data/lib/dear_inventory/environment.rb

@@ -1,4 +1,3 @@
-# typed: ignore
 # frozen_string_literal: true
 
 # Usually this class wouldn't be called directly, the environment can be managed
@@ -27,7 +26,7 @@ module DearInventory
         raise(
           ArgumentError,
           "#{error_value} is not an acceptable environment; " \
-            "please use either :production or :test"
+          "please use either :production or :test"
         )
       end
 

data/lib/dear_inventory/error.rb

@@ -1,16 +1,11 @@
-# typed: strong
 # frozen_string_literal: true
 
 module DearInventory
   class Error < StandardError
-    extend T::Sig
-
-    sig { returns(T.nilable(String)) }
     attr_reader :message
 
-    sig { params(message: T.nilable(String)).void }
     def initialize(message = nil)
-      @message = T.let(message, T.nilable(String))
+      @message = message
     end
   end
 end

data/lib/dear_inventory/errors/api_limit.rb

@@ -1,4 +1,3 @@
-# typed: strong
 # frozen_string_literal: true
 
 module DearInventory

data/lib/dear_inventory/errors/bad_request.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 module DearInventory

data/lib/dear_inventory/errors/no_more_pages.rb

@@ -1,4 +1,3 @@
-# typed: strong
 # frozen_string_literal: true
 
 module DearInventory

data/lib/dear_inventory/errors/not_paginated.rb

@@ -1,16 +1,7 @@
-# typed: strict
 # frozen_string_literal: true
 
 module DearInventory
   class NotPaginatedError < Error
-    extend T::Sig
-
-    sig do
-      params(
-        message: T.nilable(String),
-        uri: String
-      ).void
-    end
     def initialize(message = nil, uri:)
       message ||= "The endpoint (#{uri}) is not paginated"
       super(message)

data/lib/dear_inventory/errors/request.rb

@@ -1,23 +1,13 @@
-# typed: strict
 # frozen_string_literal: true
 
 module DearInventory
   class RequestError < Error
-    extend T::Sig
-
-    sig { returns(T.nilable(DearInventory::Response)) }
     attr_reader :response
 
-    sig do
-      params(
-        message: T.nilable(String),
-        response: T.nilable(DearInventory::Response)
-      ).void
-    end
     def initialize(message = nil, response = nil)
       super(message)
 
-      @response = T.let(response, T.nilable(DearInventory::Response))
+      @response = response
     end
   end
 end

data/lib/dear_inventory/errors/validation.rb

@@ -1,4 +1,3 @@
-# typed: strong
 # frozen_string_literal: true
 
 module DearInventory

data/lib/dear_inventory/lib/date_time.rb

@@ -1,16 +1,11 @@
-# typed: strict
 # frozen_string_literal: true
 
 module DearInventory
   class DateTime
-    extend T::Sig
-
-    sig { params(date: T.any(Date, Time)).void }
     def initialize(date)
-      @date = T.let(date, T.any(Date, Time))
+      @date = date
     end
 
-    sig { returns(String) }
     def to_s
       @date.strftime("%FT%T")
     end

data/lib/dear_inventory/lib/endpoint_class.rb

@@ -1,19 +1,7 @@
-# typed: strict
 # frozen_string_literal: true
 
 module DearInventory
   class EndpointClass
-    extend T::Sig
-
-    sig do
-      params(
-        class_type: String,
-        resource_class: T.class_of(DearInventory::Resource),
-        endpoint: T.nilable(String)
-      ).returns(
-        T.nilable(T.class_of(DearInventory::Parameters))
-      )
-    end
     def self.call(class_type:, resource_class:, endpoint:)
       new(
         class_type: class_type,
@@ -22,28 +10,19 @@ module DearInventory
       ).call
     end
 
-    sig do
-      params(
-        class_type: String,
-        resource_class: T.class_of(DearInventory::Resource),
-        endpoint: T.nilable(String)
-      ).void
-    end
     def initialize(class_type:, resource_class:, endpoint:)
-      @class_type = T.let(class_type, String)
-      @resource_class = T.let(resource_class, T.untyped)
-      @endpoint = T.let(endpoint || "Index", String)
-      @class_name = T.let(nil, T.nilable(String))
+      @class_type = class_type
+      @resource_class = resource_class
+      @endpoint = endpoint || "Index"
+      @class_name = nil
     end
 
-    sig { returns(T.nilable(T.class_of(DearInventory::Parameters))) }
     def call
       Object.const_get(class_name) if Object.const_defined?(class_name)
     end
 
     private
 
-    sig { returns(String) }
     def class_name
       @class_name ||= begin
         name = ["DearInventory"]

data/lib/dear_inventory/lib/is_a_subclass.rb

@@ -1,17 +1,11 @@
-# typed: strict
 # frozen_string_literal: true
 
 module DearInventory
   module IsASubclass
-    extend T::Sig
-
-    sig { params(comparison_class: T.untyped).returns(T::Boolean) }
     def is_a?(comparison_class)
       return true if super
 
-      if T.unsafe(self).class == Class
-        return T.unsafe(self).ancestors.include?(comparison_class)
-      end
+      return self <= comparison_class if instance_of?(Class)
 
       false
     end

data/lib/dear_inventory/lib/request.rb

@@ -1,33 +1,17 @@
-# typed: strict
 # frozen_string_literal: true
 
 module DearInventory
   class Request
-    extend T::Sig
-
-    sig do
-      params(
-        parameters: DearInventory::Models::Request,
-        num_previous_records: Integer
-      ).returns(DearInventory::Response)
-    end
     def self.call(parameters, num_previous_records: 0)
       new(parameters, num_previous_records: num_previous_records).call
     end
 
-    sig do
-      params(
-        parameters: DearInventory::Models::Request,
-        num_previous_records: Integer
-      ).void
-    end
     def initialize(parameters, num_previous_records: 0)
-      @parameters = T.let(parameters, DearInventory::Models::Request)
-      @num_previous_records = T.let(num_previous_records, Integer)
-      @retries = T.let(0, Integer)
+      @parameters = parameters
+      @num_previous_records = num_previous_records
+      @retries = 0
     end
 
-    sig { returns(DearInventory::Response) }
     def call
       options = request_params(@parameters.action, @parameters.params)
       response = HTTP.headers(headers).
@@ -44,7 +28,6 @@ module DearInventory
 
     private
 
-    sig { returns(T::Hash[Symbol, String]) }
     def headers
       {
         "Content-Type": "application/json",
@@ -53,10 +36,6 @@ module DearInventory
       }
     end
 
-    sig do
-      params(action: Symbol, params: DearInventory::Parameters).
-        returns(T::Hash[Symbol, T::Hash[Symbol, T.untyped]])
-    end
     def request_params(action, params)
       if %i[get delete].include?(action)
         { params: params.to_h }
@@ -65,17 +44,13 @@ module DearInventory
       end
     end
 
-    ERROR_MESSAGE_PREFIXES = T.let(
-      {
-        DearInventory::APILimitError => "The API request limit was reached",
-        HTTP::ConnectionError => "There was an error connecting to the API",
-      }.freeze,
-      T::Hash[T.class_of(StandardError), String]
-    )
-    MAX_RETRIES = T.let(4, Integer)
-    RETRY_DELAY = T.let(5, Integer)
-
-    sig { params(error: StandardError).returns(DearInventory::Response) }
+    ERROR_MESSAGE_PREFIXES = {
+      DearInventory::APILimitError => "The API request limit was reached",
+      HTTP::ConnectionError => "There was an error connecting to the API",
+    }.freeze
+    MAX_RETRIES = 4
+    RETRY_DELAY = 5
+    private_constant :ERROR_MESSAGE_PREFIXES, :MAX_RETRIES, :RETRY_DELAY
     def retry_request(error)
       @retries += 1
       raise if @retries >= MAX_RETRIES

data/lib/dear_inventory/lib/strings/urlize.rb

@@ -1,11 +1,7 @@
-# typed: strict
 # frozen_string_literal: true
 
 module Strings
   class Urlize
-    extend T::Sig
-
-    sig { params(camel_cased_word: String).returns(String) }
     def self.call(camel_cased_word)
       return camel_cased_word unless /[A-Z_]/.match?(camel_cased_word)
 

data/lib/dear_inventory/model.rb

@@ -1,4 +1,3 @@
-# typed: true
 # frozen_string_literal: true
 
 require "bigdecimal/util"
@@ -6,90 +5,47 @@ require "json"
 
 module DearInventory
   class Model
-    extend T::Sig
-    extend T::Helpers
-    abstract!
-
     extend DearInventory::IsASubclass
 
-    sig do
-      params(
-        fields: T::Hash[
-          Symbol,
-          T::Hash[Symbol, T.any(Symbol, T.class_of(DearInventory::Model))]
-        ]
-      ).void
-    end
     def self.fields(fields)
-      ancestor = T.must(ancestors[1])
-      if ancestor.const_defined?(:FIELDS)
-        fields = ancestor.const_get(:FIELDS).merge(fields)
-      end
+      ancestor = ancestors[1]
+      fields = ancestor.const_get(:FIELDS).merge(fields) if ancestor.const_defined?(:FIELDS)
       const_set(:FIELDS, fields.freeze)
 
       define_readers
     end
 
-    sig { void }
     def self.define_readers
       enumerate_fields do |_, specifications|
         __send__(:attr_reader, specifications[:name])
 
-        if specifications[:type] == :ResultSet
-          alias_method :records, specifications[:name]
-        end
+        alias_method :records, specifications[:name] if specifications[:type] == :ResultSet
       end
     end
 
-    sig { void }
-    def self.enumerate_fields
-      const_get(:FIELDS).each do |response_name, specifications|
-        yield(response_name, specifications)
-      end
+    def self.enumerate_fields(&)
+      const_get(:FIELDS).each(&)
     end
 
-    alias initialize_abstract initialize
-
-    sig do
-      params(values: T.nilable(T::Hash[T.any(String, Symbol), T.untyped])).void
-    end
     def initialize(values = nil)
-      initialize_abstract
-
       return if values.nil?
 
       self.class.enumerate_fields do |response_name, specifications|
-        value = field_value(response_name, T.must(values), specifications)
+        value = field_value(response_name, values, specifications)
         instance_variable_set(:"@#{specifications[:name]}", value)
       end
     end
 
-    sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h
       {}.tap do |hash|
-        self.class.enumerate_fields do |_, specifications|
-          key = specifications[:name]
-          hash[key] = public_send(key)
-        end
+        attributes_to_hash(hash)
       end
     end
 
     private
 
-    sig do
-      params(
-        response_name: Symbol,
-        values:
-          T::Hash[T.any(String, Symbol), T.untyped],
-        specifications:
-          T::Hash[Symbol, T.any(Symbol, T.class_of(DearInventory::Model))]
-      ).returns(T.untyped)
-    end
     def field_value(response_name, values, specifications)
-      model = T.cast(
-        specifications[:model],
-        T.nilable(T.class_of(DearInventory::Model))
-      )
+      model = specifications[:model]
       value = values[response_name.to_s]
       return if value == ""
 
@@ -101,7 +57,7 @@ module DearInventory
     def format_value(value, type, model)
       case type
       when :Array, :ResultSet
-        initialize_array_values_in_models(value, T.must(model))
+        initialize_array_values_in_models(value, model)
       when :BigDecimal
         value.to_d
       when :Date
@@ -109,7 +65,9 @@ module DearInventory
       when :DateTime
         ::DateTime.parse(value) unless value.nil?
       when :Hash
-        T.must(model).new(value)
+        model.new(value)
+      when :Integer
+        value.to_i
       else
         value
       end
@@ -117,12 +75,21 @@ module DearInventory
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
 
-    sig do
-      params(
-        array: T.nilable(T::Array[T::Hash[T.any(String, Symbol), T.untyped]]),
-        model: T.class_of(DearInventory::Model)
-      ).returns(T.nilable(T::Array[DearInventory::Model]))
+    def attributes_to_hash(hash)
+      self.class.enumerate_fields do |_, specifications|
+        key = specifications[:name]
+        hash[key] = public_send(key)
+
+        nested_attributes_to_hash(hash[key]) if hash[key].is_a?(Array)
+      end
     end
+
+    def nested_attributes_to_hash(collection)
+      collection.each_with_index do |record, index|
+        collection[index] = record.to_h
+      end
+    end
+
     def initialize_array_values_in_models(array, model)
       return if array.nil?
 

data/lib/dear_inventory/models/additional_attributes.rb

@@ -1,11 +1,8 @@
-# typed: strong
 # frozen_string_literal: true
 
 module DearInventory
   module Models
     class AdditionalAttributes < DearInventory::Model
-      extend T::Sig
-
       fields(
         AdditionalAttribute1: {
           name: :additional_attribute_1,

data/lib/dear_inventory/models/address.rb

@@ -1,11 +1,8 @@
-# typed: strong
 # frozen_string_literal: true
 
 module DearInventory
   module Models
     class Address < DearInventory::Model
-      extend T::Sig
-
       fields(
         DisplayAddressLine1: {
           name: :display_address_line_1,