ledger_get_prices 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faf17809292e7310521c27fd452006a12c4e585d
+  data.tar.gz: a89bdaa59b678bf5148f2b70fbc869c4df30c88d
+SHA512:
+  metadata.gz: 4ef4c4c623b7b9bbd5bf7cd72629301c67ddf76c0f623445ef3b8f4ec84e90e227f648f99dcf1246b4e24440d5ca6b9143d4b9dec8969930b0b0db3ad2bdb502
+  data.tar.gz: c3eb9534015dff5466e9196bd92b36570c65d4dab13d24321538dfeacec37639b44dc0cf82124880acba969e43718e20925d1dd7356299b25da07493c0df6b4f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nathan Kot
+
+MIT License
+
+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,28 @@
+## ledger-get-prices
+
+It's the end of financial year, and now that I'm accounting with NZD,USD,JPY,BTC I've spent some time to automate the
+pricedb process. Enjoy :) PR's welcome.
+
+# Synopsis
+
+_Tool that uses Yahoo finance to intelligently generate
+a ledger price database based on your current ledger
+commodities and time period._
+
+Ensure that you have set the `LEDGER` and `LEDGER_PRICE_DB`
+environment variables before proceeding. Alternatively, you
+can make the same addition to your `.ledgerrc`, so long as
+running `ledger` vanilla knows where to get the journal and
+pricedb.
+
+# Environment Variables
+
+* __LEDGER_BASE_CURRENCY__: Defaults to USD, change this to your reporting currency.
+* __LEDGER_PRICE_DATE_FORMAT__: The date format of the outputted pricedb. Defaults to +%Y/%m/%d+.
+
+# Usage
+
+```sh
+gem install ledger-get-prices
+getprices # This will WRITE to your LEDGER_PRICE_DB file.
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/getprices

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'ledger_get_prices'
+LedgerGetPrices::GetPrices.run!

data/ledger_get_prices.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ledger_get_prices/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ledger_get_prices"
+  spec.version       = LedgerGetPrices::VERSION
+  spec.authors       = ["Nathan Kot"]
+  spec.email         = ["nk@nathankot.com"]
+  spec.summary       = 'Intelligently update your ledger pricedb'
+  spec.homepage      = 'https://github.com/nathankot/ledger-get-prices'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "yahoo-finance"
+end

data/lib/ledger_get_prices/version.rb

@@ -0,0 +1,3 @@
+module LedgerGetPrices
+  VERSION = "0.0.4"
+end

data/lib/ledger_get_prices.rb

@@ -0,0 +1,141 @@
+require "ledger_get_prices/version"
+require 'date'
+require 'open-uri'
+require 'yahoo-finance'
+
+module LedgerGetPrices
+
+  # = Synopsis
+  #
+  # Tool that uses Yahoo finance to intelligently generate
+  # a ledger price database based on your current ledger
+  # commodities and time period.
+  #
+  # Ensure that you have set the +LEDGER+ and +LEDGER_PRICE_DB+
+  # environment variables before proceeding. Alternatively, you
+  # can make the same addition to your +.ledgerrc+, so long as
+  # running +ledger+ vanilla knows where to get the journal and
+  # pricedb.
+  #
+  # = Options
+  #
+  # +LEDGER_BASE_CURRENCY+: Defaults to USD, change this to your reporting currency.
+  # +LEDGER_PRICE_DATE_FORMAT+: The date format of the outputted pricedb. Defaults to +%Y/%m/%d+.
+  class GetPrices
+    class << self
+
+      # Yahoo finance works best in USD, if the base currency is
+      # different we will also store the USD price of that currency
+      # to allow for conversion.
+      BASE_CURRENCY = ENV['LEDGER_BASE_CURRENCY'] || "USD"
+
+      PRICE_DB_PATH = ENV['LEDGER_PRICE_DB'] || ENV['PRICE_HIST'] # PRICE_HIST is <v3
+      DATE_FORMAT = ENV['LEDGER_PRICE_DATE_FORMAT'] || "%Y/%m/%d"
+      PRICE_FORMAT = "P %{date} %{time} %{symbol} %{price}"
+      COMMODITY_BLACKLIST = (ENV['LEDGER_PRICE_COMMODITY_BLACKLIST'] || 'BTC').split(" ")
+
+      # With a bang because it does a file write.
+      def run!
+        File.write(PRICE_DB_PATH, new_prices.join("\n"))
+      end
+
+      # We work with the database as an array of price definitions
+      # @return [Array] an array of formatted prices
+      def existing_prices
+        @existing_prices ||= File.read(PRICE_DB_PATH)
+                                .split("\n")
+                                .reject { |x| (/^P.*$/ =~ x) != 0 }
+      end
+
+      # This method builds a new price database intelligently.
+      #
+      # @return [Array] an array of formatted prices
+      def new_prices
+        commodities.reduce(existing_prices) do |db, c|
+          # `|` is a shortcut for merge
+          db | prices_for_symbol(c, start_date: start_date, end_date: end_date)
+              .map { |x| price_string_from_result(x, symbol: c) }
+        end
+      end
+
+      # @return [Array] of YahooFinance results (OpenStruct)
+      def prices_for_symbol(symbol, start_date: start_date, end_date: end_date) # -> Array
+        puts "Getting historical quotes for: #{symbol}"
+
+        if COMMODITY_BLACKLIST.include?(symbol)
+          puts "Skipping #{symbol}: blacklisted."
+          puts "Use `LEDGER_PRICE_COMMODITY_BLACKLIST` to configure the blacklist."
+          puts "BTC is included by default because yahoo doesn't provide a way to " +
+              "get historical data for it."
+          return []
+        end
+
+        result = nil
+        quote_strings = possible_quote_strings(commodity: symbol)
+        err = nil
+
+        while quote_strings.length > 0 && result.nil?
+          begin
+            result = YahooFinance.historical_quotes(
+              quote_strings.shift, start_date: start_date, end_date: end_date, period: :daily)
+          rescue OpenURI::HTTPError => e
+            err = e
+          end
+        end
+
+        if result.nil?
+          puts "Could not get quotes from Yahoo for: #{symbol}"
+          puts "It may be worthwhile getting prices for this manually."
+          []
+        else result
+        end
+      end
+
+      # @return [String]
+      def price_string_from_result(data, symbol: nil)
+        raise "Must pass symbol" if symbol.nil?
+        PRICE_FORMAT % {
+          date: Date.strptime(data.trade_date, '%Y-%m-%d').strftime(DATE_FORMAT),
+          time: '23:59:59',
+          symbol: (BASE_CURRENCY == 'USD' ? '$' : 'USD'),
+          price: (BASE_CURRENCY == symbol ? '$' : symbol)+ data.close
+        }
+      end
+
+      protected
+
+      # Start date is either the latest price record or the earliest
+      # ever transaction.
+      # @return [Date]
+      def start_date
+        @start_date ||= existing_prices.map { |x| Date.strptime(x.split(" ")[1], DATE_FORMAT) }.max || begin
+          stats = `ledger stats` # Most compact way to retrieve this data
+          date_str = /Time\speriod:\s*([\d\w\-]*)\s*to/.match(stats)[1]
+          return Date.strptime(date_str, "%y-%b-%d")
+        end
+      end
+
+      # End date is today, wish I can see the future but unfortunately..
+      # @return [Date]
+      def end_date
+        @end_date ||= Date.new()
+      end
+
+      # Try the commodity as a currency first, before trying it as a stock
+      # @return [Array<String>] Possible Yahoo finance compatible quote strings
+      def possible_quote_strings(commodity: nil)
+        raise "No commodity given" if commodity.nil?
+        ["#{commodity}=X", "USD#{commodity}=X", "#{commodity}"]
+      end
+
+      def commodities
+        # All the commodities we care about.
+        @commodities ||= `ledger commodities`.split("\n").reject { |x| x == "$" }.tap do |c|
+          c << BASE_CURRENCY if BASE_CURRENCY != 'USD'
+        end
+      end
+
+    end
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ledger_get_prices
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Nathan Kot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: yahoo-finance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- nk@nathankot.com
+executables:
+- getprices
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/getprices
+- ledger_get_prices.gemspec
+- lib/ledger_get_prices.rb
+- lib/ledger_get_prices/version.rb
+homepage: https://github.com/nathankot/ledger-get-prices
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Intelligently update your ledger pricedb
+test_files: []