intrinio 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55d5ef7008a5e1984530c0b3f2b47fa58453505c
+  data.tar.gz: 1a4a941a3b2218fb3f20e2193ecca822bc0717cd
+SHA512:
+  metadata.gz: cbe11b914de9f015cf022bf076e0cce9de9a8cf1681c860be35981af8c978c6e8577fb1d72d995e6d9523edc883b0a2d732366bd951b226f77e5a8d2141bd3bb
+  data.tar.gz: 15e067f9bafbaedf8c51cb2c0b1f27e53574dfadadbd9f5219fe50eaf3f99b0b47966a04cd1380894201ea534cfdb43525e4af17a03bafb58c5b6898957a9e90

data/README.md

@@ -0,0 +1,149 @@
+Intrinio API Library and Command Line
+==================================================
+
+[![Gem](https://img.shields.io/gem/v/intrinio.svg?style=flat-square)](https://rubygems.org/gems/intrinio)
+[![Travis](https://img.shields.io/travis/DannyBen/intrinio.svg?style=flat-square)](https://travis-ci.org/DannyBen/intrinio)
+[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/intrinio.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/intrinio)
+[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/intrinio.svg?style=flat-square)](https://gemnasium.com/DannyBen/intrinio)
+
+---
+
+This gem provides both a Ruby library and a command line interface for the 
+[Intrinio][1] data service.
+
+---
+
+Install
+--------------------------------------------------
+
+```
+$ gem install intrinio
+```
+
+Or with bundler:
+
+```ruby
+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.
+* Includes a built in file cache (disabled by default).
+
+Usage
+--------------------------------------------------
+
+First, require and initialize with your username and password.
+
+```ruby
+require 'intrinio'
+intrinio = Intrinio::API.new username: 'me', password: 'secret'
+```
+
+Now, you can access any Intrinio endpoint with any optional parameter, like
+this:
+
+```ruby
+result = intrinio.get "indices", type: 'economic', page_size: 5
+```
+
+In addition, for convenience, you can use the first part of the endpoint as
+a method name, like this:
+
+```ruby
+result = intrinio.indices type: 'economic', page_size: 5
+```
+
+By default, you will get a ruby hash in return. If you wish to get the raw
+output, you can use the `get!` method:
+
+```ruby
+result = intrinio.get! "indices", type: 'economic', page_size: 5 
+# => JSON string
+```
+
+To save the output directly to a file, use the `save` method:
+
+```ruby
+intrinio.save "filename.json", "indices", type: 'economic', page_size: 5
+```
+
+Debugging your request and adding "sticky" query parameters that stay with
+you for the following requests is also easy:
+
+```ruby
+intrinio.debug = true
+intrinio.param page_size: 10, order_direction: 'asc'
+puts intrinio.historical_data identifier: '$INTDSRUSM193N', item: 'level'
+# => "https://api.intrinio.com/historical_data?page_size=10&order_direction=asc&identifier=%24INTDSRUSM193N&item=level
+
+intrinio.param page_size: nil # remove param
+```
+
+Command Line
+--------------------------------------------------
+
+The command line utility `intrinio` acts in a similar way. To use your 
+Intrinio authentication, simply set it in the environment variables 
+`INTRINIO_AUTH`:
+
+`$ export INTRINIO_AUTH=username:password`
+
+These commands are available:
+
+`$ intrinio get 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.  
+
+Run `intrinio --help` for more information, or view the [full usage help][2].
+
+Caching
+--------------------------------------------------
+
+We are using the [WebCache][3] gem for automatic HTTP caching.
+To take the path of least surprises, caching is disabled by default.
+
+You can enable and customize it by either passing options on 
+initialization, or by accessing the `WebCache` object directly at 
+a later stage.
+
+```ruby
+intrinio = Intrinio::API.new username: user, password: pass, 
+  use_cache: true
+
+intrinio = Intrinio::API.new username: user, password: pass, 
+  use_cache: true, cache_dir: 'tmp'
+
+intrinio = Intrinio::API.new username: user, password: pass, 
+  use_cache: true, cache_life: 120
+
+# or 
+
+intrinio = Intrinio::API.new username: user, password: pass
+intrinio.cache.enable
+intrinio.cache.dir = 'tmp/cache'   # Change cache folder
+intrinio.cache.life = 120          # Change cache life to 2 minutes
+```
+
+To enable caching for the command line, simply set one or both of 
+these environment variables:
+
+```
+$ export INTRINIO_CACHE_DIR=cache   # default: 'cache'
+$ export INTRINIO_CACHE_LIFE=120    # default: 3600 (1 hour)
+$ intrinio get indices
+# => This call will be cached
+```
+
+
+[1]: https://www.intrinio.com
+[2]: https://github.com/DannyBen/intrinio/blob/master/lib/intrinio/docopt.txt
+[3]: https://github.com/DannyBen/webcache

data/bin/intrinio

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'intrinio'
+Intrinio::CommandLine.instance.execute ARGV

data/lib/intrinio.rb

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

data/lib/intrinio/api.rb

@@ -0,0 +1,39 @@
+require 'json'
+
+module Intrinio
+  # Provides access to all the Intrinio API endpoints
+  class API < WebAPI
+    attr_reader :opts
+
+    def initialize(opts={})
+      defaults = {
+        username: nil,
+        password: nil,
+        use_cache: false,
+        cache_dir: nil,
+        cache_life: nil,
+        base_url: "https://api.intrinio.com"
+      }
+
+      opts = defaults.merge! opts
+      @opts = opts
+
+      username, password = opts[:username], opts[:password]
+
+      cache.disable unless opts[:use_cache]
+      cache.dir = opts[:cache_dir] if opts[:cache_dir]
+      cache.life = opts[:cache_life] if opts[:cache_life]
+      cache.options[:http_basic_authentication] = [username, password]
+
+      after_request do |response| 
+        begin
+          JSON.parse response, symbolize_names: true
+        rescue JSON::ParserError
+          response
+        end
+      end
+      
+      super opts[:base_url]
+    end
+  end
+end

data/lib/intrinio/command_line.rb

@@ -0,0 +1,116 @@
+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
+
+    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']
+      
+      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)
+      puts intrinio.get! path, translate_params(params)
+    end
+
+    def save(file, path, params)
+      success = intrinio.save file, path, translate_params(params)
+      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
+
+    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

data/lib/intrinio/docopt.txt

@@ -0,0 +1,38 @@
+Intrinio
+
+Usage:
+  intrinio get PATH [PARAMS...]
+  intrinio pretty PATH [PARAMS...]
+  intrinio see PATH [PARAMS...]
+  intrinio url PATH [PARAMS...]
+  intrinio save 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.

data/lib/intrinio/version.rb

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

data/lib/intrinio/web_api.rb

@@ -0,0 +1,93 @@
+require 'uri'
+require 'open-uri'
+require 'webcache'
+
+module Intrinio
+
+  # A general purpose HTTP wrapper. This is poor man's HTTParty with
+  # dynamic methods.
+  class WebAPI
+    attr_reader :base_url, :after_request_block, :last_error
+    attr_accessor :debug, :format
+
+    def initialize(base_url)
+      @base_url = base_url
+    end
+
+    # 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)
+      get "/#{method_sym}", *arguments
+    end
+
+    # Add one or more parameter to the default query string. Good for 
+    # adding keys that are always needed, like API keys.
+    def param(params)
+      params.each do |key, value|
+        default_params[key] = value
+        default_params.delete key if value.nil?
+      end
+    end
+
+    def cache
+      @cache ||= WebCache.new
+    end
+
+    # Set a block to be executed after the request. This is called only when
+    # using `get` and not when using `get!`. Good for JSON decoding, for 
+    # example.
+    def after_request(&block)
+      @after_request_block = block
+    end
+
+    # Return the response from the API. 
+    def get(path, extra=nil, params={})
+      response = get! path, extra, params
+      response = after_request_block.call(response) if after_request_block
+      response
+    end
+
+    # Return the response from the API, without executing the after_request
+    # block.
+    def get!(path, extra=nil, params={})
+      if extra.is_a?(Hash) and params.empty?
+        params = extra
+        extra = nil
+      end
+      
+      path = "#{path}/#{extra}" if extra
+      url = construct_url path, params
+
+      return url if debug 
+
+      response = cache.get(url)
+      @last_error = response.error
+      response.content
+    end
+
+    # Save the response from the API to a file.
+    def save(filename, path, params={})
+      response = get! path, nil, params
+      return response if debug
+      File.write filename, response.to_s
+    end
+
+    # Build a URL from all its explicit and implicit pieces.
+    def construct_url(path, params={})
+      path = "/#{path}" unless path[0] == '/'
+      all_params = default_params.merge params
+      result = "#{base_url}#{path}"
+      result = "#{result}.#{format}" if format && File.extname(result) == ''
+      unless all_params.empty?
+        all_params = URI.encode_www_form all_params
+        result = "#{result}?#{all_params}"
+      end
+      result
+    end
+
+    def default_params
+      @default_params ||= {}
+    end
+
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: intrinio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: webcache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: runfile-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Easy to use API for Intrinio data service with a command line interface
+email: db@dannyben.com
+executables:
+- intrinio
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/intrinio
+- lib/intrinio.rb
+- lib/intrinio/api.rb
+- lib/intrinio/command_line.rb
+- lib/intrinio/docopt.txt
+- lib/intrinio/version.rb
+- lib/intrinio/web_api.rb
+homepage: https://github.com/DannyBen/intrinio
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Intrinio API Library and Command Line
+test_files: []