stash-sword 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b9630eb6e13c298e5510adc24a284f80cd2782d
-  data.tar.gz: c84b4010037183af57468e22b0b33032f989cedd
+  metadata.gz: b73e085f5409cc5c2b3a74c703aacb670bffdc46
+  data.tar.gz: d393a54966e95e40d97d6019022781547fecdad2
 SHA512:
-  metadata.gz: 1ab2af3fea1f8d220075abe287baeb531265a4483814a7aae7766721c649d5a62099368d943a550e6a0ff6bebc04a36e250d9390df7952bb1f6089624de67e6d
-  data.tar.gz: ee6a6857b1c898f73312b60086a6cd3cb0af2ca9a177dbcdeca489ab60af8f9cd1c0bd04a9b2f9b61d17ffb77eee24abe56768b062ea680010b875f9b9d3141b
+  metadata.gz: 49f4a2eddae1eac20a7b8ee10c707287ca10f2e7390bab19fb7ac17a9e809a049a5f680112aa5059c76f2af6d38336ac297783d42786bb03b35230433e7f9787
+  data.tar.gz: 397fcf71c55dad279545b735274293c108989c0e604baa8ad488679cdc88b5beca0a97dfe15fdbfaf85cbd4f8e64167a44d7bacd954ac7dafd4b5af1fcca6664

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.2.5

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.1.4 (14 November 2016)
+
+- Update to Ruby 2.2.5
+- Add `timeout:` parameter to `HTTPHelper`, with a default of 10 minutes.
+
 ## 0.1.3 (15 August 2016)
 
 - Use 2.0.0 release version of `rest-client` to fix issues with cookie handling in redirection

data/examples/create.rb

@@ -7,7 +7,7 @@ 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}"
+collection_uri = "http://sword-aws-dev.cdlib.org:39001/mrtsword/collection/#{collection}"
 zipfile = File.expand_path('../uploads/example.zip', __FILE__)
 
 doi = "doi:10.5072/FK#{Time.now.to_i}"

data/lib/stash/sword/client.rb

@@ -59,8 +59,8 @@ module Stash
       def update(edit_iri:, zipfile:)
         log.debug("Stash::Sword::Client.update(edit_iri: #{edit_iri}, zipfile: #{zipfile})")
         uri = to_uri(edit_iri).to_s
-        response = maybe_redirect(do_put(uri, zipfile))
-        log.debug(response_to_log_msg(response))
+        response = do_put(uri, zipfile)
+        log.debug(to_log_msg(response))
         response.code # TODO: what if anything should we return here?
       rescue => e
         log_error(e)
@@ -75,15 +75,8 @@ module Stash
         raise 'no password provided' unless password
       end
 
-      def maybe_redirect(response)
-        return response unless [301, 302, 307].include?(response.code)
-        log.debug(response_to_log_msg(response))
-        log.debug("Response code #{response.code}; redirecting")
-        response.follow_get_redirection
-      end
-
       def receipt_from(response)
-        log.debug(response_to_log_msg(response))
+        log.debug(to_log_msg(response))
 
         body = response.body.strip
         return DepositReceipt.parse_xml(body) unless body.empty?
@@ -97,7 +90,7 @@ module Stash
         return nil unless edit_iri
 
         log.debug("Retrieving deposit receipt from Location header Edit-IRI: #{edit_iri}")
-        body = helper.get(to_uri(edit_iri))
+        body = helper.get(uri: to_uri(edit_iri))
         return nil unless body
 
         DepositReceipt.parse_xml(body)

data/lib/stash/sword/http_helper.rb

@@ -13,12 +13,18 @@ module Stash
       # The default number of redirects to follow before erroring out.
       DEFAULT_MAX_REDIRECTS = 5
 
+      # The default number of seconds to allow before timing out. Defaults to 10 minutes.
+      DEFAULT_TIMEOUT = 60 * 10
+
       # @return [String] the User-Agent string to send when making requests
       attr_accessor :user_agent
 
       # @return [Integer] the number of redirects to follow before erroring out
       attr_accessor :redirect_limit
 
+      # @return [Integer] the number of seconds to allow before timing out
+      attr_accessor :timeout
+
       # @return [String] the HTTP Basic Authentication username
       attr_reader :username
 
@@ -31,9 +37,10 @@ module Stash
       # @param redirect_limit [Integer] the number of redirects to follow before erroring out
       #   (defaults to {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)
+      def initialize(user_agent:, username: nil, password: nil, redirect_limit: DEFAULT_MAX_REDIRECTS, timeout: DEFAULT_TIMEOUT, logger: nil)
         @user_agent = user_agent
         @redirect_limit = redirect_limit
+        @timeout = timeout
         @username = username
         @password = password
         @log = logger || default_logger
@@ -53,12 +60,12 @@ module Stash
 
       # Posts the specified payload string to the specified URI.
       def post(uri:, payload:, headers: {}, limit: redirect_limit)
-        do_post_or_put(method: :post, uri: uri, payload: payload, headers: headers, limit: limit)
+        do_post_or_put(method: :post, uri: uri, payload: payload, headers: headers, limit: limit, timeout: timeout)
       end
 
       # Puts the specified payload string to the specified URI.
       def put(uri:, payload:, headers: {}, limit: redirect_limit)
-        do_post_or_put(method: :put, uri: uri, payload: payload, headers: headers, limit: limit)
+        do_post_or_put(method: :put, uri: uri, payload: payload, headers: headers, limit: limit, timeout: timeout)
       end
 
       private
@@ -70,19 +77,20 @@ module Stash
         }.freeze
       end
 
-      def do_post_or_put(method:, uri:, payload:, headers:, limit:)
-        options = request_options(headers, limit, method, payload, uri)
+      def do_post_or_put(method:, uri:, payload:, headers:, limit:, timeout:)
+        options = request_options(headers, limit, method, payload, uri, timeout)
         log_hash(options)
         RestClient::Request.execute(**options)
       end
 
-      def request_options(headers, limit, method, payload, uri)
+      def request_options(headers, limit, method, payload, uri, timeout)
         options = {
           method: method,
           url: uri.to_s,
           payload: payload,
           headers: headers.merge(default_headers),
-          max_redirects: limit
+          max_redirects: limit,
+          timeout: timeout
         }
         options[:user] = username if username
         options[:password] = password if password

data/lib/stash/sword/log_utils.rb

@@ -7,21 +7,15 @@ module Stash
       end
 
       def log_error(e)
-        if e.respond_to?(:response)
-          log.error(response_to_log_msg(e.response))
-        else
-          log.error('Unable to log response')
-        end
+        log.error(to_log_msg(e))
       end
 
-      def response_to_log_msg(response)
-        [
-          '-----------------------------------------------------',
-          "code: #{response.code}",
-          'headers:', hash_to_log_msg(response.headers),
-          "body:\n#{response.body}",
-          '-----------------------------------------------------'
-        ].join("\n")
+      def to_log_msg(e)
+        msg_lines = []
+        append_message(msg_lines, e)
+        append_response(msg_lines, e)
+        append_backtrace(msg_lines, e)
+        msg_lines.join("\n")
       end
 
       def log_hash(hash)
@@ -49,7 +43,11 @@ module Stash
       end
 
       def default_logger
-        logger = Logger.new($stdout, 10, 1024 * 1024)
+        LogUtils.create_default_logger($stdout, level)
+      end
+
+      def self.create_default_logger(io, level)
+        logger = Logger.new(io, 10, 1024 * 1024)
         logger.level = level
         logger.formatter = proc do |severity, datetime, progname, msg|
           "#{datetime.to_time.utc} #{severity} -#{progname}- #{msg}\n"
@@ -57,6 +55,31 @@ module Stash
         logger
       end
 
+      private
+
+      def append_message(msg_lines, e)
+        msg_lines << if e.respond_to?(:message) && e.message
+                       "message: #{e.message}"
+                     else
+                       e.to_s
+                     end
+      end
+
+      def append_response(msg_lines, e)
+        return unless e.respond_to?(:response) && e.response
+        response = e.response
+        msg_lines.unshift(*[
+                            "code: #{response.code}",
+                            'headers:', hash_to_log_msg(response.headers),
+                            "body:\n#{response.body}"
+                          ])
+      end
+
+      def append_backtrace(msg_lines, e)
+        return unless e.respond_to?(:backtrace) && e.backtrace
+        msg_lines.unshift(*e.backtrace)
+      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.3'.freeze
+    VERSION = '0.1.4'.freeze
 
     # The copyright notice for this gem
     COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'.freeze

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

@@ -50,8 +50,20 @@ module Stash
           end
         end
 
+        it "gets the entry from the Edit-IRI in the Location: header if it isn't returned in the body" do
+          authorized_uri = collection_uri.sub('http://', "http://#{username}:#{password}@")
+
+          redirect_url = 'http://www.example.org/'
+          stub_request(:post, authorized_uri).to_return(status: 201, headers: { 'Location' => redirect_url })
+          stub_request(:get, redirect_url.sub('http://', "http://#{username}:#{password}@")).to_return(
+            body: '<entry xmlns="http://www.w3.org/2005/Atom"><id>http://merritt.cdlib.org/sword/v2/object/ark:/99999/fk4t157x4p</id><author><name>ucb_dash_submitter</name></author><generator uri="http://www.swordapp.org/" version="2.0" /><link href="http://merritt.cdlib.org/sword/v2/object/ark:/99999/fk4t157x4p" rel="edit" /><link href="http://merritt.cdlib.org/sword/v2/object/ark:/99999/fk4t157x4p" rel="http://purl.org/net/sword/terms/add" /><link href="http://merritt.cdlib.org/sword/v2/object/ark:/99999/fk4t157x4p" rel="edit-media" /><treatment xmlns="http://purl.org/net/sword/terms/">no treatment information available</treatment></entry>'
+          )
+
+          receipt = client.create(zipfile: zipfile, doi: doi)
+          expect(receipt).to be_a(DepositReceipt)
+        end
+
         it 'returns the entry'
-        it "gets the entry from the Edit-IRI in the Location: header if it isn't returned in the body"
         it 'forwards a success response'
 
         it 'forwards a 4xx error' do
@@ -115,8 +127,15 @@ module Stash
           end
         end
 
-        it 'does something clever and asynchronous'
-        it 'forwards a success response'
+        it 'follows redirects' do
+          edit_iri = "http://merritt.cdlib.org/sword/v2/object/#{doi}"
+          authorized_uri = edit_iri.sub('http://', "http://#{username}:#{password}@")
+          redirect_url = 'http://www.example.org/'
+          stub_request(:put, authorized_uri).to_return(status: 303, headers: { 'Location' => redirect_url })
+          stub_request(:get, redirect_url.sub('http://', "http://#{username}:#{password}@")).to_return(status: 200)
+          code = client.update(edit_iri: edit_iri, zipfile: zipfile)
+          expect(code).to eq(200)
+        end
 
         it 'forwards a 4xx error' do
           edit_iri = "http://merritt.cdlib.org/sword/v2/object/#{doi}"

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

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+module Stash
+  module Sword
+    describe LogUtils do
+
+      attr_reader :log_utils
+      attr_reader :rails_env
+      attr_reader :log_io
+
+      before(:all) { @rails_env = ENV['RAILS_ENV'] }
+      after(:all) { ENV['RAILS_ENV'] = rails_env }
+
+      before(:each) do
+        @log_io = StringIO.new
+        @log_utils = Class.new { include LogUtils }.new
+        @log_utils.instance_variable_set(:@log, LogUtils.create_default_logger(@log_io, log_utils.level))
+      end
+
+      def log_str
+        @log_io.string
+      end
+
+      it 'sets the log level based on $RAILS_ENV' do
+        expected = {
+          'test' => Logger::DEBUG,
+          'development' => Logger::INFO,
+          'stage' => Logger::WARN,
+          'production' => Logger::WARN
+        }
+        expected.each do |env, lvl|
+          ENV['RAILS_ENV'] = env
+          expect(Class.new { include LogUtils }.new.level).to eq(lvl)
+        end
+      end
+
+      it 'logs an error response' do
+        code = 404
+        body = 'Your princess is in another castle'
+        headers = { 'Location' => 'http://example.org' }
+        message = 'I am the message'
+
+        response = instance_double(RestClient::Response)
+        expect(response).to receive(:code) { code }
+        expect(response).to receive(:headers) { headers }
+        expect(response).to receive(:body) { body }
+
+        error = RestClient::ExceptionWithResponse.new(response, 999)
+        error.message = message
+
+        log_utils.log_error(error)
+        expect(log_str).to include(code.to_s)
+        expect(log_str).to include(body)
+        headers.each do |k, v|
+          expect(log_str).to include("#{k}: #{v}")
+        end
+        expect(log_str).to include(message)
+      end
+
+      it 'logs an error with a nil response' do
+        message = 'I am the message'
+        error = RestClient::ExceptionWithResponse.new(nil, 999)
+        error.message = message
+        log_utils.log_error(error)
+        expect(log_str).to include(message)
+      end
+
+      it 'logs an error with a backtrace' do
+        backtrace = nil
+        begin
+          raise RestClient::ExceptionWithResponse.new(nil, 999)
+        rescue => e
+          backtrace = e.backtrace
+          log_utils.log_error(e)
+        end
+        expect(log_str).to include(backtrace.join("\n"))
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stash-sword
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -240,6 +240,7 @@ 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
@@ -263,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Stash SWORD 2.0 connector
@@ -278,6 +279,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: