ynaby 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b21b856bead07531e58c55c7727c679d46ed48801f8f127ba6ccf042d6ab337b
+  data.tar.gz: b7d932ba0ff729086a73ee8dd89408e5313e1104e5f2e80645df523938e3066e
+SHA512:
+  metadata.gz: 978f68ad287963620e267543d765eecc2a06bf7971cdf83efdd26cad1feb451cbd92435d9872fa8f962b518e9a3e852b759522d37f33d972e24f404150a455ff
+  data.tar.gz: '05819dd495b22761d5ec63aac8ddd785f5b5dee3f5038800e8f7fecf689ea8f4d3dc00d61396e8282a77991d271e58127286225f92709834feca847a845cdd67'

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ynaby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    ynaby (0.3.0)
+      ynab (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    ynab (0.7.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 4.0.0)
+  webmock (~> 3.4.2)
+  ynaby!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rafael Millan
+
+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,62 @@
+# Ynaby
+
+Unofficial wrapper gem of the [YNAB Ruby SDK](https://github.com/ynab/ynab-sdk-ruby) for modifying and creating transactions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ynaby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ynaby
+
+## Usage
+
+```ruby
+user = Ynaby::User.new("my_api_token")
+
+user.budgets # All budgets
+budget = user.budget("budget_id") # Find budget
+
+budget.accounts # All accounts
+account = budget.account("account_id") # Find account
+
+account.transactions # All transactions
+account.transaction(since: Date.new(2018, 9, 28)) # Transactions since date
+transaction = account.transaction("transaction_id") # Find transaction
+
+transaction.memo = "New memo"
+transaction.update # Updates the transaction
+
+new_transaction = Ynaby::Transaction.new(
+  date: Date.new(2018, 9, 15),
+  amount: -10000,
+  payee_name: "Jerry Seinfeld",
+  account: account
+)
+new_transaction.upload # Creates a new transaction
+
+account.bulk_upload_transactions([new_transaction]) # Bulk upload
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rafaelmillan/ynaby.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ynaby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/ynaby.rb

@@ -0,0 +1,7 @@
+require "ynaby/version"
+
+require "ynaby/base"
+require "ynaby/account"
+require "ynaby/budget"
+require "ynaby/transaction"
+require "ynaby/user"

data/lib/ynaby/account.rb

@@ -0,0 +1,127 @@
+module Ynaby
+  class Account < Base
+    attr_reader :id, :name, :type, :on_budget, :closed, :note, :balance, :cleared_balance, :uncleared_balance, :budget
+
+    def initialize(id:,
+                   name:,
+                   type:,
+                   on_budget:,
+                   closed:,
+                   note:,
+                   balance:,
+                   cleared_balance:,
+                   uncleared_balance:,
+                   budget:)
+
+      @id = id
+      @name = name
+      @type = type
+      @on_budget = on_budget
+      @closed = closed
+      @note = note
+      @balance = balance
+      @cleared_balance = cleared_balance
+      @uncleared_balance = uncleared_balance
+      @budget = budget
+    end
+
+    def transactions(since: nil)
+      response = ynab_client
+        .transactions
+        .get_transactions_by_account(
+          budget.id,
+          @id,
+          since_date: since&.to_date&.iso8601
+        )
+
+      response.data.transactions.map do |transaction|
+        Transaction.parse(object: transaction, account: self)
+      end
+    end
+
+    def bulk_upload_transactions(transactions)
+      if transactions.to_a.empty?
+        return {
+          new: 0,
+          updated: 0
+        }
+      end
+
+      body = {
+        transactions: transactions.map(&:upload_hash)
+      }
+
+      response = ynab_client.transactions.bulk_create_transactions(budget.id, body)
+      duplicate_transactions = response.data.bulk.duplicate_import_ids
+
+      if duplicate_transactions.any?
+        update_duplicate_transactions(
+          new_transactions: transactions,
+          duplicate_transactions_ids: response.data.bulk.duplicate_import_ids
+        )
+      end
+
+      {
+        new: response.data.bulk.transaction_ids.count,
+        updated: duplicate_transactions.count
+      }
+    end
+
+    def transaction(transaction_id)
+      response = ynab_client.transactions.get_transactions_by_id(budget.id, transaction_id)
+
+      Transaction.parse(object: response.data.transaction, account: self)
+    end
+
+    def self.parse(object:, budget:)
+      new(
+        id: object.id,
+        name: object.name,
+        type: object.type,
+        on_budget: object.on_budget,
+        closed: object.closed,
+        note: object.note,
+        balance: object.balance,
+        cleared_balance: object.cleared_balance,
+        uncleared_balance: object.uncleared_balance,
+        budget: budget
+      )
+    end
+
+    def api_token
+      budget.api_token
+    end
+
+    private
+
+    def update_duplicate_transactions(new_transactions:, duplicate_transactions_ids:)
+      old_transactions = find_from_import_ids(duplicate_transactions_ids)
+
+      old_transactions.each do |old_transaction|
+        new_transaction = new_transactions.find do |transaction|
+          transaction.import_id == old_transaction.import_id
+        end
+
+        new_transaction.id = old_transaction.id
+        new_transaction.update
+      end
+    end
+
+    def find_from_import_ids(import_ids)
+      earliest_import_date = import_ids.sort.first.split(":")[2]
+
+      ynab_transactions = ynab_client.transactions.get_transactions(
+        budget.id,
+        since_date: earliest_import_date
+      ).data.transactions
+
+      parsed_transactions = ynab_transactions.map do |transaction_object|
+        Transaction.parse(object: transaction_object, account: self)
+      end
+
+      parsed_transactions.select do |transaction|
+        import_ids.include?(transaction.import_id)
+      end
+    end
+  end
+end

data/lib/ynaby/base.rb

@@ -0,0 +1,9 @@
+require "ynab"
+
+module Ynaby
+  class Base
+    def ynab_client
+      YnabApi::Client.new(api_token)
+    end
+  end
+end

data/lib/ynaby/budget.rb

@@ -0,0 +1,45 @@
+module Ynaby
+  class Budget < Base
+    attr_reader :id, :name, :last_modified_on, :date_format, :currency_format, :user
+
+    def initialize(id:, name:, last_modified_on:, date_format:, currency_format:, user:)
+      @id = id
+      @name = name
+      @last_modified_on = last_modified_on
+      @date_format = date_format
+      @currency_format = currency_format || {}
+      @user = user
+    end
+
+    def accounts
+      response = ynab_client.accounts.get_accounts(@id)
+      response.data.accounts.map do |account|
+        Account.parse(object: account, budget: self)
+      end
+    end
+
+    def account(account_id)
+      response = ynab_client.accounts.get_account_by_id(id, account_id)
+      Account.parse(object: response.data.account, budget: self)
+    end
+
+    def currency_code
+      currency_format[:iso_code]
+    end
+
+    def self.parse(object, user)
+      new(
+        id: object.id,
+        name: object.name,
+        last_modified_on: object.last_modified_on,
+        date_format: object.date_format.to_hash,
+        currency_format: object.currency_format.to_hash,
+        user: user
+      )
+    end
+
+    def api_token
+      user.api_token
+    end
+  end
+end

data/lib/ynaby/transaction.rb

@@ -0,0 +1,104 @@
+module Ynaby
+  class Transaction < Base
+    attr_reader :account, :date, :payee_name, :import_id, :cleared, :approved,
+                :flag_color, :payee_id, :category_id, :transfer_account_id,
+                :import_id, :account_name, :payee_name, :category_name, :account
+
+    attr_accessor :id, :memo, :amount
+
+    def initialize(id: nil,
+                   date:,
+                   amount:,
+                   memo: nil,
+                   cleared: nil,
+                   approved: nil,
+                   flag_color: nil,
+                   payee_id: nil,
+                   category_id: nil,
+                   transfer_account_id: nil,
+                   import_id: nil,
+                   account_name: nil,
+                   payee_name:,
+                   category_name: nil,
+                   account:)
+
+      @id = id
+      @date = date
+      @amount = amount
+      @memo = memo
+      @cleared = cleared
+      @approved = approved
+      @flag_color = flag_color
+      @payee_id = payee_id
+      @category_id = category_id
+      @transfer_account_id = transfer_account_id
+      @import_id = import_id
+      @account_name = account_name
+      @payee_name = payee_name
+      @category_name = category_name
+      @account = account
+    end
+
+    def upload
+      body = {
+        transaction: upload_hash
+      }
+
+      response = ynab_client.transactions.create_transaction(budget_id, body)
+
+      self.class.parse(object: response.data.transaction, account: account)
+    end
+
+    def upload_hash
+      {
+        account_id: @account.id,
+        date: @date.to_date.iso8601,
+        amount: @amount,
+        payee_name: @payee_name,
+        import_id: @import_id,
+        payee_id: nil,
+        memo: @memo&.slice(0...50)
+      }
+    end
+
+    def update
+      body = {
+        transaction: upload_hash
+      }
+
+      response = ynab_client.transactions.update_transaction(budget_id, id, body)
+
+      self.class.parse(object: response.data.transaction, account: account)
+    end
+
+    def self.parse(object:, account:)
+      new(
+        id: object.id,
+        date: object.date,
+        amount: object.amount.to_i,
+        memo: object.memo,
+        cleared: object.cleared,
+        approved: object.approved,
+        flag_color: object.flag_color,
+        payee_id: object.payee_id,
+        category_id: object.category_id,
+        transfer_account_id: object.transfer_account_id,
+        import_id: object.import_id,
+        account_name: object.account_name,
+        payee_name: object.payee_name,
+        category_name: object.category_name,
+        account: account
+      )
+    end
+
+    private
+
+    def budget_id
+      account.budget.id
+    end
+
+    def api_token
+      account.api_token
+    end
+  end
+end

data/lib/ynaby/user.rb

@@ -0,0 +1,20 @@
+module Ynaby
+  class User < Base
+    attr_reader :api_token
+
+    def initialize(api_token)
+      @api_token = api_token
+    end
+
+    def budgets
+      response = ynab_client.budgets.get_budgets
+      response.data.budgets.map do |budget|
+        Budget.parse(budget, self)
+      end
+    end
+
+    def budget(id)
+      budgets.find { |budget| budget.id == id }
+    end
+  end
+end

data/lib/ynaby/version.rb

@@ -0,0 +1,3 @@
+module Ynaby
+  VERSION = "0.3.0"
+end

data/ynaby.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ynaby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ynaby"
+  spec.version       = Ynaby::VERSION
+  spec.authors       = ["Rafael Millán"]
+  spec.email         = ["rafmillan@gmail.com"]
+
+  spec.summary       = %q{A Ruby library for editing YNAB transaction.}
+  spec.homepage      = "https://github.com/rafaelmillan/ynaby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "ynab", "~> 0.7.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.4.2"
+  spec.add_development_dependency "vcr", "~> 4.0.0"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: ynaby
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Rafael Millán
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ynab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: 
+email:
+- rafmillan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ynaby.rb
+- lib/ynaby/account.rb
+- lib/ynaby/base.rb
+- lib/ynaby/budget.rb
+- lib/ynaby/transaction.rb
+- lib/ynaby/user.rb
+- lib/ynaby/version.rb
+- ynaby-0.1.0.gem
+- ynaby-0.2.0.gem
+- ynaby.gemspec
+homepage: https://github.com/rafaelmillan/ynaby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A Ruby library for editing YNAB transaction.
+test_files: []