Class: Query

Inherits:
Object
  • Object
show all
Defined in:
lib/importio.rb

Instance Method Summary collapse

Constructor Details

#initialize(callback, query) ⇒ Query

This class represents a single query to the import.io platform



23
24
25
26
27
28
29
30
31
 
# File 'lib/importio.rb', line 23

def initialize(callback, query)
  # Initialises the new query object with inputs and default state
  @query = query
  @jobs_spawned = 0
  @jobs_started = 0
  @jobs_completed = 0
  @_finished = false
  @_callback = callback
end

Instance Method Details

#_on_message(data) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/importio.rb', line 33

def _on_message(data)
  # Method that is called when a new message is received
  # 
  # Check the type of the message to see what we are working with
  msg_type = data["type"]
  if msg_type == "SPAWN"
    # A spawn message means that a new job is being initialised on the server
    @jobs_spawned+=1
  elsif msg_type == "INIT" or msg_type == "START"
    # Init and start indicate that a page of work has been started on the server
    @jobs_started+=1
  elsif msg_type == "STOP"
    # Stop indicates that a job has finished on the server
    @jobs_completed+=1
  end
    
  # Update the finished state
  # The query is finished if we have started some jobs, we have finished as many as we started, and we have started as many as we have spawned
  # There is a +1 on jobs_spawned because there is an initial spawn to cover initialising all of the jobs for the query
  @_finished = (@jobs_started == @jobs_completed and @jobs_spawned + 1 == @jobs_started and @jobs_started > 0)
  
  # These error conditions mean the query has been terminated on the server
  # It either errored on the import.io end, the user was not logged in, or the query was cancelled on the server
  if msg_type == "ERROR" or msg_type == "UNAUTH" or msg_type == "CANCEL"
    @_finished = true
  end
  
  # Now we have processed the query state, we can return the data from the message back to listeners
  @_callback.call(self, data)
end

#finished ⇒ Object 



64
65
66
67
 
# File 'lib/importio.rb', line 64

def finished
  # Returns boolean - true if the query has been completed or terminated
  return @_finished
end