wfs_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 193e2d9a2a4a8f44dfe139c5a716fd15c5337db1
+  data.tar.gz: 936a69758235a327113c9b5f5d678ea22e3423c2
+SHA512:
+  metadata.gz: f4c52e7ad4fa246ede3d79029cb93e7c09d3101b6bc9e06e130e304826d117534b1bb462ad886eb9297f81c0da5dda06dc3d40bedb8b4a94c93a3538a568a696
+  data.tar.gz: a5a7faf7fe8c92a07c69093ea88e15afdc3dcff30263f78ed3883f40946aad3da8a8758468702e0c74ced2b875b450f245544fa3a6b1393468c7f5863f1cf029

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2015 by The Board of Trustees of the Leland Stanford
+Junior University.  All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.

data/README.md

@@ -0,0 +1,6 @@
+## WFS Rails
+
+A Rails engine for testing/using Stanford WorkFlowServices
+
+See `config/routes.rb` for implemented routes
+

data/Rakefile

@@ -0,0 +1,9 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'engine_cart/rake_task'

data/app/assets/javascripts/wfs_rails/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/wfs_rails/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/wfs_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module WfsRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/wfs_rails/workflow_controller.rb

@@ -0,0 +1,39 @@
+module WfsRails
+  ##
+  # API for handling workflow request
+  class WorkflowController < ApplicationController
+    def lifecycle
+      @objects = Workflow.where(
+        repository: params[:repo], druid: params[:druid]
+      )
+    end
+
+    def workflows
+      @processes = Workflow.where(
+        repository: params[:repo], druid: params[:druid]
+      ).order(:datastream, created_at: :asc).group_by(&:datastream)
+    end
+
+    def workflows_by_datastream
+      @processes = Workflow.where(
+        repository: params[:repo],
+        druid: params[:druid],
+        datastream: params[:workflow]
+      ).order(:datastream, created_at: :asc).group_by(&:datastream)
+      render :workflows
+    end
+
+    def archive
+      @objects = Workflow.where(
+        repository: params[:repository],
+        datastream: params[:workflow]
+      ).count
+    end
+
+    def create
+      @workflows = WfsRails::WorkflowParser.new(
+        request.body.read, params[:druid], params[:repo]
+      ).create_workflows
+    end
+  end
+end

data/app/helpers/wfs_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module WfsRails
+  module ApplicationHelper
+  end
+end

data/app/models/wfs_rails/workflow.rb

@@ -0,0 +1,34 @@
+module WfsRails
+  class Workflow < ActiveRecord::Base
+    validates :druid, presence: true
+    validates :datastream, presence: true
+    validates :process, presence: true
+
+    ##
+    # Serialize a WfsRails::Workflow as a milestone
+    # @param [Nokogiri::XML::Builder] xml
+    # @return [Nokogiri::XML::Builder::NodeBuilder]
+    def as_milestone(xml)
+      xml.milestone(lifecycle,
+                    date: updated_at.to_time.iso8601,
+                    version: version)
+    end
+
+    ##
+    # Serialize as WfsRails::Workflow as a process
+    # @param [Nokogiri::XML::Builder] xml
+    # @return [Nokogiri::XML::Builder::NodeBuilder]
+    def as_process(xml)
+      xml.process(version: version,
+                  priority: priority,
+                  note: note,
+                  lifecycle: lifecycle,
+                  laneId: lane_id,
+                  elapsed: elapsed,
+                  attempts: attempts,
+                  datetime: created_at.to_time.iso8601,
+                  status: status,
+                  name: process)
+    end
+  end
+end

data/app/views/layouts/wfs_rails/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>WfsRails</title>
+  <%= stylesheet_link_tag    "wfs_rails/application", media: "all" %>
+  <%= javascript_include_tag "wfs_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/wfs_rails/workflow/archive.xml.builder

@@ -0,0 +1 @@
+xml.objects(count: @objects)

data/app/views/wfs_rails/workflow/lifecycle.xml.builder

@@ -0,0 +1,5 @@
+xml.lifecycle(objectId: params[:druid]) do
+  @objects.each do |workflow|
+    workflow.as_milestone(xml)
+  end
+end

data/app/views/wfs_rails/workflow/workflows.xml.builder

@@ -0,0 +1,9 @@
+xml.workflows(objectId: params[:druid]) {
+  @processes.each do |datastream|
+    xml.workflow(repository: params[:repo], objectId: params[:druid], id: datastream[0]) do
+      datastream[1].each do |workflow|
+        workflow.as_process(xml)
+      end
+    end
+  end
+}

data/config/routes.rb

@@ -0,0 +1,22 @@
+WfsRails::Engine.routes.draw do
+  get '/:repo/objects/:druid/lifecycle',
+      to: 'workflow#lifecycle',
+      constraints: { druid: %r{[^\/]+} },
+      defaults: { format: :xml }
+  get '/:repo/objects/:druid/workflows',
+      to: 'workflow#workflows',
+      constraints: { druid: %r{[^\/]+} },
+      defaults: { format: :xml }
+  get '/:repo/objects/:druid/workflows/:workflow',
+      to: 'workflow#workflows_by_datastream',
+      constraints: { druid: %r{[^\/]+} },
+      defaults: { format: :xml }
+  put '/:repo/objects/:druid/workflows/:workflow',
+      to: 'workflow#create',
+      constraints: { druid: %r{[^\/]+} },
+      defaults: { format: :xml }
+  get '/workflow_archive',
+      to: 'workflow#archive',
+      constraints: { druid: %r{[^\/]+} },
+      defaults: { format: :xml }
+end

data/db/migrate/20151112054510_create_wfs_rails_workflows.rb

@@ -0,0 +1,21 @@
+class CreateWfsRailsWorkflows < ActiveRecord::Migration
+  def change
+    create_table :wfs_rails_workflows do |t|
+      t.string      :druid, null: false
+      t.string      :datastream, null: false
+      t.string      :process, null: false
+      t.string      :status
+      t.text        :error_msg
+      t.binary      :error_txt
+      t.integer     :attempts, default: 0, null: false
+      t.string      :lifecycle
+      t.decimal     :elapsed, precision: 9, scale: 3
+      t.string      :repository
+      t.integer     :version, default: 1
+      t.text        :note
+      t.integer     :priority, default: 0
+      t.string      :lane_id, default: 'default', null: false
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/wfs_rails/install_generator.rb

@@ -0,0 +1,13 @@
+module WfsRails
+  class Install < Rails::Generators::Base
+    def add_routes
+      route <<-EOF
+        mount WfsRails::Engine => '/'
+      EOF
+    end
+
+    def install_migrations
+      rake('wfs_rails:install:migrations')
+    end
+  end
+end

data/lib/wfs_rails/engine.rb

@@ -0,0 +1,16 @@
+module WfsRails
+  class Engine < ::Rails::Engine
+    isolate_namespace WfsRails
+
+    require 'wfs_rails/workflow_parser'
+    require 'wfs_rails/process_parser'
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/wfs_rails/process_parser.rb

@@ -0,0 +1,29 @@
+module WfsRails
+  ##
+  # Parsing Process creation request
+  class ProcessParser
+    attr_reader :process
+
+    ##
+    # @param [Nokogiri::XML::Element] process
+    def initialize(process)
+      @process = process
+    end
+
+    def name
+      process.attr('name')
+    end
+
+    def status
+      process.attr('status')
+    end
+
+    def lane_id
+      process.attr('laneId')
+    end
+
+    def lifecycle
+      process.attr('lifecycle')
+    end
+  end
+end

data/lib/wfs_rails/version.rb

@@ -0,0 +1,3 @@
+module WfsRails
+  VERSION = "0.0.1"
+end

data/lib/wfs_rails/workflow_parser.rb

@@ -0,0 +1,48 @@
+module WfsRails
+  ##
+  # Parsing Workflow creation request
+  class WorkflowParser
+    attr_reader :xml_request, :druid, :repository
+
+    ##
+    # @param [String] request_body
+    # @param [String] druid
+    # @param [String] repository
+    def initialize(request_body, druid, repository)
+      @xml_request = Nokogiri::XML(request_body)
+      @druid = druid
+      @repository = repository
+    end
+
+    ##
+    # @return [Array]
+    def create_workflows
+      processes.map do |process|
+        Workflow.create(datastream: workflow_id,
+                        druid: druid,
+                        process: process.name,
+                        status: process.status,
+                        lane_id: process.lane_id,
+                        repository: repository,
+                        lifecycle: process.lifecycle
+                       )
+      end
+    end
+
+    private
+
+    def workflow
+      xml_request.xpath('//workflow')
+    end
+
+    def processes
+      workflow.xpath('//process').map do |process|
+        ProcessParser.new(process)
+      end
+    end
+
+    def workflow_id
+      workflow.attr('id')
+    end
+  end
+end

data/lib/wfs_rails.rb

@@ -0,0 +1,4 @@
+require "wfs_rails/engine"
+
+module WfsRails
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: wfs_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Reed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails engine for using/testing Stanford Libraries Workflow Services.
+email:
+- pjreed@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/wfs_rails/application.js
+- app/assets/stylesheets/wfs_rails/application.css
+- app/controllers/wfs_rails/application_controller.rb
+- app/controllers/wfs_rails/workflow_controller.rb
+- app/helpers/wfs_rails/application_helper.rb
+- app/models/wfs_rails/workflow.rb
+- app/views/layouts/wfs_rails/application.html.erb
+- app/views/wfs_rails/workflow/archive.xml.builder
+- app/views/wfs_rails/workflow/create.xml.builder
+- app/views/wfs_rails/workflow/lifecycle.xml.builder
+- app/views/wfs_rails/workflow/workflows.xml.builder
+- config/routes.rb
+- db/migrate/20151112054510_create_wfs_rails_workflows.rb
+- lib/generators/wfs_rails/install_generator.rb
+- lib/tasks/wfs_rails_tasks.rake
+- lib/wfs_rails.rb
+- lib/wfs_rails/engine.rb
+- lib/wfs_rails/process_parser.rb
+- lib/wfs_rails/version.rb
+- lib/wfs_rails/workflow_parser.rb
+homepage: 
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Rails engine for using/testing Stanford Libraries Workflow Services.
+test_files: []