lunchmoney 1.4.0 → 1.5.0

data/lib/lunchmoney/calls/recurring_expenses.rb

@@ -17,11 +17,10 @@ module LunchMoney
         params = clean_params({ start_date:, end_date: })
         response = get("recurring_expenses", query_params: params)
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        response.body[:recurring_expenses].map do |recurring_expense|
-          LunchMoney::Objects::RecurringExpense.new(**recurring_expense)
+        handle_api_response(response) do |body|
+          body[:recurring_expenses].map do |recurring_expense|
+            LunchMoney::Objects::RecurringExpense.new(**recurring_expense)
+          end
         end
       end
     end

data/lib/lunchmoney/calls/tags.rb

@@ -11,10 +11,9 @@ module LunchMoney
       def tags
         response = get("tags")
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        response.body.map { |tag| LunchMoney::Objects::Tag.new(**tag) }
+        handle_api_response(response) do |body|
+          body.map { |tag| LunchMoney::Objects::Tag.new(**tag) }
+        end
       end
     end
   end

data/lib/lunchmoney/calls/transactions.rb

@@ -42,7 +42,6 @@ module LunchMoney
         offset: nil,
         limit: nil
       )
-
         params = clean_params({
           tag_id:,
           recurring_id:,
@@ -60,17 +59,16 @@ module LunchMoney
         })
         response = get("transactions", query_params: params)
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
+        handle_api_response(response) do |body|
+          body[:transactions].map do |transaction|
+            transaction[:tags].map! { |tag| LunchMoney::Objects::TagBase.new(**tag) }
 
-        response.body[:transactions].map do |transaction|
-          transaction[:tags].map! { |tag| LunchMoney::Objects::TagBase.new(**tag) }
+            transaction[:children]&.map! do |child_transaction|
+              LunchMoney::Objects::ChildTransaction.new(**child_transaction)
+            end
 
-          transaction[:children]&.map! do |child_transaction|
-            LunchMoney::Objects::ChildTransaction.new(**child_transaction)
+            LunchMoney::Objects::Transaction.new(**transaction)
           end
-
-          LunchMoney::Objects::Transaction.new(**transaction)
         end
       end
 
@@ -84,10 +82,9 @@ module LunchMoney
         params = clean_params({ debit_as_negative: })
         response = get("transactions/#{transaction_id}", query_params: params)
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        LunchMoney::Objects::Transaction.new(**response.body)
+        handle_api_response(response) do |body|
+          LunchMoney::Objects::Transaction.new(**body)
+        end
       end
 
       sig do
@@ -112,10 +109,9 @@ module LunchMoney
         })
         response = post("transactions", params)
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        response.body
+        handle_api_response(response) do |body|
+          body
+        end
       end
 
       sig do
@@ -142,10 +138,9 @@ module LunchMoney
         })
         response = put("transactions/#{transaction_id}", params)
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        response.body
+        handle_api_response(response) do |body|
+          body
+        end
       end
 
       sig do
@@ -158,20 +153,18 @@ module LunchMoney
         params = { parent_ids:, remove_parents: }
         response = post("transactions/unsplit", params)
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        response.body
+        handle_api_response(response) do |body|
+          body
+        end
       end
 
       sig { params(transaction_id: Integer).returns(T.any(LunchMoney::Objects::Transaction, LunchMoney::Errors)) }
       def transaction_group(transaction_id)
         response = get("transactions/group", query_params: { transaction_id: })
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        LunchMoney::Objects::Transaction.new(**response.body)
+        handle_api_response(response) do |body|
+          LunchMoney::Objects::Transaction.new(**body)
+        end
       end
 
       sig do
@@ -195,10 +188,9 @@ module LunchMoney
         })
         response = post("transactions/group", params)
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        response.body
+        handle_api_response(response) do |body|
+          body
+        end
       end
 
       sig do
@@ -210,10 +202,9 @@ module LunchMoney
       def delete_transaction_group(transaction_id)
         response = delete("transactions/group/#{transaction_id}")
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        response.body
+        handle_api_response(response) do |body|
+          body
+        end
       end
     end
   end

data/lib/lunchmoney/calls/users.rb

@@ -11,10 +11,9 @@ module LunchMoney
       def me
         response = get("me")
 
-        api_errors = errors(response)
-        return api_errors if api_errors.present?
-
-        LunchMoney::Objects::User.new(**response.body)
+        handle_api_response(response) do |body|
+          LunchMoney::Objects::User.new(**body)
+        end
       end
     end
   end

data/lib/lunchmoney/configuration.rb

@@ -22,5 +22,25 @@ module LunchMoney
       @api_key = ENV.fetch("LUNCHMONEY_TOKEN", nil)
       @validate_object_attributes = T.let(true, T::Boolean)
     end
+
+    sig { returns(T::Array[String]) }
+    def validation_errors
+      errors = []
+
+      if api_key&.strip&.empty?
+        errors << "API key cannot be empty"
+      end
+
+      if api_key && T.must(api_key).length < 10
+        errors << "API key appears to be too short"
+      end
+
+      errors
+    end
+
+    sig { returns(T::Boolean) }
+    def valid?
+      validation_errors.empty?
+    end
   end
 end

data/lib/lunchmoney/deprecate.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LunchMoney
+  module Deprecate
+    cattr_accessor :endpoint_deprecation_warnings, default: true
+
+    sig { params(replacement: T.nilable(String)).void }
+    def deprecate_endpoint(replacement = nil)
+      return unless endpoint_deprecation_warnings
+
+      replacement = if replacement.nil?
+        "There is currently no replacement for this endpoint"
+      else
+        "Please use #{replacement} instead"
+      end
+
+      message = "#{deprecated_endpoint} is deprecated and may be removed from LunchMoney | #{replacement}"
+      Kernel.warn(message)
+    end
+
+    private
+
+    sig { returns(String) }
+    def deprecated_endpoint
+      endpoint_call = Kernel.caller_locations.find { |call| call.to_s.include?("lunchmoney/calls") }
+
+      if endpoint_call.nil?
+        ""
+      else
+        "LunchMoney::Api##{endpoint_call.label}"
+      end
+    end
+  end
+end

data/lib/lunchmoney/objects/asset.rb

@@ -22,6 +22,9 @@ module LunchMoney
       sig { returns(T::Boolean) }
       attr_accessor :exclude_transactions
 
+      sig { returns(T.nilable(Number)) }
+      attr_accessor :to_base
+
       # Valid asset type names
       VALID_TYPE_NAMES = T.let(
         [
@@ -54,10 +57,11 @@ module LunchMoney
           display_name: T.nilable(String),
           closed_on: T.nilable(String),
           institution_name: T.nilable(String),
+          to_base: T.nilable(Number),
         ).void
       end
       def initialize(created_at:, type_name:, name:, balance:, balance_as_of:, currency:, exclude_transactions:, id:,
-        subtype_name: nil, display_name: nil, closed_on: nil, institution_name: nil)
+        subtype_name: nil, display_name: nil, closed_on: nil, institution_name: nil, to_base: nil)
         super()
         @created_at = T.let(validate_iso8601!(created_at), String)
         @type_name = T.let(validate_one_of!(type_name, VALID_TYPE_NAMES), String)
@@ -71,6 +75,7 @@ module LunchMoney
         @display_name = display_name
         @closed_on = closed_on
         @institution_name = institution_name
+        @to_base = to_base
       end
 
       sig { params(name: String).void }

data/lib/lunchmoney/objects/object.rb

@@ -8,17 +8,12 @@ module LunchMoney
     class Object
       sig { params(symbolize_keys: T::Boolean).returns(T::Hash[T.any(String, Symbol), T.untyped]) }
       def serialize(symbolize_keys: false)
-        ivars = instance_variables
-
         output = {}
 
-        ivars.each do |ivar|
-          key = ivar.to_s.gsub("@", "")
-          key = key.to_sym if symbolize_keys
-
-          value = instance_variable_get(ivar)
-
-          output[key] = value
+        instance_variables.each do |ivar|
+          key_string = ivar.to_s.delete_prefix("@")
+          key = symbolize_keys ? key_string.to_sym : key_string
+          output[key] = instance_variable_get(ivar)
         end
 
         output

data/lib/lunchmoney/objects/plaid_account.rb

@@ -27,6 +27,9 @@ module LunchMoney
       sig { returns(T.nilable(Integer)) }
       attr_accessor :limit
 
+      sig { returns(T.nilable(Number)) }
+      attr_accessor :to_base
+
       sig do
         params(
           date_linked: String,
@@ -46,11 +49,12 @@ module LunchMoney
           subtype: T.nilable(String),
           import_start_date: T.nilable(String),
           last_fetch: T.nilable(String),
+          to_base: T.nilable(Number),
         ).void
       end
       def initialize(date_linked:, name:, type:, mask:, institution_name:, status:, balance:, currency:,
         balance_last_update:, display_name:, id:, plaid_last_successful_update:, last_import: nil, limit: nil,
-        subtype: nil, import_start_date: nil, last_fetch: nil)
+        subtype: nil, import_start_date: nil, last_fetch: nil, to_base: nil)
         super()
         @id = id
         @date_linked = date_linked
@@ -69,6 +73,7 @@ module LunchMoney
         @last_import = last_import
         @last_fetch = last_fetch
         @plaid_last_successful_update = plaid_last_successful_update
+        @to_base = to_base
       end
     end
   end

data/lib/lunchmoney/validators.rb

@@ -8,9 +8,10 @@ module LunchMoney
   module Validators
     include Kernel
 
-    sig { params(value: String, valid_values: T::Array[String]).returns(String) }
-    def validate_one_of!(value, valid_values)
-      return value unless LunchMoney.validate_object_attributes?
+    sig { params(value: String, valid_values: T::Array[String], validate: T.nilable(T::Boolean)).returns(String) }
+    def validate_one_of!(value, valid_values, validate: nil)
+      should_validate = validate.nil? ? LunchMoney.validate_object_attributes? : validate
+      return value unless should_validate
 
       if valid_values.exclude?(value)
         raise(InvalidObjectAttribute, "#{value} is invalid, must be one of #{valid_values.join(", ")}")
@@ -19,9 +20,10 @@ module LunchMoney
       value
     end
 
-    sig { params(value: String).returns(String) }
-    def validate_iso8601!(value)
-      return value unless LunchMoney.validate_object_attributes?
+    sig { params(value: String, validate: T.nilable(T::Boolean)).returns(String) }
+    def validate_iso8601!(value, validate: nil)
+      should_validate = validate.nil? ? LunchMoney.validate_object_attributes? : validate
+      return value unless should_validate
 
       raise(InvalidObjectAttribute, "#{value} is not a valid ISO 8601 string") unless valid_iso8601_string?(value)
 

data/lib/lunchmoney/version.rb

@@ -3,5 +3,5 @@
 
 module LunchMoney
   # Current version of the gem
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/lunchmoney.rb

@@ -1,9 +1,9 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "active_support"
-require "active_support/core_ext/module/delegation.rb"
-require "active_support/core_ext/object/blank.rb"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/module/attribute_accessors"
 require "faraday"
 require "sorbet-runtime"
 

data/lunchmoney.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
 
   spec.summary                = "LunchMoney API client library."
   spec.homepage               = "https://github.com/mmenanno/lunchmoney"
-  spec.required_ruby_version  = ">= 3.1"
+  spec.required_ruby_version  = ">= 3.2"
   spec.license = "MIT"
 
   spec.metadata["allowed_push_host"]  = "https://rubygems.org"

data/sorbet/rbi/annotations/activesupport.rbi

@@ -88,6 +88,10 @@ class Hash
 
   sig { returns(T::Boolean) }
   def extractable_options?; end
+
+  # @version >= 6.1.0
+  sig { returns(T::Hash[K, V]) }
+  def compact_blank; end
 end
 
 class Array
@@ -193,6 +197,32 @@ class DateTime
   def present?; end
 end
 
+module Enumerable
+  sig { type_parameters(:Block).params(block: T.proc.params(arg0: Elem).returns(T.type_parameter(:Block))).returns(T::Hash[T.type_parameter(:Block), Elem]) }
+  sig { returns(T::Enumerable[T.untyped]) }
+  def index_by(&block); end
+
+  sig { type_parameters(:Block).params(block: T.proc.params(arg0: Elem).returns(T.type_parameter(:Block))).returns(T::Hash[Elem, T.type_parameter(:Block)]) }
+  sig { returns(T::Enumerable[T.untyped]) }
+  sig { type_parameters(:Default).params(default: T.type_parameter(:Default)).returns(T::Hash[Elem, T.type_parameter(:Default)]) }
+  def index_with(default = nil, &block); end
+
+  sig { params(block: T.proc.params(arg0: Elem).returns(BasicObject)).returns(T::Boolean) }
+  sig { returns(T::Boolean) }
+  def many?(&block); end
+
+  sig { params(object: BasicObject).returns(T::Boolean) }
+  def exclude?(object); end
+
+  # @version >= 6.1.0
+  sig { returns(T::Array[Elem]) }
+  def compact_blank; end
+
+  # @version >= 7.0.0
+  sig { returns(Elem) }
+  def sole; end
+end
+
 class NilClass
   sig { returns(TrueClass) }
   def blank?; end
@@ -287,6 +317,8 @@ class String
   sig { returns(TrueClass) }
   def acts_like_string?; end
 
+  # This is the subset of `#[]` sigs that have just 1 parameter.
+  # https://github.com/sorbet/sorbet/blob/40ad87b4dc7be23fa00c1369ac9f927053c68907/rbi/core/string.rbi#L270-L303
   sig { params(position: Integer).returns(T.nilable(String)) }
   sig { params(position: T.any(T::Range[Integer], Regexp)).returns(T.nilable(String)) }
   sig { params(position: String).returns(T.nilable(String)) }
@@ -437,12 +469,15 @@ class String
 end
 
 class ActiveSupport::ErrorReporter
+  # @version >= 7.1.0.beta1
   sig { type_parameters(:Block, :Fallback).params(error_classes: T.class_of(Exception), severity: T.nilable(Symbol), context: T.nilable(T::Hash[Symbol, T.untyped]), fallback: T.nilable(T.proc.returns(T.type_parameter(:Fallback))), source: T.nilable(String), blk: T.proc.returns(T.type_parameter(:Block))).returns(T.any(T.type_parameter(:Block), T.type_parameter(:Fallback))) }
   def handle(*error_classes, severity: T.unsafe(nil), context: T.unsafe(nil), fallback: T.unsafe(nil), source: T.unsafe(nil), &blk); end
 
+  # @version >= 7.1.0.beta1
   sig { type_parameters(:Block).params(error_classes: T.class_of(Exception), severity: T.nilable(Symbol), context: T.nilable(T::Hash[Symbol, T.untyped]), source: T.nilable(String), blk: T.proc.returns(T.type_parameter(:Block))).returns(T.type_parameter(:Block)) }
   def record(*error_classes, severity: T.unsafe(nil), context: T.unsafe(nil), source: T.unsafe(nil), &blk); end
 
+  # @version >= 7.1.0.beta1
   sig { params(error: Exception, handled: T::Boolean, severity: T.nilable(Symbol), context: T::Hash[Symbol, T.untyped], source: T.nilable(String)).void }
   def report(error, handled: true, severity: T.unsafe(nil), context: T.unsafe(nil), source: T.unsafe(nil)); end
 
@@ -450,3 +485,8 @@ class ActiveSupport::ErrorReporter
   sig { params(error: T.any(Exception, String), severity: T.nilable(Symbol), context: T::Hash[Symbol, T.untyped], source: T.nilable(String)).void }
   def unexpected(error, severity: T.unsafe(nil), context: T.unsafe(nil), source: T.unsafe(nil)); end
 end
+
+module ActiveSupport::Testing::Assertions
+  sig { type_parameters(:Block).params(block: T.proc.returns(T.type_parameter(:Block))).returns(T.type_parameter(:Block)) }
+  def assert_nothing_raised(&block); end
+end

data/sorbet/rbi/dsl/active_support/callbacks.rbi

@@ -13,11 +13,9 @@ module ActiveSupport::Callbacks
   module GeneratedClassMethods
     def __callbacks; end
     def __callbacks=(value); end
-    def __callbacks?; end
   end
 
   module GeneratedInstanceMethods
     def __callbacks; end
-    def __callbacks?; end
   end
 end