Class: HaveAPI::Client::Action

Inherits:
Object
  • Object
show all
Defined in:
lib/haveapi/client/action.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, api, name, spec, args) ⇒ Action

Returns a new instance of Action.



8
9
10
11
12
13
14
15
 
# File 'lib/haveapi/client/action.rb', line 8

def initialize(client, api, name, spec, args)
  @client = client
  @api = api
  @name = name
  @spec = spec

  apply_args(args)
end

Instance Attribute Details

#api ⇒ Object (readonly)

Returns the value of attribute api.



5
6
7
 
# File 'lib/haveapi/client/action.rb', line 5

def api
  @api
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



5
6
7
 
# File 'lib/haveapi/client/action.rb', line 5

def client
  @client
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/haveapi/client/action.rb', line 5

def name
  @name
end

#resource_path ⇒ Object

Returns the value of attribute resource_path.



6
7
8
 
# File 'lib/haveapi/client/action.rb', line 6

def resource_path
  @resource_path
end

Class Method Details

.cancel(client, id) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/haveapi/client/action.rb', line 234

def self.cancel(client, id)
  res = client.action_state.cancel(id, meta: { block: false })

  if res.ok? && res.action.blocking? && res.meta[:action_state_id]
    res.meta[:action_state_id]

  else
    res
  end
end

.wait_for_completion(client, id, interval: 15, update_in: 3, timeout: nil) {|state| ... } ⇒ Boolean, ...

Block until the action is completed or timeout occurs. If the block is given, it is regularly called with the action's state.

Parameters:

  • interval (Float) (defaults to: 15) —

    how often should the action state be checked

  • timeout (Integer) (defaults to: nil) —

    timeout in seconds

Yield Parameters:

Returns:

  • (Boolean) —

    when the action is finished

  • (nil) —

    when timeout occurs

  • (Response) —

    if the action was cancelled and the cancel itself isn't blocking

  • (Integer) —

    id of cancellation if the action was cancelled, cancel is blocking and no cancel block is provided



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/haveapi/client/action.rb', line 166

def self.wait_for_completion(client, id, interval: 15, update_in: 3, timeout: nil)
  res = client.action_state.show(id)
  state = ActionState.new(res)

  yield(state) if block_given?
  return state.status if state.finished?

  last = {}
  t = Time.now if timeout

  loop do
    res = client.action_state.poll(
      id,
      timeout: interval,
      update_in: update_in,
      status: last[:status],
      current: last[:current],
      total: last[:total]
    )

    state = ActionState.new(res)

    last[:status] = res.response[:status]
    last[:current] = res.response[:current]
    last[:total] = res.response[:total]

    yield(state) if block_given?
    break if state.finished?

    if state.cancel?
      state.stop
      cancel_block = state.cancel_block

      ret = cancel(client, id)

      if ret.is_a?(Response)
        # The cancel is not a blocking operation, return immediately
        raise ActionFailed, ret unless ret.ok?

        return ret
      end

      # Cancel is a blocking operation
      if cancel_block
        return wait_for_completion(
          client,
          ret,
          interval: interval,
          timeout: timeout,
          update_in: update_in,
          &cancel_block
        )
      end

      return ret
    end

    return nil if (timeout && (Time.now - t) >= timeout) || state.stop?
  end

  state.status
rescue Interrupt => e
  %i[show poll].each do |action|
    client.action_state.actions[action].reset
  end
  raise e
end

Instance Method Details

#aliases(include_name = false) ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/haveapi/client/action.rb', line 57

def aliases(include_name = false)
  if include_name
    [@name] + @spec[:aliases]
  else
    @spec[:aliases]
  end
end

#auth? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/haveapi/client/action.rb', line 49

def auth?
  @spec[:auth]
end

#blocking? ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/haveapi/client/action.rb', line 53

def blocking?
  @spec[:blocking]
end

#client_message(key, **values) ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'lib/haveapi/client/action.rb', line 21

def client_message(key, **values)
  if @client.respond_to?(:client_message)
    @client.client_message(key, **values)
  elsif @api.respond_to?(:client_message)
    @api.client_message(key, **values)
  else
    I18n.t(nil, key, values)
  end
end

#description ⇒ Object 



65
66
67
 
# File 'lib/haveapi/client/action.rb', line 65

def description
  @spec[:description]
end

#examples ⇒ Object 



93
94
95
 
# File 'lib/haveapi/client/action.rb', line 93

def examples
  @spec[:examples]
end

#execute(data) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/haveapi/client/action.rb', line 31

def execute(data)
  params_arg = {}

  if input
    params = Params.new(self, data)

    unless params.valid?
      raise ValidationError.new(self, params.errors)
    end

    params_arg = params.to_api
  end

  @api.call(self, params_arg)
ensure
  reset
end

#help ⇒ Object 



117
118
119
 
# File 'lib/haveapi/client/action.rb', line 117

def help
  @spec[:help]
end

#http_method ⇒ Object 



130
131
132
 
# File 'lib/haveapi/client/action.rb', line 130

def http_method
  @spec[:method]
end

#input ⇒ Object 



69
70
71
 
# File 'lib/haveapi/client/action.rb', line 69

def input
  @spec[:input]
end

#input_layout ⇒ Object 



77
78
79
 
# File 'lib/haveapi/client/action.rb', line 77

def input_layout
  @spec[:input][:layout].to_sym
end

#input_params ⇒ Object 



97
98
99
 
# File 'lib/haveapi/client/action.rb', line 97

def input_params
  @spec[:input][:parameters]
end

#inspect ⇒ Object 



17
18
19
 
# File 'lib/haveapi/client/action.rb', line 17

def inspect
  "#<#{self.class.name} @name=#{@name}>"
end

#meta(scope) ⇒ Object 



109
110
111
 
# File 'lib/haveapi/client/action.rb', line 109

def meta(scope)
  @spec[:meta][scope]
end

#namespace(src) ⇒ Object 



89
90
91
 
# File 'lib/haveapi/client/action.rb', line 89

def namespace(src)
  @spec[src][:namespace]
end

#output ⇒ Object 



73
74
75
 
# File 'lib/haveapi/client/action.rb', line 73

def output
  @spec[:output]
end

#output_layout ⇒ Object 



81
82
83
 
# File 'lib/haveapi/client/action.rb', line 81

def output_layout
  @spec[:output][:layout].to_sym
end

#param_description(dir, name) ⇒ Object 



105
106
107
 
# File 'lib/haveapi/client/action.rb', line 105

def param_description(dir, name)
  @spec[dir][:parameters][name]
end

#params ⇒ Object 



101
102
103
 
# File 'lib/haveapi/client/action.rb', line 101

def params
  @spec[:output][:parameters]
end

#path ⇒ Object 



113
114
115
 
# File 'lib/haveapi/client/action.rb', line 113

def path
  @spec[:path]
end

#prepared_help ⇒ Object 



126
127
128
 
# File 'lib/haveapi/client/action.rb', line 126

def prepared_help
  @prepared_help || @spec[:help]
end

#prepared_path ⇒ Object

Url with resolved parameters.



122
123
124
 
# File 'lib/haveapi/client/action.rb', line 122

def prepared_path
  @prepared_path || @spec[:path]
end

#provide_args(*args) ⇒ Object 



138
139
140
 
# File 'lib/haveapi/client/action.rb', line 138

def provide_args(*args)
  apply_args(args)
end

#provide_path(path, help) ⇒ Object 



142
143
144
145
 
# File 'lib/haveapi/client/action.rb', line 142

def provide_path(path, help)
  @prepared_path = path
  @prepared_help = help
end

#reset ⇒ Object 



147
148
149
150
 
# File 'lib/haveapi/client/action.rb', line 147

def reset
  @prepared_path = nil
  @prepared_help = nil
end

#structure ⇒ Object 



85
86
87
 
# File 'lib/haveapi/client/action.rb', line 85

def structure
  @spec[:output][:format]
end

#unresolved_args? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/haveapi/client/action.rb', line 134

def unresolved_args?
  prepared_path =~ /\{[a-zA-Z0-9\-_]+\}/
end

#update_description(spec) ⇒ Object 



152
153
154
 
# File 'lib/haveapi/client/action.rb', line 152

def update_description(spec)
  @spec = spec
end