quandl_client 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e81aaa8f303bf326b11226513522ddfe29c7e408
-  data.tar.gz: dc1c441e7569562647ce575105ee7ee9fa689858
+  metadata.gz: 96bcb5f9ffb52af6a7448692809d6a6780353eea
+  data.tar.gz: 3c54dcbb44783c244fab3635dd5386b15a45edd9
 SHA512:
-  metadata.gz: 6dff6e5349a2e01375699d7a953c24569d849c3d113e5d32d7caa24e25f8f486139cc4d1db58dc8fabda7f9c355c14ef7f96121f14028e784215092a56d5f83b
-  data.tar.gz: 6698073bfb90697f063c2562b35f37cb0017b6210c1fef9803d50a7671125aed03a3ce7f37cbabad04291978c4376d03a7111c8ec7d22b8a4cb3e22ca94ca05c
+  metadata.gz: 2a5687a55d8381f1e6dbcf80c8d722a74c9681da244c6f7d44659d8ab77b9f245c8f67bca8ec9eb33a796e49b29996d483ccac85f5f8c40a7beca9d1543c778e
+  data.tar.gz: 2189f13d9f07eab27de81362e2554180cc964034d48c89ab127ac260beb2758fd3906f88577272da91c9e8730444d1c1aa4840d059f217a7cbf75a8b7f3e7494

data/UPGRADE.md

@@ -1,3 +1,12 @@
+## 2.3.0
+
+* add auth_token attribute to user
+* add Quandl::Client::User, .login for authenticating
+* full_url outputs the quandl link instead of the api link. Add human_status and HTTP_STATUS_CODES
+* should validate display_url as a url
+* add reference_url alias for display_url. reference_url will automatically add http when missing
+
+
 ## 2.2.1
 
 * full_code: dont assume that source_code is present

data/examples/login.rb

@@ -0,0 +1,13 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'pry'
+require "quandl/client"
+
+include Quandl::Client
+
+Quandl::Client.use ENV['QUANDL_API_HOST']
+Quandl::Client.token = ENV['QUANDL_USER_TOKEN']
+
+u = User.login( login: 'blakehil', password: 'example' )
+
+binding.pry

data/lib/quandl/client/base/validation.rb

@@ -38,6 +38,10 @@ module Validation
       status > 0
     end
     
+    def human_status
+      Quandl::Client::HTTP_STATUS_CODES[status]
+    end
+    
     def status
       metadata[:status].to_i
     end
@@ -70,6 +74,21 @@ module Validation
     def halt_unless_valid!
       return false unless valid?
     end
+    
+    class UrlValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        begin
+          uri = URI.parse(value)
+          resp = uri.kind_of?(URI::HTTP)
+          
+        rescue URI::InvalidURIError
+          resp = false
+        end
+        unless resp == true
+          record.errors[attribute] << (options[:message] || "is not an url")
+        end
+      end
+    end
      
   end
 end

data/lib/quandl/client/base.rb

@@ -15,7 +15,7 @@ class Quandl::Client::Base
     attr_accessor :url, :token
   
     def use(url)
-      self.url = File.join( url, Quandl::Client.api_version )
+      self.url = url
       models_use_her_api!
     end
     
@@ -25,7 +25,7 @@ class Quandl::Client::Base
     end
     
     def her_api
-      Her::API.new.setup url: url do |c|
+      Her::API.new.setup url: url_with_version do |c|
         c.use TokenAuthentication
         c.use Faraday::Request::UrlEncoded
         c.use Quandl::Client::Middleware::ParseJSON
@@ -34,7 +34,11 @@ class Quandl::Client::Base
     end
 
     def url
-      @url ||= "http://localhost:3000/api/#{Quandl::Client.api_version}/"
+      @url ||= "http://quandl.com/api/"
+    end
+
+    def url_with_version
+      File.join( url.to_s, Quandl::Client.api_version.to_s )
     end
     
     def inherited(subclass)
@@ -57,7 +61,7 @@ class Quandl::Client::Base
     
     def models_use_her_api!
       models.each{|m|
-        m.url = url
+        m.url = url_with_version
         m.use_api( her_api ) 
       }
     end

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

@@ -10,7 +10,7 @@ class Quandl::Client::Dataset < Quandl::Client::Base
   ##########
   
   def self.touch_existing(id)
-    put(File.join(Quandl::Client::Base.url, "datasets/#{id}/touch")).exists?
+    put(File.join(Quandl::Client::Base.url_with_version, "datasets/#{id}/touch")).exists?
   end
   
   # SEARCH
@@ -31,7 +31,7 @@ class Quandl::Client::Dataset < Quandl::Client::Base
   ###############
   
   validates :code, presence: true, format: { with: /[A-Z0-9_]+/ }
-  validates :name, presence: true, :length => { :maximum => 1000 }
+  validates :display_url, allow_blank: true, url: true
   
   
   ##############
@@ -49,8 +49,15 @@ class Quandl::Client::Dataset < Quandl::Client::Base
   alias_method :locations, :locations_attributes
   alias_method :locations=, :locations_attributes=
   
+  def reference_url
+    self.display_url
+  end
+  def reference_url=(value)
+    self.display_url = value
+  end
+  
   def full_url
-    File.join(Quandl::Client::Dataset.url, 'datasets', full_code)
+    File.join(Quandl::Client::Base.url.gsub('api/', ''), full_code)
   end
   
   def full_code

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

@@ -0,0 +1,7 @@
+class Quandl::Client::User < Quandl::Client::Base
+  
+  custom_post :login
+  
+  attributes :auth_token
+  
+end

data/lib/quandl/client/version.rb

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

data/lib/quandl/client.rb

@@ -11,9 +11,11 @@ require 'quandl/client/base'
 require 'quandl/client/models/dataset'
 require 'quandl/client/models/sheet'
 require 'quandl/client/models/source'
+require 'quandl/client/models/user'
 
 module Quandl
   module Client
+    
     def self.use(url)
       Quandl::Client::Base.use(url)
     end
@@ -21,5 +23,7 @@ module Quandl
       Quandl::Client::Base.token = value
     end
     
+    HTTP_STATUS_CODES = {100=>"Continue", 101=>"Switching Protocols", 102=>"Processing", 200=>"OK", 201=>"Created", 202=>"Accepted", 203=>"Non-Authoritative Information", 204=>"No Content", 205=>"Reset Content", 206=>"Partial Content", 207=>"Multi-Status", 208=>"Already Reported", 226=>"IM Used", 300=>"Multiple Choices", 301=>"Moved Permanently", 302=>"Found", 303=>"See Other", 304=>"Not Modified", 305=>"Use Proxy", 306=>"Reserved", 307=>"Temporary Redirect", 308=>"Permanent Redirect", 400=>"Bad Request", 401=>"Unauthorized", 402=>"Payment Required", 403=>"Forbidden", 404=>"Not Found", 405=>"Method Not Allowed", 406=>"Not Acceptable", 407=>"Proxy Authentication Required", 408=>"Request Timeout", 409=>"Conflict", 410=>"Gone", 411=>"Length Required", 412=>"Precondition Failed", 413=>"Request Entity Too Large", 414=>"Request-URI Too Long", 415=>"Unsupported Media Type", 416=>"Requested Range Not Satisfiable", 417=>"Expectation Failed", 422=>"Unprocessable Entity", 423=>"Locked", 424=>"Failed Dependency", 425=>"Reserved for WebDAV advanced collections expired proposal", 426=>"Upgrade Required", 427=>"Unassigned", 428=>"Precondition Required", 429=>"Too Many Requests", 430=>"Unassigned", 431=>"Request Header Fields Too Large", 500=>"Internal Server Error", 501=>"Not Implemented", 502=>"Bad Gateway", 503=>"Service Unavailable", 504=>"Gateway Timeout", 505=>"HTTP Version Not Supported", 506=>"Variant Also Negotiates (Experimental)", 507=>"Insufficient Storage", 508=>"Loop Detected", 509=>"Unassigned", 510=>"Not Extended", 511=>"Network Authentication Required"}
+    
   end
 end

data/quandl_client.gemspec

@@ -22,16 +22,14 @@ Gem::Specification.new do |s|
   s.add_development_dependency "factory_girl_rails"
   s.add_development_dependency "fivemat", "~> 1.2"
   s.add_development_dependency "pry"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+
+  s.add_runtime_dependency "quandl_data", "~> 1.2"
 
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
   s.add_runtime_dependency "her", "~> 0.6"
   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"
-  s.add_runtime_dependency "quandl_data", "~> 1.2"
-  
-
-  s.add_development_dependency "guard"
-  s.add_development_dependency "guard-rspec"
 end

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

@@ -10,6 +10,26 @@ describe Dataset do
   }
   subject{ create(:dataset, source_code: source.code, private: true ) }
   
+  describe "#reference_url" do
+    let(:url){ "http://website.com/path/to/reference" }
+    let(:dataset){ Dataset.new( reference_url: url, code: "VALID" ) }
+    subject{ dataset }
+    
+    its(:reference_url){ should eq url }
+    its(:valid?){ should be_true }
+    
+    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 }
+    end
+    
+  end
+  
   describe "#private" do
     
     it "should update to false" do

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

@@ -7,6 +7,7 @@ describe Dataset do
   subject{ dataset }
   
   context "admin user" do
+
     its(:saved?){ should be_true }
     its(:source_code){ should be_present }
     

data/spec/lib/quandl/client/dataset_spec.rb

@@ -15,11 +15,12 @@ describe Dataset do
   end
   
   it "should change url" do
+    original_url = Quandl::Client::Base.url
     Quandl::Client.use('http://url.com/')
     Quandl::Client::Dataset.url.should eq 'http://url.com/v2'
     Quandl::Client.use('http://url.com/2/')
     Quandl::Client::Dataset.url.should eq 'http://url.com/2/v2'
-    Quandl::Client.use ENV['QUANDL_API_HOST']
+    Quandl::Client.use original_url
   end
   
   describe ".query" do

data/spec/spec_helper.rb

@@ -10,6 +10,14 @@ Dir.glob( factory_dir ).each{|f| require(f); puts f }
 require "quandl/client"
 require "quandl/fabricate"
 
+# Expects two env variables:
+
+# administrator:
+# ENV['QUANDL_AUTH_TOKEN'] 
+
+# user:
+# ENV['QUANDL_USER_TOKEN']
+
 include Quandl::Client
 Quandl::Client.token = ENV['QUANDL_AUTH_TOKEN']
 Quandl::Client.use ENV['QUANDL_API_HOST']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_client
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,117 +81,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: her
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
+  name: quandl_data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: scope_composer
+  name: her
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: quandl_data
+  name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.7.7
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: scope_composer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 description: An orm for the cassinatra rest interface.
 email:
 - blake@hilscher.ca
@@ -210,6 +210,7 @@ files:
 - Rakefile
 - UPGRADE.md
 - examples/create.rb
+- examples/login.rb
 - examples/search.rb
 - examples/trims.rb
 - lib/quandl/client.rb
@@ -224,6 +225,7 @@ files:
 - lib/quandl/client/models/dataset/data.rb
 - lib/quandl/client/models/sheet.rb
 - lib/quandl/client/models/source.rb
+- lib/quandl/client/models/user.rb
 - lib/quandl/client/version.rb
 - lib/quandl/her/remove_method_data.rb
 - quandl_client.gemspec