quandl_client 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90fc4b658334f8b64a152c8856d1d5746d2f30d6
-  data.tar.gz: dfd804e1df9105ef39ab391f5af287dd2b96bf9c
+  metadata.gz: 3018260bc400c7f59310d511e13cb51bfbffe97c
+  data.tar.gz: 4ab1e74283f845bb3dee3521c18367afc4d9a8ad
 SHA512:
-  metadata.gz: 5c03db4abbe8ba3b1b815be22c42f7dbdc435c770e69ad9a3adadb454b129b306a6bb35f456da4cd765c8fd480898d38237653f0ffb28d7dfe3c34d960e9cb50
-  data.tar.gz: 93bc9a5a89cd0bdefecc6fc9a183ed89c59bf7e83879cf6d1471b8a8ca1c446b50a391f493e732e45ba4f9cc41fb7eadf167b957cea75a7e1503b3b477267c2b
+  metadata.gz: 0c1931a9c197ae51d561b1dea40675ba24cca2247262b1c157fcbc78956738d0fd8be26b3c9aee7dd9c8a7c7498336486853debe63e2f0f2a6882b22de6349a5
+  data.tar.gz: 86c0a7a0f16a237c7cd8d38a1b0ddbfefaaaa675516857740b245374790507392ff457583c57692bc8a946e6a3b307e22bad7eecc6e07452e817910356ff793d

data/UPGRADE.md

@@ -1,3 +1,9 @@
+# 2.5.1
+
+* QUGC-57 move data validation from Quandl::Format into Quandl::Client. Data validations only run on #valid?
+* QUGC-53 numeric codes require the full code
+
+
 # 2.5.0
 
 * remove yajl

data/examples/create.rb

@@ -15,4 +15,18 @@ include Quandl::Client
 Quandl::Client.use ENV['QUANDL_TEST_URL']
 Quandl::Client.token = ENV['QUANDL_TEST_TOKEN']
 
-binding.pry
+# set some attributes
+d = Dataset.new(
+  code:           "MY_DATASET_#{Time.now.to_i.to_s(16)}", 
+  name:           "My dataset has a name.",
+  description:    "This is the description.",
+  data:           [[ 2014, 1, 2 ]]
+)
+# POST to server
+d.save
+
+if d.saved?
+  puts "View your new dataset at: #{d.full_url}"
+else
+  puts "Something went wrong:\n#{d.human_status}\n#{d.human_error_messages}"
+end

data/examples/find.rb

@@ -0,0 +1,18 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+# DEBUGGING
+require 'pry'
+require "quandl/fabricate"
+
+# LOAD
+require "quandl/client"
+include Quandl::Client
+
+# CONFIGURE
+Quandl::Client.use ENV['QUANDL_URL']
+Quandl::Client.token = ENV['QUANDL_TOKEN']
+
+# FIND
+d = Dataset.find('MCX.ALMG2014')
+
+binding.pry

data/lib/quandl/client/models/dataset.rb

@@ -14,7 +14,7 @@ class Quandl::Client::Dataset < Quandl::Client::Base
       # enforce code formatting
       if value.is_a?(String)
         # ensure slashes are forward facing
-        value = value.gsub("\\","/")
+        value = value.gsub("\\","/").gsub(".","/")
         # ensure uppercase
         value = value.upcase
       end
@@ -45,6 +45,10 @@ class Quandl::Client::Dataset < Quandl::Client::Base
   validates :code, presence: true, format: { with: Quandl::Pattern.code, message: "is invalid. Expected format: #{Quandl::Pattern.code.to_example}" }
   validates :display_url, allow_blank: true, url: true
   validate :data_columns_should_not_exceed_column_names!
+  validate :data_rows_should_have_equal_columns!
+  validate :data_row_count_should_match_column_count!
+  validate :ambiguous_code_requires_source_code!
+  
   
   ##############
   # PROPERTIES #
@@ -121,6 +125,15 @@ class Quandl::Client::Dataset < Quandl::Client::Base
   
   protected
   
+  def ambiguous_code_requires_source_code!
+    if code.to_s.numeric? && source_code.blank?
+      message = %Q{Pure numerical codes like "#{code}" are not allowed unless you prefix them with a source code. Do this:\ncode: <your-username>/#{code}}
+      self.errors.add( :data, message )
+      return false
+    end
+    true 
+  end
+  
   def data_columns_should_not_exceed_column_names!
     if dataset_data.data? && column_names.present? && data.first.count != column_names.count
       self.errors.add( :data, "You may not change the number of columns in a dataset. This dataset has #{column_names.count} columns but you tried to send #{data.first.count} columns." )
@@ -129,6 +142,40 @@ class Quandl::Client::Dataset < Quandl::Client::Base
     true 
   end
   
+  def data_rows_should_have_equal_columns!
+    # skip validation unless data is present
+    return true unless dataset_data.data?
+    # use first row as expected column count
+    column_count = data[0].count
+    # check each row
+    data.each_with_index do |row, index|
+      # the row is valid if it's count matches the first row's count
+      next if row.count == column_count
+      # the row is invalid if the count is mismatched
+      self.errors.add( :data, "Unexpected number of points in this row '#{row}'. Expected #{column_count} but found #{row.count} based on #{data[0]}" )
+      # return validation failure
+      return false
+    end
+    true
+  end
+  
+  def data_row_count_should_match_column_count!
+    # skip validation unless data and column_names present
+    return true unless dataset_data.data? && column_names.present?
+    # count the number of expected columns
+    column_count = column_names.count
+    # check each row
+    data.each_with_index do |row, index|
+      # the row is valid if it's count matches the first row's count
+      next if row.count == column_count
+      # the row is invalid if the count is mismatched
+      self.errors.add( :data, "Unexpected number of points in this row '#{row}'. Expected #{column_names.count} but found #{row.count} based on #{column_names}" )
+      # return validation failure
+      return false
+    end
+    true
+  end
+  
   def save_dataset_data
     return if (!saved? && id.blank?)
     return if !dataset_data.data?

data/lib/quandl/client/version.rb

@@ -1,6 +1,6 @@
 module Quandl
 module Client
-  VERSION = '2.5.0'
+  VERSION = '2.5.1'
   API_VERSION = 'v2'
   
   class << self

data/spec/lib/quandl/client/dataset/validation_spec.rb

@@ -3,6 +3,32 @@ require 'spec_helper'
 
 describe Dataset do
   
+  let(:dataset){ build(:dataset, source_code: "QUANDL_CLIENT_TEST_SOURCE" ) }
+  subject{ dataset }
+  
+  context "given ambiguous code" do
+    before(:each){ 
+      dataset.source_code = nil
+      dataset.code = '12345'
+      dataset.valid?
+    }
+    its(:valid?){ should be_false }
+    its('errors.messages'){ should eq({ data: ["Pure numerical codes like \"12345\" are not allowed unless you prefix them with a source code. Do this:\ncode: <your-username>/12345"]}) }
+  end
+  
+  context "mismatch row count" do
+    before(:each){ dataset.data = [[2012, 1,2],[2011, 1,2,3]] }
+    its(:valid?){ should be_false }
+  end
+  
+  context "mismatch column_names count" do
+    before(:each){
+      dataset.column_names = ['Date','Value']
+      dataset.data = [[2012, 1,2],[2011, 1,2]]
+    }
+    its(:valid?){ should be_false }
+  end
+  
   describe "#code" do
 
     before(:all){ Quandl::Client.token = ENV['QUANDL_AUTH_TOKEN'] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_client
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -196,6 +196,7 @@ files:
 - Rakefile
 - UPGRADE.md
 - examples/create.rb
+- examples/find.rb
 - examples/login.rb
 - examples/search.rb
 - examples/trims.rb