quandl_client 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+/Gemfile.lock
+/pkg
+/tmp
+quandl_client-*

data/.rspec

@@ -0,0 +1 @@
+--colour --format=Fivemat

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+
+gemfile:
+  - Gemfile
+  - gemfiles/activemodel-4.0.gemfile
+
+matrix:
+  exclude:
+  - rvm: 1.8.7
+    gemfile: gemfiles/activemodel-4.0.gemfile
+  - rvm: 1.9.2
+    gemfile: gemfiles/activemodel-4.0.gemfile
+
+script: "echo 'COME ON!' && bundle exec rake spec"

data/.yardopts

@@ -0,0 +1,2 @@
+--protected
+--no-private

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012-2013 Blake Hilscher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,162 @@
+# Installation
+
+```ruby
+
+gem 'quandl_client'
+
+```
+
+
+
+
+# Configuration
+
+```ruby
+
+require 'quandl/client'
+
+Quandl::Client.use 'http://localhost:3000/api/'
+
+```
+
+
+
+
+# Usage
+
+
+## Quandl::Client::Dataset
+
+
+#### Search
+
+search_scope :rows, :exclude_data, :exclude_headers, :trim_start, :trim_end, :transform, :collapse
+
+```ruby
+
+datasets = Quandl::Client::Dataset.query('cobalt').source_code('ofdp').all
+=> [#<Quandl::Client::Dataset(datasets) source_code="OFDP" code="COBALT_51">, ...]
+
+```
+
+
+#### Show
+
+attributes :data, :source_code, :code, :name, :urlize_name, 
+  :description, :updated_at, :frequency, :from_date, 
+  :to_date, :column_names, :private, :type
+
+```ruby
+
+d = Quandl::Client::Dataset.find('OFDP/COBALT_51')
+d.full_code
+d.data_table
+
+
+d = Quandl::Client::Dataset.collapse('weekly').trim_start("2012-03-31").trim_end("2013-06-30").find('OFDP/COBALT_51')
+d.data_table
+
+
+d = Quandl::Client::Dataset.exclude_data('true').find('OFDP/COBALT_51')
+d.data_table
+
+```
+
+
+
+## Quandl::Client::Sheet
+
+
+#### Search
+
+```ruby
+
+sheets = Quandl::Client::Sheet.url_title('housing').query('hood').page(2).all
+
+=> [#<Quandl::Client::Sheet(sheets) title="hood" url_title="housing/hood">,...]
+
+```
+
+
+#### Show
+
+```ruby
+
+sheet = Quandl::Client::Sheet.find_by_url_title('housing/hood')
+
+```
+
+
+
+## Quandl::Client::Sheet
+
+
+#### Search
+
+```ruby
+
+require 'quandl/client'
+
+Quandl::Client.use 'http://localhost:3000/api/'
+
+sources = Quandl::Client::Source.query('canada').all
+=> [#<Quandl::Client::Source(sources) code="STATSCAN5" datasets_count=1>,...]
+
+source = Quandl::Client::Source.find('STATSCAN5')
+dataset = source.datasets.page(2).first
+dataset.data_table
+
+```
+
+
+#### Show
+
+```ruby
+
+sheet = Quandl::Client::Sheet.find_by_url_title('housing/hood')
+
+```
+
+
+#### Create
+
+
+```ruby
+
+Quandl::Client.token = 'xyz'
+
+s = Quandl::Client::Sheet.create(title: 'Hi there', content: 'magic')
+
+```
+
+
+#### Update
+
+
+```ruby
+
+Quandl::Client.token = 'xyz'
+
+s = Quandl::Client::Sheet.find_by_url_title('hi_there')
+s.title = 'another title'
+s.save
+
+```
+
+
+# Authentication
+
+```ruby
+
+require 'quandl/client'
+
+Quandl::Client.use 'http://localhost:3000/api/'
+Quandl::Client.token = 'xyz'
+
+s = Quandl::Client::Sheet.find_by_url_title('testing')
+s.title = 'more testing'
+s.save
+=> true
+
+```
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+require "rake"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = "spec/**/*_spec.rb"
+end

data/UPGRADE.md

@@ -0,0 +1,3 @@
+## 0.1
+
+Initial

data/lib/quandl/client.rb

@@ -0,0 +1,19 @@
+require "quandl/client/version"
+
+require "active_support"
+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/models'
+
+module Quandl
+  module Client
+  end
+end

data/lib/quandl/client/her.rb

@@ -0,0 +1,74 @@
+module Quandl
+module Client
+  class << self
+    
+    def use(url)
+      self.rest_url = url
+    end
+    
+    def token
+      @token
+    end    
+    def token=(token)
+      @token = token
+      reload_models
+    end
+    
+    def her_api
+      # setup api
+      api = Her::API.new
+      api.setup url: rest_url do |c|
+        c.use TokenAuthentication
+        c.use Faraday::Request::UrlEncoded
+        c.use Parser
+        c.use Faraday::Adapter::NetHttp
+      end
+    end
+
+    def rest_url
+      @rest_url ||= 'http://quandl.com/api/'
+    end
+    
+    def rest_url=(url)
+      url = "http://#{url}" if ( url =~ /^http:\/\// ) == nil
+      url = File.join(url, "#{API_VERSION}/")
+      @rest_url = url
+      reload_models
+      @rest_url
+    end
+    
+    def reload_models
+      Models.use_api( her_api )
+    end
+    
+    class Parser < Faraday::Response::Middleware
+      def on_complete(env)
+        json = MultiJson.load(env[:body], symbolize_keys: true)
+        errors = []
+        if json.is_a?(Hash) && json.has_key?(:docs)
+          errors = [json.delete(:error)]
+          data = json.delete(:docs)
+          metadata = json
+        else
+          errors = [json.delete(:error)] if json.is_a?(Hash) && json.has_key?(:error)
+          data = json.present? ? json : {}
+          metadata = {}
+        end
+        env[:body] = {
+          data: data,
+          errors: errors,
+          metadata: metadata
+        }
+      end
+    end
+    
+    class TokenAuthentication < Faraday::Middleware
+      def call(env)
+        env[:request_headers]["X-API-Token"] = Quandl::Client.token if Quandl::Client.token.present?
+        @app.call(env)
+      end
+    end
+    
+  end 
+end
+end

data/lib/quandl/client/models.rb

@@ -0,0 +1,25 @@
+require 'quandl/client/models/source'
+require 'quandl/client/models/dataset'
+require 'quandl/client/models/sheet'
+
+module Quandl
+  module Client
+    module Models
+      class << self
+        
+        def use_api(api)
+          each{|k| k.use_api(api) }
+        end
+        
+        def each(&block)
+          types.each{|k| block.call(k) }
+        end
+        
+        def types
+          [Source, Dataset, Sheet]
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'quandl/client/models/dataset/searchable'
+require 'quandl/client/models/dataset/properties'
+
+module Quandl
+module Client
+
+class Dataset
+  
+  include Properties
+  include Searchable
+  
+  def source
+    @source ||= Source.find(self.source_code)
+  end
+  
+  def id
+    'show'
+  end
+  
+end
+
+end
+end

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

@@ -0,0 +1,37 @@
+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
+    
+    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

@@ -0,0 +1,39 @@
+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

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

@@ -0,0 +1,45 @@
+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
+  
+  search_scope :query, :page, :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
+  
+  class << self
+    
+    def find_by_url_title(title)
+      where( url_title: title ).find('show')
+    end
+    
+  end
+  
+  # ORM
+  include Her::Model
+  use_api Client.her_api
+  attributes :title, :url_title, :content
+  
+  def html
+    @html ||= @attributes['html'] || Sheet.find(self.url_title).instance_variable_get('@attributes')['data']
+  end
+  
+  def id
+    'show'
+  end
+  
+end
+
+end
+end

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

@@ -0,0 +1,40 @@
+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
+  
+  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
+  
+  def datasets
+    Dataset.source_code(code)
+  end
+  
+  def id
+    'show'
+  end
+  
+end
+
+end
+end

data/lib/quandl/client/version.rb

@@ -0,0 +1,15 @@
+module Quandl
+module Client
+  VERSION = '0.0.1'
+  API_VERSION = 'v1'
+  
+  class << self
+    
+    def api_version
+      API_VERSION
+    end
+    
+  end
+  
+end
+end

data/lib/quandl/her/patch.rb

@@ -0,0 +1,9 @@
+module Her
+  module Model
+    # remove deprecated data method since cassinatra returns data: []
+    module DeprecatedMethods
+      remove_method :data
+      remove_method :data=
+    end
+  end
+end

data/quandl_client.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "quandl/client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "quandl_client"
+  s.version     = Quandl::Client::VERSION
+  s.authors     = ["Blkae Hilscher"]
+  s.email       = ["blake@hilscher.ca"]
+  s.homepage    = "http://blake.hilscher.ca/"
+  s.license     = "MIT"
+  s.summary     = "Client rest orm."
+  s.description = "An orm for the cassinatra rest interface."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 2.13"
+  s.add_development_dependency "fivemat", "~> 1.2"
+  s.add_development_dependency "pry"
+
+  s.add_runtime_dependency "activesupport", ">= 3.0.0"
+  s.add_runtime_dependency "her", "~> 0.6.7"
+  s.add_runtime_dependency "scope_builder", "~> 0.0.6"
+  s.add_runtime_dependency "quandl_data", "~> 0.0.4"
+  s.add_runtime_dependency 'json', '~> 1.7.7'
+end

data/spec/quandl_client.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Quandl::Client do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "rspec"
+require "quandl/client"

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: quandl_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Blkae Hilscher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+- !ruby/object:Gem::Dependency
+  name: scope_builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: quandl_data
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: An orm for the cassinatra rest interface.
+email:
+- blake@hilscher.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- UPGRADE.md
+- lib/quandl/client.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
+- lib/quandl/her/patch.rb
+- quandl_client.gemspec
+- spec/quandl_client.rb
+- spec/spec_helper.rb
+homepage: http://blake.hilscher.ca/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Client rest orm.
+test_files:
+- spec/quandl_client.rb
+- spec/spec_helper.rb