Merge pull request #20 from MITLibraries/5_sword_submission

5 sword submission

Author: JPrevost

Gemfile

@@ -12,7 +12,7 @@ gem 'less-rails'
 gem 'nokogiri'
 gem 'omniauth-mit-oauth2'
 gem 'omniauth-oauth2', '~> 1.3.1'
-gem 'passenger'
+gem 'rest-client'
 gem 'rubyzip', require: 'zip'
 gem 'skylight'
 gem 'therubyracer', platforms: :ruby
@@ -24,6 +24,10 @@ group :production do
   gem 'rails_12factor'
 end
 
+group :production, :development do
+  gem 'passenger'
+end
+
 group :development, :test do
   gem 'byebug'
   gem 'sqlite3'
@@ -40,4 +44,6 @@ group :test do
   gem 'minitest-reporters'
   gem 'minitest-rails'
   gem 'minitest-rails-capybara'
+  gem 'vcr'
+  gem 'webmock'
 end

Gemfile.lock

@@ -46,6 +46,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    addressable (2.4.0)
     annotate (2.6.10)
       activerecord (>= 3.2, <= 4.3)
       rake (~> 10.4)
@@ -76,8 +77,10 @@ GEM
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
       tins (~> 1.6.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     debug_inspector (0.0.2)
-    devise (3.5.2)
+    devise (3.5.3)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
       railties (>= 3.2.6, < 5)
@@ -93,6 +96,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     globalid (0.3.6)
       activesupport (>= 4.1.0)
+    hashdiff (0.2.3)
     hashie (3.4.3)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
@@ -161,7 +165,7 @@ GEM
     orm_adapter (0.5.0)
     parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
-    passenger (5.0.21)
+    passenger (5.0.22)
       rack
       rake (>= 0.8.1)
     pg (0.18.4)
@@ -216,14 +220,15 @@ GEM
       tins (<= 1.6.0)
     ruby-progressbar (1.7.5)
     rubyzip (1.1.7)
+    safe_yaml (1.0.4)
     simplecov (0.11.1)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     skylight (0.10.0)
       activesupport (>= 3.0.0)
-    sprockets (3.5.1)
+    sprockets (3.5.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (2.3.3)
@@ -253,13 +258,18 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
-    warden (1.2.3)
+    vcr (3.0.0)
+    warden (1.2.4)
       rack (>= 1.0)
     web-console (2.2.1)
       activemodel (>= 4.0)
       binding_of_caller (>= 0.7.2)
       railties (>= 4.0)
       sprockets-rails (>= 2.0, < 4.0)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     xpath (2.0.0)
       nokogiri (~> 1.3)
 
@@ -287,14 +297,17 @@ DEPENDENCIES
   pg
   rails (= 4.2.5)
   rails_12factor
+  rest-client
   rubocop
   rubyzip
   skylight
   sqlite3
   therubyracer
   twitter-bootstrap-rails
   uglifier (>= 1.3.0)
+  vcr
   web-console (~> 2.0)
+  webmock
 
 BUNDLED WITH
    1.10.6

app/controllers/submissions_controller.rb

@@ -19,8 +19,7 @@ def create
     @submission = Submission.new(submission_params)
     @submission.user = current_user
     if @submission.save
-      process_submission(@submission)
-      flash.notice = 'Your Submission is now in progress.'
+      process_submission
       redirect_to submissions_path
     else
       render 'new'
@@ -33,10 +32,34 @@ def package
 
   private
 
-  def process_submission(submission)
-    # this will likely want to be an asynch job queue
-    # to create the package and handle the sword submission
-    submission.to_sword_package
+  def process_submission
+    @submission.to_sword_package
+    sword = Sword.new(@submission)
+    begin
+      sword.deposit
+      read_sword_response(sword)
+    rescue RestClient::Unauthorized
+      @submission.status = 'failed'
+      flash.notice = 'There was a problem with your submission.'
+    end
+    @submission.save
+  end
+
+  def read_sword_response(sword)
+    deposited(sword) if sword.response.code == 201
+    queued if sword.response.code == 202
+  end
+
+  def deposited(sword)
+    @submission.status = 'deposited'
+    @submission.handle = sword.handle
+    flash.notice =
+      "Your Submission succeeded. Permanent URL: #{@submission.handle}"
+  end
+
+  def queued
+    @submission.status = 'in review queue'
+    flash.notice = 'Your Submission is now in progress.'
   end
 
   def submission_params

app/models/mets.rb

@@ -5,7 +5,8 @@ def initialize(submission)
       xml['mets'].mets(
         'xmlns:mets' => 'http://www.loc.gov/METS/',
         'xmlns:xlink' => 'http://www.w3.org/1999/xlink',
-        'xmlns:epdcx' => 'http://purl.org/eprint/epdcx/2006-11-16/') do
+        'xmlns:epdcx' => 'http://purl.org/eprint/epdcx/2006-11-16/',
+        'PROFILE' => 'DSpace METS SIP Profile 1.0') do
         overall_structure(xml)
       end
     end

app/models/submission.rb

@@ -14,6 +14,8 @@
 #  created_at        :datetime         not null
 #  updated_at        :datetime         not null
 #  documents         :string
+#  status            :string
+#  handle            :string
 #
 
 class Submission < ActiveRecord::Base

app/models/sword.rb

@@ -0,0 +1,24 @@
+class Sword
+  attr_reader :response
+
+  def initialize(submission)
+    @submission = submission
+    @sword_server = RestClient::Resource.new(
+      Rails.application.secrets.sword_endpoint,
+      user: Rails.application.secrets.sword_username,
+      password: Rails.application.secrets.sword_password)
+  end
+
+  def deposit
+    @response = @sword_server.post(
+      File.read(@submission.sword_path),
+      content_type: 'application/zip',
+      x_packaging: 'http://purl.org/net/sword-types/METSDSpaceSIP')
+  end
+
+  def handle
+    return unless @response.code == 201
+    xml = Nokogiri::XML(@response)
+    xml.xpath('//atom:id').text
+  end
+end

app/models/user.rb

@@ -7,7 +7,7 @@
 #  uid        :string           not null
 #  created_at :datetime         not null
 #  updated_at :datetime         not null
-#  admin      :boolean
+#  admin      :boolean          default(FALSE)
 #
 
 class User < ActiveRecord::Base

app/views/submissions/index.html.erb

@@ -1,18 +1,33 @@
 <h1>MIT DSpace Quick Submit Submissions</h1>
 
 <% if @submissions %>
-  <ul>
+
   <% @submissions.each do |sub| %>
-    <li>
-      <strong><%= sub.title %></strong>
-      submitted: <%= time_ago_in_words(sub.created_at) %> ago
-      <br />
+    <% if sub.status == 'deposited' %>
+      <div class="panel panel-success">
+    <% elsif sub.status == 'in review queue' %>
+      <div class="panel panel-info">
+    <% elsif sub.status == 'failed' %>
+      <div class="panel panel-danger">
+    <% else %>
+      <div class="panel panel-warning">
+    <% end %>
+      <div class="panel-heading">
+        <%= sub.title %>
+      </div>
+      <div class="panel-body">
+        Submitted: <%= time_ago_in_words(sub.created_at) %> ago<br />
+        Status: <%= sub.status || 'unknown' %><br />
+        Permanent URL: <%= sub.handle || 'pending submission processing' %><br />
+      </div>
       <% if current_user.admin? %>
-        <%= link_to('Sword Package', submission_package_path(sub)) %>
+        <div class="panel-footer">
+          <%= link_to('Sword Package', submission_package_path(sub)) %>
+        </div>
       <% end %>
-    </li>
+    </div>
   <% end %>
-  </ul>
+
 <% else %>
   <p>You have no submissions in progress.</p>
 <% end %>

config/environments/production.rb

@@ -42,7 +42,7 @@
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
-  # config.force_ssl = true
+  config.force_ssl = true
 
   # Use the lowest log level to ensure availability of diagnostic information
   # when problems arise.

config/secrets.yml

@@ -18,13 +18,22 @@ common: &common
 development:
   <<: *common
   secret_key_base: 85c11866fb99f4aa04e3b6a44ea14ab2e8594395c16b90797ea3b57402737be909f7d3a198486ad3e0deb448dbc022c5b4d5b2fd60bcfda7739d36d4b64d42d7
+  sword_endpoint: <%= ENV['SWORD_ENDPOINT'] %>
+  sword_username: <%= ENV['SWORD_USERNAME'] %>
+  sword_password: <%= ENV['SWORD_PASSWORD'] %>
 
 test:
   <<: *common
   secret_key_base: a42ad0e17b7f5a1e4aca95c930ee3d497f6ffe9a96a85818fe8544028b8f96a2641141da61bcdb39f67af684ffd096836f7c43b09417fd017c7f6126051b90bb
+  sword_endpoint: http://example.com
+  sword_username: username
+  sword_password: password
 
 # Do not keep production secrets in the repository,
 # instead read values from the environment.
 production:
   <<: *common
   secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
+  sword_endpoint: <%= ENV['SWORD_ENDPOINT'] %>
+  sword_username: <%= ENV['SWORD_USERNAME'] %>
+  sword_password: <%= ENV['SWORD_PASSWORD'] %>