intrinio 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c39293234adfdcffde5539f0dcdf68385155f258
-  data.tar.gz: 3ee010eb81eb115abcb1da60fcc5e69fcfa2bf5d
+  metadata.gz: cf2eaeb36817a3f28f086932851aa82640d66649
+  data.tar.gz: e41ba73df6877e6031bafa0fce2e655aff79096a
 SHA512:
-  metadata.gz: 19ac629eda3c065f569160148cbafc86d9963fbcea6c6a767a75cda675a17532a5634220cd80b019cc94f17b5a8c09e28a126caf0a6c84d2f98399d416061e44
-  data.tar.gz: 6004cedc1ccf6b5b5848fce25f735a3052c41024aa15307b98fa0d92313f44e87b6a6a7d0e5afef068d12433ca908424789ca6654960dae523612d1557e7cf11
+  metadata.gz: 428dcc7137db5a06459c20b385496b6c529d69e18c085f6bcf29d5a2f42d1c1a2310159bb474d485e09524ca54984200b2e2a6dd92c2dbf45e551f0691db7a26
+  data.tar.gz: 86a3c2604b6bb99c8443ee9eaebedec15cdf261dc4f9a49643f89ad03624c9c95da51520a49ebde8e3d587f64b28063e99464d11c3be98367beec988e519aaa7

data/README.md

@@ -71,22 +71,57 @@ 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:
+as well as these two:
+
+```ruby
+intrinio.get 'endpoint/sub', param: value
+intrinio.endpoint 'sub', param: value
+```
+
+By default, you will get a ruby hash in return. If you wish to have more 
+control over the response, use the `get!` method instead:
 
 ```ruby
 result = intrinio.get! "indices", type: 'economic', page_size: 5 
+
+# Request Object
+p payload.request.class
+# => HTTParty::Request
+
+# Response Object
+p payload.response.class
+# => Net::HTTPOK
+
+p payload.response.body
 # => JSON string
+
+p payload.response.code
+# => 200
+
+p payload.response.msg
+# => OK
+
+# Headers Object
+p payload.headers
+# => Hash with headers
+
+# Parsed Response Object
+p payload.parsed_response
+# => Hash with HTTParty parsed response 
+#    (this is the content returned with #get)
 ```
 
-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.
+You can get the response as CSV by calling `get_csv`:
 
 ```ruby
 result = intrinio.get_csv "indices", page_size: 5
 # => CSV string
 ```
 
+Intrinio automatically decides which part of the data to convert to CSV.
+When there is an array in the response, it will be used as the CSV data. 
+Otherwise, the entire response will be treated as a single-row CSV.
+
 To save the output directly to a file, use the `save` method:
 
 ```ruby
@@ -96,20 +131,9 @@ 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
+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:
-
-```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
@@ -154,7 +178,7 @@ $ intrinio url indices query:interest page_size:5
 Caching
 --------------------------------------------------
 
-We are using the [WebCache][3] gem for automatic HTTP caching.
+We are using the [Lightly][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 
@@ -192,4 +216,4 @@ $ intrinio get indices
 
 [1]: https://www.intrinio.com
 [2]: https://github.com/DannyBen/intrinio/blob/master/lib/intrinio/docopt.txt
-[3]: https://github.com/DannyBen/webcache
+[3]: https://github.com/DannyBen/lightly

data/bin/intrinio

@@ -4,6 +4,6 @@ require 'intrinio'
 
 begin
   Intrinio::CommandLine.instance.execute ARGV
-rescue Intrinio::BadResponse, Intrinio::IncompatibleResponse => e
+rescue APICake::BadResponse => e
   STDERR.puts "#{e.class} - #{e.message}"
 end

data/lib/intrinio.rb

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

data/lib/intrinio/api.rb

@@ -1,10 +1,12 @@
-require 'json'
-require 'csv'
+require 'apicake'
 
 module Intrinio
-  # Provides access to all the Intrinio API endpoints
-  class API < WebAPI
-    attr_reader :opts
+  # Provides access to all the Intrinio API endpoints with dynamic methods
+  # anc caching.
+  class API < APICake::Base
+    base_uri 'https://api.intrinio.com'
+
+    attr_reader :username, :password
 
     def initialize(opts={})
       if opts[:auth] 
@@ -12,58 +14,15 @@ module Intrinio
         opts.delete :auth
       end
 
-      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]
+      @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
-
-    def get_csv(*args)
-      result = get *args
-
-      raise Intrinio::BadResponse, "API said '#{result}'" if result.is_a? String
-      raise Intrinio::BadResponse, "Got a #{result.class}, expected a Hash" unless result.is_a? Hash
-      raise Intrinio::IncompatibleResponse, "There is no data attribute in the response" unless result.has_key? :data
-      raise Intrinio::IncompatibleResponse, "The data attribute in the response is empty" unless result[: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
+    def default_params
+      { basic_auth: { username: username, password: password } }
     end
   end
 end

data/lib/intrinio/command_line.rb

@@ -56,7 +56,8 @@ module Intrinio
       if csv
         puts intrinio.get_csv path, params
       else
-        puts intrinio.get! path, params
+        payload = intrinio.get! path, params
+        puts payload.response.body
       end
     end
 
@@ -70,8 +71,8 @@ module Intrinio
     end
 
     def pretty
-      response = intrinio.get path, params
-      puts JSON.pretty_generate response
+      payload = intrinio.get path, params
+      puts JSON.pretty_generate payload
     end
 
     def see
@@ -79,19 +80,17 @@ module Intrinio
     end
 
     def url
-      intrinio.debug = true
-      puts intrinio.get path, params
-      intrinio.debug = false
+      puts intrinio.url path, params
     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 = {}
+      return result if pairs.empty?
       pairs.each do |pair|
         key, value = pair.split ':'
-        result[key] = value
+        result[key.to_sym] = value
       end
       result
     end

data/lib/intrinio/exceptions.rb

@@ -1,5 +1,3 @@
 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.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intrinio
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: webcache
+  name: apicake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: runfile
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +165,6 @@ files:
 - lib/intrinio/docopt.txt
 - lib/intrinio/exceptions.rb
 - lib/intrinio/version.rb
-- lib/intrinio/web_api.rb
 homepage: https://github.com/DannyBen/intrinio
 licenses:
 - MIT

data/lib/intrinio/web_api.rb

@@ -1,93 +0,0 @@
-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