stash-sword 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e0a9bb5934ab1313698dde7e68177a63ffb0597
-  data.tar.gz: 2ad46f630eb85d4349e24c8bf866607358c5ae4c
+  metadata.gz: 0037ff658b5959ae0dca3bdfed3af072d81a7755
+  data.tar.gz: 6677bb48ecbe7d07e25d1bf27c1737250f4c1ae9
 SHA512:
-  metadata.gz: 66c005b599f1359ad1fe9884a065d4a96619af9764b791c034f8c5f197f413ef50a2d08c0f654ad662496aae6c387cee9f2d9ebed96ae9503a996930dfcebaae
-  data.tar.gz: 124321ab9db2a6d31f43f16fb717f595337f92778219f45521adccb74d63af3e8ee26d5afbe65c078164f9175374c4aaa1435522a9809e124934d995addadc57
+  metadata.gz: 6a0e6a7532fb0e39ae48dd242e9b20f03cae6870f43addbbb20c6d137f49cddcec1510798c9e33fbb516c8a6b71906afafc2c8c647cfdb9bc6cdd97417d28d57
+  data.tar.gz: 0265b3b0cfc3fd3d0ea4eac70bafd83f528632259e9bbc4943cd869b0aa5cd490e1a7e880a749bb73c13e9a400eb7f2c246fbe87a543d8092b8f1ff3517e4866

data/.gitignore

@@ -15,6 +15,8 @@
 *.a
 mkmf.log
 
+/*.gem
+
 # Database
 
 db/*.sqlite3

data/CHANGES.md

@@ -0,0 +1,7 @@
+## 0.1.1 (23 June 2016)
+
+- `logger` is now a parameter passed to `Stash::Sword::Client` instead of a global singleton.
+
+## 0.1.0 (8 June 2016)
+
+- Initial release.

data/examples/{example.rb → create.rb}

@@ -4,23 +4,23 @@ require 'stash/sword'
 
 include Stash::Sword
 
-username, password, collection = ARGV
+password = ARGV[0]
+username = 'ucop_dash_submitter'
+collection = 'dash_cdl'
+collection_uri = "http://uc3-mrtsword-dev.cdlib.org:39001/mrtsword/collection/#{collection}"
+zipfile = File.expand_path('../uploads/example.zip', __FILE__)
+
+doi = "doi:10.5072/FK#{Time.now.to_i}"
 
 client = Client.new(
   username: username,
   password: password,
-  collection_uri: URI("http://uc3-mrtsword-dev.cdlib.org:39001/mrtsword/collection/#{collection}")
+  collection_uri: URI(collection_uri)
 )
 
-doi = "doi:10.5072/FK#{Time.now.to_i}"
-zipfile = File.expand_path('../uploads/example.zip', __FILE__)
-
 receipt = client.create(doi: doi, zipfile: zipfile)
 em_iri = receipt.em_iri
-se_iri = receipt.se_iri
+edit_iri = receipt.edit_iri
 
 puts "em_iri: #{em_iri}"
-puts "se_iri: #{se_iri}"
-
-code = client.update(se_iri: se_iri, zipfile: zipfile)
-puts "update response code: #{code}"
+puts "edit_iri: #{edit_iri}"

data/examples/update.rb

@@ -0,0 +1,22 @@
+#! /usr/bin/env ruby
+
+require 'stash/sword'
+
+include Stash::Sword
+
+password = ARGV[0]
+username = 'ucop_dash_submitter'
+collection = 'dash_cdl'
+collection_uri = "http://uc3-mrtsword-dev.cdlib.org:39001/mrtsword/collection/#{collection}"
+zipfile = File.expand_path('../uploads/example.zip', __FILE__)
+
+edit_iri = 'http://sword-aws-dev.cdlib.org:39001/mrtsword/edit/dash_cdl/doi%3A10.5072%2FFK1465424720'
+
+client = Client.new(
+  username: username,
+  password: password,
+  collection_uri: URI(collection_uri)
+)
+
+code = client.update(edit_iri: edit_iri, zipfile: zipfile)
+puts "update response code: #{code}"

data/lib/stash/sword.rb

@@ -1,39 +1,5 @@
-require 'uri'
-require 'logger'
-
 module Stash
-
-  # TODO: Make this configurable
-  LOG_LEVEL = case ENV['RAILS_ENV'].to_s.downcase
-              when 'test'
-                Logger::DEBUG
-              when 'development'
-                Logger::INFO
-              else
-                Logger::WARN
-              end
-
   module Sword
-
     Dir.glob(File.expand_path('../sword/*.rb', __FILE__)).sort.each(&method(:require))
-
-    def self.log
-      @log ||= new_logger(logdev: $stdout)
-    end
-
-    def self.log_device=(value)
-      @log = new_logger(logdev: value)
-    end
-
-    def self.new_logger(logdev:, level: Stash::LOG_LEVEL, shift_age: 10, shift_size: 1024 * 1024)
-      logger = Logger.new(logdev, shift_age, shift_size)
-      logger.level = level
-      logger.formatter = proc do |severity, datetime, progname, msg|
-        "#{datetime.to_time.utc} #{severity} -#{progname}- #{msg}\n"
-      end
-      logger
-    end
-
-    private_class_method :new_logger
   end
 end

data/lib/stash/sword/client.rb

@@ -4,6 +4,7 @@ require 'stash/sword/header_utils'
 require 'stash/sword/log_utils'
 require 'stash/sword/http_helper'
 require 'stash/sword/sequence_io'
+require 'logger'
 
 module Stash
   module Sword
@@ -24,7 +25,8 @@ module Stash
       # @param password [String] the password
       # @param on_behalf_of [String, nil] the user for whom the original sword package was deposited on behalf of.
       #   Defaults to `username`.
-      def initialize(collection_uri:, username:, password:, on_behalf_of: nil, helper: nil)
+      # @param logger [Logger, nil] the logger to use, or nil to use a default logger
+      def initialize(collection_uri:, username:, password:, on_behalf_of: nil, logger: nil, helper: nil)
         raise 'no collection URI provided' unless collection_uri
         raise 'no username provided' unless username
         raise 'no password provided' unless password
@@ -32,7 +34,8 @@ module Stash
         @username     = username
         @password     = password
         @on_behalf_of = on_behalf_of || username
-        @helper       = helper || HTTPHelper.new(username: username, password: password, user_agent: "stash-sword #{VERSION}")
+        @helper       = helper || HTTPHelper.new(username: username, password: password, user_agent: "stash-sword #{VERSION}", logger: logger)
+        @log          = logger || default_logger
       end
 
       # Creates a new resource for the specified DOI with the specified zipfile
@@ -118,7 +121,11 @@ module Stash
         update_mime_headers(zipfile).each { |k, v| content << "#{k}: #{v}#{EOL}" }
         content << EOL
         content << zipfile
+        content << EOL
         content << "--#{boundary}--#{EOL}"
+
+        log.debug("Payload:\n\t#{content.map(&:to_s).join("\t")}")
+
         SequenceIO.new(content).binmode
       end
 

data/lib/stash/sword/header_utils.rb

@@ -5,13 +5,15 @@ module Stash
       SIMPLE_ZIP                 = 'http://purl.org/net/sword/package/SimpleZip'.freeze
       APPLICATION_ZIP            = 'application/zip'.freeze
       MULTIPART_RELATED_ATOM_XML = 'multipart/related; type="application/atom+xml"'.freeze
+      # CONTENT_DISPOSITION        = 'attachment'.freeze
+      CONTENT_DISPOSITION        = 'form-data'.freeze
 
       attr_reader :on_behalf_of
 
       def create_request_headers(zipfile, slug)
         {
           'Content-Type'        => APPLICATION_ZIP,
-          'Content-Disposition' => "attachment; filename=#{File.basename(zipfile)}",
+          'Content-Disposition' => "#{CONTENT_DISPOSITION}; filename=#{File.basename(zipfile)}",
           'Packaging'           => SIMPLE_ZIP,
           'Content-MD5'         => Digest::MD5.file(zipfile).to_s,
           'On-Behalf-Of'        => on_behalf_of,
@@ -31,7 +33,7 @@ module Stash
       def update_mime_headers(zipfile)
         {
           'Content-Type'        => APPLICATION_ZIP,
-          'Content-Disposition' => "attachment; name=payload; filename=\"#{File.basename(zipfile)}\"",
+          'Content-Disposition' => "#{CONTENT_DISPOSITION}; name=\"payload\"; filename=\"#{File.basename(zipfile)}\"",
           'Packaging'           => SIMPLE_ZIP,
           'Content-MD5'         => Digest::MD5.file(zipfile).to_s,
           'MIME-Version'        => '1.0'

data/lib/stash/sword/http_helper.rb

@@ -30,11 +30,13 @@ module Stash
       # @param user_agent [String] the User-Agent string to send when making requests
       # @param redirect_limit [Integer] the number of redirects to follow before erroring out
       #   (defaults to {DEFAULT_MAX_REDIRECTS})
-      def initialize(user_agent:, username: nil, password: nil, redirect_limit: DEFAULT_MAX_REDIRECTS)
+      # @param logger [Logger, nil] the logger to use, or nil to use a default logger
+      def initialize(user_agent:, username: nil, password: nil, redirect_limit: DEFAULT_MAX_REDIRECTS, logger: nil)
         @user_agent = user_agent
         @redirect_limit = redirect_limit
         @username = username
         @password = password
+        @log = logger || default_logger
       end
 
       # Gets the content of the specified URI as a string.

data/lib/stash/sword/log_utils.rb

@@ -1,8 +1,9 @@
 module Stash
   module Sword
     module LogUtils
+
       def log
-        ::Stash::Sword.log
+        @log ||= default_logger
       end
 
       def log_error(e)
@@ -34,6 +35,28 @@ module Stash
           "#{k}: #{value}"
         end.join("\n")
       end
+
+      def level
+        # TODO: make this configurable
+        @level ||= case ENV['RAILS_ENV'].to_s.downcase
+                   when 'test'
+                     Logger::DEBUG
+                   when 'development'
+                     Logger::INFO
+                   else
+                     Logger::WARN
+                   end
+      end
+
+      def default_logger
+        logger = Logger.new($stdout, 10, 1024 * 1024)
+        logger.level = level
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          "#{datetime.to_time.utc} #{severity} -#{progname}- #{msg}\n"
+        end
+        logger
+      end
+
     end
   end
 end

data/lib/stash/sword/module_info.rb

@@ -4,7 +4,7 @@ module Stash
     NAME = 'stash-sword'.freeze
 
     # The version of this gem
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
 
     # The copyright notice for this gem
     COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'.freeze

data/spec/rspec_custom_matchers.rb

@@ -113,6 +113,6 @@ RSpec::Matchers.define :include_header do |k, v|
   end
 
   failure_message do |actual|
-    "expected #{k}: #{v} but found #{value_for(key: k, in_hash: actual) || 'nil'}"
+    "expected #{k} to be '#{v}' but found '#{value_for(key: k, in_hash: actual) || 'nil'}'"
   end
 end

data/spec/unit/stash/sword2/client_spec.rb

@@ -33,12 +33,14 @@ module Stash
             actual_headers = req.headers
           end).to have_been_made
 
+          expected_disposition = 'attachment'
+
           aggregate_failures('request headers') do
             {
               'On-Behalf-Of' => on_behalf_of,
               'Packaging' => 'http://purl.org/net/sword/package/SimpleZip',
               'Slug' => doi,
-              'Content-Disposition' => 'attachment; filename=example.zip',
+              'Content-Disposition' => "#{expected_disposition}; filename=example.zip",
               'Content-MD5' => md5,
               'Content-Length' => /[0-9]+/,
               'Content-Type' => 'application/zip'
@@ -84,16 +86,19 @@ module Stash
             end
           end
 
+          expected_disposition = 'attachment'
+
           mime_headers = {
             'Packaging' => 'http://purl.org/net/sword/package/SimpleZip',
-            'Content-Disposition' => 'attachment; name=payload; filename="example.zip"',
+            'Content-Disposition' => "#{expected_disposition}; name=payload; filename=\"example.zip\"",
             'Content-Type' => 'application/zip',
             'Content-MD5' => md5
           }
 
           aggregate_failures('MIME headers') do
             mime_headers.each do |k, v|
-              expect(actual_body).to include("#{k}: #{v}"), "expected #{k}: #{v}, closest match was #{actual_body[/#{k}[^\n]+/m]}"
+              closest_match = actual_body[/#{k}[^\n]+/m].strip
+              expect(actual_body).to include("#{k}: #{v}"), "expected '#{k}: #{v}'; closest match was '#{closest_match}'"
             end
           end
         end

data/spec/unit/stash/sword2/sequence_io_spec.rb

@@ -67,7 +67,7 @@ module Stash
 
       after(:each) do
         sqio.close if sqio
-        tempfiles.each { |f| File.delete(f) } if tempfiles
+        tempfiles.each { |f| File.delete(f) if File.exist?(f) } if tempfiles
       end
 
       def make_alphanumeric_string(chars)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stash-sword
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -202,11 +202,13 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
+- CHANGES.md
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
-- examples/example.rb
+- examples/create.rb
+- examples/update.rb
 - examples/uploads/example.zip
 - examples/uploads/example/lorem-ipsum.txt
 - examples/uploads/example/mrt-datacite.xml
@@ -234,7 +236,6 @@ files:
 - spec/unit/stash/sword2/http_helper_get_spec.rb
 - spec/unit/stash/sword2/http_helper_post_spec.rb
 - spec/unit/stash/sword2/http_helper_put_spec.rb
-- spec/unit/stash/sword2/log_spec.rb
 - spec/unit/stash/sword2/namespaces_spec.rb
 - spec/unit/stash/sword2/sequence_io_spec.rb
 - stash-sword.gemspec
@@ -273,7 +274,6 @@ test_files:
 - spec/unit/stash/sword2/http_helper_get_spec.rb
 - spec/unit/stash/sword2/http_helper_post_spec.rb
 - spec/unit/stash/sword2/http_helper_put_spec.rb
-- spec/unit/stash/sword2/log_spec.rb
 - spec/unit/stash/sword2/namespaces_spec.rb
 - spec/unit/stash/sword2/sequence_io_spec.rb
 has_rdoc: 

data/spec/unit/stash/sword2/log_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-module Stash
-  module Sword
-    describe 'log' do
-      it 'logs to stdout in a timestamp-first format' do
-        out = StringIO.new
-        Sword.log_device = out
-        begin
-          msg = 'I am a log message'
-          Sword.log.warn(msg)
-          logged = out.string
-          expect(logged).to include(msg)
-          timestamp_str = logged.split[0]
-          timestamp = DateTime.parse(timestamp_str)
-          expect(timestamp.to_date).to eq(Time.now.utc.to_date)
-        ensure
-          Sword.log_device = $stdout
-        end
-      end
-    end
-  end
-end