dbgrandi-ruby-aws 1.2.0

data/History.txt

@@ -0,0 +1,38 @@
+== 1.2.0 / 2007-10-11
+
+=== 3 major enhancements
+* Threading optimizations for bulk convenience operations:
+  createHITs, updateHITs, and getHITResults
+* Paginated extension xxxAllProactive -- retrieves results proactively
+  via a threadpool
+* Paginated extension xxxIterator -- hands back an iterator instead
+  of buffered results, for streaming large result sets
+
+=== 2 minor enhancements
+* Enhanced test coverage
+* Rest transport now default (previously SOAP)
+
+== 1.1.1 / 2007-08-28
+
+=== 0 major enhancements
+
+=== 3 minor enhancements
+* createHITs now supports MaxAssignments correctly
+* Generate .zip file
+* Documentation correction
+
+== 1.1.0 / 2007-08-06
+
+=== 2 major enhancements
+* Updated for Mechanical Turk's 2007-06-21 WSDL (updateHIT, blockWorker)
+* Added enhanced error handling system with retry logic
+
+== 3 minor enhancements
+* Samples try to require rubygems
+* BlankSlate now disposes hits with pending assignments (approves them)
+* BlankSlate now aborts when it gets an Interrupt (CTRL-C)
+
+== 1.0.0 / 2007-07-13
+
+=== 1 major enhancement
+* Birthday!

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Manifest.txt

@@ -0,0 +1,69 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+NOTICE.txt
+README.txt
+Rakefile
+bin/ruby-aws
+lib/amazon/util.rb
+lib/amazon/util/binder.rb
+lib/amazon/util/data_reader.rb
+lib/amazon/util/filter_chain.rb
+lib/amazon/util/hash_nesting.rb
+lib/amazon/util/lazy_results.rb
+lib/amazon/util/logging.rb
+lib/amazon/util/paginated_iterator.rb
+lib/amazon/util/proactive_results.rb
+lib/amazon/util/threadpool.rb
+lib/amazon/util/user_data_store.rb
+lib/amazon/webservices/mechanical_turk.rb
+lib/amazon/webservices/mechanical_turk_requester.rb
+lib/amazon/webservices/mturk/mechanical_turk_error_handler.rb
+lib/amazon/webservices/mturk/question_generator.rb
+lib/amazon/webservices/util/amazon_authentication_relay.rb
+lib/amazon/webservices/util/command_line.rb
+lib/amazon/webservices/util/convenience_wrapper.rb
+lib/amazon/webservices/util/filter_proxy.rb
+lib/amazon/webservices/util/mock_transport.rb
+lib/amazon/webservices/util/request_signer.rb
+lib/amazon/webservices/util/rest_transport.rb
+lib/amazon/webservices/util/soap_simplifier.rb
+lib/amazon/webservices/util/soap_transport.rb
+lib/amazon/webservices/util/soap_transport_header_handler.rb
+lib/amazon/webservices/util/unknown_result_exception.rb
+lib/amazon/webservices/util/validation_exception.rb
+lib/amazon/webservices/util/xml_simplifier.rb
+lib/ruby-aws.rb
+lib/ruby-aws/version.rb
+samples/mturk/best_image/BestImage.rb
+samples/mturk/best_image/best_image.properties
+samples/mturk/best_image/best_image.question
+samples/mturk/blank_slate/BlankSlate.rb
+samples/mturk/blank_slate/BlankSlate_multithreaded.rb
+samples/mturk/helloworld/MTurkHelloWorld.rb
+samples/mturk/helloworld/mturk.yml
+samples/mturk/reviewer/Reviewer.rb
+samples/mturk/reviewer/mturk.yml
+samples/mturk/simple_survey/SimpleSurvey.rb
+samples/mturk/simple_survey/simple_survey.question
+samples/mturk/site_category/SiteCategory.rb
+samples/mturk/site_category/externalpage.htm
+samples/mturk/site_category/site_category.input
+samples/mturk/site_category/site_category.properties
+samples/mturk/site_category/site_category.question
+test/mturk/test_changehittypeofhit.rb
+test/mturk/test_error_handler.rb
+test/mturk/test_mechanical_turk_requester.rb
+test/mturk/test_mock_mechanical_turk_requester.rb
+test/test_ruby-aws.rb
+test/unit/test_binder.rb
+test/unit/test_data_reader.rb
+test/unit/test_exceptions.rb
+test/unit/test_hash_nesting.rb
+test/unit/test_lazy_results.rb
+test/unit/test_mock_transport.rb
+test/unit/test_paginated_iterator.rb
+test/unit/test_proactive_results.rb
+test/unit/test_question_generator.rb
+test/unit/test_threadpool.rb
+test/unit/test_user_data_store.rb

data/NOTICE.txt

@@ -0,0 +1,4 @@
+Libraries for Amazon Web Services
+Copyright 2007 Amazon Technologies, Inc.
+
+This product includes software developed by Amazon Technologies, Inc.

data/README.txt

@@ -0,0 +1,105 @@
+Libraries For Amazon Web Services (ruby-aws)
+* http://www.rubyforge.org/projects/ruby-aws/
+
+== Description
+
+Libraries for Amazon Web Services (ruby-aws) is a set of libraries and tools
+designed to make it easier for you to build solutions leveraging Amazon Web
+Services like Amazon Mechanical Turk.  The goals of the libraries are:
+
+* To abstract you from the "muck" of using web services
+* To simplify using the various Amazon Web Service APIs
+* To allow you to focus more on solving the business problem
+  and less on managing technical details
+
+== Usage
+
+  require 'ruby-aws'
+  @mturk = Amazon::WebServices::MechanicalTurkRequester.new
+  puts "I have $#{@mturk.availableFunds} in Sandbox"
+  @mturk_prod = Amazon::WebServices::MechanicalTurkRequester.new :Host => :Production
+  puts "I have $#{@mturk_prod.availableFunds} in Production"
+
+For more in-depth example code, check out the samples folder included in this
+distribution.
+
+== Prerequisites
+
+To use the Libraries and successfully run the samples,
+you must meet these prerequisites:
+
+* You must have an Amazon Web Services (AWS) account. You can sign up at
+  the {AWS web site}[http://aws.amazon.com].
+* You must have an Amazon Mechanical Turk Requester account.
+  Be sure to use the same e-mail address and password you used when creating
+  your Amazon Web Services account.
+  You can sign up at the {Requester web site}[http://requester.mturk.com].
+* You must have Ruby 1.8.3 or later.  You can download Ruby at the following
+  web site: http://www.ruby-lang.org.
+* You must have RubyGems[http://rubyforge.org/projects/rubygems] installed
+  and configured correctly for your Ruby installation.  Review the installation
+  instructions here[http://docs.rubygems.org].
+
+  (Note: If installing RubyGems for the first time, you may need to restart your console 
+  to pick up environment changes.  To execute code that is dependent on Ruby Gems, the 
+  command to execute is: "ruby -rubygems program_that_uses_gems".  The "-rubygems" 
+  command line parameter should be a default parameter that is always included.  To do this,
+  Ruby can utilize the "RUBYOPT" environment label that should be set to "RUBYOPT=-rubygems".
+  Please refer to documentation specific to your OS on defining environment labels.)
+
+== Installation
+
+1. Execute the following command:
+      gem install ruby-aws
+      
+   (Note: Some Unix-based systems may require root access to install Ruby libraries.  You
+   may need to execute the above command as the following:
+      sudo gem install ruby-aws
+   and enter in the password to successfully install the Gem)
+
+2. Installation of the ruby-aws gem will prompt to install the following dependent gems 
+   if not already installed:
+   * Hoe[http://seattlerb.rubyforge.org/hoe]
+   * Highline[http://rubyforge.org/projects/highline]
+
+3. (Optional) Download and expand the corresponding tarball/zip file from the {project
+   homepage}[http://rubyforge.org/projects/ruby-aws] to an installation directory.  This will
+   provide you access to the source files, test files and sample code.
+
+4. Configure the Libraries to use your Amazon Web Services authentication credentials by
+   executing the following command:
+     ruby-aws
+
+5. Verify your installation by running the automated tests by executing the following
+   command in the installation path:
+     rake test
+
+== Running Sample Applications
+
+1. Navigate to the samples\mturk directory of the installation path.
+2. Run the various samples
+
+== Comments, Questions or Feedback
+
+If you have any comments, questions, or feedback concerning the Libraries for
+Amazon Web Services, please visit our {Rubyforge project page}[http://rubyforge.org/projects/ruby-aws].
+
+If you have any comments, questions, or feedback concerning the Mechanical
+Turk service in general, please visit the {Amazon Mechanical Turk discussion
+forums}[http://developer.amazonwebservices.com/connect/forum.jspa?forumID=11]
+
+== License
+
+Copyright (c) 2007 Amazon Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+ 
+require 'rubygems'
+require 'hoe'
+require './lib/ruby-aws/version.rb'
+ 
+Hoe.new('ruby-aws', RubyAWS::VERSION) do |p|
+  p.rubyforge_name = 'ruby-aws'
+  p.summary = 'Ruby libraries for working with Amazon Web Services ( Mechanical Turk )'
+  p.email = 'ruby-aws-develop@rubyforge.org'
+  p.author = 'David J Parrott'
+  p.description = p.paragraphs_of('README.txt', 2..3).join("\n\n")
+  p.url = "http://rubyforge.org/projects/ruby-aws/"
+  p.changes = p.paragraphs_of('History.txt', 0..2).join("\n\n")
+  p.extra_deps << ['highline','>= 1.2.7']
+  p.need_tar = true
+  p.need_zip = true
+end
+
+# vim: syntax=ruby

data/bin/ruby-aws

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'ruby-aws'
+require 'amazon/webservices/util/command_line'
+
+Amazon::WebServices::Util::CommandLine.new.run