Class: Resync::ZipPackage

Inherits:
Object
  • Object
show all
Defined in:
lib/resync/client/zip_package.rb

Overview

A ZIP package of resources or changes, providing access to individual bitstreams based on the included manifest file.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(zipfile) ⇒ ZipPackage

Creates a new ZipPackage for the specified file.

Parameters:

  • zipfile (Zip::File, String) —

    the ZIP file, or a path to it.



27
28
29
 
# File 'lib/resync/client/zip_package.rb', line 27

def initialize(zipfile)
  self.zipfile = zipfile
end

Instance Attribute Details

#manifest ⇒ ResourceDumpManifest, ChangeDumpManifest (readonly)

Returns the manifest for the ZIP package.

Returns:

  • (ResourceDumpManifest, ChangeDumpManifest) —

    the manifest for the ZIP package



19
20
21
 
# File 'lib/resync/client/zip_package.rb', line 19

def manifest
  @manifest
end

#zipfile ⇒ Zip::File

Returns the ZIP file wrapped by this package.

Returns:

  • (Zip::File) —

    the ZIP file wrapped by this package



15
16
17
 
# File 'lib/resync/client/zip_package.rb', line 15

def zipfile
  @zipfile
end

Instance Method Details

#bitstream_for(resource) ⇒ Bitstream

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.)

Returns:

  • (Bitstream) —

    a bitstream wrapping the ZIP entry for the specified resource.



41
42
43
 
# File 'lib/resync/client/zip_package.rb', line 41

def bitstream_for(resource)
  Bitstream.new(zipfile: @zipfile, resource: resource)
end

#bitstreams ⇒ Array<Bitstream>

Gets all bitstreams declared in the package manifest.

Returns:

  • (Array<Bitstream>) —

    a list of all bitstreams in the package



47
48
49
 
# File 'lib/resync/client/zip_package.rb', line 47

def bitstreams
  manifest.resources.map { |r| bitstream_for(r) }
end