wfs_rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 93afc7ee2ee310809ee14375f509e17c06a6275c
-  data.tar.gz: f05aeecd99a271c420411e757a72847a676efba1
+SHA256:
+  metadata.gz: d0e773620a0175206c1408629e9faddc261cc0ebe6d3c50e6ce3db989b555850
+  data.tar.gz: 748531162b2d00125b45e79b77b273793843397ca385ebd8695c13a4b2d0cbdd
 SHA512:
-  metadata.gz: 427f2847a024de186edb0560f20e54bb3daddba565426f5219400abaabbaceb37ccf46c2d050e86e79813cbbd07e61dbb27940001f9a4893219e8f9a70107f68
-  data.tar.gz: 0223b5dbe3a5e8f17f3b833230007e70b1b358e895427574a788adbc5e2983b16cf5c6635b1d7003358b4b3b3c61d9d7a4ded7ba0688a1a3dee1ae149bf42c48
+  metadata.gz: 71d3c82b9fa1f0a940ec4a0729613e6a942647b8edb849c943696815bece1c6f2987d87a4de4487a8e884818a59073c53dcef9eae3c4052aa1180f1674dabaf5
+  data.tar.gz: 3a38697aea8fc9f50c33f0096eb63ab2ae7aacb2215e95a237977ec64f0ae4be5f4576de7df8b6c13bedb0fd35cb1c30a634ee57766ab1a7756d095f98aceb35

data/README.md

@@ -1,7 +1,41 @@
 ## WFS Rails
 [![Build Status](https://travis-ci.org/sul-dlss/wfs_rails.svg)](https://travis-ci.org/sul-dlss/wfs_rails)
 
-A Rails engine for testing/using Stanford WorkFlowServices
+WFS Rails is a Rails engine for testing and development with Stanford's DOR Worklow Services.
 
-See `config/routes.rb` for implemented routes
+The Rails engine stubs several of the most frequently
+used Workflow Services routes (but not all of them). See `config/routes.rb` for implemented routes.
 
+### Installing
+Add to `Gemfile`
+```ruby
+gem 'wfs_rails'
+```
+Then `bundle install`
+
+Next add this to `config/routes.rb`:
+```ruby
+Rails.application.routes.draw do
+  mount WfsRails::Engine => '/'
+end
+```
+
+Finally run:
+```
+rake wfs_rails:install:migrations
+```
+
+
+### Alternative install
+You may choose to use
+[Capybara::Discoball](https://github.com/thoughtbot/capybara_discoball) which 
+expects to use your application's Rails database as storage for Workflow Service data. The advantage of using WFS Rails is that you don't need
+to access any external Workflow APIs during development or testing (this is especially useful when building on Travis).
+
+To set up and use WFS Rails in your project, take a look at this Argo pull request:
+
+https://github.com/sul-dlss/argo/pull/317/files
+
+Or this stanalone server:
+
+https://github.com/sul-dlss-labs/workflow-server-rails/

data/Rakefile

@@ -15,7 +15,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end
 
-EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
+ENV['ENGINE_CART_RAILS_OPTIONS'] = '--api'
 
 desc 'Run test suite'
 task ci: ['wfs_rails:generate'] do

data/app/controllers/wfs_rails/application_controller.rb

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

data/app/controllers/wfs_rails/workflow_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WfsRails
   ##
   # API for handling workflow request. Implemented as an isolated Rails::Engine
@@ -10,19 +12,44 @@ module WfsRails
       )
     end
 
-    def workflows
+    def index
       @processes = Workflow.where(
         repository: params[:repo], druid: params[:druid]
       ).order(:datastream, created_at: :asc).group_by(&:datastream)
     end
 
-    def workflows_by_datastream
+    def show
       @processes = Workflow.where(
         repository: params[:repo],
         druid: params[:druid],
         datastream: params[:workflow]
       ).order(:datastream, created_at: :asc).group_by(&:datastream)
-      render :workflows
+      render :index
+    end
+
+    def update
+      @process = Workflow.find_by!(
+        repository: params[:repo],
+        druid: params[:druid],
+        datastream: params[:workflow],
+        process: params[:process]
+      )
+
+      if params['current-status'].present?
+        @process.update(status: params['current-status'])
+      else
+        @process.update(status: 'completed')
+      end
+      head :no_content
+   end
+
+    def destroy
+      @processes = Workflow.where(
+        repository: params[:repo],
+        druid: params[:druid],
+        datastream: params[:workflow]
+      ).destroy_all
+      head :no_content
     end
 
     def archive

data/config/routes.rb

@@ -1,20 +1,18 @@
+# frozen_string_literal: true
+
 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 }
+  scope ':repo/objects/:druid', constraints: { druid: %r{[^\/]+} }, defaults: { format: :xml } do
+    get 'lifecycle', to: 'workflow#lifecycle'
+
+    resources :workflows, only: %i[show index destroy], controller: 'workflow', param: :workflow do
+      collection do
+        # Create should be a POST, but this is what the Java WFS app did.
+        put ':workflow', to: 'workflow#create'
+        put ':workflow/:process', to: 'workflow#update'
+      end
+    end
+  end
+
   get '/workflow_archive',
       to: 'workflow#archive',
       constraints: { druid: %r{[^\/]+} },

data/lib/generators/wfs_rails/install_generator.rb

@@ -5,9 +5,5 @@ module WfsRails
         mount WfsRails::Engine => '/'
       EOF
     end
-
-    def install_migrations
-      rake('wfs_rails:install:migrations')
-    end
   end
 end

data/lib/wfs_rails/engine.rb

@@ -2,6 +2,7 @@ module WfsRails
   class Engine < ::Rails::Engine
     isolate_namespace WfsRails
 
+    require 'jbuilder'
     require 'wfs_rails/workflow_parser'
     require 'wfs_rails/process_parser'
 

data/lib/wfs_rails/version.rb

@@ -1,3 +1,3 @@
 module WfsRails
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wfs_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jack Reed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -113,8 +127,8 @@ files:
 - 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/index.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
@@ -144,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Rails engine for using/testing Stanford Libraries Workflow Services.