scaleapi-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd1682c683487bf57533d8f7e15262377c34a08c
+  data.tar.gz: c55fce2c3b0be18af7617511919420c388505e79
+SHA512:
+  metadata.gz: 214b011b51c59ee19523f84f10d7d256e580f41e7ee11c87814e8bd2845f80e08446bbafd92387dca29b0b38cef31b5b13f522dc0fc7523dce16a67977b06fb9
+  data.tar.gz: 366e928aab8f116be689fe8cd6e14643097c9ed5d76f09e165758cba47a6f2c6ee9649bf6878fd82a9e739edf39cab52fcea80144c413605c1158ede152dc1e5

data/.document

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

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+1. Fork this project
+2. Create your feature branch `git checkout -b my-branch`
+3. Add yourself as a developer to `README.md`!
+4. Commit your changes `git commit -am 'Add some feature'`
+5. Push to the branch `git push origin my-new-feature`
+6. Create a pull request with the following format:
+
+```markdown
+## Description
+
+This pull request will be used to [fix|implement|...] the following [bugs|features|...].
+
+## Tasks
+
+- [ ] Uncompleted task nº1.
+- [x] Completed task nº2.
+- [x] Buy eggs.
+- [ ] Fix that strange bug.
+- [ ] Etc.
+
+## References
+
+- [Example reference](http://www.example.com)
+- [Wabit season!](https://www.youtube.com/watch?v=17ocaZb-bGg)
+```
+
+Remember that your help is always appreciated! :smile:

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'rest-client'
+gem 'activesupport'
+
+group :development do
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'juwelier', '~> 2.1.0'
+  gem 'pry'
+  gem 'pry-nav'
+end
+
+group :test do
+  gem 'test-unit'
+  gem 'shoulda', '>= 0'
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,121 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    domain_name (0.5.20160826)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.14.5)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2 (~> 1.0)
+    hashdiff (0.3.0)
+    hashie (3.4.4)
+    highline (1.7.8)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    juwelier (2.1.2)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    jwt (1.5.4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    netrc (0.11.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pkg-config (1.1.7)
+    power_assert (0.3.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (1.6.4)
+    rake (11.2.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (2.0.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    safe_yaml (1.0.4)
+    semver (1.0.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    slop (3.6.0)
+    test-unit (3.2.1)
+      power_assert
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    vcr (3.0.3)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.0)
+  juwelier (~> 2.1.0)
+  pry
+  pry-nav
+  rdoc (~> 3.12)
+  rest-client
+  shoulda
+  test-unit
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2016` `Daniel Herzog`
+
+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,237 @@
+# ScaleAPI for Ruby
+
+A simple ruby wrapper for the [Scale](http://www.scaleapi.com) HTTP API. Documentation for this API is available [here](https://docs.scaleapi.com/).
+
+This project uses [`juwelier`](https://github.com/flajann2/juwelier) for managing and releasing this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scaleapi-ruby'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install scaleapi-ruby
+```
+
+## Usage
+
+First, you need to initialize the Scale client:
+
+```ruby
+require 'scale'
+scale = Scale.setup api_key: 'YOUR_KEY_GOES_HERE',              # Required
+                    callback_key: 'YOUR CALLBACK_KEY_GOES_HERE' # Optional
+```
+
+Check [this]() for further information.
+
+### Tasks
+
+Most of these methods will return a `Scale::Resources::Task` object, which will contain information
+about the json response (task_id, status...).
+
+Any parameter available in the [documentation](https://docs.scaleapi.com) can be passed as an argument
+option with the corresponding type.
+
+The following endpoints for tasks are available:
+
+#### Create categorization task
+
+Check [this](https://docs.scaleapi.com/#create-categorization-task) for further information.
+
+```ruby
+task = scale.create_categorization_task(
+  callback_url: 'http://www.example.com/callback',
+  instruction: 'Is this company public or private?',
+  attachment_type: 'website',
+  attachment: 'http://www.google.com/',
+  categories: ['public', 'private']
+)
+```
+
+#### Create transcription task
+
+Check [this](https://docs.scaleapi.com/#create-transcription-task) for further information.
+
+```ruby
+task = scale.create_transcription_task(
+  callback_url: 'http://www.example.com/callback',
+  instruction: 'Transcribe the given fields. Then for each news item on the page, transcribe the information for the row.',
+  attachment_type: 'website',
+  attachment: 'http://www.google.com/',
+  fields: { title: 'Title of Webpage', top_result: 'Title of the top result' },
+  row_fields: { username: 'Username of submitter', comment_count: 'Number of comments' }
+)
+```
+
+#### Create phone call task
+
+Check [this](https://docs.scaleapi.com/#create-phone-call-task) for further information.
+
+```ruby
+scale.create_phonecall_task(
+  callback_url: 'http://www.example.com/callback',
+  instruction: "Call this person and tell me his email address. Ask if he's happy too.",
+  phone_number: '5055006865',
+  entity_name: 'Alexandr Wang',
+  fields: { email: 'Email Address' },
+  choices: ['He is happy', 'He is not happy']
+)
+```
+
+#### Create comparison task
+
+Check [this](https://docs.scaleapi.com/#create-comparison-task) for further information.
+
+```ruby
+scale.create_comparison_task(
+  callback_url: 'http://www.example.com/callback',
+  instruction: 'Do the objects in these images have the same pattern?',
+  attachment_type: 'image',
+  choices: ['yes', 'no'],
+  attachments: [
+    'http://i.ebayimg.com/00/$T2eC16dHJGwFFZKjy5ZjBRfNyMC4Ig~~_32.JPG',
+    'http://images.wisegeek.com/checkered-tablecloth.jpg'
+  ]
+)
+```
+
+#### Create annotation task
+
+Check [this](https://docs.scaleapi.com/#create-annotation-task-bounding-box) for further information.
+
+```ruby
+scale.create_comparison_task(
+  callback_url: 'http://www.example.com/callback',
+  instruction: 'Draw a box around each baby cow and big cow.',
+  attachment_type: "image",
+  attachment: "http://i.imgur.com/v4cBreD.jpg",
+  objects_to_annotate: ["baby cow", "big cow"]
+)
+```
+
+#### Retrieve task
+
+Check [this](https://docs.scaleapi.com/#retrieve-a-task) for further information.
+
+Retrieve a task given its id.
+
+```ruby
+task = scale.retrieve_task 'asdfasdfasdfasdfasdfasdf'
+task.id == 'asdfasdfasdfasdfasdfasdf' # true
+```
+
+#### Cancel task
+
+Check [this](https://docs.scaleapi.com/#cancel-a-task) for further information.
+
+Cancel a task given its id, only if it's not completed.
+
+```ruby
+task = scale.cancel_task 'asdfasdfasdfasdfasdfasdf'
+```
+
+#### List tasks
+
+Check [this](https://docs.scaleapi.com/#list-all-tasks) for further information.
+
+Retrieve a list (`Array`) of all tasks.
+
+```ruby
+tasks = scale.tasks
+tasks.all? { |t| t.is_a? Scale::Resources::Task } # true
+```
+
+### Callbacks
+
+This gem allows you to create and parse callback data, so it can be easily used for web applications:
+
+For example, for Ruby on Rails:
+
+```ruby
+# app/controllers/scale_api_controller.rb
+class ScaleApiController < ApplicationController
+  # POST /scale_api
+  def create
+    callback = scale.build_callback params, 'task', callback_key: request.headers['scale-callback-auth']
+    callback.response # Response content hash (code and result)
+    callback.task     # Scale::Resources::Task object
+  end
+end
+```
+
+Please note that callback validation is optional; omit it if no `callback_key` was passed to `Scale.build`
+builder.
+
+If the validation is enabled, the `build_callback` method will raise a `Scale::GenericError`, explaning that
+the tokens don't match. You can also use `valid_callback_key?` to test it:
+
+```rb
+# `scale.callback_key` is 'TEST'
+scale.valid_callback_key? 'FAKE' # false, because 'TEST' != 'FAKE'
+```
+
+## Error handling
+
+If something went wrong while making API calls, then exceptions will be raised automatically
+as a `Scale::GenericError` (or `Scale::HttpError`) runtime error. For example:
+
+```ruby
+begin
+  scale.create_categorization_task instructions: 'Some parameters are missing.'
+rescue Scale::HttpError => e
+  puts e.code # 400
+  puts e.exception # Missing parameter X
+  pust e.original_exception # Catched exception
+rescue Scale::GenericError => e
+  puts e.message # Missing parameter X
+end
+```
+
+## Custom options
+
+The api initialization accepts the following options:
+
+| Name | Description | Default |
+| ---- | ----------- | ------- |
+| `endpoint` | Endpoint used in the http requests. | https://api.scaleapi.com/v1/ |
+| `api_key` | API key used in the http requests. |  |
+| `callback_key` | API key used to validate callback POST requests. |  |
+| `default_request_params` | Default parameters (payload) for the API requests | |
+
+For example, `default_request_params` can be used to always set the same `callback_url` value:
+
+```rb
+scale = Scale.setup api_key: 'YOUR_KEY_GOES_HERE',              # Required
+                    callback_key: 'YOUR CALLBACK_KEY_GOES_HERE' # Optional
+                    default_request_params: {
+                      callback_url: 'http://www.example.com/callback'
+                    }
+
+# All callback requests will posted be made to http://www.example.com/callback
+scale.create_comparison_task(
+  instruction: 'Draw a box around each baby cow and big cow.',
+  attachment_type: "image",
+  attachment: "http://i.imgur.com/v4cBreD.jpg",
+  objects_to_annotate: ["baby cow", "big cow"]
+)
+```
+
+## Authors
+
+This project has been developed by:
+
+| Avatar | Name | Nickname | Email |
+| ------- | ------------- | --------- | ------------------ |
+| ![](http://www.gravatar.com/avatar/2ae6d81e0605177ba9e17b19f54e6b6c.jpg?s=64)  | Daniel Herzog | Wikiti | [wikiti.doghound@gmail.com](mailto:wikiti.doghound@gmail.com) |