quandl_client 0.0.4 → 0.0.5

data/README.md

@@ -68,7 +68,7 @@ d.data_table
 ```ruby
 
 attributes = {
-  code:         "TEST_12345",
+  code:         "TEST_#{Time.now.to_i}",
   source_code:  'OFDP',
   name:         "Test Upload #{Time.now.to_i}",
   frequency:    'daily',
@@ -86,33 +86,51 @@ d = Dataset.create( attributes )
 
 ```
 
-##### Errors
-
-```ruby
-
-d = Dataset.create(code: 'TEST', source_code: 'OFDP', locations_attributes: [{ type: 'http', url: 'test.com' }] )
-d.errors
-=>  {"locations.post_data"=>["can't be blank"], "locations.cookie_url"=>["can't be blank"], "name"=>["can't be blank"], "frequency"=>["is not included in the list"]}
-
-```
-
 
 #### Update
 
 ```ruby
 
-d = Dataset.find("OFDP/TEST_12345")
+d = Dataset.find( d.full_code )
 d.name = 'New Name'
 d.data = Quandl::Data::Random.table.to_csv
 d.save
 
-d = Dataset.collapse(:weekly).find("OFDP/TEST_12345")
+d = Dataset.collapse(:weekly).find( d.full_code )
 d.data
 => [[...],...]
 
 ```
 
 
+#### Delete
+
+```ruby
+
+Dataset.destroy_existing('SOME_SOURCE/SOME_CODE')
+Dataset.destroy_existing(52352)
+
+Dataset.find('SOME_SOURCE/SOME_CODE')
+=> nil
+
+```
+
+
+#### Error Handling
+
+```ruby
+
+d = Dataset.create(code: 'TEST', source_code: 'OFDP', locations: [{ type: 'http', url: 'test.com' }] )
+d.error_messages
+=>  {:name=>["can't be blank"]}
+
+d = Dataset.create(name: 'asdfs', code: 'TEST', source_code: 'OFDP', locations: [{ type: 'http', url: 'test.com' }] )
+d.error_messages
+=>  {"code"=>["has already been taken"], "frequency"=>["is not included in the list"]}
+
+```
+
+
 
 
 ## Quandl::Client::Source
@@ -122,9 +140,9 @@ d.data
 
 ```ruby
 
-sources = Quandl::Client::Source.query('canada').page(2).all
+sources = Quandl::Client::Source.query('can').all
 
-=> [#<Quandl::Client::Source(sources) code="STATCAN1" title="Stat Can">,...]
+=> [#<Quandl::Client::Source(sources/413) code="STATSCAN5" datasets_count=1>...]
 
 ```
 
@@ -133,7 +151,45 @@ sources = Quandl::Client::Source.query('canada').page(2).all
 
 ```ruby
 
-sheet = Quandl::Client::Source.find('STATCAN1')
+s = Quandl::Client::Source.find('STATSCAN5')
+
+```
+
+
+#### Create
+
+```ruby
+
+s = Source.create( code: 'test' )
+s.valid?
+s.error_messages
+=> {:code=>["is invalid"], :host=>["can't be blank"], :name=>["can't be blank"]}
+
+s = Source.create(code: %Q{TEST_#{Time.now.to_i}}, name: 'asdf', host: "http://asdf#{Time.now}.com" )
+s.saved?
+=> true
+
+```
+
+
+#### Update
+
+```ruby
+
+s = Source.find(s.code)
+s.name = "Updated Name #{Time.now.to_i}"
+s.code = "DATA_#{Time.now.to_i}"
+s.save
+
+```
+
+
+#### Delete
+
+```ruby
+
+Source.destroy_existing('SOMESOURCE')
+Source.destroy_existing(52352)
 
 ```
 
@@ -166,11 +222,12 @@ sheet = Quandl::Client::Sheet.find('housing/hood')
 
 ```ruby
 
-include Quandl::Client
+s = Quandl::Client::Sheet.create( title: 'ocean' )
+s = Quandl::Client::Sheet.create( full_url_title: 'ocean/river', title: 'River' )
+s = Quandl::Client::Sheet.create( full_url_title: 'ocean/river/lake', title: 'Lake!' )
 
-s = Sheet.create( title: 'ocean' )
-s = Sheet.create( full_url_title: 'ocean/river', title: 'River' )
-s = Sheet.create( full_url_title: 'ocean/river/lake', title: 'Lake!' )
+Sheet.find('ocean/river/lake').title
+=> 'Lake!'
 
 Sheet.find('ocean').children.first.title
 => River
@@ -182,15 +239,24 @@ Sheet.find('ocean').children.first.title
 
 ```ruby
 
-Quandl::Client.token = 'xyz'
-
-s = Quandl::Client::Sheet.find_by_url_title('hi_there')
-s.title = 'another title'
+s = Quandl::Client::Sheet.find('ocean/river')
+s.title = "River #{Time.now.to_i}"
 s.save
 
 ```
 
 
+#### Delete
+
+```ruby
+
+Quandl::Client::Sheet.destroy_existing('ocean/river/lake')
+
+Quandl::Client::Sheet.destroy_existing(15252)
+
+```
+
+
 
 
 # Authentication

data/lib/quandl/client/base.rb

@@ -0,0 +1,12 @@
+require 'scope_builder'
+require "quandl/data"
+
+module Quandl
+module Client
+
+class Base
+  
+end
+
+end
+end

data/lib/quandl/client/concerns/properties.rb

@@ -0,0 +1,33 @@
+module Quandl
+module Client
+module Concerns
+  
+module Properties
+  extend ActiveSupport::Concern
+
+  included do
+
+    include Her::Model
+    use_api Client.her_api
+  
+    before_save :halt_unless_valid!
+    
+    def error_messages
+      valid?
+      m = errors.messages.to_h || {}
+      e = self.attributes[:errors].to_h || {}
+      m.deep_merge(e)
+    end
+    
+    protected
+  
+    def halt_unless_valid!
+      return false unless valid?
+    end
+    
+  end      
+end
+
+end
+end
+end

data/lib/quandl/client/concerns/search.rb

@@ -0,0 +1,26 @@
+module Quandl
+module Client
+module Concerns
+  
+module Search
+  extend ActiveSupport::Concern
+
+  included do
+
+    include ScopeBuilder::Model
+  
+    scope_builder_for :search
+
+    search_helper :all, ->{ connection.where(attributes).fetch }
+    search_helper :connection, -> { self.class.parent }
+
+    search_scope.class_eval do
+      delegate *Array.forwardable_methods, to: :all
+    end
+
+  end      
+end
+
+end
+end
+end

data/lib/quandl/client/concerns.rb

@@ -0,0 +1,17 @@
+require "active_support"
+require "active_support/inflector"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/object"
+
+require 'quandl/client/concerns/search'
+require 'quandl/client/concerns/properties'
+
+module Quandl
+module Client
+  
+module Concerns
+
+end
+
+end
+end

data/lib/quandl/client/her.rb

@@ -1,3 +1,6 @@
+require 'her'
+require 'quandl/her/patch'
+
 module Quandl
 module Client
   class << self

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

@@ -1,18 +1,71 @@
-require 'quandl/client/models/dataset/searchable'
-require 'quandl/client/models/dataset/properties'
-
 module Quandl
 module Client
 
 class Dataset
   
-  include Properties
-  include Searchable
+  include Concerns::Search
+  include Concerns::Properties
+  
+  
+  ##########  
+  # SCOPES #
+  ##########
+  
+  # SEARCH
+  search_scope :query, :rows
+  search_scope :page, ->(p){ where( page: p.to_i )}
+  search_scope :source_code, ->(c){ where( code: c.to_s.upcase )}
+  
+  # SHOW
+  scope_builder_for :show
+  show_scope :rows, :exclude_data, :exclude_headers, :trim_start, :trim_end, :transform, :collapse
+  show_helper :find, ->(id){ connection.where(attributes).find( id ) }
+  show_helper :connection, -> { self.class.parent }
   
+  
+  ###############
+  # ASSOCIATIONS #
+  ###############
+   
   def source
     @source ||= Source.find(self.source_code)
   end
   
+  
+  ###############
+  # VALIDATIONS #
+  ###############
+   
+  validates :source_code, presence: true, length: { minimum: 2 }, format: { with: /^([A-Z][A-Z0-9_]+)$/ }
+  validates :code, presence: true, length: { minimum: 2 }, format: { with: /^([A-Z][A-Z0-9_]+)$/ }
+  validates :name, presence: true
+  
+  
+  ##############
+  # PROPERTIES #
+  ##############
+    
+  attributes :data, :source_code, :code, :name, :urlize_name, 
+    :description, :updated_at, :frequency, :from_date, 
+    :to_date, :column_names, :private, :type
+    
+  attributes :locations_attributes
+  
+  alias_method :locations, :locations_attributes
+  alias_method :locations=, :locations_attributes=
+  
+  def full_code
+    @full_code ||= File.join(self.source_code, self.code)
+  end
+
+  def data_table
+    Data::Table.new( raw_data )
+  end
+  
+  def raw_data
+    @raw_data ||= (self.data || Dataset.find(full_code).data || [])
+  end
+  
 end
 
 end

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

@@ -1,31 +1,22 @@
-require 'quandl/client/models/dataset/searchable'
-require 'quandl/client/models/dataset/properties'
-
 module Quandl
 module Client
 
 class Sheet
-
-  include ScopeBuilder::Model
   
-  scope_builder_for :search
+  include Concerns::Search
+  include Concerns::Properties
+  
+  
+  ##########  
+  # SCOPES #
+  ##########
   
   search_scope :query, :page, :parent_url_title
-  search_helper :all, ->{ connection.where(attributes).fetch.to_a }
-  search_helper :connection, -> { self.class.parent }
-
-  search_scope.class_eval do
-    delegate *Array.forwardable_methods, to: :all
-  end
   
-  # ORM
-  include Her::Model
-  use_api Client.her_api
-  attributes :title, :content, :url_title, :full_url_title
   
-  def html
-    @html ||= self.attributes[:html] || Sheet.find(full_url_title).attributes[:html]
-  end
+  ###############
+  # ASSOCIATIONS #
+  ###############
   
   def parent
     @parent ||= Sheet.find(parent_url_title)
@@ -35,10 +26,29 @@ class Sheet
     Sheet.parent_url_title(self.full_url_title)
   end
   
+  
+  ###############
+  # VALIDATIONS #
+  ###############
+  
+  validates :title, presence: true
+  
+
+  ##############
+  # PROPERTIES #
+  ##############
+  
+  attributes :title, :content, :url_title, :full_url_title
+  
+  def html
+    @html ||= self.attributes[:html] || Sheet.find(full_url_title).attributes[:html]
+  end
+  
   def parent_url_title
     @parent_url_title ||= self.full_url_title.split('/')[0..-2].join()
   end
   
+  
 end
 
 end

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

@@ -1,38 +1,42 @@
-require 'quandl/client/models/dataset/searchable'
-require 'quandl/client/models/dataset/properties'
-
 module Quandl
 module Client
 
 class Source
-
-  include ScopeBuilder::Model
   
-  scope_builder_for :search
+  include Concerns::Search
+  include Concerns::Properties
+  
+  ##########  
+  # SCOPES #
+  ##########
   
   search_scope :query
   search_scope :page, ->(p){ where( page: p.to_i )}
   search_scope :code, ->(c){ where( code: c.to_s.upcase )}
   
-  search_helper :all, ->{ connection.where(attributes).fetch }
-  search_helper :connection, -> { self.class.parent }
-
-  search_scope.class_eval do
-    delegate *Array.forwardable_methods, to: :all
-  end
   
-  # ORM
-  include Her::Model
-  use_api Client.her_api
-  attributes :code, :datasets_count, :description, :name, :host
+  ###############
+  # ASSOCIATIONS #
+  ###############
   
   def datasets
     Dataset.source_code(code)
   end
   
-  def id
-    'show'
-  end
+  
+  ###############
+  # VALIDATIONS #
+  ###############
+   
+  validates :code, presence: true, length: { minimum: 2 }, format: { with: /^([A-Z][A-Z0-9_]+)$/ }
+  validates :host, :name, presence: true
+  
+
+  ##############
+  # PROPERTIES #
+  ##############
+   
+  attributes :code, :name, :host, :description, :datasets_count, :use_proxy, :type, :concurrency
   
 end
 

data/lib/quandl/client/version.rb

@@ -1,6 +1,6 @@
 module Quandl
 module Client
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
   API_VERSION = 'v1'
   
   class << self

data/lib/quandl/client.rb

@@ -5,12 +5,9 @@ require "active_support/inflector"
 require "active_support/core_ext/hash"
 require "active_support/core_ext/object"
 
-require 'her'
-require 'quandl/her/patch'
-require 'scope_builder'
-require "quandl/data"
-
 require 'quandl/client/her'
+require 'quandl/client/concerns'
+require 'quandl/client/base'
 require 'quandl/client/models'
 
 module Quandl

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quandl_client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -188,11 +188,13 @@ files:
 - Rakefile
 - UPGRADE.md
 - lib/quandl/client.rb
+- lib/quandl/client/base.rb
+- lib/quandl/client/concerns.rb
+- lib/quandl/client/concerns/properties.rb
+- lib/quandl/client/concerns/search.rb
 - lib/quandl/client/her.rb
 - lib/quandl/client/models.rb
 - lib/quandl/client/models/dataset.rb
-- lib/quandl/client/models/dataset/properties.rb
-- lib/quandl/client/models/dataset/searchable.rb
 - lib/quandl/client/models/sheet.rb
 - lib/quandl/client/models/source.rb
 - lib/quandl/client/version.rb

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

@@ -1,46 +0,0 @@
-module Quandl
-module Client
-
-class Dataset
-
-module Properties
-
-  extend ActiveSupport::Concern
-  
-  included do
-    
-    include Her::Model
-    use_api Client.her_api
-    
-    attributes :data, :source_code, :code, :name, :urlize_name, 
-      :description, :updated_at, :frequency, :from_date, 
-      :to_date, :column_names, :private, :type
-      
-    attributes :locations_attributes
-    
-    alias_method :locations, :locations_attributes
-    alias_method :locations=, :locations_attributes=
-    
-    def errors
-      self.attributes[:errors]
-    end
-    
-    def full_code
-      @full_code ||= File.join(self.source_code, self.code)
-    end
-  
-    def data_table
-      Data::Table.new( raw_data )
-    end
-    
-    def raw_data
-      @raw_data ||= (self.data || Dataset.find(full_code).data || [])
-    end
-    
-  end
-  
-end
-
-end
-end
-end

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

@@ -1,39 +0,0 @@
-module Quandl
-module Client
-  
-class Dataset
-
-module Searchable
-
-  extend ActiveSupport::Concern
-
-  included do
-  
-    include ScopeBuilder::Model
-    
-    scope_builder_for :search, :show
-  
-    # SEARCH
-  
-    search_scope :query, :rows
-    search_scope :page, ->(p){ where( page: p.to_i )}
-    search_scope :source_code, ->(c){ where( code: c.to_s.upcase )}
-
-    search_helper :all, ->{ connection.where(attributes).fetch }
-    search_helper :connection, -> { self.class.parent }
-    
-    search_scope.class_eval{ delegate *Array.forwardable_methods, to: :all }
-    
-    # SHOW
-    
-    show_scope :rows, :exclude_data, :exclude_headers, :trim_start, :trim_end, :transform, :collapse
-    show_helper :find, ->(id){ connection.where(attributes).find( id ) }
-    show_helper :connection, -> { self.class.parent }
-    
-  end
-  
-end
-
-end
-end
-end