quandl_ruby 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d2f779e7506690aabe6a2d8ed1885c7218673ac
-  data.tar.gz: 5331b314fe42c0546c26aa5da69916ff230f04f8
+  metadata.gz: 6c2169fcb001f481bf93cdbb46ee7a9bc8e34513
+  data.tar.gz: 635b03bfe0a03217d23f6dcd86bdf6ecffc37fae
 SHA512:
-  metadata.gz: c4b1a2c92022343fe9e74ebbae78b1f4ab6aa3471288a4138c9deb7d30523ee375ce7ecad685cdbbe27c9c95d950a859de58b429560f8fb635df87e827c1c5f9
-  data.tar.gz: 04543fe4e82e5e527114ea4f66c6e89ba3dcb0b1dc826760d8c008fbcb12d203f428886c1f4df3103bc58ee8a92588250af25befad847c1a682525962ace1d2f
+  metadata.gz: 8e70f2a1c36677ecd9c19a4fe22f4d59e8e94e115d9f94099afa76a0b69fcc6fcbee2bb046b6629783edeae3311816b9873bcf161190b3ad10b147bcf188a61b
+  data.tar.gz: e9d86debe8f31abf4f9f0decdb7e44b6a78881c5fefb96cb91011b2aa2cb673255922a2f93af1b3c5bced15c055892d227739d3a87c21229d74ff5d91a003fc8

data/README.md

@@ -2,8 +2,13 @@
 
 Ruby wrapper for the Quandl API (www.quandle.com).
 
-Currently supports Datasets, Metadata, and Searches.
-Coming soon: Multisets and Favorites.
+Supports:
+
+- Datasets
+- Metadata
+- Multisets
+- Searches
+- Favorites
 
 ## Installation
 
@@ -27,7 +32,7 @@ If you've got a Quandl API key, configure the Ruby API as below. If not, skip th
 
 ```ruby
 Quandl.configure do |config|
-  config.auth_token = (your api key)
+  config.auth_token = 'your auth token here'
 end
 ```
 
@@ -36,22 +41,17 @@ end
 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
+gdp = Quandl::Dataset.get('FRED/GDP')
 ```
 
 `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' })
+aapl = Quandl::Dataset.get('WIKI/AAPL', {
+  format: 'csv',
+  column: 4,
+  collapse: 'annual'
+})
 ```
 
 
@@ -60,20 +60,42 @@ aapl = Quandl::Dataset.new('WIKI/AAPL', { format: 'csv', column: 4, collapse: 'a
 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 = Quandl::Metadata.get('NSE/OIL')
+```
+
+
+### Using Multisets
+
+The `Quandl::Multiset` class allows you to build multisets for yourself. Accepts `options` hash as a secondary argument to the initializer.
 
-oil.get # => returns metadata for 'NSE/OIL'
+```ruby
+example = Quandl::Multiset.get(['FRED/GDP/1', 'WIKI/AAPL/4'])
 ```
 
+Unlike the official Quandl API, use `/` (instead of `.`) as your delimiter for source, table, and column number to maintain consistency with `Quandl::Dataset`.
+
 
 ### 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 = Quandl::Search.get('crude oil')
+```
+
+
+### Retrieving Favorites
+
+The `Quandl::Favorites` API allows you to retrieve the favorites of any user.
+
+```ruby
+# If an authorization token was previously configured with Quandl.configure,
+# then one is not required for Quandl::Favorites.get
 
-results.get # => returns search results for 'crude oil'
+favs = Quandl::Favorites.get(
+  :auth_token => 'an auth token here'
+  # Any other options here
+)
 ```
 
 

data/lib/quandl/configuration.rb

@@ -0,0 +1,30 @@
+module Quandl
+  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
+
+  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
+end

data/lib/quandl/dataset.rb

@@ -0,0 +1,34 @@
+module Quandl
+  class Dataset
+    attr_accessor :set, :options, :data
+
+    def self.get(params, options = {})
+      instance = new(params, options)
+      instance.get
+      if block_given?
+        yield(data)
+      else
+        data
+      end
+    end
+
+    def initialize(params, options = {})
+      @set = params
+      @options = options
+    end
+
+    def get(reload = false)
+      if !data || reload
+        self.data = Quandl::Request.new('datasets', {
+          dataset: set,
+          options: options
+        }).get
+      end
+      if block_given?
+        yield(data)
+      else
+        data
+      end
+    end
+  end
+end

data/lib/quandl/favorites.rb

@@ -0,0 +1,34 @@
+module Quandl
+  class Favorites
+    attr_reader :auth_token, :options, :data
+
+    def self.get(options = {})
+      instance = new(options)
+      instance.get
+      if block_given?
+        yield(instance.data)
+      else
+        instance.data
+      end
+    end
+
+    def initialize(options = {})
+      @auth_token = options.delete(:auth_token) || Quandl.configuration.auth_token
+      @options = options
+    end
+
+    def get(reload = false)
+      if !data || reload
+        self.data = Quandl::Request.new('current_user/collections/datasets/favourites', {
+          options: options,
+          auth_token: auth_token
+        }).get
+      end
+      if block_given?
+        yield(data)
+      else
+        data
+      end
+    end
+  end
+end

data/lib/quandl/metadata.rb

@@ -0,0 +1,8 @@
+module Quandl
+  class Metadata < Quandl::Dataset
+    def initialize(params = {}, options = {})
+      options[:exclude_data] = true
+      super
+    end
+  end
+end

data/lib/quandl/multiset.rb

@@ -0,0 +1,34 @@
+module Quandl
+  class Multiset
+    attr_accessor :sets, :options, :data
+
+    def self.get(datasets, options = {})
+      instance = new(datasets, options)
+      instance.get
+      if block_given?
+        yield(instance.data)
+      else
+        instance.data
+      end
+    end
+
+    def initialize(datasets, options = {})
+      @sets = datasets
+      @options = options
+    end
+
+    def get
+      if !data || reload
+        self.data = Quandl::Request.new('multisets', {
+          datasets: sets,
+          options: options
+        }).get
+      end
+      if block_given?
+        yield(data)
+      else
+        data
+      end
+    end
+  end
+end

data/lib/quandl/request.rb

@@ -0,0 +1,35 @@
+module Quandl
+  API_URI = 'http://www.quandl.com/api/'
+
+  class Request
+    attr_accessor :uri
+
+    def initialize(base, params)
+      path = [Quandl.configuration.api_version, base]
+      if Quandl.configuration.auth_token
+        params[:auth_token] = Quandl.configuration.auth_token
+      end
+      [:source, :table].each do |param|
+        path << params[param] if params[param]
+      end
+      if params[:query]
+        params[:options][:query] = params[:query]
+      end
+      path = path.join('/')
+      if params[:datasets]
+        params[:options][:columns] = params[:datasets].map { |set| set.split('/').join('.') }
+      end
+      if params[:dataset]
+        path += "/#{params[:dataset]}"
+      end
+      path += '.' + ((params[:options] || {}).delete(:format) || 'json')
+      @uri = URI(API_URI + path).tap do |uri|
+        uri.query = URI.encode_www_form(params[:options])
+      end
+    end
+
+    def get
+      open(uri).read
+    end
+  end
+end

data/lib/quandl/search.rb

@@ -0,0 +1,34 @@
+module Quandl
+  class Search
+    attr_accessor :query, :options, :data
+
+    def self.get(query, options = {})
+      instance = new(query, options)
+      instance.get
+      if block_given?
+        yield(instance.data)
+      else
+        data
+      end
+    end
+
+    def initialize(query, options = {})
+      @query = query
+      @options = options
+    end
+
+    def get
+      if !data || reload
+        self.data = Quandl::Request.new('datasets', {
+          query: query,
+          options: options
+        }).get
+      end
+      if block_given?
+        yield(data)
+      else
+        data
+      end
+    end
+  end
+end

data/lib/quandl/version.rb

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

data/lib/quandl.rb

@@ -1,103 +1,9 @@
-require 'quandl/version'
+require_relative 'quandl/version'
+require_relative 'quandl/configuration'
+require_relative 'quandl/dataset'
+require_relative 'quandl/metadata'
+require_relative 'quandl/multiset'
+require_relative 'quandl/search'
+require_relative 'quandl/favorites'
+require_relative 'quandl/request'
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Kash Nouroozi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,6 +51,13 @@ files:
 - README.md
 - Rakefile
 - lib/quandl.rb
+- lib/quandl/configuration.rb
+- lib/quandl/dataset.rb
+- lib/quandl/favorites.rb
+- lib/quandl/metadata.rb
+- lib/quandl/multiset.rb
+- lib/quandl/request.rb
+- lib/quandl/search.rb
 - lib/quandl/version.rb
 - quandl.gemspec
 homepage: https://github.com/knrz/Quandl-Ruby