bpo-ruby-crowdflower 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dolores Labs
+
+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.rdoc

@@ -0,0 +1,21 @@
+= ruby-crowdflower
+
+A toolkit for interacting with CrowdFlower via the REST API.
+
+This is alpha software in its most nascent stages, and is not 
+yet ready for use with the current version of CrowdFlower.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Dolores Labs. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-crowdflower"
+    gem.summary = %Q{a toolkit for the CrowdFlower API}
+    gem.description = <<-EOF
+A toolkit for interacting with CrowdFlower via the REST API.
+
+This is alpha software in its most nascent stages, and is not 
+yet ready for use with the current version of CrowdFlower.
+
+EOF
+    gem.email = "brian@doloreslabs.com"
+    gem.homepage = "http://github.com/dolores/ruby-crowdflower"
+    gem.authors = ["Brian P O'Rourke", "Chris Van Pelt"]
+    gem.add_dependency 'httparty', '>= 0.4.3'
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-crowdflower #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/ruby-crowdflower/crowdflower.rb

@@ -0,0 +1,132 @@
+module CrowdFlower
+  def self.connect!(key)
+    @@conn = Base.new(key)
+  end
+  
+  def self.conn
+    raise "Please establish a connection using 'CrowdFlower.connect!'" unless @@conn
+    @@conn.class
+  end
+  
+  class Base
+    include HTTParty
+
+    def initialize(key)
+      Base.default_params(:key => key)
+    end
+  end
+  
+  module Defaults
+    def self.included(base)
+      base.send :include, HTTParty
+      base.send :headers, "HTTP_ACCEPT" => "application/json"
+      base.send :format, :json
+    end
+  end
+  
+  class Job
+    include Defaults
+    attr_reader :job_id
+    
+    def initialize(job_id)
+      @job_id = job_id
+      Job.base_uri "https://api.crowdflower.com/v1/jobs"
+      Job.default_params(CrowdFlower.conn.default_params)
+    end
+    
+    def self.all
+      Job.get("/")
+    end
+    
+    def get(id = nil)
+      Job.get("/#{@job_id || id}")
+    end
+    
+    #Copies a job and optionally gold or all units.
+    #Parameters
+    #  opts: Hash
+    #    gold: when set to true copies gold units
+    #    all_units: when set to true copies all units
+    def copy(opts = {})
+      Job.get("/#{@job_id}/copy", {:query => opts})
+    end
+    
+    def status
+      Job.get("/#{@job_id}/ping")
+    end
+    
+    def download_csv(full = true, filename = nil)
+      filename ||= "#{full ? "f" : "a"}#{@job_id}.csv"
+      res = Job.get("/#{@job_id}.csv", {:format => :csv, :query => {:full => full}})
+      puts "Status... #{res.code.inspect}"
+      if res.code == 202
+        puts "CSV Generating... Trying again in 10 seconds."
+        Kernel.sleep 10
+        download_csv
+      else
+        puts "CSV written to: #{File.expand_path(filename)}"
+        File.open(filename, "w") {|f| f.puts res.body }
+      end
+    end
+    
+    def pause
+      Job.get("/#{@job_id}/pause")
+    end
+    
+    def resume
+      Job.get("/#{@job_id}/resume")
+    end
+    
+    def cancel
+      Job.get("/#{@job_id}/cancel")
+    end
+  end
+  
+  class Unit
+    include Defaults
+    
+    def initialize(job)
+      @job = job
+      Unit.base_uri "https://api.crowdflower.com/v1/jobs/#{@job.job_id}/units"
+      Unit.default_params(CrowdFlower.conn.default_params)
+    end
+    
+    def all(page = 1, limit = 1000)
+      Unit.get("", {:query => {:limit => limit, :page => page}})
+    end
+    
+    def get(id)
+      Unit.get("/#{id}")
+    end
+    
+    def create(data, gold = nil)
+      Unit.post("", {:query => {:unit => {:data => data.to_json, :golden => gold}}})
+    end
+    
+    def copy(unit_id, job_id, data = {})
+      Unit.get("/#{unit_id}/copy", {:query => {:unit => {:job_id => job_id, :data => data}}})
+    end
+    
+    def split(on, with = " ")
+      Unit.get("/split", {:query => {:on => on, :with => with}})
+    end
+  end
+  
+  class Judgment
+    include Defaults
+    
+    def initialize(job)
+      Judgment.base_uri "https://api.crowdflower.com/v1/jobs/#{@job.job_id}/judgments"
+      Judgment.default_params(CrowdFlower.conn.default_params)
+    end
+    
+    #Pull every judgment
+    def all(page = 1, limit = 1000)#full = true
+      Judgment.get("", {:query => {:limit => limit, :page => page}})
+    end
+    
+    def get(id)
+      Judgment.get("/#{id}")
+    end
+  end
+end

data/lib/ruby-crowdflower/httparty.rb

@@ -0,0 +1,30 @@
+module HTTParty
+  class Request
+    def handle_response(response)
+      case response
+        when Net::HTTPRedirection
+          options[:limit] -= 1
+        
+          self.path = response['location']
+          @redirect = true
+          @message = parse_response(response.body.to_s) rescue nil
+          perform
+        else
+          parsed_response = parse_response(response.body.to_s)
+          Response.new(parsed_response, response.body.to_s, response.code, @message || response.message, response.to_hash)
+        end
+    end
+    
+    def uri
+      # Don't use relative path on redirect
+      new_uri = path.relative? && !@redirect ? URI.parse("#{options[:base_uri]}#{path}") : path
+      
+      # avoid double query string on redirects [#12]
+      unless @redirect
+        new_uri.query = query_string(new_uri)
+      end
+      
+      new_uri
+    end
+  end
+end

data/lib/ruby-crowdflower.rb

@@ -0,0 +1,3 @@
+require 'httparty'
+require 'ruby-crowdflower/httparty'
+require 'ruby-crowdflower/crowdflower'

data/ruby-crowdflower.gemspec

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-crowdflower}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian P O'Rourke", "Chris Van Pelt"]
+  s.date = %q{2009-07-31}
+  s.description = %q{A toolkit for interacting with CrowdFlower via the REST API.
+
+This is alpha software in its most nascent stages, and is not 
+yet ready for use with the current version of CrowdFlower.
+
+}
+  s.email = %q{brian@doloreslabs.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/ruby-crowdflower.rb",
+     "lib/ruby-crowdflower/crowdflower.rb",
+     "lib/ruby-crowdflower/httparty.rb",
+     "ruby-crowdflower.gemspec",
+     "spec/ruby-crowdflower_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dolores/ruby-crowdflower}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{a toolkit for the CrowdFlower API}
+  s.test_files = [
+    "spec/ruby-crowdflower_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.3"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.3"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.4.3"])
+  end
+end

data/spec/ruby-crowdflower_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CrowdFlower do
+  it "has examples" do
+    pending "they need to be ported to the gem package"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'ruby-crowdflower'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: bpo-ruby-crowdflower
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Brian P O'Rourke
+- Chris Van Pelt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
+description: A toolkit for interacting with CrowdFlower via the REST API.  This is alpha software in its most nascent stages, and is not  yet ready for use with the current version of CrowdFlower.
+email: brian@doloreslabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/ruby-crowdflower.rb
+- lib/ruby-crowdflower/crowdflower.rb
+- lib/ruby-crowdflower/httparty.rb
+- ruby-crowdflower.gemspec
+- spec/ruby-crowdflower_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/dolores/ruby-crowdflower
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: a toolkit for the CrowdFlower API
+test_files: 
+- spec/ruby-crowdflower_spec.rb
+- spec/spec_helper.rb