quandl 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87e7132b067d332656110bfa7074e2bcaff73679
-  data.tar.gz: 18467ef6fffdef18bdcb9c959d98151cee64be87
+  metadata.gz: 5eb40c7bbb80beb7aaf78a9147cbcde56542a407
+  data.tar.gz: 1b6c5c98ca1ed08e27f26d4d21492156a64e069e
 SHA512:
-  metadata.gz: cfbb28a5c8ad560bcafffe8d1ab0182bea85af5899a65372eb515f85bf9164443d697a9025b7fe18955d96ee9ca18579039f824554abc42c2f0a67701c3a7e6d
-  data.tar.gz: c08e8547dba57bad78708ef595dd4f8c5af33d06edf0c813e234ba402892818204624f7bdf98680a02ae28c09388fb7afea529f1a16fe1b06ad4240c931cf894
+  metadata.gz: 6ab11ee0f247d5f6c342fa032520fdd627ed4df2eb394b03e417df483967a2c7fc80b36360ada3db7a2a3b31ab0cee2bdec174c387f240da597972ca9b10c928
+  data.tar.gz: 437897b2e8b18937d8930ac8468314c8f98d4e6d6edb8f95dabb933b86344fb7a4e50344a5d42a291e409571601220df2149d94ee6f26f23eaed231beabf2b65

data/README.md

@@ -1,10 +1,12 @@
-# Quandl Ruby Client
+# Quandl Ruby Client [![Build Status](https://travis-ci.org/quandl/quandl-ruby.svg?branch=master)](https://travis-ci.org/quandl/quandl-ruby)
 
-*Copyright Quandl 2015*
+The official ruby gem for all your data needs! The Quandl client can be used to interact with the latest version of the [Quandl RESTful API](https://www.quandl.com/docs/api).
 
-The official gem for all your data needs! The Quandl client can be used to interact with the latest version of the [Quandl restful API](https://www.quandl.com/tools/api). Currently V3.
+## Deprecation of old package
 
-Note that v1 and v2 of the REST API are deprecated and we will be moving over all functionality to V3. During this transitionary period you can continue to use the old client here: https://rubygems.org/gems/quandl_client
+With the release of our v3 API we are officially deprecating version 2 of the `quandl_client` ruby gem. We have re-written the package from the ground up and will be moving forward with a 1.x.x package with the name of `quandl` that will rely on version 3 of our restful api. During this transitional period you can continue to use the old package here: 
+
+https://rubygems.org/gems/quandl_client
 
 
 ## Installation
@@ -28,77 +30,88 @@ Quandl::ApiConfig.api_version = '2015-04-09'
 
 ## Retrieving Data
 
-### Database
+### Dataset
 
-To retrieve a database simply use its code with the get parameter:
+Retrieving dataset data can be done in a similar way to Databases. For example to retrieve a dataset use its full code: 
 
 ```ruby
 require 'quandl'
-Quandl::Database.get('WIKI')
-=> ... wiki database ...
+Quandl::Dataset.get('WIKI/AAPL')
+=> ... dataset ...
 ```
 
-You can also retrieve a list of databases by using: 
+You can also retrieve a list of datasets associated to a database by using the Database helper method:
+
 
 ```ruby
-require 'quandl'
-Quandl::Database.all
-=> ... results ...
+Quandl::Database.get('WIKI').datasets
+=> ... datasets results ...
 ```
 
-You can also search for specific databases by passing a query parameter such as:
+By default, each list query will return page 1 of the first 100 results (Please see the [API Documentation](https://www.quandl.com/docs/api) for more detail)
+
+### Data
+
+Dataset data can be queried through a dataset. For example:
 
 ```ruby
 require 'quandl'
-Quandl::Database.all(params: { query: 'oil' })
-=> ... oil results ...
+Quandl::Dataset.get('WIKI/AAPL').data
+=> ... data ...
 ```
 
-### Dataset
-
-Retrieving dataset data can be done in a similar way to Databases. For example to retrieve a dataset use its full code: 
+you can access the data much like you would other lists. In addition all the data column fields are mapped to their column_names for convenience:
 
 ```ruby
-require 'quandl'
-Quandl::Dataset.get('WIKI/AAPL')
-=> ... dataset ...
+Quandl::Dataset.get('WIKI/AAPL').data.first.date
+=> ... date ...
 ```
 
-You can also retrieve the dataset through the database by using the helper method.
+### Database
 
+To retrieve a database simply use its code with the get parameter:
 
 ```ruby
 require 'quandl'
-Quandl::Database.get('WIKI').datasets
-=> ... datasets results ...
+Quandl::Database.get('WIKI')
+=> ... wiki database ...
 ```
 
-or to search for datasets with `AAPL` in them use:
+You can also retrieve a list of databases by using:
 
 ```ruby
-require 'quandl'
-Quandl::Database.get('WIKI').datasets(params: { query: 'apple' })
-=> ... datasets results for apple ...
+Quandl::Database.all
+=> ... results ...
 ```
 
-### Data
+### Database Bulk Download
 
-Dataset data can be queried through a dataset. For example:
+To get the url for bulk download of all datasets data of a database:
 
 ```ruby
 require 'quandl'
-Quandl::Dataset.get('WIKI/AAPL').data
-=> ... data ...
+Quandl::ApiConfig.api_key = 'tEsTkEy123456789'
+Quandl::Database.get('ZEA').bulk_download_url
+=> "https://www.quandl.com/api/v3/databases/ZEA/data?api_key=tEsTkEy123456789"
 ```
 
-you can access the data much like you would other lists. In addition all the data column fields are mapped to their column_names for convenience:
+To bulk download all datasets data of a database:
 
 ```ruby
-require 'quandl'
-Quandl::Dataset.get('WIKI/AAPL').data.first.date
-=> ... date ...
+Quandl::ApiConfig.api_key = 'tEsTkEy123456789'
+Quandl::Database.get('ZEA').bulk_download_to_file('/path/to/destination/file_or_folder')
 ```
 
+For bulk download of premium databases, please ensure that a valid `api_key` is set, as authentication is required.
+
+For both `bulk_download_url` and `bulk_download_to_file`, an optional `download_type` parameter can be passed in:
+
+```ruby
+Quandl::Database.get('ZEA').bulk_download_to_file('.', download_type: 'partial')
+```
+
+If `download_type` is not specified, a `complete` bulk download will be performed. Please see the [API Documentation](https://www.quandl.com/docs/api) for more detail.
+
 ## Working with results
 
 ### Instance
@@ -115,7 +128,6 @@ database.data_fields
 You can then uses these methods in your code. Additionally you can access the data by using the hash equalivalent lookup.
 
 ```ruby
-require 'quandl'
 database = Quandl::Database.get('WIKI')
 database.database_code
 => 'WIKI'
@@ -126,7 +138,6 @@ database['database_code']
 In some cases name of the fields returned by the API may not be compatible with the ruby language syntax. These will be converted into compatible field names.
 
 ```ruby
-require 'quandl'
 data = Quandl::Dataset.get('WIKI/AAPL').data(params: { limit: 1 }).first
 data.column_names
 => ["Date", "Open", "High", "Low", "Close", "Volume", "Ex-Dividend", "Split Ratio", "Adj. Open", "Adj. High", "Adj. Low", "Adj. Close", "Adj. Volume"]
@@ -136,7 +147,7 @@ data.data_fields
 
 ### List
 
-Most list queries will return a paginated list of results. You can check whether the resulting list has more data by using the `more_results?` method. Depending on its results you can pass additional params to filter the data:
+Most list queries will return a paginated list of results. You can check whether the resulting list has more data by using the `more_results?` method. By default, each list query will return page 1 of the first 100 results (Please see the [API Documentation](https://www.quandl.com/docs/api) for more detail). Depending on its results you can pass additional params to filter the data:
 
 ```ruby
 require 'quandl'
@@ -151,8 +162,8 @@ Quandl::Database.all(params: { page: 2 })
 Lists also function as arrays and can be iterated through. Note however that using these features will only work on the current page of data you have locally. You will need to continue to fetch results and iterate again to loop through the full result set.
 
 ```ruby
-require 'quandl'
-databases = Quandl::Database.all.each { |d| puts d.database_code }
+databases = Quandl::Database.all
+databases.each { |d| puts d.database_code }
 => ... print database codes ...
 databases.more_results?
 => true
@@ -163,7 +174,6 @@ Quandl::Database.all(params: { page: 2 }).each { |d| puts d.database_code }
 Lists also return metadata associated with the request. This can include things like the current page, total results, etc. Each of these fields can be accessed through a hash or convenience method.
 
 ```ruby
-require 'quandl'
 Quandl::Database.all.current_page
 => 1
 Quandl::Database.all['current_page']
@@ -173,12 +183,21 @@ Quandl::Database.all['current_page']
 As a convenience method lists can also return their data in CSV form. To do this simply issue the .to_csv method on a list:
 
 ```ruby
-require 'quandl'
 databases = Quandl::Database.all.to_csv
 => "Id,Name,Database Code,Description,Datasets Count,Downloads,Premium,Image,Bundle Ids,Plan ...
 ```
 
+## Questions/Comments
+
+For any questions, comments or inquires about this package please open a ticket on the github repo or email the development team at <dev@quandl.com>. For any questions about data provided by the API please email connect@quandl.com
+
 ## Additional Links
 
 * [Quandl](https://www.quandl.com)
 * [Quandl Tools](https://www.quandl.com/tools/api)
+* [API Docs](https://www.quandl.com/docs/api)
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT)
+

data/lib/quandl/api_config.rb.orig

@@ -0,0 +1,48 @@
+module Quandl
+  class ApiConfig
+    API_KEY_THREAD_KEY = 'quandl_api_key'
+    API_BASE_THREAD_KEY = 'quandl_api_base'
+    API_VERSION_THREAD_KEY = 'quandl_api_version_key'
+<<<<<<< HEAD
+=======
+    DEFAULT_PER_PAGE_THREAD_KEY = 'default_per_page'
+>>>>>>> abd0bfd... Implement Database and Dataset get and list
+
+    class << self
+      def api_key=(api_key)
+        Thread.current[API_KEY_THREAD_KEY] = api_key
+      end
+
+      def api_key
+        Thread.current[API_KEY_THREAD_KEY]
+      end
+
+      def api_base=(api_base)
+        Thread.current[API_BASE_THREAD_KEY] = api_base
+      end
+
+      def api_base
+        Thread.current[API_BASE_THREAD_KEY] || 'https://www.quandl.com/api/v3'
+      end
+
+      def api_version=(api_version)
+        Thread.current[API_VERSION_THREAD_KEY] = api_version
+      end
+
+      def api_version
+        Thread.current[API_VERSION_THREAD_KEY]
+      end
+<<<<<<< HEAD
+=======
+
+      def default_per_page=(per_page)
+        Thread.current[DEFAULT_PER_PAGE_THREAD_KEY] = per_page
+      end
+
+      def default_per_page
+        Thread.current[DEFAULT_PER_PAGE_THREAD_KEY] || 25
+      end
+>>>>>>> abd0bfd... Implement Database and Dataset get and list
+    end
+  end
+end

data/lib/quandl/model/database.rb

@@ -16,7 +16,7 @@ module Quandl
 
       params = {}
       params['download_type'] = options[:download_type] if options[:download_type]
-      params['auth_token'] = Quandl::ApiConfig.api_key if Quandl::ApiConfig.api_key
+      params['api_key'] = Quandl::ApiConfig.api_key if Quandl::ApiConfig.api_key
 
       url += '?' + params.to_query if params.any?
       url

data/lib/quandl/model/list.rb.orig

@@ -0,0 +1,48 @@
+module Quandl
+  class List
+    attr_reader :meta
+    attr_reader :values
+
+    def initialize(klass, values, meta)
+      @klass = klass
+      @values = values.map { |v| klass.new(v, meta: meta) }
+      @meta = meta
+    end
+
+    def more_results?
+<<<<<<< HEAD
+=======
+      fail(QuandlError, "#{@klass} does not support pagination yet") if !@meta.key?('total_pages') && !@meta.key?('current_page')
+>>>>>>> b480b01... pre-release version of quandl gem
+      @meta['total_pages'] > @meta['current_page']
+    end
+
+    def to_a
+      @values.map(&:to_a)
+    end
+
+    def to_csv
+      fail(QuandlError, 'No values to export') if @values.empty?
+
+      CSV.generate do |csv|
+        csv << @values.first.column_names
+        @values.each do |row|
+          csv << row.to_a
+        end
+      end
+    end
+
+    def inspect
+      { meta: @meta, values: @values }.to_s
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return @meta[method_name.to_s] if @meta.key?(method_name.to_s)
+      return @meta[*args] if method_name.to_s == '[]' && @meta.key?(args[0].to_s)
+      return @values.method(method_name).call(*args, &block) if @values.respond_to?(method_name)
+      super
+    end
+  end
+end

data/lib/quandl/version.rb

@@ -1,3 +1,3 @@
 module Quandl
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quandl
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Clement Leung
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-17 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -162,6 +162,7 @@ files:
 - README.md
 - lib/quandl.rb
 - lib/quandl/api_config.rb
+- lib/quandl/api_config.rb.orig
 - lib/quandl/connection.rb
 - lib/quandl/errors/quandl_error.rb
 - lib/quandl/model/base.rb
@@ -169,6 +170,7 @@ files:
 - lib/quandl/model/database.rb
 - lib/quandl/model/dataset.rb
 - lib/quandl/model/list.rb
+- lib/quandl/model/list.rb.orig
 - lib/quandl/operations/base.rb
 - lib/quandl/operations/get.rb
 - lib/quandl/operations/list.rb