Module: Sinatra::RbbtRESTWorkflow

Defined in:
lib/rbbt/rest/workflow.rb

Constant Summary collapse

WORKFLOWS =
[]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.registered(base) ⇒ Object



201
202
203
204
205
# File 'lib/rbbt/rest/workflow.rb', line 201

def self.registered(base)
  base.module_eval do
    helpers WorkflowRESTHelpers
  end
end

Instance Method Details

#add_workflow(workflow, add_resource = false) ⇒ Object



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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
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
# File 'lib/rbbt/rest/workflow.rb', line 35

def add_workflow(workflow, add_resource = false)
  raise "Provided workflow is not of type Workflow" unless  Workflow === workflow 
  RbbtRESTWorkflow::WORKFLOWS.push workflow unless RbbtRESTWorkflow::WORKFLOWS.include? workflow

  Log.debug "Adding #{ workflow } to REST server" 

  add_workflow_resource(workflow) if add_resource


  self.instance_eval workflow.libdir.lib['sinatra.rb'].read, workflow.libdir.lib['sinatra.rb'].find if workflow.respond_to?(:libdir) and  File.exists? workflow.libdir.lib['sinatra.rb']

  get "/#{workflow.to_s}" do
    case format
    when :html
      workflow_render('tasks', workflow)
    when :json
      content_type "application/json"
      {:exec => workflow.exec_exports, :synchronous => workflow.synchronous_exports, :asynchronous => workflow.asynchronous_exports}.to_json
    else
      raise "Unsupported format specified: #{ format }"
    end
  end

  get "/#{workflow.to_s}/:task/info" do
    task     = consume_parameter(:task)

    case format
    when :html
      workflow_render('task_info', workflow)
    when :json
      content_type "application/json"
      workflow.task_info(task.to_sym).to_json
    else
      raise "Unsupported format specified: #{ format }"
    end
  end

  get "/#{workflow.to_s}/:task/dependencies" do
    task     = consume_parameter(:task)

    case format
    when :html
      workflow_render('task_dependencies', workflow)
    when :json
      content_type "application/json"
      workflow.task_dependencies[task.to_sym].to_json
    else
      raise "Unsupported format specified: #{ format }"
    end
  end

  get "/#{workflow.to_s}/description" do
    halt 200, workflow.workflow_description
  end


  get "/#{workflow.to_s}/:task" do
    task     = consume_parameter(:task)
    jobname  = consume_parameter(:jobname)

    task_parameters = consume_task_parameters(workflow, task, params)

    if complete_input_set(workflow, task, task_parameters) or format == :json
      issue_job(workflow, task, jobname, task_parameters)
    else
      workflow_render('form', workflow, task, task_parameters)
    end
  end

  post "/#{workflow.to_s}/:task" do
    task = consume_parameter(:task)
    jobname  = consume_parameter(:jobname)

    task_parameters = consume_task_parameters(workflow, task, params)

    issue_job(workflow, task, jobname, task_parameters)
  end

  get "/#{workflow.to_s}/:task/:job" do
    task = consume_parameter(:task)
    job  = consume_parameter(:job)

    job = workflow.load_id(File.join(task, job))

    clean_job(workflow, job) if update == :clean

    begin
      started = job.info.any?
      done = job.done?
      error = job.error?

      if done
        show_result job, workflow, task
      else
        if started
          case
          when job.status == :error
            error_for job
          when execution_type(workflow, task) == :asynchronous
            wait_on job
          else
            job.join
            raise RbbtRESTHelpers::Retry
          end
        else
          halt 404, "Job not found"
        end
      end
    rescue RbbtRESTHelpers::Retry
      retry
    end
  end

  get "/#{workflow.to_s}/:task/:job/info" do
    task = consume_parameter(:task)
    job  = consume_parameter(:job)

    job = workflow.load_id(File.join(task, job))

    case format
    when :html
      workflow_render('job_info', workflow, task, :info => job.info)
    when :json
      content_type "application/json"
      job.info.to_json
    else
      raise "Unsupported format specified: #{ format }"
    end
  end

  get "/#{workflow.to_s}/:task/:job/files" do
    task = consume_parameter(:task)
    job  = consume_parameter(:job)

    job = workflow.load_id(File.join(task, job))

    case format
    when :html
      workflow_render('job_files', workflow, task, :info => job.info)
    when :json
      content_type "application/json"
      job.files.to_json
    else
      raise "Unsupported format specified: #{ format }"
    end
  end

  get "/#{workflow.to_s}/:task/:job/file/*" do
    task = consume_parameter(:task)
    job  = consume_parameter(:job)
    filename = params[:splat].first

    job = workflow.load_id(File.join(task, job))

    send_file job.file(filename)
  end

  delete "/#{workflow.to_s}/:task/:job" do
    task = consume_parameter(:task)
    job  = consume_parameter(:job)
    job  = workflow.load_id(File.join(task, job))

    clean_job(workflow, job)
  end
end

#add_workflow_resource(workflow) ⇒ Object



21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/rbbt/rest/workflow.rb', line 21

def add_workflow_resource(workflow)
  views_dir = workflow.respond_to?(:libdir)? workflow.libdir.www.views.find(:lib) : nil
  if views_dir and views_dir.exists?
    Log.debug "Registering views for #{ workflow }: #{ views_dir.find }"
    EntityRESTHelpers.entity_resources.unshift views_dir
    RbbtRESTHelpers.template_resources.unshift views_dir

    RbbtRESTHelpers.add_sass_load_path views_dir.compass if views_dir.compass.exists?

    RbbtRESTHelpers.javascript_resources.unshift views_dir.public.js if views_dir.public.js.exists?
    RbbtRESTHelpers.sass_resources.unshift views_dir.compass if views_dir.compass.exists?
  end
end