quandl 0.2.27 → 0.3.0

data/lib/quandl/command/presenter.rb

@@ -0,0 +1,74 @@
+require 'quandl/command/presenter/record'
+
+require 'quandl/command/presenters/dataset_presenter'
+require 'quandl/command/presenters/nil_class_presenter'
+require 'quandl/command/presenters/error_presenter'
+require 'quandl/command/presenters/scraper_presenter'
+require 'quandl/command/presenters/superset_presenter'
+
+module Quandl
+module Command
+class Presenter
+  
+  class << self
+  
+    def wrap_record_in_presenter(record, options)
+      klass = find_presenter_for_record(record, options)
+      klass.new(record, options)
+    end
+    
+    def find_presenter_for_record(record, options={})
+      name = 'Error' if record.kind_of?(Exception)
+      name = options[:as] || record.class.name.to_s.split("::").last unless name.present?
+      "Quandl::Command::Presenters::#{name}Presenter".constantize rescue Quandl::Command::Presenter::Record
+    end
+  
+  end
+  
+  attr_accessor :options, :type
+  
+  def initialize( object, opts={} )
+    self.type = ( object.try(:class) == Her::Collection ) ? :docs : :doc
+    self.options = { type: type }.merge( opts.symbolize_keys! )
+    self.collection = object
+  end
+  
+  def each(&block)
+    collection.each do |presenter|
+      block.call( presenter )
+    end
+  end
+  
+  def each_to_format(type, &block)
+    collection.each do |record|
+      output = record.send("to_#{type}") if record.respond_to?("to_#{type}")
+      block.call( output, record.object )
+    end
+  end
+  
+  def to_format(type)
+    output = []
+    collection.each do |record|
+      output << record.send("to_#{type}") if record.respond_to?("to_#{type}")
+    end
+    output.join("\n")
+  end
+  
+  def collection=(records)
+    @collection = []
+    records = Array(records).flatten
+    records.each do |record|
+      @collection << self.class.wrap_record_in_presenter(record, options)
+    end
+    # present nil if the collection is empty
+    @collection = [self.class.wrap_record_in_presenter( nil, options )] if @collection.blank?
+    @collection
+  end
+  
+  def collection
+    @collection ||= []
+  end
+  
+end
+end
+end

data/lib/quandl/command/presenter/record.rb

@@ -0,0 +1,121 @@
+module Quandl
+module Command
+class Presenter
+
+class Record
+  
+  attr_accessor :object, :options
+  
+  def initialize(*args)
+    self.options = args.extract_options!
+    self.object = args.first
+  end
+  
+  # supported formats
+  
+  def to_format(f)
+    self.send("to_#{f}") if self.respond_to?("to_#{f}")
+  end
+  
+  
+  def to_pipes
+    column = options[:output_column] if options.present? && options.is_a?(Hash)
+    pipes = as_pipes.dup.compact
+    pipes = [ pipes[ column.to_i ] ] if column.present? && column.to_s.numeric?
+    pipes.join(" | ")
+  end
+  
+  def to_stderr
+    as_stderr
+  end
+  
+  def as_stderr
+    output = ''
+    output += "#{id}\n" if id.present?
+    output += "#{detail}\n" if detail.present?
+    output += errors if errors.present?
+    output += object.to_s if object.kind_of?(Exception)
+    output += object.backtrace.join("\n") if object.respond_to?(:backtrace) && options[:trace] == true
+    output += "\n---\n"
+  end
+  
+  def to_qdf
+    object.try(:to_qdf)
+  end
+  
+  def to_csv
+    object.try(:to_csv)
+  end
+  
+  def to_json
+    as_json.try(:to_json)
+  end
+  
+  def as_pipes
+    [ status, id, detail, message ]
+  end
+  
+  def as_json
+    json = { status: status, id: id, detail: detail, message: message }
+    json[:attributes] = object.attributes if object.respond_to?(:attributes)
+    json[:metadata] = object.metadata if object.respond_to?(:metadata)
+    json[:errors] = object.error_messages if object.respond_to?(:error_messages)
+    json
+  end
+  
+  # default attribute mappings
+  
+  def valid?
+    return true if object.nil?
+    return true if [200,201,404].include?(object.try(:status))
+    false
+  end
+  
+  def status
+    return Quandl::Client::HTTP_STATUS_CODES[422] if object.try(:errors).try(:present?)
+    return object.try(:human_status) if object.respond_to?(:human_status) && object.human_status.present?
+    Quandl::Client::HTTP_STATUS_CODES[404]
+  end
+  
+  def id
+    object.try(:id)
+  end
+  
+  def message
+    errors_without_spaces
+  end
+  
+  def detail
+  end
+  
+  def errors_without_spaces
+    errors.to_s.gsub("\n", ' ')
+  end
+  
+  def errors
+    result = []
+    messages = object.try(:error_messages) || []
+    # extract repsonse errors
+    re = messages.delete(:response_errors) if messages.is_a?(Hash) && messages.has_key?(:response_errors)
+    re.each{|k,v| messages[k] = v } if re.present? && re.is_a?(Hash)
+    # format
+    messages.each do |k,v|
+      v = v.join(" & ") if v.respond_to?(:join)
+      result << "#{k}: #{v}"
+    end
+    result.join(", ")
+  end
+  
+  def docs?
+    options[:type] == :docs
+  end
+
+  def doc?
+    options[:type] == :doc
+  end
+  
+end
+
+end
+end
+end

data/lib/quandl/command/presenters/dataset_presenter.rb

@@ -0,0 +1,19 @@
+module Quandl
+module Command
+class Presenters
+
+class DatasetPresenter < Quandl::Command::Presenter::Record
+  
+  def id
+    object.try(:full_code)
+  end
+  
+  def detail
+    object.try(:full_url)
+  end
+  
+end
+
+end
+end
+end

data/lib/quandl/command/presenters/error_presenter.rb

@@ -0,0 +1,31 @@
+module Quandl
+module Command
+class Presenters
+
+class ErrorPresenter < Quandl::Command::Presenter::Record
+  
+  def as_pipes
+    [ status, id, detail, message.gsub(/\n+/, '. ') ]
+  end
+  
+  def status
+    Quandl::Client::HTTP_STATUS_CODES[422]
+  end
+  
+  def id
+    'Error'
+  end
+  
+  def detail
+    object.class.to_s
+  end
+  
+  def message
+    object.to_s
+  end
+  
+end
+
+end
+end
+end

data/lib/quandl/command/presenters/nil_class_presenter.rb

@@ -0,0 +1,10 @@
+module Quandl
+module Command
+class Presenters
+
+class NilClassPresenter < Quandl::Command::Presenter::Record
+end
+
+end
+end
+end

data/lib/quandl/command/presenters/scraper_presenter.rb

@@ -0,0 +1,25 @@
+module Quandl
+module Command
+class Presenters
+
+class ScraperPresenter < Quandl::Command::Presenter::Record
+  
+  def as_pipes
+    pipes = [object.name]
+    #pipes += [object.scraper_url, object.git_url, object.git_reference].compact if doc?
+    pipes
+  end
+  
+  def id
+    object.try(:name)
+  end
+  
+  def detail
+    object.try(:type)
+  end
+  
+end
+
+end
+end
+end

data/lib/quandl/command/presenters/superset_presenter.rb

@@ -0,0 +1,10 @@
+module Quandl
+module Command
+class Presenters
+
+class SupersetPresenter < DatasetPresenter
+end
+
+end
+end
+end

data/lib/quandl/command/task.rb

@@ -0,0 +1,40 @@
+require 'active_model'
+require 'quandl/pattern'
+require 'quandl/pattern/client'
+require 'quandl/operation'
+
+require 'quandl/command/task/configurable'
+require 'quandl/command/task/callbacks'
+require 'quandl/command/task/reportable'
+require 'quandl/command/task/commandable'
+require 'quandl/command/task/logging'
+require 'quandl/command/task/presentation'
+require 'quandl/command/task/threading'
+require 'quandl/command/task/translations'
+require 'quandl/command/task/updatable'
+require 'quandl/command/task/clientable'
+require 'quandl/command/task/inputable'
+
+module Quandl
+module Command
+  
+class Task
+  
+  include ActiveModel::Validations
+
+  include Quandl::Command::Task::Configurable
+  include Quandl::Command::Task::Callbacks
+  include Quandl::Command::Task::Commandable
+  include Quandl::Command::Task::Logging
+  include Quandl::Command::Task::Presentation
+  include Quandl::Command::Task::Threading
+  include Quandl::Command::Task::Translations
+  include Quandl::Command::Task::Updatable
+  include Quandl::Command::Task::Clientable
+  include Quandl::Command::Task::Reportable
+  include Quandl::Command::Task::Inputable
+  
+end
+
+end
+end

data/lib/quandl/command/task/callbacks.rb

@@ -0,0 +1,47 @@
+module Quandl
+module Command
+class Task
+
+module Callbacks
+  
+  extend ActiveSupport::Concern
+
+  included do
+  
+    extend ActiveModel::Callbacks
+    define_model_callbacks :execute
+    
+    before_execute :run_task_validations!
+    
+  end
+
+  module ClassMethods
+    
+    def disable_in_gem!
+      before_execute :disable_in_gem!
+    end
+  
+  end
+  
+  def run_task_validations!
+    unless valid?
+      error( table(errors.full_messages) )
+      false
+    end
+  end
+  
+  def disable_in_gem!
+    if force_yes?
+      info("You have forced update!")
+      true
+    elsif Dir.exists?( File.join( Tasks.root, ".git") ) || File.exists?( File.join( Tasks.root, "Gemfile") )
+      fatal("#{self.class.command_name} is only permitted when installed as a package! http://quandl.com/help/toolbelt") 
+      false
+    end
+  end
+  
+end
+
+end
+end
+end

data/lib/quandl/command/task/clientable.rb

@@ -0,0 +1,65 @@
+module Quandl
+module Command
+class Task
+
+module Clientable
+  
+  extend ActiveSupport::Concern
+
+  included do
+  end
+  
+  module ClassMethods
+    
+    def authenticated_users_only!
+      before_execute :authenticated_users_only!
+    end
+  
+    def warn_unauthenticated_users
+      before_execute :warn_unauthenticated_users
+    end
+    
+    def autoload_quandl_client
+      before_execute :autoload_quandl_client
+    end
+    
+  end
+  
+  def current_user
+    @current_user ||= Quandl::Client::User.info
+  end
+  
+  protected
+  
+  def clear_session!
+    @auth_token = nil
+    @current_user = nil
+    autoload_quandl_client
+  end
+  
+  def authenticated_users_only!
+    if auth_token.blank?
+      fatal("You must authenticate to use #{self.class.command_name}! 'quandl login' OR --token xyz923")
+      false
+    end
+  end
+  
+  def warn_unauthenticated_users
+    error("WARN: Authenticate your requests! 'quandl login' OR --token xyz923") if auth_token.blank?
+  end
+  
+  def autoload_quandl_client
+    require 'thread/pool'
+    require 'quandl/format'
+    require 'quandl/command/client_ext'
+    Quandl::Client.use( quandl_url )
+    Quandl::Client.token = auth_token
+    Quandl::Client.request_source = 'quandl_command'
+    Quandl::Client.request_version = Quandl::Command::VERSION
+  end
+  
+end
+
+end
+end
+end