scaleapi-ruby 0.0.1

data/test/helper.rb

@@ -0,0 +1,42 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'scale'
+
+class Test::Unit::TestCase
+  def scale
+    @scale ||= Scale.setup api_key: (ENV['SCALE_API_KEY'] || 'test_abcdefghijklmopqrstuvwxyz'),
+                           default_request_params: { callback_url: 'http://www.example.com/callback' },
+                           callback_key: 'TEST'
+  end
+
+  def load_file(file)
+    File.read "test/fixtures/#{file}"
+  end
+
+  def load_json(file)
+    Scale.hash JSON.parse(load_file(file))
+  end
+end
+
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+  config.default_cassette_options = config.default_cassette_options.merge(
+    match_requests_on: %i(method uri host path query body headers),
+    record: :new_episodes
+  )
+end

data/test/tasks/test_cancel_task.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class TestCancelTask < Test::Unit::TestCase
+  context 'cancel a completed task' do
+    should 'raise an error' do
+      VCR.use_cassette 'tasks' do
+        # First, create a task
+        task = scale.create_phonecall_task 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']
+
+        # Then, try canceling it
+        assert_raise Scale::HttpError do
+          scale.cancel_task task.id
+        end
+      end
+    end
+  end
+end

data/test/tasks/test_create_annotation_task.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class TestCreateAnnotationTask < Test::Unit::TestCase
+  context 'create a annotation task' do
+    setup do
+      @valid_parameters = Scale.hash 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"],
+                                     with_labels: true
+
+      @invalid_parameters = Scale.hash
+    end
+
+    should 'create a valid annotation task' do
+      VCR.use_cassette 'tasks' do
+        task = scale.create_annotation_task @valid_parameters
+        assert_equal task.class, Scale::Resources::Task
+        assert_equal task.params, @valid_parameters.select { |k| %Q(attachment_type attachment objects_to_annotate with_labels).include? k.to_s }
+      end
+    end
+
+    should 'raise a 400 (bad request) error with invalid parameters' do
+      VCR.use_cassette 'tasks' do
+        assert_raise Scale::HttpError do
+          scale.create_annotation_task @invalid_parameters
+        end
+
+        begin
+          scale.create_annotation_task @invalid_parameters
+        rescue => e
+          exception = e
+        end
+
+        assert_equal exception.code, 400
+        assert_equal exception.message, 'Please provide a plaintext instruction to the worker in the instruction field.'
+      end
+    end
+  end
+end

data/test/tasks/test_create_categorization_task.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class TestCreateCategorizationTask < Test::Unit::TestCase
+  context 'create a categorization task' do
+    setup do
+      @valid_parameters = Scale.hash instruction: 'Is this company public or private?',
+                                     attachment_type: 'website',
+                                     attachment: 'http://www.google.com/',
+                                     categories: ['public', 'private'],
+                                     allow_multiple: false
+
+      @invalid_parameters = Scale.hash instruction: 'Test instruction'
+    end
+
+    should 'create a valid categorization task' do
+      VCR.use_cassette 'tasks' do
+        task = scale.create_categorization_task @valid_parameters
+        assert_equal task.class, Scale::Resources::Task
+        assert_equal task.params, @valid_parameters.select { |k| %Q(attachment_type attachment categories allow_multiple).include? k.to_s }
+      end
+    end
+
+    should 'raise a 400 (bad request) error with invalid parameters' do
+      VCR.use_cassette 'tasks' do
+        assert_raise Scale::HttpError do
+          scale.create_categorization_task @invalid_parameters
+        end
+
+        begin
+          scale.create_categorization_task @invalid_parameters
+        rescue => e
+          exception = e
+        end
+
+        assert_equal exception.code, 400
+        assert_equal exception.message, 'Please provide an attachment as a URL or plaintext.'
+      end
+    end
+  end
+end

data/test/tasks/test_create_comparison_task.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+class TestCreateAnnotationTask < Test::Unit::TestCase
+  context 'create a comparison task' do
+    setup do
+      @valid_parameters = Scale.hash 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'
+                                     ]
+
+      @invalid_parameters = Scale.hash instruction: 'Test instruction',
+                                       choices: ['a', 'b']
+    end
+
+    should 'create a valid comparison task' do
+      VCR.use_cassette 'tasks' do
+        task = scale.create_comparison_task @valid_parameters
+        assert_equal task.class, Scale::Resources::Task
+        assert_equal task.params, @valid_parameters.select { |k| %Q(attachment_type choices attachments).include? k.to_s }
+      end
+    end
+
+    should 'raise a 400 (bad request) error with invalid parameters' do
+      VCR.use_cassette 'tasks' do
+        assert_raise Scale::HttpError do
+          scale.create_comparison_task @invalid_parameters
+        end
+
+        begin
+          scale.create_comparison_task @invalid_parameters
+        rescue => e
+          exception = e
+        end
+
+        assert_equal exception.code, 400
+        assert_equal exception.message, 'Please provide attachments for the worker to compare for the task.'
+      end
+    end
+  end
+end

data/test/tasks/test_create_phonecall_task.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestCreatePhonecallTask < Test::Unit::TestCase
+  context 'create a phonecall task' do
+    setup do
+      @valid_parameters = Scale.hash 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']
+
+      @invalid_parameters = Scale.hash instruction: 'Test instruction',
+                                       phone_number: '5055006865'
+    end
+
+    should 'create a valid phone call task' do
+      VCR.use_cassette 'tasks' do
+        task = scale.create_phonecall_task @valid_parameters
+        assert_equal task.class, Scale::Resources::Task
+        assert_equal task.params, @valid_parameters.select { |k| %Q(phone_number entity_name fields choices).include? k.to_s }
+      end
+    end
+
+    should 'raise a 400 (bad request) error with invalid parameters' do
+      VCR.use_cassette 'tasks' do
+        assert_raise Scale::HttpError do
+          scale.create_phonecall_task @invalid_parameters
+        end
+
+        begin
+          scale.create_phonecall_task @invalid_parameters
+        rescue => e
+          exception = e
+        end
+
+        assert_equal exception.code, 400
+        assert_equal exception.message, 'Please provide an entity name (name, business name, etc.) corresponding to the phone number for the worker.'
+      end
+    end
+  end
+end

data/test/tasks/test_create_transcription_task.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestCreateTranscriptionTask < Test::Unit::TestCase
+  context 'create a categorization task' do
+    setup do
+      @valid_parameters = Scale.hash 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' }
+
+      @invalid_parameters = Scale.hash instruction: 'Test instruction',
+                                       attachment_type: 'website'
+    end
+
+    should 'create a valid transcription task' do
+      VCR.use_cassette 'tasks' do
+        task = scale.create_transcription_task @valid_parameters
+        assert_equal task.class, Scale::Resources::Task
+        assert_equal task.params, @valid_parameters.select { |k| %Q(attachment_type attachment fields row_fields).include? k.to_s }
+      end
+    end
+
+    should 'raise a 400 (bad request) error with invalid parameters' do
+      VCR.use_cassette 'tasks' do
+        assert_raise Scale::HttpError do
+          scale.create_transcription_task @invalid_parameters
+        end
+
+        begin
+          scale.create_transcription_task @invalid_parameters
+        rescue => e
+          exception = e
+        end
+
+        assert_equal exception.code, 400
+        assert_equal exception.message, 'Please provide an attachment as a URL or plaintext.'
+      end
+    end
+  end
+end

data/test/tasks/test_list_tasks.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestListTasks < Test::Unit::TestCase
+  context 'list available tasks' do
+    should 'retrieve a list of tasks' do
+      VCR.use_cassette 'tasks' do
+        tasks = scale.tasks
+        assert_equal(tasks.class, Array)
+        assert(tasks.count > 0)
+        assert tasks.all? { |t| t.is_a? Scale::Resources::Task }
+      end
+    end
+  end
+end

data/test/tasks/test_retrieve_task.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestRetrieveTask < Test::Unit::TestCase
+  context 'retrieve an available tasks' do
+    should 'return a task object' do
+      VCR.use_cassette 'tasks' do
+        # First, create a task
+        task1 = scale.create_phonecall_task 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']
+
+        # Retrieve that task, and compare it with the previous task
+        task2 = scale.retrieve_task task1.id
+        assert_equal(task1.id, task2.id)
+        assert_equal(task1.instruction, task2.instruction)
+        assert_equal(task1.callback_url, task2.callback_url)
+        assert_equal(task1.created_at, task2.created_at)
+      end
+    end
+  end
+
+  context 'retrieve a non existent tasks' do
+    setup do
+      @fake_task_id = 'abcdefghijklmn0123456789'
+    end
+
+    should 'raise an http error' do
+      VCR.use_cassette 'tasks' do
+        assert_raise Scale::HttpError do
+          scale.retrieve_task @fake_task_id
+        end
+      end
+    end
+  end
+end

data/test/test_api.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestAPI < Test::Unit::TestCase
+  context 'create a valid API handler' do
+    should 'create an API object with default parameters' do
+      assert_nothing_raised do
+        Scale.setup api_key: scale.api_key
+      end
+    end
+  end
+
+  context 'create an API handler with an invalid token' do
+    should 'raise an error' do
+      assert_raise Scale::GenericError do
+        Scale.setup api_key: ''
+      end
+    end
+  end
+
+  context 'create an API handler with an invalid endpoint' do
+    should 'raise an error' do
+      assert_raise Scale::GenericError do
+        Scale.setup endpoint: 'invalid-url'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: scaleapi-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Herzog
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby gem wrapper for the Scale API, containing all the endpoints available.
+email: info@danielherzog.es
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- ".document"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- lib/scale.rb
+- lib/scale/api.rb
+- lib/scale/callbacks/base.rb
+- lib/scale/callbacks/task.rb
+- lib/scale/endpoints/endpoint.rb
+- lib/scale/endpoints/tasks/cancel_task.rb
+- lib/scale/endpoints/tasks/create_annotation_task.rb
+- lib/scale/endpoints/tasks/create_categorization_task.rb
+- lib/scale/endpoints/tasks/create_comparison_task.rb
+- lib/scale/endpoints/tasks/create_phonecall_task.rb
+- lib/scale/endpoints/tasks/create_transcription_task.rb
+- lib/scale/endpoints/tasks/list_tasks.rb
+- lib/scale/endpoints/tasks/retrieve_task.rb
+- lib/scale/endpoints/tasks/task_endpoint.rb
+- lib/scale/generic_error.rb
+- lib/scale/http_error.rb
+- lib/scale/resources/base.rb
+- lib/scale/resources/task.rb
+- test/callbacks/test_task_callback.rb
+- test/fixtures/callback.json
+- test/fixtures/vcr_cassettes/tasks.yml
+- test/helper.rb
+- test/tasks/test_cancel_task.rb
+- test/tasks/test_create_annotation_task.rb
+- test/tasks/test_create_categorization_task.rb
+- test/tasks/test_create_comparison_task.rb
+- test/tasks/test_create_phonecall_task.rb
+- test/tasks/test_create_transcription_task.rb
+- test/tasks/test_list_tasks.rb
+- test/tasks/test_retrieve_task.rb
+- test/test_api.rb
+homepage: http://github.com/wikiti/scaleapi-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem wrapper for the Scale API
+test_files: []