chimps 0.2.2 → 0.3.0

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Dhruv Bansal
@@ -15,61 +15,43 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 -06:00
-default_executable: chimps
+date: 2011-03-25 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
   name: json
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 3
         segments: 
-        - 1
-        - 4
-        - 3
-        version: 1.4.3
+        - 0
+        version: "0"
+  requirement: *id001
   type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: imw
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  name: configliere
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 23
         segments: 
         - 0
-        - 2
         - 3
-        version: 0.2.3
+        - 2
+        version: 0.3.2
+  requirement: *id002
   type: :runtime
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  name: rest-client
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,15 +59,15 @@ dependencies:
         hash: 13
         segments: 
         - 1
-        - 2
-        - 9
-        version: 1.2.9
-  type: :development
-  version_requirements: *id004
+        - 6
+        - 1
+        version: 1.6.1
+  requirement: *id003
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  name: addressable
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -94,69 +76,42 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id005
-description: Chimps! allows you to easily make API calls against Infochimps web services.  Chimps!'s Request and Response classes take care of all the details so you can remain calm and RESTful.  Chimps! also comes with a command-line tool to make it simple to query, create, update, upload, and download data on Infochimps
-email: coders@infochimps.org
-executables: 
-- chimps
+  requirement: *id004
+  type: :runtime
+description: Chimps allows you to easily make API calls against Infochimps web services.  Chimps!'s Request and Response classes take care of all the details so you can remain calm and RESTful.
+email: coders@infochimps.com
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
-- CHANGELOG.textile
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
-- bin/chimps
 - examples/batch.yaml
 - examples/query.yaml
 - lib/chimps.rb
-- lib/chimps/cli.rb
-- lib/chimps/commands.rb
-- lib/chimps/commands/base.rb
-- lib/chimps/commands/batch.rb
-- lib/chimps/commands/create.rb
-- lib/chimps/commands/destroy.rb
-- lib/chimps/commands/download.rb
-- lib/chimps/commands/help.rb
-- lib/chimps/commands/list.rb
-- lib/chimps/commands/query.rb
-- lib/chimps/commands/search.rb
-- lib/chimps/commands/show.rb
-- lib/chimps/commands/test.rb
-- lib/chimps/commands/update.rb
-- lib/chimps/commands/upload.rb
 - lib/chimps/config.rb
+- lib/chimps/error.rb
+- lib/chimps/query_request.rb
 - lib/chimps/request.rb
 - lib/chimps/response.rb
-- lib/chimps/typewriter.rb
 - lib/chimps/utils.rb
-- lib/chimps/utils/error.rb
 - lib/chimps/utils/extensions.rb
-- lib/chimps/utils/log.rb
+- lib/chimps/utils/typewriter.rb
 - lib/chimps/utils/uses_curl.rb
-- lib/chimps/utils/uses_model.rb
-- lib/chimps/utils/uses_yaml_data.rb
-- lib/chimps/workflows.rb
-- lib/chimps/workflows/batch.rb
-- lib/chimps/workflows/downloader.rb
-- lib/chimps/workflows/up.rb
-- lib/chimps/workflows/upload/bundler.rb
-- lib/chimps/workflows/upload/notifier.rb
-- lib/chimps/workflows/upload/token.rb
-- lib/chimps/workflows/upload/uploader.rb
+- lib/chimps/workflows/download.rb
+- lib/chimps/workflows/upload.rb
+- spec/chimps/query_request_spec.rb
+- spec/chimps/request_spec.rb
 - spec/chimps/response_spec.rb
-- spec/chimps/typewriter_spec.rb
-- spec/chimps/workflows/upload/bundler_spec.rb
-- spec/chimps/workflows/upload/token_spec.rb
+- spec/chimps/workflows/download_spec.rb
 - spec/spec_helper.rb
 - spec/support/custom_matchers.rb
 has_rdoc: true
@@ -164,8 +119,8 @@ homepage: http://github.com/infochimps/chimps
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -192,11 +147,11 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Chimps! is a Ruby wrapper and command-line interface for the Infochimps APIs (http://infochimps.org/api, http://api.infochimps.com)
+summary: Chimps is a Ruby interface for the Infochimps Dataset & Query APIs (http://www.infochimps.com/api)
 test_files: 
-- spec/spec_helper.rb
-- spec/chimps/workflows/upload/bundler_spec.rb
-- spec/chimps/workflows/upload/token_spec.rb
-- spec/chimps/typewriter_spec.rb
+- spec/chimps/query_request_spec.rb
+- spec/chimps/request_spec.rb
 - spec/chimps/response_spec.rb
+- spec/chimps/workflows/download_spec.rb
+- spec/spec_helper.rb
 - spec/support/custom_matchers.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,32 +0,0 @@
-
-# editors
-*~
-\#*
-\.#*
-*.tmproj
-tmtags
-TAGS
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-# editors
-# miscellaneous
-# version control
-*.tmproj
-*DO_NOT_VERSION*
-*~
-.#*
-.DS_Store
-.bak
-.bzr
-.hg
-.svn
-/chimps.gemspec
-TAGS
-\#*
-\.#*
-pkg/*

data/CHANGELOG.textile

@@ -1,4 +0,0 @@
-
-Chimps v0.1.1 2010-05-20
-
-* Made Gem

data/bin/chimps

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
-require "chimps"
-require 'chimps/cli'
-exit    Chimps::CLI.execute!

data/lib/chimps/cli.rb

@@ -1,28 +0,0 @@
-module Chimps
-
-  # Defines methods for choosing which Chimps::Command class should be
-  # instantiated from the ARGV passed in on the command line.
-  module CLI
-
-    include Chimps::Commands
-
-    # Execute the Chimps command specified on the command line.
-    #
-    # Will exit the Ruby process with 0 on success or 1 on an error.
-    def self.execute!
-      begin
-        Chimps.boot!
-        command.execute!
-        return 0
-      rescue Chimps::Error, Configliere::Error => e
-        puts e.message
-        return 1
-      rescue => e
-        $stderr.puts("#{e.message} (#{e.class})")
-        $stderr.puts(e.backtrace.join("\n"))
-        return 2
-      end
-    end
-  end
-end
-

data/lib/chimps/commands/base.rb

@@ -1,65 +0,0 @@
-module Chimps
-
-  # A base class from which to subclass specific commands.  A subclass
-  # should
-  #
-  # - define class constants <tt>BANNER</tt> and <tt>HELP</tt> which
-  # - will display the appropriate help to the user.
-  # 
-  # - add specific options by defining a method that begins with
-  #   +define+ and ends with +options+ (i.e. - +define_output_options+
-  #   to add options related to output).
-  #
-  # - define a method <tt>execute!</tt> which will actually run the
-  #   command.
-  class Command
-
-    # Appears when printing help for this command, as the very first
-    # line.  Should be one-line summary of how to use this command.
-    USAGE = "Define #{self}::USAGE when you subclass Chimps::Command"
-
-    # Appears when printing help for this command.  Should consist of
-    # general help or examples of the command iteslf.  Help on
-    # specific options is automatically generated.
-    HELP   = "Define #{self}::HELP when you subclass Chimps::Command"
-
-    # The configuration settings for this command.
-    #
-    # @return [Configliere::Param]
-    attr_accessor :config
-
-    # Create a new command.  Will define options specific to
-    # subclases, parse the given +argv+, and load the global Chimps
-    # configuration.  Will _not_ execute the command.
-    #
-    # @param  [Configliere::Param]
-    # @return [Chimps::Command]
-    def initialize config
-      self.config = config
-    end
-
-    # The name of this command, including the
-    # <tt>Chimps::Commands</tt> prefix.
-    #
-    # @return [String]
-    def self.name
-      self.to_s.downcase
-    end
-
-    # The name of this command, excluding the
-    # <tt>Chimps::Commands</tt> prefix.
-    #
-    # @return [String]
-    def name
-      self.class.name.split('::').last
-    end
-    
-    # Run this command.
-    #
-    # Will raise a NotImplementedError for Chimps::Command itself --
-    # subclasses are expected to redefine this method.
-    def execute!
-      raise NotImplementedError.new("Redefine the `execute!' method in a subclass of #{self.class}.")
-    end
-  end
-end

data/lib/chimps/commands/batch.rb

@@ -1,40 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command for performing batch updates.
-    class Batch < Chimps::Command
-
-      USAGE = "usage: chimps batch [OPTIONS] [INPUT_PATH] ..."
-      HELP   = <<EOF
-
-Perform a batch operation on Infochimps by reading YAML input files.
-
-The input files should collectively define an array of resources to
-make create or update requests on.  Each request in the array is
-treated separately (even though the entire array is processed as one
-POST request) and so it is possible that some will succeed and others
-fail.
-
-It is also possible to upload data in this batch process.  Each
-(successful) request which defined a 'local_paths' property in the
-original input files will have the data at these paths uploaded to
-Infochimps.  These uploads will proceed one at a time following the
-initial batch POST request.
-
-The format of the YAML input files is given at
-
-  http://infochimps.org/api
-EOF
-
-      include Chimps::Utils::UsesYamlData
-
-      # Perform the batch update and upload.
-      def execute!
-        ensure_data_is_present!
-        Chimps::Workflows::BatchUpdater.new(data, :output_path => config[:output], :upload_even_if_errors => config[:force], :fmt => config[:format]).execute!
-      end
-      
-    end
-  end
-end
-

data/lib/chimps/commands/create.rb

@@ -1,31 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to issue a POST requst to create a resource at
-    # Infochimps.
-    class Create < Chimps::Command
-
-      USAGE = "usage: chimps create [OPTIONS] [PROP=VALUE] ..."
-      HELP   = <<EOF
-
-Create a single resource (defaults to a dataset) 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
-
-      # Issue the POST request.
-      def execute!
-        ensure_data_is_present!
-        Request.new(models_path, :data => {model.to_sym => data } , :authenticate => true).post.print
-      end
-      
-    end
-  end
-end
-

data/lib/chimps/commands/destroy.rb

@@ -1,26 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to issue a DELETE request against a resource at
-    # Infochimps.
-    class Destroy < Chimps::Command
-
-      USAGE = "usage: chimps destroy [OPTIONS] ID_OR_HANDLE"
-      HELP   = <<EOF
-
-Destroys a resource of a given type (defaults to dataset) identified
-by ID_OR_HANDLE.
-
-EOF
-
-      include Chimps::Utils::UsesModel
-
-      # Issue the DELETE request.
-      def execute!
-        Request.new(model_path, :authenticate => true).delete.print
-      end
-      
-    end
-  end
-end
-

data/lib/chimps/commands/download.rb

@@ -1,46 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to download data from Infochimps.
-    class Download < Chimps::Command
-
-      USAGE = "usage: chimps download [OPTIONS] ID_OR_HANDLE"
-      HELP   = <<EOF
-
-Download a dataset identified by the given ID_OR_HANDLE to the current
-directory (you can also specify a particular path).
-
-If the dataset isn't freely downloadable, you'll have to have
-purchased it first via the Web.
-EOF
-
-      # Return the given string downcased and stripped of leading
-      # periods.
-      #
-      # @param [String] string
-      # @return [String, nil]
-      def normalize string
-        return string if string.blank?
-        string.downcase.strip.gsub(/^\./, '')
-      end
-      
-      # The ID of the package to download.
-      def dataset
-        raise CLIError.new("Must provide an ID or handle of a dataset to download.") if config.argv.first.blank?
-        config.argv.first
-      end
-
-      def local_path
-        config[:output].blank? ? config[:output] : File.expand_path(config[:output])
-      end
-
-      # Issue the request for the token and the request for the
-      # download.
-      def execute!
-        Chimps::Workflows::Downloader.new(:dataset => dataset, :fmt => normalize(config[:format]), :pkg_fmt => normalize(config[:pkg_fmt]), :local_path => local_path).execute!
-      end
-      
-    end
-  end
-end
-

data/lib/chimps/commands/help.rb

@@ -1,100 +0,0 @@
-module Chimps
-  module Commands
-    class Help < Chimps::Command
-
-      USAGE = "usage: chimps help [OPTIONS] [COMMAND]"
-
-      HELP = <<EOF
-
-This is the Infochimps command-line client.  You can use it to search,
-browse, create, edit, or delete data and metadata in the Infochimps
-repository at http://infochimps.org.
-
-Before you can create, edit, or delete anything you'll need to get an
-Infochimps account and sign up for an API key:
-
-  http://infochimps.org/signup
-
-But you can still browse, search, and download (free) data
-immediately.
-
-Learn more about the Infochimps API which powers this tool at
-
-  http://infochimps.org/api
-
-= Commands
-
-chimps is a wrapper over the RESTful Infochimps API.  It exposes the
-following actions
-
-  chimps list
-  chimps show
-  chimps create
-  chimps update
-  chimps destroy
-
-for datasets (as well as other selected resources).  It also helps
-automate the workflow of uploading and downloading data and making
-batch changes with
-
-  chimps upload
-  chimps download
-  chimps batch
-
-You can also make queries against the Infochimps paid query API with
-
-  chimps query
-
-Finally, you can test that your system is configured properly and that
-you can authenticate with Infochimps with
-
-  chimps test
-
-If you're confused try running
-
-  chimps help COMMAND
-
-for any of the commands above.
-
-= Setup
-
-Once you have obtained an API key and secret from Infochimps, place
-them in a file Chimps::Config[:config] in your home directory
-with the following format
-
-  ---
-  # API credentials for use on the main Infochimps site
-  :site:
-    :username: your_site_name
-    :key: oreeph6giedaeL3
-    :secret: Queechei6cu8chiuyiig8cheg5Ahx0boolaizi1ohtarooFu1doo5ohj5ohp9eehae5hakoongahghohgoi7yeihohx1eidaeng0eaveefohchoh6WeeV1EM
-
-  # API credentials for use on the Infochimps paid query API
-  :query:
-    :username: your_query_name
-    :key: zei7eeloShoah3Ce
-    :secret: eixairaichaxaaRe8eeya5moh8Uthahf0pi4eig7SoirohPhei6sai8aereu0yuepiefeipoozoegahchaeheedee8uphohoo9moongae8Fa0aih4BooSeiM
-EOF
-
-     
-      def fake_command name
-        Chimps::Commands.class_for(name).new(Chimps::Config.commands[name][:config])
-      end
-      
-      def execute!
-        if Chimps::Config.command?(config.argv.first)
-          command = fake_command(config.argv.first)
-          $stderr.puts command.class::USAGE
-          $stderr.puts command.class::HELP
-          command.config.dump_basic_help
-          Chimps::Config.dump_basic_help
-        else
-          $stderr.puts Chimps::Config.usage
-          Chimps::Config.dump_help
-        end
-      end
-
-    end
-  end
-end
-

data/lib/chimps/commands/list.rb

@@ -1,41 +0,0 @@
-module Chimps
-  module Commands
-
-    # A command to issue a GET request against an index of resources
-    # at Infochimps.
-    class List < Chimps::Command
-
-      USAGE = "usage: chimps list [OPTIONS]"
-      HELP   = <<EOF
-
-List resources of a given type (defaults to dataset).
-
-Lists your resources by default but see options below.
-
-EOF
-
-      include Chimps::Utils::UsesModel
-
-      # List all resources or just those owned by the Chimps user?
-      def all?
-        config[:all]
-      end
-
-      # Parameters to include in the query.
-      #
-      # If listing all resources, then return +nil+.
-      #
-      # @return [Hash, nil]
-      def params
-        return { :id => Chimps.username } unless all?
-      end
-
-      # Issue the GET request.
-      def execute!
-        Request.new(models_path, :params => params).get.print(:skip_column_names => config[:skip_column_names])
-      end
-
-    end
-  end
-end
-