intrinio 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55d5ef7008a5e1984530c0b3f2b47fa58453505c
-  data.tar.gz: 1a4a941a3b2218fb3f20e2193ecca822bc0717cd
+  metadata.gz: 4d0685eb48926073584dcdce2b696f9ff9e16cff
+  data.tar.gz: 92d8f5b8c2dd0cddea07f789c82e09933287876f
 SHA512:
-  metadata.gz: cbe11b914de9f015cf022bf076e0cce9de9a8cf1681c860be35981af8c978c6e8577fb1d72d995e6d9523edc883b0a2d732366bd951b226f77e5a8d2141bd3bb
-  data.tar.gz: 15e067f9bafbaedf8c51cb2c0b1f27e53574dfadadbd9f5219fe50eaf3f99b0b47966a04cd1380894201ea534cfdb43525e4af17a03bafb58c5b6898957a9e90
+  metadata.gz: 5940954864a1e0fd987dbc6c119a8804023d5a3b0cac93f75ee3f752c2b3bb65d138bd070a1249b97801cf71c4e236c5e22c3c63c0efd65b4e7a7aa422ab116e
+  data.tar.gz: 74e9ee1c8d6a5f16ff78495f89c063d2b503fd04acfaa5dbd5c38245fa2602df5bc24822b7af33dd54d231e4670b08f687a0a5ef9cb714329c56bf260e419de1

data/README.md

@@ -13,6 +13,7 @@ This gem provides both a Ruby library and a command line interface for the
 
 ---
 
+
 Install
 --------------------------------------------------
 
@@ -26,16 +27,18 @@ Or with bundler:
 gem 'intrinio'
 ```
 
+
 Features
 --------------------------------------------------
 
 * Easy to use interface.
 * Use as a library or through the command line.
-* Access any Intrinio endpoint directly.
-* Display output in various formats.
-* Save output to a file.
+* Access any Intrinio endpoint and option directly.
+* Display output as JSON or CSV.
+* Save output to a file as JSON or CSV.
 * Includes a built in file cache (disabled by default).
 
+
 Usage
 --------------------------------------------------
 
@@ -68,12 +71,26 @@ result = intrinio.get! "indices", type: 'economic', page_size: 5
 # => JSON string
 ```
 
+When calling any endpoint that returns a `data` attribute, you can also
+call `get_csv` in order to convert the data to a CSV string.
+
+```ruby
+result = intrinio.get_csv "indices", page_size: 5
+# => CSV string
+```
+
 To save the output directly to a file, use the `save` method:
 
 ```ruby
 intrinio.save "filename.json", "indices", type: 'economic', page_size: 5
 ```
 
+Or, to save CSV, use the `save_csv` method:
+
+```ruby
+intrinio.save_csv "filename.csv" "indices", page_size: 5
+```
+
 Debugging your request and adding "sticky" query parameters that stay with
 you for the following requests is also easy:
 
@@ -86,6 +103,7 @@ puts intrinio.historical_data identifier: '$INTDSRUSM193N', item: 'level'
 intrinio.param page_size: nil # remove param
 ```
 
+
 Command Line
 --------------------------------------------------
 
@@ -105,6 +123,26 @@ These commands are available:
 
 Run `intrinio --help` for more information, or view the [full usage help][2].
 
+Examples:
+
+```bash
+# Shows the first 5 indices
+$ intrinio see indices page_size:5
+
+# Pass arguments that require spaces
+$ intrinio see indices "query:interest rate" page_size:5
+
+# Saves a file
+$ intrinio save aapl.json historical_data identifier:AAPL \
+    item:adj_close_price frequency:monthly page_size:10
+
+# Shows the URL that Intrinio has constructed, good for debugging
+$ intrinio url indices query:interest page_size:5
+# => https://api.intrinio.com/indices?query=interest&page_size=5
+
+```
+
+
 Caching
 --------------------------------------------------
 

data/lib/intrinio.rb

@@ -1,4 +1,5 @@
 require 'intrinio/version'
+require 'intrinio/exceptions'
 require 'intrinio/web_api'
 require 'intrinio/api'
 require 'intrinio/command_line'

data/lib/intrinio/api.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'csv'
 
 module Intrinio
   # Provides access to all the Intrinio API endpoints
@@ -6,6 +7,11 @@ module Intrinio
     attr_reader :opts
 
     def initialize(opts={})
+      if opts[:auth] 
+        opts[:username], opts[:password] = opts[:auth].split ':'
+        opts.delete :auth
+      end
+
       defaults = {
         username: nil,
         password: nil,
@@ -35,5 +41,27 @@ module Intrinio
       
       super opts[:base_url]
     end
+
+    def get_csv(*args)
+      result = get *args
+      
+      raise Intrinio::BadResponse, "Result is not a hash" unless result.is_a? Hash
+      raise Intrinio::IncompatibleResponse, "Result does not contain a data attribute" unless result.has_key? :data
+      
+      data = result[:data]
+
+      header = data.first.keys
+      result = CSV.generate do |csv|
+        csv << header
+        data.each { |row| csv << row.values }
+      end
+
+      result
+    end
+
+    def save_csv(file, *args)
+      data = get_csv *args
+      File.write file, data
+    end
   end
 end

data/lib/intrinio/command_line.rb

@@ -27,6 +27,8 @@ module Intrinio
 
     private
 
+    attr_reader :csv
+
     def intrinio!
       Intrinio::API.new options
     end
@@ -37,6 +39,7 @@ module Intrinio
       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']
@@ -46,16 +49,23 @@ module Intrinio
     end
 
     def get(path, params)
-      puts intrinio.get! path, translate_params(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)
-      success = intrinio.save file, path, translate_params(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)
-      intrinio.format = :json
       response = intrinio.get path, translate_params(params)
       puts JSON.pretty_generate response
     end

data/lib/intrinio/docopt.txt

@@ -1,11 +1,11 @@
 Intrinio
 
 Usage:
-  intrinio get PATH [PARAMS...]
+  intrinio get [--csv] PATH [PARAMS...]
   intrinio pretty PATH [PARAMS...]
   intrinio see PATH [PARAMS...]
   intrinio url PATH [PARAMS...]
-  intrinio save FILE PATH [PARAMS...]
+  intrinio save [--csv] FILE PATH [PARAMS...]
   intrinio (-h|--help|--version)
 
 Commands:
@@ -36,3 +36,29 @@ Parameters:
 
   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

data/lib/intrinio/exceptions.rb

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

data/lib/intrinio/version.rb

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

data/lib/intrinio/web_api.rb

@@ -16,7 +16,7 @@ module Intrinio
 
     # Allow using any method as the first segment of the path
     # object.user 'details' becomes object.get 'user/details'
-    def method_missing(method_sym, *arguments, &block)
+    def method_missing(method_sym, *arguments, &_block)
       get "/#{method_sym}", *arguments
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intrinio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-29 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,7 @@ files:
 - lib/intrinio/api.rb
 - lib/intrinio/command_line.rb
 - lib/intrinio/docopt.txt
+- lib/intrinio/exceptions.rb
 - lib/intrinio/version.rb
 - lib/intrinio/web_api.rb
 homepage: https://github.com/DannyBen/intrinio