CrowdFlower API Gem

Currently this is a toolkit for interacting with the CrowdFlower REST API. It may potentially become a complete Ruby gem for accessing and editing CrowdFlower jobs.

Getting Started
Usage and Examples
Helpful Documentation Links
Contribute
Team
License

Getting Started

Add this line to your application's Gemfile:

$ gem 'crowdflower'

Then execute:

$ bundle install

Or install it yourself as:

$ gem install crowdflower

And require the gem in your ruby file as:

require 'crowdflower'

This gem makes use of CrowdFlower's API. To find your API key, click on your name in the upper right hand corner and select "Account" from the drop down. To create an account click here.

Specify your api key directly in your code or store it in a yaml file:

API_KEY = "YOUR_API_KEY"

CrowdFlower.connect!( 'CrowdFlower.yaml' )

Usage and Examples

Example Job - referenced throught the following examples (must be signed in to view).

Access Job Info

require 'crowdflower'

API_KEY = "YOUR_API_KEY"
DOMAIN_BASE = "https://api.crowdflower.com"

CrowdFlower::Job.connect! API_KEY, DOMAIN_BASE

job = CrowdFlower::Job.new(job_id)
job = CrowdFlower::Job.new(418404)

Create Blank Job

require 'crowdflower'

API_KEY = "YOUR_API_KEY"
DOMAIN_BASE = "https://api.crowdflower.com"

CrowdFlower::Job.connect! API_KEY, DOMAIN_BASE

title = "Crowdshop for Shoes!"
job = CrowdFlower::Job.create(title)

Copy Existing Job

require 'crowdflower'

API_KEY = "YOUR_API_KEY"
DOMAIN_BASE = "https://api.crowdflower.com"
JOB_ID = 418404

CrowdFlower::Job.connect! API_KEY, DOMAIN_BASE

job_one = CrowdFlower::Job.new(job_id)
job_two = job_one.copy

Available Features (Methods)

GET - https://crowdflower.com/jobs/418404.json

job.get["css"]
job.get["auto_order"]
job.get["units_remain_finalized"]
job.get["secret"]
job.get["support_email"]
job.get["golds_count"]
job.get["units_count"]
job.get["included_countries"]
job.get["desired_requirements"]
job.get["max_judgments_per_unit"]
job.get["instructions"]
job.get["auto_order_timeout"]
job.get["public_data"]
job.get["project_number"]
job.get["problem"]
job.get["created_at"]
job.get["send_judgments_webhook"]
job.get["expected_judgments_per_unit"]
job.get["design_verified"]
job.get["worker_ui_remix"]
job.get["fields"]
job.get["completed_at"]
job.get["auto_order_threshold"]
job.get["min_unit_confidence"]
job.get["minimum_account_age_seconds"]
job.get["units_per_assignment"]
job.get["execution_mode"]
job.get["max_judgments_per_worker"]
job.get["gold"]
job.get["require_worker_login"]
job.get["pages_per_assignment"]
job.get["title"]
job.get["completed"]
job.get["order_approved"]
job.get["minimum_requirements"]
job.get["max_judgments_per_ip"]
job.get["confidence_fields"]
job.get["gold_per_assignment"]
job.get["alias"]
job.get["id"]
job.get["judgments_count"]
job.get["js"]
job.get["cml"]
job.get["excluded_countries"]
job.get["updated_at"]
job.get["language"]
job.get["state"]
job.get["variable_judgments_mode"]
job.get["custom_key"]
job.get["options"]

UPLOAD (data to create units)

job.upload(filename, type, opts)
job.upload("crowdshopping.csv", "text/csv")

CHANNELS - http://api.crowdflower.com/v1/jobs/418404/channels

job.channels 
job.enable_channels(channels)
job.enable_channels("cf_internal")

TAGS - https://api.crowdflower.com/jobs/418404/tags

tags = "shoes", "shopping", "fashion"
job.add_tags(tags)
job.update_tags("fun", "glitter", "crowdshop")
job.remove_tags("crowdshop")

UNITS: http://api.crowdflower.com/v1/jobs/418404/units

unit = CrowdFlower::Unit.new(job)

UNIT.ALL: View all units or count all units in a job; same result as job.units.

unit.all 
unit.all.count

UNIT.GET: Get info about a unit by passing in the unit's ID.units.

unit.get(unit_id)

UNIT.PING: Returns the status of all units in a job.

unit.ping

UNIT.JUDGMENTS: View all judgments for a specific unit by passing in the unit_id.

unit.judgments(unit_id)
unit.judgments(444154130)

UNIT.CREATE: Create a new unit.

unit.create("glitter_color"=>"blue") 
unit.create("glitter_color"=>"blue", gold: true)

UNIT.COPY: Copy an existing unit.

unit.copy(unit_id, job_id, data = {})
unit.copy(444154130, 418404, "glitter_color"=>"blue")

UNIT.SPLIT: In cases where multiple values are stored in the cells of the same column, you can use the Split Column function to parse the data into two or more columns by specifying a delimiter (most typically a newline character).

unit.split(on, with = " ")

UNIT.UPDATE: Update the value of a unit's key.

unit.update(unit_id, params)
unit.update(444154130, "glitter_color"=>"green")

UNIT.MAKE_GOLD: Turn an existing unit into a test question (gold) unit.

unit.make_gold(unit_id)

UNIT.CANCEL: Cancel a unit.

unit.cancel(unit_id)

UNIT.DELETE: Delete a unit.

unit.delete(unit_id)

UNIT.REQUEST_MORE_JUDGMENTS: Get more answers (judgments) for a specific unit by using this method with the unit's id and the amount of requested judgments passed as params.

unit.request_more_judgments(unit_id, nb_judgments = 1)

ORDER: Set up an order using your job's id.

order = CrowdFlower::Order.new(job)

ORDER.DEBIT: When a job has data (units) and properly working cml, it is ready to launch. The launch tab on the job dashboard is the same as calling order.debit.

# defaults to on_demand channels
order.debit(units_count, channels = ["on_demand"])

# pass in specific channel name to launch job w/ that channel
order.debit(6, "cf_internal")

PAUSE: Only can be called on running jobs.

job.pause

RESUME: Only can be called on paused or completed jobs.

job.resume

CANCEL: Only can be called on paused jobs.

job.cancel

UPDATE: Update any of the JSON attributes that get can access. Scroll up to GET to see the full list of accessible attributes.

job.update
job.update("project_number"=>"PN123")

DELETE: Delete the entire job.

job.delete

WORKERS: http://api.crowdflower.com/v1/jobs/418404/workers

worker = CrowdFlower::Worker.new(job)

WORKER.BONUS: Award a bonus in cents, 200 for $2.00 and (optionally) add a message

worker.bonus(worker_id, amount, reason=nil)
worker.bonus(23542619, 200, "You shoe shop like a pro! Thanks for the awesome answers!")

WORKER.REJECT: Stops contributors from completing tasks, and removes the contributors judgments from a job. Try to only use when a job is running, otherwise the completed job will lose judgments and be unable to collect replacement ones.

worker.reject(worker_id)
worker.reject(14952322)

WORKER.NOTIFY: Sends a notification to a specific contributor. The contributor will see the message under their notifications.

worker.notify(worker_id, subject, message)
worker.notify(23542619, "you earned a bonus!", "good job!")

WORKER.FLAG: Stops contributors from completing tasks. Their judgments remain in their current state of tainted or non-tainted and will not be thrown away.

worker.flag(worker_id, reason=nil)
worker.flag(14952322, "testing")

WORKER.DEFLAG: Allows a flagged contributor to continue completing tasks.

worker.deflag(worker_id)
worker.deflag(14952322)

JUDGMENTS - http://api.crowdflower.com/v1/jobs/418404/units/judgments

judgment = CrowdFlower::Judgment.new(job) 
judgment.all
judgment.get(judgment_id)
judgment.get(1239592918)

# Return every judgment for the given unit
job.units.judgments(unit_id_number) 
job.units.judgments(444154130)

LEGEND: Returns all of the cml in a job; shows all questions and available answers, see example: http://api.crowdflower.com/v1/jobs/418404/legend.

job.legend

STATUS: parsed JSON response or access attributes like GET

job.status
job.status["golden_units"]
job.status["all_judgments"]
job.status["tainted_judgments"]
job.status["completed_units_estimate"]
job.status["needed_judgments"]
job.status["all_units"]
job.status["completed_non_gold_estimate"]
job.status["completed_gold_estimate"]
job.status["ordered_units"]

DOWNLOAD_CSV: Downloads a CSV of the job with results, sometimes as csv and sometimes as a zip containing the CSV.

job.download_csv(type, filename, opts) 
job.download_csv(full, nil, force:true)

Helpful Documentation Links

Contribute

Fork the repo: https://github.com/dolores/ruby-crowdflower.git
Create your topic branch (git checkout -b my_branch)
Make changes and add tests for those changes
Commit your changes, making sure not to change the rakefile, version or history (git commit -am 'Adds cool, new README')
Push to your branch (git push origin my_branch)
Create an issue with a link to your branch for the pull request

Team

Check out the CrowdFlower Team!

License

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.

Please review our Terms and Conditions page for detailed api usage and licensing information.