Class: RTurk::Operation

Inherits:

Object

• Object
• RTurk::Operation

show all

Defined in:

lib/rturk/operation.rb

Class Method Summary (collapse)

• + (Object) create(opts = {}, &blk)
• + (Object) default_params
• + (Object) require_params(*args)
• + (Object) required_params
• + (Object) set_operation(op)

Instance Method Summary (collapse)

• - (Object) check_params
• - (Object) default_params
• - (Operation) initialize(opts = {}) {|_self| ... } constructor

  ###################### # Instance Methods ### ######################.

• - (Object) parse(xml)
• - (Object) request
• - (Object) to_params

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# File 'lib/rturk/operation.rb', line 34

def initialize(opts = {})
  opts.each_pair do |k,v|
    if self.respond_to?("#{k.to_sym}=")
      self.send "#{k}=".to_sym, v
    elsif v.is_a?(Array)
      v.each do |a|
        (self.send k.to_s).send a[0].to_sym, a[1]
      end
    elsif self.respond_to?(k.to_sym)
      self.send k.to_sym, v
    end
  end
  yield(self) if block_given?
  self
end

23
24
25
26

# File 'lib/rturk/operation.rb', line 23

def create(opts = {}, &blk)
  hit = self.new(opts, &blk)
  response = hit.request
end

6
7
8

# File 'lib/rturk/operation.rb', line 6

def default_params
  @default_params ||= {}
end

14
15
16
17

# File 'lib/rturk/operation.rb', line 14

def require_params(*args)
  @required_params ||= []
  @required_params.push(*args)
end

10
11
12

# File 'lib/rturk/operation.rb', line 10

def required_params
  @required_params || []
end

19
20
21

# File 'lib/rturk/operation.rb', line 19

def set_operation(op)
  default_params.merge!('Operation' => op)
end

75
76
77
78
79
80
81
82
83
84
85

# File 'lib/rturk/operation.rb', line 75

def check_params
  missing_parameters = []
  self.class.required_params.each do |param|
    if self.respond_to?(param)
      missing_parameters << param.to_s if self.send(param).nil?
    else
      raise MissingParameters, "The parameter '#{param.to_s}' was required and not available"
    end
    raise MissingParameters, "Parameters '#{missing_parameters.join(', ')}' cannot be blank" unless missing_parameters.empty?
  end
end

50
51
52

# File 'lib/rturk/operation.rb', line 50

def default_params
  self.class.default_params
end

54
55
56
57

# File 'lib/rturk/operation.rb', line 54

def parse(xml)
  # Override this in your operation if you like
  RTurk::Response.new(xml)
end

63
64
65
66
67
68
69
70
71
72
73

# File 'lib/rturk/operation.rb', line 63

def request
  if self.respond_to?(:validate)
    validate
  end
  check_params
  params = {'Operation' => self.class.to_s.gsub(/^\w+::/,'')}
  params = params.merge(self.default_params)
  params = to_params.merge(params)
  response = RTurk.Request(params)
  parse(response)
end

59
60
61

# File 'lib/rturk/operation.rb', line 59

def to_params
  {}# Override to include extra params
end