async-firefly 1.0.0

data/lib/async/firefly/available_budgets.rb

@@ -0,0 +1,59 @@
+require_relative "page"
+
+module Async
+  module Firefly
+    class AvailableBudget < Representation
+      def created_at = self.attributes[:created_at]
+
+      def updated_at = self.attributes[:updated_at]
+
+      def object_has_currency_setting = self.attributes[:object_has_currency_setting]
+
+      def currency_id = self.attributes[:currency_id]
+
+      def currency_name = self.attributes[:currency_name]
+
+      def currency_code = self.attributes[:currency_code]
+
+      def currency_symbol = self.attributes[:currency_symbol]
+
+      def currency_decimal_places = self.attributes[:currency_decimal_places]
+
+      def primary_currency_id = self.attributes[:primary_currency_id]
+
+      def primary_currency_name = self.attributes[:primary_currency_name]
+
+      def primary_currency_code = self.attributes[:primary_currency_code]
+
+      def primary_currency_symbol = self.attributes[:primary_currency_symbol]
+
+      def primary_currency_decimal_places = self.attributes[:primary_currency_decimal_places]
+
+      def amount = self.attributes[:amount]
+
+      def pc_amount = self.attributes[:pc_amount]
+
+      def start = self.attributes[:start]
+
+      def end = self.attributes[:end]
+
+      def spent_in_budgets = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:spent_in_budgets])
+
+      def pc_spent_in_budgets = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:pc_spent_in_budgets])
+
+      def spent_outside_budgets = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:spent_outside_budgets])
+
+      def pc_spent_outside_budgets = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:pc_spent_outside_budgets])
+    end
+
+    class AvailableBudgetPage < Page
+      MEMBER = AvailableBudget
+    end
+
+    module AvailableBudgets
+      def available_budgets(**parameters) = Collection.for(self, "v1/available-budgets", AvailableBudgetPage, **parameters)
+
+      def available_budget(id) = AvailableBudget.new(self.with(path: "v1/available-budgets/" + Firefly.escape(id)))
+    end
+  end
+end

data/lib/async/firefly/bills.rb

@@ -0,0 +1,107 @@
+require_relative "page"
+
+module Async
+  module Firefly
+    class Bill < Representation
+      def created_at = self.attributes[:created_at]
+
+      def updated_at = self.attributes[:updated_at]
+
+      def name = self.attributes[:name]
+
+      def object_has_currency_setting = self.attributes[:object_has_currency_setting]
+
+      def currency_id = self.attributes[:currency_id]
+
+      def currency_name = self.attributes[:currency_name]
+
+      def currency_code = self.attributes[:currency_code]
+
+      def currency_symbol = self.attributes[:currency_symbol]
+
+      def currency_decimal_places = self.attributes[:currency_decimal_places]
+
+      def primary_currency_id = self.attributes[:primary_currency_id]
+
+      def primary_currency_name = self.attributes[:primary_currency_name]
+
+      def primary_currency_code = self.attributes[:primary_currency_code]
+
+      def primary_currency_symbol = self.attributes[:primary_currency_symbol]
+
+      def primary_currency_decimal_places = self.attributes[:primary_currency_decimal_places]
+
+      def amount_min = self.attributes[:amount_min]
+
+      def pc_amount_min = self.attributes[:pc_amount_min]
+
+      def amount_max = self.attributes[:amount_max]
+
+      def pc_amount_max = self.attributes[:pc_amount_max]
+
+      def amount_avg = self.attributes[:amount_avg]
+
+      def pc_amount_avg = self.attributes[:pc_amount_avg]
+
+      def date = self.attributes[:date]
+
+      def end_date = self.attributes[:end_date]
+
+      def extension_date = self.attributes[:extension_date]
+
+      def repeat_freq = self.attributes[:repeat_freq]
+
+      def skip = self.attributes[:skip]
+
+      def active = self.attributes[:active]
+
+      def order = self.attributes[:order]
+
+      def notes = self.attributes[:notes]
+
+      def object_group_id = self.attributes[:object_group_id]
+
+      def object_group_order = self.attributes[:object_group_order]
+
+      def object_group_title = self.attributes[:object_group_title]
+
+      def paid_dates = self.attributes[:paid_dates]
+
+      def pay_dates = self.attributes[:pay_dates]
+
+      def next_expected_match = self.attributes[:next_expected_match]
+
+      def next_expected_match_diff = self.attributes[:next_expected_match_diff]
+
+      def active? = self.active == true
+
+      def attachments(**parameters) = Collection.for(@resource, "attachments", NestedAttachmentPage, **parameters)
+
+      def rules(**parameters) = NestedRulePage.new(@resource.with(path: "rules", parameters: parameters))
+
+      def transactions(**parameters) = Collection.for(@resource, "transactions", NestedTransactionPage, **parameters)
+
+      def update(payload) = self.submit(Bill, @resource, payload, method: :put)
+
+      def delete = self.discard(@resource)
+    end
+
+    class BillPage < Page
+      MEMBER = Bill
+    end
+
+    module Bills
+      def bills(**parameters) = Collection.for(self, "v1/bills", BillPage, **parameters)
+
+      def bill(id) = Bill.new(self.with(path: "v1/bills/" + Firefly.escape(id)))
+
+      def create_bill(payload) = self.submit(Bill, self.with(path: "v1/bills"), payload, identify: true)
+
+      def subscriptions(**parameters) = Collection.for(self, "v1/subscriptions", BillPage, **parameters)
+
+      def subscription(id) = Bill.new(self.with(path: "v1/subscriptions/" + Firefly.escape(id)))
+
+      def create_subscription(payload) = self.submit(Bill, self.with(path: "v1/subscriptions"), payload, identify: true)
+    end
+  end
+end

data/lib/async/firefly/budgets.rb

@@ -0,0 +1,165 @@
+require_relative "page"
+
+module Async
+  module Firefly
+    class Budget < Representation
+      def created_at = self.attributes[:created_at]
+
+      def updated_at = self.attributes[:updated_at]
+
+      def active = self.attributes[:active]
+
+      def name = self.attributes[:name]
+
+      def order = self.attributes[:order]
+
+      def notes = self.attributes[:notes]
+
+      def auto_budget_type = self.attributes[:auto_budget_type]
+
+      def auto_budget_period = self.attributes[:auto_budget_period]
+
+      def object_group_id = self.attributes[:object_group_id]
+
+      def object_group_order = self.attributes[:object_group_order]
+
+      def object_group_title = self.attributes[:object_group_title]
+
+      def object_has_currency_setting = self.attributes[:object_has_currency_setting]
+
+      def currency_id = self.attributes[:currency_id]
+
+      def currency_name = self.attributes[:currency_name]
+
+      def currency_code = self.attributes[:currency_code]
+
+      def currency_symbol = self.attributes[:currency_symbol]
+
+      def currency_decimal_places = self.attributes[:currency_decimal_places]
+
+      def primary_currency_id = self.attributes[:primary_currency_id]
+
+      def primary_currency_name = self.attributes[:primary_currency_name]
+
+      def primary_currency_code = self.attributes[:primary_currency_code]
+
+      def primary_currency_symbol = self.attributes[:primary_currency_symbol]
+
+      def primary_currency_decimal_places = self.attributes[:primary_currency_decimal_places]
+
+      def auto_budget_amount = self.attributes[:auto_budget_amount]
+
+      def pc_auto_budget_amount = self.attributes[:pc_auto_budget_amount]
+
+      def spent = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:spent])
+
+      def pc_spent = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:pc_spent])
+
+      def active? = self.active == true
+
+      def limits(**parameters) = BudgetLimitPage.new(@resource.with(path: "limits", parameters: parameters))
+
+      def limit(id) = BudgetLimit.new(@resource.with(path: "limits/" + Firefly.escape(id)))
+
+      def create_limit(payload) = self.submit(BudgetLimit, @resource.with(path: "limits"), payload, identify: true)
+
+      def transactions(**parameters) = Collection.for(@resource, "transactions", NestedTransactionPage, **parameters)
+
+      def attachments(**parameters) = Collection.for(@resource, "attachments", NestedAttachmentPage, **parameters)
+
+      def update(payload) = self.submit(Budget, @resource, payload, method: :put)
+
+      def delete = self.discard(@resource)
+    end
+
+    class BudgetPage < Page
+      MEMBER = Budget
+    end
+
+    class BudgetLimit < Representation
+      def created_at = self.attributes[:created_at]
+
+      def updated_at = self.attributes[:updated_at]
+
+      def start = self.attributes[:start]
+
+      def end = self.attributes[:end]
+
+      def budget_id = self.attributes[:budget_id]
+
+      def object_has_currency_setting = self.attributes[:object_has_currency_setting]
+
+      def currency_id = self.attributes[:currency_id]
+
+      def currency_name = self.attributes[:currency_name]
+
+      def currency_code = self.attributes[:currency_code]
+
+      def currency_symbol = self.attributes[:currency_symbol]
+
+      def currency_decimal_places = self.attributes[:currency_decimal_places]
+
+      def primary_currency_id = self.attributes[:primary_currency_id]
+
+      def primary_currency_name = self.attributes[:primary_currency_name]
+
+      def primary_currency_code = self.attributes[:primary_currency_code]
+
+      def primary_currency_symbol = self.attributes[:primary_currency_symbol]
+
+      def primary_currency_decimal_places = self.attributes[:primary_currency_decimal_places]
+
+      def amount = self.attributes[:amount]
+
+      def pc_amount = self.attributes[:pc_amount]
+
+      def period = self.attributes[:period]
+
+      def spent = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:spent])
+
+      def pc_spent = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:pc_spent])
+
+      def notes = self.attributes[:notes]
+
+      def transactions(**parameters) = Collection.for(@resource, "transactions", BudgetLimitTransactionPage, **parameters)
+
+      def update(payload) = self.submit(BudgetLimit, @resource, payload, method: :put)
+
+      def delete = self.discard(@resource)
+    end
+
+    class BudgetLimitPage < Page
+      MEMBER = BudgetLimit
+    end
+
+    class BudgetLimitListPage < Page
+      MEMBER = BudgetLimit
+
+      def member_path(record) = "../budgets/" + self.identifier(record, :attributes, :budget_id) + "/limits/" + self.identifier(record, :id)
+    end
+
+    class BudgetLimitTransactionPage < Page
+      def member_class = Transaction
+
+      def member_path(record) = "../../../../../transactions/" + self.identifier(record, :id)
+    end
+
+    class TransactionsWithoutBudgetPage < Page
+      def member_class = Transaction
+
+      def member_path(record) = "../../transactions/" + self.identifier(record, :id)
+    end
+
+    module Budgets
+      def budgets(**parameters) = Collection.for(self, "v1/budgets", BudgetPage, **parameters)
+
+      def budget(id) = Budget.new(self.with(path: "v1/budgets/" + Firefly.escape(id)))
+
+      def create_budget(payload) = self.submit(Budget, self.with(path: "v1/budgets"), payload, identify: true)
+
+      def budget_limits(**parameters) = BudgetLimitListPage.new(self.with(path: "v1/budget-limits", parameters: parameters))
+
+      def transactions_without_budget(**parameters) = Collection.for(self, "v1/budgets/transactions-without-budget", TransactionsWithoutBudgetPage, **parameters)
+    end
+  end
+end

data/lib/async/firefly/categories.rb

@@ -0,0 +1,63 @@
+require_relative "page"
+
+module Async
+  module Firefly
+    class Category < Representation
+      def created_at = self.attributes[:created_at]
+
+      def updated_at = self.attributes[:updated_at]
+
+      def name = self.attributes[:name]
+
+      def color = self.attributes[:color]
+
+      def last_activity = self.attributes[:last_activity]
+
+      def notes = self.attributes[:notes]
+
+      def object_has_currency_setting = self.attributes[:object_has_currency_setting]
+
+      def primary_currency_id = self.attributes[:primary_currency_id]
+
+      def primary_currency_name = self.attributes[:primary_currency_name]
+
+      def primary_currency_code = self.attributes[:primary_currency_code]
+
+      def primary_currency_symbol = self.attributes[:primary_currency_symbol]
+
+      def primary_currency_decimal_places = self.attributes[:primary_currency_decimal_places]
+
+      def spent = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:spent])
+
+      def pc_spent = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:pc_spent])
+
+      def earned = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:earned])
+
+      def pc_earned = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:pc_earned])
+
+      def transferred = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:transferred])
+
+      def pc_transferred = self.nested_list(ArrayEntryWithCurrencyAndSum, self.attributes[:pc_transferred])
+
+      def transactions(**parameters) = Collection.for(@resource, "transactions", NestedTransactionPage, **parameters)
+
+      def attachments(**parameters) = Collection.for(@resource, "attachments", NestedAttachmentPage, **parameters)
+
+      def update(payload) = self.submit(Category, @resource, payload, method: :put)
+
+      def delete = self.discard(@resource)
+    end
+
+    class CategoryPage < Page
+      MEMBER = Category
+    end
+
+    module Categories
+      def categories(**parameters) = Collection.for(self, "v1/categories", CategoryPage, **parameters)
+
+      def category(id) = Category.new(self.with(path: "v1/categories/" + Firefly.escape(id)))
+
+      def create_category(payload) = self.submit(Category, self.with(path: "v1/categories"), payload, identify: true)
+    end
+  end
+end

data/lib/async/firefly/charts.rb

@@ -0,0 +1,73 @@
+require_relative "page"
+
+module Async
+  module Firefly
+    class ChartDataPoint < Representation
+      def key = self.value[:key]
+    end
+
+    class ChartDataSet < Representation
+      def label = self.value[:label]
+
+      def currency_id = self.value[:currency_id]
+
+      def currency_name = self.value[:currency_name]
+
+      def currency_code = self.value[:currency_code]
+
+      def currency_symbol = self.value[:currency_symbol]
+
+      def currency_decimal_places = self.value[:currency_decimal_places]
+
+      def primary_currency_id = self.value[:primary_currency_id]
+
+      def primary_currency_name = self.value[:primary_currency_name]
+
+      def primary_currency_code = self.value[:primary_currency_code]
+
+      def primary_currency_symbol = self.value[:primary_currency_symbol]
+
+      def primary_currency_decimal_places = self.value[:primary_currency_decimal_places]
+
+      def date = self.value[:date]
+
+      def start_date = self.value[:start_date]
+
+      def end_date = self.value[:end_date]
+
+      def type = self.value[:type]
+
+      def period = self.value[:period]
+
+      def yAxisID = self.value[:yAxisID]
+
+      def entries = self.value[:entries]
+
+      def pc_entries = self.value[:pc_entries]
+    end
+
+    class ChartLine < Representation
+      include Enumerable
+
+      def each(&block)
+        if block
+          self.deconstruct.each{|record| block.call(ChartDataSet.new(@resource, value: record, metadata: self.metadata))}
+        else
+          self.to_enum(:each)
+        end
+      end
+    end
+
+    module Charts
+      def account_overview_chart(**parameters) = self.fetch(ChartLine, self.with(path: "v1/chart/account/overview", parameters: parameters))
+
+      def balance_chart(**parameters) = self.fetch(ChartLine, self.with(path: "v1/chart/balance/balance", parameters: parameters))
+
+      def budget_overview_chart(**parameters) = self.fetch(ChartLine, self.with(path: "v1/chart/budget/overview", parameters: parameters))
+
+      def budget_overview_with_limits_chart(**parameters) = self.fetch(ChartLine, self.with(path: "v1/chart/budget/overview-with-limits", parameters: parameters))
+
+      def category_overview_chart(**parameters) = self.fetch(ChartLine, self.with(path: "v1/chart/category/overview", parameters: parameters))
+    end
+  end
+end

data/lib/async/firefly/client.rb

@@ -0,0 +1,89 @@
+require "async/rest/resource"
+
+require_relative "about"
+require_relative "accounts"
+require_relative "attachments"
+require_relative "autocomplete"
+require_relative "available_budgets"
+require_relative "bills"
+require_relative "budgets"
+require_relative "categories"
+require_relative "charts"
+require_relative "configurations"
+require_relative "currencies"
+require_relative "data"
+require_relative "error"
+require_relative "exchange_rates"
+require_relative "insight"
+require_relative "links"
+require_relative "nested"
+require_relative "object_groups"
+require_relative "page"
+require_relative "sums"
+require_relative "piggy_banks"
+require_relative "preferences"
+require_relative "recurrences"
+require_relative "rule_groups"
+require_relative "rules"
+require_relative "search"
+require_relative "submit"
+require_relative "summary"
+require_relative "tags"
+require_relative "transactions"
+require_relative "user_groups"
+require_relative "users"
+require_relative "version"
+require_relative "webhooks"
+
+module Async
+  module Firefly
+    class Client < Async::REST::Resource
+      ENDPOINT = Async::HTTP::Endpoint.parse(ENV.fetch("FIREFLY_URL", "http://localhost:8080/api/"))
+
+      USER_AGENT = "async-firefly (https://github.com/n-at-han-k/async-firefly, v" + VERSION + ")"
+
+      include Submit
+
+      include About
+      include Accounts
+      include Attachments
+      include Autocomplete
+      include AvailableBudgets
+      include Bills
+      include Budgets
+      include Categories
+      include Charts
+      include Configurations
+      include Currencies
+      include Data
+      include ExchangeRates
+      include Insight
+      include Links
+      include ObjectGroups
+      include PiggyBanks
+      include Preferences
+      include Recurrences
+      include RuleGroups
+      include Rules
+      include Search
+      include Summary
+      include Tags
+      include Transactions
+      include UserGroups
+      include Users
+      include Webhooks
+
+      def initialize(delegate, reference = ::Protocol::URL::Reference.parse, headers = ::Protocol::HTTP::Headers.new)
+        super
+
+        unless @headers["user-agent"]
+          @headers = @headers.merge("user-agent" => USER_AGENT)
+        end
+      end
+
+      def authenticated(token)
+        self.with(headers: {"authorization" => "Bearer " + token})
+      end
+    end
+  end
+end

data/lib/async/firefly/configurations.rb

@@ -0,0 +1,62 @@
+require_relative "page"
+
+module Async
+  module Firefly
+    class Configuration < Representation
+      def title = self.value[:title]
+
+      def value_attribute = self.value[:value]
+
+      def editable = self.value[:editable]
+    end
+
+    module Configurations
+      def configurations
+        resource = self.with(path: "v1/configuration")
+
+        Configuration.get(resource) do |target, response|
+          unless response.success?
+            raise Failure.for(response)
+          end
+
+          Array(response.read).map{|item| Configuration.new(target, value: item, metadata: response.headers)}
+        end
+      end
+
+      def configuration(name)
+        resource = self.with(path: "v1/configuration/" + Firefly.escape(name))
+
+        Configuration.get(resource) do |target, response|
+          unless response.success?
+            raise Failure.for(response)
+          end
+
+          self.unwrapped_configuration(target, response)
+        end
+      end
+
+      def set_configuration(name, payload)
+        resource = self.with(path: "v1/configuration/" + Firefly.escape(name))
+
+        self.with_retry do
+          Configuration.put(resource, payload) do |target, response|
+            unless response.success?
+              raise Failure.for(response)
+            end
+
+            self.unwrapped_configuration(target, response)
+          end
+        end
+      end
+
+      def unwrapped_configuration(target, response)
+        case response.read
+        in {data: Hash => data}
+          Configuration.new(target, value: data, metadata: response.headers)
+        else
+          Configuration.new(target, value: {}, metadata: response.headers)
+        end
+      end
+    end
+  end
+end

data/lib/async/firefly/currencies.rb

@@ -0,0 +1,71 @@
+require_relative "page"
+
+module Async
+  module Firefly
+    class Currency < Representation
+      def created_at = self.attributes[:created_at]
+
+      def updated_at = self.attributes[:updated_at]
+
+      def enabled = self.attributes[:enabled]
+
+      def primary = self.attributes[:primary]
+
+      def code = self.attributes[:code]
+
+      def name = self.attributes[:name]
+
+      def symbol = self.attributes[:symbol]
+
+      def decimal_places = self.attributes[:decimal_places]
+
+      def enabled? = self.enabled == true
+
+      def primary? = self.primary == true
+
+      def accounts(**parameters) = Collection.for(@resource, "accounts", NestedAccountPage, **parameters)
+
+      def available_budgets(**parameters) = Collection.for(@resource, "available-budgets", NestedAvailableBudgetPage, **parameters)
+
+      def bills(**parameters) = Collection.for(@resource, "bills", NestedBillPage, **parameters)
+
+      def budget_limits(**parameters) = NestedBudgetLimitPage.new(@resource.with(path: "budget-limits", parameters: parameters))
+
+      def recurrences(**parameters) = Collection.for(@resource, "recurrences", NestedRecurrencePage, **parameters)
+
+      def rules(**parameters) = NestedRulePage.new(@resource.with(path: "rules", parameters: parameters))
+
+      def transactions(**parameters) = Collection.for(@resource, "transactions", NestedTransactionPage, **parameters)
+
+      def exchange_rates(**parameters) = Collection.for(@resource, "cer", NestedExchangeRatePage, **parameters)
+
+      def enable = self.submit(Currency, @resource.with(path: "enable"), method: :post, identify: nil)
+
+      def disable = self.submit(Currency, @resource.with(path: "disable"), method: :post, identify: nil)
+
+      def make_primary = self.submit(Currency, @resource.with(path: "primary"), method: :post, identify: nil)
+
+      def update(payload) = self.submit(Currency, @resource, payload, method: :put)
+
+      def delete = self.discard(@resource)
+    end
+
+    class CurrencyPage < Page
+      MEMBER = Currency
+
+      def member_path(record) = self.identifier(record, :attributes, :code)
+    end
+
+    module Currencies
+      def currencies(**parameters) = Collection.for(self, "v1/currencies", CurrencyPage, **parameters)
+
+      def currency(code) = Currency.new(self.with(path: "v1/currencies/" + Firefly.escape(code)))
+
+      def create_currency(payload) = self.submit(Currency, self.with(path: "v1/currencies"), payload, identify: :code)
+
+      def primary_currency = Currency.new(self.with(path: "v1/currencies/primary"))
+
+      def default_currency = Currency.new(self.with(path: "v1/currencies/default"))
+    end
+  end
+end