quandl 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a80d550c3a42a20073ce20ec17b9565e3dacd26
-  data.tar.gz: 1377601b7d60dfc17faa807d25add882bc4418e0
+  metadata.gz: 8bcec9178eedea09db0f199d66775c08a466e626
+  data.tar.gz: 1f83ce52389cdcf290b7227d683e47ea1a5bbfae
 SHA512:
-  metadata.gz: 481d5c5b7a5089c23a9abba7c52ffcc48aa626f70f7c221f16ea1e552a367c4bf1fa5e48aea2cc1bf93eeefd1bc961f5ee8a9d1d32321c6a7cd3a6053ae32810
-  data.tar.gz: d2f63dcf21bfc4be9bf169ea161f32ce32ac30f1cb0c8ad6aeb01ac942ea10bf743f5054cbc0dbbf9fbed390de419bdbba7ad9e02ff695981549515bd8788c5c
+  metadata.gz: ba3f3b3dc36b8c5608a7d5f274b3b571224966748076b0a3ec8a40937ee7e1bb4387143dc25ecad070ad96669f8d925c5c97c28e03380ba0374078da13a6208e
+  data.tar.gz: 9b8e317737e4b51d3547a9cc6fdc636f7dc207fa6c6c873742b5ce28720af8c65d0f194662d794b81dee75c33f8349b84ea1a4ab70069def46e430c09b2f7dca

data/README.md

@@ -84,9 +84,9 @@ Quandl::Database.all
 => ... results ...
 ```
 
-### Database Bulk Download
+### Download Entire Database (Bulk Download)
 
-To get the url for bulk download of all datasets data of a database:
+To get the url for downloading all dataset data of a database:
 
 ```ruby
 require 'quandl'
@@ -95,19 +95,21 @@ Quandl::Database.get('ZEA').bulk_download_url
 => "https://www.quandl.com/api/v3/databases/ZEA/data?api_key=tEsTkEy123456789"
 ```
 
-To bulk download all datasets data of a database:
+To bulk download all dataset data of a database:
 
 ```ruby
 Quandl::ApiConfig.api_key = 'tEsTkEy123456789'
 Quandl::Database.get('ZEA').bulk_download_to_file('/path/to/destination/file_or_folder')
 ```
 
+The file or folder path can either be specified as a string or as a [File](http://ruby-doc.org/core-2.2.0/File.html).
+
 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:
+For both `bulk_download_url` and `bulk_download_to_file`, an optional `download_type` query parameter can be passed in:
 
 ```ruby
-Quandl::Database.get('ZEA').bulk_download_to_file('.', download_type: 'partial')
+Quandl::Database.get('ZEA').bulk_download_to_file('.', params: {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.

data/lib/quandl/errors/quandl_error.rb

@@ -53,4 +53,7 @@ module Quandl
 
   class ForbiddenError < QuandlError
   end
+
+  class InvalidDataError < QuandlError
+  end
 end

data/lib/quandl/model/data.rb

@@ -3,6 +3,11 @@ module Quandl
     include Quandl::Operations::List
 
     def self.create_list_from_response(_response, data)
+      if data['dataset_data']['data'].length > 0 &&
+         data['dataset_data']['column_names'].length != data['dataset_data']['data'].first.length
+        fail InvalidDataError.new('number of column names does not match number of data points in a row!',
+                                  nil, nil, data)
+      end
       values = data['dataset_data'].delete('data')
       metadata = data['dataset_data']
       Quandl::List.new(self, values, metadata)

data/lib/quandl/model/database.rb

@@ -8,26 +8,32 @@ module Quandl
     end
 
     def bulk_download_url(options = {})
-      options.assert_valid_keys(:download_type, :path_only)
+      options.assert_valid_keys(:params)
 
-      url = self.class.default_path + '/data'
-      url = Quandl::ApiConfig.api_base + '/' + url unless options[:path_only]
+      url = bulk_download_path
+      url = Quandl::ApiConfig.api_base + '/' + url
       url = Quandl::Util.constructed_path(url, id: database_code)
 
-      params = {}
-      params['download_type'] = options[:download_type] if options[:download_type]
+      params = options[:params] || {}
       params['api_key'] = Quandl::ApiConfig.api_key if Quandl::ApiConfig.api_key
+      params['api_version'] = Quandl::ApiConfig.api_version if Quandl::ApiConfig.api_version
 
       url += '?' + params.to_query if params.any?
       url
     end
 
+    def bulk_download_path
+      path = self.class.default_path + '/data'
+      path = Quandl::Util.constructed_path(path, id: database_code)
+      path
+    end
+
     def bulk_download_to_file(file_or_folder_path, options = {})
       fail(QuandlError, 'You must specific a file handle or folder to write to.') if file_or_folder_path.blank?
 
       # Retrieve the location of the bulk download url
-      url = bulk_download_url({ path_only: true }.merge(options))
-      download_url = Quandl::Connection.request(:get, url) do |response, _request, _result, &_block|
+      path = bulk_download_path
+      download_url = Quandl::Connection.request(:get, path, options) do |response, _request, _result, &_block|
         if response.code == 302
           response.headers[:location]
         else
@@ -40,7 +46,9 @@ module Quandl
       # Check that we can write to the directory
       file = file_or_folder_path
       unless file_or_folder_path.is_a?(File)
-        file_or_folder_path = Pathname.new(file_or_folder_path.to_s).join(File.basename(uri.path))
+        if File.directory?(file_or_folder_path)
+          file_or_folder_path = Pathname.new(file_or_folder_path.to_s).join(File.basename(uri.path))
+        end
         file = File.open(file_or_folder_path, 'wb')
       end
 

data/lib/quandl/version.rb

@@ -1,3 +1,3 @@
 module Quandl
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quandl
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Clement Leung
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport