stockcruncher 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fe544c0ab3e0bb05c2cca11cb4363bce698cf88b565d897098420b3b8206ac
-  data.tar.gz: bc0de76838cf286f9c5400ddc368da33ee2bd748f0a5a29ebed653010e183d8a
+  metadata.gz: 51887b6440cf8d3958f52c05d5daa9e77c0bada0e385445ec6bcb6553fe9c16d
+  data.tar.gz: 66ade1c3623130c5e5588ceca005bddb201b176d1d81ffbb0cabd41568b1692c
 SHA512:
-  metadata.gz: b69c6d91c2160e1e70a339ea68616b27012839b105dcfd0cef5ccf7a9643e3a08fb88738d794cf98e3d4de03e505c32db4a827d45a296d734f7e10d2334eb287
-  data.tar.gz: 44ecc54323e85117c04bb0aa8b9c2ab54421020a2614b01356988700f610264e1e82a07e88d5fd62f62945c1469c508699b3a78c2dad52a73b988e508ce2264d
+  metadata.gz: 0bbdd83e653eadf37c57b6cf5e2bf3234c94ccf74d59ffcd21f995d74260a7673da8a79564f37b4b69715fb5f295d0e1bcf2465fee119a84965cbcc333d0f0bc
+  data.tar.gz: 979223a1ee0cba78f9d482d22f3025c17fb0506c487d237b94b5855a7843ef3eca610fd89fcbd0a41c66325a1f9e86786e0b56703d666fbca8d5417dd3906321

data/CHANGELOG

@@ -5,3 +5,9 @@ Changelog
 -----
 
 - Initial version
+
+1.1.0
+-----
+
+- Add InfluxDB as database.
+- WIP for daily time serie.

data/README.md

@@ -25,29 +25,38 @@ to write the data in a database for later calculation and use.
 
     $ gem install stockcruncher
     $ mkdir /etc/stockcruncher && cd /etc/stockcruncher
-    $ echo $'AlphaVantage:\n  apikey: CHANGEME' > stockcruncher.yml
+    $ echo 'AlphaVantage:' > stockcruncher.yml
+    $ echo '  apikey: CHANGEME' >> stockcruncher.yml
+    $ echo 'InfluxDB:' >> stockcruncher.yml
+    $ echo '  scheme: http' >> stockcruncher.yml
+    $ echo '  host: localhost' >> stockcruncher.yml
+    $ echo '  port: 8086' >> stockcruncher.yml
+    $ echo '  user: CHANGEMEAGAIN' >> stockcruncher.yml
+    $ echo '  password: CHANGEMETOO' >> stockcruncher.yml
+    $ echo '  dbname: stock' >> stockcruncher.yml
 
 ## Usage
 
 An interactive help is available with:
 
-    $ stockcruncher help
+    $ stockcruncher help [subcommand]
 
 ## Examples
 
 To get daily time serie data of a symbol:
 
-    $ stockcruncher crunch AAPL daily
+    $ stockcruncher daily AAPL
 
 To get last day endpoint data of a symbol:
 
-    $ stockcruncher crunch AAPL quote_endpoint
+    $ stockcruncher quote AAPL
 
 ## Limitations
 
 Data are currently scraped from AlphaVantage API.
 More source could be great especially because AlphaVantage doesn't provide EU
 intraday data.
+InfluxDB is used as database to keep time series data.
 
 ## Development
 

data/lib/stockcruncher/alphavantage.rb

@@ -9,28 +9,19 @@ module StockCruncher
     API_URL = 'https://www.alphavantage.co/query?'
 
     # Main method to crunch data.
-    def crunch_daily(symbol, opts)
-      url = API_URL + parameters(symbol, 'TIME_SERIES_DAILY') + options_d(opts)
+    def crunch_daily(symbol, fullsize)
+      url = API_URL + parameters(symbol, 'TIME_SERIES_DAILY')
+      url += '&datatype=csv&outputsize=' + (fullsize ? 'full' : 'compact')
       res = request(url)
-      puts res.body
+      res.body
     end
 
     # Main method to crunch data.
-    def crunch_quote(symbol, opts)
-      url = API_URL + parameters(symbol, 'GLOBAL_QUOTE') + options_q(opts)
+    def crunch_quote(symbol)
+      url = API_URL + parameters(symbol, 'GLOBAL_QUOTE')
+      url += '&datatype=csv'
       res = request(url)
-      puts res.body
-    end
-
-    def options_d(opts)
-      o = '&datatype=' + (opts['json'] ? 'json' : 'csv')
-      o += '&outputsize=' + (opts['full'] ? 'full' : 'compact')
-      o
-    end
-
-    def options_q(opts)
-      o = '&datatype=' + (opts['json'] ? 'json' : 'csv')
-      o
+      res.body
     end
 
     def parameters(symbol, serie)

data/lib/stockcruncher/cli.rb

@@ -2,18 +2,12 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'yaml'
 
 module StockCruncher
   # Simple CLI for StockCruncher
   class CLI < Thor
-    desc 'version', 'Print stockcruncher current version'
-    def version
-      puts "StockCruncher version #{StockCruncher::VERSION}"
-    end
-
-    desc('daily SYMBOL [options]',
-         'Crunch SYMBOL stock market data for daily time series.')
-    option(
+    class_option(
       :config,
       aliases: ['-c'],
       type: :string,
@@ -21,13 +15,28 @@ module StockCruncher
       desc: 'Yaml formatted config file to load ' \
             '(default to /etc/stockcruncher/stockcruncher.yml).'
     )
-    option(
-      :json,
-      aliases: ['-j'],
+    class_option(
+      :insecure,
+      aliases: ['-k'],
+      type: :boolean,
+      default: false,
+      desc: 'Ignore SSL certificate (default to false).'
+    )
+    class_option(
+      :quiet,
+      aliases: ['-q'],
       type: :boolean,
       default: false,
-      desc: 'Json format data (default to csv).'
+      desc: 'Run silently (default to false).'
     )
+
+    desc 'version', 'Print stockcruncher current version'
+    def version
+      puts "StockCruncher version #{StockCruncher::VERSION}"
+    end
+
+    desc('daily SYMBOL [options]',
+         'Crunch SYMBOL stock market data for daily time series.')
     option(
       :full,
       aliases: ['-f'],
@@ -37,31 +46,22 @@ module StockCruncher
     )
     def daily(symbol)
       opts = options.dup
-      cruncher = StockCruncher::AlphaVantage.new(opts['config'])
-      cruncher.crunch_daily(symbol, opts)
+      config = YAML.load_file(opts['config'])
+      cruncher = StockCruncher::AlphaVantage.new(config, opts['insecure'])
+      raw_data = cruncher.crunch_daily(symbol, opts['full'])
+      # TODO: export to DB here
+      puts raw_data unless opts['quiet']
     end
 
     desc('quote SYMBOL [options]',
          'Crunch SYMBOL stock market data for last day quote.')
-    option(
-      :config,
-      aliases: ['-c'],
-      type: :string,
-      default: '/etc/stockcruncher/stockcruncher.yml',
-      desc: 'Yaml formatted config file to load ' \
-            '(default to /etc/stockcruncher/stockcruncher.yml).'
-    )
-    option(
-      :json,
-      aliases: ['-j'],
-      type: :boolean,
-      default: false,
-      desc: 'Json format data (default to csv).'
-    )
     def quote(symbol)
       opts = options.dup
-      cruncher = StockCruncher::AlphaVantage.new(opts['config'])
-      cruncher.crunch_quote(symbol, opts)
+      config = YAML.load_file(opts['config'])
+      cruncher = StockCruncher::AlphaVantage.new(config, opts['insecure'])
+      raw_data = cruncher.crunch_quote(symbol)
+      puts raw_data unless opts['quiet']
+      StockCruncher::InfluxDB.new(config).export_last_day(raw_data)
     end
   end
 end

data/lib/stockcruncher/cruncher.rb

@@ -2,27 +2,22 @@
 # frozen_string_literal: true
 
 require 'net/http'
-require 'yaml'
 
 module StockCruncher
   # This is an data cruncher abstract class.
   class Cruncher
     # Class constructor method
-    def initialize(file)
-      @config = load_conf(file)
-    end
-
-    # Method to load configurations described in config_file.
-    def load_conf(file)
-      YAML.load_file(file)
+    def initialize(config, insecure = false)
+      @config = config
+      @insecure = insecure
     end
 
     # Method to send http get request
-    def request(url, insecure = false)
+    def request(url)
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme.eql?('https')
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if insecure
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @insecure
       req = Net::HTTP::Get.new(uri.request_uri)
       http.request(req)
     end

data/lib/stockcruncher/influxdb.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require 'net/http'
+
+module StockCruncher
+  # this is a class to write time series to database
+  class InfluxDB
+    # Class constructor method
+    def initialize(config, insecure = false)
+      @cfg = config[self.class.name.split('::').last]
+      @insecure = insecure
+    end
+
+    # Method to export latest data to database
+    def export_last_day(raw)
+      (desc, line) = raw.split("\r\n")
+      values = desc.split(',').zip(line.split(',')).to_h
+      values['close'] = values.delete('price')
+      values['changePercent'] = values['changePercent'].delete('%')
+      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(raw)
+      # TODO: export whole history and calculated missing values
+    end
+
+    # Method to format and array of values into comma separated string
+    def format_values(values)
+      string = ''
+      values.each_pair do |k, v|
+        string += "#{k}=#{v}"
+        string += ',' unless k == values.keys.last
+      end
+      string
+    end
+
+    # Method to send http post request
+    def request(url, body)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme.eql?('https')
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @insecure
+      req = Net::HTTP::Post.new(uri.request_uri)
+      req.basic_auth(@cfg['user'], @cfg['password'])
+      req.body = body
+      http.request(req)
+    end
+
+    # Method to write data in bucket
+    def write(name, tags, values, date)
+      url = "#{@cfg['scheme']}://#{@cfg['host']}:#{@cfg['port']}/write?" \
+            "db=#{@cfg['dbname']}"
+      timestamp = DateTime.parse(date + 'T18:00:00').strftime('%s%N')
+      body = "#{name},#{format_values(tags)} #{format_values(values)} " \
+             "#{timestamp}"
+      request(url, body)
+    end
+  end
+end

data/lib/stockcruncher/version.rb

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

data/spec/files/stockcruncher.yml

@@ -1,2 +1,9 @@
 AlphaVantage:
   apikey: demo
+InfluxDB:
+  scheme: http
+  host: localhost
+  port: 8086
+  user: testuser
+  password: testpassword
+  dbname: test

data/spec/stockcruncher/cli_spec.rb

@@ -2,6 +2,10 @@
 
 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"
+
 describe StockCruncher::CLI do
   context 'version' do
     it 'prints the version.' do
@@ -18,7 +22,7 @@ describe StockCruncher::CLI do
 
   context 'quote SYM -c spec/files/stockcruncher.yml' do
     it 'Get the quote for SYM.' do
-      expect { start(self) }.to output("{}\n").to_stdout
+      expect { start(self) }.to output(quote).to_stdout
     end
   end
 

data/spec/stockcruncher/stubs/servers_stubs.rb

@@ -2,15 +2,21 @@
 
 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"
+
 RSpec.configure do |config|
   config.before(:each) do
     # requests an API without extra arguments
     stub_request(:get, 'https://www.alphavantage.co/query?' \
       'function=GLOBAL_QUOTE&symbol=SYM&apikey=demo&datatype=csv')
-      .to_return('status' => 200, 'body' => '{}', 'headers' => {})
+      .to_return('status' => 200, 'body' => quote, 'headers' => {})
     stub_request(:get, 'https://www.alphavantage.co/query?' \
       'function=TIME_SERIES_DAILY&symbol=SYM&apikey=demo' \
       '&datatype=csv&outputsize=compact')
       .to_return('status' => 200, 'body' => '{}', 'headers' => {})
+    stub_request(:post, 'http://localhost:8086/write?db=test')
+      .to_return('status' => 204, 'body' => '', 'headers' => {})
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockcruncher
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Delaplace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,10 +130,10 @@ files:
 - lib/stockcruncher/alphavantage.rb
 - lib/stockcruncher/cli.rb
 - lib/stockcruncher/cruncher.rb
+- lib/stockcruncher/influxdb.rb
 - lib/stockcruncher/version.rb
 - spec/files/stockcruncher.yml
 - spec/spec_helper.rb
-- spec/stockcruncher/alphavantage_spec.rb
 - spec/stockcruncher/cli_spec.rb
 - spec/stockcruncher/stubs/servers_stubs.rb
 - spec/stockcruncher_spec.rb

data/spec/stockcruncher/alphavantage_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe StockCruncher::AlphaVantage do
-  context 'daily SYM -c spec/files/stockcruncher.yml' do
-    it 'requests a daily time serie.' do
-      expect { start(self) }.to output("{}\n").to_stdout
-    end
-  end
-  context 'quote SYM -c spec/files/stockcruncher.yml' do
-    it 'requests a quote endpoint.' do
-      expect { start(self) }.to output("{}\n").to_stdout
-    end
-  end
-end