quandl_client 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cbfcdc4f840923e85b3dce389da7ab5757292e7
-  data.tar.gz: 4c6beabf2a4649dfa4c1c0a59576b74a4b0822f7
+  metadata.gz: 6bdbf7c4522f4761addb5805c1ff9f7933021ee8
+  data.tar.gz: 26ed1147332cde5d16d202662bfda14b784e46db
 SHA512:
-  metadata.gz: 73f5b8521d90663b8f2321c389471260255a9164c1ffa9c7f8145554a8f796101d2c9b7c63f7d4bda7ec5840f52198c75e7a1fce0efd45d5e3367b3dbc900f2e
-  data.tar.gz: 2c31963ac71365a060f5e7bb29e4489cecd834f5b15ee81a4d35afbdbfff65bc5ece3914ab40e6ec4579b32c477ef391c7863098245b804c9cb228fc824ef7c6
+  metadata.gz: f06923fbaafc6eb86326796a3355b09a3e25214ccd4626ec3d5bcff7549439483283fb26713ca297da2da14d7fcc86b427333d762b9ad0a1858de179409d0bd4
+  data.tar.gz: 68ee14e21b88d24f9d3a89a2703ee1c6a8a5a3031c13ecc9b3c84fc797636cd6f4b7dbdeed37b62b4e9ae8a818bc62e973a7afd96ed7f631763861395cc96c19

data/UPGRADE.md

@@ -1,3 +1,9 @@
+# 2.4.0
+
+* Dataset#reference_url should prepend of http:// when missing
+* add Quandl::Pattern for defining regex patterns with embedded examples
+
+
 # 2.3.2
 
 * add #elapsed_request_time_ms

data/examples/create.rb

@@ -1,14 +1,18 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
-require 'pry'
+# load quandl api client
 require "quandl/client"
+
+# tools for debugging
 require "quandl/fabricate"
 require 'securerandom'
+require 'pry'
 
+# Make Dataset available in global namespace
 include Quandl::Client
 
+# configure quandl client
 Quandl::Client.use ENV['QUANDL_API_HOST']
 Quandl::Client.token = ENV['QUANDL_USER_TOKEN']
-# Quandl::Client.use 'http://quandl.com/api/'
 
 binding.pry

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

@@ -2,9 +2,6 @@ class Quandl::Client::Dataset < Quandl::Client::Base
   
   require 'quandl/client/models/dataset/data'
 
-  # parse_root_in_json true
-  # root_element :docs
-  
   ##########  
   # SCOPES #
   ##########
@@ -30,10 +27,9 @@ class Quandl::Client::Dataset < Quandl::Client::Base
   # VALIDATIONS #
   ###############
   
-  validates :code, presence: true, format: { with: /[A-Z0-9_]+/ }
+  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
   
-  
   ##############
   # PROPERTIES #
   ##############
@@ -46,6 +42,8 @@ class Quandl::Client::Dataset < Quandl::Client::Base
     
   before_save :enforce_required_formats
   
+  after_save :save_dataset_data
+  
   alias_method :locations, :locations_attributes
   alias_method :locations=, :locations_attributes=
   
@@ -53,6 +51,7 @@ class Quandl::Client::Dataset < Quandl::Client::Base
     self.display_url
   end
   def reference_url=(value)
+    value = "http://#{value}" if value.present? && !(value =~ /http:\/\//)
     self.display_url = value
   end
   
@@ -104,8 +103,6 @@ class Quandl::Client::Dataset < Quandl::Client::Base
     @full_code = nil
   end
   
-  after_save :save_dataset_data
-  
   protected
   
   def save_dataset_data

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

@@ -25,7 +25,7 @@ class Source < Quandl::Client::Base
   # VALIDATIONS #
   ###############
    
-  validates :code, presence: true, length: { minimum: 2 }, format: { with: /([A-Z0-9_]+)/ }
+  validates :code, presence: true, length: { minimum: 2 }, format: { with: Quandl::Pattern.code, message: "is invalid. Expected format: #{Quandl::Pattern.code.to_example}" }
   validates :host, :name, presence: true
   
 

data/lib/quandl/client/version.rb

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

data/lib/quandl/client.rb

@@ -6,6 +6,9 @@ require 'quandl/her/remove_method_data'
 require 'quandl/logger'
 require "quandl/data"
 
+require 'quandl/pattern'
+require 'quandl/pattern/client'
+
 require 'quandl/client/middleware'
 require 'quandl/client/base'
 require 'quandl/client/models/dataset'

data/lib/quandl/pattern/client.rb

@@ -0,0 +1,9 @@
+module Quandl
+class Pattern
+  
+  define_pattern :dataset_date, /[0-9]{4}\-[0-9]{2}\-[0-9]{2}/, example: "yyyy-mm-dd"
+  define_pattern :code, /[A-Z0-9_]{3,}+/, example: 'ALPHA_NUMERIC_1024'
+  define_pattern :full_code, /(#{code}\/)?(#{code})/, example: "(SOURCE_CODE/)#{code.to_example}"
+  
+end
+end

data/lib/quandl/pattern.rb

@@ -0,0 +1,38 @@
+module Quandl
+class Pattern < Regexp
+  
+  class << self
+  
+    def define_pattern(name, pattern, options={})
+      assert_unique_pattern!(name, pattern)
+      patterns << name 
+      define_singleton_method(name){ Quandl::Pattern.new( pattern, options ) }
+    end
+    
+    def assert_unique_pattern!(name, pattern)
+      return false unless self.respond_to?(name)
+      message = "Attempted to redefine previously defined pattern! '#{name}', /#{pattern}/"
+      raise ArgumentError.new(name), message
+    end
+    
+    def patterns
+      @patterns ||= []
+    end
+  
+  end
+  
+  def initialize(*args)
+    @options = args.pop if args.last.is_a?(Hash)
+    super(*args)
+  end
+  
+  def to_example
+    options[:example]
+  end
+  
+  def options
+    @options ||= {}
+  end
+  
+end
+end

data/quandl_client.gemspec

@@ -32,4 +32,4 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "yajl-ruby", "~> 1.1.0"
   s.add_runtime_dependency 'json', '~> 1.7.7'
   s.add_runtime_dependency "scope_composer", "~> 0.3"
-end
+end

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

@@ -10,6 +10,12 @@ describe Dataset do
   }
   subject{ create(:dataset, source_code: source.code, private: true ) }
   
+  describe "#name" do
+    subject{ create(:dataset, source_code: source.code, private: true, name: '' ) }
+    
+    its(:name){ should match /Untitled Dataset #{Date.today}/ }
+  end
+  
   describe "#reference_url" do
     let(:url){ "http://website.com/path/to/reference" }
     let(:dataset){ Dataset.new( reference_url: url, code: "VALID" ) }
@@ -20,12 +26,8 @@ describe Dataset do
     
     context "partial url" do
       let(:url){ "website.com/path/to/reference" }
-      its(:valid?){ should be_false }
-    end
-    
-    context "invalid url" do
-      let(:url){ "website" }
-      its(:valid?){ should be_false }
+      its(:reference_url){ should eq "http://website.com/path/to/reference" }
+      its(:valid?){ should be_true }
     end
     
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_client
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -228,6 +228,8 @@ files:
 - lib/quandl/client/models/user.rb
 - lib/quandl/client/version.rb
 - lib/quandl/her/remove_method_data.rb
+- lib/quandl/pattern.rb
+- lib/quandl/pattern/client.rb
 - quandl_client.gemspec
 - spec/factories/dataset.rb
 - spec/factories/sheet.rb