accern 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7c204397deb420cd177d017a494a87cd0760267
-  data.tar.gz: 9295d9b66d5228f0a4655492868cb648b21a4264
+  metadata.gz: d98bb97d1e447d5ab00d4543d233a81c79320976
+  data.tar.gz: dbb9c2da127d6da30b59406b1cee447be57c5767
 SHA512:
-  metadata.gz: 5b7b7a02503dd010f9138faccfd89b7de6b4a558f86c384c12c6e1dd76bbd82e08fb837824a4b6c4dac709105702b3dd885609d4eab39b1ae7e9868f96ccd0c3
-  data.tar.gz: 26194881673928fa452e03f8b36d7659869f32a790e683432612c22c0af817b6fb66bcfe20c1c7f06f6d22677360fdea187bd3b39da3ab999f803a8870ec68e2
+  metadata.gz: 9ae51b0a920b3fd85d90ac62226055232daa7598dbe19292670e39206356ff519788cccdc1c6dee2d1e56879ef3381f7093450e548153d6dfb25496a0c7fad33
+  data.tar.gz: f8a5b856fe9aaa653c46022646697d9a8ab40a603b853f5fdbc6535996a0f04abf9698776371b59d4d647d395134341259985a406c9b8f738e9655db4808785a

data/.gitignore

@@ -12,3 +12,5 @@
 # rspec failure tracking
 .rspec_status
 test_home
+alpha_last_id.yml
+feed.jsonl

data/README.md

@@ -7,7 +7,11 @@ A command line interface for the Accern API. Which is used for streaming the rea
 ## Installation
 
 ```shell
-gem install accern
+# default macOS Ruby
+$ sudo gem install accern
+
+# When using a Ruby version manager
+$ gem install accern
 ```
 
 ## Usage
@@ -26,7 +30,62 @@ The the next time you run `accern` the client will begin streaming the full data
 To reset and bring up the getting started prompts run:
 
 ```shell
-accern --init
+$ accern --init
+```
+
+### Filter by ticker
+
+```shell
+# single ticker
+$ accern --ticker appl
+
+# multiple tickers
+$ accern --ticker "appl,amzn"
+```
+
+### Filter by ticker file
+Create a newline delimited ticker file:
+
+```
+appl
+amzn
+```
+
+```shell
+$ accern --ticker-file ./my_tickers.txt
+```
+
+### Filter by index
+
+The index value must be one of the following values
+
+index					 | expected value
+-----------------|----------------------
+S&P 500				| sp500
+Russell 1000		| russell1000
+Russell 3000		| russell3000
+Wilshire 5000		| wilshire5000
+Barron's 400		| barrons400
+DOW 30				| dow30
+
+```shell
+# single index
+$ accern --index sp500
+
+# multiple indexes
+$ accern --index "dow30,russell1000"
+```
+
+### Filter by index file
+Create a newline delimited index file with the any of the allowed values:
+
+```
+dow30
+sp500
+```
+
+```shell
+$ accern --index-file ./my_indexes.txt
 ```
 
 ## Contributing

data/accern.gemspec

@@ -6,7 +6,7 @@ require 'accern/version'
 Gem::Specification.new do |spec|
   spec.name          = 'accern'
   spec.version       = Accern::VERSION
-  spec.authors       = ['Carlos Espejo']
+  spec.authors       = ['Carlos Espejo', 'Kerry Imai']
   spec.email         = ['vendors@accern.com']
   spec.summary       = 'A command line interface for the Accern API.'
   spec.homepage      = 'https://github.com/Accern/accern'

data/bin/console

@@ -12,14 +12,14 @@ require 'pry'
 # require "irb"
 # IRB.start(__FILE__)
 
-# args = ['-h']
-# args = []
 
-args = {token: "0652400596ecf80e014176dd4bc17044",
- format: :json}
 
- a = Accern::Alpha.new(args)
 
-# c = Accern::Cli.new(args)
 
+ticker = "amzn,aapl"
+# ["--ticker", "aapp,amaz,lol"]
+# token: '08b14780c4b4aae5ac97d92c33d25495',
+args = {format: :json, index: "sp500"}
+c = Accern::Cli.new( args: ["--index", "sp500,barrons400"])
 binding.pry
+# ticker=amzn&

data/lib/accern/alpha.rb

@@ -1,10 +1,12 @@
 module Accern
   class Alpha
     attr_reader :token, :base_url, :uri, :last_id, :new_id, :docs,
-                :format, :flat, :params
+                :format, :flat, :params, :ticker, :index
 
-    def initialize(token:, format: :json, params: {})
+    def initialize(token:, ticker:, index:, format: :json)
       @token = token
+      @ticker = ticker
+      @index = index
       @format = format
       @params = params
       @base_url = 'http://feed.accern.com/v3/alphas'
@@ -14,9 +16,7 @@ module Accern
     end
 
     def download(path)
-      uri.query = URI.encode_www_form(last_id: last_id) if last_id
-      puts uri
-
+      create_uri
       format_response(
         Net::HTTP.new(uri.host, uri.port).request_get(uri, header)
       )
@@ -42,15 +42,29 @@ module Accern
       puts e.backtrace
     end
 
-    def download_loop(path)
+    def download_loop(path:)
       loop do
         download(path)
         sleep 8
       end
     end
 
+
+    def create_uri
+      uri.query = URI.encode_www_form(combine_query)
+      puts uri
+    end
+
     private
 
+    def combine_query
+      filters = Hash.new
+      filters[:ticker] = ticker unless ticker.empty?
+      filters[:last_id] = last_id if last_id
+      filters[:index] = index unless index.empty?
+      filters
+    end
+
     def header
       { 'Authorization' => %(Token token="#{token}"),  'User-Agent' => "Accern #{VERSION} (#{RUBY_PLATFORM})" }
     end

data/lib/accern/cli.rb

@@ -1,7 +1,8 @@
 module Accern
   class Cli
     attr_reader :stdout, :stdin, :token, :filetype, :valid_types, :config_path,
-                :options, :args, :feed
+                :options, :args, :feed, :tickers,:indexes
+
 
     def initialize(stdout: $stdout, stdin: $stdin, args: [], feed: Alpha)
       @stdout = stdout
@@ -12,6 +13,8 @@ module Accern
       @valid_types = %w(json csv)
       @config_path = "#{ENV['HOME']}/.accern.rc.yml"
       @feed = feed
+      @tickers = []
+      @indexes = []
     end
 
     def start
@@ -21,8 +24,8 @@ module Accern
       if options[:init]
         ask_for_info
       else
-        feed.new(token: token, format: filetype.to_sym)
-            .download_loop('./feed.jsonl')
+        feed.new(token: token, format: filetype.to_sym, ticker: tickers.join(','), index: indexes.join(','))
+            .download_loop(path: './feed.jsonl')
       end
     end
 
@@ -58,13 +61,45 @@ module Accern
           puts Accern::VERSION
           exit
         end
+
+        opts.on("--ticker NAME", "Filters document by ticker") do |tic|
+
+          options[:ticker] = tic.to_s.downcase.split(',')
+          @tickers += options[:ticker]
+        end
+
+        opts.on("--ticker-file PATH", "Receives the path to a file that has tickers") do |t_path|
+          options[:ticker_path] = t_path
+          @tickers += read_file(t_path)
+        end
+
+        index_options = ['sp500', 'russell1000', 'russell3000', 'wilshire5000', 'barrons400', 'dow30']
+        opts.on("--index TYPE", "Filters document by index") do |i|
+          options[:index] = i.to_s.downcase.split(',')
+          options[:index] = sanitizes_input(options[:index])
+          raise OptionParser::InvalidArgument.new("Invalid index options") unless (options[:index] - index_options).empty?
+          @indexes += options[:index]
+        end
+
+        opts.on("--index-file PATH", "get filter indexes from file") do |i_path|
+          parsed = read_file(i_path)
+          parsed = sanitizes_input(parsed)
+          raise OptionParser::InvalidArgument.new("Invalid index options") unless (parsed - index_options).empty?
+          @indexes += parsed
+        end
+
       end
 
       parser.parse!(args)
+      @tickers = sanitizes_input(@tickers)
     end
 
     private
 
+    def sanitizes_input(arg)
+       arg.map {|t| t.gsub(/\W/, '')}
+    end
+
     def ask_for_info
       ask_for_token
       # ask_for_filetype
@@ -93,5 +128,10 @@ module Accern
       File.write(config_path, config.to_yaml)
       stdout.puts 'Your client is now configured and settings saved to ~/.accern.rc.yml.'
     end
+
+    def read_file(path)
+      return [] unless File.exist?(path)
+      File.readlines(path).map { |x| x.downcase.chomp }
+    end
   end
 end

data/lib/accern/version.rb

@@ -1,3 +1,3 @@
 module Accern
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.2.0'.freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: accern
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Carlos Espejo
+- Kerry Imai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler