resync-client 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 541947c7770153caf12143dc26d885166877c4bd
-  data.tar.gz: 5b7aa7977c089a5d09c7997d92088a695cece901
+  metadata.gz: 53bce63e13094ab4ffeec5ff5b3d4365c96eaf9f
+  data.tar.gz: 72becf942fb027a0d02d948e3a98fb28d8a626fc
 SHA512:
-  metadata.gz: 2d4c7fa6f2ea310e34ff78c2fe956c99e1967ec4c4bba23d88a42cf5e0cc11ff5e4d84e8f88d2b79cf3f446132dbf97ab8e20ae903d90d58fa6306361c2e7c45
-  data.tar.gz: b23323bc0c7ca29050e4379d8596fb7d4b51f16f9f14fee80e62be12f0b4d2fd0fd34b541825d77b8d8f825b883cdf94bc569e007b02d8c8994dc9d341b5d34f
+  metadata.gz: 97e28c200dbd29c6896c9c4d3e351f89ba0f3836f8cdf0ccc5e87517cb97fefe869e313311f87f635007a06e3373b9c499668b277d089b5b68c227fe4126559d
+  data.tar.gz: c5b24e9fbb0db69734b5e805077b9da163b86ac84a1c4bf296868979812a49e1efa8b863ca1a7a6a386b148ed8c82f0a68c584f51281437851ff8e4a9af11bf8

data/.gitignore

@@ -36,6 +36,8 @@ spec/dummy/.sass-cache
 # Emacs
 
 *~
+.#*
+\#*
 
 # Mac OS
 

data/CHANGES.md

@@ -1,3 +1,13 @@
+# 0.2.1
+
+- Update to depend on [resync](https://github.com/dmolesUC3/resync) 0.1.3
+- Add more tests for client delegation
+
+# 0.2.0
+
+- Use named mixins instead of instance monkey-patching for easier documentation and navigation.
+- Update to depend on [resync](https://github.com/dmolesUC3/resync) 0.1.2
+
 # 0.1.2
 
 - Change the `:zip_packages` extension method on `ResourceDump` and `ChangeDump` to return a lazy enumerable instead of preemptively downloading all packages. 

data/lib/resync/client.rb

@@ -1,3 +1,66 @@
 require 'resync'
+require_relative 'extensions'
 
 Dir.glob(File.expand_path('../client/*.rb', __FILE__), &method(:require))
+
+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_delegate = 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
+
+    # Allows a {Client} to act as a {Mixins::ClientDelegator} delegate.
+    # @return [Client] this client
+    def client
+      self
+    end
+
+  end
+end

data/lib/resync/client/http_helper.rb

@@ -4,108 +4,108 @@ require 'uri'
 require 'mime-types'
 
 module Resync
+  class Client
+    # Utility class simplifying GET requests for HTTP/HTTPS resources.
+    class HTTPHelper
+
+      # ------------------------------------------------------------
+      # Constants
+
+      # The default number of redirects to follow before erroring out.
+      DEFAULT_MAX_REDIRECTS = 5
+
+      # ------------------------------------------------------------
+      # Accessors
+
+      # @!attribute [rw] user_agent
+      #   @return [String] the User-Agent string to send when making requests
+      attr_accessor :user_agent
+
+      # @!attribute [rw] redirect_limit
+      #   @return [Integer] the number of redirects to follow before erroring out
+      attr_accessor :redirect_limit
+
+      # ------------------------------------------------------------
+      # Initializer
+
+      # Creates a new +HTTPHelper+
+      #
+      # @param user_agent [String] the User-Agent string to send when making requests
+      # @param redirect_limit [Integer] the number of redirects to follow before erroring out
+      #   (defaults to {DEFAULT_MAX_REDIRECTS})
+      def initialize(user_agent:, redirect_limit: DEFAULT_MAX_REDIRECTS)
+        @user_agent = user_agent
+        @redirect_limit = redirect_limit
+      end
 
-  # Utility class simplifying GET requests for HTTP/HTTPS resources.
-  #
-  class HTTPHelper
-
-    # ------------------------------------------------------------
-    # Constants
-
-    # The default number of redirects to follow before erroring out.
-    DEFAULT_MAX_REDIRECTS = 5
-
-    # ------------------------------------------------------------
-    # Accessors
-
-    # @!attribute [rw] user_agent
-    #   @return [String] the User-Agent string to send when making requests
-    attr_accessor :user_agent
-
-    # @!attribute [rw] redirect_limit
-    #   @return [Integer] the number of redirects to follow before erroring out
-    attr_accessor :redirect_limit
-
-    # ------------------------------------------------------------
-    # Initializer
-
-    # Creates a new +HTTPHelper+
-    #
-    # @param user_agent [String] the User-Agent string to send when making requests
-    # @param redirect_limit [Integer] the number of redirects to follow before erroring out
-    #   (defaults to {DEFAULT_MAX_REDIRECTS})
-    def initialize(user_agent:, redirect_limit: DEFAULT_MAX_REDIRECTS)
-      @user_agent = user_agent
-      @redirect_limit = redirect_limit
-    end
-
-    # ------------------------------------------------------------
-    # Public methods
-
-    # Gets the content of the specified URI as a string.
-    # @param uri [URI] the URI to download
-    # @param limit [Integer] the number of redirects to follow (defaults to {#redirect_limit})
-    # @return [String] the content of the URI
-    def fetch(uri:, limit: redirect_limit)
-      make_request(uri, limit) do |success|
-        # not 100% clear why we need an explicit return here; it
-        # doesn't show up in unit tests but it does in example.rb
-        return success.body
+      # ------------------------------------------------------------
+      # Public methods
+
+      # Gets the content of the specified URI as a string.
+      # @param uri [URI] the URI to download
+      # @param limit [Integer] the number of redirects to follow (defaults to {#redirect_limit})
+      # @return [String] the content of the URI
+      def fetch(uri:, limit: redirect_limit)
+        make_request(uri, limit) do |success|
+          # not 100% clear why we need an explicit return here; it
+          # doesn't show up in unit tests but it does in example.rb
+          return success.body
+        end
       end
-    end
 
-    # Gets the content of the specified URI and saves it to a file. If no
-    # file path is provided, saves it to a temporary file.
-    # @param uri [URI] the URI to download
-    # @param path [String] the path to save the download to (optional)
-    # @return [String] the path to the downloaded file
-    def fetch_to_file(uri:, path: nil, limit: redirect_limit)
-      make_request(uri, limit) do |success|
-        file = path ? File.new(path, 'w+') : Tempfile.new(['resync-client', ".#{extension_for(success)}"])
-        open file, 'w' do |out|
-          success.read_body { |chunk| out.write(chunk) }
+      # Gets the content of the specified URI and saves it to a file. If no
+      # file path is provided, saves it to a temporary file.
+      # @param uri [URI] the URI to download
+      # @param path [String] the path to save the download to (optional)
+      # @return [String] the path to the downloaded file
+      def fetch_to_file(uri:, path: nil, limit: redirect_limit)
+        make_request(uri, limit) do |success|
+          file = path ? File.new(path, 'w+') : Tempfile.new(['resync-client', ".#{extension_for(success)}"])
+          open file, 'w' do |out|
+            success.read_body { |chunk| out.write(chunk) }
+          end
+          return file.path
         end
-        return file.path
       end
-    end
 
-    # ------------------------------------------------------------
-    # Private methods
-
-    private
-
-    def make_request(uri, limit, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      fail "Redirect limit (#{redirect_limit}) exceeded retrieving URI #{uri}" if limit <= 0
-      req = Net::HTTP::Get.new(uri, 'User-Agent' => user_agent)
-      Net::HTTP.start(uri.hostname, uri.port, use_ssl: (uri.scheme == 'https')) do |http|
-        http.request(req) do |response|
-          case response
-          when Net::HTTPSuccess
-            block.call(response)
-          when Net::HTTPInformation, Net::HTTPRedirection
-            make_request(redirect_uri_for(response, uri), limit - 1, &block)
-          else
-            fail "Error #{response.code}: #{response.message} retrieving URI #{uri}"
+      # ------------------------------------------------------------
+      # Private methods
+
+      private
+
+      def make_request(uri, limit, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        fail "Redirect limit (#{redirect_limit}) exceeded retrieving URI #{uri}" if limit <= 0
+        req = Net::HTTP::Get.new(uri, 'User-Agent' => user_agent)
+        Net::HTTP.start(uri.hostname, uri.port, use_ssl: (uri.scheme == 'https')) do |http|
+          http.request(req) do |response|
+            case response
+            when Net::HTTPSuccess
+              block.call(response)
+            when Net::HTTPInformation, Net::HTTPRedirection
+              make_request(redirect_uri_for(response, uri), limit - 1, &block)
+            else
+              fail "Error #{response.code}: #{response.message} retrieving URI #{uri}"
+            end
           end
         end
       end
-    end
 
-    def extension_for(response)
-      content_type = response['Content-Type']
-      mime_type = MIME::Types[content_type].first || MIME::Types['application/octet-stream'].first
-      mime_type.preferred_extension || 'bin'
-    end
+      def extension_for(response)
+        content_type = response['Content-Type']
+        mime_type = MIME::Types[content_type].first || MIME::Types['application/octet-stream'].first
+        mime_type.preferred_extension || 'bin'
+      end
 
-    def redirect_uri_for(response, original_uri)
-      if response.is_a?(Net::HTTPInformation)
-        original_uri
-      else
-        location = response['location']
-        new_uri = URI(location)
-        new_uri.relative? ? original_uri + location : new_uri
+      def redirect_uri_for(response, original_uri)
+        if response.is_a?(Net::HTTPInformation)
+          original_uri
+        else
+          location = response['location']
+          new_uri = URI(location)
+          new_uri.relative? ? original_uri + location : new_uri
+        end
       end
-    end
 
+    end
   end
 end

data/lib/resync/client/mixins.rb

@@ -0,0 +1 @@
+Dir.glob(File.expand_path('../mixins/*.rb', __FILE__), &method(:require))

data/lib/resync/client/mixins/bitstream_resource.rb

@@ -0,0 +1,26 @@
+require_relative '../zip'
+
+# A resource that refers to a bitsream within a zipped bitstream package.
+#
+# @!attribute [rw] zip_package_delegate
+#   @return [ZipPackage] the provider of the containing package,
+#     e.g. its manifest
+module Resync
+  class Client
+    module Mixins
+      module BitstreamResource
+        attr_accessor :zip_package_delegate
+
+        # @return [ZipPackage] the package containing the bitstream for this resource
+        def containing_package
+          @zip_package_delegate.zip_package
+        end
+
+        # @return [Bitstream] the bitstream for this resource
+        def bitstream
+          containing_package.bitstream_for(self)
+        end
+      end
+    end
+  end
+end

data/lib/resync/client/mixins/bitstream_resource_list.rb

@@ -0,0 +1,29 @@
+require_relative '../zip'
+require_relative 'bitstream_resource'
+
+# A list of resources within a single zipped bitstream package, e.g. as provided
+# by the package manifest.
+#
+# @!attribute [rw] zip_package
+#   @return [ZipPackage] the package.
+module Resync
+  class Client
+    module Mixins
+      module BitstreamResourceList
+        attr_accessor :zip_package
+
+        # Makes each provided resource a {BitstreamResource}
+        # @param value [Array<Resource>] the resources for this list
+        def resources=(value)
+          super
+          resources.each do |r|
+            class << r
+              prepend BitstreamResource
+            end
+            r.zip_package_delegate = self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/resync/client/mixins/client_delegator.rb

@@ -0,0 +1,38 @@
+require_relative '../../client'
+
+# An object that delegates to another to provide a {Client} for downloading
+# resources and links.
+#
+# @!attribute [rw] client_delegate
+#   @return [#client] The client provider.
+module Resync
+  class Client
+    module Mixins
+      module ClientDelegator
+        attr_accessor :client_delegate
+
+        def client
+          client_delegate.client
+        end
+
+        # Creates a one-off delegate wrapper around the specified {Client}
+        # @param value [Client] the client
+        def client=(value)
+          @client_delegate = ClientDelegate.new(value)
+        end
+
+        # Minimal 'delegate' wrapper around a specified {Client}
+        class ClientDelegate
+          # @return [#client] the client
+          attr_reader :client
+
+          # Creates a new {ClientDelegate} wrapping the specified {Client}
+          # @param client The client to delegate to
+          def initialize(client)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/resync/client/mixins/downloadable.rb

@@ -0,0 +1,36 @@
+require_relative 'client_delegator'
+
+# A downloadable resource or link.
+module Resync
+  class Client
+    module Mixins
+      module Downloadable
+        prepend ClientDelegator
+
+        # 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
+  end
+end

data/lib/resync/client/mixins/link_client_delegate.rb

@@ -0,0 +1,19 @@
+require_relative 'client_delegator'
+
+# A link container that is capable of providing those resources with a {Client}
+module Resync
+  class Client
+    module Mixins
+      module LinkClientDelegate
+        prepend ClientDelegator
+
+        # Sets this object as the client provider delegate for each link.
+        # @param value [Array<Link>] the links for this list
+        def links=(value)
+          super
+          links.each { |l| l.client_delegate = self }
+        end
+      end
+    end
+  end
+end