aspire_budget 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c4c01c53dfa0197f18c5c9106e860982bbc3456e3104f7c9587505cad730c1
-  data.tar.gz: a7665ac0e37ae4f6b9a6d125eb3845ed1ebac66228b7aad8b95dda2e725e3593
+  metadata.gz: cffb2693a537cc0bb7e7e5a73f8d2ac478d89be2a226ecde8b97d28f61642625
+  data.tar.gz: dea6ce0b436d527c8d668f4e9652dd8ac18327cdfe08304bc194c753fba08b29
 SHA512:
-  metadata.gz: 48e8701f8b7ded9c829d2c83e3d2dcf8f3ce51c8ca5ee5605574d3ce65bd1db0db089cac7a79a1d0f95ce31a1abe5f12122d343d3bd957efc41e89bf02c5259e
-  data.tar.gz: 227a8bf87a812c688592d8fac317bebe51abd9517d5ad5176416ee79aa50dd8d5eb4a50da023a28a1a8abaeaf7021a162121b527bdc405554cd02c1688e04e1d
+  metadata.gz: 8a18685dd70429d75a36578082b26656012aa79f40eda357400c22ce151cbc016ec3d0faaaf8e20097a7ec97bb43c6dfec0849ff058ddff814e277f553dee27c
+  data.tar.gz: 21eeeb99b5d606d7416134c95ca9acb5e2f7b5547ed9cf18d165b4ae0047a5315383c234c828fd8b0c87663583ef7569dd729ea5d038fae7c1ad13978a1c200a

data/README.md

@@ -1,21 +1,102 @@
-# Aspire Budget - Ruby 
+# Aspire Budget - Ruby
 
-This is an independent project implementing a Ruby  for Aspire Budgeting spreadsheets, leveraging from the use of another great gem: `google_drive`.  
+[![CI Status](https://github.com/drowze/aspirebudgeting_ruby/workflows/CI/badge.svg)](https://github.com/drowze/aspirebudgeting_ruby)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
+[![codecov](https://codecov.io/gh/Drowze/aspirebudgeting_ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/Drowze/aspirebudgeting_ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/03531044f88452981597/maintainability)](https://codeclimate.com/github/Drowze/aspirebudgeting_ruby/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/03531044f88452981597/test_coverage)](https://codeclimate.com/github/Drowze/aspirebudgeting_ruby/test_coverage)
+
+This is an independent project implementing a Ruby  for Aspire Budgeting spreadsheets, leveraging from the use of another great gem: `google_drive`.
 The idea of this gem is to enable a good API to be easily implemented, allowing more powerful and complex tools to emerge.
 
 If you don't know Aspire Budgeting please refer to: https://aspirebudget.com/
 
 ## Installation
 
-todo
+```bash
+$ gem install aspire_budget
+```
 
 ## Usage
 
+Either have an initializer with your config:
+
 ```ruby
-session = GoogleDrive::Session.from_config('path_to_your_credentials.json')
-client = AspireBudget::Client.new(session: session, spreadsheet_key: 'YOUR_SPREADSHEET_KEY')
+# Use this method if you plan to work on a single spreadsheet with your application
+AspireBudget.configure do |config|
+  config.session = GoogleDrive.from_config('path_to_your_credentials.json')
+  config.spreadsheet_key = 'YOUR_SPREADSHEET_KEY'
+end
 ```
 
+Or specify the config when initializing a worksheet like below.
+
+```ruby
+# Use this method if you plan working with multiple spreadsheets with your application
+AspireBudget::Worksheets::Transactions.new(
+  session: GoogleDrive.from_config('path_to_your_credentials.json'),
+  spreadsheet_key: 'YOUR_SPREADSHEET_KEY'
+)
+```
+
+List transactions:
+
+```ruby
+# or AspireBudget::Worksheets::Transactions.new(...).all
+AspireBudget::Worksheets::Transactions.all
+=> #[<AspireBudget::Models::Transaction:0x0000564acc1ae088
+#    @account="Revolut",
+#    @category="Groceries",
+#    @date=#<Date: 2020-05-31 ((2459001j,0s,0n),+0s,2299161j)>,
+#    @inflow=0.0,
+#    @memo="Tesco",
+#    @outflow=22.51,
+#    @status=:approved>,
+#   <AspireBudget::Models::Transaction:0x0000564acc1541a0
+#    @account="Revolut",
+#    @category="Electric Bill",
+#    @date=#<Date: 2020-06-22 ((2459023j,0s,0n),+0s,2299161j)>,
+#    @inflow=0.0,
+#    @memo="Amazon",
+#    @outflow=21.54,
+#    @status=:approved>]
+```
+
+Insert transaction:
+
+```ruby
+# or AspireBudget::Worksheets::Transactions.new(...).all
+# you can also pass a Transaction record instead of a hash
+AspireBudget::Worksheets::Transactions.insert(date: '25/06/2020', outflow: 10.0, inflow: 12.0, category: 'test', account: 'AIB', memo: 'ruby', status: :pending)
+=> #<AspireBudget::Models::Transaction:0x0000564acc1522b0 ... >
+```
+
+List category transfers
+
+```ruby
+AspireBudget::Worksheets::CategoryTransfers.all
+=> [#<AspireBudget::Models::CategoryTransfer:0x0000559501fddab8
+#    @amount=46.37,
+#    @date=#<Date: 2020-06-29 ((2459030j,0s,0n),+0s,2299161j)>,
+#    @from="Available to budget",
+#    @to="Lunch / Breakfast out",
+#    @memo="Monthly target">,
+#   <AspireBudget::Models::CategoryTransfer:0x0000559501fdd810
+#    @amount=15.0,
+#    @date=#<Date: 2020-06-29 ((2459030j,0s,0n),+0s,2299161j)>,
+#    @from="Public Transport",
+#    @memo="",
+#    @to="Available to budget">]
+```
+
+Insert category transfer
+
+```ruby
+AspireBudget::Worksheets::CategoryTransfers.insert(amount: 10, date: '25/06/2020', from: 'Available to budget', to: 'Electric Bill', memo: 'test')
+=> #<AspireBudget::Models::CategoryTransfer:0x0000264acc1529b0 ... >
+```
+
+
 ## Development
 
 todo

data/lib/aspire_budget.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'aspire_budget/core_extensions'
+
+require_relative 'aspire_budget/version'
+require_relative 'aspire_budget/configuration'
+
+require_relative 'aspire_budget/worksheets/backend_data'
+require_relative 'aspire_budget/worksheets/transactions'
+require_relative 'aspire_budget/worksheets/category_transfers'
+
+require_relative 'aspire_budget/models/transaction'
+require_relative 'aspire_budget/models/category_transfer'

data/lib/aspire_budget/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AspireBudget
+  # Configures default values
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  # @return [AspireBudget::Configuration] the current configured defaults
+  def self.configuration
+    Thread.current[:aspire_budget_configuration] ||= Configuration.new
+  end
+
+  # Overwrite the current configured defaults
+  # @param [AspireBudget::Configuration]
+  def self.configuration=(other)
+    Thread.current[:aspire_budget_configuration] = other
+  end
+
+  # Resets the set configuration. Useful on e.g. testing
+  def self.reset!
+    Thread.current[:aspire_budget_configuration] = nil
+  end
+
+  class Configuration
+    # Authenticated GoogleDrive session
+    # @return [GoogleDrive::Session]
+    attr_accessor :session
+
+    # Google spreadsheet key (as it is in the url)
+    # @return [String]
+    attr_accessor :spreadsheet_key
+
+    # Build an agent using given +session+ and +spreadsheet_key+ (falling back
+    # to the configured ones).
+    # @return [GoogleDrive::Spreadsheet] an spreadsheet agent
+    # @param session [GoogleDrive::Session] will fallback to configured one if
+    #   not defined
+    # @param spreadsheet_key [String] will fallback to configured one if not
+    #   defined
+    def agent(session = nil, spreadsheet_key = nil)
+      @agents ||= Hash.new do |h, k|
+        h[k] = k.first.spreadsheet_by_key(k.last)
+      end
+      @agents[
+        [session || self.session, spreadsheet_key || self.spreadsheet_key]
+      ]
+    end
+  end
+end

data/lib/aspire_budget/core_extensions.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'google_drive'
+
+module AspireBudget
+  module CoreExtensions
+    # rubocop:disable all
+    module Worksheet
+      def rows(skip = 0)
+        nc = num_cols
+        result = ((1 + skip)..num_rows).map do |row|
+          (1..nc).map do |col|
+            block_given? ? yield(row, col) : self[row, col]
+          end.freeze
+        end
+        result.freeze
+      end
+
+      # Same as +#rows+, but replacing cells with numeric values where they exist.
+      # Please note that this will NOT replace dirty cells with their numeric
+      # value.
+      #
+      # @see #rows
+      # @see #numeric_value
+      def rows_with_numerics(skip = 0)
+        rows(skip) { |row, col| numeric_value(row, col) || self[row, col] }
+      end
+
+      def []=(*args) # rubocop:disable all
+        (row, col) = parse_cell_args(args[0...-1])
+        value = args[-1]
+
+        reload_cells unless @cells
+        @numeric_values[[row, col]] = value.is_a?(Numeric) ? value : nil
+        value = value.to_s
+        validate_cell_value(value)
+
+        @cells[[row, col]] = value
+        @input_values[[row, col]] = value
+        @modified.add([row, col])
+        self.max_rows = row if row > @max_rows
+        self.max_cols = col if col > @max_cols
+        if value.empty?
+          @num_rows = nil
+          @num_cols = nil
+        else
+          @num_rows = row if @num_rows && row > @num_rows
+          @num_cols = col if @num_cols && col > @num_cols
+        end
+      end
+
+      def save # rubocop:disable all
+        sent = false
+
+        if @meta_modified
+          add_request({
+            update_sheet_properties: {
+              properties: {
+                sheet_id: sheet_id,
+                title: title,
+                index: index,
+                grid_properties: {row_count: max_rows, column_count: max_cols},
+              },
+              fields: '*',
+            },
+          })
+        end
+
+        if !@v4_requests.empty?
+          self.spreadsheet.batch_update(@v4_requests)
+          @v4_requests = []
+          sent = true
+        end
+
+        @remote_title = @title
+
+        unless @modified.empty?
+          min_modified_row = 1.0 / 0.0
+          max_modified_row = 0
+          min_modified_col = 1.0 / 0.0
+          max_modified_col = 0
+          @modified.each do |r, c|
+            min_modified_row = r if r < min_modified_row
+            max_modified_row = r if r > max_modified_row
+            min_modified_col = c if c < min_modified_col
+            max_modified_col = c if c > max_modified_col
+          end
+
+          # Uses update_spreadsheet_value instead batch_update_spreadsheet with
+          # update_cells. batch_update_spreadsheet has benefit that the request
+          # can be batched with other requests. But it has drawback that the
+          # type of the value (string_value, number_value, etc.) must be
+          # explicitly specified in user_entered_value. Since I don't know exact
+          # logic to determine the type from text, I chose to use
+          # update_spreadsheet_value here.
+          range = "'%s'!R%dC%d:R%dC%d" %
+              [@title, min_modified_row, min_modified_col, max_modified_row, max_modified_col]
+          values = (min_modified_row..max_modified_row).map do |r|
+            (min_modified_col..max_modified_col).map do |c|
+              next unless @modified.include?([r, c])
+
+              @numeric_values[[r, c]] || @cells[[r, c]] || ''
+            end
+          end
+          value_range = Google::Apis::SheetsV4::ValueRange.new(values: values)
+          @session.sheets_service.update_spreadsheet_value(
+              spreadsheet.id, range, value_range, value_input_option: 'USER_ENTERED')
+
+          @modified.clear
+          sent = true
+        end
+
+        sent
+      end
+    end
+    # rubocop:enable all
+  end
+end
+
+# https://github.com/gimite/google-drive-ruby/issues/378 (PR #377)
+# https://github.com/gimite/google-drive-ruby/issues/380 (PR #379)
+GoogleDrive::Worksheet.prepend AspireBudget::CoreExtensions::Worksheet

data/lib/aspire_budget/models/category_transfer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+
+module AspireBudget
+  module Models
+    class CategoryTransfer
+      attr_reader :date, :amount, :from, :to, :memo
+
+      def self.from_row(header, row)
+        params = header.zip(row).to_h
+
+        params.tap do |h|
+          h[:date] = Utils.parse_date(h[:date])
+        end
+
+        new(**params)
+      end
+
+      def initialize(date:, amount:, from:, to:, memo:)
+        @date = date.nil? ? Date.today : Utils.parse_date(date)
+        @amount = amount.to_f
+        @from = from || 'Available to Budget'
+        @to = to
+        @memo = memo
+      end
+
+      def to_row(header)
+        header.map do |h|
+          value = send(h)
+          next Utils.serialize_date(value) if h == :date
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/{models → aspire_budget/models}/transaction.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'utils'
+require_relative '../utils'
 
 module AspireBudget
   module Models
@@ -12,30 +12,29 @@ module AspireBudget
 
         params.tap do |h|
           h[:date] = Utils.parse_date(h[:date])
-          h[:outflow] = Utils.parse_currency(h[:outflow])
-          h[:inflow] = Utils.parse_currency(h[:inflow])
           h[:status] = Utils.parse_status(h[:status])
         end
 
         new(**params)
       end
 
+      # rubocop:disable Metrics/ParameterLists
       def initialize(date:, outflow:, inflow:, category:, account:, memo:, status:)
-        @date = Utils.parse_date(date) || Date.today
-        @outflow = outflow || 0.0
-        @inflow = inflow || 0.0
+        @date = date.nil? ? Date.today : Utils.parse_date(date)
+        @outflow = outflow.to_f
+        @inflow = inflow.to_f
         @category = category
         @account = account
         @memo = memo
         @status = status
       end
+      # rubocop:enable Metrics/ParameterLists
 
       def to_row(header)
         header.map do |h|
           value = send(h)
           next Utils.serialize_date(value) if h == :date
           next Utils.serialize_status(value) if h == :status
-          next Utils.serialize_currency(value) if %i[inflow outflow].include?(h)
 
           value
         end

data/lib/aspire_budget/utils.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module AspireBudget
+  module Utils
+    class << self
+      # Parses a value to a date object
+      # @return [Date]
+      # @param value either a numeric object or an object responding to +to_date+
+      def parse_date(value)
+        return parse_serial_date(value) if value.is_a?(Numeric)
+        return value.to_date if value.respond_to?(:to_date)
+
+        raise 'Unsupported date format'
+      end
+
+      # Parses a value to a serial date
+      # @return [Float]
+      # @param value either a numeric object or an object responding to +to_date+
+      def serialize_date(value)
+        return Float(value) if value.is_a?(Numeric) && value >= 0
+
+        value = value.to_date if value.respond_to?(:to_date)
+        raise 'Unsupported date value' unless value.is_a?(Date)
+        raise "Date should be after #{LOTUS_DAY_ONE}" if LOTUS_DAY_ONE > value
+
+        Float(value - LOTUS_DAY_ONE)
+      end
+
+      # Parses a status icon
+      # @return [Symbol]
+      # @param value [String]
+      def parse_status(value)
+        TRANSACTION_STATUS_MAPPING.fetch(value, nil)
+      end
+
+      # Serialize a status symbol
+      # @return [String]
+      # @param value [Symbol]
+      def serialize_status(value)
+        TRANSACTION_STATUS_MAPPING.key(value) || ''
+      end
+
+      private
+
+      TRANSACTION_STATUS_MAPPING = {
+        '✅' => :approved,
+        '🅿️' => :pending,
+        '*️⃣' => :reconciliation
+      }.freeze
+      private_constant :TRANSACTION_STATUS_MAPPING
+
+      LOTUS_DAY_ONE = Date.new(1899, 12, 30).freeze
+      private_constant :LOTUS_DAY_ONE
+
+      def parse_serial_date(days_after_lotus_day_one)
+        LOTUS_DAY_ONE + days_after_lotus_day_one
+      end
+    end
+  end
+end

data/lib/aspire_budget/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AspireBudget
+  # Full release version.
+  # @return [String]
+  VERSION = '0.0.2'
+end

data/lib/aspire_budget/worksheets/backend_data.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'worksheet_base'
+
+module AspireBudget
+  module Worksheets
+    class BackendData < WorksheetBase
+      WS_TITLE = 'BackendData'
+
+      # @return [String] the spreadsheet version
+      def version
+        version_column = ws.rows[0].index { |header| header.include?('Update') }
+        ws.rows[1][version_column]
+      end
+    end
+  end
+end

data/lib/aspire_budget/worksheets/category_transfers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'worksheet_base'
+require_relative 'transactions'
+require_relative '../models/category_transfer'
+
+module AspireBudget
+  module Worksheets
+    class CategoryTransfers < Transactions
+      WS_TITLE = 'Category Transfers'
+
+      private
+
+      def klass
+        Models::CategoryTransfer
+      end
+
+      def header
+        @header ||=
+          super.map { |k| k == :'from category' ? :from : k }
+               .map { |k| k == :'to category' ? :to : k }[0...-1]
+      end
+    end
+  end
+end

data/lib/aspire_budget/worksheets/transactions.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'worksheet_base'
+require_relative '../models/transaction'
+
+module AspireBudget
+  module Worksheets
+    class Transactions < WorksheetBase
+      WS_TITLE = 'Transactions'
+
+      # @return [Array<AspireBudget::Transaction>] all transactions
+      def all
+        rows.map do |row|
+          klass.from_row(header, row)
+        end
+      end
+
+      # Inserts a transaction to the spreadsheet. Accepts either a transaction
+      # record or a hash (that is passed to the transaction initializer)
+      # @see AspireBudget::Models::Transaction#initialize
+      # @param record [AspireBudget::Transaction, Hash]
+      # @return [AspireBudget::Transaction] a transaction
+      def insert(record, sync: true)
+        record = klass.new(**record) if record.is_a?(Hash)
+        row = record.to_row(header)
+        ws.update_cells(*next_row_col, [row])
+        ws.synchronize if sync
+        record
+      end
+
+      private
+
+      def klass
+        Models::Transaction
+      end
+
+      # There is a 1 cell margin before the spreadsheet content
+      def margin_left
+        1
+      end
+
+      def next_row_col
+        [ws.num_rows + 1, margin_left + 1]
+      end
+
+      def sanitize(row)
+        return if row.all? { |cell| cell == '' }
+
+        row.drop(margin_left)
+      end
+
+      def rows
+        ws.rows_with_numerics(header_location)
+          .map(&method(:sanitize)).compact
+      end
+
+      def header
+        @header ||=
+          ws.rows(header_location - 1)
+            .first
+            .drop(margin_left)
+            .map(&:downcase)
+            .map(&:to_sym)
+      end
+
+      def header_location
+        @header_location ||=
+          (1..ws.num_rows).find { |i| ws[i, margin_left + 1].casecmp?('date') }
+      end
+    end
+  end
+end

data/lib/aspire_budget/worksheets/worksheet_base.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../configuration'
+
+module AspireBudget
+  module Worksheets
+    # @abstract Subclass and reimplement ws_title to implement a custom
+    #   worksheet
+    class WorksheetBase
+      class << self
+        # @return an instance of the current object
+        def instance
+          Thread.current[to_s] ||= new
+        end
+
+        private
+
+        def method_missing(method_name, *args, &block)
+          if instance.respond_to?(method_name)
+            instance.public_send(method_name, *args, &block)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(method_name, _include_private)
+          instance.respond_to?(method_name) || super
+        end
+      end
+
+      # @see AspireBudget::Configuration#agent
+      # @return a new instance of the calling class configured with an agent
+      # @param session [GoogleDrive::Session]
+      # @param spreadsheet_key [String] spreadsheet key as per its url
+      def initialize(session: nil, spreadsheet_key: nil)
+        @session = session
+        @spreadsheet_key = spreadsheet_key
+        @agent = AspireBudget.configuration.agent(@session, @spreadsheet_key)
+      end
+
+      # @return [Boolean] Whether the worksheet has unsaved changes
+      def dirty?
+        ws.dirty?
+      end
+
+      private
+
+      def ws
+        worksheets[self.class::WS_TITLE]
+      end
+
+      def worksheets
+        @worksheets ||=
+          @agent.worksheets.reduce({}) { |h, sheet| h.merge(sheet.title => sheet) }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspire_budget
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Drowze
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -24,37 +24,188 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Aspire Budget Ruby Wrapper
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Aspire Budget is a free zero-based envelope-style budgeting spreadsheet
+      built with Google Sheets by Matthew Alcorn. This gem aims to provide an
+      expressive Ruby interface to it.
 email:
 - gibim6+aspire@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- aspire_budget.gemspec
-- bin/console
-- bin/setup
-- lib/client.rb
-- lib/models/transaction.rb
-- lib/utils.rb
-- lib/version.rb
-- lib/worksheets/backend_data.rb
-- lib/worksheets/transactions.rb
-- lib/worksheets/worksheet_base.rb
-homepage: https://google.com
+- lib/aspire_budget.rb
+- lib/aspire_budget/configuration.rb
+- lib/aspire_budget/core_extensions.rb
+- lib/aspire_budget/models/category_transfer.rb
+- lib/aspire_budget/models/transaction.rb
+- lib/aspire_budget/utils.rb
+- lib/aspire_budget/version.rb
+- lib/aspire_budget/worksheets/backend_data.rb
+- lib/aspire_budget/worksheets/category_transfers.rb
+- lib/aspire_budget/worksheets/transactions.rb
+- lib/aspire_budget/worksheets/worksheet_base.rb
+homepage: https://github.com/drowze/aspirebudgeting_ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://google.com
+  homepage_uri: https://github.com/drowze/aspirebudgeting_ruby
   source_code_uri: https://github.com/drowze/aspirebudgeting_ruby
 post_install_message: 
 rdoc_options: []
@@ -64,13 +215,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- Aspire Budget spreadsheet v3.1.0+
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,11 +0,0 @@
-AllCops:
-  Exclude:
-    - 'bin/console'
-
-  NewCops: enable
-
-Metrics/AbcSize:
-  Max: 20
-
-Style/Documentation:
-  Enabled: false

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in aspire_budget.gemspec
-gemspec
-
-gem 'pry'
-gem 'rake', '~> 12.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop'

data/Gemfile.lock

@@ -1,109 +0,0 @@
-PATH
-  remote: .
-  specs:
-    aspire_budget (0.0.1)
-      google_drive (~> 3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    coderay (1.1.3)
-    declarative (0.0.10)
-    declarative-option (0.1.0)
-    diff-lcs (1.4.1)
-    faraday (1.0.1)
-      multipart-post (>= 1.2, < 3)
-    google-api-client (0.41.0)
-      addressable (~> 2.5, >= 2.5.1)
-      googleauth (~> 0.9)
-      httpclient (>= 2.8.1, < 3.0)
-      mini_mime (~> 1.0)
-      representable (~> 3.0)
-      retriable (>= 2.0, < 4.0)
-      signet (~> 0.12)
-    google_drive (3.0.5)
-      google-api-client (>= 0.11.0, < 1.0.0)
-      googleauth (>= 0.5.0, < 1.0.0)
-      nokogiri (>= 1.5.3, < 2.0.0)
-    googleauth (0.13.0)
-      faraday (>= 0.17.3, < 2.0)
-      jwt (>= 1.4, < 3.0)
-      memoist (~> 0.16)
-      multi_json (~> 1.11)
-      os (>= 0.9, < 2.0)
-      signet (~> 0.14)
-    httpclient (2.8.3)
-    jwt (2.2.1)
-    memoist (0.16.2)
-    method_source (1.0.0)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    multi_json (1.14.1)
-    multipart-post (2.1.1)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    os (1.1.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
-      ast (~> 2.4.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.5)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (1.7.1)
-    representable (3.0.4)
-      declarative (< 0.1.0)
-      declarative-option (< 0.2.0)
-      uber (< 0.2.0)
-    retriable (3.1.2)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.86.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    signet (0.14.0)
-      addressable (~> 2.3)
-      faraday (>= 0.17.3, < 2.0)
-      jwt (>= 1.5, < 3.0)
-      multi_json (~> 1.10)
-    uber (0.1.0)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  aspire_budget!
-  pry
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  rubocop
-
-BUNDLED WITH
-   2.1.4

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/aspire_budget.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'aspire_budget'
-  spec.version       = AspireBudget::VERSION
-  spec.authors       = ['Drowze']
-  spec.email         = ['gibim6+aspire@gmail.com']
-
-  spec.summary       = 'Aspire Budget Ruby Wrapper'
-  spec.description   = 'Aspire Budget Ruby Wrapper'
-  spec.homepage      = 'https://google.com'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/drowze/aspirebudgeting_ruby'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'google_drive', '~> 3.0'
-end

data/bin/console

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'pry'
-require 'google_drive'
-
-require 'bundler/setup'
-require 'client'
-
-session = GoogleDrive::Session.from_config(ENV['GOOGLE_CREDENTIALS_PATH'])
-client = AspireBudget::Client.new(session: session, spreadsheet_key: ENV['SPREADSHEET_KEY'])
-
-binding.pry
-
-# params = { date: '25/06/2020', outflow: 10.0, inflow: 12.0, category: 'test', account: 'AIB', memo: 'ruby', status: :pending }
-# client.insert_transaction(params)
-
-# client.transactions_list

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/client.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'worksheets/backend_data'
-require 'worksheets/transactions'
-
-require 'models/transaction'
-
-module AspireBudget
-  class Client
-    def initialize(session:, spreadsheet_key:)
-      @session = session
-      @spreadsheet_key = spreadsheet_key
-    end
-
-    def categories
-      backend_data.categories
-    end
-
-    def transaction_list
-      transactions.all
-    end
-
-    def insert_transaction(params)
-      transaction = Models::Transaction.new(params)
-      transactions.insert(transaction)
-    end
-
-    private
-
-    def transactions
-      @transactions ||= Worksheets::Transactions.new(agent: agent)
-    end
-
-    def backend_data
-      @backend_data ||= Worksheets::BackendData.new(agent: agent)
-    end
-
-    def agent
-      @agent ||= begin
-        @session.spreadsheet_by_key(@spreadsheet_key)
-      end
-    end
-  end
-end

data/lib/utils.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module AspireBudget
-  module Utils
-    class << self
-      DATE_FORMAT = '%d/%m/%y'
-      CURRENCY_SYMBOL = '€'
-      TRANSACTION_STATUS_MAPPING = {
-        '✅' => :approved,
-        '🅿️' => :pending,
-        '*️⃣' => :reconciliation
-      }.freeze
-
-      def parse_date(value)
-        return value unless value.is_a?(String)
-
-        Date.strptime(value, DATE_FORMAT)
-      end
-
-      def serialize_date(value)
-        return value unless value.respond_to?(:strftime)
-
-        value.strftime(DATE_FORMAT)
-      end
-
-      def parse_currency(value)
-        value && value[/\d+\.\d+/].to_f || 0.0
-      end
-
-      def serialize_currency(value)
-        "#{CURRENCY_SYMBOL}#{format('%.2f', value)}"
-      end
-
-      def parse_status(value)
-        TRANSACTION_STATUS_MAPPING.fetch(value)
-      end
-
-      def serialize_status(value)
-        TRANSACTION_STATUS_MAPPING.key(value)
-      end
-    end
-  end
-end

data/lib/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module AspireBudget
-  VERSION = '0.0.1'
-end

data/lib/worksheets/backend_data.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './worksheet_base'
-
-module AspireBudget
-  module Worksheets
-    class BackendData < WorksheetBase
-      WS_TITLE = 'BackendData'
-
-      def categories
-        fetch_data(data_title: 'Categories')
-      end
-
-      def category_exists?(category)
-        categories.include?(category)
-      end
-
-      def fetch_data(data_title: 'Categories')
-        col = (1..ws.num_cols).find_index do |i|
-          ws[1, i] == data_title
-        end
-
-        ws.rows.transpose[col].reject(&:empty?) - [data_title]
-      end
-    end
-  end
-end

data/lib/worksheets/transactions.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require 'worksheets/worksheet_base'
-require 'models/transaction'
-
-module AspireBudget
-  module Worksheets
-    class Transactions < WorksheetBase
-      WS_TITLE = 'Transactions'
-      MARGIN_LEFT = 1
-
-      def all
-        transaction_rows.map do |row|
-          Models::Transaction.from_row(transactions_header, row)
-        end
-      end
-
-      def insert(transaction, sync: true)
-        row = transaction.to_row(transactions_header)
-        ws.update_cells(ws.rows.size + 1, MARGIN_LEFT + 1, [row])
-        ws.synchronize if sync
-        Models::Transaction.from_row(transactions_header, sanitize(ws.rows.last))
-      end
-
-      private
-
-      def sanitize(row)
-        return if row.all?(&:empty?)
-
-        row.drop(MARGIN_LEFT)
-      end
-
-      def transaction_rows
-        ws.rows(transactions_header_location)
-          .map(&method(:sanitize)).compact
-      end
-
-      def transactions_header
-        @transactions_header ||=
-          ws.rows(transactions_header_location - 1)
-            .first
-            .drop(MARGIN_LEFT)
-            .map(&:downcase)
-            .map(&:to_sym)
-      end
-
-      def transactions_header_location
-        @transactions_header_location ||=
-          ((MARGIN_LEFT + 1)..ws.num_rows).find { |i| ws[i, MARGIN_LEFT + 1] == 'DATE' }
-      end
-    end
-  end
-end

data/lib/worksheets/worksheet_base.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'utils'
-
-module AspireBudget
-  module Worksheets
-    class WorksheetBase
-      include Utils
-
-      def initialize(agent:)
-        @agent = agent
-      end
-
-      private
-
-      def ws
-        worksheets[self.class::WS_TITLE]
-      end
-
-      def worksheets
-        @worksheets ||=
-          @agent.worksheets.reduce({}) { |h, sheet| h.merge(sheet.title => sheet) }
-      end
-    end
-  end
-end