kempelen 1.0.0

data/lib/kempelen/API/operations/get_account_balance.rb

@@ -0,0 +1,30 @@
+module Kempelen
+  module API
+    module Operations
+      class GetAccountBalance < Base
+        AWS_OPERATION_NAME = "GetAccountBalance".freeze
+        AWS_RESPONSE_OBJECT = "GetAccountBalanceResponse".freeze
+
+        def initialize(client)
+          super(client)
+
+          @response_object = AWS_RESPONSE_OBJECT
+        end
+
+        def create_parameters
+          @parameters[:operation] = AWS_OPERATION_NAME
+
+          super 
+        end
+
+        def perform_operation
+          create_request_string
+
+          super
+
+          Kempelen::API::Responses::AccountBalanceResponse.new(@raw_response)
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/operations/get_assignments_for_hit.rb

@@ -0,0 +1,42 @@
+module Kempelen
+  module API
+    module Operations
+      class GetAssignmentsForHit < HitOperation
+        attr_accessor :assignment_status
+        attr_accessor :page_size
+        attr_accessor :page_number
+
+        AWS_OPERATION_NAME = "GetAssignmentsForHIT".freeze
+        AWS_RESPONSE_OBJECT = "GetAssignmentsForHITResponse".freeze
+        AWS_DEFAULT_PAGE_SIZE = 10
+        AWS_DEFAULT_PAGE_NUMBER = 1
+
+        def initialize(client, hit_id)
+          super(client, hit_id)
+
+          @operation_name = AWS_OPERATION_NAME
+          @response_object = AWS_RESPONSE_OBJECT
+          @assignment_status = nil
+          @page_size = AWS_DEFAULT_PAGE_SIZE
+          @page_number = AWS_DEFAULT_PAGE_NUMBER
+        end
+
+        def create_parameters
+          @parameters[:assignment_status] = @assignment_status
+          @parameters[:page_size] = @page_size
+          @parameters[:page_number] = @page_number
+
+          super
+        end
+
+        def perform_operation
+          create_request_string
+
+          super
+
+          Kempelen::API::Responses::GetAssignmentsResponse.new(@raw_response)
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/operations/get_hit.rb

@@ -0,0 +1,25 @@
+module Kempelen
+  module API
+    module Operations
+      class GetHit < HitOperation
+        AWS_OPERATION_NAME = "GetHIT".freeze
+        AWS_RESPONSE_OBJECT = "GetHITResponse".freeze
+
+        def initialize(client, hit_id)
+          super(client, hit_id)
+
+          @operation_name = AWS_OPERATION_NAME
+          @response_object = AWS_RESPONSE_OBJECT
+        end
+
+        def perform_operation
+          create_request_string
+
+          super
+
+          Kempelen::API::Responses::HitResponse.new(@raw_response)
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/operations/get_reviewable_hits.rb

@@ -0,0 +1,64 @@
+module Kempelen
+  module API
+    module Operations
+      class GetReviewableHits < Base
+        attr_accessor :hit_type_id
+        attr_accessor :status
+        attr_accessor :page_size
+        attr_accessor :page_number
+        attr_accessor :sort_property
+        attr_accessor :sort_direction
+
+        AWS_OPERATION_NAME = "GetReviewableHITs".freeze
+        AWS_RESPONSE_OBJECT = "GetReviewableHITsResponse".freeze
+        AWS_DEFAULT_PAGE_SIZE = 100
+        AWS_DEFAULT_PAGE_NUMBER = 1
+
+        def initialize(client, hit_type_id)
+          super(client)
+
+          @response_object = AWS_RESPONSE_OBJECT
+          @hit_type_id = hit_type_id
+          @status = :reviewable
+          @page_size = AWS_DEFAULT_PAGE_SIZE
+          @page_number = AWS_DEFAULT_PAGE_NUMBER
+          @sort_property = :enumeration
+          @sort_direction = :descending
+        end
+
+        def amazon_status
+          @status.to_s.capitalize.freeze
+        end
+
+        def amazon_sort_property
+          @sort_property.to_s.capitalize.freeze
+        end
+
+        def amazon_sort_direction
+          @sort_direction.to_s.capitalize.freeze
+        end
+
+        def create_parameters
+          @parameters[:operation] = AWS_OPERATION_NAME
+          @parameters[:hit_type_id] = @hit_type_id
+          @parameters[:status] = amazon_status
+          @parameters[:page_size] = @page_size
+          @parameters[:page_number] = @page_number
+          @parameters[:sort_property] = amazon_sort_property
+          @parameters[:sort_direction] = amazon_sort_direction
+
+          super
+        end
+
+        def perform_operation
+          create_request_string
+
+          super
+
+          Kempelen::API::Responses::ReviewableHitsResponse.new(@raw_response)
+        end
+      end
+    end
+  end
+end
+

data/lib/kempelen/API/operations/hit_operation.rb

@@ -0,0 +1,23 @@
+module Kempelen
+  module API
+    module Operations
+      class HitOperation < Base
+        attr_accessor :hit_id
+        attr_accessor :operation_name
+
+        def initialize(client, hit_id)
+          super(client)
+
+          @hit_id = hit_id
+        end
+
+        def create_parameters
+          @parameters[:operation] = @operation_name
+          @parameters[:hit_id] = @hit_id
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/operations/parameters.rb

@@ -0,0 +1,40 @@
+module Kempelen
+  module API
+    module Operations
+      PARAMETERS = {
+        service: "Service".freeze,
+        operation: "Operation".freeze,
+        access_key: "AWSAccessKeyId".freeze,
+        timestamp: "Timestamp".freeze,
+        signature: "Signature".freeze,
+        hit_type_id: "HITTypeId".freeze,
+        layout_id: "HITLayoutId".freeze,
+        lifetime_in_seconds: "LifetimeInSeconds".freeze,
+        max_assignments: "MaxAssignments".freeze,
+        requester_annotation: "RequesterAnnotation".freeze,
+        unique_request_token: "UniqueRequestToken".freeze,
+        hit_id: "HITId".freeze,
+        status: "Status".freeze,
+        page_size: "PageSize".freeze,
+        page_number: "PageNumber".freeze,
+        sort_property: "SortProperty".freeze,
+        sort_direction: "SortDirection".freeze,
+        assignment_id: "AssignmentId".freeze,
+        requester_feedback: "RequesterFeedback".freeze,
+        assignment_status: "AssignmentStatus".freeze,
+        revert: "Revert".freeze,
+        title: "Title".freeze,
+        description: "Description".freeze,
+        reward: "Reward".freeze,
+        assignment_duration: "AssignmentDurationInSeconds".freeze,
+        keywords: "Keywords".freeze,
+        auto_approval_delay: "AutoApprovalDelayInSeconds".freeze,
+        qualification_requirement: "QualificationRequirement".freeze
+      }
+
+      ARRAY_PARAMETERS = {
+        layout_parameters: "HITLayoutParameter".freeze
+      }
+    end
+  end
+end

data/lib/kempelen/API/operations/register_hit_type.rb

@@ -0,0 +1,47 @@
+module Kempelen
+  module API
+    module Operations
+      class RegisterHitType < Base
+        attr_accessor :title
+        attr_accessor :description
+        attr_accessor :reward
+        attr_accessor :assignment_duration
+        attr_accessor :keywords
+        attr_accessor :auto_approval_delay
+
+        # TODO: Support qualification requirements
+        attr_accessor :qualification_requirement
+
+        AWS_OPERATION_NAME = "RegisterHITType".freeze
+
+        def initialize(client, title, description, reward, assignment_duration, &block)
+          super(client)
+
+          @title = title
+          @description = description
+          @reward = reward
+          @assignment_duration = assignment_duration
+          @keywords = []
+
+          yield self unless block == nil
+        end
+
+        def amazon_keywords
+          @keywords.map {|k| k.strip}.join(',')
+        end
+
+        def create_parameters
+          @parameters[:operation] = AWS_OPERATION_NAME
+          @parameters[:title] = @title
+          @parameters[:description] = @description
+          @parameters[:reward] = @reward
+          @parameters[:assignment_duration] = @assignment_duration
+          @parameters[:keywords] = amazon_keywords
+          @parameters[:auto_approval_delay] = @auto_approval_delay
+
+          super 
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/operations/reject_assignment.rb

@@ -0,0 +1,17 @@
+module Kempelen
+  module API
+    module Operations
+      class RejectAssignment < AssignmentOperation
+        AWS_OPERATION_NAME = "RejectAssignment".freeze
+        AWS_RESPONSE_OBJECT = "RejectAssignmentResponse".freeze
+
+        def initialize(client, assignment_id, requester_feedback = nil)
+          super(client, assignment_id, requester_feedback)
+
+          @operation_name = AWS_OPERATION_NAME
+          @response_object = AWS_RESPONSE_OBJECT
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/operations/set_hit_as_reviewing.rb

@@ -0,0 +1,34 @@
+module Kempelen
+  module API
+    module Operations
+      class SetHitAsReviewing < HitOperation
+        attr_accessor :revert
+
+        AWS_OPERATION_NAME = "SetHITAsReviewing".freeze
+        AWS_RESPONSE_OBJECT = "SetHITAsReviewingResponse".freeze
+
+        def initialize(client, hit_id, revert = false)
+          super(client, hit_id)
+
+          @operation_name = AWS_OPERATION_NAME
+          @response_object = AWS_RESPONSE_OBJECT
+          @revert = revert
+        end
+
+        def create_parameters
+          @parameters[:revert] = @revert
+
+          super 
+        end
+
+        def perform_operation
+          create_request_string
+
+          super
+
+          Kempelen::API::Responses::EmptyResponse.new(@raw_response)
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/responses/account_balance_response.rb

@@ -0,0 +1,27 @@
+module Kempelen
+  module API
+    module Responses
+      class AccountBalanceResponse < Base
+        attr_reader :available_balance
+        attr_reader :on_hold_balance
+
+        def initialize(response)
+          super()
+
+          load_from_response(response)
+        end
+
+        def load_from_response(response)
+          super(response)
+
+          balance_response = response["GetAccountBalanceResult"]
+          unless balance_response.nil?
+            @available_balance = Kempelen::API::Common::Price.create_from_response(balance_response["AvailableBalance"])
+            @on_hold_balance = Kempelen::API::Common::Price.create_from_response(balance_response["OnHoldBalance"])
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/kempelen/API/responses/base.rb

@@ -0,0 +1,32 @@
+module Kempelen
+  module API
+    module Responses
+      class Base
+        attr_accessor :success
+        attr_accessor :request_id
+        attr_accessor :error
+
+        def initialize
+          @success = false
+          @error = nil
+        end
+
+        def load_from_response(response)
+          @request_id = response["OperationRequest"]["RequestId"] rescue nil
+
+          response.each_key do |k|
+            if response[k].has_key?("Request")
+              request_response = response[k]["Request"]
+              @success = (request_response["IsValid"] == "True")
+
+              if request_response.has_key?("Errors")
+                @success = false
+                @error = ErrorResponse.new(request_response["Errors"])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/responses/empty_response.rb

@@ -0,0 +1,17 @@
+module Kempelen
+  module API
+    module Responses
+      class EmptyResponse < Base
+        def initialize(response)
+          super()
+
+          load_from_response(response)
+        end
+
+        def load_from_response(response)
+          super(response)
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/responses/error_response.rb

@@ -0,0 +1,32 @@
+module Kempelen
+  module API
+    module Responses
+      class ErrorResponse
+        attr_accessor :code
+        attr_accessor :message
+        attr_accessor :data
+
+        def initialize(response = nil)
+          @data = []
+
+          parse_from_response(response) unless response.nil?
+        end
+
+        def parse_from_response(response)
+          error = response["Error"]
+          unless error.nil?
+            @code = error["Code"]
+            @message = error["Message"]
+          end
+
+          data = error["Data"].nil? ? [] : error["Data"]
+          data.each do |data_value|
+            key = data_value["Key"] rescue nil
+            value = data_value["Value"] rescue nil
+            @data << {key: key, value: value}
+          end
+        end
+      end
+    end
+  end
+end