google-refine 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 David Huynh & Max Ogden
+
+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.textile

@@ -0,0 +1,80 @@
+<h1>google-refine</h1> is a Ruby Gem client library for "Google Refine":http://code.google.com/p/google-refine/
+
+h2. Install
+
+@gem install google-refine@
+
+h2. Example
+
+Given that you have the following raw data:
+
+<pre>
+  <code>
+    Date
+    7 December 2001
+    July 1 2002
+    10/20/10
+  </code>
+</pre>
+
+Google Refine lets you clean up the data and export your operation history as a JSON instruction set. Here is an example that extracts the year from the above dates:
+
+<pre>
+<code>
+  [
+    {
+      "op": "core/text-transform",
+      "description": "Text transform on cells in column Date using expression grel:value.toDate()",
+      "engineConfig": {
+        "facets": [],
+        "mode": "row-based"
+      },
+      "columnName": "Date",
+      "expression": "grel:value.toDate()",
+      "onError": "set-to-blank",
+      "repeat": false,
+      "repeatCount": 10
+    },
+    {
+      "op": "core/text-transform",
+      "description": "Text transform on cells in column Date using expression grel:value.datePart(\"year\")+1",
+      "engineConfig": {
+        "facets": [],
+        "mode": "row-based"
+      },
+      "columnName": "Date",
+      "expression": "grel:value.datePart(\"year\")",
+      "onError": "set-to-blank",
+      "repeat": false,
+      "repeatCount": 10
+    }
+  ]
+</code>
+</pre>
+
+You can use this gem to apply the operation set to the raw data from ruby. You will need to have Google Refine running on your local computer, or specify an external address (see source):
+
+<pre>
+  <code>
+    prj = Refine.new('date cleanup', 'dates.txt')
+    prj.apply_operations('operations.json')
+    puts prj.export_rows('csv')
+    prj.delete_project
+  </code>
+</pre>
+
+Which outputs:
+
+<pre>
+  <code>
+    Date
+    2001
+    2002
+    2010
+  </code>
+</pre>
+
+h2. Copyright
+
+Copyright (c) 2010 Max Ogden. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "google-refine"
+    gem.summary = %Q{Client library for interacting with Google Refine instances}
+    gem.description = %Q{Client library for interacting with Google Refine instances}
+    gem.email = "max@maxogden.com"
+    gem.homepage = "http://github.com/maxogden/refine-ruby"
+    gem.authors = ["Max Ogden"]
+    gem.add_dependency "json", ">= 1.4.6"
+    gem.add_dependency "httpclient", ">= 2.1.6.1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/google-refine.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+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.date = %q{2011-01-22}
+  s.description = %q{Client library for interacting with Google Refine instances}
+  s.email = %q{max@maxogden.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.textile"
+  ]
+  s.files = [
+    "LICENSE",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "google-refine.gemspec",
+    "lib/google-refine.rb",
+    "test/dates.txt",
+    "test/operations.json",
+    "test/test.rb"
+  ]
+  s.homepage = %q{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
+end
+

data/lib/google-refine.rb

@@ -0,0 +1,66 @@
+require 'httpclient'
+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
+  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"
+      }
+      response = client.post(uri, body)
+      url = response.header['Location']
+      unless url == []
+        project_id = CGI.parse(url[0].split('?')[1])['project'][0]
+      end
+    end
+    raise "Error creating project: #{response}" unless project_id
+    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)
+    end
+    JSON.parse(@response.content)['code'] rescue false
+  end
+
+  def export_rows(format='tsv')
+    uri = @server + "/command/core/export-rows/#{@project_name}.#{format}"
+    client = HTTPClient.new(@server)
+    body = {
+      'engine' => '{"facets":[],"mode":"row-based"}',
+      '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
+end

data/test/dates.txt

@@ -0,0 +1,4 @@
+Date
+7 December 2001
+July 1 2002
+10/20/10

data/test/operations.json

@@ -0,0 +1,28 @@
+[
+  {
+    "op": "core/text-transform",
+    "description": "Text transform on cells in column Date using expression grel:value.toDate()",
+    "engineConfig": {
+      "facets": [],
+      "mode": "row-based"
+    },
+    "columnName": "Date",
+    "expression": "grel:value.toDate()",
+    "onError": "set-to-blank",
+    "repeat": false,
+    "repeatCount": 10
+  },
+  {
+    "op": "core/text-transform",
+    "description": "Text transform on cells in column Date using expression grel:value.datePart(\"year\")",
+    "engineConfig": {
+      "facets": [],
+      "mode": "row-based"
+    },
+    "columnName": "Date",
+    "expression": "grel:value.datePart(\"year\")",
+    "onError": "set-to-blank",
+    "repeat": false,
+    "repeatCount": 10
+  }
+]

data/test/test.rb

@@ -0,0 +1,6 @@
+load '../lib/refine.rb'
+
+prj = Refine.new('date cleanup', 'dates.txt')
+prj.apply_operations('operations.json')
+puts prj.export_rows('csv')
+prj.delete_project

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: google-refine
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Max Ogden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 125
+        segments: 
+        - 2
+        - 1
+        - 6
+        - 1
+        version: 2.1.6.1
+  type: :runtime
+  version_requirements: *id002
+description: Client library for interacting with Google Refine instances
+email: max@maxogden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- google-refine.gemspec
+- lib/google-refine.rb
+- 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: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Client library for interacting with Google Refine instances
+test_files: 
+- test/test.rb