intrinio 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d0685eb48926073584dcdce2b696f9ff9e16cff
-  data.tar.gz: 92d8f5b8c2dd0cddea07f789c82e09933287876f
+  metadata.gz: 1445cecea92901fa631ab950788949e4ffb8472e
+  data.tar.gz: a984c027e44ba371c037e9bf9f595c5b8b260787
 SHA512:
-  metadata.gz: 5940954864a1e0fd987dbc6c119a8804023d5a3b0cac93f75ee3f752c2b3bb65d138bd070a1249b97801cf71c4e236c5e22c3c63c0efd65b4e7a7aa422ab116e
-  data.tar.gz: 74e9ee1c8d6a5f16ff78495f89c063d2b503fd04acfaa5dbd5c38245fa2602df5bc24822b7af33dd54d231e4670b08f687a0a5ef9cb714329c56bf260e419de1
+  metadata.gz: f45beb9d024f240d330a8b39b3e18dc33378d97865ff75980bfbf149ea43c2942dd185fbd89a7ee61a298b1f5e51aa9d14943021b9ca4b05b192aa98bd23e7a2
+  data.tar.gz: 3e5af5e586f14760f6c10b2ab79105af113cef36fcc1209bcb9771dbb4ab88e7fb9439debb1c16d20d51b2af9aa29061adc4adaf68330a3bc1113c74a6cb4d47

data/README.md

@@ -47,6 +47,7 @@ First, require and initialize with your username and password.
 ```ruby
 require 'intrinio'
 intrinio = Intrinio::API.new username: 'me', password: 'secret'
+# or: Intrinio::API.new auth: 'me:secret'
 ```
 
 Now, you can access any Intrinio endpoint with any optional parameter, like
@@ -63,6 +64,13 @@ a method name, like this:
 result = intrinio.indices type: 'economic', page_size: 5
 ```
 
+In other words, these calls are the same:
+
+```ruby
+intrinio.get 'endpoint', param: value
+intrinio.endpoint, param: value
+```
+
 By default, you will get a ruby hash in return. If you wish to get the raw
 output, you can use the `get!` method:
 
@@ -115,11 +123,11 @@ Intrinio authentication, simply set it in the environment variables
 
 These commands are available:
 
-`$ intrinio get PATH [PARAMS...]` - print the output.  
+`$ intrinio get [--csv] PATH [PARAMS...]` - print the output.  
 `$ intrinio pretty PATH [PARAMS...]` - print a pretty JSON.  
 `$ intrinio see PATH [PARAMS...]` - print a colored output.  
 `$ intrinio url PATH [PARAMS...]` - show the constructed URL.  
-`$ intrinio save FILE PATH [PARAMS...]` - save the output to a file.  
+`$ intrinio save [--csv] FILE PATH [PARAMS...]` - save the output to a file.  
 
 Run `intrinio --help` for more information, or view the [full usage help][2].
 
@@ -133,7 +141,7 @@ $ intrinio see indices page_size:5
 $ intrinio see indices "query:interest rate" page_size:5
 
 # Saves a file
-$ intrinio save aapl.json historical_data identifier:AAPL \
+$ intrinio save --csv aapl.csv historical_data identifier:AAPL \
     item:adj_close_price frequency:monthly page_size:10
 
 # Shows the URL that Intrinio has constructed, good for debugging

data/lib/intrinio/command_line.rb

@@ -1,126 +1,130 @@
-require 'singleton'
-require 'docopt'
-require 'json'
-require 'awesome_print'
-
-module Intrinio
-
-  # Handles the command line interface
-  class CommandLine
-    include Singleton
-
-    # Gets an array of arguments (e.g. ARGV), executes the command if valid
-    # and shows usage patterns / help otherwise.
-    def execute(argv=[])
-      doc = File.read File.dirname(__FILE__) + '/docopt.txt'
-      begin
-        args = Docopt::docopt(doc, argv: argv, version: VERSION)
-        handle args
-      rescue Docopt::Exit => e
-        puts e.message
-      end
-    end
-
-    def intrinio
-      @intrinio ||= intrinio!
-    end
-
-    private
-
-    attr_reader :csv
-
-    def intrinio!
-      Intrinio::API.new options
-    end
-
-    # Called when the arguments match one of the usage patterns. Will 
-    # delegate action to other, more specialized methods.
-    def handle(args)
-      path   = args['PATH']
-      params = args['PARAMS']
-      file   = args['FILE']
-      @csv   = args['--csv']
-      
-      return get(path, params)        if args['get']
-      return pretty(path, params)     if args['pretty']
-      return see(path, params)        if args['see']
-      return url(path, params)        if args['url']
-      return save(file, path, params) if args['save']
-    end
-
-    def get(path, params)
-      if csv
-        puts intrinio.get_csv path, translate_params(params)
-      else
-        puts intrinio.get! path, translate_params(params)
-      end
-    end
-
-    def save(file, path, params)
-      if csv
-        success = intrinio.save_csv file, path, translate_params(params)
-      else
-        success = intrinio.save file, path, translate_params(params)
-      end
-      puts success ? "Saved #{file}" : "Saving failed"
-    end
-
-    def pretty(path, params)
-      response = intrinio.get path, translate_params(params)
-      puts JSON.pretty_generate response
-    end
-
-    def see(path, params)
-      ap intrinio.get path, translate_params(params)
-    end
-
-    def url(path, params)
-      intrinio.debug = true
-      puts intrinio.get path, translate_params(params)
-      intrinio.debug = false
-    end
-
-    # Convert a params array like [key:value, key:value] to a hash like
-    # {key: value, key: value}
-    def translate_params(params)
-      return nil if params.empty?
-      result = {}
-      params.each do |param|
-        key, value = param.split ':'
-        result[key] = value
-      end
-      result
-    end
-
-    def options
-      result = { username: username, password: password }
-      return result unless cache_dir || cache_life
-      
-      result[:use_cache] = true
-      result[:cache_dir] = cache_dir if cache_dir
-      result[:cache_life] = cache_life.to_i if cache_life
-      result
-    end
-
-    def username
-      @username ||= intrinio_auth.split(':').first
-    end
-
-    def password
-      @password ||= intrinio_auth.split(':').last
-    end
-
-    def intrinio_auth
-      ENV['INTRINIO_AUTH'] || ''
-    end
-
-    def cache_dir
-      ENV['INTRINIO_CACHE_DIR']
-    end
-
-    def cache_life
-      ENV['INTRINIO_CACHE_LIFE']
-    end
-
-  end
-end
+require 'singleton'
+require 'docopt'
+require 'json'
+require 'awesome_print'
+
+module Intrinio
+
+  # Handles the command line interface
+  class CommandLine
+    include Singleton
+
+    # Gets an array of arguments (e.g. ARGV), executes the command if valid
+    # and shows usage patterns / help otherwise.
+    def execute(argv=[])
+      doc = File.read File.dirname(__FILE__) + '/docopt.txt'
+      begin
+        args = Docopt::docopt(doc, argv: argv, version: VERSION)
+        handle args
+      rescue Docopt::Exit, Intrinio::MissingAuth => e
+        puts e.message
+      end
+    end
+
+    def intrinio
+      @intrinio ||= intrinio!
+    end
+
+    private
+
+    attr_reader :path, :params, :file, :csv
+
+    def intrinio!
+      Intrinio::API.new options
+    end
+
+    # Called when the arguments match one of the usage patterns. Will 
+    # delegate action to other, more specialized methods.
+    def handle(args)
+      @path   = args['PATH']
+      @params = translate_params args['PARAMS']
+      @file   = args['FILE']
+      @csv    = args['--csv']
+
+      if intrinio_auth.empty?
+        raise Intrinio::MissingAuth, "Missing Authentication\nPlease set INTRINIO_AUTH=username:password"
+      end
+      
+      return get    if args['get']
+      return pretty if args['pretty']
+      return see    if args['see']
+      return url    if args['url']
+      return save   if args['save']
+    end
+
+    def get
+      if csv
+        puts intrinio.get_csv path, params
+      else
+        puts intrinio.get! path, params
+      end
+    end
+
+    def save
+      if csv
+        success = intrinio.save_csv file, path, params
+      else
+        success = intrinio.save file, path, params
+      end
+      puts success ? "Saved #{file}" : "Saving failed"
+    end
+
+    def pretty
+      response = intrinio.get path, params
+      puts JSON.pretty_generate response
+    end
+
+    def see
+      ap intrinio.get path, params
+    end
+
+    def url
+      intrinio.debug = true
+      puts intrinio.get path, params
+      intrinio.debug = false
+    end
+
+    # Convert a params array like [key:value, key:value] to a hash like
+    # {key: value, key: value}
+    def translate_params(pairs)
+      return nil if pairs.empty?
+      result = {}
+      pairs.each do |pair|
+        key, value = pair.split ':'
+        result[key] = value
+      end
+      result
+    end
+
+    def options
+      result = { username: username, password: password }
+      return result unless cache_dir || cache_life
+      
+      result[:use_cache] = true
+      result[:cache_dir] = cache_dir if cache_dir
+      result[:cache_life] = cache_life.to_i if cache_life
+      result
+    end
+
+    def username
+      @username ||= intrinio_auth.split(':').first
+    end
+
+    def password
+      @password ||= intrinio_auth.split(':').last
+    end
+
+    def intrinio_auth
+      ENV['INTRINIO_AUTH'] || ''
+    end
+
+    def cache_dir
+      ENV['INTRINIO_CACHE_DIR']
+    end
+
+    def cache_life
+      ENV['INTRINIO_CACHE_LIFE']
+    end
+
+  end
+end

data/lib/intrinio/docopt.txt

@@ -1,64 +1,77 @@
-Intrinio
-
-Usage:
-  intrinio get [--csv] PATH [PARAMS...]
-  intrinio pretty PATH [PARAMS...]
-  intrinio see PATH [PARAMS...]
-  intrinio url PATH [PARAMS...]
-  intrinio save [--csv] FILE PATH [PARAMS...]
-  intrinio (-h|--help|--version)
-
-Commands:
-  get
-    Downloads data and prints it to screen as it. 
-  
-  pretty
-    Downloads data and prints it as a prettified JSON output.
-
-  see
-    Downloads data and awesome-prints it.
-
-  url
-    Shows the URL constructed from the request.
-
-  save
-    Downloads data and saves it to a file.
-
-Parameters:
-  PATH:
-    This is the Intrinio API path, without the query string.
-    For example: `indices` or `historical_data`.
-
-  PARAMS:
-    An optional list of query string parameters, separated by a space, to 
-    send with the request. Each parameter should be in the format of 
-    key:value, for example: page:2 per_page:10
-
-  FILE:
-    Path to the output file.
-
-Flags:
-  --csv
-    When this flag is provided, the data will be converted to CSV before
-    it is displayed or saved. Note that this works only with endpoints that
-    have a 'data' attribute.
-
-Examples:
-  intrinio see indices page_size:5
-
-  intrinio pretty indices "query:interest rate" page_size:5
-
-  intrinio see companies identifier:AAPL
-
-  intrinio see historical_data identifier:\$INTDSRUSM193N item:level \
-    start_date:2015-01-01
-
-  intrinio see historical_data identifier:\$SP500 item:percent_change \
-    frequency:monthly page_size:10
-
-  intrinio save aapl.json historical_data identifier:AAPL \
-    item:adj_close_price frequency:monthly page_size:10
-
-  intrinio get --csv indices page_size:5
-  
-  intrinio save --csv indices.csv indices page_size:5
+Intrinio
+
+Usage:
+  intrinio get [--csv] PATH [PARAMS...]
+  intrinio pretty PATH [PARAMS...]
+  intrinio see PATH [PARAMS...]
+  intrinio url PATH [PARAMS...]
+  intrinio save [--csv] FILE PATH [PARAMS...]
+  intrinio (-h|--help|--version)
+
+Commands:
+  get
+    Downloads data and prints it to screen as it. 
+  
+  pretty
+    Downloads data and prints it as a prettified JSON output.
+
+  see
+    Downloads data and awesome-prints it.
+
+  url
+    Shows the URL constructed from the request.
+
+  save
+    Downloads data and saves it to a file.
+
+Parameters:
+  PATH:
+    This is the Intrinio API path, without the query string.
+    For example: `indices` or `historical_data`.
+
+  PARAMS:
+    An optional list of query string parameters, separated by a space, to 
+    send with the request. Each parameter should be in the format of 
+    key:value, for example: page:2 per_page:10
+
+  FILE:
+    Path to the output file.
+
+Flags:
+  --csv
+    When this flag is provided, the data will be converted to CSV before
+    it is displayed or saved. Note that this works only with endpoints that
+    have a 'data' attribute.
+
+Environment Variables:
+  INTRINIO_AUTH=username:password
+    Set Intrinio username and password. This variable is required.
+
+  INTRINIO_CACHE_LIFE=360
+    Set the number of seconds to consider the cache fresh. This variable
+    it optional.
+
+  INTRINIO_CACHE_DIR=./cache
+    Set the cache directory. This variable is optional.
+    If both INTRINIO_CACHE_DIR and INTRINIO_CACHE_LIFE are not set, requests
+    will not be cached.
+
+Examples:
+  intrinio see indices page_size:5
+
+  intrinio pretty indices "query:interest rate" page_size:5
+
+  intrinio see companies identifier:AAPL
+
+  intrinio see historical_data identifier:\$INTDSRUSM193N item:level \
+    start_date:2015-01-01
+
+  intrinio see historical_data identifier:\$SP500 item:percent_change \
+    frequency:monthly page_size:10
+
+  intrinio save aapl.json historical_data identifier:AAPL \
+    item:adj_close_price frequency:monthly page_size:10
+
+  intrinio get --csv indices page_size:5
+  
+  intrinio save --csv indices.csv indices page_size:5

data/lib/intrinio/exceptions.rb

@@ -1,4 +1,5 @@
-module Intrinio
-  class BadResponse < StandardError; end
-  class IncompatibleResponse < StandardError; end
+module Intrinio
+  class BadResponse < StandardError; end
+  class IncompatibleResponse < StandardError; end
+  class MissingAuth < StandardError; end
 end

data/lib/intrinio/version.rb

@@ -1,3 +1,3 @@
 module Intrinio
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intrinio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt