lunchmoney 1.0.0 → 1.1.0

data/lib/lunchmoney/objects/transaction_modification_base.rb

@@ -0,0 +1,32 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LunchMoney
+  module Objects
+    # Base object used for transaction objects that are used to update
+    # transactions https://lunchmoney.dev/#update-transaction
+    class TransactionModificationBase < LunchMoney::Objects::Object
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payee, :date, :notes
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :category_id
+
+      sig do
+        params(
+          payee: T.nilable(String),
+          date: T.nilable(String),
+          category_id: T.nilable(Integer),
+          notes: T.nilable(String),
+        ).void
+      end
+      def initialize(payee: nil, date: nil, category_id: nil, notes: nil)
+        super()
+        @payee = payee
+        @date = date
+        @category_id = category_id
+        @notes = notes
+      end
+    end
+  end
+end

data/lib/lunchmoney/objects/update_transaction.rb

@@ -0,0 +1,47 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "transaction_modification_base"
+
+module LunchMoney
+  module Objects
+    # object used when updating a transaction https://lunchmoney.dev/#update-transaction
+    class UpdateTransaction < TransactionModificationBase
+      sig { returns(T.nilable(String)) }
+      attr_accessor :amount, :currency, :status, :external_id
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :asset_id, :recurring_id
+
+      sig { returns(T.nilable(T::Array[T.any(String, Integer)])) }
+      attr_accessor :tags
+
+      sig do
+        params(
+          tags: T.nilable(T::Array[T.any(String, Integer)]),
+          category_id: T.nilable(Integer),
+          payee: T.nilable(String),
+          amount: T.nilable(String),
+          currency: T.nilable(String),
+          asset_id: T.nilable(Integer),
+          recurring_id: T.nilable(Integer),
+          notes: T.nilable(String),
+          status: T.nilable(String),
+          external_id: T.nilable(String),
+          date: T.nilable(String),
+        ).void
+      end
+      def initialize(tags: nil, category_id: nil, payee: nil, amount: nil, currency: nil, asset_id: nil,
+        recurring_id: nil, notes: nil, status: nil, external_id: nil, date: nil)
+        super(payee:, date:, category_id:, notes:)
+        @amount = amount
+        @tags = tags
+        @currency = currency
+        @asset_id = asset_id
+        @recurring_id = recurring_id
+        @status = status
+        @external_id = external_id
+      end
+    end
+  end
+end

data/lib/lunchmoney/objects/user.rb

@@ -0,0 +1,38 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LunchMoney
+  module Objects
+    # https://lunchmoney.dev/#user-object
+    class User < LunchMoney::Objects::Object
+      sig { returns(Integer) }
+      attr_accessor :user_id, :account_id
+
+      sig { returns(String) }
+      attr_accessor :user_name, :user_email, :budget_name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :api_key_label
+
+      sig do
+        params(
+          user_id: Integer,
+          user_name: String,
+          user_email: String,
+          account_id: Integer,
+          budget_name: String,
+          api_key_label: T.nilable(String),
+        ).void
+      end
+      def initialize(user_id:, user_name:, user_email:, account_id:, budget_name:, api_key_label: nil)
+        super()
+        @user_id = user_id
+        @user_name = user_name
+        @user_email = user_email
+        @account_id = account_id
+        @budget_name = budget_name
+        @api_key_label = api_key_label
+      end
+    end
+  end
+end

data/lib/lunchmoney/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lunchmoney
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - "@halorrr"
@@ -89,40 +89,40 @@ files:
 - bin/yard
 - lib/lunchmoney.rb
 - lib/lunchmoney/api.rb
-- lib/lunchmoney/api_call.rb
-- lib/lunchmoney/assets/asset.rb
-- lib/lunchmoney/assets/asset_calls.rb
-- lib/lunchmoney/budget/budget.rb
-- lib/lunchmoney/budget/budget_calls.rb
-- lib/lunchmoney/budget/config.rb
-- lib/lunchmoney/budget/data.rb
-- lib/lunchmoney/categories/category/category.rb
-- lib/lunchmoney/categories/category/child_category.rb
-- lib/lunchmoney/categories/category_calls.rb
+- lib/lunchmoney/calls/assets.rb
+- lib/lunchmoney/calls/base.rb
+- lib/lunchmoney/calls/budgets.rb
+- lib/lunchmoney/calls/categories.rb
+- lib/lunchmoney/calls/crypto.rb
+- lib/lunchmoney/calls/plaid_accounts.rb
+- lib/lunchmoney/calls/recurring_expenses.rb
+- lib/lunchmoney/calls/tags.rb
+- lib/lunchmoney/calls/transactions.rb
+- lib/lunchmoney/calls/users.rb
 - lib/lunchmoney/configuration.rb
-- lib/lunchmoney/crypto/crypto/crypto.rb
-- lib/lunchmoney/crypto/crypto/crypto_base.rb
-- lib/lunchmoney/crypto/crypto_calls.rb
-- lib/lunchmoney/data_object.rb
 - lib/lunchmoney/errors.rb
 - lib/lunchmoney/exceptions.rb
-- lib/lunchmoney/plaid_accounts/plaid_account.rb
-- lib/lunchmoney/plaid_accounts/plaid_account_calls.rb
-- lib/lunchmoney/recurring_expenses/recurring_expense/recurring_expense.rb
-- lib/lunchmoney/recurring_expenses/recurring_expense/recurring_expense_base.rb
-- lib/lunchmoney/recurring_expenses/recurring_expense_calls.rb
-- lib/lunchmoney/tags/tag/tag.rb
-- lib/lunchmoney/tags/tag/tag_base.rb
-- lib/lunchmoney/tags/tag_calls.rb
-- lib/lunchmoney/transactions/transaction/child_transaction.rb
-- lib/lunchmoney/transactions/transaction/split.rb
-- lib/lunchmoney/transactions/transaction/transaction.rb
-- lib/lunchmoney/transactions/transaction/transaction_base.rb
-- lib/lunchmoney/transactions/transaction/transaction_modification_base.rb
-- lib/lunchmoney/transactions/transaction/update_transaction.rb
-- lib/lunchmoney/transactions/transaction_calls.rb
-- lib/lunchmoney/user/user.rb
-- lib/lunchmoney/user/user_calls.rb
+- lib/lunchmoney/objects/asset.rb
+- lib/lunchmoney/objects/budget.rb
+- lib/lunchmoney/objects/category.rb
+- lib/lunchmoney/objects/child_category.rb
+- lib/lunchmoney/objects/child_transaction.rb
+- lib/lunchmoney/objects/config.rb
+- lib/lunchmoney/objects/crypto.rb
+- lib/lunchmoney/objects/crypto_base.rb
+- lib/lunchmoney/objects/data.rb
+- lib/lunchmoney/objects/object.rb
+- lib/lunchmoney/objects/plaid_account.rb
+- lib/lunchmoney/objects/recurring_expense.rb
+- lib/lunchmoney/objects/recurring_expense_base.rb
+- lib/lunchmoney/objects/split.rb
+- lib/lunchmoney/objects/tag.rb
+- lib/lunchmoney/objects/tag_base.rb
+- lib/lunchmoney/objects/transaction.rb
+- lib/lunchmoney/objects/transaction_base.rb
+- lib/lunchmoney/objects/transaction_modification_base.rb
+- lib/lunchmoney/objects/update_transaction.rb
+- lib/lunchmoney/objects/user.rb
 - lib/lunchmoney/validators.rb
 - lib/lunchmoney/version.rb
 - lunchmoney.gemspec

data/lib/lunchmoney/api_call.rb

@@ -1,109 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require_relative "errors"
-
-module LunchMoney
-  # Base class for all API call types
-  class ApiCall
-    # Base URL used for API calls
-    BASE_URL = "https://dev.lunchmoney.app/v1/"
-
-    sig { returns(T.nilable(String)) }
-    attr_reader :api_key
-
-    sig { params(api_key: T.nilable(String)).void }
-    def initialize(api_key: nil)
-      @api_key = T.let((api_key || LunchMoney.configuration.api_key), T.nilable(String))
-    end
-
-    private
-
-    sig { params(endpoint: String, query_params: T.nilable(T::Hash[Symbol, T.untyped])).returns(Faraday::Response) }
-    def get(endpoint, query_params: nil)
-      connection = request(flat_params: true)
-
-      if query_params.present?
-        connection.get(BASE_URL + endpoint, query_params)
-      else
-        connection.get(BASE_URL + endpoint)
-      end
-    end
-
-    sig { params(endpoint: String, params: T.nilable(T::Hash[Symbol, T.untyped])).returns(Faraday::Response) }
-    def post(endpoint, params)
-      request(json_request: true).post(BASE_URL + endpoint, params)
-    end
-
-    sig { params(endpoint: String, body: T::Hash[Symbol, T.untyped]).returns(Faraday::Response) }
-    def put(endpoint, body)
-      request(json_request: true).put(BASE_URL + endpoint) do |req|
-        req.body = body
-      end
-    end
-
-    sig { params(endpoint: String, query_params: T.nilable(T::Hash[Symbol, T.untyped])).returns(Faraday::Response) }
-    def delete(endpoint, query_params: nil)
-      connection = request(flat_params: true)
-
-      if query_params.present?
-        connection.delete(BASE_URL + endpoint, query_params)
-      else
-        connection.delete(BASE_URL + endpoint)
-      end
-    end
-
-    sig { params(json_request: T::Boolean, flat_params: T::Boolean).returns(Faraday::Connection) }
-    def request(json_request: false, flat_params: false)
-      Faraday.new do |conn|
-        conn.request(:authorization, "Bearer", @api_key)
-        conn.request(:json) if json_request
-        # conn.options.params_encoder = Faraday::FlatParamsEncoder if flat_params
-        conn.response(:json, content_type: /json$/, parser_options: { symbolize_names: true })
-      end
-    end
-
-    sig { params(response: Faraday::Response).returns(LunchMoney::Errors) }
-    def errors(response)
-      body = response.body
-
-      return parse_errors(body) unless error_hash(body).nil?
-
-      LunchMoney::Errors.new
-    end
-
-    sig { params(body: T::Hash[Symbol, T.any(String, T::Array[String])]).returns(LunchMoney::Errors) }
-    def parse_errors(body)
-      errors = error_hash(body)
-      api_errors = LunchMoney::Errors.new
-      return api_errors if errors.blank?
-
-      case errors
-      when String
-        api_errors << errors
-      when Array
-        errors.each { |error| api_errors << error }
-      end
-
-      api_errors
-    end
-
-    sig { params(body: T.untyped).returns(T.untyped) }
-    def error_hash(body)
-      return unless body.is_a?(Hash)
-
-      if body[:error]
-        body[:error]
-      elsif body[:errors]
-        body[:errors]
-      elsif body[:name] == "Error"
-        body[:message]
-      end
-    end
-
-    sig { params(params: T::Hash[Symbol, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
-    def clean_params(params)
-      params.reject! { |_key, value| value.nil? }
-    end
-  end
-end

data/lib/lunchmoney/assets/asset.rb

@@ -1,89 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module LunchMoney
-  # https://lunchmoney.dev/#assets-object
-  class Asset < LunchMoney::DataObject
-    include LunchMoney::Validators
-
-    sig { returns(Integer) }
-    attr_accessor :id
-
-    sig { returns(String) }
-    attr_reader :type_name, :balance_as_of, :created_at
-
-    sig { returns(String) }
-    attr_accessor :name, :balance, :currency
-
-    sig { returns(T.nilable(String)) }
-    attr_accessor :display_name, :closed_on, :institution_name, :subtype_name
-
-    sig { returns(T::Boolean) }
-    attr_accessor :exclude_transactions
-
-    # Valid asset type names
-    VALID_TYPE_NAMES = T.let(
-      [
-        "cash",
-        "credit",
-        "investment",
-        "real estate",
-        "loan",
-        "vehicle",
-        "cryptocurrency",
-        "employee compensation",
-        "other liability",
-        "other asset",
-      ],
-      T::Array[String],
-    )
-
-    sig do
-      params(
-        created_at: String,
-        type_name: String,
-        name: String,
-        balance: String,
-        balance_as_of: String,
-        currency: String,
-        exclude_transactions: T::Boolean,
-        id: Integer,
-        subtype_name: T.nilable(String),
-        display_name: T.nilable(String),
-        closed_on: T.nilable(String),
-        institution_name: T.nilable(String),
-      ).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)
-      super()
-      @created_at = T.let(validate_iso8601!(created_at), String)
-      @type_name = T.let(validate_one_of!(type_name, VALID_TYPE_NAMES), String)
-      @name = name
-      @balance = balance
-      @balance_as_of = T.let(validate_iso8601!(balance_as_of), String)
-      @currency = currency
-      @exclude_transactions = exclude_transactions
-      @id = id
-      @subtype_name = subtype_name
-      @display_name = display_name
-      @closed_on = closed_on
-      @institution_name = institution_name
-    end
-
-    sig { params(name: String).void }
-    def type_name=(name)
-      @type_name = validate_one_of!(name, VALID_TYPE_NAMES)
-    end
-
-    sig { params(time: String).void }
-    def balance_as_of=(time)
-      @balance_as_of = validate_iso8601!(time)
-    end
-
-    sig { params(time: String).void }
-    def created_at=(time)
-      @created_at = validate_iso8601!(time)
-    end
-  end
-end

data/lib/lunchmoney/assets/asset_calls.rb

@@ -1,96 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require_relative "asset"
-
-module LunchMoney
-  # https://lunchmoney.dev/#assets
-  class AssetCalls < ApiCall
-    sig { returns(T.any(T::Array[LunchMoney::Asset], LunchMoney::Errors)) }
-    def assets
-      response = get("assets")
-
-      api_errors = errors(response)
-      return api_errors if api_errors.present?
-
-      response.body[:assets].map do |asset|
-        LunchMoney::Asset.new(**asset)
-      end
-    end
-
-    sig do
-      params(
-        type_name: String,
-        name: String,
-        balance: String,
-        subtype_name: T.nilable(String),
-        display_name: T.nilable(String),
-        balance_as_of: T.nilable(String),
-        currency: T.nilable(String),
-        institution_name: T.nilable(String),
-        closed_on: T.nilable(String),
-        exclude_transactions: T.nilable(T::Boolean),
-      ).returns(T.any(LunchMoney::Asset, LunchMoney::Errors))
-    end
-    def create_asset(type_name:, name:, balance:, subtype_name: nil, display_name: nil, balance_as_of: nil,
-      currency: nil, institution_name: nil, closed_on: nil, exclude_transactions: nil)
-      params = {
-        type_name:,
-        name:,
-        balance:,
-        subtype_name:,
-        display_name:,
-        balance_as_of:,
-        currency:,
-        institution_name:,
-        closed_on:,
-        exclude_transactions:,
-      }
-
-      response = post("assets", params)
-
-      api_errors = errors(response)
-      return api_errors if api_errors.present?
-
-      LunchMoney::Asset.new(**response.body)
-    end
-
-    sig do
-      params(
-        asset_id: Integer,
-        type_name: T.nilable(String),
-        name: T.nilable(String),
-        balance: T.nilable(String),
-        subtype_name: T.nilable(String),
-        display_name: T.nilable(String),
-        balance_as_of: T.nilable(String),
-        currency: T.nilable(String),
-        institution_name: T.nilable(String),
-        closed_on: T.nilable(String),
-        exclude_transactions: T.nilable(T::Boolean),
-      ).returns(T.any(LunchMoney::Asset, LunchMoney::Errors))
-    end
-    def update_asset(asset_id, type_name: nil, name: nil, balance: nil, subtype_name: nil, display_name: nil,
-      balance_as_of: nil, currency: nil, institution_name: nil, closed_on: nil, exclude_transactions: nil)
-      params = {
-        type_name:,
-        name:,
-        balance:,
-        subtype_name:,
-        display_name:,
-        balance_as_of:,
-        currency:,
-        institution_name:,
-        closed_on:,
-        exclude_transactions:,
-      }
-
-      response = put("assets/#{asset_id}", params)
-
-      api_errors = errors(response)
-      return api_errors if api_errors.present?
-
-      LunchMoney::Asset.new(**response.body)
-    end
-  end
-end

data/lib/lunchmoney/budget/budget.rb

@@ -1,74 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require_relative "data"
-require_relative "config"
-
-module LunchMoney
-  # https://lunchmoney.dev/#budget-object
-  class Budget < LunchMoney::DataObject
-    # API object reference documentation: https://lunchmoney.dev/#budget-object
-
-    sig { returns(String) }
-    attr_accessor :category_name
-
-    sig { returns(Integer) }
-    attr_accessor :order
-
-    sig { returns(T.nilable(String)) }
-    attr_accessor :category_group_name
-
-    sig { returns(T.nilable(Integer)) }
-    attr_accessor :category_id, :group_id
-
-    sig { returns(T.nilable(T::Boolean)) }
-    attr_accessor :is_group
-
-    sig { returns(T::Boolean) }
-    attr_accessor :is_income, :exclude_from_budget, :exclude_from_totals, :archived
-
-    sig { returns(T::Hash[Symbol, LunchMoney::Data]) }
-    attr_accessor :data
-
-    sig { returns(T.nilable(T::Hash[Symbol, LunchMoney::Config])) }
-    attr_accessor :config
-
-    sig { returns(T.nilable({ list: T::Array[LunchMoney::RecurringExpense] })) }
-    attr_accessor :recurring
-
-    sig do
-      params(
-        is_income: T::Boolean,
-        exclude_from_budget: T::Boolean,
-        exclude_from_totals: T::Boolean,
-        data: T::Hash[Symbol, LunchMoney::Data],
-        category_name: String,
-        order: Integer,
-        archived: T::Boolean,
-        category_id: T.nilable(Integer),
-        category_group_name: T.nilable(String),
-        group_id: T.nilable(Integer),
-        is_group: T.nilable(T::Boolean),
-        config: T.nilable(T::Hash[Symbol, LunchMoney::Config]),
-        recurring: T.nilable({ list: T::Array[LunchMoney::RecurringExpense] }),
-      ).void
-    end
-    def initialize(is_income:, exclude_from_budget:, exclude_from_totals:, data:, category_name:, order:, archived:,
-      category_id: nil, category_group_name: nil, group_id: nil, is_group: nil, config: nil, recurring: nil)
-      super()
-      @category_id = category_id
-      @is_income = is_income
-      @exclude_from_budget = exclude_from_budget
-      @exclude_from_totals = exclude_from_totals
-      @data = data
-      @category_name = category_name
-      @order = order
-      @category_group_name = category_group_name
-      @group_id = group_id
-      @is_group = is_group
-      @config = config
-      @archived = archived
-      @recurring = recurring
-    end
-  end
-end

data/lib/lunchmoney/budget/budget_calls.rb

@@ -1,82 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require_relative "budget"
-
-module LunchMoney
-  # https://lunchmoney.dev/#budget
-  class BudgetCalls < ApiCall
-    sig do
-      params(
-        start_date: String,
-        end_date: String,
-        currency: T.nilable(String),
-      ).returns(T.any(T::Array[LunchMoney::Budget], LunchMoney::Errors))
-    end
-    def budgets(start_date:, end_date:, currency: nil)
-      params = clean_params({ start_date:, end_date:, currency: })
-      response = get("budgets", query_params: params)
-
-      api_errors = errors(response)
-      return api_errors if api_errors.present?
-
-      response.body.map do |budget|
-        if budget[:data]
-          data_keys = budget[:data].keys
-          data_keys.each do |data_key|
-            budget[:data][data_key] = LunchMoney::Data.new(**budget[:data][data_key])
-          end
-        end
-
-        if budget[:config]
-          config_keys = budget[:config].keys
-          config_keys.each do |config_key|
-            budget[:config][config_key] = LunchMoney::Data.new(**budget[:config][config_key])
-          end
-        end
-
-        if budget[:recurring]
-          budget[:recurring][:list]&.map! { |recurring| LunchMoney::RecurringExpenseBase.new(**recurring) }
-        end
-
-        LunchMoney::Budget.new(**budget)
-      end
-    end
-
-    sig do
-      params(
-        start_date: String,
-        category_id: Integer,
-        amount: Number,
-        currency: T.nilable(String),
-      ).returns(T.any(
-        T::Hash[Symbol, { category_id: Integer, amount: Number, currency: String, start_date: String }],
-        LunchMoney::Errors,
-      ))
-    end
-    def upsert_budget(start_date:, category_id:, amount:, currency: nil)
-      params = clean_params({ start_date:, category_id:, amount:, currency: })
-      response = put("budgets", params)
-
-      api_errors = errors(response)
-      return api_errors if api_errors.present?
-
-      response.body
-    end
-
-    sig { params(start_date: String, category_id: Integer).returns(T.any(T::Boolean, LunchMoney::Errors)) }
-    def remove_budget(start_date:, category_id:)
-      params = {
-        start_date:,
-        category_id:,
-      }
-
-      response = delete("budgets", query_params: params)
-
-      api_errors = errors(response)
-      return api_errors if api_errors.present?
-
-      response.body
-    end
-  end
-end