mrt-ingest 0.0.2

data/.hgignore

@@ -0,0 +1,4 @@
+.*\.gem
+\.bundle
+Gemfile\.lock
+pkg/.*

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mrt-ingest.gemspec
+gemspec
+
+group :test do
+  gem "fakeweb"
+  gem "mocha"
+  gem "checkm", ">=0.0.6"
+end

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2011, Regents of the University of California
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+- Neither the name of the University of California nor the names of its
+  contributors may be used to endorse or promote products derived from this 
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
+POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,29 @@
+= 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/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+require 'rake/testtask'
+require 'rdoc/task'
+
+require 'bundler'
+include Rake::DSL
+Bundler::GemHelper.install_tasks
+
+task :default => [:test]
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+RDoc::Task.new do |rd|
+  rd.title = "Merritt Ingest Client"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
+
+  rd.options += ['-f', 'darkfish',]
+end

data/lib/mrt/ingest.rb

@@ -0,0 +1,16 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+module Mrt
+  module Ingest
+    autoload :Client, "mrt/ingest/client"
+    autoload :IObject, "mrt/ingest/iobject"
+    autoload :MessageDigest, "mrt/ingest/message_digest"
+    autoload :OneTimeServer, "mrt/ingest/one_time_server"
+    autoload :Request, "mrt/ingest/request"
+    autoload :Response, "mrt/ingest/response"
+
+    class IngestException < Exception
+    end
+  end
+end

data/lib/mrt/ingest/client.rb

@@ -0,0 +1,38 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'rubygems'
+
+require 'rest-client'
+
+module Mrt
+  module Ingest
+
+    # A client for ingesting objects into a Merritt.
+    class Client
+      def initialize(base_uri, username=nil, password=nil)
+        @base_uri = base_uri
+        @username = username
+        @password = password
+      end
+
+      # Send a request to the client.
+      def ingest(ingest_req)
+        return Response.new(mk_rest_request(ingest_req).execute())
+      end
+
+      # :nodoc:
+      def mk_rest_request(ingest_req)
+        args = { 
+          :method   => :post,
+          :url      => @base_uri,
+          :user     => @username,
+          :password => @password,
+          :payload  => ingest_req.mk_args(),
+          :headers  => { :multipart => true } }.delete_if { |k,v| (v.nil? || v == "") }
+        return RestClient::Request.new(args)
+      end
+
+    end
+  end
+end

data/lib/mrt/ingest/iobject.rb

@@ -0,0 +1,144 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'mrt/ingest'
+require 'tempfile'
+require 'uri'
+
+module Mrt
+  module Ingest
+    # Represents a component of an object to ingest. Either a #URI or a
+    # #File.
+    class Component # :nodoc:
+      def initialize(server, where, options)
+        @name = options[:name]
+        @digest = options[:digest]
+        @mime_type = options[:mime_type]
+        @size = options[:size]
+        
+        case where
+        when File, Tempfile
+          @name = File.basename(where.path) if @name.nil?
+          @uri = server.add_file(where)[0]
+          if @digest.nil? then
+            @digest = Mrt::Ingest::MessageDigest::MD5.from_file(where)
+          end
+          @size = File.size(where.path) if @size.nil?
+        when URI
+          @name = File.basename(where.to_s) if @name.nil?
+          @uri = where
+        else
+          raise IngestException.new("Trying to add a component that is not a File or URI")
+        end
+        
+      end
+      
+      def to_manifest_entry
+        (digest_alg, digest_value) = if @digest.nil? then
+                                       ['', '']
+                                     else
+                                       [@digest.type, @digest.value]
+                                     end
+        return "#{@uri} | #{digest_alg} | #{digest_value} | #{@size || ''} | | #{@name} | #{@mime_type || '' }\n"
+      end
+    end
+    
+    # An object prepared for ingest into Merritt.
+    class IObject
+      
+      attr_accessor :primary_identifier, :local_identifier, :erc
+
+      # Options can have the keys :primary_identifier,
+      # :local_identifier, :server, or :erc. :erc can be a #File, #Uri
+      # or a #Hash of metadata. :server is a #OneTimeServer.
+      def initialize(options={})
+        @primary_identifier = options[:primary_identifier]
+        @local_identifier = options[:local_identifier]
+        @erc = options[:erc] || Hash.new
+        @components = []
+        @server = options[:server] || Mrt::Ingest::OneTimeServer.new
+      end
+      
+      # Add a component to the object. where can be either a #URI or a
+      # #File. Options is a hash whose keys may be :name, :digest,
+      # :mime_type, or :size. If :digest is supplied, it must be a
+      # subclass of Mrt::Ingest::MessageDigest::Base. If where is a
+      # #File, it will be hosted on an embedded web server.
+      def add_component(where, options={})
+        @components.push(Component.new(@server, where, options))
+      end
+      
+      # Make a Mrt::Ingest::Request object for this mrt-object
+      def mk_request(profile, submitter)
+        erc_component = case @erc
+                        when URI, File, Tempfile
+                          Component.new(@server, @erc, :name => 'mrt-erc.txt')
+                        when Hash
+                          uri_str, path = @server.add_file do |f|
+                            @erc.each_pair do |k, v|
+                              f.write("#{k}: #{v}\n")
+                            end
+                          end
+                          Component.new(@server, 
+                                        URI.parse(uri_str), 
+                                        :name => 'mrt-erc.txt',
+                                        :digest => Mrt::Ingest::MessageDigest::MD5.from_file(File.new(path)))
+                        else
+                          raise IngestException.new("Bad ERC supplied: must be a URI, File, or Hash")
+                        end
+        manifest_file = Tempfile.new("mrt-ingest")
+        mk_manifest(manifest_file, erc_component)
+        # reset to beginning
+        manifest_file.open
+        return Mrt::Ingest::Request.
+          new(:file               => manifest_file,
+              :filename           => manifest_file.path.split(/\//).last,
+              :type               => "object-manifest",
+              :submitter          => submitter,
+              :profile            => profile,
+              :primary_identifier => @primary_identifier)
+      end
+
+      def start_server # :nodoc:
+        return @server.start_server()
+      end
+
+      def join_server # :nodoc:
+        return @server.join_server()
+      end
+
+      def stop_server # :nodoc:
+        return @server.stop_server()
+      end
+        
+      def mk_manifest(manifest, erc_component) # :nodoc:
+        manifest.write("#%checkm_0.7\n")
+        manifest.write("#%profile http://uc3.cdlib.org/registry/ingest/manifest/mrt-ingest-manifest\n")
+        manifest.write("#%prefix | mrt: | http://uc3.cdlib.org/ontology/mom#\n")
+        manifest.write("#%prefix | nfo: | http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#\n")
+        manifest.write("#%fields | nfo:fileUrl | nfo:hashAlgorithm | nfo:hashValue | nfo:fileSize | nfo:fileLastModified | nfo:fileName | mrt:mimeType\n")
+        @components.each { |c|
+          manifest.write(c.to_manifest_entry)
+        }
+        manifest.write(erc_component.to_manifest_entry)
+        manifest.write("#%EOF\n")
+      end
+      
+      # Begin an ingest on the given client, with a profile and
+      # submitter.
+      def start_ingest(client, profile, submitter)
+        request = mk_request(profile, submitter)
+        start_server
+        @response = client.ingest(request)
+        return @response
+      end
+
+      # Wait for the ingest of this object to finish.
+      def finish_ingest
+        # XXX Right now we only join the hosting server; in the future
+        # we will check the status via the ingest server.
+        join_server
+      end
+    end
+  end
+end

data/lib/mrt/ingest/message_digest.rb

@@ -0,0 +1,51 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'digest/md5'
+
+module Mrt
+  module Ingest
+    module MessageDigest
+      class Base # :nodoc:
+        attr_reader :value, :type
+        def initialize(value, type)
+          @value = value
+          @type  = type
+        end
+      end
+      
+      # Represents a SHA256 digest suitable for a Checkm manifest.
+      class SHA256 < Base
+        def initialize(value)
+          super(value, "sha-256")
+        end
+      end
+
+      # Represents an MD5 digest suitable for a Checkm manifest.
+      class MD5 < Base
+        def initialize(value)
+          super(value, "md5")
+        end
+        
+        # Generate a digest from a file.
+        def self.from_file(file)
+          digest = Digest::MD5.new
+          File.open(file.path, 'r') do |f|
+            buff = ""
+            while (f.read(1024, buff) != nil)
+              digest << buff
+            end
+          end
+          return Mrt::Ingest::MessageDigest::MD5.new(digest.hexdigest)
+        end
+      end
+
+      # Represents a SHA1 digest suitable for a Checkm manifest.
+      class SHA1 < Base
+        def initialize(value)
+          super(value, "sha1")
+        end
+      end
+    end
+  end
+end

data/lib/mrt/ingest/one_time_server.rb

@@ -0,0 +1,116 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'webrick'
+
+# An HTTP server that will serve each file ONCE before shutting down.
+module Mrt
+  module Ingest
+    class OneTimeServer
+      # Find an open port, starting with start and adding one until we get
+      # an open port
+      def get_open_port(start=8080)
+        try_port = start
+        while (true)
+          begin
+            s = TCPServer.open(try_port)
+            s.close
+            return try_port
+          rescue Errno::EADDRINUSE
+            try_port = try_port + 1
+          end
+        end
+      end
+
+      def initialize
+        @dir = Dir.mktmpdir
+        @mutex = Mutex.new
+        @known_paths = {}
+        @requested = {}
+        @port = get_open_port()
+        @file_callback = lambda do |req, res|
+          @requested[req.path] ||= true
+        end
+      
+        config = { :Port => @port }
+        @server = WEBrick::HTTPServer.new(config)
+        @server.mount("/", WEBrick::HTTPServlet::FileHandler, @dir,
+                      { :FileCallback=>@file_callback })
+      end
+
+      # Return true if each file has been served.
+      def finished?
+        Dir.entries(@dir).each do |entry|
+          next if (entry == "." || entry == "..")
+          if @requested["/#{entry}"].nil? then
+            return false
+          end
+        end
+        return true
+      end
+
+      def get_temppath
+        tmpfile = Tempfile.new("tmp", @dir)
+        tmppath = tmpfile.path
+        tmpfile.close!
+        @mutex.synchronize do
+          if !@known_paths.has_key?(tmppath) then
+            # no collision
+            @known_paths[tmppath] = true
+            return tmppath
+          end
+        end
+        # need to retry, there was a collision
+        return get_temppath
+      end
+
+      # Add a file to this server. Returns the URL to use
+      # to fetch the file & the file path
+      def add_file(sourcefile=nil)
+        fullpath = get_temppath()
+        path = File.basename(fullpath)
+        if !sourcefile.nil? then
+          @server.mount("/#{path}",
+                        WEBrick::HTTPServlet::FileHandler,
+                        sourcefile.path,
+                        { :FileCallback=>@file_callback })
+        else
+          File.open(fullpath, 'w+') do |f|
+            yield f
+          end
+        end
+        return "http://#{Socket.gethostname}:#{@port}/#{path}", fullpath
+      end
+      
+      def start_server
+        @thread = Thread.new do
+          @server.start
+        end
+        return @thread
+      end
+
+      # Stop server unconditionally.
+      def stop_server
+        @server.shutdown
+        @thread.join
+      end
+
+      # Wait for server to finish serving all files.
+      def join_server
+        # ensure that each file is requested once before shutting down
+        while (!self.finished?) do sleep(1) end
+        @server.shutdown 
+        @thread.join
+      end
+      
+      # Run the server and wait until each file has been served once.
+      # Cleans up files before it returns.
+      def run
+        start_server()
+        join_server()
+        #    FileUtils.rm_rf(@dir)
+        return
+      end
+    end
+  end
+end

data/lib/mrt/ingest/request.rb

@@ -0,0 +1,57 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+module Mrt
+  module Ingest
+    class RequestException < Exception
+    end
+
+    # Represents a request to be sent to an ingest server.
+    class Request
+      attr_accessor :creator, :date, :local_identifier,
+                    :primary_identifier, :profile, :note, :submitter,
+                    :title, :type
+
+      # Options is a hash; required are :profile, :submitter, :type.
+      # May also include :creator, :date, :digest, :file, :filename,
+      # :local_identifier, :primary_identifier, :note, :title.
+      def initialize(options)
+        @creator = options[:creator]
+        @date = options[:date]
+        @digest = options[:digest]
+        @file = options[:file]
+        @filename = options[:filename]
+        @local_identifier = options[:local_identifier]
+        @primary_identifier = options[:primary_identifier]
+        @profile = options[:profile]
+        @note = options[:note]
+        @submitter = options[:submitter]
+        @title = options[:title]
+        @type = options[:type]
+        [:profile, :submitter, :type].each do |arg|
+          raise RequestException.new("#{arg} is required.") if options[arg].nil?
+        end
+      end
+      
+      # Returns a hash of arguments suitable for sending to a server.
+      def mk_args
+        return {
+          'creator'           => @creator,
+          'date'              => @date,
+          'digestType'        => ((!@digest.nil? && @digest.type) || nil),
+          'digestValue'       => ((!@digest.nil? && @digest.value) || nil),
+          'file'              => @file,
+          'filename'          => @filename,
+          'localIdentifier'   => @local_identifier,
+          'primaryIdentifier' => @primary_identifier,
+          'profile'           => @profile,
+          'note'              => @note,
+          'responseForm'      => 'json',
+          'submitter'         => @submitter,
+          'title'             => @title,
+          'type'              => @type
+        }.reject{|k, v| v.nil? || (v == '')}
+      end
+    end
+  end
+end

data/lib/mrt/ingest/response.rb

@@ -0,0 +1,29 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'rubygems'
+
+require 'json'
+require 'time'
+
+module Mrt
+  module Ingest
+    class Response
+      def initialize(data)
+        @parsed = JSON.parse(data)['batchState']
+      end
+      
+      def batch_id
+        return @parsed['batchID']
+      end
+      
+      def user_agent
+        return @parsed['userAgent']
+      end
+      
+      def submission_date
+        return Time.parse(@parsed['submissionDate'])
+      end
+    end
+  end
+end

data/mrt-ingest.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mrt/ingest/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mrt-ingest"
+  s.version     = "0.0.2"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Erik Hetzner"]
+  s.email       = ["erik.hetzner@ucop.edu"]
+  s.homepage    = "http://bitbucket.org/merritt/mrt-ingest-ruby"
+  s.summary     = %q{A client for Merritt ingest.}
+  s.description = %q{A client for the Merritt ingest system. More details available from http://wiki.ucop.edu/display/curation.}
+
+  s.add_dependency "json", ">=1.5.0"
+  s.add_dependency "rest-client", ">=1.6.0"
+
+  s.rubyforge_project = "mrt-ingest"
+
+  s.files         = `hg locate`.split("\n")
+  s.test_files    = `hg locate --include '{spec,features}'`.split("\n")
+  s.executables   = `hg locate --include bin`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/test_client.rb

@@ -0,0 +1,39 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'rubygems'
+
+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

data/test/test_iobject.rb

@@ -0,0 +1,143 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'rubygems'
+
+require 'checkm'
+require 'fakeweb'
+require 'mocha'
+require 'mrt/ingest'
+require 'shoulda'
+require 'open-uri'
+
+class TestIObject < Test::Unit::TestCase
+  def parse_object_manifest(iobject)
+    req = iobject.mk_request("profile", "submitter")
+    args = req.mk_args
+    return Checkm::Manifest.new(args['file'].read())
+  end
+
+  def write_to_tempfile(content)
+    tempfile = Tempfile.new('test_iobject')
+    tempfile << content
+    tempfile.open
+    return tempfile
+  end
+
+  def get_uri_for_name(iobject, name)
+    manifest = parse_object_manifest(iobject)
+    return manifest.entries.find { |entry|
+      entry.values[-2] == name
+    }
+  end
+
+  def parse_erc(erc)
+    return Hash[erc.map { |l| l.chomp.split(/:\s+/) }]
+  end
+
+  def parse_erc_entry(erc_entry)
+    return parse_erc(open(erc_entry.values[0]).read())
+  end
+
+  def check_erc_content(iobject, asserted_erc)
+    erc_entry = get_uri_for_name(iobject, "mrt-erc.txt")
+    if erc_entry.nil?
+      assert(false, "Could not find mrt-erc.txt file!")
+    else
+      iobject.start_server()
+      assert_equal(asserted_erc, parse_erc_entry(erc_entry))
+      iobject.stop_server()
+    end
+  end
+
+  context "an iobject" do
+    setup do
+      @iobject = Mrt::Ingest::IObject.new
+    end
+    
+    should "be able to add a URI component" do
+      @iobject.add_component(URI.parse("http://example.org/file"))
+    end
+
+    should "not be able to add a non-URI component" do
+      assert_raise(Mrt::Ingest::IngestException) do
+        @iobject.add_component("http://example.org/file")
+      end
+    end
+    
+    should "be able to make a request" do
+      req = @iobject.mk_request("profile", "submitter")
+      assert_equal("profile", req.profile)
+      assert_equal("submitter", req.submitter)
+    end
+  end
+  
+  context "the created request" do
+    setup do
+      @iobject = Mrt::Ingest::IObject.new
+      @manifest = parse_object_manifest(@iobject)
+      @erc_entry = get_uri_for_name(@iobject, "mrt-erc.txt")
+    end
+    
+    should "generate a valid manifest file with more than one line" do
+      assert(@manifest.entries.length > 0, "Empty manifest?")
+    end
+    
+    should "have a mrt-erc.txt entry, and it should be fetchable" do
+      if @erc_entry.nil?
+        assert(false, "Could not find mrt-erc.txt file!")
+      else
+        @iobject.start_server()
+        erc_lines = open(@erc_entry.values[0]).read().lines().to_a
+        @iobject.stop_server()
+      end
+    end
+  end
+
+  ERC_CONTENT = <<EOS
+who: John Doe
+what: Something
+when: now
+EOS
+
+  context "an iobject" do
+    should "be able to specify a file for ERC" do
+      erc_tempfile = write_to_tempfile(ERC_CONTENT)
+      iobject = Mrt::Ingest::IObject.new(:erc=>File.new(erc_tempfile.path))
+      check_erc_content(iobject, parse_erc(ERC_CONTENT))
+    end
+    
+    should "be able to use a hash for ERC" do
+      erc = { 
+        "who" => "John Doe",
+        "what" => "Something",
+        "when" => "now" }
+      iobject = Mrt::Ingest::IObject.new(:erc=>erc)
+      check_erc_content(iobject, erc)
+    end
+  end
+  
+  FILE_CONTENT = <<EOS
+Hello, world!
+EOS
+
+  FILE_CONTENT_MD5 = "746308829575e17c3331bbcb00c0898b"
+
+  context "serving local files" do
+    should "be able to add a local file component" do
+      iobject = Mrt::Ingest::IObject.new
+      tempfile = write_to_tempfile(FILE_CONTENT)
+      iobject.add_component(tempfile, {:name => "helloworld" })
+      uri_entry = get_uri_for_name(iobject, "helloworld")
+      erc_entry = get_uri_for_name(iobject, "mrt-erc.txt")
+      manifest = parse_object_manifest(iobject)
+      if uri_entry.nil?
+        assert(false, "Could not find hosted file URI!")
+      else
+        iobject.start_server
+        assert_equal(FILE_CONTENT, open(uri_entry.values[0]).read())
+        iobject.stop_server()
+      end
+    end
+  end
+end

data/test/test_request.rb

@@ -0,0 +1,36 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'rubygems'
+
+require 'fakeweb'
+require 'mocha'
+require 'mrt/ingest'
+require 'shoulda'
+
+class TestRequest < Test::Unit::TestCase
+  context "when creating a request" do
+    setup do
+    end
+    
+    should "not supplying a required parameter should raise an exception" do
+      assert_raise(Mrt::Ingest::RequestException) do
+        Mrt::Ingest::Request.
+          new(:submitter => "jd/John Doe",
+              :type      => "file")
+      end
+
+      assert_raise(Mrt::Ingest::RequestException) do
+        Mrt::Ingest::Request.
+          new(:profile => "demo_merritt",
+              :type    => "file")
+      end
+
+      assert_raise(Mrt::Ingest::RequestException) do
+        Mrt::Ingest::Request.
+          new(:profile   => "demo_merritt",
+              :submitter => "jd/John Doe")
+      end
+    end
+  end
+end

data/test/test_response.rb

@@ -0,0 +1,62 @@
+# Author::    Erik Hetzner  (mailto:erik.hetzner@ucop.edu)
+# Copyright:: Copyright (c) 2011, Regents of the University of California
+
+require 'rubygems'
+
+require 'fakeweb'
+require 'mocha'
+require 'mrt/ingest'
+require 'shoulda'
+
+class TestResponse < Test::Unit::TestCase
+  RESPONSE_JSON = <<EOS
+{
+
+    "batchState": {
+        "batchID":"bid-8c0fa0c2-f3d7-4deb-bd49-f953f6752b59",
+        "updateFlag":false,
+        "targetQueue":"example.org:2181",
+        "batchStatus":"QUEUED",
+        "userAgent":"egh/Erik Hetzner",
+        "submissionDate":"2011-08-31T15:40:26-07:00",
+        "targetQueueNode":"/ingest.example.1",
+        "batchProfile": {
+            "owner":"ark:/99999/fk4tt4wsh",
+            "creationDate":"2010-01-19T13:28:14-08:00",
+            "targetStorage": {
+                "storageLink":"http://example.org:35121",
+                "nodeID":10
+            },
+            "objectType":"MRT-curatorial",
+            "modificationDate":"2010-01-26T23:28:14-08:00",
+            "aggregateType":"",
+            "objectMinterURL":"https://example.org/ezid/shoulder/ark:/99999/fk4",
+            "collection": {
+            },
+            "profileID":"merritt_content",
+            "profileDescription":"Merritt demo content",
+            "fixityURL":"http://example.org:33143",
+            "contactsEmail": {
+                "notification": {
+                    "contactEmail":"erik.hetzner@example.org"
+                }
+            },
+            "identifierScheme":"ARK",
+            "identifierNamespace":"99999",
+            "objectRole":"MRT-content"
+        }
+    }
+}
+EOS
+
+  context "when creating a response" do
+    setup do
+      @response = Mrt::Ingest::Response.new(RESPONSE_JSON)
+    end
+    
+    should "have the right properties" do
+      assert_equal("bid-8c0fa0c2-f3d7-4deb-bd49-f953f6752b59", @response.batch_id)
+      assert_equal(Time.at(1314830426), @response.submission_date)
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: mrt-ingest
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Erik Hetzner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id002
+description: A client for the Merritt ingest system. More details available from http://wiki.ucop.edu/display/curation.
+email: 
+- erik.hetzner@ucop.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .hgignore
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- lib/mrt/ingest.rb
+- lib/mrt/ingest/client.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.gemspec
+- test/test_client.rb
+- test/test_iobject.rb
+- test/test_request.rb
+- test/test_response.rb
+homepage: http://bitbucket.org/merritt/mrt-ingest-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mrt-ingest
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: A client for Merritt ingest.
+test_files: []
+