chimps 0.2.2 → 0.3.0

data/lib/chimps/commands/query.rb

@@ -1,82 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to issue a GET request against the Infochimps paid
-    # query API.
-    class Query < Chimps::Command
-
-      USAGE = "usage: chimps query [OPTIONS] DATASET [PROP=VALUE] ..."
-      HELP   = <<EOF
-
-Make a query of the given DATASET on the Infochimps paid query API
-(not the main Infochimps site).
-
-Properties and values can be supplied directly on the command line,
-from an input YAML file, or multiple YAML documents streamed in via
-STDIN, in order of decreasing precedence.
-
-You can learn more about the Infochimps query API, discover datasets
-to query, and look up the available parameters at
-
-  http://api.infochimps.com
-
-You can learn about the main Infochimps site API at
-
-  http://infochimps.org/api
-EOF
-
-      include Chimps::Utils::UsesYamlData
-      def ignore_first_arg_on_command_line
-        true
-      end
-
-      # The dataset to query.
-      #
-      # @return [String]
-      def dataset
-        raise CLIError.new("Must provide a dataset to query.") if config.argv.first.blank?
-        config.argv.first
-      end
-
-      # The path on the Infochimps query API to query.
-      #
-      # @return [String]
-      def path
-        dataset + ".json"
-      end
-
-      # Should the query output be pretty-printed?
-      #
-      # @return [true, nil]
-      def pretty_print?
-        config[:pretty_print]
-      end
-
-      # The requests that will be sent to the server.
-      #
-      # @return [Array<Chimps::QueryRequest>]
-      def requests
-        ensure_data_is_present!
-        if data.is_a?(Hash)
-          [QueryRequest.new(path, :query_params => data, :authenticate => true)]
-        else # it's an Array, see Chimps::Utils::UsesYamlData
-          data.map { |params| QueryRequest.new(path, :query_params => params, :authenticate => true) }
-        end
-      end
-      
-      # Issue the GET request.
-      def execute!
-        requests.each do |request|
-          response = request.get
-          if response.error?
-            response.print :to => $stderr
-          else
-            puts pretty_print? ? JSON.pretty_generate(response.data) : response.body
-          end
-        end
-      end
-      
-    end
-  end
-end
-

data/lib/chimps/commands/search.rb

@@ -1,48 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to issue a GET request to create a search at
-    # Infochimps.
-    class Search < Chimps::Command
-
-      # Describes usage of search command.
-      USAGE = "usage: chimps search [OPTIONS] QUERY"
-
-      # Default number of search results returned.
-      # DEFAULT_LIMIT  = 20
-      
-      HELP   = <<EOF
-
-Perform a search on Infochimps.  By default the search will be of
-datasets and will return all matches for the given QUERY.
-EOF
-      
-      # Path to search resource
-      PATH   = 'search.json'
-      
-      include Chimps::Utils::UsesModel
-
-      # FIXME have to implement this on the server side.
-      # def limit
-      #   @limit ||= DEFAULT_LIMIT
-      # end
-
-      def query
-        raise CLIError.new("Must provide a query to search for") if config.argv.blank?
-        config.argv.join(' ')
-      end
-
-      def params
-        {
-          :query => query,
-          :model => model
-        }
-      end
-
-      def execute!
-        Chimps::Request.new(PATH, :params => params).get.print(:skip_column_names => config[:skip_column_names])
-      end
-    end
-  end
-end
-

data/lib/chimps/commands/show.rb

@@ -1,30 +0,0 @@
-module Chimps
-  module Commands
-
-    class Show < Chimps::Command
-
-      USAGE = "usage: chimps show [OPTIONS] ID_OR_HANDLE"
-      HELP   = <<EOF
-
-Return a description of the resource (defaults to dataset) with the
-given ID or HANDLE
-EOF
-
-      include Chimps::Utils::UsesModel
-
-      # The path of the URL to send a Request to.
-      #
-      # This is different from Chimps::Commands::UsesModel in that it
-      # submits to the YAML path.
-      def model_path
-        "#{plural_model}/#{model_identifier}.yaml"
-      end
-
-      def execute!
-        puts Chimps::Request.new(model_path).get.body
-      end
-
-    end
-  end
-end
-

data/lib/chimps/commands/test.rb

@@ -1,39 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to test whether API authentication with Infochimps is
-    # working.
-    class Test < Chimps::Command
-
-      USAGE = "usage: chimps test"
-      HELP = <<EOF
-
-Print diagnostic information on the API credentials being used by chimps
-and send a test request to Infochimps to make sure the API credentials
-work.
-
-EOF
-
-      # Path to submit test requests to.
-      def path
-        "api_accounts/#{Chimps::Config[:site][:key]}"
-      end
-
-      # Issue the request.
-      def execute!
-        response = Chimps::Request.new(path, :sign => true).get
-        if response.error?
-          case 
-          when response.code == 404 then puts "ERROR Unrecognized API key" # record not found
-          when response.code == 401 then puts "ERROR Signature does not match API key and query.  Is your secret key correct?" # unauthorized
-          else
-            nil                 # response gets printed anyway
-          end
-        end
-        response.print
-      end
-
-    end
-  end
-end
-

data/lib/chimps/commands/update.rb

@@ -1,34 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to issue a PUT request to update a resource at
-    # Infochimps.
-    class Update < Chimps::Command
-
-      USAGE = "usage: chimps update [OPTIONS] ID_OR_HANDLE [PROP=VALUE] ..."
-      HELP   = <<EOF
-
-Updates a single resource of a given type (defaults to dataset)
-identified by ID_OR_HANDLE using the properties and values supplied.
-
-Properties and values can be supplied directly on the command line,
-from an input YAML file, or multiple YAML documents streamed in via
-STDIN, in order of decreasing precedence.
-EOF
-
-      include Chimps::Utils::UsesModel
-      include Chimps::Utils::UsesYamlData
-      def ignore_first_arg_on_command_line
-        true
-      end
-
-      # Issue the PUT request.
-      def execute!
-        ensure_data_is_present!
-        Request.new(model_path, :data => {model.to_sym => data } , :authenticate => true).put.print
-      end
-      
-    end
-  end
-end
-

data/lib/chimps/commands/upload.rb

@@ -1,50 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command for uploading data to Infochimps.
-    class Upload < Chimps::Command
-
-      USAGE  = "usage: chimps upload [OPTIONS] ID_OR_HANDLE PATH [PATH] ..."
-      HELP   = <<EOF
-
-Upload data from your local machine for an existing dataset identified
-by ID_OR_HANDLE on Infochimps.
-
-chimps will package all paths supplied into a local archive and then
-upload this archive to Infochimps.  The local archive defaults to a
-sensible name in the current directory but can also be customized.
-
-If the only file to be packaged is already a package (.zip, .tar,
-.tar.gz, &c.) then it will not be packaged again.
-
-Supplied paths are allowed to be remote files so someting like
-
-  chimps upload my-dataset path/to/local/file.txt http://my-site.com/path/to/remote/file.txt
-
-will work.
-EOF
-
-      # The ID or handle of the dataset to upload data for.
-      #
-      # @return [String]
-      def dataset
-        raise CLIError.new("Must provide an ID or URL-escaped handle as the first argument") if config.argv.first.blank?
-        config.argv.first
-      end
-
-      # A list of paths to upload.
-      #
-      # @return [Array<String>]
-      def paths
-        raise CLIError.new("Must provide some paths to upload") if config.argv.length < 2
-        config.argv[1..-1]
-      end
-      
-      # Upload the data.
-      def execute!
-        Chimps::Workflows::Up.new(:dataset => dataset, :archive => config[:archive], :paths => paths, :fmt => config[:format]).execute!.print
-      end
-    end
-  end
-end
-

data/lib/chimps/commands.rb

@@ -1,125 +0,0 @@
-require 'configliere'
-
-module Chimps
-
-  Config.use :commands
-
-  # A namespace to hold the various commands Chimps defines.
-  module Commands
-
-    def self.class_for name
-      "Chimps::Commands::#{name.to_s.capitalize}".constantize
-    end
-
-    def self.included obj
-      obj.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      # Create a new command from the given +command_name+.  The
-      # resulting command will be initialized but will not have been
-      # executed.
-      #
-      # @return [Chimps::Command]
-      def command
-        raise Chimps::CLIError.new("Must specify a command.  Try `chimps help'.") unless Chimps::Config.command
-        Chimps::Config.command_settings.resolve!
-        Chimps::Commands.class_for(Chimps::Config.command_name).new(Chimps::Config.command_settings)
-      end
-    end
-
-    protected
-    
-    def self.define_skip_column_names command
-      command.define :skip_column_names, :description => "Don't print column names in output", :flag => :s, :type => :boolean
-    end
-
-    def self.define_model command, models=%w[dataset collection source license]
-      models_string = models[0..-2].map { |m| "'#{m}'" }.join(', ') + ", or '#{models.last}'"
-      command.define :model, :description => "Model to search (one of #{models_string})", :flag => :m, :default => models.first, :type => String
-    end
-
-    def self.define_data_file command
-      command.define :data_file, :description => "Path to a file containing YAML data.", :flag => :d
-    end
-
-    #
-    # Core REST actions
-    #
-
-    Chimps::Config.define_command :list, :description => "List resources" do |command|
-      define_skip_column_names(command)
-      define_model(command)
-      command.define :all, :description => "List all resources, not just those owned by you", :flag => :a
-    end
-    
-    Chimps::Config.define_command :show, :description => "Show a resource in detail" do |command|
-      define_model(command, %w[dataset collection source license category tag])
-    end
-
-    Chimps::Config.define_command :create, :description => "Create a new resource" do |command|
-      define_model(command, %w[dataset source license])
-      define_data_file(command)
-    end
-
-    Chimps::Config.define_command :update, :description => "Update an existing resource" do |command|
-      define_model(command, %w[dataset source license])
-      define_data_file(command)
-    end
-
-    Chimps::Config.define_command :destroy, :description => "Destroy an existing resource" do |command|
-      define_model(command, %w[dataset package source license])
-    end
-
-    #
-    # Workflows
-    #
-
-    Chimps::Config.define_command :download, :description => "Download a dataset" do |command|
-      command.define :output, :description => "Path to output file (defaults to sensible path in current directory)", :flag => :o, :type => String
-      command.define :format, :description => "Preferred data-format (csv, tsv, xls, &c.)", :flag => :f, :type => String
-      command.define :pkg_fmt, :description => "Preferred package-format (zip, tar.bz2, &c.)", :flag => :p, :type => String
-    end
-
-    Chimps::Config.define_command :upload, :description => "Upload a dataset" do |command|
-      command.define :archive, :description => "Path to the local archive that will be created (defaults to a sensibly named ZIP file in the current directory)", :type => String, :flag => :a
-      command.define :format, :description => "Data format (tsv, csv, xls, &c.) of the uploaded data (will guess if not given)", :type => String, :flag => :f
-    end
-
-    Chimps::Config.define_command :batch, :description => "Perform a batch processing request" do |command|
-      command.define :output, :description => "Path to store the server's response", :type => String, :flag => :o
-      command.define :force, :description => "Force upload of data even if there were errors in the batch request.", :flag => :F
-      command.define :format, :description => "Data format to annotate each upload with (will guess if not given)", :type => String, :flag => :f
-      define_data_file(command)
-    end
-
-    #
-    # Miscellaneous
-    #
-
-    Chimps::Config.define_help_command!
-
-    Chimps::Config.define_command :search, :description => 'Search resources' do |command|
-      define_skip_column_names(command)
-      define_model(command)
-    end
-
-    Chimps::Config.define_command :query, :description => "Get a response from the Query API" do |command|
-      command.define :pretty_print, :description => "Pretty-print output", :flag => :p
-      define_data_file(command)
-    end
-    
-    Chimps::Config.define_command :test, :description => "Test your authentication credentials with Infochimps"
-
-
-    # A list of all the commmand names defined by Chimps.  Each name
-    # maps to a corresponding subclass of Chimps::Command living in
-    # the Chimps::Commands module.
-    #Configliere::COMMANDS += %w[search help test create show update destroy upload list download batch query]
-    
-    Chimps::Config.commands.keys.each do |command|
-      autoload command.to_s.capitalize.to_sym, "chimps/commands/#{command}"
-    end
-
-  end
-end