resync-client 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c72554545a2d19f93f85eb0b021de5516041024f
-  data.tar.gz: a285cc547f7c90a4bc6d1ca5ef27ae8e75b2c9fb
+  metadata.gz: bd8d1fac9a7feece07634eca0cb2b9b4e9d2ce93
+  data.tar.gz: 27e94c732902e0f9b42be6ce9ec9df74f16d641a
 SHA512:
-  metadata.gz: 8e4600dffb2cbe106fb2454c402e84085743ccbaed5d3195564bdc79ddb96d26b1c746876aedabbc599ac1d262e6a7f16b37c4bc412b782854f65679fd15bbf4
-  data.tar.gz: ff4b5427c5a8fdbb88d9a56688cb908ccf3bdaae73e0aba580c202a8b30ba7f07e74dd37765e0985499802bc7c57f686672f96dfd07eaf7a499c6ccc08e2c6f9
+  metadata.gz: 188aab78224fc2e642aa7759a3c9c5a4a97d156c332ef66df771d6a305758126b64352ff9651d6c68ccff3bb3da226d1f47d7f83b22ff0abc5576ed1bc13d0f9
+  data.tar.gz: 4eebbc3ba5cb6ecb5115eec09015d22fca5155a4da3fb79e6b4c99ac99c935fbda05cc93d4b444483f4a0273483306560df4d0e2bf5859a879106049e4c10b89

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.3.2
+
+- Added utility methods to `CapabilityList` to simplify downloading and parsing ResourceSync documents by capability
+- Make `ChangeList#all_changes`, and `#all_resources` on both `ResourceList` and `ChangeList`, return `Enumerator::Lazy` to improve interoperation with the corresponding methods on `ResourceIndex/ChangeIndex`
+
 # 0.3.1
 
 - Make `#get` and `#get_and_parse` in `Downloadable` (i.e., `Resource` and `Link`) cache the downloaded content

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

@@ -0,0 +1,55 @@
+require 'resync'
+
+module Resync
+  class CapabilityList
+
+    # Downloads and parses the document for the specified capability.
+    # Subsequent calls will return the same parsed object.
+    # @return [ResourceList, ResourceListIndex, ChangeList, ChangeListIndex, ResourceDump, ResourceDumpIndex, ChangeDump, ChangeDumpIndex, nil]
+    #   the document, or +nil+ if this capability list does not provide that capability
+    def document_for(capability)
+      @documents ||= {}
+      @documents[capability] ||= get_and_parse_resource_for(capability)
+    end
+
+    # Downloads and parses the resource list or resource list index.
+    # Subsequent calls will return the same parsed object.
+    # @return [ResourceList, ResourceListIndex, nil] the resource list, or +nil+ if this capability list does not
+    #   provide one
+    def resource_list
+      document_for(ResourceList::CAPABILITY)
+    end
+
+    # Downloads and parses the change list or change list index.
+    # Subsequent calls will return the same parsed object.
+    # @return [ChangeList, ChangeListIndex, nil] the change list, or +nil+ if this capability list does not
+    #   provide one
+    def change_list
+      document_for(ChangeList::CAPABILITY)
+    end
+
+    # Downloads and parses the resource dump or resource dump index.
+    # Subsequent calls will return the same parsed object.
+    # @return [ResourceDump, ResourceDumpIndex, nil] the resource dump, or +nil+ if this capability dump does not
+    #   provide one
+    def resource_dump
+      document_for(ResourceDump::CAPABILITY)
+    end
+
+    # Downloads and parses the change dump or change dump index.
+    # Subsequent calls will return the same parsed object.
+    # @return [ChangeDump, ChangeDumpIndex, nil] the change dump, or +nil+ if this capability dump does not
+    #   provide one
+    def change_dump
+      document_for(ChangeDump::CAPABILITY)
+    end
+
+    private
+
+    def get_and_parse_resource_for(capability)
+      resource = resource_for(capability: capability)
+      resource.get_and_parse if resource
+    end
+
+  end
+end

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

@@ -22,7 +22,7 @@ module Resync
         def all_changes(of_type: nil, in_range: nil)
           @change_lists ||= {}
           lists = in_range ? change_lists(in_range: in_range, strict: false) : resources
-          lists.flat_map do |cl|
+          lists.lazy.flat_map do |cl|
             @change_lists[cl] ||= cl.get_and_parse
             @change_lists[cl].changes(of_type: of_type, in_range: in_range)
           end
@@ -36,8 +36,13 @@ module Resync
   end
 
   class ChangeList
-    # Aliases +:changes+ as +:all_changes+ for transparent
-    # interoperability with +ChangeListIndex+
-    alias_method :all_changes, :changes
+    # Delegates to {ChangeList#changes} for interoperation with {ChangeList#all_changes}.
+    # @param of_type [Types::Change] the change type
+    # @param in_range [Range<Time>] the range of modification times
+    # @return [Enumerator::Lazy<Resource>] a lazy enumeration of the matching changes, or all
+    #   changes if neither +of_type+ nor +in_range+ is specified.
+    def all_changes(of_type: nil, in_range: nil)
+      changes(of_type: of_type, in_range: in_range).lazy
+    end
   end
 end

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

@@ -27,19 +27,7 @@ module Resync
     prepend Client::Mixins::ListIndex
   end
 
-  class ChangeList
-    # Aliases +:resources+ as +:all_resources+ for transparent
-    # interoperability with +ChangeListIndex+
-    alias_method :all_resources, :resources
-  end
-
   class ResourceListIndex
     prepend Client::Mixins::ListIndex
   end
-
-  class ResourceList
-    # Aliases +:resources+ as +:all_resources+ for transparent
-    # interoperability with +ResourceListIndex+
-    alias_method :all_resources, :resources
-  end
 end

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

@@ -0,0 +1,25 @@
+require 'resync'
+require_relative 'resource_client_delegate'
+
+module Resync
+  class Client
+    module Mixins
+      # A resource container whose resources are not, themselves, resource containers
+      module PlainList
+        # Delegates to {BaseResourceList#resources} for interoperation with {ListIndex#all_resources}.
+        # @return [Enumerator::Lazy<Resync::Resource>] a lazy enumeration of the resources in this document
+        def all_resources
+          resources.lazy
+        end
+      end
+    end
+  end
+
+  class ChangeList
+    prepend Client::Mixins::PlainList
+  end
+
+  class ResourceList
+    prepend Client::Mixins::PlainList
+  end
+end

data/lib/resync/client/version.rb

@@ -1,6 +1,6 @@
 module Resync
   class Client
     # The version of this gem.
-    VERSION = '0.3.1'
+    VERSION = '0.3.2'
   end
 end

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

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+module Resync
+  describe CapabilityList do
+    doc_types = [ResourceList, ResourceDump, ChangeList, ChangeDump]
+
+    before(:each) do
+      @client = instance_double(Resync::Client)
+      allow(@client).to receive(:client) { @client }
+      @cap_list = XMLParser.parse(File.read('spec/data/examples/capability-list.xml'))
+      @cap_list.client_delegate = @client
+    end
+
+    describe '#document_for' do
+      it 'downloads and parses documents by capability' do
+        doc_types.each do |doc_type|
+          capability = doc_type::CAPABILITY
+          class_name = doc_type.name.split('::').last
+          uri = URI("http://example.com/dataset1/#{class_name.downcase}.xml")
+          doc = instance_double(doc_type)
+          expect(@client).to receive(:get_and_parse).once.with(uri) { doc }
+          expect(@cap_list.document_for(capability)).to be(doc)
+          expect(@cap_list.document_for(capability)).to be(@cap_list.document_for(capability))
+        end
+      end
+
+      it 'caches downloaded resources' do
+        doc_types.each do |doc_type|
+          capability = doc_type::CAPABILITY
+          class_name = doc_type.name.split('::').last
+          uri = URI("http://example.com/dataset1/#{class_name.downcase}.xml")
+          doc = instance_double(doc_type)
+          expect(@client).to receive(:get_and_parse).once.with(uri) { doc }
+          expect(@cap_list.document_for(capability)).to be(@cap_list.document_for(capability))
+        end
+      end
+    end
+
+    doc_types.each do |doc_type|
+      class_name = doc_type.name.split('::').last
+      method_name = class_name.gsub(/(.)([A-Z])/, '\1_\2').downcase
+
+      describe "##{method_name}" do
+        it "downloads and parses the #{class_name}" do
+          uri = URI("http://example.com/dataset1/#{class_name.downcase}.xml")
+          doc = instance_double(doc_type)
+          expect(@client).to receive(:get_and_parse).once.with(uri) { doc }
+          expect(@cap_list.send(method_name.to_sym)).to be(doc)
+        end
+
+        it "caches the downloaded/parsed #{class_name}" do
+          uri = URI("http://example.com/dataset1/#{class_name.downcase}.xml")
+          doc = instance_double(doc_type)
+          expect(@client).to receive(:get_and_parse).once.with(uri) { doc }
+          expect(@cap_list.send(method_name.to_sym)).to be(@cap_list.send(method_name.to_sym))
+        end
+      end
+    end
+
+  end
+end

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

@@ -36,6 +36,16 @@ module Resync
             end
           end
 
+          it 'is lazy' do
+            index_uri = URI('http://example.com/resource-list-index.xml')
+            index_data = File.read('spec/data/examples/resource-list-index.xml')
+            expect(@helper).to receive(:fetch).with(uri: index_uri).and_return(index_data)
+
+            index = @client.get_and_parse(index_uri)
+            all_resources = index.all_resources
+            expect(all_resources).to be_a(Enumerator::Lazy)
+          end
+
           it 'is lazy enough not to download anything till it \'s iterated ' do
             index_uri = URI('http://example.com/resource-list-index.xml')
             index_data = File.read('spec/data/examples/resource-list-index.xml')

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

@@ -44,33 +44,37 @@ module Resync
 
     describe ResourceList do
       describe '#all_resources' do
-        it 'is an alias for #resources' do
+        it 'delegates to #resources, but lazily' do
           resources = Array.new(3) do
             resource = instance_double(Resource)
             allow(resource).to receive(:client_delegate=)
             resource
           end
           list = ResourceList.new(resources: resources)
-          expect(list.all_resources).to be(list.resources)
+          all_resources = list.all_resources
+          expect(all_resources.to_a).to eq(list.resources)
+          expect(all_resources).to be_a(Enumerator::Lazy)
         end
       end
     end
 
     describe ChangeList do
-      describe '#all_changes' do
-        describe '#all_resources' do
-          it 'is an alias for #resources' do
-            resources = []
-            resources[0] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(1999, 1, 1))
-            resources[1] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2000, 1, 1))
-            resources[2] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2001, 3, 1))
-
-            all_resources = ResourceList.new(resources: resources).all_resources
-            expect(all_resources.to_a).to eq(resources)
-          end
+      describe '#all_resources' do
+        it 'delegates to #resources, but lazily' do
+          resources = []
+          resources[0] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(1999, 1, 1))
+          resources[1] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2000, 1, 1))
+          resources[2] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2001, 3, 1))
+
+          list = ChangeList.new(resources: resources)
+          all_resources = list.all_resources
+          expect(all_resources.to_a).to eq(list.resources)
+          expect(all_resources).to be_a(Enumerator::Lazy)
         end
+      end
 
-        it 'is a proxy for #changes' do
+      describe '#all_changes' do
+        it 'delegates to #changes, lazily' do
           resources = []
           resources[0] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(1999, 1, 1), metadata: Metadata.new(change: Types::Change::CREATED))
           resources[1] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2000, 1, 1), metadata: Metadata.new(change: Types::Change::CREATED))
@@ -82,6 +86,7 @@ module Resync
           resources[7] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2000, 9, 1), metadata: Metadata.new(change: Types::Change::DELETED))
           list = ChangeList.new(resources: resources)
           all_changes = list.all_changes(of_type: Types::Change::UPDATED, in_range: Time.utc(1999, 4, 1)..Time.utc(2000, 4, 1))
+          expect(all_changes).to be_a(Enumerator::Lazy)
           expect(all_changes.to_a).to eq([resources[3], resources[4]])
         end
       end
@@ -152,6 +157,22 @@ module Resync
           end
           expect(count).to eq(1)
         end
+
+        it 'is lazy when unfiltered' do
+          change_index_uri = URI('http://example.com/dataset1/changelist.xml')
+          change_index_data = File.read('spec/data/examples/change-list-index.xml')
+          expect(@helper).to receive(:fetch).with(uri: change_index_uri).and_return(change_index_data)
+
+          list2_uri = URI('http://example.com/20130102-changelist.xml')
+          expect(@helper).not_to receive(:fetch).with(uri: list2_uri)
+
+          list3_uri = URI('http://example.com/20130103-changelist.xml')
+          expect(@helper).not_to receive(:fetch).with(uri: list3_uri)
+
+          change_index = @client.get_and_parse(change_index_uri)
+          all_changes = change_index.all_changes
+          expect(all_changes).to be_a(Enumerator::Lazy)
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resync-client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lazy
@@ -197,6 +197,7 @@ files:
 - lib/resync/client/http_helper.rb
 - lib/resync/client/mixins.rb
 - lib/resync/client/mixins/bitstream_resource.rb
+- lib/resync/client/mixins/capability_list_extensions.rb
 - lib/resync/client/mixins/change_index.rb
 - lib/resync/client/mixins/client_delegator.rb
 - lib/resync/client/mixins/downloadable.rb
@@ -205,6 +206,7 @@ files:
 - lib/resync/client/mixins/dump_manifest.rb
 - lib/resync/client/mixins/link_client_delegate.rb
 - lib/resync/client/mixins/list_index.rb
+- lib/resync/client/mixins/plain_list.rb
 - lib/resync/client/mixins/resource_client_delegate.rb
 - lib/resync/client/mixins/zipped_resource.rb
 - lib/resync/client/version.rb
@@ -243,6 +245,7 @@ files:
 - spec/spec_helper.rb
 - spec/todo.rb
 - spec/unit/resync/client/bitstream_spec.rb
+- spec/unit/resync/client/capability_list_extensions_spec.rb
 - spec/unit/resync/client/change_dump_index_spec.rb
 - spec/unit/resync/client/change_dump_spec.rb
 - spec/unit/resync/client/client_spec.rb
@@ -308,6 +311,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/todo.rb
 - spec/unit/resync/client/bitstream_spec.rb
+- spec/unit/resync/client/capability_list_extensions_spec.rb
 - spec/unit/resync/client/change_dump_index_spec.rb
 - spec/unit/resync/client/change_dump_spec.rb
 - spec/unit/resync/client/client_spec.rb