stash-sword 0.1.0

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

@@ -0,0 +1,143 @@
+require 'spec_helper'
+require 'webmock/rspec'
+
+module Stash
+  module Sword
+    describe HTTPHelper do
+
+      # ------------------------------------------------------------
+      # Fixture
+
+      attr_writer :user_agent
+
+      def user_agent
+        @user_agent ||= 'elvis'
+      end
+
+      attr_writer :helper
+
+      def helper
+        @helper ||= HTTPHelper.new(user_agent: user_agent)
+      end
+
+      # ------------------------------------------------------------
+      # Tests
+
+      describe '#post' do
+        it 'posts to the specified URI' do
+          uri = URI('http://example.org/')
+          stub_request(:post, uri)
+          helper.post(uri: uri, payload: 'the payload')
+          expect(a_request(:post, uri)).to have_been_made
+        end
+
+        it 'sends the payload' do
+          uri = URI('http://example.org/')
+          stub_request(:post, uri)
+
+          payload = 'the payload'
+          helper.post(uri: uri, payload: payload)
+
+          expect(a_request(:post, uri).with do |req|
+            expect(req.body).to eq(payload)
+          end).to have_been_made
+        end
+
+        it 'sets the User-Agent header' do
+          uri = URI('http://example.org/')
+          stub_request(:post, uri)
+
+          helper.post(uri: uri, payload: 'the payload')
+
+          expect(a_request(:post, uri).with do |req|
+            expect(req.headers).to include_header('User-Agent', user_agent)
+          end).to have_been_made
+        end
+
+        it 'sets Basic-Auth headers' do
+          username = 'elvis'
+          password = 'presley'
+          helper   = HTTPHelper.new(user_agent: user_agent, username: username, password: password)
+
+          uri            = URI('http://example.org/')
+          authorized_uri = URI(uri.to_s.sub('http://', "http://#{username}:#{password}@"))
+          stub_request(:post, authorized_uri)
+
+          helper.post(uri: uri, payload: 'the payload')
+          expect(a_request(:post, authorized_uri)).to have_been_made
+        end
+
+        it 'sets other specified headers' do
+          uri = URI('http://example.org/')
+          stub_request(:post, uri)
+
+          headers = {
+            'Packaging'    => 'http://purl.org/net/sword/package/SimpleZip',
+            'Content-Type' => 'application/zip'
+          }
+          helper.post(uri: uri, payload: 'the payload', headers: headers)
+
+          expect(a_request(:post, uri).with do |req|
+            headers.each do |k, v|
+              expect(req.headers).to include_header(k, v)
+            end
+          end).to have_been_made
+        end
+
+        it 'uses SSL for https requests' do
+          uri           = URI('https://example.org/')
+          uri_with_port = uri.to_s.sub('org/', 'org:443/')
+          stub_request(:post, uri_with_port)
+          helper.post(uri: uri, payload: 'the payload')
+          expect(a_request(:post, uri_with_port)).to have_been_made
+        end
+
+        describe 'continuation' do
+          it 'sends Expect: 100-continue'
+          it 'sends the request body on a 100 Continue'
+          it 'continues on a timeout in lieu of a 100 Continue'
+          it 'redirects to post to a 302 Found'
+          it 'respects the redirect limit'
+          it 'fails on a 417 Expectation Failed'
+        end
+        describe 'responses' do
+          it 'accepts a 200 OK'
+          it 'accepts a 204 No Content'
+          it 'accepts a 201 Created'
+          it 'redirects to get a 303 See Other'
+          it 'respects the redirect limit'
+          it 'fails on a 4xx'
+          it 'fails on a 5xx'
+        end
+      end
+
+      describe '#post_file' do
+        it 'posts to the specified URI'
+        it 'sends the payload'
+        it 'sets the User-Agent header'
+        it 'sets Basic-Auth headers'
+        it 'sets other specified headers'
+        it 'uses SSL for https requests'
+
+        describe 'continuation' do
+          it 'sends Expect: 100-continue'
+          it 'sends the request body on a 100 Continue'
+          it 'continues on a timeout in lieu of a 100 Continue'
+          it 'redirects to post to a 302 Found'
+          it 'respects the redirect limit'
+          it 'fails on a 417 Expectation Failed'
+        end
+        describe 'responses' do
+          it 'accepts a 200 OK'
+          it 'accepts a 204 No Content'
+          it 'accepts a 201 Created'
+          it 'redirects to get a 303 See Other'
+          it 'respects the redirect limit'
+          it 'fails on a 4xx'
+          it 'fails on a 5xx'
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+require 'spec_helper'
+require 'webmock/rspec'
+
+module Stash
+  module Sword
+    describe HTTPHelper do
+
+      # ------------------------------------------------------------
+      # Fixture
+
+      attr_writer :user_agent
+
+      def user_agent
+        @user_agent ||= 'elvis'
+      end
+
+      attr_writer :helper
+
+      def helper
+        @helper ||= HTTPHelper.new(user_agent: user_agent)
+      end
+
+      # ------------------------------------------------------------
+      # Tests
+
+      describe '#put' do
+        it 'puts to the specified URI' do
+          uri = URI('http://example.org/')
+          stub_request(:put, uri)
+          helper.put(uri: uri, payload: 'the payload')
+          expect(a_request(:put, uri)).to have_been_made
+        end
+
+        it 'sends the payload' do
+          uri = URI('http://example.org/')
+          stub_request(:put, uri)
+
+          payload = 'the payload'
+          helper.put(uri: uri, payload: payload)
+
+          expect(a_request(:put, uri).with do |req|
+            expect(req.body).to eq(payload)
+          end).to have_been_made
+        end
+
+        it 'sets the User-Agent header' do
+          uri = URI('http://example.org/')
+          stub_request(:put, uri)
+
+          helper.put(uri: uri, payload: 'the payload')
+
+          expect(a_request(:put, uri).with do |req|
+            expect(req.headers).to include_header('User-Agent', user_agent)
+          end).to have_been_made
+        end
+
+        it 'sets Basic-Auth headers' do
+          username = 'elvis'
+          password = 'presley'
+          helper   = HTTPHelper.new(user_agent: user_agent, username: username, password: password)
+
+          uri            = URI('http://example.org/')
+          authorized_uri = URI(uri.to_s.sub('http://', "http://#{username}:#{password}@"))
+          stub_request(:put, authorized_uri)
+
+          helper.put(uri: uri, payload: 'the payload')
+          expect(a_request(:put, authorized_uri)).to have_been_made
+        end
+
+        it 'sets other specified headers' do
+          uri = URI('http://example.org/')
+          stub_request(:put, uri)
+
+          headers = {
+            'Packaging'    => 'http://purl.org/net/sword/package/SimpleZip',
+            'Content-Type' => 'application/zip'
+          }
+          helper.put(uri: uri, payload: 'the payload', headers: headers)
+
+          expect(a_request(:put, uri).with do |req|
+            headers.each do |k, v|
+              expect(req.headers).to include_header(k, v)
+            end
+          end).to have_been_made
+        end
+
+        it 'uses SSL for https requests' do
+          uri           = URI('https://example.org/')
+          uri_with_port = uri.to_s.sub('org/', 'org:443/')
+          stub_request(:put, uri_with_port)
+          helper.put(uri: uri, payload: 'the payload')
+          expect(a_request(:put, uri_with_port)).to have_been_made
+        end
+
+        describe 'continuation' do
+          it 'sends Expect: 100-continue'
+          it 'sends the request body on a 100 Continue'
+          it 'continues on a timeout in lieu of a 100 Continue'
+          it 'redirects to put to a 302 Found'
+          it 'respects the redirect limit'
+          it 'fails on a 417 Expectation Failed'
+        end
+        describe 'responses' do
+          it 'accepts a 200 OK'
+          it 'accepts a 204 No Content'
+          it 'accepts a 201 Created'
+          it 'redirects to get a 303 See Other'
+          it 'respects the redirect limit'
+          it 'fails on a 4xx'
+          it 'fails on a 5xx'
+        end
+      end
+
+      describe '#put_file' do
+        it 'puts to the specified URI'
+        it 'sends the payload'
+        it 'sets the User-Agent header'
+        it 'sets Basic-Auth headers'
+        it 'sets other specified headers'
+        it 'uses SSL for https requests'
+
+        describe 'continuation' do
+          it 'sends Expect: 100-continue'
+          it 'sends the request body on a 100 Continue'
+          it 'continues on a timeout in lieu of a 100 Continue'
+          it 'redirects to put to a 302 Found'
+          it 'respects the redirect limit'
+          it 'fails on a 417 Expectation Failed'
+        end
+        describe 'responses' do
+          it 'accepts a 200 OK'
+          it 'accepts a 204 No Content'
+          it 'accepts a 201 Created'
+          it 'redirects to get a 303 See Other'
+          it 'respects the redirect limit'
+          it 'fails on a 4xx'
+          it 'fails on a 5xx'
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+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

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

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Stash
+  module Sword
+    describe Namespace do
+
+      it 'defines namespaces' do
+        by_namespace = {}
+        by_uri = {}
+        by_prefix = {}
+
+        Namespace.each do |ns_enum|
+          expect(ns_enum.value).to be_an(XML::MappingExtensions::Namespace)
+
+          expect(by_namespace.key?(ns_enum.value)).to be(false), -> { "Duplicate namespace: #{by_namespace[ns_enum.value].key} and #{ns_enum.key} both declare #{ns_enum.value}" }
+          by_namespace[ns_enum.value] = ns_enum
+
+          expect(by_uri.key?(ns_enum.uri)).to be(false), -> { "Duplicate URI: #{by_uri[ns_enum.uri].key} and #{ns_enum.key} both declare #{ns_enum.uri}" }
+          by_uri[ns_enum.uri] = ns_enum
+
+          if ns_enum.prefix
+            expect(by_prefix.key?(ns_enum.prefix)).to be(false), -> { "Duplicate prefix: #{by_prefix[ns_enum.prefix].key} and #{ns_enum.key} both declare #{ns_enum.prefix}" }
+            by_prefix[ns_enum.prefix] = ns_enum
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,153 @@
+require 'spec_helper'
+require 'tempfile'
+
+module Stash
+  module Sword
+
+    RSpec.shared_examples 'reading' do
+      it 'reads' do
+        expect(sqio.read).to eq(content)
+      end
+
+      it 'reads into a buffer' do
+        expect(sqio.read(len, outbuf)).to eq(content)
+        expect(outbuf).to eq(content)
+      end
+
+      it 'reads n < length chars' do
+        length   = len / 2
+        expected = content.slice(0, length)
+        expect(sqio.read(length)).to eq(expected)
+      end
+
+      it 'reads n < length chars into a buffer' do
+        length   = len / 2
+        expected = content.slice(0, length)
+        expect(sqio.read(length, outbuf)).to eq(expected)
+        expect(outbuf).to eq(expected)
+      end
+
+      it 'reads n == length chars' do
+        expect(sqio.read(len)).to eq(content)
+      end
+
+      it 'reads n == length chars into a buffer' do
+        expect(sqio.read(len, outbuf)).to eq(content)
+        expect(outbuf).to eq(content)
+      end
+
+      it 'reads n > length chars' do
+        expect(sqio.read(len * 2)).to eq(content)
+      end
+
+      it 'reads n > length chars into a buffer' do
+        expect(sqio.read(len * 2, outbuf)).to eq(content)
+        expect(outbuf).to eq(content)
+      end
+
+      it 'calculates the size' do
+        expect(sqio.size).to eq(len)
+      end
+    end
+
+    describe SequenceIO do
+
+      ALPHANUMERIC = Array('A'..'Z') + Array('a'..'z') + Array('0'..'9')
+
+      attr_reader :len
+      attr_reader :content
+      attr_reader :sqio
+      attr_reader :outbuf
+      attr_reader :tempfiles
+
+      before(:each) do
+        @len    = 100
+        @outbuf = '[overwrite me!]'
+      end
+
+      after(:each) do
+        sqio.close if sqio
+        tempfiles.each { |f| File.delete(f) } if tempfiles
+      end
+
+      def make_alphanumeric_string(chars)
+        Array.new(chars) { ALPHANUMERIC.sample }.join
+      end
+
+      def make_tempfile(base_name, content)
+        f = Tempfile.new([base_name, 'bin'])
+        f.binmode
+        begin
+          f.write(content)
+        ensure
+          f.close
+        end
+        f.path
+      end
+
+      describe 'a string' do
+        before(:each) do
+          @content = make_alphanumeric_string(len)
+          @sqio    = SequenceIO.new(@content)
+        end
+        include_examples 'reading'
+      end
+
+      describe 'a file' do
+        before(:each) do
+          @content   = Random.new.bytes(len)
+          @tempfiles = [make_tempfile('array_stream-spec', content)]
+          @sqio      = SequenceIO.new(File.open(tempfiles[0], 'rb'))
+        end
+        include_examples 'reading'
+      end
+
+      describe 'an array of strings' do
+        before(:each) do
+          inputs   = Array.new(10) { make_alphanumeric_string(10) }
+          @content = inputs.join
+          @sqio    = SequenceIO.new(inputs)
+        end
+        include_examples 'reading'
+      end
+
+      describe 'an array of files' do
+        before(:each) do
+          @content   = ''
+          @tempfiles = Array.new(10) do |i|
+            content = Random.new.bytes(10)
+            @content << content
+            make_tempfile("array_stream-spec-#{i}", content)
+          end
+          @sqio      = SequenceIO.new(@tempfiles.map { |f| File.open(f, 'rb') })
+        end
+        include_examples 'reading'
+      end
+
+      describe 'a mix of strings and files' do
+        before(:each) do
+          @content   = ''
+          @tempfiles = []
+          inputs     = (0..9).map do |i|
+            content = nil
+            begin
+              if i.even?
+                content = make_alphanumeric_string(10)
+              else
+                content = Random.new.bytes(10)
+                @tempfiles << make_tempfile("array_stream-spec-#{i}", content)
+                File.open(tempfiles.last, 'rb')
+              end
+            ensure
+              @content << content
+            end
+          end
+
+          @sqio = SequenceIO.new(inputs)
+        end
+
+        include_examples 'reading'
+      end
+    end
+  end
+end