A Ruby client for the ResourceSync web synchronization framework
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/resync
spec
.gitignore
.rubocop.yml
.ruby-version
.travis.yml
CHANGES.md
Gemfile
LICENSE.md
README.md
Rakefile
example.rb
resync-client.gemspec

README.md

resync-client

Build Status Code Climate Inline docs Gem Version

A gem providing a Ruby client for the ResourceSync web synchronization framework, based on the resync gem and Net::HTTP.

Usage

Retrieving the Source Description for a site:

client = Resync::Client.new

source_desc_uri = 'http://example.org/.well-known/resourcesync'
source_desc = client.get_and_parse(source_desc_uri) # => Resync::SourceDescription

Retrieving a Capability List from the source description:

cap_list_resource = source_desc.resource_for(capability: 'capabilitylist')
cap_list = cap_list_resource.get_and_parse # => Resync::CapabilityList

Retrieving a Change List and downloading the latest revision of a known resource to a file

change_list_resource = cap_list.resource_for(capability: 'changelist')
change_list = change_list_resource.get_and_parse # => Resync::ChangeList
latest_rev_resource = change_list.latest_for(uri: URI('http://example.com/my-resource'))
latest_rev_resource.download_to_file('/tmp/my-resource.txt')

Retrieving a Change Dump, searching through its manifests for changes to a specified URL, downloading the ZIP package containing that resource, and extracting it from the ZIP package:

change_dump_resource = cap_list.resource_for(capability: 'changedump')
change_dump = change_dump_resource.get_and_parse # => Resync::ChangeDump
change_dump.resources.each do |package|
  manifest_link = package.link_for(rel: 'contents')
  if manifest_link
    manifest = manifest_link.get_and_parse # => Resync::ChangeDumpManifest
    latest_resource = manifest.latest_for(uri: URI('http://example.com/my-resource'))
    if latest_resource
      timestamp = latest_resource.modified_time.strftime('%s%3N')
      zip_package = package.zip_package # => Resync::ZipPackage (downloaded to temp file)
      bitstream = zip_package.bitstream_for(latest_resource) # => Resync::Bitstream
      content = bitstream.content # => String (extracted from ZIP file)
      File.open("/tmp/my-resource-#{timestamp}.txt") { |f| f.write(content) }
    end
  end
end

Status

This is a work in progress -- bug reports and feature requests are welcome. It's still a prototype, and hasn't really been tested except with resync-simulator -- and that not much beyond what you'll find in example.rb. So expect some trouble. :)