quata 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 580e41302fffc675f215c6e0be760ee1c12331d1
-  data.tar.gz: 2366adc0b92c05bb7b7fb3535c32cace572274fb
+  metadata.gz: 7974b74f540308b621c8a7fc0de260af55852223
+  data.tar.gz: e1277a24096c30ddc75b819cdc62be04740a4b68
 SHA512:
-  metadata.gz: 013f37a822659606f555ccc6c3c3f454e3b57b18a24f84234947812509e2455f8102d7ee46768751ec903019cb40038956095b5a4c585558dcee10a0fcce9979
-  data.tar.gz: 1d70b2d056137211277eb9e59070d3c8946a10eb14b4be974b39a22c5b39b863b9717d855383894df6d1bc41c410b04aa0ec014f9748d5000127867fae99b3db
+  metadata.gz: 8475fd5c7e82dcac96a77744f2e45b3c8ef6c18b9e576f48391553bdd9827c8a0bf0ba513c89ff679895bbdebf5aa7cb2b26184b87ab8ce2358c135f4882e3a3
+  data.tar.gz: 998facc8591d26543bcdc618d9bfa96654bcb1dee09d7f75102aad7ebf36bc5f4689aed56a173b3932eb2a94d919159b5e28be0bd74ddd53cb83be80297a58f9

data/README.md

@@ -15,6 +15,19 @@ It provides direct access to all of the [Quandl API][1] endpoints.
 
 ---
 
+Install
+--------------------------------------------------
+
+```
+$ gem install quata
+```
+
+Or with bundler:
+
+```ruby
+gem 'quata'
+```
+
 Features
 --------------------------------------------------
 
@@ -23,6 +36,7 @@ Features
 * Access any Quandl endpoint directly.
 * Display output in various formats.
 * Save output to a file, including bulk downloads.
+* Includes a built in file cache (disabled by default).
 
 Usage
 --------------------------------------------------
@@ -60,14 +74,14 @@ result = quandl.get! "datasets/WIKI/AAPL.csv", rows: 3 # => CSV string
 To save the output directly to a file, use the `save` method:
 
 ```ruby
-result = quandl.save "aapl.csv", "datasets/WIKI/AAPL.csv", rows: 3
+quandl.save "aapl.csv", "datasets/WIKI/AAPL.csv", rows: 3
 ```
 
 Debugging your request and adding "sticky" query parameters that stay with
 you for the following requests is also easy:
 
 ```ruby
-quandl.debug true
+quandl.debug = true
 quandl.param rows: 10, order: 'asc'
 puts quandl.get 'WIKI/AAPL'
 # => https://www.quandl.com/api/v3/WIKI/AAPL.json?auth_token=key&rows=10&order=asc
@@ -125,7 +139,45 @@ $ quata url datasets/WIKI/AAPL rows:5
 # => https://www.quandl.com/api/v3/datasets/WIKI/AAPL.csv?auth_token=YOUR_KEY&rows=5
 ```
 
+Caching
+--------------------------------------------------
+
+Quata uses 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
+quandl = Quandl.new 'Your API Key', use_cache: true
+quandl = Quandl.new 'Your API Key', use_cache: true, cache_dir: 'tmp'
+quandl = Quandl.new 'Your API Key', use_cache: true, cache_life: 120
+
+# or 
+
+quandl = Quandl.new 'Your API Key'
+quandl.cache.enable
+quandl.cache.dir = 'tmp/cache'   # Change cache folder
+quandl.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 QUANDL_CACHE_DIR=cache
+$ export QUANDL_CACHE_LIFE=120
+$ quata get datasets/WIKI/AAPL
+# => This call will be cached
+```
+
+
+Terminalcast
+--------------------------------------------------
+
 ![Quata Demo](https://raw.githubusercontent.com/DannyBen/quata/master/demo.gif "Quata Demo")
 
 [1]: https://www.quandl.com/blog/getting-started-with-the-quandl-api
 [2]: https://github.com/DannyBen/quata/blob/master/lib/quata/docopt.txt
+[3]: https://github.com/DannyBen/webcache

data/lib/quata/command_line.rb

@@ -12,8 +12,8 @@ module Quata
     attr_reader :quandl
 
     def initialize
-      @quandl = Quandl.new api_key
-      @quandl.format :csv
+      @quandl = Quandl.new api_key, options
+      @quandl.format = :csv
     end
 
     # Gets an array of arguments (e.g. ARGV), executes the command if valid
@@ -54,20 +54,20 @@ module Quata
     end
 
     def pretty(path, params)
-      quandl.format :json
+      quandl.format = :json
       response = quandl.get path, translate_params(params)
       puts JSON.pretty_generate response
     end
 
     def see(path, params)
-      quandl.format :json
+      quandl.format = :json
       ap quandl.get path, translate_params(params)
     end
 
     def url(path, params)
-      quandl.debug true
+      quandl.debug = true
       puts quandl.get path, translate_params(params)
-      quandl.debug false
+      quandl.debug = false
     end
 
     # Convert a params array like [key:value, key:value] to a hash like
@@ -86,6 +86,22 @@ module Quata
       @api_key ||= ENV['QUANDL_KEY']
     end
 
-  end
+    def options
+      return {} unless cache_dir || cache_life
+      result = {}
+      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 cache_dir
+      ENV['QUANDL_CACHE_DIR']
+    end
+
+    def cache_life
+      ENV['QUANDL_CACHE_LIFE']
+    end
+
+  end
 end

data/lib/quata/quandl.rb

@@ -4,13 +4,29 @@ require 'json'
 class Quandl < Quata::WebAPI
   attr_reader :api_key
 
-  def initialize(api_key=nil, base_url=nil)
+  def initialize(api_key=nil, opts={})
+    if api_key.is_a? Hash
+      opts = api_key
+      api_key = nil
+    end
+
     @api_key = api_key
 
-    base_url ||= 'https://www.quandl.com/api/v3'
+    defaults = {
+      use_cache: false,
+      cache_dir: nil,
+      cache_life: nil,
+      base_url: 'https://www.quandl.com/api/v3'
+    }
+
+    opts = defaults.merge! opts
+
+    self.cache.disable unless opts[:use_cache]
+    self.cache.dir = opts[:cache_dir] if opts[:cache_dir]
+    self.cache.life = opts[:cache_life] if opts[:cache_life]
 
     param auth_token: api_key if api_key
-    format :json
+    self.format = :json
 
     after_request do |response| 
       begin
@@ -20,6 +36,6 @@ class Quandl < Quata::WebAPI
       end
     end
     
-    super base_url
+    super opts[:base_url]
   end
 end

data/lib/quata/version.rb

@@ -1,3 +1,3 @@
 module Quata
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/quata/web_api.rb

@@ -1,12 +1,14 @@
 require 'uri'
 require 'open-uri'
+require 'webcache'
 
 module Quata
 
   # A general purpose HTTP wrapper. This is poor man's HTTParty with
   # dynamic methods.
   class WebAPI
-    attr_reader :base_url, :after_request_block, :debug_mode
+    attr_reader :base_url, :after_request_block
+    attr_accessor :debug, :format
 
     def initialize(base_url)
       @base_url = base_url
@@ -15,11 +17,7 @@ module Quata
     # 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)
-      begin
-        get "/#{method_sym}", *arguments
-      rescue
-        super
-      end
+      get "/#{method_sym}", *arguments
     end
 
     # Add one or more parameter to the default query string. Good for 
@@ -31,17 +29,13 @@ module Quata
       end
     end
 
-    # Set the default format that will be appended to the URL. value can be 
-    # a string or a symbol.
-    def format(value=nil)
-      @format = value if value
-      @format
+    def cache
+      @cache ||= WebCache.new
     end
 
-    # Set debug mode, which will return the requested, restructured URL 
-    # instead of returning the response.
-    def debug(value)
-      @debug_mode = value
+    # Return the last HTTP error, or false if all was good
+    def last_error
+      cache.last_error
     end
 
     # Set a block to be executed after the request. This is called only when
@@ -69,13 +63,13 @@ module Quata
       path = "#{path}/#{extra}" if extra
       url = construct_url path, params
 
-      debug_mode ? url : http_get(url)
+      debug ? url : cache.get(url)
     end
 
     # Save the response from the API to a file.
     def save(filename, path, params={})
       response = get! path, nil, params
-      return response if debug_mode
+      return response if debug
       File.write filename, response.to_s
     end
 
@@ -96,15 +90,5 @@ module Quata
       @default_params ||= {}
     end
 
-    private
-
-    def http_get(url)
-      begin
-        open(url).read
-      rescue OpenURI::HTTPError => e
-        e.message
-      end
-    end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quata
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -39,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: runfile
+  name: webcache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: runfile-tasks
+  name: runfile
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: runfile-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement