resync-client 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f400045ef45597f5b91078336f0210322b58ff29
-  data.tar.gz: c6f10cbd9a55a03e7b2d9c7db1f5bd721189acff
+  metadata.gz: c72554545a2d19f93f85eb0b021de5516041024f
+  data.tar.gz: a285cc547f7c90a4bc6d1ca5ef27ae8e75b2c9fb
 SHA512:
-  metadata.gz: 561e1fc1d2c34e59a31ace3f76ae1522839500a65a8b6f6a407654ee32b91f7ded1cba8b07e8550932b03e2f6dff983205b9d51ba7042689aca1f897772dbd9a
-  data.tar.gz: 327fe3b46728b19e6043f78f363df94d1d4a74b21c3363fa70d8f720c02ce500f5bf2e188bf96cb8c16bfdd3b61ed2ef0847d1888a1e9eb2279940cbae34cba8
+  metadata.gz: 8e4600dffb2cbe106fb2454c402e84085743ccbaed5d3195564bdc79ddb96d26b1c746876aedabbc599ac1d262e6a7f16b37c4bc412b782854f65679fd15bbf4
+  data.tar.gz: ff4b5427c5a8fdbb88d9a56688cb908ccf3bdaae73e0aba580c202a8b30ba7f07e74dd37765e0985499802bc7c57f686672f96dfd07eaf7a499c6ccc08e2c6f9

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.3.1
+
+- Make `#get` and `#get_and_parse` in `Downloadable` (i.e., `Resource` and `Link`) cache the downloaded content
+
 # 0.3.0
 
 - Update to depend on [resync](https://github.com/dmolesUC3/resync) 0.3.0

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

@@ -9,24 +9,31 @@ module Resync
         prepend ClientDelegator
 
         # Delegates to {Client#get_and_parse} to get the contents of
-        # +:uri+ as a ResourceSync document
+        # +:uri+ as a ResourceSync document. The downloaded, parsed
+        # document will only be downloaded once; subsequent calls to
+        # this method will return the cached document.
         def get_and_parse # rubocop:disable Style/AccessorMethodName
-          client.get_and_parse(uri)
+          @parsed_content ||= client.get_and_parse(uri)
         end
 
-        # Delegates to {Client#get} to get the contents of this +:uri+
+        # Delegates to {Client#get} to get the contents of this +:uri+.
+        # The downloaded content will only be downloaded once; subsequent
+        # calls to this method will return the cached content.
         def get # rubocop:disable Style/AccessorMethodName
-          client.get(uri)
+          @content ||= client.get(uri)
         end
 
         # Delegates to {Client#download_to_temp_file} to download the
-        # contents of +:uri+ to a file.
+        # contents of +:uri+ to a file. Subsequent calls will download
+        # the contents again, each time to a fresh temporary 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.
+        # contents of +:uri+ to the specified path. Subsequent
+        # calls wiill download the contents again, potentially
+        # overwriting the file if given the same path.
         # @param path [String] the path to download to
         def download_to_file(path)
           client.download_to_file(uri: uri, path: path)

data/lib/resync/client/version.rb

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

data/spec/unit/resync/client/{extensions_spec.rb → mixins_spec.rb}

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 module Resync
 
+  # TODO: Share examples
   describe 'extensions' do
 
     # ------------------------------------------------------------
@@ -178,6 +179,14 @@ module Resync
           expect(client).to receive(:get_and_parse).with(@resources[0].uri) { resource }
           expect(@resources[0].get_and_parse).to be(resource)
         end
+
+        it 'caches the downloaded contents' do
+          client = instance_double(Resync::Client)
+          resource = instance_double(Resync::ResourceList)
+          @list.client = client
+          expect(client).to receive(:get_and_parse).once.with(@resources[0].uri) { resource }
+          expect(@resources[0].get_and_parse).to be(@resources[0].get_and_parse)
+        end
       end
 
       describe '#get' do
@@ -188,6 +197,14 @@ module Resync
           expect(client).to receive(:get).with(@resources[0].uri) { data }
           expect(@resources[0].get).to be(data)
         end
+
+        it 'caches the downloaded contents' do
+          data = 'I am the contents of a resource'
+          client = instance_double(Resync::Client)
+          @list.client = client
+          expect(client).to receive(:get).once.with(@resources[0].uri) { data }
+          expect(@resources[0].get).to be(@resources[0].get)
+        end
       end
 
       describe '#download_to_temp_file' do
@@ -198,6 +215,16 @@ module Resync
           expect(client).to receive(:download_to_temp_file).with(@resources[0].uri) { path }
           expect(@resources[0].download_to_temp_file).to be(path)
         end
+
+        it 'downloads anew each time' do
+          path1 = '/tmp/whatever1.zip'
+          path2 = '/tmp/whatever2.zip'
+          client = instance_double(Resync::Client)
+          @list.client = client
+          expect(client).to receive(:download_to_temp_file).twice.with(@resources[0].uri).and_return(path1, path2)
+          expect(@resources[0].download_to_temp_file).to eq(path1)
+          expect(@resources[0].download_to_temp_file).to eq(path2)
+        end
       end
 
       describe '#download_to_file' do
@@ -208,6 +235,14 @@ module Resync
           expect(client).to receive(:download_to_file).with(uri: @resources[0].uri, path: path) { path }
           expect(@resources[0].download_to_file(path)).to be(path)
         end
+
+        it 'downloads anew each time' do
+          path = '/tmp/whatever.zip'
+          client = instance_double(Resync::Client)
+          @list.client = client
+          expect(client).to receive(:download_to_file).twice.with(uri: @resources[0].uri, path: path) { path }
+          expect(@resources[0].download_to_file(path)).to eq(@resources[0].download_to_file(path))
+        end
       end
     end
 
@@ -220,6 +255,14 @@ module Resync
           expect(client).to receive(:get_and_parse).with(@links[0].uri) { resource }
           expect(@links[0].get_and_parse).to be(resource)
         end
+
+        it 'caches the downloaded contents' do
+          client = instance_double(Resync::Client)
+          resource = instance_double(Resync::ResourceList)
+          @list.client = client
+          expect(client).to receive(:get_and_parse).once.with(@links[0].uri) { resource }
+          expect(@links[0].get_and_parse).to be(@links[0].get_and_parse)
+        end
       end
 
       describe '#get' do
@@ -230,11 +273,19 @@ module Resync
           expect(client).to receive(:get).with(@links[0].uri) { data }
           expect(@links[0].get).to be(data)
         end
+
+        it 'caches the downloaded contents' do
+          data = 'I am the contents of a link'
+          client = instance_double(Resync::Client)
+          @list.client = client
+          expect(client).to receive(:get).once.with(@links[0].uri) { data }
+          expect(@links[0].get).to be(@links[0].get)
+        end
       end
 
       describe '#download_to_temp_file' do
         it 'downloads the link contents to a file using the injected client' do
-          path = '/tmp/whatever.zip'
+          path = '/tmp/whatever1.zip'
           client = instance_double(Resync::Client)
           @list.client = client
           expect(client).to receive(:download_to_temp_file).with(@links[0].uri) { path }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resync-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - David Moles
@@ -248,9 +248,9 @@ files:
 - spec/unit/resync/client/client_spec.rb
 - spec/unit/resync/client/dump_index_spec.rb
 - spec/unit/resync/client/dump_spec.rb
-- spec/unit/resync/client/extensions_spec.rb
 - spec/unit/resync/client/http_helper_spec.rb
 - spec/unit/resync/client/list_index_spec.rb
+- spec/unit/resync/client/mixins_spec.rb
 - spec/unit/resync/client/zip_package_spec.rb
 homepage: http://github.com/dmolesUC3/resync-client
 licenses:
@@ -313,8 +313,8 @@ test_files:
 - spec/unit/resync/client/client_spec.rb
 - spec/unit/resync/client/dump_index_spec.rb
 - spec/unit/resync/client/dump_spec.rb
-- spec/unit/resync/client/extensions_spec.rb
 - spec/unit/resync/client/http_helper_spec.rb
 - spec/unit/resync/client/list_index_spec.rb
+- spec/unit/resync/client/mixins_spec.rb
 - spec/unit/resync/client/zip_package_spec.rb
 has_rdoc: