quandl_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d2f779e7506690aabe6a2d8ed1885c7218673ac
+  data.tar.gz: 5331b314fe42c0546c26aa5da69916ff230f04f8
+SHA512:
+  metadata.gz: c4b1a2c92022343fe9e74ebbae78b1f4ab6aa3471288a4138c9deb7d30523ee375ce7ecad685cdbbe27c9c95d950a859de58b429560f8fb635df87e827c1c5f9
+  data.tar.gz: 04543fe4e82e5e527114ea4f66c6e89ba3dcb0b1dc826760d8c008fbcb12d203f428886c1f4df3103bc58ee8a92588250af25befad847c1a682525962ace1d2f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quandl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kash Nouroozi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Quandl
+
+Ruby wrapper for the Quandl API (www.quandle.com).
+
+Currently supports Datasets, Metadata, and Searches.
+Coming soon: Multisets and Favorites.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'quandl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quandl
+
+## Usage
+
+### Configuration
+
+If you've got a Quandl API key, configure the Ruby API as below. If not, skip this step.
+
+```ruby
+Quandl.configure do |config|
+  config.auth_token = (your api key)
+end
+```
+
+### Getting A Dataset
+
+To get a dataset, create a new `Quandl::Dataset`:
+
+```ruby
+gdp = Quandl::Dataset.new('FRED/GDP')
+
+# To pass the data to a block provide a block to Quandl::Dataset#get,
+# which will otherwise return the Quandl data
+# Both of the following present the same data:
+gdp.get do |data|
+  # Do stuff with the data, by default in JSON format
+end
+
+data = gdp.get
+```
+
+`Quandl::Dataset#new` accepts an options hash as a second argument. Put anything that you would otherwise but as an argument in the url here.
+
+```ruby
+aapl = Quandl::Dataset.new('WIKI/AAPL', { format: 'csv', column: 4, collapse: 'annual' })
+```
+
+
+### Getting Metadata
+
+The `Quandl::Metadata` API is exactly the same as the `Quandl::Dataset` API, except that it only returns metadata.
+
+```ruby
+oil = Quandl::Metadata.new('NSE/OIL')
+
+oil.get # => returns metadata for 'NSE/OIL'
+```
+
+
+### Searching Quandl
+
+The `Quandl::Search` API is exactly the same as the `Quandl::Dataset` API, except that it returns a query.
+
+```ruby
+results = Quandl::Search.new('crude oil')
+
+results.get # => returns search results for 'crude oil'
+```
+
+
+## Contributing
+
+1. [Fork it](https://github.com/knrz/quandl/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/quandl/version.rb

@@ -0,0 +1,3 @@
+module Quandl
+  VERSION = '0.0.1'
+end

data/lib/quandl.rb

@@ -0,0 +1,103 @@
+require 'quandl/version'
+require 'open-uri'
+
+module Quandl
+  API_URI = 'http://www.quandl.com/api/'
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.build_uri(params)
+    path = [configuration.api_version, 'datasets']
+    if configuration.auth_token
+      params[:auth_token] = configuration.auth_token
+    end
+    unless params[:query]
+      path << params.delete(:source)
+      path << params.delete(:table)
+    end
+    path = path.join('/') + '.' + (params[:options][:format] || 'json')
+    URI(API_URI + path).tap do |uri|
+      uri.query = URI.encode_www_form(params[:options])
+    end
+  end
+
+  def self.get(params = {})
+    open(build_uri(params)).read
+  end
+
+  class Configuration
+    attr_writer :api_version
+    attr_accessor :auth_token
+
+    def initialize
+      self.api_version = 1
+    end
+
+    def api_version
+      "v#{@api_version}"
+    end
+  end
+
+  class Dataset
+    attr_accessor :source, :table, :options
+    def initialize(params = {}, options = {})
+      if params.is_a? String
+        match_data = params.match(/(.+)\/(.+)/)
+        params = {
+          source: match_data[1],
+          table:  match_data[2]
+        }
+      end
+      @source  = params[:source].upcase
+      @table   = params[:table].upcase
+      @options = options
+    end
+
+    def get
+      data = Quandl.get(source: source, table: table, options: options)
+      if block_given?
+        yield(data)
+      else
+        data
+      end
+    end
+  end
+
+  class Metadata < Dataset
+    def initialize(params = {}, options = {})
+      options[:exclude_data] = true
+      super
+    end
+  end
+
+  class Search
+    attr_accessor :query, :options
+    def initialize(query, options = {})
+      @query = query
+      @options = options
+    end
+
+    def get
+      data = Quandl.get(query: query, options: options)
+      if block_given?
+        yield(data)
+      else
+        data
+      end
+    end
+  end
+end

data/quandl.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quandl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quandl_ruby'
+  spec.version       = Quandl::VERSION
+  spec.authors       = ['Kash Nouroozi']
+  spec.email         = ['hi@knrz.co']
+  spec.summary       = %q{Ruby wrapper for the Quandl API (www.quandle.com)}
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/knrz/Quandl-Ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: quandl_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kash Nouroozi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: ''
+email:
+- hi@knrz.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quandl.rb
+- lib/quandl/version.rb
+- quandl.gemspec
+homepage: https://github.com/knrz/Quandl-Ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Quandl API (www.quandle.com)
+test_files: []