quandl 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a80d550c3a42a20073ce20ec17b9565e3dacd26
-  data.tar.gz: 1377601b7d60dfc17faa807d25add882bc4418e0
+SHA256:
+  metadata.gz: 8481bd2e2b3c7f1cf717957487dd202dd480499ca654a158b3f2c05d6d79a849
+  data.tar.gz: dae3cfe235ca3195fd537bca6a1ac9a4a74f91d8f8110e85cd9a04f145a3d7fe
 SHA512:
-  metadata.gz: 481d5c5b7a5089c23a9abba7c52ffcc48aa626f70f7c221f16ea1e552a367c4bf1fa5e48aea2cc1bf93eeefd1bc961f5ee8a9d1d32321c6a7cd3a6053ae32810
-  data.tar.gz: d2f63dcf21bfc4be9bf169ea161f32ce32ac30f1cb0c8ad6aeb01ac942ea10bf743f5054cbc0dbbf9fbed390de419bdbba7ad9e02ff695981549515bd8788c5c
+  metadata.gz: 16e109f9880cabb3fd880e4a5dc1b68c9bb7bd179137b67de8812cf6ded8c1a73dc89b4e262c877840d6ce43b89802f8ed31a680fc1287a33f423cd7d6d32acd
+  data.tar.gz: 7b67c735c72a6170a0aa00c328cd21af6743c8ce1f40f4dc072b71a7fc256fbf842099d5f18b8b4b01e9198d37446c2442bc920fde931a32c2da75146908c627

data/README.md

@@ -2,13 +2,6 @@
 
 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).
 
-## Deprecation of old package
-
-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
 
 ```ruby
@@ -32,7 +25,7 @@ Quandl::ApiConfig.api_version = '2015-04-09'
 
 ### Dataset
 
-Retrieving dataset data can be done in a similar way to Databases. For example to retrieve a dataset use its full code: 
+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'
@@ -60,7 +53,7 @@ Quandl::Dataset.get('WIKI/AAPL').data
 => ... data ...
 ```
 
-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:
+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
 Quandl::Dataset.get('WIKI/AAPL').data.first.date
@@ -84,9 +77,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 +88,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.
@@ -125,7 +120,7 @@ database.data_fields
 => ["id", "name", "database_code", "description", "datasets_count", "downloads", "premium", "image"]
 ```
 
-You can then uses these methods in your code. Additionally you can access the data by using the hash equalivalent lookup.
+You can then uses these methods in your code. Additionally you can access the data by using the hash equivalent lookup.
 
 ```ruby
 database = Quandl::Database.get('WIKI')
@@ -187,10 +182,6 @@ 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)
@@ -200,4 +191,3 @@ For any questions, comments or inquires about this package please open a ticket
 ## License
 
 [MIT License](http://opensource.org/licenses/MIT)
-

data/lib/quandl/api_config.rb

@@ -1,32 +1,47 @@
+# frozen_string_literal: true
+
 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'
 
+    @api_key = nil
+    @api_base = nil
+    @api_version = nil
+
     class << self
       def api_key=(api_key)
+        @api_key ||= api_key
         Thread.current[API_KEY_THREAD_KEY] = api_key
       end
 
       def api_key
-        Thread.current[API_KEY_THREAD_KEY]
+        Thread.current[API_KEY_THREAD_KEY] || @api_key
       end
 
       def api_base=(api_base)
+        @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'
+        Thread.current[API_BASE_THREAD_KEY] || @api_base || 'https://www.quandl.com/api/v3'
       end
 
       def api_version=(api_version)
+        @api_version ||= api_version
         Thread.current[API_VERSION_THREAD_KEY] = api_version
       end
 
       def api_version
-        Thread.current[API_VERSION_THREAD_KEY]
+        Thread.current[API_VERSION_THREAD_KEY] || @api_version
+      end
+
+      def reset
+        @api_key = nil
+        @api_base = nil
+        @api_version = nil
       end
     end
   end

data/lib/quandl/connection.rb

@@ -46,29 +46,29 @@ module Quandl
 
       case code_letter
       when 'L'
-        fail LimitExceededError.new(message, resp.code, resp.body, error_body,
-                                    resp.headers, code)
-      when 'M'
-        fail InternalServerError.new(message, resp.code, resp.body, error_body,
+        raise LimitExceededError.new(message, resp.code, resp.body, error_body,
                                      resp.headers, code)
+      when 'M'
+        raise InternalServerError.new(message, resp.code, resp.body, error_body,
+                                      resp.headers, code)
       when 'A'
-        fail AuthenticationError.new(message, resp.code, resp.body, error_body,
-                                     resp.headers, code)
+        raise AuthenticationError.new(message, resp.code, resp.body, error_body,
+                                      resp.headers, code)
       when 'P'
-        fail ForbiddenError.new(message, resp.code, resp.body, error_body,
-                                resp.headers, code)
+        raise ForbiddenError.new(message, resp.code, resp.body, error_body,
+                                 resp.headers, code)
       when 'S'
-        fail InvalidRequestError.new(message, resp.code, resp.body, error_body,
-                                     resp.headers, code)
+        raise InvalidRequestError.new(message, resp.code, resp.body, error_body,
+                                      resp.headers, code)
       when 'C'
-        fail NotFoundError.new(message, resp.code, resp.body, error_body,
-                               resp.headers, code)
+        raise NotFoundError.new(message, resp.code, resp.body, error_body,
+                                resp.headers, code)
       when 'X'
-        fail ServiceUnavailableError.new(message, resp.code, resp.body,
-                                         error_body, resp.headers, code)
+        raise ServiceUnavailableError.new(message, resp.code, resp.body,
+                                          error_body, resp.headers, code)
       else
-        fail QuandlError.new(message, resp.code, resp.body, error_body,
-                             resp.headers, code)
+        raise QuandlError.new(message, resp.code, resp.body, error_body,
+                              resp.headers, code)
       end
     end
   end

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/base.rb

@@ -25,6 +25,7 @@ module Quandl
     def method_missing(method_name, *args, &block)
       return @raw_data[method_name.to_s] if @raw_data.key?(method_name.to_s)
       return @raw_data.method(method_name.to_s).call(*args, &block) if @raw_data.respond_to?(method_name.to_s)
+
       super
     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'].empty? &&
+         data['dataset_data']['column_names'].length != data['dataset_data']['data'].first.length
+        raise 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)
@@ -26,6 +31,7 @@ module Quandl
 
     def method_missing(method_name, *args, &block)
       return @meta[method_name.to_s] if @meta.key?(method_name.to_s)
+
       super
     end
   end

data/lib/quandl/model/database.rb

@@ -8,31 +8,37 @@ 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?
+      raise(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
-          Quandl::Connection.handle_api_error(response) if response
-          fail(QuandlError, 'Unexpected result when fetching bulk download URI.')
+          Quandl::Connection.handle_api_error(response) if response&.body
+          raise(QuandlError, 'Unexpected result when fetching bulk download URI.')
         end
       end
       uri = URI.parse(download_url)
@@ -40,7 +46,7 @@ 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))
+        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 = File.open(file_or_folder_path, 'wb')
       end
 

data/lib/quandl/model/dataset.rb

@@ -3,11 +3,11 @@ module Quandl
     include Quandl::Operations::Get
     include Quandl::Operations::List
 
-    # rubocop:disable Style/AccessorMethodName
+    # rubocop:disable Naming/AccessorMethodName
     def self.get_path
       default_path + '/metadata'
     end
-    # rubocop:enable Style/AccessorMethodName
+    # rubocop:enable Naming/AccessorMethodName
 
     def database
       Quandl::Database.get(database_code)

data/lib/quandl/model/list.rb

@@ -10,7 +10,8 @@ module Quandl
     end
 
     def more_results?
-      fail(QuandlError, "#{@klass} does not support pagination yet") if !@meta.key?('total_pages') && !@meta.key?('current_page')
+      raise(QuandlError, "#{@klass} does not support pagination yet") if !@meta.key?('total_pages') && !@meta.key?('current_page')
+
       @meta['total_pages'] > @meta['current_page']
     end
 
@@ -19,7 +20,7 @@ module Quandl
     end
 
     def to_csv
-      fail(QuandlError, 'No values to export') if @values.empty?
+      raise(QuandlError, 'No values to export') if @values.empty?
 
       CSV.generate do |csv|
         csv << @values.first.column_names
@@ -39,6 +40,7 @@ module Quandl
       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

data/lib/quandl/operations/get.rb

@@ -10,11 +10,11 @@ module Quandl
           new(response_data[lookup_key.singularize])
         end
 
-        # rubocop:disable Style/AccessorMethodName
+        # rubocop:disable Naming/AccessorMethodName
         def get_path
           default_path
         end
-        # rubocop:enable Style/AccessorMethodName
+        # rubocop:enable Naming/AccessorMethodName
       end
     end
   end

data/lib/quandl/util.rb

@@ -1,11 +1,12 @@
 module Quandl
   class Util
     def self.methodize(string)
-      string.gsub(/\./, '').parameterize.gsub(/\-/, '_')
+      string.delete('.').parameterize.tr('-', '_')
     end
 
     def self.convert_to_dates(hash)
       return hash unless hash.is_a?(Hash)
+
       hash.update(hash) do |_k, v|
         if v.is_a?(String) && v =~ /^\d{4}-\d{2}-\d{2}$/ # Date
           Date.parse(v)

data/lib/quandl/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Quandl
-  VERSION = '1.0.1'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quandl
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 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: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,70 +17,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 5.2.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.3
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
+        version: 2.0.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -96,61 +82,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.5.0
-- !ruby/object:Gem::Dependency
-  name: rubocopter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
 description: A ruby implementation of the quandl client to be used as an ORM for quandl's
   restful APIs.
 email:
@@ -193,10 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: An ORM interface into the quandl api.
 test_files: []
-has_rdoc: