resync-client 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dc391cfdfcafd5a808a5a4736daf19a1e52d418
-  data.tar.gz: 2f983d3560d4bf3390faaeda241e5b6a570be8f9
+  metadata.gz: f400045ef45597f5b91078336f0210322b58ff29
+  data.tar.gz: c6f10cbd9a55a03e7b2d9c7db1f5bd721189acff
 SHA512:
-  metadata.gz: 65e5d83731a97afab8e3d1d6cbcca7ef716f7acf2e3e7d1ef490763dff15c8daef6539591bd51069b11ddae2f530bcd005928e92b57fdd0805b092e66da7b961
-  data.tar.gz: 468e546e76abb8f29ca6f6a968efd17ab46f785fd082148f0b9b343fca139a69cc2f9dcbd0f491ad37834dab454d104fae35edca5f0e055fcbcba0f34558effc
+  metadata.gz: 561e1fc1d2c34e59a31ace3f76ae1522839500a65a8b6f6a407654ee32b91f7ded1cba8b07e8550932b03e2f6dff983205b9d51ba7042689aca1f897772dbd9a
+  data.tar.gz: 327fe3b46728b19e6043f78f363df94d1d4a74b21c3363fa70d8f720c02ce500f5bf2e188bf96cb8c16bfdd3b61ed2ef0847d1888a1e9eb2279940cbae34cba8

data/.travis.yml

@@ -1,2 +1,7 @@
 language: ruby
 
+addons:
+  code_climate:
+    repo_token: dbb3c6eb70c0de106cdc3f65d542882e7bfce9deee2db544dbcc7ca0a4e5f3da
+    
+

data/CHANGES.md

@@ -1,3 +1,15 @@
+# 0.3.0
+
+- Update to depend on [resync](https://github.com/dmolesUC3/resync) 0.3.0
+- Replace `ZipPackages` class with simple enumerable
+
+# 0.2.6
+
+- Added `#all_resources` (as alias for `#resources`) to `ChangeList`/`ResourceList` for transparent interoperability with `ChangeListIndex`/`ResourceListIndex`
+- Added `#all_changes` (as alias for `#changes`) to `ChangeList`/`ChangeDump` for transparent interoperability with `ChangeListIndex`/`ChangeDumpIndex`
+<!-- TODO: figure out what ChangeDump#all_changes should really do -->
+- Added `#all_zip_packages` (as alias for `#zip_packages`) to `ChangeDump`/`ResourceDump` for transparent interoperability with `ChangeDumpIndex`/`ResourceDumpIndex`
+
 # 0.2.5
 
 - Added `#all_changes` to transparently download and flatten changes in `ChangeListIndex` and `ChangeDumpIndex` documents, with filtering by time and type

data/README.md

@@ -1,4 +1,4 @@
-# resync-client
+# resync-client [![Build Status](https://travis-ci.org/dmolesUC3/resync-client.png?branch=master)](https://travis-ci.org/dmolesUC3/resync-client) [![Code Climate](https://codeclimate.com/github/dmolesUC3/resync-client.png)](https://codeclimate.com/github/dmolesUC3/resync-client) [![Inline docs](http://inch-ci.org/github/dmolesUC3/resync-client.png)](http://inch-ci.org/github/dmolesUC3/resync-client)
 
 A gem providing a Ruby client for the [ResourceSync](http://www.openarchives.org/rs/1.0/resourcesync) web synchronization framework, based on the [resync](https://github.com/dmolesUC3/resync) gem and [Net::HTTP](http://ruby-doc.org/stdlib-2.2.2/libdoc/net/http/rdoc/Net/HTTP.html).
 

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

@@ -34,4 +34,10 @@ module Resync
   class BaseChangeIndex
     prepend Client::Mixins::ChangeIndex
   end
+
+  class ChangeList
+    # Aliases +:changes+ as +:all_changes+ for transparent
+    # interoperability with +ChangeListIndex+
+    alias_method :all_changes, :changes
+  end
 end

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

@@ -1,4 +1,5 @@
 require 'resync'
+require 'lazy'
 require_relative '../zip'
 require_relative 'zipped_resource'
 
@@ -7,6 +8,8 @@ module Resync
     module Mixins
       # A list of resources each of which refers to a zipped bitstream package.
       module Dump
+
+        # Makes each resource a {ZippedResource}
         def resources=(value)
           super
           resources.each do |r|
@@ -17,11 +20,19 @@ module Resync
           end
         end
 
-        # A list (downloaded lazily) of the {Resync::Client::Zip::ZipPackage}s for each resource
-        # @return [Resync::Client::Zip::ZipPackages] the zip packages for each resource
+        # The {Resync::Client::Zip::ZipPackage}s for each resource, downloaded lazily
+        # @return [Array<Lazy::Promise<Resync::Client::Zip::ZipPackage>>] the zip packages for each resource
         def zip_packages
-          @zip_packages ||= Resync::Client::Zip::ZipPackages.new(resources)
+          @zip_packages ||= resources.map { |r| Lazy.promise { r.zip_package } }
+        end
+
+        # Aliases +:zip_packages+ as +:all_zip_packages+ for transparent
+        # interoperability between +ResourceDump+ and +ResourceDumpIndex+,
+        # +ChangeDump+ and +ChangeDumpIndex+
+        def self.prepended(ext)
+          ext.send(:alias_method, :all_zip_packages, :zip_packages)
         end
+
       end
     end
   end
@@ -31,6 +42,23 @@ module Resync
   end
 
   class ChangeDump
-    prepend Client::Mixins::Dump
+    include Client::Mixins::Dump
+
+    # A list (downloaded lazily) of the {Resync::Client::Zip::ZipPackage}s for each resource
+    # If a time range parameter is provided, the lists of packages is filtered by +from_time+
+    # and +until_time+, in non-strict mode (only excluding those lists provably not in the range,
+    # i.e., including packages without +from_time+ or +until_time+).
+    # @param in_range [Range<Time>] the range of times to filter by
+    # @return [Array<Lazy::Promise<Resync::Client::Zip::ZipPackage>>] the zip packages for each resource
+    def zip_packages(in_range: nil)
+      if in_range
+        change_lists = change_lists(in_range: in_range, strict: false)
+        change_lists.map { |r| Lazy.promise { r.zip_package } }
+      else
+        super()
+      end
+    end
+
+    alias_method :all_zip_packages, :zip_packages
   end
 end

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

@@ -11,20 +11,54 @@ module Resync
         # Downloads and parses each resource list and returns a flattened enumeration
         # of all zip packages in each contained list. Each contained list is only downloaded
         # as needed, and only downloaded once.
-        # @return [Enumerator::Lazy<Resync::Client::Zip::ZipPackages>] the flattened enumeration of resources
+        # @return [Enumerator::Lazy<Resync::Client::Zip::ZipPackage>] the flattened enumeration of resources
         def all_zip_packages
-          @zipped_resource_lists ||= {}
-          resources.flat_map do |r|
-            @zipped_resource_lists[r] ||= r.get_and_parse
-            @zipped_resource_lists[r].respond_to?(:zip_packages) ? @zipped_resource_lists[r].zip_packages : []
+          resources.lazy.flat_map do |r|
+            package_for(r)
           end
         end
+
+        private
+
+        def zipped_resource_list_for(r)
+          @zipped_resource_lists ||= {}
+          @zipped_resource_lists[r] ||= r.get_and_parse
+        end
+
+        def package_for(r)
+          zrl = zipped_resource_list_for(r)
+          zrl.respond_to?(:zip_packages) ? zrl.zip_packages : []
+        end
       end
     end
   end
 
   class ChangeDumpIndex
-    prepend Client::Mixins::DumpIndex
+    include Client::Mixins::DumpIndex
+
+    # Downloads and parses each resource list and returns a flattened enumeration
+    # of all zip packages in each contained list. Each contained list is only downloaded
+    # as needed, and only downloaded once.
+    # If a time range parameter is provided, the lists of packages is filtered by +from_time+
+    # and +until_time+, in non-strict mode (only excluding those lists provably not in the range,
+    # i.e., including packages without +from_time+ or +until_time+).
+    # @param in_range [Range<Time>] the range of times to filter by
+    # @return [Enumerator::Lazy<Resync::Client::Zip::ZipPackage>] the flattened enumeration of resources
+    def all_zip_packages(in_range: nil)
+      if in_range
+        dump_resources = change_lists(in_range: in_range, strict: false)
+        dump_resources.lazy.flat_map { |cl| package_for(cl, in_range: in_range) }
+      else
+        super()
+      end
+    end
+
+    private
+
+    def package_for(r, in_range: nil)
+      zrl = zipped_resource_list_for(r)
+      in_range ? zrl.zip_packages(in_range: in_range) : super(r)
+    end
   end
 
   class ResourceDumpIndex

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

@@ -14,7 +14,7 @@ module Resync
         # @return [Enumerator::Lazy<Resync::Resource>] the flattened enumeration of resources
         def all_resources
           @resource_lists ||= {}
-          resources.flat_map do |r|
+          resources.lazy.flat_map do |r|
             @resource_lists[r] ||= r.get_and_parse
             @resource_lists[r].resources
           end
@@ -27,7 +27,19 @@ 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/version.rb

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

data/resync-client.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'resync', '~> 0.2', '>= 0.2.2'
+  spec.add_dependency 'lazy', '~> 0.9', '>= 0.9.6'
+  spec.add_dependency 'resync', '~> 0.2', '>= 0.3.0'
   spec.add_dependency 'rubyzip', '~> 1.1'
 
   spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'
@@ -32,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.9.2'
   spec.add_development_dependency 'simplecov-console', '~> 0.2.0'
   spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
 end

data/spec/spec_helper.rb

@@ -1,7 +1,12 @@
 # ------------------------------------------------------------
-# SimpleCov setup
+# SimpleCov/CodeClimate setup
 
 if ENV['COVERAGE']
+  if ENV['CODECLIMATE_REPO_TOKEN']
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter.start
+  end
+
   require 'simplecov'
   require 'simplecov-console'
 

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

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+module Resync
+  describe ChangeDumpIndex do
+    before(:each) do
+      @change_dump_index = ChangeDumpIndex.load_from_xml(XML.element(
+                                                           "<sitemapindex xmlns='http://www.sitemaps.org/schemas/sitemap/0.9' xmlns:rs='http://www.openarchives.org/rs/terms/'>
+                                                             <rs:md capability='changedump'/>
+                                                             <sitemap>
+                                                               <loc>http://example.com/20130101-changedump.xml</loc>
+                                                               <rs:md from='2013-01-01T00:00:00Z' until='2013-01-02T00:00:00Z'/>
+                                                             </sitemap>
+                                                             <sitemap>
+                                                               <loc>http://example.com/20130102-changedump.xml</loc>
+                                                               <rs:md from='2013-01-02T00:00:00Z' until='2013-01-03T00:00:00Z'/>
+                                                             </sitemap>
+                                                             <sitemap>
+                                                               <loc>http://example.com/20130103-changedump.xml</loc>
+                                                               <rs:md from='2013-01-03T00:00:00Z' until='2013-01-04T00:00:00Z'/>
+                                                             </sitemap>
+                                                           </sitemapindex>"))
+
+      @change_dumps = [
+        "<urlset xmlns='http://www.sitemaps.org/schemas/sitemap/0.9' xmlns:rs='http://www.openarchives.org/rs/terms/'>
+          <rs:md capability='changedump'/>
+          <url>
+            <loc>http://example.com/20130101-changedump-0.zip</loc>
+            <rs:md modified='2013-01-01T11:59:59Z' from='2013-01-01T00:00:00Z' until='2013-01-01T12:00:00Z'/>
+          </url>
+          <url>
+            <loc>http://example.com/20130101-changedump-1.zip</loc>
+            <rs:md modified='2013-01-01T23:59:59Z' from='2013-01-01T12:00:00Z' until='2013-01-02T00:00:00Z'/>
+          </url>
+        </urlset>",
+        "<urlset xmlns='http://www.sitemaps.org/schemas/sitemap/0.9' xmlns:rs='http://www.openarchives.org/rs/terms/'>
+           <rs:md capability='changedump'/>
+           <url>
+             <loc>http://example.com/20130102-changedump-0.zip</loc>
+             <rs:md modified='2013-01-02T11:59:59Z' from='2013-01-02T00:00:00Z' until='2013-01-02T12:00:00Z'/>
+           </url>
+           <url>
+             <loc>http://example.com/20130102-changedump-1.zip</loc>
+             <rs:md modified='2013-01-02T23:59:59Z' from='2013-01-02T12:00:00Z' until='2013-01-03T00:00:00Z'/>
+           </url>
+         </urlset>",
+        "<urlset xmlns='http://www.sitemaps.org/schemas/sitemap/0.9' xmlns:rs='http://www.openarchives.org/rs/terms/'>
+          <rs:md capability='changedump'/>
+          <url>
+            <loc>http://example.com/20130103-changedump-0.zip</loc>
+            <rs:md modified='2013-01-03T11:59:59Z' from='2013-01-03T00:00:00Z' until='2013-01-03T12:00:00Z'/>
+          </url>
+          <url>
+            <loc>http://example.com/20130103-changedump-1.zip</loc>
+            <rs:md modified='2013-01-03T23:59:59Z' from='2013-01-03T12:00:00Z' until='2013-01-04T00:00:00Z'/>
+          </url>
+        </urlset>"
+      ].map { |xml| ChangeDump.load_from_xml(XML.element(xml)) }
+
+      @all_package_resources = []
+      @all_zip_packages = []
+      @change_dumps.each do |d|
+        d.resources.each do |r|
+          @all_package_resources << r
+          zp = instance_double(Resync::Client::Zip::ZipPackage)
+          allow(r).to receive(:zip_package) { zp }
+          @all_zip_packages << zp
+        end
+      end
+
+      @change_dump_resources = []
+      @change_dump_index.resources.each_with_index do |r, i|
+        @change_dump_resources << r
+        allow(r).to receive(:get_and_parse) { @change_dumps[i] }
+      end
+    end
+
+    describe '#all_zip_packages' do
+      it 'should accept an optional time range' do
+        range = Time.utc(2013, 1, 1)..Time.utc(2013, 1, 2, 6)
+        all_packages = @change_dump_index.all_zip_packages(in_range: range).to_a
+        expect(all_packages).to eq(@all_zip_packages[0, 3])
+      end
+
+      it 'should not download unnecessary dumps or packages' do
+        expect(@change_dump_resources[2]).not_to receive(:get_and_parse)
+        @all_package_resources[3, 3].each do |r|
+          expect(r).not_to receive(:zip_package)
+        end
+        @change_dump_index.all_zip_packages(in_range: Time.utc(2013, 1, 1)..Time.utc(2013, 1, 2, 6)).to_a
+      end
+
+      it 'should not require a time range' do
+        all_packages = @change_dump_index.all_zip_packages.to_a
+        expect(all_packages).to eq(@all_zip_packages)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module Resync
+  describe ChangeDump do
+    before(:each) do
+      @resources = [
+        Resource.new(
+          uri: URI('http://example.com/20130101-changedump.zip'),
+          modified_time: Time.utc(2013, 1, 1, 23, 59, 59),
+          metadata: Metadata.new(
+            from_time: Time.utc(2013, 1, 1),
+            until_time: Time.utc(2013, 1, 2))),
+        Resource.new(
+          uri: URI('http://example.com/20130102-changedump.zip'),
+          modified_time: Time.utc(2013, 1, 2, 23, 59, 59),
+          metadata: Metadata.new(
+            from_time: Time.utc(2013, 1, 2),
+            until_time: Time.utc(2013, 1, 3))),
+        Resource.new(
+          uri: URI('http://example.com/20130103-changedump.zip'),
+          modified_time: Time.utc(2013, 1, 3, 23, 59, 59),
+          metadata: Metadata.new(
+            from_time: Time.utc(2013, 1, 3),
+            until_time: Time.utc(2013, 1, 4)))
+      ]
+      @dump = ChangeDump.new(resources: @resources)
+
+      @zip_packages = []
+      @resources.each_with_index do |r, i|
+        @zip_packages[i] = instance_double(Resync::Client::Zip::ZipPackage)
+        allow(r).to receive(:zip_package) { @zip_packages[i] }
+      end
+    end
+
+    describe '#zip_packages' do
+      it 'should accept an optional time range' do
+        packages = @dump.zip_packages(in_range: Time.utc(2013, 1, 3)..Time.utc(2013, 1, 4))
+        expect(packages.size).to eq(2)
+        expect(packages.to_a).to eq([@zip_packages[1], @zip_packages[2]])
+      end
+
+      it 'should not require a time range' do
+        packages = @dump.zip_packages
+        expect(packages.to_a).to eq(@zip_packages)
+      end
+    end
+
+    describe '#all_zip_packages' do
+      it 'should delegate to #zip_packages' do
+        packages = @dump.all_zip_packages
+        expect(packages.to_a).to eq(@zip_packages)
+      end
+    end
+  end
+
+end

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

@@ -51,10 +51,14 @@ module Resync
 
           it 'is lazy enough not to download resources it doesn\'t need' do
             resources = Array.new(3) { instance_double(ZippedResource) }
-            resources.each do |r|
+            zip_packages = Array.new(3) { instance_double(Zip::ZipPackage) }
+            resources.each_with_index do |r, i|
               allow(r).to receive(:client_delegate=)
-              zip_package = instance_double(Zip::ZipPackage)
-              expect(r).to receive(:zip_package).once.and_return(zip_package)
+              if i <= 1
+                expect(r).to receive(:zip_package).once.and_return(zip_packages[i])
+              else
+                expect(r).not_to receive(:zip_package)
+              end
             end
 
             dump1 = ResourceDump.new(resources: resources[0, 3])
@@ -68,37 +72,9 @@ module Resync
             expect(dump2_resource).not_to receive(:get_and_parse)
 
             index = ResourceDumpIndex.new(resources: [dump1_resource, dump2_resource])
-            index.all_zip_packages.each_with_index do |_, i|
-              break if i >= 2
-            end
-          end
-
-          it 'caches downloaded resources' do
-            resources = Array.new(6) { instance_double(ZippedResource) }
-            resources.each do |r|
-              allow(r).to receive(:client_delegate=)
-              zip_package = instance_double(Zip::ZipPackage)
-              expect(r).to receive(:zip_package).once.and_return(zip_package)
-            end
-
-            dump1 = ResourceDump.new(resources: resources[0, 3])
-            dump2 = ResourceDump.new(resources: resources[3, 3])
-
-            dump1_resource = instance_double(Resource)
-            allow(dump1_resource).to receive(:client_delegate=)
-            expect(dump1_resource).to receive(:get_and_parse).once.and_return(dump1)
-
-            dump2_resource = instance_double(Resource)
-            allow(dump2_resource).to receive(:client_delegate=)
-            expect(dump2_resource).to receive(:get_and_parse).once.and_return(dump2)
-
-            index = ResourceDumpIndex.new(resources: [dump1_resource, dump2_resource])
-            all_packages = index.all_zip_packages
-
-            a1 = all_packages.to_a
-            a2 = all_packages.to_a
-            a1.each_with_index do |pkg, i|
-              expect(pkg).to be(a2[i])
+            index.all_zip_packages.each_with_index do |zp, i|
+              expect(zp).to be(zip_packages[i])
+              break if i >= 1
             end
           end
         end

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

@@ -1,60 +1,205 @@
 require 'spec_helper'
 
 module Resync
-  class Client
-    module Mixins
-      describe Dump do
-        it "works for #{ResourceDump}" do
-          path = 'spec/data/resourcedump/resourcedump.xml'
-          package_uri = URI('http://example.com/resourcedump.zip')
+  # TODO: introduce shared examples
+  describe ResourceDump do
+    describe '#zip_packages' do
+      it 'transparently exposes bitstreams' do
+        path = 'spec/data/resourcedump/resourcedump.xml'
+        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')
+
+        dump = XMLParser.parse(File.read(path))
+        dump.client = client
+
+        zip_packages = dump.zip_packages
+        expect(zip_packages.size).to eq(1)
+        expect(zip_packages[0]).to be_a(Client::Zip::ZipPackage)
+
+        bitstreams = zip_packages[0].bitstreams
+        expect(bitstreams.size).to eq(2)
+        expect(bitstreams[0].content).to eq(File.read('spec/data/resourcedump/resources/res1'))
+        expect(bitstreams[1].content).to eq(File.read('spec/data/resourcedump/resources/res2'))
+      end
+
+      it 'is lazy' do
+        resources = Array.new(3) { |i| Resource.new(uri: "http://example.org/res#{i}") }
+        dump = ResourceDump.new(resources: resources)
+        zip_packages = dump.zip_packages
+        zip_package = instance_double(Client::Zip::ZipPackage)
 
-          client = instance_double(Client)
-          expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
+        expect(resources[0]).not_to receive(:zip_package)
+        expect(resources[1]).not_to receive(:zip_package)
+        expect(resources[2]).to receive(:zip_package).and_return(zip_package)
 
-          dump = XMLParser.parse(File.read(path))
-          dump.client = client
+        expect(zip_packages[2]).to be(zip_package)
+      end
+
+      it 'flatmaps' do
+        resources = Array.new(6) { |i| Resource.new(uri: "http://example.org/res#{i}") }
+        all_packages = Array.new(6) do |i|
+          zip_package = instance_double(Client::Zip::ZipPackage)
+          expect(resources[i]).to receive(:zip_package).once.and_return(zip_package)
+          zip_package
+        end
 
-          zip_packages = dump.zip_packages
-          expect(zip_packages.size).to eq(1)
+        zrl1 = ResourceDump.new(resources: resources[0, 3])
+        zrl2 = ResourceDump.new(resources: resources[3, 3])
 
-          zip_package = zip_packages[0]
-          expect(zip_package).to be_a(Resync::Client::Zip::ZipPackage)
+        flat_mapped = [zrl1, zrl2].flat_map(&:zip_packages)
+        expect(flat_mapped).to eq(all_packages)
 
-          bitstreams = zip_package.bitstreams
-          expect(bitstreams.size).to eq(2)
+        lazy_flat_mapped = [zrl1, zrl2].lazy.flat_map(&:zip_packages).to_a
+        expect(lazy_flat_mapped).to eq(all_packages)
+      end
 
-          stream1 = bitstreams[0]
-          expect(stream1.content).to eq(File.read('spec/data/resourcedump/resources/res1'))
+      it 'supports lazy iteration 'do
+        manifests = Array.new(3) { instance_double(ChangeDumpManifest) }
+        all_packages = Array.new(3) do |index|
+          zip_package = instance_double(Client::Zip::ZipPackage)
+          allow(zip_package).to receive(:manifest).and_return(manifests[index])
+          zip_package
+        end
+        resources = Array.new(3) do |index|
+          resource = Resource.new(uri: "http://example.org/res#{index}")
+          if index > 1
+            expect(resource).not_to receive(:zip_package)
+          else
+            expect(resource).to receive(:zip_package).and_return(all_packages[index])
+          end
+          resource
+        end
 
-          stream2 = bitstreams[1]
-          expect(stream2.content).to eq(File.read('spec/data/resourcedump/resources/res2'))
+        zip_packages = ResourceDump.new(resources: resources).zip_packages
+        zip_packages.each_with_index do |zip_package, index|
+          expect(zip_package.manifest).to be(manifests[index])
+          break if index >= 1
         end
+      end
+    end
 
-        it "works for #{ChangeDump}" do
-          path = 'spec/data/resourcedump/changedump.xml'
-          package_uri = URI('http://example.com/changedump.zip')
+    describe '#all_zip_packages' do
+      it 'is an alias for #zip_packages' do
+        path = 'spec/data/resourcedump/resourcedump.xml'
+        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')
+        client = instance_double(Client)
+        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
 
-          dump = XMLParser.parse(File.read(path))
-          dump.client = client
+        dump = XMLParser.parse(File.read(path))
+        dump.client = client
 
-          zip_packages = dump.zip_packages
-          expect(zip_packages.size).to eq(1)
+        all_zip_packages = dump.all_zip_packages
+        expect(all_zip_packages.size).to eq(1)
+        expect(all_zip_packages[0]).to be_a(Client::Zip::ZipPackage)
 
-          zip_package = zip_packages[0]
-          expect(zip_package).to be_a(Resync::Client::Zip::ZipPackage)
+        bitstreams = all_zip_packages[0].bitstreams
+        expect(bitstreams.size).to eq(2)
+        expect(bitstreams[0].content).to eq(File.read('spec/data/resourcedump/resources/res1'))
+        expect(bitstreams[1].content).to eq(File.read('spec/data/resourcedump/resources/res2'))
+      end
+    end
+  end
+
+  describe ChangeDump do
+    describe '#zip_packages' do
+      it 'transparently exposes bitstreams' do
+        path = 'spec/data/resourcedump/changedump.xml'
+        package_uri = URI('http://example.com/changedump.zip')
+
+        client = instance_double(Client)
+        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
+
+        dump = XMLParser.parse(File.read(path))
+        dump.client = client
+
+        zip_packages = dump.zip_packages
+        expect(zip_packages.size).to eq(1)
+        expect(zip_packages[0]).to be_a(Client::Zip::ZipPackage)
+
+        bitstreams = zip_packages[0].bitstreams
+        expect(bitstreams.size).to eq(2)
+        expect(bitstreams[0].content).to eq(File.read('spec/data/resourcedump/resources/res1'))
+        expect(bitstreams[1].content).to eq(File.read('spec/data/resourcedump/resources/res2'))
+      end
 
-          bitstreams = zip_package.bitstreams
-          expect(bitstreams.size).to eq(2)
+      it 'is lazy' do
+        resources = Array.new(3) { |i| Resource.new(uri: "http://example.org/res#{i}") }
+        dump = ChangeDump.new(resources: resources)
+        zip_packages = dump.zip_packages
+        zip_package = instance_double(Client::Zip::ZipPackage)
 
-          stream1 = bitstreams[0]
-          expect(stream1.content).to eq(File.read('spec/data/resourcedump/resources/res1'))
+        expect(resources[0]).not_to receive(:zip_package)
+        expect(resources[1]).not_to receive(:zip_package)
+        expect(resources[2]).to receive(:zip_package).and_return(zip_package)
 
-          stream2 = bitstreams[1]
-          expect(stream2.content).to eq(File.read('spec/data/resourcedump/resources/res2'))
+        expect(zip_packages[2]).to be(zip_package)
+      end
+
+      it 'flatmaps' do
+        resources = Array.new(6) { |i| Resource.new(uri: "http://example.org/res#{i}") }
+        all_packages = Array.new(6) do |i|
+          zip_package = instance_double(Client::Zip::ZipPackage)
+          expect(resources[i]).to receive(:zip_package).once.and_return(zip_package)
+          zip_package
+        end
+
+        zrl1 = ChangeDump.new(resources: resources[0, 3])
+        zrl2 = ChangeDump.new(resources: resources[3, 3])
+
+        lazy_flat_mapped = [zrl1, zrl2].lazy.flat_map(&:zip_packages).to_a
+        expect(lazy_flat_mapped).to eq(all_packages)
+
+        flat_mapped = [zrl1, zrl2].flat_map(&:zip_packages)
+        expect(flat_mapped).to eq(all_packages)
+      end
+
+      it 'supports lazy iteration 'do
+        manifests = Array.new(3) { instance_double(ChangeDumpManifest) }
+        all_packages = Array.new(3) do |index|
+          zip_package = instance_double(Client::Zip::ZipPackage)
+          allow(zip_package).to receive(:manifest).and_return(manifests[index])
+          zip_package
+        end
+        resources = Array.new(3) do |index|
+          resource = Resource.new(uri: "http://example.org/res#{index}")
+          if index > 1
+            expect(resource).not_to receive(:zip_package)
+          else
+            expect(resource).to receive(:zip_package).and_return(all_packages[index])
+          end
+          resource
         end
+
+        zip_packages = ChangeDump.new(resources: resources).zip_packages
+        zip_packages.each_with_index do |zip_package, index|
+          expect(zip_package.manifest).to be(manifests[index])
+          break if index >= 1
+        end
+      end
+    end
+
+    describe '#all_zip_packages' do
+      it 'is an alias for #zip_packages' do
+        path = 'spec/data/resourcedump/changedump.xml'
+        package_uri = URI('http://example.com/changedump.zip')
+
+        client = instance_double(Client)
+        expect(client).to receive(:download_to_temp_file).once.with(package_uri).and_return('spec/data/resourcedump/resourcedump.zip')
+
+        dump = XMLParser.parse(File.read(path))
+        dump.client = client
+
+        zip_packages = dump.all_zip_packages
+        expect(zip_packages.size).to eq(1)
+        expect(zip_packages[0]).to be_a(Client::Zip::ZipPackage)
+
+        bitstreams = zip_packages[0].bitstreams
+        expect(bitstreams.size).to eq(2)
+        expect(bitstreams[0].content).to eq(File.read('spec/data/resourcedump/resources/res1'))
+        expect(bitstreams[1].content).to eq(File.read('spec/data/resourcedump/resources/res2'))
       end
     end
   end

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

@@ -41,6 +41,51 @@ module Resync
       end
     end
 
+    describe ResourceList do
+      describe '#all_resources' do
+        it 'is an alias for #resources' 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)
+        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
+        end
+
+        it 'is a proxy for #changes' 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))
+          resources[2] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(1999, 3, 1), metadata: Metadata.new(change: Types::Change::UPDATED))
+          resources[3] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(1999, 6, 1), metadata: Metadata.new(change: Types::Change::UPDATED))
+          resources[4] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2000, 3, 1), metadata: Metadata.new(change: Types::Change::UPDATED))
+          resources[5] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(2000, 6, 1), metadata: Metadata.new(change: Types::Change::UPDATED))
+          resources[6] = Resource.new(uri: 'http://example.org/', modified_time: Time.utc(1999, 9, 1), metadata: Metadata.new(change: Types::Change::DELETED))
+          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_a).to eq([resources[3], resources[4]])
+        end
+      end
+    end
+
     describe BaseChangeIndex do
       before(:each) do
         @helper = instance_double(Client::HTTPHelper)

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: resync-client
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lazy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: resync
   requirement: !ruby/object:Gem::Requirement
@@ -19,7 +39,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +49,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +162,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby client for the ResourceSync web synchronization framework
 email:
 - david.moles@ucop.edu
@@ -177,7 +211,6 @@ files:
 - lib/resync/client/zip.rb
 - lib/resync/client/zip/bitstream.rb
 - lib/resync/client/zip/zip_package.rb
-- lib/resync/client/zip/zip_packages.rb
 - resync-client.gemspec
 - spec/acceptance/example_spec.rb
 - spec/data/examples/capability-list.xml
@@ -210,6 +243,8 @@ files:
 - spec/spec_helper.rb
 - spec/todo.rb
 - spec/unit/resync/client/bitstream_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
 - spec/unit/resync/client/dump_index_spec.rb
 - spec/unit/resync/client/dump_spec.rb
@@ -217,7 +252,6 @@ files:
 - spec/unit/resync/client/http_helper_spec.rb
 - spec/unit/resync/client/list_index_spec.rb
 - spec/unit/resync/client/zip_package_spec.rb
-- spec/unit/resync/client/zip_packages_spec.rb
 homepage: http://github.com/dmolesUC3/resync-client
 licenses:
 - MIT
@@ -238,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Client library for ResourceSync
@@ -274,6 +308,8 @@ test_files:
 - spec/spec_helper.rb
 - spec/todo.rb
 - spec/unit/resync/client/bitstream_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
 - spec/unit/resync/client/dump_index_spec.rb
 - spec/unit/resync/client/dump_spec.rb
@@ -281,5 +317,4 @@ test_files:
 - spec/unit/resync/client/http_helper_spec.rb
 - spec/unit/resync/client/list_index_spec.rb
 - spec/unit/resync/client/zip_package_spec.rb
-- spec/unit/resync/client/zip_packages_spec.rb
 has_rdoc: 

data/lib/resync/client/zip/zip_packages.rb

@@ -1,69 +0,0 @@
-require 'resync'
-require_relative '../mixins'
-require_relative 'zip_package'
-
-module Resync
-  class Client
-    module Zip
-      # 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.
-        # @yield [ZipPackage] the zip package for each resource
-        def each
-          @resources.lazy.each do |resource|
-            yield package_for(resource)
-          end
-        end
-
-        # Eagerly gets the zip package for each resource, downloading
-        # as necessary. (For compatbility with {::Enumerator::Lazy#flat_map})
-        # @return [Array<ZipPackage>] the zip package for each resource
-        def force
-          @resources.map { |r| package_for(r) }.to_a
-        end
-
-        # Alias for {#force} (for compatbility with {::Enumerable#flat_map})
-        alias_method :to_ary, :force
-      end
-    end
-  end
-end

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

@@ -1,82 +0,0 @@
-require 'spec_helper'
-
-module Resync
-  class Client
-    module Zip
-      describe ZipPackages do
-        it 'is lazy' do
-          resources = Array.new(3) { |i| Resource.new(uri: "http://example.org/res#{i}") }
-
-          zip_packages = ZipPackages.new(resources)
-
-          zip_package = instance_double(ZipPackage)
-          expect(resources[0]).not_to receive(:zip_package)
-          expect(resources[1]).not_to receive(:zip_package)
-          expect(resources[2]).to receive(:zip_package).and_return(zip_package)
-
-          expect(zip_packages[2]).to be(zip_package)
-        end
-
-        it 'caches zip packages' do
-          resources = Array.new(3) { |i| Resource.new(uri: "http://example.org/res#{i}") }
-
-          zip_packages = ZipPackages.new(resources)
-
-          zip_package = instance_double(ZipPackage)
-          expect(resources[1]).to receive(:zip_package).once.and_return(zip_package)
-
-          expect(zip_packages[1]).to be(zip_package)
-          expect(zip_packages[1]).to be(zip_package)
-        end
-
-        it 'flatmaps' do
-          resources = Array.new(6) { |i| Resource.new(uri: "http://example.org/res#{i}") }
-          all_packages = Array.new(6) do |i|
-            zip_package = instance_double(ZipPackage)
-            expect(resources[i]).to receive(:zip_package).once.and_return(zip_package)
-            zip_package
-          end
-
-          zip_packages_1 = ZipPackages.new(resources[0, 3])
-          zip_packages_2 = ZipPackages.new(resources[3, 3])
-
-          zrl1 = instance_double(Resync::Client::Mixins::Dump)
-          expect(zrl1).to receive(:zip_packages).twice.and_return(zip_packages_1)
-
-          zrl2 = instance_double(Resync::Client::Mixins::Dump)
-          expect(zrl2).to receive(:zip_packages).twice.and_return(zip_packages_2)
-
-          flat_mapped = [zrl1, zrl2].flat_map(&:zip_packages)
-          expect(flat_mapped).to eq(all_packages)
-
-          lazy_flat_mapped = [zrl1, zrl2].lazy.flat_map(&:zip_packages).to_a
-          expect(lazy_flat_mapped).to eq(all_packages)
-        end
-
-        it 'supports lazy iteration' do
-          manifests = Array.new(3) { instance_double(ChangeDumpManifest) }
-          all_packages = Array.new(3) do |index|
-            zip_package = instance_double(ZipPackage)
-            allow(zip_package).to receive(:manifest).and_return(manifests[index])
-            zip_package
-          end
-          resources = Array.new(3) do |index|
-            resource = Resource.new(uri: "http://example.org/res#{index}")
-            if index > 1
-              expect(resource).not_to receive(:zip_package)
-            else
-              expect(resource).to receive(:zip_package).and_return(all_packages[index])
-            end
-            resource
-          end
-
-          zip_packages = ZipPackages.new(resources)
-          zip_packages.each_with_index do |zip_package, index|
-            expect(zip_package.manifest).to be(manifests[index])
-            break if index >= 1
-          end
-        end
-      end
-    end
-  end
-end