google-refine 0.0.1 → 0.1.0

data/README.textile

@@ -1,5 +1,7 @@
 <h1>google-refine</h1> is a Ruby Gem client library for "Google Refine":http://code.google.com/p/google-refine/
 
+If you want to port this to another language, check out the "Refine API":https://github.com/maxogden/refine-python/wiki/Refine-API documentation.
+
 h2. Install
 
 @gem install google-refine@
@@ -76,5 +78,5 @@ Which outputs:
 
 h2. Copyright
 
-Copyright (c) 2010 Max Ogden. See LICENSE for details.
+Copyright (c) 2011 David Huynh and Max Ogden. See LICENSE for details.
 

data/google-refine.gemspec

@@ -5,13 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google-refine}
-  s.version = "0.0.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Max Ogden"]
+  s.version = "0.1.0"
+  s.authors = ["Max Ogden", "Michael Bianco"]
   s.date = %q{2011-01-22}
-  s.description = %q{Client library for interacting with Google Refine instances}
-  s.email = %q{max@maxogden.com}
+  s.summary = %q{Client library for interacting with Google Refine instances}
+  s.description = %q{Client library for interacting with Google Refine instances. Easily work with CSVs from the command line}
+  s.email = ['max@maxogden.com', 'info@cliffsidedev.com']
   s.extra_rdoc_files = [
     "LICENSE",
     "README.textile"
@@ -27,28 +26,13 @@ Gem::Specification.new do |s|
     "test/operations.json",
     "test/test.rb"
   ]
-  s.homepage = %q{http://github.com/maxogden/refine-ruby}
+  s.homepage = "http://github.com/maxogden/refine-ruby"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Client library for interacting with Google Refine instances}
   s.test_files = [
     "test/test.rb"
   ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
-      s.add_runtime_dependency(%q<httpclient>, [">= 2.1.6.1"])
-    else
-      s.add_dependency(%q<json>, [">= 1.4.6"])
-      s.add_dependency(%q<httpclient>, [">= 2.1.6.1"])
-    end
-  else
-    s.add_dependency(%q<json>, [">= 1.4.6"])
-    s.add_dependency(%q<httpclient>, [">= 2.1.6.1"])
-  end
+  s.add_dependency('json', ">= 1.4.6")
+  s.add_dependency('httpclient', ">= 2.1.6.1")
 end
 

data/lib/google-refine.rb

@@ -3,21 +3,38 @@ require 'cgi'
 require 'json'
 
 class Refine
-  def initialize(project_name, file_name, server="http://127.0.0.1:3333")
-    project_name = CGI.escape(project_name)
-    @server = server
-    @project_id = create_project(project_name, file_name)
-    @project_name = project_name if @project_id
+  attr_reader :project_name
+  attr_reader :project_id
+
+  def self.get_all_project_metadata(server="http://127.0.0.1:3333")
+    uri = "#{server}/command/core/get-all-project-metadata"
+    response = HTTPClient.new(server).get(uri)
+    JSON.parse(response.body)
+  end
+
+  def initialize(opts = {})
+    @server = opts["server"] || "http://127.0.0.1:3333"
+    @throws_exceptions = opts["throws_exceptions"] || true
+
+    if opts["file_name"] && !opts["file_name"].empty? && opts["project_name"] && !opts["project_name"].empty?
+      project_name = CGI.escape(opts["project_name"])
+      @project_id = create_project(project_name, opts["file_name"])
+      @project_name = project_name if @project_id
+    else
+      @project_id = opts["project_id"]
+
+      metadata = self.get_project_metadata
+      @project_name = CGI.escape(metadata["name"])
+    end
   end
   
   def create_project(project_name, file_name)
     uri = @server + "/command/core/create-project-from-upload"
     project_id = false
-    client = HTTPClient.new(@server)
     File.open(file_name) do |file|
       body = { 
         'project-file' => file,
-        'project-name' => "awesome"
+        'project-name' => project_name
       }
       response = client.post(uri, body)
       url = response.header['Location']
@@ -29,38 +46,75 @@ class Refine
     project_id
   end
 
-  def apply_operations(file_name)
-    raise "You must create a project" unless @project_id
-    uri = @server + "/command/core/apply-operations?project=#{@project_id}"
-    client = HTTPClient.new(@server)
-    File.open(file_name) do |file|
-      body = { 
-        'operations' => file.read
-      }
-      @response = client.post(uri, body)
+  def apply_operations(file_name_or_string)
+    if File.exists?(file_name_or_string)
+      operations = File.read(file_name_or_string)
+    else
+      operations = file_name_or_string
     end
-    JSON.parse(@response.content)['code'] rescue false
+
+    call('apply-operations', 'operations' => file_name_or_string)
   end
 
-  def export_rows(format='tsv')
+  def export_rows(opts={})
+    format = opts["format"] || 'tsv'
     uri = @server + "/command/core/export-rows/#{@project_name}.#{format}"
-    client = HTTPClient.new(@server)
+
     body = {
-      'engine' => '{"facets":[],"mode":"row-based"}',
+      'engine' => {
+        "facets" => opts["facets"] || [],
+        "mode" => "row-based"
+      }.to_json,
+      'options' => opts["options"] || '',
       'project' => @project_id,
       'format' => format
     }
+
     @response = client.post(uri, body)
     @response.content
   end
 
   def delete_project
     uri = @server + "/command/core/delete-project"
-    client = HTTPClient.new(@server)
     body = {
       'project' => @project_id
     }
     @response = client.post(uri, body)
     JSON.parse(@response.content)['code'] rescue false
   end
+
+  # this pattern is pulled from mailchimp/mailchimp-gem
+
+  def call(method, params = {})
+    uri = "#{@server}/command/core/#{method}"
+    params = { "project" => @project_id }.merge(params)
+
+    response = if method.start_with?('get-')
+      client.get(uri, params)
+    else
+      client.post(uri, params)
+    end
+
+    begin
+      response = JSON.parse(response.body)
+    rescue
+      response = JSON.parse('[' + response.body + ']').first
+    end
+
+    if @throws_exceptions && response.is_a?(Hash) && response["code"] && response["code"] == "error"
+      raise "API Error: #{response}"
+    end
+
+    response
+  end
+
+  def method_missing(method, *args)
+    # translate: get_column_info --> get-column-info
+    call(method.to_s.gsub('_', '-'), *args)
+  end
+
+  protected
+    def client
+      @client ||= HTTPClient.new(@server)
+    end
 end

metadata

@@ -1,66 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: google-refine
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Max Ogden
+- Michael Bianco
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-22 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 4
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: httpclient
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 125
-        segments: 
-        - 2
-        - 1
-        - 6
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.6.1
   type: :runtime
-  version_requirements: *id002
-description: Client library for interacting with Google Refine instances
-email: max@maxogden.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.6.1
+description: Client library for interacting with Google Refine instances. Easily work
+  with CSVs from the command line
+email:
+- max@maxogden.com
+- info@cliffsidedev.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.textile
-files: 
+files:
 - LICENSE
 - README.textile
 - Rakefile
@@ -70,39 +64,29 @@ files:
 - test/dates.txt
 - test/operations.json
 - test/test.rb
-has_rdoc: true
 homepage: http://github.com/maxogden/refine-ruby
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Client library for interacting with Google Refine instances
-test_files: 
+test_files:
 - test/test.rb