resync-client 0.1.2 → 0.2.1

data/lib/resync/client/client.rb

@@ -1,58 +0,0 @@
-require_relative 'version'
-require_relative 'http_helper'
-
-module Resync
-
-  # Utility class for retrieving HTTP content and parsing it as ResourceSync documents.
-  class Client
-
-    # ------------------------------------------------------------
-    # Initializer
-
-    # Creates a new +Client+
-    # @param helper [HTTPHelper] the HTTP helper. Defaults to a new HTTP helper with
-    #   +resync-client VERSION+ as the User-Agent string.
-    def initialize(helper: HTTPHelper.new(user_agent: "resync-client #{VERSION}"))
-      @helper = helper
-    end
-
-    # ------------------------------------------------------------
-    # Public methods
-
-    # Gets the content of the specified URI and parses it as a ResourceSync document.
-    def get_and_parse(uri)
-      uri = Resync::XML.to_uri(uri)
-      raw_contents = get(uri)
-      doc = XMLParser.parse(raw_contents)
-      doc.client = self
-      doc
-    end
-
-    # Gets the content of the specified URI as a string.
-    # @param uri [URI, String] the URI to download
-    # @return [String] the content of the URI
-    def get(uri)
-      uri = Resync::XML.to_uri(uri)
-      @helper.fetch(uri: uri)
-    end
-
-    # Gets the content of the specified URI and saves it to a temporary file.
-    # @param uri [URI, String] the URI to download
-    # @return [String] the path to the downloaded file
-    def download_to_temp_file(uri)
-      uri = Resync::XML.to_uri(uri)
-      @helper.fetch_to_file(uri: uri)
-    end
-
-    # Gets the content of the specified URI and saves it to the specified file,
-    # overwriting it if it exists.
-    # @param uri [URI, String] the URI to download
-    # @param path [String] the path to save the download to
-    # @return [String] the path to the downloaded file
-    def download_to_file(uri:, path:)
-      uri = Resync::XML.to_uri(uri)
-      @helper.fetch_to_file(path: path, uri: uri)
-    end
-
-  end
-end

data/lib/resync/client/downloadable.rb

@@ -1,35 +0,0 @@
-require 'resync'
-
-module Resync
-
-  # Adds +get+, +get_raw+, and +get_file+ methods, delegating
-  # to the injected client.
-  #
-  # @see Augmented#client
-  module Downloadable
-    # Delegates to {Client#get_and_parse} to get the contents of
-    # +:uri+ as a ResourceSync document
-    def get_and_parse # rubocop:disable Style/AccessorMethodName
-      client.get_and_parse(uri)
-    end
-
-    # Delegates to {Client#get} to get the contents of this +:uri+
-    def get # rubocop:disable Style/AccessorMethodName
-      client.get(uri)
-    end
-
-    # Delegates to {Client#download_to_temp_file} to download the
-    # contents of +:uri+ to a file.
-    def download_to_temp_file # rubocop:disable Style/AccessorMethodName
-      client.download_to_temp_file(uri)
-    end
-
-    # Delegates to {Client#download_to_file} to download the
-    # contents of +:uri+ to the specified path.
-    # @param path [String] the path to download to
-    def download_to_file(path)
-      client.download_to_file(uri: uri, path: path)
-    end
-  end
-
-end

data/lib/resync/client/dump.rb

@@ -1,26 +0,0 @@
-require_relative 'zip_packages'
-
-module Resync
-  # Extends {ChangeDump} and {ResourceDump} to provide
-  # transparent access to the linked bitstream packages
-  module Dump
-    # Injects a +:zip_package+ method into each resource,
-    # downloading the (presumed) bitstream package to a
-    # temp file and returning it as a {ZipPackage}
-    def resources=(value)
-      super
-      resources.each do |r|
-        def r.zip_package
-          @zip_package ||= ZipPackage.new(download_to_temp_file)
-        end
-      end
-    end
-
-    # A list (downloaded lazily) of the {ZipPackage}s for each resource
-    # @return [ZipPackages] the zip packages for each resource
-    def zip_packages
-      @zip_packages ||= ZipPackages.new(resources)
-    end
-  end
-
-end

data/lib/resync/client/resync_extensions.rb

@@ -1,85 +0,0 @@
-require 'resync'
-require_relative 'downloadable'
-require_relative 'dump'
-
-# Extensions to the core Resync classes to simplify retrieval
-module Resync
-
-  # ------------------------------------------------------------
-  # Base classes
-
-  # Injects a {Client} that subclasses can use to fetch
-  # resources and links
-  #
-  # @!attribute [rw] client
-  #   @return [Client] the injected {Client}. Defaults to
-  #     a new {Client} instance.
-  class Augmented
-    attr_writer :client
-
-    def client
-      @client ||= Client.new
-    end
-
-    alias_method :base_links=, :links=
-    private :base_links=
-
-    # Adds a +:client+ method to each link, delegating
-    # to {#client}
-    def links=(value)
-      self.base_links = value
-      self.base_links = value
-      parent = self
-      links.each do |l|
-        l.define_singleton_method(:client) do
-          parent.client
-        end
-      end
-    end
-  end
-
-  # Adds a +:client+ method to each resource, delegating
-  # to {Augmented#client}
-  class BaseResourceList
-    alias_method :base_resources=, :resources=
-    private :base_resources=
-
-    # Adds a +:client+ method to each resource, delegating
-    # to {Augmented#client}
-    def resources=(value)
-      self.base_resources = value
-      parent = self
-      resources.each do |r|
-        r.define_singleton_method(:client) do
-          parent.client
-        end
-      end
-    end
-  end
-
-  # ------------------------------------------------------------
-  # Resource and Link
-
-  # Includes the {Downloadable} module
-  class Resource
-    include Downloadable
-  end
-
-  # Includes the {Link} module
-  class Link
-    include Downloadable
-  end
-
-  # ------------------------------------------------------------
-  # ResourceDump and ChaneDump
-
-  # Includes the {Dump} module
-  class ResourceDump
-    include Dump
-  end
-
-  # Includes the {Dump} module
-  class ChangeDump
-    include Dump
-  end
-end

data/lib/resync/client/zip_package.rb

@@ -1,66 +0,0 @@
-require 'rexml/document'
-require 'zip'
-require_relative 'bitstream'
-
-module Resync
-  # A ZIP package of resources or changes, providing access to individual
-  # bitstreams based on the included manifest file.
-  #
-  class ZipPackage
-
-    # ------------------------------------------------------------
-    # Attributes
-
-    # @return [Zip::File] the ZIP file wrapped by this package
-    attr_reader :zipfile
-
-    # @return [ResourceDumpManifest, ChangeDumpManifest] the manifest
-    #   for the ZIP package
-    attr_reader :manifest
-
-    # ------------------------------------------------------------
-    # Initializer
-
-    # Creates a new +ZipPackage+ for the specified file.
-    #
-    # @param zipfile [Zip::File, String] the ZIP file, or a path to it.
-    def initialize(zipfile)
-      self.zipfile = zipfile
-    end
-
-    # ------------------------------------------------------------
-    # Public methods
-
-    # Gets the bitstream for the specified resource. (Note that this
-    # does no validation; if the resource is not in the manifest, or
-    # the corresponding entry is not in the ZIP file, the behavior of
-    # the returned {Bitstream} is undefined.)
-    #
-    # @return [Bitstream] a bitstream wrapping the ZIP entry for the
-    #   specified resource.
-    def bitstream_for(resource)
-      Bitstream.new(zipfile: @zipfile, resource: resource)
-    end
-
-    # Gets all bitstreams declared in the package manifest.
-    # @return [Array<Bitstream>] a list of all bitstreams in the package
-    def bitstreams
-      manifest.resources.map { |r| bitstream_for(r) }
-    end
-
-    # ------------------------------------------------------------
-    # Private methods
-
-    private
-
-    def zipfile=(value)
-      zipfile = value.is_a?(Zip::File) ? value : Zip::File.open(value)
-      manifest_entry = zipfile.find_entry('manifest.xml')
-      fail "No manifest.xml found in zipfile #{zipfile.name}" unless manifest_entry
-      manifest_stream = manifest_entry.get_input_stream
-      @manifest = XMLParser.parse(manifest_stream)
-      @zipfile = zipfile
-    end
-
-  end
-end

data/lib/resync/client/zip_packages.rb

@@ -1,51 +0,0 @@
-module Resync
-  # Lazily retrieves and caches the zip packages for the specified
-  # list of resources. The packages are cached to temporary files
-  # which are deleted on exit; if they are deleted while the
-  # interpreter is running, the behavior is undefined (but bad things
-  # are likely to happen).
-  class ZipPackages
-    include Enumerable
-
-    # Creates a new {ZipPackages} wrapper for the specified list
-    # of resources.
-    # @param resources [Array<Resource>] The list of resources to
-    #   get zip packages for.
-    def initialize(resources)
-      @resources = resources
-      @packages = {}
-    end
-
-    # Gets the size of this list of packages.
-    # @return the size of the underlying array.
-    def size
-      @resources.size
-    end
-
-    # Gets the zip package at the specified index, downloading it
-    # if necessary.
-    #
-    # @return [ZipPackage] the zip package for the resource at the
-    #   specified index in the underlying array.
-    def [](key)
-      resource = @resources[key]
-      package_for(resource)
-    end
-
-    # Gets the zip package for the specified resource, downloading it
-    # if necessary.
-    # @return [ZipPackage] the package for the resource
-    def package_for(resource)
-      @packages[resource] ||= resource.zip_package
-    end
-
-    # Lazily iterates the given block for each zip package, downloading
-    # as necessary.
-    # @param &block [Block] The block to iterate
-    def each
-      @resources.lazy.each do |resource|
-        yield package_for(resource)
-      end
-    end
-  end
-end

data/spec/unit/resync/client/dump_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-module Resync
-  describe Dump do
-    it 'transparently extracts bitstreams' do
-      package_uri = URI('http://example.com/resourcedump.zip')
-      client = instance_double(Client)
-      expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
-
-      resource_dump = XMLParser.parse(File.read('spec/data/resourcedump/resourcedump.xml'))
-      resource_dump.client = client
-
-      zip_packages = resource_dump.zip_packages
-      expect(zip_packages.size).to eq(1)
-
-      zip_package = zip_packages[0]
-      expect(zip_package).to be_a(ZipPackage)
-
-      bitstreams = zip_package.bitstreams
-      expect(bitstreams.size).to eq(2)
-
-      stream1 = bitstreams[0]
-      expect(stream1.content).to eq(File.read('spec/data/resourcedump/resources/res1'))
-    end
-  end
-end