mrt-ingest 0.0.4 → 0.0.5

data/spec/unit/mrt/ingest/message_digest_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Mrt::Ingest
+  module MessageDigest
+    describe SHA256 do
+      it 'wraps an SHA256 digest' do
+        value = '40191d95b873db0b6ac09aca3cf51188ce914920a2330ddda1d88f75d93588e6'
+        digest = SHA256.new(value)
+        expect(digest.value).to eq(value)
+        expect(digest.type).to eq('sha-256')
+      end
+    end
+    describe MD5 do
+      it 'wraps an MD5 digest' do
+        value = 'b6d8a343fe281e92f1296283c29efc72'
+        digest = MD5.new(value)
+        expect(digest.value).to eq(value)
+        expect(digest.type).to eq('md5')
+      end
+
+      describe :from_file do
+        it 'hashes a file in text mode' do
+          digest = MD5.from_file(File.new('spec/unit/data/file.txt'))
+          expect(digest.value).to eq('91b767c2da0e8bfe318aee57d907d5f7')
+          expect(digest.type).to eq('md5')
+        end
+      end
+    end
+    describe SHA1 do
+      it 'wraps an SHA1 digest' do
+        value = '08eefa1ab77c34a479310632923771f835c475e3'
+        digest = SHA1.new(value)
+        expect(digest.value).to eq(value)
+        expect(digest.type).to eq('sha1')
+      end
+    end
+  end
+end

data/spec/unit/mrt/ingest/one_time_server_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+require 'English'
+
+module Mrt::Ingest
+  describe OneTimeServer do
+    attr_reader :server
+
+    before(:each) do
+      @server = OneTimeServer.new
+      server.start_server
+    end
+
+    after(:each) do
+      server.stop_server
+    end
+
+    describe :finished? do
+      it 'returns true when all files have been served, false otherwise' do
+        urls = (0..3).map do |i|
+          url_str, = server.add_file { |f| f.puts("I am file #{i}") }
+          url_str
+        end
+
+        urls.each do |url|
+          expect(server.finished?).to be_falsey
+          Net::HTTP.get(URI.parse(url))
+        end
+
+        expect(server.finished?).to be_truthy
+      end
+    end
+
+    describe :temppath do
+      it 'avoids collisions' do
+        tmpfiles = []
+        allow(Tempfile).to receive(:new).and_wrap_original do |m, *args|
+          tmpfile = m.call(*args)
+          if tmpfiles.empty?
+            known_paths = server.instance_variable_get(:@known_paths)
+            known_paths[tmpfile.path] = true
+          end
+          tmpfiles << tmpfile.path
+          tmpfile
+        end
+
+        temppath = server.temppath
+        expect(tmpfiles.size).to eq(2)
+        expect(temppath).to eq(tmpfiles[1])
+      end
+    end
+
+    describe :join_server do
+      it 'blocks till all files have been served' do
+        urls = (0..3).map do |i|
+          url_str, = server.add_file { |f| f.puts("I am file #{i}") }
+          url_str
+        end
+
+        joining_thread = Thread.new { server.join_server }
+        expect(joining_thread.status).not_to be_falsey
+
+        client_process_id = fork do
+          begin
+            urls.each do |url|
+              resp = Net::HTTP.get_response(URI.parse(url))
+              status = resp.code.to_i
+              exit(status) if status != 200
+            end
+          rescue StandardError => e
+            warn(e)
+            exit(1)
+          end
+        end
+        Process.wait(client_process_id)
+        expect($CHILD_STATUS.exitstatus).to eq(0) # just to be sure
+
+        Timeout.timeout(5) { joining_thread.join }
+        expect(joining_thread.status).to eq(false)
+      end
+    end
+
+    describe :run do
+      it 'starts, serves, and stops' do
+        server2 = OneTimeServer.new
+        urls = (0..3).map do |i|
+          url_str, = server2.add_file { |f| f.puts("I am file #{i}") }
+          url_str
+        end
+
+        running_thread = Thread.new { server2.run }
+        expect(running_thread.status).not_to be_falsey
+
+        client_process_id = fork do
+          begin
+            urls.each do |url|
+              resp = Net::HTTP.get_response(URI.parse(url))
+              status = resp.code.to_i
+              exit(status) if status != 200
+            end
+          rescue StandardError => e
+            warn(e)
+            exit(1)
+          end
+        end
+        Process.wait(client_process_id)
+        expect($CHILD_STATUS.exitstatus).to eq(0) # just to be sure
+
+        Timeout.timeout(5) { running_thread.join }
+        expect(running_thread.status).to eq(false)
+      end
+    end
+  end
+end

data/spec/unit/mrt/ingest/request_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Mrt::Ingest
+  describe Request do
+    describe :new do
+      it 'should require a profile' do
+        expect do
+          Mrt::Ingest::Request.new(profile: nil, submitter: 'jd/John Doe', type: 'file')
+        end.to raise_error(ArgumentError)
+      end
+
+      it 'should require a submitter' do
+        expect do
+          Mrt::Ingest::Request.new(profile: 'demo_merritt', submitter: nil, type: 'file')
+        end.to raise_error(ArgumentError)
+      end
+
+      it 'should require a type' do
+        expect do
+          Mrt::Ingest::Request.new(profile: 'demo_merritt', submitter: 'jd/John Doe', type: nil)
+        end.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/unit/mrt/ingest/response_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module Mrt::Ingest
+  describe Response do
+    RESPONSE_JSON = <<~JSON.freeze
+      {
+          "bat:batchState": {
+              "bat:batchID":"bid-8c0fa0c2-f3d7-4deb-bd49-f953f6752b59",
+              "bat:updateFlag":false,
+              "bat:targetQueue":"example.org:2181",
+              "bat:batchStatus":"QUEUED",
+              "bat:userAgent":"egh/Erik Hetzner",
+              "bat:submissionDate":"2011-08-31T15:40:26-07:00",
+              "bat:targetQueueNode":"/ingest.example.1",
+              "bat:batchProfile": {
+                  "bat:owner":"ark:/99999/fk4tt4wsh",
+                  "bat:creationDate":"2010-01-19T13:28:14-08:00",
+                  "bat:targetStorage": {
+                      "bat:storageLink":"http://example.org:35121",
+                      "bat:nodeID":10
+                  },
+                  "bat:objectType":"MRT-curatorial",
+                  "bat:modificationDate":"2010-01-26T23:28:14-08:00",
+                  "bat:aggregateType":"",
+                  "bat:objectMinterURL":"https://example.org/ezid/shoulder/ark:/99999/fk4",
+                  "bat:collection": {
+                  },
+                  "bat:profileID":"merritt_content",
+                  "bat:profileDescription":"Merritt demo content",
+                  "bat:fixityURL":"http://example.org:33143",
+                  "bat:contactsEmail": {
+                      "bat:notification": {
+                          "bat:contactEmail":"erik.hetzner@example.org"
+                      }
+                  },
+                  "bat:identifierScheme":"ARK",
+                  "bat:identifierNamespace":"99999",
+                  "bat:objectRole":"MRT-content"
+              }
+          }
+      }
+    JSON
+
+    describe :new do
+      before(:each) do
+        @response = Response.new(RESPONSE_JSON)
+      end
+
+      it 'should parse the response' do
+        expect(@response.batch_id).to eq('bid-8c0fa0c2-f3d7-4deb-bd49-f953f6752b59')
+        expect(@response.submission_date).to eq(Time.at(1_314_830_426))
+        expect(@response.user_agent).to eq('egh/Erik Hetzner')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mrt-ingest
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mark Reyes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -95,6 +95,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.68'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -110,19 +138,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 description: A client for the Merritt ingest system. More details available from https://github.com/CDLUC3/mrt-doc/wiki
 email:
 - mark.reyes@ucop.edu
@@ -133,23 +189,41 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".hgignore"
+- ".idea/.rakeTasks"
+- ".idea/encodings.xml"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE
-- README
+- README.md
 - Rakefile
 - lib/mrt/ingest.rb
 - lib/mrt/ingest/client.rb
+- lib/mrt/ingest/component.rb
+- lib/mrt/ingest/ingest_exception.rb
 - lib/mrt/ingest/iobject.rb
 - lib/mrt/ingest/message_digest.rb
 - lib/mrt/ingest/one_time_server.rb
 - lib/mrt/ingest/request.rb
 - lib/mrt/ingest/response.rb
+- mrt-ingest-ruby.iml
 - mrt-ingest.gemspec
-- test/test_client.rb
-- test/test_iobject.rb
-- test/test_request.rb
-- test/test_response.rb
+- spec/.rubocop.yml
+- spec/spec_helper.rb
+- spec/unit/data/file.txt
+- spec/unit/mrt/ingest/client_spec.rb
+- spec/unit/mrt/ingest/component_spec.rb
+- spec/unit/mrt/ingest/iobject_spec.rb
+- spec/unit/mrt/ingest/message_digest_spec.rb
+- spec/unit/mrt/ingest/one_time_server_spec.rb
+- spec/unit/mrt/ingest/request_spec.rb
+- spec/unit/mrt/ingest/response_spec.rb
 homepage: https://github.com/CDLUC3/mrt-ingest-ruby
 licenses:
 - BSD-3-Clause
@@ -170,12 +244,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: A client for Merritt ingest.
 test_files:
-- test/test_client.rb
-- test/test_iobject.rb
-- test/test_request.rb
-- test/test_response.rb
+- spec/.rubocop.yml
+- spec/spec_helper.rb
+- spec/unit/data/file.txt
+- spec/unit/mrt/ingest/client_spec.rb
+- spec/unit/mrt/ingest/component_spec.rb
+- spec/unit/mrt/ingest/iobject_spec.rb
+- spec/unit/mrt/ingest/message_digest_spec.rb
+- spec/unit/mrt/ingest/one_time_server_spec.rb
+- spec/unit/mrt/ingest/request_spec.rb
+- spec/unit/mrt/ingest/response_spec.rb

data/README

@@ -1,29 +0,0 @@
-= mrt-ingest (ruby)
-Date:: 6 Sept. 2011
-Author:: Erik Hetzner (mailto:erik.hetzner@ucop.edu)
-
-== What?
-
-A Ruby ingest client for Merritt[http://merritt.cdlib.org/].
-
-== Install
-
-  $ gem build mrt-ingest.gemspec
-  $ sudo gem install mrt-ingest-0.0.1.gem
-
-== How?
-
-  require 'rubygems'
-  require 'mrt/ingest'
-  client = Mrt::Ingest::Client.new("http://merritt.cdlib.org/object/ingest", USERNAME, PASSWORD)
-  obj = Mrt::Ingest::IObject.new(:erc => {
-    "who"          => "Doe, John",
-    "what"         => "Hello, world",
-    "when/created" => "2011" })
-  obj.add_component(File.new("/tmp/helloworld_a"))
-  obj.add_component(File.new("/tmp/helloworld_b"))
-  obj.add_component(URI.parse("http://example.org/xxx"),
-                    :name => "helloworld_c",
-                    :digest => Mrt::Ingest::MessageDigest::MD5.new("6f5902ac237024bdd0c176cb93063dc4"))
-  obj.start_ingest(client, "demo_merritt_content", "me/My Name")
-  obj.finish_ingest()

data/test/test_client.rb

@@ -1,40 +0,0 @@
-# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
-# Copyright:: Copyright (c) 2011, Regents of the University of California
-
-require 'rubygems'
-
-require 'test/unit'
-require 'checkm'
-require 'fakeweb'
-require 'mocha'
-require 'mrt/ingest'
-require 'shoulda'
-require 'open-uri'
-
-class TestClient < Test::Unit::TestCase
-  context "creating a client" do
-    should "be able to create an ingest client" do
-      client = Mrt::Ingest::Client.new("http://example.org/ingest")
-      assert_instance_of(Mrt::Ingest::Client, client)
-    end
-
-    should "be able to create an ingest client with login credentials" do
-      client = Mrt::Ingest::Client.new("http://example.org/ingest", "me", "secret")
-      assert_instance_of(Mrt::Ingest::Client, client)
-    end
-  end
-  
-  context "ingest clients" do
-    setup do
-      @client = Mrt::Ingest::Client.new("http://example.org/ingest", "me", "secret")
-      @iobject = Mrt::Ingest::IObject.new
-      @ingest_req = @iobject.mk_request("profile", "submitter")
-    end
-
-    should "should create a good rest client request" do
-      rest_req = @client.mk_rest_request(@ingest_req)
-      assert_equal("me", rest_req.user)
-      assert_equal("secret", rest_req.password)
-    end
-  end
-end