quandl_ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0952595cac0796e5898395d4c40c759e0340f68
-  data.tar.gz: beb7d47ca034889c91d39c4f442c63550d7d0911
+  metadata.gz: add9b14412c18ff8c852d0515ae35ef0b5444626
+  data.tar.gz: 741d9919e1abb3efc7abd86b78edb5d099ec1f5e
 SHA512:
-  metadata.gz: 16174ec2d59b403d495e1859e12f5836f7d273a69effb7a42e3c460d8f044c350dafa22520151a6e36e7016f5998d64ed2db38709ca3c6273715acc10642994c
-  data.tar.gz: 910439ff04926038746f133d463dc4e3ae9a8049cafc3e5573ebe0350d00ff11a1bbbfd917bc8fa72737b83bd528fa4f2bda27691b9d1b2a53ff81461377f67c
+  metadata.gz: 7ee77318c3c234c5e62a788a987312543db2ca7e2f342f1b77eff991f15b727506bfe5fa2713ca5773ecbcfc9b7d9396b1425514698e7260ea9c7586208b4337
+  data.tar.gz: c4e05e82854fab05c0d7dd76e8c6517c9d6d5d58b3ac25614e749bb81317e7f403ac94fdd693a2507eb93b60c67c8d0324956b97115a8270d23eeb9c3b739088

data/README.md

@@ -8,7 +8,7 @@ A Ruby wrapper for the Quandl API (www.quandl.com).
 
 Add this line to your application's Gemfile:
 
-    gem 'quandl'
+    gem 'quandl_ruby'
 
 And then execute:
 
@@ -16,7 +16,11 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install quandl
+    $ gem install quandl_ruby
+
+Then at the beginning of a file:
+
+    require 'quandl_ruby'
 
 ## Usage
 
@@ -132,27 +136,23 @@ gdp = Quandl::Dataset.get('FRED/GDP')
 #   Example from: http://www.quandl.com/help/api#A-Multiset-Example
 
 datasets = ['FRED/GDP/1', 'DOE/RWTC/1', 'WIKI/AAPL/4']
-options = {
-  collapse: 'annual',
-  transformation: 'rdiff',
-  rows: 10
-}
-comparison = Quandl::Multiset.new(datasets, options)
+comparison = Quandl::Multiset.get(datasets).
+               collapse(:annual).
+               transform(:rdiff).
+               limit(10)
 # Unlike the official Quandl REST API, separate source, table, and column numbers
 # With `/` as opposed to `.` to maintain consistency with Quandl::Dataset
 ```
 
 ### Doing A Search
 
+Note that Quandl::Search does not have access to the API option-setting methods. Instead, it has #per_page and #page, which correspond with the `per_page` and `page` url parameters of the Quandl API
+
 ```ruby
 # Get search results for crude oil
 #   Example from: http://www.quandl.com/help/api#Doing-a-Search
 query = 'crude oil'
-options = {
-  per_page: 50,
-  page: 2
-}
-results = Quandl::Search.get(query, options)
+results = Quandl::Search.get(query).per_page(20).page(4)
 ```
 
 ### Getting Metadata
@@ -174,7 +174,7 @@ oil_metadata = Quandl::Metadata.get('NSE/OIL')
 my_favorites = Quandl::Favorites.get
 
 # Or pass in another API key as the first argument to override your own
-some_other_guys_favorites = Quandl::Favorites.get('that_guys_api_key')
+another_guys_favorites = Quandl::Favorites.get('that_guys_api_key')
 
 # For Brits and Canucks, Quandl::Favorites is aliased as Quandl::Favourites
 ```

data/lib/quandl/base.rb

@@ -0,0 +1,26 @@
+module Quandl
+  class Base
+    attr_accessor :query, :options
+
+    def self.get(*params)
+      new(*params)
+    end
+
+    def initialize(query, options = {})
+      @query = query
+      @options = options
+    end
+
+    [:data, :metadata].each do |data|
+      define_method(data) do |bust_cache = false|
+        cache = instance_variable_get "@#{data}"
+        if cache && !bust_cache
+          cache
+        else
+          reload!
+          instance_variable_get "@#{data}"
+        end
+      end
+    end
+  end
+end

data/lib/quandl/dataset.rb

@@ -1,30 +1,7 @@
 module Quandl
-  class Dataset
-    attr_accessor :query, :options
-
+  class Dataset < Quandl::Base
     include Quandl::Filter
 
-    def self.get(*params)
-      new(*params)
-    end
-
-    def initialize(query, options = {})
-      @query = query
-      @options = options
-    end
-
-    [:data, :metadata].each do |data|
-      define_method(data) do |bust_cache = false|
-        cache = instance_variable_get "@#{data}"
-        if cache && !bust_cache
-          cache
-        else
-          reload!
-          instance_variable_get "@#{data}"
-        end
-      end
-    end
-
     def reload!
       raw_data = Quandl::Request.new('datasets', {
         dataset: query,
@@ -33,6 +10,7 @@ module Quandl
       response = Quandl.parse(raw_data, (options[:format] || :json).to_sym)
       @data = response.delete(:data)
       @metadata = response
+      self
     end
   end
 end

data/lib/quandl/favorites.rb

@@ -13,6 +13,7 @@ module Quandl
       response = Quandl.parse(raw_data, (options[:format] || :json).to_sym)
       @data = response.delete(:data)
       @metadata = response
+      self
     end
   end
 

data/lib/quandl/multiset.rb

@@ -8,6 +8,7 @@ module Quandl
       response = Quandl.parse(raw_data, (options[:format] || :json).to_sym)
       @data = response.delete(:data)
       @metadata = response
+      self
     end
   end
 end

data/lib/quandl/search.rb

@@ -1,5 +1,12 @@
 module Quandl
-  class Search < Quandl::Dataset
+  class Search < Quandl::Base
+    [:page, :per_page].each do |filter|
+      define_method(filter) do |n|
+        @options[filter] = n.to_i
+        self
+      end
+    end
+
     def reload!
       raw_data = Quandl::Request.new('datasets', {
         query: query,
@@ -8,6 +15,7 @@ module Quandl
       response = Quandl.parse(raw_data, (options[:format] || :json).to_sym)
       @data = response.delete(:data)
       @metadata = response
+      self
     end
   end
 end

data/lib/quandl/version.rb

@@ -1,3 +1,3 @@
 module Quandl
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/quandl.rb

@@ -1,10 +1,22 @@
+# The version
 require_relative 'quandl/version'
+
+# Configuration
 require_relative 'quandl/configuration'
-require_relative 'quandl/parse'
+
+# Modules
 require_relative 'quandl/filter'
+
+# Module methods
+require_relative 'quandl/parse'
+
+# Base classes
+require_relative 'quandl/base'
+require_relative 'quandl/request'
+
+# API classes
 require_relative 'quandl/dataset'
 require_relative 'quandl/metadata'
 require_relative 'quandl/multiset'
 require_relative 'quandl/search'
 require_relative 'quandl/favorites'
-require_relative 'quandl/request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kash Nouroozi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,6 +51,7 @@ files:
 - README.md
 - Rakefile
 - lib/quandl.rb
+- lib/quandl/base.rb
 - lib/quandl/configuration.rb
 - lib/quandl/dataset.rb
 - lib/quandl/favorites.rb