rbbt-rest 1.1.0

data/lib/rbbt/rest/workflow.rb

@@ -0,0 +1,198 @@
+require 'rbbt'
+require 'rbbt/workflow'
+
+require 'rbbt/rest/common/locate'
+require 'rbbt/rest/common/misc'
+require 'rbbt/rest/common/render'
+require 'rbbt/rest/common/forms'
+require 'rbbt/rest/common/users'
+
+require 'rbbt/rest/workflow/locate'
+require 'rbbt/rest/workflow/render'
+require 'rbbt/rest/workflow/jobs'
+
+require 'sinatra/base'
+require 'json'
+
+module Sinatra
+  module RbbtRESTWorkflow
+
+    def add_workflow_resource(workflow)
+      views_dir = workflow.libdir.www.views.find(:lib)
+      if views_dir.exists?
+        EntityRESTHelpers.entity_resources.unshift views_dir
+        RbbtRESTHelpers.template_resources.unshift views_dir
+
+        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?
+      end
+    end
+
+    def add_workflow(workflow, add_resource = false)
+      raise "Provided workflow is not of type Workflow" unless  Workflow === workflow or WorkflowRESTClient === workflow
+
+      add_workflow_resource(workflow) if add_resource
+
+      Log.debug("Adding #{ workflow } to REST server")
+
+      load workflow.libdir.lib['sinatra.rb'] if 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}/: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
+          done = job.done?
+          started = job.info.any?
+
+          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) if update == :clean
+      end
+    end
+
+    def self.registered(base)
+      base.module_eval do
+        helpers WorkflowRESTHelpers
+      end
+    end
+  end
+end
+

data/lib/rbbt/rest/workflow/jobs.rb

@@ -0,0 +1,154 @@
+require 'rbbt/workflow'
+require 'rbbt/rest/common/misc'
+
+module WorkflowRESTHelpers
+
+  def consume_task_parameters(workflow, task, params = nil)
+    task_inputs = workflow.task_info(task.to_sym)[:inputs]
+
+    task_parameters = {}
+    task_inputs.each do |input|
+
+      input_val = consume_parameter(input, params)
+      task_parameters[input] = input_val unless input_val.nil?
+
+      # Param files
+      input_val = consume_parameter(input.to_s + '__param_file', params)
+      task_parameters[input.to_s + '__param_file'] = input_val unless input_val.nil?
+    end
+
+    task_parameters
+  end
+
+  def complete_input_set(workflow, task, inputs)
+    inputs.keys.sort === workflow.task_info(task.to_sym)[:inputs].sort
+  end
+
+  def type_of_export(workflow, task)
+    task = task.to_sym
+    case
+    when workflow.exec_exports.include?(task)
+      :exec
+    when workflow.synchronous_exports.include?(task)
+      :synchronous
+    when workflow.asynchronous_exports.include?(task)
+      :asynchronous
+    else
+      raise "No known export type for #{ workflow } #{ task }"
+    end
+  end
+
+  def execution_type(workflow, task)
+    export = type_of_export(workflow, task)
+    return export if export == :exec or cache_type.nil?
+    return cache_type if cache_type
+  end
+  
+  def prepare_job_inputs(workflow, task, params)
+    inputs = workflow.task_info(task)[:inputs]
+    input_types = workflow.task_info(task)[:input_types]
+
+    task_inputs = {}
+    inputs.each do |input|
+      value = consume_parameter(input, params)
+      param_file = consume_parameter(input.to_s + '__param_file', params)
+      next if value.nil? and param_file.nil?
+      type = input_types[input]
+
+      fixed_value = fix_input(type, value, param_file)
+      task_inputs[input] = fixed_value
+    end
+
+    task_inputs
+  end
+
+  def show_result_html(result, workflow, task, jobname = nil, job = nil)
+    result_type = workflow.task_info(task)[:result_type]
+    result_description = workflow.task_info(task)[:result_description]
+    workflow_render('job_result', workflow, task, :result => result, :type => result_type, :description => result_description, :jobname => jobname, :job => job)
+  end
+
+  def show_exec_result(result, workflow, task)
+    case format
+    when :html
+      show_result_html result, workflow, task, nil
+    when :json
+      content_type "application/json"
+      halt 200, result.to_json
+    when :tsv
+      content_type "text/tab-separated-values"
+      halt 200, result.to_s
+    when :literal, :raw
+      content_type "text/plain"
+      halt 200, result.to_s
+    when :binary
+      content_type "application/octet-stream"
+      halt 200, result.to_s
+    else
+      raise "Unsupported format: #{ format }"
+    end
+  end
+
+  def show_result(job, workflow, task)
+    case format
+    when :html
+      show_result_html job.load, workflow, task, job.name, job
+    when :json
+      content_type "application/json"
+      halt 200, job.load.to_json
+    when :tsv
+      content_type "text/tab-separated-values"
+      job.path ? send_file(job.path) : halt(200, job.load.to_s)
+    when :literal, :raw
+      content_type "text/plain"
+      job.path ? send_file(job.path) : halt(200, job.load.to_s)
+    when :binary
+      content_type "application/octet-stream"
+      job.path ? send_file(job.path) : halt(200, job.load.to_s)
+    when :excel
+      require 'rbbt/tsv/excel'
+      data = nil
+      excel_file = TmpFile.tmp_file
+      result = job.load
+      result.excel(excel_file, :name => @excel_use_name,:sort_by => @excel_sort_by, :sort_by_cast => @excel_sort_by_cast)
+      send_file excel_file, :type => 'application/vnd.ms-excel', :filename => job.clean_name + '.xls'
+    else
+      raise "Unsupported format: #{ format }"
+    end
+  end
+
+  def issue_job(workflow, task, jobname = nil, params = {})
+    inputs = prepare_job_inputs(workflow, task, params)
+    job = workflow.job(task, jobname, inputs)
+
+    execution_type = execution_type(workflow, task)
+    case execution_type
+    when :exec
+      show_exec_result job.exec, workflow, task
+    when :synchronous, :sync
+      job.clean if update == :reload
+      job.run
+      job_url = to(File.join("/", workflow.to_s, task, job.name)) 
+      halt 200, job.name if format === :jobname
+      redirect job_url
+    when :asynchronous, :async, nil
+      job.clean if update == :reload
+      job.fork
+      job_url = to(File.join("/", workflow.to_s, task, job.name)) 
+      halt 200, job.name if format === :jobname
+      redirect job_url
+    else
+      raise "Unsupported execution_type: #{ execution_type }"
+    end
+  end
+
+  def clean_job(workflow, job)
+    job.clean
+
+    if ajax
+      halt 200
+    else
+      redirect to(File.join("/", workflow.to_s, job.task_name.to_s))
+    end
+  end
+end

data/lib/rbbt/rest/workflow/locate.rb

@@ -0,0 +1,41 @@
+module WorkflowRESTHelpers
+  attr_accessor :workflow_resources
+
+  def self.workflow_resources
+    @workflow_resources ||= [Rbbt.share.views.find(:lib)]
+  end
+
+  def workflow_resources
+    [Rbbt.www.views.find(:lib)] + WorkflowRESTHelpers.workflow_resources
+  end
+
+  def locate_workflow_template_from_resource(resource, template, workflow = nil, task = nil)
+    template += '.haml' unless template =~ /.+\..+/
+
+    paths = []
+    paths << resource[workflow][task][template] if task and workflow
+    paths << resource[workflow][template] if workflow
+    paths << resource[template]
+
+    paths.each do |path|
+      return path.find if path.exists?
+    end 
+
+    nil
+  end   
+
+  def locate_workflow_template(template, workflow = nil, task = nil)
+
+    if workflow
+      path = locate_workflow_template_from_resource(workflow.libdir.www.views.find, template, workflow, task)
+      return path if path and path.exists?
+    end
+
+    workflow_resources.each do |resource|
+      path = locate_workflow_template_from_resource(resource, template, workflow, task)
+      return path if path and path.exists?
+    end
+
+    raise "Template not found: [#{ template }, #{workflow}, #{ task }]"
+  end
+end

data/lib/rbbt/rest/workflow/render.rb

@@ -0,0 +1,33 @@
+require 'rbbt/util/open'
+
+require 'haml'
+module WorkflowRESTHelpers
+
+  def workflow_render(template, workflow = nil, task = nil, params = {})
+    workflow = consume_parameter(:workflow, params) if workflow.nil?
+    task     = consume_parameter(:task, params) if workflow.nil?
+
+    template_file = locate_workflow_template(template, workflow, task)
+
+    locals = params.dup
+    locals[:workflow] = workflow if workflow
+    locals[:task]     = task if task
+
+    layout_file = layout ? locate_template("layout") : nil
+
+    render(template_file, locals, layout_file)
+  end
+
+  def workflow_partial(template, workflow = nil, task = nil, params = {})
+    workflow = consume_parameter(:workflow, params) if workflow.nil?
+    task     = consume_parameter(:task, params) if workflow.nil?
+
+    template_file = locate_workflow_template(template, workflow, task)
+
+    locals = params.dup
+    locals[:workflow] = workflow if workflow
+    locals[:task]     = task if task
+
+    render_partial(template_file, locals)
+  end
+end

data/share/views/compass/_foundation_setup.sass

@@ -0,0 +1,79 @@
+// Make sure the charset is set appropriately
+@charset "UTF-8"
+
+// This includes all of the foundation global elements that are needed to work with any of the other files.
+//
+// RENAME THIS TO _foundation-global.scss ONCE ALL THE OLD VARIABLES ARE OUT OF THE FILE.
+
+@import "normalize"
+@import "foundation/_variables"
+@import "foundation/components/global"
+@import "colors"
+$breakpoint: 1050px
+
+$small-screen: emCalc($breakpoint) 
+$medium-screen: emCalc(1280px) 
+$large-screen: emCalc(1440px) 
+
+$small: "only screen and (min-width:"#{$small-screen}")" 
+$medium: "only screen and (min-width:"#{$medium-screen}")" 
+$large: "only screen and (min-width:"#{$large-screen}")" 
+
+
+$very_small: "only screen and (max-width: #{$small-screen / 2})" 
+$not_small: "only screen and (min-width: #{$small-screen})" 
+$only_small: "only screen and (max-width: #{$small-screen})" 
+
+$topbar-breakpoint: emCalc($breakpoint)
+$topbar-media-query: "only screen and (min-width:"#{$topbar-breakpoint}")" 
+
+@import "foundation/_variables"
+@import "normalize"
+
+$row-width: auto 
+$column-gutter: 30px
+$total-columns: 12
+$mobile-total-columns: 4
+$block-grid-elements: 12
+
+$indent: 15px
+$vindent: 22px
+$white: #EEEEEE
+
+
+// Foundation Components
+@import foundation/components/grid
+@import foundation/components/visibility
+@import foundation/components/block-grid
+@import foundation/components/type
+@import foundation/components/buttons
+@import foundation/components/forms
+//@import foundation/components/custom-forms
+@import foundation/components/button-groups
+@import foundation/components/dropdown-buttons
+//@import foundation/components/split-buttons
+//@import foundation/components/flex-video
+@import foundation/components/section
+@import foundation/components/top-bar
+//@import foundation/components/orbit
+@import foundation/components/reveal
+//@import foundation/components/joyride
+@import foundation/components/clearing
+//@import foundation/components/alert-boxes
+//@import foundation/components/breadcrumbs
+//@import foundation/components/keystrokes
+//@import foundation/components/labels
+@import foundation/components/inline-lists
+@import foundation/components/pagination
+@import foundation/components/panels
+//@import foundation/components/pricing-tables
+//@import foundation/components/progress-bars
+//@import foundation/components/side-nav
+//@import foundation/components/sub-nav
+//@import foundation/components/switch
+//@import foundation/components/magellan
+@import foundation/components/tables
+//@import foundation/components/thumbs
+//@import foundation/components/tooltips
+@import foundation/components/dropdown
+