artifactory 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25479b749ea49c38799479ba12df5373efdf77a0
-  data.tar.gz: 52732e8ba49c9b1e29ad2180aa1e4ff8175d1798
+  metadata.gz: 2b85783f95f2c304e859d43d9c35399812049fbf
+  data.tar.gz: 5c7d4b82bbdcb8d64effa3ef4d0d205c5ecc1b3e
 SHA512:
-  metadata.gz: e111db3109a4598677fd2ba3b1cbe7d5cb26c087e43690c06ca97cc3ced0b0fc776e1736dfadf87ee5d8683ba1d6a369dbd0c416ae27055d41dfa0ca69d58c6f
-  data.tar.gz: c76f8078e1829439fb4673a284842c954d8aa859b9ac16cad3535f508f568309c196e587df1d43946bcc1725e97211c5460d0797bd27717054124687ff4449f2
+  metadata.gz: 334b556c77599920368e7aaab3ff2062243872c8f02dc356b4acc4e4e6ec2ebc0db66280c9fb8185e6ed813185b0062c5c94052c46a1b394a805ff83a97dd377
+  data.tar.gz: 6991c793b25068e7d028d0939780809e72186d0dae9dcec1b31ea6107fe76d8015eed1d937030af34322a3dfa803144bb5239dc5404f7bf8da4b737f6238e146

data/CHANGELOG.md

@@ -3,6 +3,10 @@ Artifactory Client CHANGELOG
 This file is used to document the changes between releases of the Artifactory
 Ruby client.
 
+v2.8.1 (03-21-2017)
+-------------------
+- Allow downloading of large files. Fixes #83.
+
 v2.8.0 (03-17-2017)
 -------------------
 - Include statuses in Build resource

data/lib/artifactory/client.rb

@@ -90,16 +90,21 @@ module Artifactory
     #
     # Make a HTTP GET request
     #
+    # If a block is provided the response body is yielded in chunks/fragments
+    # as it is read from the undelrying socket.
+    #
     # @param path (see Client#request)
     # @param [Hash] params
     #   the list of query params
     # @param headers (see Client#request)
     #
+    # @yield [chunk] Partial piece of response body
+    #
     # @raise (see Client#request)
     # @return (see Client#request)
     #
-    def get(path, params = {}, headers = {})
-      request(:get, path, params, headers)
+    def get(path, params = {}, headers = {}, &block)
+      request(:get, path, params, headers, &block)
     end
 
     #
@@ -162,7 +167,9 @@ module Artifactory
     #
     # Make an HTTP request with the given verb, data, params, and headers. If
     # the response has a return type of JSON, the JSON is automatically parsed
-    # and returned as a hash; otherwise it is returned as a string.
+    # and returned as a hash; otherwise it is returned as a string. If a block
+    # is provided the response body is yielded in chunks/fragments as it is
+    # read from the undelrying socket.
     #
     # @raise [Error::HTTPError]
     #   if the request is not an HTTP 200 OK
@@ -177,10 +184,12 @@ module Artifactory
     # @param [Hash] headers
     #   the list of headers to use
     #
+    # @yield [chunk] Partial piece of response body
+    #
     # @return [String, Hash]
     #   the response body
     #
-    def request(verb, path, data = {}, headers = {})
+    def request(verb, path, data = {}, headers = {}, &block)
       # Build the URI and request object from the given information
       uri = build_uri(verb, path, data)
       request = class_for_request(verb).new(uri.request_uri)
@@ -245,16 +254,25 @@ module Artifactory
       # Create a connection using the block form, which will ensure the socket
       # is properly closed in the event of an error.
       connection.start do |http|
-        response = http.request(request)
-
-        case response
-        when Net::HTTPRedirection
-          redirect = URI.parse(response["location"])
-          request(verb, redirect, data, headers)
-        when Net::HTTPSuccess
-          success(response)
+
+        if block_given?
+          http.request(request) do |response|
+            response.read_body do |chunk|
+              yield chunk
+            end
+          end
         else
-          error(response)
+          response = http.request(request)
+
+          case response
+          when Net::HTTPRedirection
+            redirect = URI.parse(response["location"])
+            request(verb, redirect, data, headers)
+          when Net::HTTPSuccess
+            success(response)
+          else
+            error(response)
+          end
         end
       end
     rescue SocketError, Errno::ECONNREFUSED, EOFError

data/lib/artifactory/resources/artifact.rb

@@ -502,7 +502,9 @@ module Artifactory
       destination = File.join(target, filename)
 
       File.open(destination, "wb") do |file|
-        file.write(client.get(download_uri))
+        client.get(download_uri) do |chunk|
+          file.write chunk
+        end
       end
 
       destination

data/lib/artifactory/version.rb

@@ -15,5 +15,5 @@
 #
 
 module Artifactory
-  VERSION = "2.8.0"
+  VERSION = "2.8.1"
 end

data/spec/unit/client_spec.rb

@@ -46,6 +46,13 @@ module Artifactory
         expect(subject).to receive(:request).with(:get, "/foo", {}, {})
         subject.get("/foo")
       end
+
+      context "called with a block" do
+        it "yields the response in chunks" do
+          expect(subject).to receive(:request).with(:get, "/foo", {}, {}) { |&block| block.call("Chunked Body") }
+          expect { |chunk| subject.get("/foo", &chunk) }.to yield_with_args("Chunked Body")
+        end
+      end
     end
 
     describe "#post" do
@@ -90,6 +97,16 @@ module Artifactory
           expect { subject.request(:get, "/") }.to raise_error(Error::HTTPError)
         end
       end
+
+      context "called with a block" do
+        before { stub_request(:get, /.+/).to_return(status: 200, body: "Chunked Body") }
+
+        it "yields the response in chunks" do
+          subject.request(:get, "/foo") do |chunk|
+            expect(chunk).to eq("Chunked Body")
+          end
+        end
+      end
     end
 
     describe "#to_query_string" do

data/spec/unit/resources/artifact_spec.rb

@@ -560,6 +560,20 @@ module Artifactory
           expect(Dir.entries(tmpdir)).to include("foobar.deb")
         end
       end
+
+      it "writes the file in chunks" do
+        Dir.mktmpdir("artifact_download") do |tmpdir|
+          subject.download_uri = "/artifact.deb"
+
+          expect(client).to receive(:get).and_yield("some content")
+
+          file = double("file")
+          expect(File).to receive(:open).with(File.join(tmpdir, "artifact.deb"), "wb").and_yield(file)
+          expect(file).to receive(:write).with("some content")
+
+          subject.download(tmpdir)
+        end
+      end
     end
 
     describe "#relative_path" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artifactory
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler