quata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 580ff598467d94e05a1ab31b7c6a07907fcb618a
+  data.tar.gz: 2acff7751ca88d39a4f57ea0b7aa1b31c09234be
+SHA512:
+  metadata.gz: 8edcf7a6387ccb52603351c03685f68b5c2d4c35d806a1a7693cd019f2b8af2df7285832642a16a8decae6c2e726a875db0a3cd877d286fb63827c3d4b28ff54
+  data.tar.gz: 45aa82466c670de3b0935c510f00c4ba6ef4113a94fb14608fbc7a0e7ee30a4fe56b2c42ae752a21e9f959c69f56ab7dc58e8bb1e3ec9e839af3bb364b370184

data/README.md

@@ -0,0 +1,98 @@
+Quata - Quandl API Library and Command Line
+==================================================
+
+---
+
+Quata is a lightweight ruby library for accessing Quandl with a command 
+line interface.
+
+---
+
+Features
+--------------------------------------------------
+
+* Access any Quandl endpoint directly.
+* Display output in various formats.
+* Save output to a file, including bulk downloads.
+
+Example
+--------------------------------------------------
+
+First, require and initialize Quata with your API key
+
+```ruby
+require 'quata'
+quandl = Quandl.new 'Your API Key'
+```
+
+Now, you can access any Quandl endpoint with any optional parameter, like
+this:
+
+```ruby
+result = quandl.get "datasets/WIKI/AAPL", rows: 3 # => Hash
+```
+
+In addition, for convenience, you can use the first part of the endpoint as
+a method name, like this:
+
+```ruby
+result = quandl.datasets "WIKI/AAPL", rows: 3
+```
+
+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 = quandl.get! "datasets/WIKI/AAPL", rows: 3 # => JSON string
+result = quandl.get! "datasets/WIKI/AAPL.json", rows: 3 # => JSON string
+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
+```
+
+Command Line
+--------------------------------------------------
+
+The command line utility `quata` acts similarly. It provides these commands:
+
+`$ quata get PATH [PARAMS...]` - print the output.  
+`$ quata pretty PATH [PARAMS...]` - print a pretty JSON.  
+`$ quata see PATH [PARAMS...]` - print a colored output.  
+`$ quata url PATH [PARAMS...]` - show the constructed URL.  
+`$ quata save FILE PATH [PARAMS...]` - save the output to a file.  
+
+Run `quata --help` for more information.
+
+Examples:
+```bash
+# Shows the first two databases
+quata see databases per_page:2
+
+# Or more compactly, as CSV
+quata get databases per_page:2
+
+# Prints CSV to screen (CSV is the default in the command line)
+$ quata get datasets/WIKI/AAPL
+
+# Prints JSON instead
+$ quata get datasets/WIKI/AAPL.json
+
+# Pass arguments using the same syntax - key:value
+$ quata get datasets/WIKI/AAPL rows:5
+
+# Pass arguments that require spaces
+$ quata get datasets.json "query:qqq index"
+
+# Prints a colored output
+$ quata see datasets/WIKI/AAPL rows:5
+
+# Saves a file
+$ quata save output.csv datasets/WIKI/AAPL rows:5
+
+# Shows the URL that Quata has constructed, good for debugging
+$ quata url datasets/WIKI/AAPL rows:5
+```

data/bin/quata

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

data/lib/quata.rb

@@ -0,0 +1,4 @@
+require 'quata/version'
+require 'quata/web_api'
+require 'quata/quandl'
+require 'quata/command_line'

data/lib/quata/command_line.rb

@@ -0,0 +1,84 @@
+require 'singleton'
+require 'docopt'
+require 'json'
+require 'awesome_print'
+
+module Quata
+
+  class CommandLine
+    include Singleton
+
+    attr_reader :quandl
+
+    def initialize
+      @quandl = Quandl.new api_key
+      @quandl.format :csv
+    end
+
+    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
+
+    private
+
+    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 quandl.get! path, translate_params(params)
+    end
+
+    def save(file, path, params)
+      success = quandl.save file, path, translate_params(params)
+      puts success ? "Saved #{file}" : "Saving failed"
+    end
+
+    def pretty(path, params)
+      quandl.format :json
+      response = quandl.get path, translate_params(params)
+      puts JSON.pretty_generate response
+    end
+
+    def see(path, params)
+      quandl.format :json
+      ap quandl.get path, translate_params(params)
+    end
+
+    def url(path, params)
+      quandl.debug true
+      puts quandl.get path, translate_params(params)
+      quandl.debug false
+    end
+
+    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 api_key
+      @api_key ||= ENV['QUANDL_KEY']
+    end
+
+  end
+
+end

data/lib/quata/quandl.rb

@@ -0,0 +1,25 @@
+# Quandl
+require 'json'
+
+class Quandl < Quata::WebAPI
+  attr_reader :api_key
+
+  def initialize(api_key=nil, base_url=nil)
+    @api_key = api_key
+
+    base_url ||= 'https://www.quandl.com/api/v3'
+
+    param :auth_token, api_key if api_key
+    format :json
+
+    after_request do |response| 
+      begin
+        JSON.parse response, symbolize_names: true
+      rescue JSON::ParserError => e  
+        response
+      end
+    end
+    
+    super base_url
+  end
+end

data/lib/quata/version.rb

@@ -0,0 +1,3 @@
+module Quata
+  VERSION = "0.1.0"
+end

data/lib/quata/web_api.rb

@@ -0,0 +1,101 @@
+require 'uri'
+require 'open-uri'
+
+module Quata
+
+  class WebAPI
+    attr_reader :base_url, :after_request_block, :debug_mode
+
+    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)
+      begin
+        get "/#{method_sym}", *arguments
+      rescue
+        super
+      end
+    end
+
+    # Add a parameter to the default query string. Good for adding keys that
+    # are always needed, like API keys.
+    def param(key, value)
+      default_params[key] = value
+    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
+    end
+
+    # Set debug mode, which will return the requested, restructured URL 
+    # instead of returning the response.
+    def debug(value)
+      @debug_mode = value
+    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 teh 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
+
+      debug_mode ? url : http_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
+      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
+
+    private
+
+    def http_get(url)
+      open(url).read
+    end
+  end
+
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: quata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-19 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.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Easy to use API for Quandl data service with a command line interface
+email: db@dannyben.com
+executables:
+- quata
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/quata
+- lib/quata.rb
+- lib/quata/command_line.rb
+- lib/quata/quandl.rb
+- lib/quata/version.rb
+- lib/quata/web_api.rb
+homepage: https://github.com/DannyBen/quata
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Quandl API Library and Command Line
+test_files: []