coin_portfolio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8a032d0d880bb3634a0a36d4a326f8f8ecfd5aa
+  data.tar.gz: c0bb36a36153d2d0b9a3455f04323d15d1a5d51d
+SHA512:
+  metadata.gz: 2031265f7c27bfac6e03b520a754a1c2093dd3642071ef6d1108d80ba5360f0e2328c1800e5635ec2757dc1749e1463e2cc30faa83e498b023e59816b1b8ac36
+  data.tar.gz: 5064e4896ed6bc79585772263cc4132500f41801c8383e024dab91b05c9d3aad4f1347d9aaa9988c2a63765e4248d98970bd7afe9d0bf72b64fcef32d6d3a3d3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coin_portfolio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Name: coin_portfolio
+Copyright (c) 2016 Mário Nzualo
+
+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,50 @@
+# CoinPortfolio
+
+CoinPortfolio calculates the gains/losses of the current cryptocurrency portfolio.
+
+Typically when checking the evolution of the price of bitcoin you can see how much the price increased/decreased over
+a period of time (e.g. day, week, year).
+
+What if you wanted to answer the question: Would it be profitable to sell all my bitcoins now? This small library
+attempts to answer that question by calculating the portfolio cost, portfolio value and the
+percentage of gains/losses, if the portfolio were to be fully liquidated now.
+
+The library tries to account for scenarios in which an account has multiple incoming and outgoing transactions with
+distinct prices using the [FIFO accounting method](https://en.wikipedia.org/wiki/FIFO_and_LIFO_accounting).
+
+This is still a work in progress.
+
+## Usage
+
+The library uses the Coinbase API to:
+- access the primary account for a given API key and secret
+
+- iterate through all the account's transactions in order to get a snapshot of the distribution of the portfolio
+
+- get the current price of the account's cryptocurrency
+
+The API keys need to have the following permissions: `wallet:accounts:read`, `wallet:transactions:read`.
+
+```ruby
+$ bundle exec rake console
+$ api_key = "key"
+$ api_secret = "secret"
+$ calculator = CoinPortfolio::Calculator.new(api_key: api_key, api_secret: api_secret)
+$ calculator.potential_returns
+gains percentage: 25.00%
+portfolio cost: €100,00
+current portfolio value: €125,00
+```
+
+## Improvements
+Until now the priority has been getting a working version therefore, there are still plenty of improvements to be made:
+- API client - the code that interacts with coinbase's gem is isolated in a single class which translates
+response hashes into domain objects. Yet the code is tied to coinbase's gem and would require some changes if there was
+a need to integrate with another exchange. Additionally a proper handling of API related errors hasn't been
+implemented.
+
+- Multiple currencies - the code currently assumes that the user's account has a single cryptocurrency and that its
+transactions are all in the same native currency. This might not be true in all cases.
+
+## License
+MIT (c) Mário Nzualo

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+task :console do
+  exec "irb -r coin_portfolio -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coin_portfolio"
+
+# 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

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/coin_portfolio.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coin_portfolio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coin_portfolio"
+  spec.version       = CoinPortfolio::VERSION
+  spec.authors       = ["Mário Nzualo"]
+  spec.email         = ["mario.nzualo@gmail.com"]
+
+  spec.summary       = %q{Calculate the gains/losses of the a crytocurrency portfolio}
+  spec.homepage      = "https://github.com/marionzualo/coin_portfolio"
+
+  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.licenses = %w(MIT)
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4", ">= 3.4.0"
+  spec.add_dependency "immutable-struct", "~> 2.2", ">= 2.2.2"
+  spec.add_dependency "coinbase", "~> 4.1", ">= 4.1.0"
+  spec.add_dependency "money", "~> 6.7", ">= 6.7.1"
+end

data/lib/coin_portfolio.rb

@@ -0,0 +1,9 @@
+require "immutable-struct"
+require "coin_portfolio/liquidation"
+require "coin_portfolio/inventory"
+require "coin_portfolio/inventory_item"
+require "coin_portfolio/transaction"
+require "coin_portfolio/exchange_client"
+require "coin_portfolio/money"
+require "coin_portfolio/calculator"
+require "coin_portfolio/version"

data/lib/coin_portfolio/calculator.rb

@@ -0,0 +1,42 @@
+module CoinPortfolio
+  class Calculator
+    def initialize(api_key:, api_secret:)
+      @api_key = api_key
+      @api_secret = api_secret
+    end
+
+    def potential_returns
+      liquidation = Liquidation.new(inventory_items)
+      details = liquidation.details(price)
+      puts "Gains percentage: #{format_percentage(details.gains_percentage)}"
+      puts "Portfolio cost: #{details.portfolio_cost}"
+      puts "Current portfolio value: #{details.current_portfolio_value}"
+      details
+    end
+
+    private
+
+    attr_reader :api_key, :api_secret
+
+    def format_percentage(percentage)
+      rounded = (percentage * 100).round(2)
+      "#{sprintf("%.2f", rounded)}%"
+    end
+
+    def inventory_items
+      Inventory.new(transactions).build
+    end
+
+    def transactions
+      client.transactions
+    end
+
+    def price
+      client.price
+    end
+
+    def client
+      @client ||= ExchangeClient.new(api_key: api_key, api_secret: api_secret)
+    end
+  end
+end

data/lib/coin_portfolio/exchange_client.rb

@@ -0,0 +1,46 @@
+require "coinbase/wallet"
+
+module CoinPortfolio
+  class ExchangeClient
+    def initialize(api_key:, api_secret:, client_factory: Coinbase::Wallet::Client)
+      @api_key = api_key
+      @api_secret = api_secret
+      @client_factory = client_factory
+    end
+
+    def price
+      sell_price = client.sell_price
+      CoinPortfolio::Money.new(amount: BigDecimal.new(sell_price["amount"]), currency: sell_price["currency"])
+    end
+
+    def transactions
+      transactions_from_client.map do |transaction|
+        amount = transaction["amount"]
+        money_amount = CoinPortfolio::Money.new(amount: BigDecimal.new(amount["amount"]).abs, currency: amount["currency"])
+
+        native_amount = transaction["native_amount"]
+        money_native_amount = CoinPortfolio::Money.new(amount: BigDecimal.new(native_amount["amount"]).abs, currency: native_amount["currency"])
+
+        incoming = amount["amount"][0] != "-"
+
+        CoinPortfolio::Transaction.new(amount: money_amount, native_amount: money_native_amount, incoming: incoming)
+      end
+    end
+
+    private
+
+    attr_reader :api_key, :api_secret, :client_factory
+
+    def transactions_from_client
+      client.transactions(account_id, fetch_all: true)
+    end
+
+    def account_id
+      client.primary_account["id"]
+    end
+
+    def client
+      @client = client_factory.new(api_key: api_key, api_secret: api_secret)
+    end
+  end
+end

data/lib/coin_portfolio/inventory.rb

@@ -0,0 +1,39 @@
+module CoinPortfolio
+  class Inventory
+    def initialize(transactions)
+      @transactions = transactions
+    end
+
+    def build
+      build_inventory_with_fifo_method
+    end
+
+    private
+
+    attr_reader :transactions
+
+    def build_inventory_with_fifo_method
+      outgoing_quantity = total_outgoing_quantity
+      incoming_transactions.each_with_object([]) do |transaction, inventory_items|
+        transaction_quantity = transaction.amount.amount
+        remaining_quantity = transaction_quantity - outgoing_quantity
+        if remaining_quantity > 0
+          item = InventoryItem.new(quantity: remaining_quantity, cost: transaction.price)
+          inventory_items.push(item)
+        end
+
+        outgoing_quantity = [0, outgoing_quantity - transaction_quantity].max
+      end
+    end
+
+    def incoming_transactions
+      transactions.select(&:incoming?)
+    end
+
+    def total_outgoing_quantity
+      transactions.reject(&:incoming?).reduce(0) do |sum, transaction|
+        sum + transaction.amount.amount
+      end
+    end
+  end
+end

data/lib/coin_portfolio/inventory_item.rb

@@ -0,0 +1,3 @@
+module CoinPortfolio
+  InventoryItem = ImmutableStruct.new(:quantity, :cost)
+end

data/lib/coin_portfolio/liquidation.rb

@@ -0,0 +1,41 @@
+module CoinPortfolio
+  class Liquidation
+    Details = ImmutableStruct.new(:portfolio_cost, :current_portfolio_value, :gains_percentage)
+    def initialize(inventory_items)
+      @inventory_items = inventory_items
+    end
+
+    def details(price)
+      current_portfolio_value = current_portfolio_value(price)
+      gains_percentage = (current_portfolio_value - portfolio_cost).to_f / portfolio_cost
+      currency = price.currency
+
+      attributes = {
+        portfolio_cost: Money.new(amount: portfolio_cost, currency: currency),
+        current_portfolio_value: Money.new(amount: current_portfolio_value, currency: currency),
+        gains_percentage: gains_percentage
+      }
+      Details.new(attributes)
+    end
+
+    private
+
+    def portfolio_cost
+      inventory_items.reduce(0) do |sum, item|
+        sum + (item.quantity * item.cost.amount)
+      end
+    end
+
+    def current_portfolio_value(price)
+      total_item_quantity * price.amount
+    end
+
+    def total_item_quantity
+      inventory_items.reduce(0) do |sum, item|
+        sum + item.quantity
+      end
+    end
+
+    attr_reader :inventory_items
+  end
+end

data/lib/coin_portfolio/money.rb

@@ -0,0 +1,10 @@
+require "money"
+I18n.enforce_available_locales = false
+
+module CoinPortfolio
+  Money = ImmutableStruct.new(:amount, :currency) do
+    def to_s
+      ::Money.from_amount(amount, currency).format
+    end
+  end
+end

data/lib/coin_portfolio/transaction.rb

@@ -0,0 +1,24 @@
+module CoinPortfolio
+  class Transaction
+    attr_accessor :amount, :native_amount
+
+    def initialize(amount:, native_amount:, incoming:)
+      @amount = amount
+      @native_amount = native_amount
+      @incoming = incoming
+    end
+
+    def price
+      price_f = native_amount.amount.to_f / amount.amount
+      CoinPortfolio::Money.new(amount: price_f, currency: native_amount.currency)
+    end
+
+    def incoming?
+      incoming
+    end
+
+    private
+
+    attr_accessor :incoming
+  end
+end

data/lib/coin_portfolio/version.rb

@@ -0,0 +1,3 @@
+module CoinPortfolio
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: coin_portfolio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mário Nzualo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: immutable-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: coinbase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.7.1
+description: 
+email:
+- mario.nzualo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coin_portfolio.gemspec
+- lib/coin_portfolio.rb
+- lib/coin_portfolio/calculator.rb
+- lib/coin_portfolio/exchange_client.rb
+- lib/coin_portfolio/inventory.rb
+- lib/coin_portfolio/inventory_item.rb
+- lib/coin_portfolio/liquidation.rb
+- lib/coin_portfolio/money.rb
+- lib/coin_portfolio/transaction.rb
+- lib/coin_portfolio/version.rb
+homepage: https://github.com/marionzualo/coin_portfolio
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Calculate the gains/losses of the a crytocurrency portfolio
+test_files: []