aspire_budget 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19c4c01c53dfa0197f18c5c9106e860982bbc3456e3104f7c9587505cad730c1
+  data.tar.gz: a7665ac0e37ae4f6b9a6d125eb3845ed1ebac66228b7aad8b95dda2e725e3593
+SHA512:
+  metadata.gz: 48e8701f8b7ded9c829d2c83e3d2dcf8f3ce51c8ca5ee5605574d3ce65bd1db0db089cac7a79a1d0f95ce31a1abe5f12122d343d3bd957efc41e89bf02c5259e
+  data.tar.gz: 227a8bf87a812c688592d8fac317bebe51abd9517d5ad5176416ee79aa50dd8d5eb4a50da023a28a1a8abaeaf7021a162121b527bdc405554cd02c1688e04e1d

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,109 @@
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Drowze
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# 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`.  
+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
+
+## Usage
+
+```ruby
+session = GoogleDrive::Session.from_config('path_to_your_credentials.json')
+client = AspireBudget::Client.new(session: session, spreadsheet_key: 'YOUR_SPREADSHEET_KEY')
+```
+
+## Development
+
+todo
+
+## Contributing
+
+Bug reports, feature requests and pull requests are welcome.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,30 @@
+# 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

@@ -0,0 +1,18 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

@@ -0,0 +1,44 @@
+# 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/models/transaction.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'utils'
+
+module AspireBudget
+  module Models
+    class Transaction
+      attr_reader :date, :outflow, :inflow, :category, :account, :memo, :status
+
+      def self.from_row(header, row)
+        params = header.zip(row).to_h
+
+        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
+
+      def initialize(date:, outflow:, inflow:, category:, account:, memo:, status:)
+        @date = Utils.parse_date(date) || Date.today
+        @outflow = outflow || 0.0
+        @inflow = inflow || 0.0
+        @category = category
+        @account = account
+        @memo = memo
+        @status = status
+      end
+
+      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
+      end
+    end
+  end
+end

data/lib/utils.rb

@@ -0,0 +1,43 @@
+# 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

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

data/lib/worksheets/backend_data.rb

@@ -0,0 +1,27 @@
+# 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

@@ -0,0 +1,53 @@
+# 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

@@ -0,0 +1,26 @@
+# 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

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: aspire_budget
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Drowze
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google_drive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Aspire Budget Ruby Wrapper
+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
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://google.com
+  source_code_uri: https://github.com/drowze/aspirebudgeting_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Aspire Budget Ruby Wrapper
+test_files: []