multichoice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5abd476d3dea81ee3313944da5f7d55fd26a772c
+  data.tar.gz: 543c9ba81467d4d4b72a75edc264e9d511b7800f
+SHA512:
+  metadata.gz: 78da0c0b618873fe8d8427cec59ee797bb95a0c50b88e697490781404dbbc2adb2a2f79e3f148160ae1fe98452c4e1d034662f3d4bb465d71f48fcdb9c40cbb8
+  data.tar.gz: 35f3ba9d23c6e5bf3b834d13c162e8e21cb2c83ce08bad5012f1d8ff83a6007761a2363adb02c5f82110b9380ec2380ddbb7806224ef170d960ef4965909ad4a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multichoice.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Floyd Wallace
+
+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,140 @@
+# Multichoice
+
+The gem takes Amazon MTurk's XML Spec file and adds the multiple choice elements with RADIO BUTTONS
+please note that you can supply as many and as varied elements as you want
+for each Human Intelligence Task or HIT.
+
+The Gem was written to enable users to rapidly create a Human Intelligence Task that has RADIO BUTTONS.
+
+#Arguments:
+  *over_view_text is the overview for the Question you are asking Mturkers
+
+  *identifier: format "Your_Name - HitNumber", example "John_Smith-1"
+
+  *question: format "something you want to ask", example "Which of these is a cat?"
+
+  *possibles: format ['A tabby cat', 'Leo Di Caprio since his name is Leo', 'Cat Stevens', 'The Year of the Cat by Al Stewart because Seventies Man!', 'None of the Above']
+
+  *possibles is the only argument that is NOT A STRING, but an array.
+
+  *possibles must have AT LEAST ONE ARRAY ELEMENT, which is at least one possible answer to the question. But to make sense to the Mturker workers you should have at least two, i.e
+  
+  *possibles = ['The Band Stray Cats', 'None of the Above']
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multichoice'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multichoice
+
+## Usage
+Try this sample code out:
+
+```ruby
+require "multichoice"
+require 'mturk'
+require 'yaml'
+
+module TestCreateHit
+  class AmazonMturkHit
+
+    def initialize
+      read_config
+      @mturk = Amazon::WebServices::MechanicalTurkRequester.new :Host => @T_Host, :AWSAccessKeyId => @T_AWSAccessKeyId, :AWSAccessKey => @T_AWSAccessKey
+
+    end
+
+
+    def read_config
+      config = YAML.load_file("mturk.yaml")
+      @T_Host = config["Host"]
+      @T_AWSAccessKeyId = config["AWSAccessKeyId"]
+      @T_AWSAccessKey = config["AWSAccessKey"]
+    end
+
+
+    def create_hit
+      over_view_text = "This is a HIT to choose which of the following is a cat"
+      identifier = "John_Smith-3"
+      question = "Which of the following is a feline?"
+      possibles = ['Cat Stevens', 'The Year of the Cat by Al Stewart, The Seventies Man', 'Leo DiCaprio because his name is Leo', 'a tabby cat', 'None of the Above, they are all wrong']
+      my_xml = MultiChoice::RadioButton.new(over_view_text, identifier, question, possibles).execute
+      available = @mturk.availableFunds.to_f
+      puts "Available funds = #{available}"
+      title = "Question about CATS"
+      desc = "This is a HIT to answer questions about CATS"
+      keywords = "cats, match"
+      numAssignments = 1
+      my_LifetimeInSeconds = 604800
+      #one week lifetime
+      #autoapproval = 5 days
+      my_auto_approve = 60*60*24*5
+      rewardAmount = 0.09 # 9 cents
+
+
+      #create the HIT
+      result = @mturk.createHIT( :Title => title,
+          :Description => desc,
+          :MaxAssignments => numAssignments,
+          :LifetimeInSeconds => my_LifetimeInSeconds,
+          :AutoApprovalDelayInSeconds => my_auto_approve,
+
+          :Reward => { :Amount => rewardAmount, :CurrencyCode => 'USD' },
+          :Question => my_xml,
+          :Keywords => keywords )
+      #---------------------
+      #display Hit info
+      puts "Created HIT: #{result[:HITId]}"
+      myhit_id = result[:HITId]
+      myhit_type_id = result[:HITTypeId]
+      puts "HIT TYPE ID : #{myhit_type_id}"
+      my_hit_location = getHITUrl(result[:HITTypeId])
+      puts "HIT Location: #{getHITUrl( result[:HITTypeId])}"
+
+
+    end
+
+
+    def getHITUrl( hitTypeId )
+        if @mturk.host =~ /sandbox/
+            "http://workersandbox.mturk.com/mturk/preview?groupId=#{hitTypeId}"   # Sandbox Url
+        else
+             "http://mturk.com/mturk/preview?groupId=#{hitTypeId}"   # Production Url
+        end
+    end
+
+
+  end
+end
+
+TestCreateHit::AmazonMturkHit.new.create_hit
+```
+
+## TODO
+
+Still to come are checkboxes as well as radio buttons and retrieving the answer and parsing it for the good stuff.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fwallace99/multichoice.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multichoice"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multichoice.rb

@@ -0,0 +1,86 @@
+require "multichoice/version"
+#require "mturk"
+
+module MultiChoice
+  #takes Amazon MTurk's XML Spec file and adds the multiple choice elements with RADIO BUTTONS
+  #please note that you can supply as many and as varied elements as you want
+  #for each Human Intelligence Task or HIT.
+
+  #Arguments: over_view_text is the overview for the Question you are asking Mturkers
+  #identifier: format "Your_Name - HitNumber", example "John_Smith-1"
+  #question: format "something you want to ask", example "Which of these is a cat?"
+  #possibles: format ['A tabby cat', 'Leo Di Caprio since his name is Leo', 'Cat Stevens', 'The Year of the Cat by Al Stewart because Seventies Man!', 'None of the Above']
+  #possibles is the only argument that is NOT A STRING, but an array.
+  #possibles must have AT LEAST ONE ARRAY ELEMENT, which is at least one possible answer to the question. But to make sense to the Mturker workers you should have at least two, i.e
+  # possibles = ['The Band Stray Cats', 'None of the Above']
+  class RadioButton
+
+  def initialize(over_view_text, identifier, question, possibles)
+    @over_view_text = over_view_text
+    @identifier = identifier
+    @question = question
+    @possibles = possibles
+  end
+
+  def execute
+    spitoutxml
+  end
+
+  def spitoutxml
+    base_xml = <<HERE
+<?xml version="1.0" encoding="UTF-8"?>
+    <QuestionForm xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd">
+      <Overview>
+      <Text>#{@over_view_text}</Text>
+      </Overview>
+      <Question>
+HERE
+
+    mylocal_identifier = "<QuestionIdentifier>#{@identifier}</QuestionIdentifier>"
+    my_sku = "<QuestionContent>\n"
+    my_sku = my_sku + "<Text>#{@question}</Text>\n"
+    my_sku = my_sku + "</QuestionContent>\n"
+    base_xml = base_xml + mylocal_identifier + my_sku
+
+    top_answer_spec = <<ANS1
+         <AnswerSpecification>
+         <SelectionAnswer>
+      <StyleSuggestion>radiobutton</StyleSuggestion>
+      <Selections>
+ANS1
+
+    base_xml = base_xml + top_answer_spec
+    my_answer = ''
+
+
+    @possibles.each do |myelement|
+
+        my_answer_spec = "<Selection>\n"
+        spec_ident = "<SelectionIdentifier>#{myelement}</SelectionIdentifier>\n"
+        sel_text = "<Text>#{myelement}</Text>\n"
+        close_spec = "</Selection>\n"
+        my_temp = my_answer_spec + spec_ident + sel_text + close_spec
+        my_answer = my_answer + my_temp
+
+       end
+
+
+    base_xml = base_xml + my_answer
+
+    bottom_answer = <<BOTTOM
+
+
+      </Selections>
+    </SelectionAnswer>
+       </AnswerSpecification>
+      </Question>
+    </QuestionForm>
+BOTTOM
+    base_xml = base_xml + bottom_answer
+
+    return base_xml
+  end
+
+
+ end
+end

data/lib/multichoice/version.rb

@@ -0,0 +1,3 @@
+module Multichoice
+  VERSION = "0.1.0"
+end

data/multichoice.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multichoice/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multichoice"
+  spec.version       = Multichoice::VERSION
+  spec.authors       = ["Floyd Wallace"]
+  spec.email         = ["fwallace99@gmail.com"]
+
+  spec.summary       = %q{Creates a Multiple Choice Amazon Mechanical Turk Human Intellgince Task using radio buttons.}
+  spec.description   = %q{Create Checkboxes and also parse the answer for a HIT.}
+  spec.homepage      = "https://github.com/fwallace99/multichoice"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/multichoice_array_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class MultichoiceTest2 < Minitest::Test
+
+  def possibles_is_array
+    possibles = ['Cat Stevens', 'The Year of the Cat by Al Stevens, Seventies Man', 'Leo DiCaprio because his name is Leo', 'a tabby cat', 'None of the Above, they are all wrong']
+    assert_equal('Array', possibles.class)
+
+  end
+
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: multichoice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Floyd Wallace
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Create Checkboxes and also parse the answer for a HIT.
+email:
+- fwallace99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multichoice.rb
+- lib/multichoice/version.rb
+- multichoice.gemspec
+- multichoice_array_test.rb
+homepage: https://github.com/fwallace99/multichoice
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Creates a Multiple Choice Amazon Mechanical Turk Human Intellgince Task using
+  radio buttons.
+test_files: []