crowdkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 465723a6ac2f11feea2f347b1574cc49bc46a295
+  data.tar.gz: 527a5d9e1482d98e57f767015eee4792e6276b08
+SHA512:
+  metadata.gz: 575299ba50009f42385dac46185aec5e909c456a62b4b38a2cdecd5ece3e3432147d9c79d4f641833dfa8b06be7dd41442ee2b180900e68dd04864b2e44ce69f
+  data.tar.gz: 386d5c148f30af3b8ca843bddf20d92c7087b81369f4b1bfefea79da269ff19c285466746e6c92b323a92fa73f4fe0e017d5bdcf8d61a99ab2807db5e2e4520d

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "sawyer", "0.5.5"
+gem "ruby-progressbar"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "webmock"
+  gem "pry"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.2.0)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    ruby-progressbar (1.7.1)
+    safe_yaml (1.0.4)
+    sawyer (0.5.5)
+      addressable (~> 2.3.5)
+      faraday (~> 0.8, < 0.10)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  pry
+  rspec
+  ruby-progressbar
+  sawyer (= 0.5.5)
+  simplecov
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Chris Van Pelt
+
+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.md

@@ -0,0 +1,178 @@
+# CrowdKit
+
+CrowdKit is the official Ruby wrapper for the [CrowdFlower API v2](http://docs.crowdflower.apiary.io).
+
+CrowdKit is heavily inspired by Peter Murach's fantastic Github API gem: https://github.com/peter-murach/github.
+
+## Sample Usage
+
+```ruby
+require "crowdkit"
+
+#A reusable client instance
+@client = Crowdkit.new(access_token: "123abc")
+@client.jobs(12345).units.list do |unit|
+  puts unit.state
+end
+
+#Global configuration and a new client instance on every call to `Crowdkit`
+Crowdkit.configure do |c|
+  c.access_token = "123abc"
+end
+puts Crowdkit.units.get(unit_id: 54321)
+```
+
+## Contents
+
+1. [Configuration](#configuration)
+2. [Scopes & Parameters](#scopes--parameters)
+3. [Errors](#errors)
+4. [Example Usage](#example-usage)
+10. [Development](#development)
+
+## Configuration
+
+As demonstrated above, CrowdKit can be instantiated in one of two ways.  The `Crowdkit` namespace will proxy to a newly created client instance every time a defined method is called.  Alternatively calling `Crowdkit.new` will return a reusable client instance.  Configuration overrides can be passed into `Crowdkit.new` as a hash, or both `Crowdkit.new` and `Crowdkit.configure` accept a block that receives a configuration object as demonstrated below.
+
+```ruby
+Crowdkit.new(debug: true)
+Crowdkit.new do |config|
+  config.debug = true
+end
+Crowdkit.configure do |config|
+  config.debug = true
+end
+```
+
+### Configuration Variables
+
+Variable | Definition
+---------|------------
+*access_token* | Your CrowdFlower Access Token found on your account page, required for API access.
+*per_page* | The number of results to request per page.  By default 10.
+*debug* | Enabling this will log all API activity for debugging purposes.
+*adapter* | The HTTP adapter to use, by default :net_http, other options are: :net_http_persistent, :typhoeus, :patron, :em_synchrony, :excon, :test
+*user_agent* | The user agent, by default "CrowdKit Ruby Gem {version}".
+*auto_paginate* | Whether or not to automatically paginate through collections, default: false.
+*api_endpoint* | A custom API endpoint, default: https://api.crowdflower.com/v2
+*ssl* | By default the client is configured to use OpenSSL::SSL::VERIFY_PEER, to disable peer verification set this to `{ verify: false }`
+
+### Environment Variables
+
+Lastly, Crowdkit looks for all configuration variables in the environment with the following format: `CROWDKIT_{upcased_variable_name}` i.e. `CROWDKIT_ACCESS_TOKEN=abc123`
+
+### Advanced Configuration
+
+Crowdkit uses Faraday and exposes a `stack` configuration parameter.  `stack` can be freely modified with methods such as `insert`, `insert_after`, `delete` and `swap`.  Additionally, if you're feeling adventurous you can override the default stack completely:
+
+```ruby
+Crowdkit.configure do |config|
+  config.stack.insert CustomMiddleware
+end
+
+Crowdkit.configure do |config|
+  config.stack do |builder|
+    builder.use CustomMiddleware
+    builder.use Crowdkit::Middleware::RaiseError
+    builder.adapter :excon
+  end
+end
+```
+
+### Scopes & Parameters
+
+Crowdkit operates within scopes appropriate to the CrowdFlower API.  The most common scope is `jobs`.  Parameters can be passed into any scope and will be used by the API method. i.e.
+
+```ruby
+client.jobs(state: "finished").list
+```
+
+Ofcourse the API methods themselves also accept parameters
+
+```ruby
+client.jobs.list(state: "finished")
+```
+
+Most scopes accept an optional first parameter that will be translated to the primary key of the scope for convenience. i.e.
+
+```ruby
+client.units(54321).get
+client.jobs.search("whatever")
+```
+
+The above is equivalent to the following:
+
+```ruby
+client.units.get(unit_id: 54321)
+client.jobs.search(query: "whatever")
+```
+
+Lastly Crowdkit also provides a `with` method to clearly denote your scopes.
+
+```ruby
+client.with(unit_id: 54321).units.get
+```
+
+### Errors
+
+All errors thrown by the client inherit from `Crowdkit::Error`.  There are two primary types of errors: `Crowdkit::UserError` and `Crowdkit::ServiceError`.  User errors are thrown when local validations fail while service errors are thrown when we receive invalid response codes from the CrowdFlower servers.
+
+### Example Usage
+
+#### Get statistics for jobs with a given tag
+
+```ruby
+jobs = client.jobs.search("url", fields: ["tags"])
+jobs.each do |job|
+  pp job.stats
+end
+```
+
+#### Copying a job and ordering all units
+
+```ruby
+new_job = client.jobs(101010).copy(all_units: true)
+CrowdKit.wait_on_status(new_job)
+order = client.jobs(new_job.id).order
+CrowdKit.wait_on_status(order)
+```
+
+#### Sum unit states for all units in a job
+
+```ruby
+client.jobs(101010).units.list(auto_pagination: true).inject(Hash.new(0)) do |memo, unit|
+  memo[unit.state] += 1
+  memo
+end
+```
+
+#### Poll a job for completed units
+
+```ruby
+while true
+  units = client.jobs(101010).units.poll
+  if units.any?
+    units.each do |unit|
+      # Do something with the resulting data
+      result = unit.aggregate_result
+      # We also support acknowledging individual units if you want more granularity i.e.
+      # result.delete
+    end
+    # This acknowledges all units in one request but assumes the above code will
+    # complete in less than 30 seconds if you have multiple pollers.
+    units.delete
+  else
+    sleep 10
+  end
+end
+```
+
+### Development
+
+All scopes are defined in the `client` directory and inherit from API.  The API class provides the following convenience methods for defining API's:
+
+  *arguments:* parses arguments and let's you specify which if any are required: `arguments(args, required: [:job_id])`
+
+  *do_{http_verb}:* performs the specified http_verb.
+
+  *namespace:* attaches a scope and uses the class defined with `class_name` to instantiate it: `namespace :units, class_name: "Client::Units"`

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "crowdkit"
+  gem.homepage = "http://github.com/crowdflower/crowdkit.rb"
+  gem.license = "MIT"
+  gem.summary = %Q{CrowdFlower ruby API client}
+  gem.description = %Q{A flat API client that sits atop the CrowdFlower API}
+  gem.email = "vanpelt@crowdflower.com"
+  gem.authors = ["Chris Van Pelt"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :pry do
+  `pry --gem -r crowdkit`
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "crowdkit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/crowdkit.gemspec

@@ -0,0 +1,122 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: crowdkit 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "crowdkit"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Chris Van Pelt"]
+  s.date = "2015-01-09"
+  s.description = "A flat API client that sits atop the CrowdFlower API"
+  s.email = "vanpelt@crowdflower.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "crowdkit.gemspec",
+    "lib/crowdkit.rb",
+    "lib/crowdkit/api.rb",
+    "lib/crowdkit/api/arguments.rb",
+    "lib/crowdkit/api/factory.rb",
+    "lib/crowdkit/api/request_methods.rb",
+    "lib/crowdkit/api/response_wrapper.rb",
+    "lib/crowdkit/client.rb",
+    "lib/crowdkit/client/account.rb",
+    "lib/crowdkit/client/jobs.rb",
+    "lib/crowdkit/client/judgments.rb",
+    "lib/crowdkit/client/poll.rb",
+    "lib/crowdkit/client/statuses.rb",
+    "lib/crowdkit/client/units.rb",
+    "lib/crowdkit/client/workers.rb",
+    "lib/crowdkit/client/worksets.rb",
+    "lib/crowdkit/config.rb",
+    "lib/crowdkit/core_ext/array.rb",
+    "lib/crowdkit/core_ext/hash.rb",
+    "lib/crowdkit/core_ext/sawyer.rb",
+    "lib/crowdkit/error.rb",
+    "lib/crowdkit/middleware/raise_error.rb",
+    "lib/crowdkit/ssl_certs/cacerts.pem",
+    "lib/crowdkit/version.rb",
+    "spec/crowdkit/client/account_spec.rb",
+    "spec/crowdkit/client/jobs_spec.rb",
+    "spec/crowdkit/client/judgments_spec.rb",
+    "spec/crowdkit/client/statuses_spec.rb",
+    "spec/crowdkit/client/units_spec.rb",
+    "spec/crowdkit/client/workers_spec.rb",
+    "spec/crowdkit/client/worksets_spec.rb",
+    "spec/crowdkit/client_spec.rb",
+    "spec/crowdkit_spec.rb",
+    "spec/fixtures/account.json",
+    "spec/fixtures/jobs/copy.json",
+    "spec/fixtures/jobs/job.json",
+    "spec/fixtures/jobs/order.json",
+    "spec/fixtures/jobs/search.json",
+    "spec/fixtures/judgments/index.json",
+    "spec/fixtures/judgments/show.json",
+    "spec/fixtures/root.json",
+    "spec/fixtures/statuses/index.json",
+    "spec/fixtures/statuses/status.json",
+    "spec/fixtures/units/copy.json",
+    "spec/fixtures/units/index.json",
+    "spec/fixtures/units/poll/normal.json",
+    "spec/fixtures/units/poll/small.json",
+    "spec/fixtures/units/show.json",
+    "spec/fixtures/upload.csv",
+    "spec/fixtures/worksets/index.json",
+    "spec/fixtures/worksets/show.json",
+    "spec/spec_helper.rb",
+    "spec/support/base.rb"
+  ]
+  s.homepage = "http://github.com/crowdflower/crowdkit.rb"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.0"
+  s.summary = "CrowdFlower ruby API client"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sawyer>, ["= 0.5.5"])
+      s.add_runtime_dependency(%q<ruby-progressbar>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<sawyer>, ["= 0.5.5"])
+      s.add_dependency(%q<ruby-progressbar>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sawyer>, ["= 0.5.5"])
+    s.add_dependency(%q<ruby-progressbar>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+