stockcruncher 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd12e5a6e5db6f83f239c1b6da9aca85931048dd427778ffb96f043e7334596
-  data.tar.gz: 48fe8efa593f30fe39c294725d7090c89a4a14413eaa59a1d6741c817fc02d64
+  metadata.gz: e4729948dfb9635323240f73d947c2257b1ca4b8a6c2a065a812a8726f502599
+  data.tar.gz: 3686ad0bbb61ef2a3801a2a2c1b3258b543da3015c49b2c959570c9d7b0e8a3a
 SHA512:
-  metadata.gz: ad4ed352a8ed30d41edbe9c4bac03ba721c9af42837f9e94f9c14df2175013d4ae7a09e29c7076e034cf375abaf222ce04c251a4b8fde31ce10ae29936c18894
-  data.tar.gz: 06206e1a91e23706c6a83c02357b31064124a21e522f3144d4ec93d4d4e7863e82e38cf4b561eedb662e59ea801120ee05f8cd3fff1b414da5ea5a069dd337ff
+  metadata.gz: 24120c82f3e7cd9d622bcf1636ee528ea69d170fe0f60951b33b34754870a1b92837d5f2cbcd3f59ab4be85264195e7c2058036a557e8b486c8fe55cf81e5c18
+  data.tar.gz: e849aea61ae75175742d97611cffdc889aa3c95394aec2cc8ccbe93ed35bafc6958984fb0fc92b08190a41003c183b753ad287a51676990eee855d32f43bfceb

data/CHANGELOG

@@ -22,3 +22,9 @@ Changelog
 
 - daily subcommand now recalculates missing data
 - daily subcommand also writes data to database
+
+1.2.1
+-----
+
+- Refactor to preprocess data in source class
+- Refactor to print pretty json instead of comma separated striing

data/lib/stockcruncher/alphavantage.rb

@@ -8,12 +8,40 @@ module StockCruncher
   class AlphaVantage < Cruncher
     API_URL = 'https://www.alphavantage.co/query?'
 
+    # Method to calculate missing data (previousClose, change, changePercent)
+    def calculate_missing_data(hash)
+      keys = hash.keys
+      hash.each_with_index do |(date, v), index|
+        prevday = keys[index + 1]
+        next if prevday.nil?
+
+        prevclose = hash[prevday]['close']
+        hash[date] = v.merge(generate_missing_data(v['close'], prevclose))
+      end
+      hash
+    end
+
+    # Method to calculate change difference
+    def change(value, base)
+      (value - base).round(4).to_s
+    end
+
+    # Method to calculate percentage of change
+    def change_percent(value, base)
+      ((value / base - 1) * 100).round(4).to_s
+    end
+
+    # Method to create a new hash from two arrays of keys and values
+    def create_hash(descriptions, values)
+      descriptions.split(',').zip(values.split(',')).to_h
+    end
+
     # Main method to crunch data.
     def crunch_daily(symbol, fullsize)
       url = API_URL + parameters(symbol, 'TIME_SERIES_DAILY')
       url += '&datatype=csv&outputsize=' + (fullsize ? 'full' : 'compact')
       res = request(url)
-      res.body
+      transform_daily(res.body)
     end
 
     # Main method to crunch data.
@@ -21,14 +49,56 @@ module StockCruncher
       url = API_URL + parameters(symbol, 'GLOBAL_QUOTE')
       url += '&datatype=csv'
       res = request(url)
-      res.body
+      transform_quote(res.body)
     end
 
+    # Method to generate missing data
+    def generate_missing_data(current, previous)
+      {
+        'previousClose' => previous,
+        'change' => change(current.to_f, previous.to_f),
+        'changePercent' => change_percent(current.to_f, previous.to_f)
+      }
+    end
+
+    # Set parameters of api call
     def parameters(symbol, serie)
       p = 'function=' + serie
       p += '&symbol=' + symbol
       p += '&apikey=' + @config[self.class.name.split('::').last]['apikey']
       p
     end
+
+    # Method to transform raw data to constructed hash
+    def prepare_daily_timeserie(data)
+      lines = data.split("\r\n")
+      desc = lines.shift.split(',').drop(1)
+      hash = {}
+      lines.each do |line|
+        values = line.split(',')
+        date = values.shift
+        hash[date] = desc.zip(values).to_h
+      end
+      hash
+    end
+
+    # Method to transform daily result to nested hash
+    def transform_daily(rawdata)
+      raise StandardError, 'No data' if rawdata.match?(/Error Message/)
+
+      values = prepare_daily_timeserie(rawdata)
+      values = calculate_missing_data(values)
+      values
+    end
+
+    # Method to transform quote result to hash
+    def transform_quote(rawdata)
+      raise StandardError, 'No data' if rawdata.match?(/{}/)
+
+      values = create_hash(*rawdata.split("\r\n"))
+      values['close'] = values.delete('price')
+      values['changePercent'] = values['changePercent'].delete('%')
+      values
+    end
   end
 end

data/lib/stockcruncher/cli.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/ruby
 # frozen_string_literal: true
 
+require 'json'
 require 'thor'
 require 'yaml'
 
@@ -48,9 +49,9 @@ module StockCruncher
       opts = options.dup
       config = YAML.load_file(opts['config'])
       cruncher = StockCruncher::AlphaVantage.new(config, opts['insecure'])
-      raw_data = cruncher.crunch_daily(symbol, opts['full'])
-      StockCruncher::InfluxDB.new(config).export_history(symbol, raw_data)
-      puts raw_data unless opts['quiet']
+      data = cruncher.crunch_daily(symbol, opts['full'])
+      StockCruncher::InfluxDB.new(config).export_history(symbol, data)
+      puts JSON.pretty_generate(data) unless opts['quiet']
     end
 
     desc('quote SYMBOL [options]',
@@ -59,9 +60,9 @@ module StockCruncher
       opts = options.dup
       config = YAML.load_file(opts['config'])
       cruncher = StockCruncher::AlphaVantage.new(config, opts['insecure'])
-      raw_data = cruncher.crunch_quote(symbol)
-      StockCruncher::InfluxDB.new(config).export_last_day(raw_data)
-      puts raw_data unless opts['quiet']
+      data = cruncher.crunch_quote(symbol)
+      StockCruncher::InfluxDB.new(config).export_last_day(data)
+      puts JSON.pretty_generate(data) unless opts['quiet']
     end
   end
 end

data/lib/stockcruncher/influxdb.rb

@@ -13,62 +13,16 @@ module StockCruncher
       @insecure = insecure
     end
 
-    # Method to calculate missing data (previousClose, change, changePercent)
-    def calculate_missing_data(hash)
-      keys = hash.keys
-      hash.each_with_index do |(date, v), index|
-        prevday = keys[index + 1]
-        next if prevday.nil?
-
-        prevclose = hash[prevday]['close']
-        hash[date] = v.merge(generate_missing_data(v['close'], prevclose))
-      end
-      hash
-    end
-
-    # Method to generate missing data
-    def generate_missing_data(current, previous)
-      {
-        'previousClose' => previous,
-        'change' => change(current.to_f, previous.to_f),
-        'changePercent' => change_percent(current.to_f, previous.to_f)
-      }
-    end
-
-    # Method to calculate change difference
-    def change(value, base)
-      (value - base).round(4).to_s
-    end
-
-    # Method to calculate percentage of change
-    def change_percent(value, base)
-      ((value / base - 1) * 100).round(4).to_s
-    end
-
-    # Method to create a new hash from two arrays of keys and values
-    def create_hash(descriptions, values)
-      descriptions.split(',').zip(values.split(',')).to_h
-    end
-
     # Method to export latest data to database
-    def export_last_day(raw)
-      raise StandardError, 'No data to export' if raw.match?(/{}/)
-
-      values = create_hash(*raw.split("\r\n"))
-      values['close'] = values.delete('price')
-      values['changePercent'] = values['changePercent'].delete('%')
+    def export_last_day(values)
       tags = { 'symbol' => values.delete('symbol') }
       date = values.delete('latestDay')
       write('daily', tags, values, date)
     end
 
     # Method to export historical data to database
-    def export_history(symbol, raw)
-      raise StandardError, 'No data to export' if raw.match?(/Error Message/)
-
+    def export_history(symbol, timeseries)
       tags = { 'symbol' => symbol }
-      timeseries = prepare_daily_timeserie(raw)
-      timeseries = calculate_missing_data(timeseries)
       timeseries.each_pair do |date, values|
         write('daily', tags, values, date)
       end
@@ -84,19 +38,6 @@ module StockCruncher
       string
     end
 
-    # Method to transform raw data to constructed hash
-    def prepare_daily_timeserie(data)
-      lines = data.split("\r\n")
-      desc = lines.shift.split(',').drop(1)
-      hash = {}
-      lines.each do |line|
-        values = line.split(',')
-        date = values.shift
-        hash[date] = desc.zip(values).to_h
-      end
-      hash
-    end
-
     # Method to send http post request
     def request(url, body)
       uri = URI.parse(url)

data/lib/stockcruncher/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module StockCruncher
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/spec/files/SYM.daily

@@ -0,0 +1,49 @@
+{
+  "2020-08-03": {
+    "open": "23.8500",
+    "high": "24.6500",
+    "low": "23.7400",
+    "close": "24.5500",
+    "volume": "3112972",
+    "previousClose": "23.8100",
+    "change": "0.74",
+    "changePercent": "3.1079"
+  },
+  "2020-07-31": {
+    "open": "24.0100",
+    "high": "24.5100",
+    "low": "23.5900",
+    "close": "23.8100",
+    "volume": "5482485",
+    "previousClose": "23.6600",
+    "change": "0.15",
+    "changePercent": "0.634"
+  },
+  "2020-07-30": {
+    "open": "24.4700",
+    "high": "24.6600",
+    "low": "23.5200",
+    "close": "23.6600",
+    "volume": "6466738",
+    "previousClose": "24.5600",
+    "change": "-0.9",
+    "changePercent": "-3.6645"
+  },
+  "2020-07-29": {
+    "open": "24.7500",
+    "high": "25.0300",
+    "low": "24.0400",
+    "close": "24.5600",
+    "volume": "4605804",
+    "previousClose": "24.7500",
+    "change": "-0.19",
+    "changePercent": "-0.7677"
+  },
+  "2020-07-28": {
+    "open": "25.9900",
+    "high": "26.0700",
+    "low": "24.5100",
+    "close": "24.7500",
+    "volume": "6904261"
+  }
+}

data/spec/files/SYM.quote

@@ -0,0 +1,10 @@
+{
+  "open": "100.0000",
+  "high": "100.1000",
+  "low": "99.9000",
+  "volume": "4",
+  "previousClose": "100.0000",
+  "change": "0.0000",
+  "changePercent": "0.0000",
+  "close": "100.0000"
+}

data/spec/stockcruncher/cli_spec.rb

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'spec_helper'
 
-quote = 'symbol,open,high,low,price,volume,latestDay,previousClose,change,ch' \
-        "angePercent\r\nSYM,100.0000,100.1000,99.9000,100.0000,4,2020-07-30," \
-        "100.0000,0.0000,0.0000%\r\n"
-daily = "timestamp,open,high,low,close,volume\r\n2020-08-03,23.8500,24.6500," \
-        "23.7400,24.5500,3112972\r\n2020-07-31,24.0100,24.5100,23.5900,23.81" \
-        "00,5482485\r\n2020-07-30,24.4700,24.6600,23.5200,23.6600,6466738\r" \
-        "\n2020-07-29,24.7500,25.0300,24.0400,24.5600,4605804\r\n2020-07-28," \
-        "25.9900,26.0700,24.5100,24.7500,6904261\r\n"
+daily = File.read('spec/files/SYM.daily')
+quote = File.read('spec/files/SYM.quote')
 
 describe StockCruncher::CLI do # rubocop:disable Metrics/BlockLength
   context 'version' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockcruncher
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Richard Delaplace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,8 @@ files:
 - lib/stockcruncher/cruncher.rb
 - lib/stockcruncher/influxdb.rb
 - lib/stockcruncher/version.rb
+- spec/files/SYM.daily
+- spec/files/SYM.quote
 - spec/files/stockcruncher.yml
 - spec/spec_helper.rb
 - spec/stockcruncher/cli_spec.rb