studio_api 3.1.4 → 3.2.0

data/VERSION

@@ -1 +1 @@
-3.1.4
+3.2.0

data/lib/studio_api/file.rb

@@ -2,18 +2,18 @@ require "studio_api/studio_resource"
 require "cgi"
 module StudioApi
   # Represents overlay files which can be loaded to appliance.
-  # 
+  #
   # Supports finding files for appliance, updating metadata, deleting, uploading and downloading.
-  # 
+  #
   # @example Find files for appliance
   # StudioApi::File.find :all, :params => { :appliance_id => 1234 }
   #
   # @example Upload file Xorg.conf
-  #   File.open ("/tmp/xorg.conf) { |file|
-  #     StudioApi::File.upload file, 1234, :path => "/etc/X11", 
+  #   File.open ("/tmp/xorg.conf") do |file|
+  #     StudioApi::File.upload file, 1234, :path => "/etc/X11",
   #                         :filename => "Xorg.conf", :permissions => "0755",
   #                         :owner => "root"
-  #   }
+  #   end
   #
   # @example Update metadata
   # file = StudioApi::File.find 1234
@@ -27,10 +27,15 @@ module StudioApi
     self.element_name = "file"
 
     # Downloads file to output. Allow downloading to stream or to path.
-    # @return [String] content of file
-    def content
+    # @return [String] content of file if no block
+    # @return [nil] if block given
+    # @yield [socket response segment] Read the Net::HTTPResponse segments
+    # @yieldparam[body segment] buffered chunk of body
+    # @yieldreturn [nil]
+    def content &block
       rq = GenericRequest.new self.class.studio_connection
-      rq.get "/files/#{id.to_i}/data"
+      path = "/files/#{id.to_i}/data"
+      block_given? ? rq.get_file(path, &block) : rq.get(path)
     end
 
     # Overwritte file content and keep metadata ( of course without such things like size )
@@ -45,7 +50,7 @@ module StudioApi
     end
 
     # Uploads file to appliance
-    # @param (String,File) content as String or as opened File 
+    # @param (String,File) content as String or as opened File
     #   ( in this case its name is used as default for uploaded file name)
     # @param (#to_i) appliance_id id of appliance where to upload
     # @param (Hash<#to_s,#to_s>) options optional parameters, see API documentation
@@ -64,7 +69,7 @@ module StudioApi
       end
     end
 
-private 
+private
     # file uses for update parameter put
     # @private
     def new?

data/lib/studio_api/generic_request.rb

@@ -66,6 +66,15 @@ module StudioApi
       do_request(Net::HTTP::Get.new(Util.join_relative_url(@connection.uri.request_uri,path)))
     end
 
+    # sends get request to suse studio
+    # @return (nil) as response
+    # @raise [ActiveResource::ConnectionError] when problem occur during connection
+    def get_file(path, &block)
+      do_file_request(Net::HTTP::Get.new(
+        Util.join_relative_url(@connection.uri.request_uri,path)),
+        &block)
+    end
+
     # sends delete request
     # @param (String) path relative path from api root
     # @return (String) response body from studio
@@ -102,18 +111,28 @@ module StudioApi
       request.basic_auth @connection.user, @connection.password
       @http.start() do
         response = @http.request request
-        unless response.kind_of? Net::HTTPSuccess
-          msg = error_message response
-          create_active_resource_exception response,msg
-        end
+        handle_active_resource_exception response
         response.body
       end
     end
 
+    def do_file_request request, &block
+      request.basic_auth @connection.user, @connection.password
+      @http.start do |http|
+        http.request request do |response|
+          handle_active_resource_exception response
+          response.read_body {|body| yield body }
+        end
+      end
+    end
+
       #XXX not so nice to use internal method, but better to be DRY and proper test if it works with supported rails
-    def create_active_resource_exception response,msg
-      response.instance_variable_set "@message",msg
-      ActiveResource::Connection.new('').send :handle_response, response
+    def handle_active_resource_exception response
+      unless response.kind_of? Net::HTTPSuccess
+        msg = error_message response
+        response.instance_variable_set "@message",msg
+        ActiveResource::Connection.new('').send :handle_response, response
+      end
     end
 
     def error_message response

data/lib/studio_api/rpm.rb

@@ -3,9 +3,9 @@ require 'cgi'
 
 module StudioApi
   # Represents Additional rpms which can user upload to studio.
-  # 
+  #
   # Allows uploading, downloading, listing (via find) and deleting
-  # 
+  #
   # @example Delete own rpm
   #   rpms = StudioApi::Rpm.find :all, :params => { :base_system => "SLE11" }
   #   my_pac = rpms.find {|r| r.filename =~ /my_pac/ }
@@ -30,8 +30,13 @@ module StudioApi
 
     # Downloads file to specified path.
     # @return [String] content of rpm
-    def content
-      GenericRequest.new(self.class.studio_connection).get "/rpms/#{id.to_i}/data"
+    # @yield [tempfile] Access the tempfile from the block parameter
+    # @yieldparam[tempfile Tempfile] Tempfile instance
+    # @yieldreturn [nil] Tempfile gets closed when the block returns
+    def content &block
+      request = GenericRequest.new self.class.studio_connection
+      path = "/rpms/#{id.to_i}/data"
+      block_given? ? request.get_file(path, &block) : request.get(path)
     end
   end
 end

data/rubygem-studio_api.changes

@@ -1,3 +1,18 @@
+-------------------------------------------------------------------
+Tue Feb 21 16:48:12 UTC 2012 - jreidinger@suse.com
+
+- add feature for chunk processing of downloaded overlay files
+  and rpms ( thanks to vmoravec )
+- 3.2.0 
+
+-------------------------------------------------------------------
+Mon Nov 28 15:13:50 UTC 2011 - jreidinger@suse.com
+
+- rails 3.1 fixes
+-- fix persistency when model created by new
+- improve documentation of configuration of appliance
+- 3.1.4 
+
 -------------------------------------------------------------------
 Wed Aug 17 12:59:00 UTC 2011 - jreidinger@novell.com
 

data/test/file_test.rb

@@ -36,14 +36,31 @@ class File1Test < Test::Unit::TestCase
   end
 
   def test_update
-   register_fake_response_from_file :get, "/api/files/#{@file_id}",
-                                    'file.xml'
-   register_fake_response_from_file :put, "/api/files/#{@file_id}",
-                                    'file.xml'
-
-   f = StudioApi::File.find(@file_id)
-   f.path = "/tmp"
-   assert f.save
+    register_fake_response_from_file :get, "/api/files/#{@file_id}",
+                                     'file.xml'
+    register_fake_response_from_file :put, "/api/files/#{@file_id}",
+                                     'file.xml'
+
+    f = StudioApi::File.find(@file_id)
+    f.path = "/tmp"
+    assert f.save
+  end
+
+  def test_content
+    file_name = 'file.xml'
+    file_path = File.join File.dirname(__FILE__), 'responses'
+    register_fake_response_from_file :get, "/api/files/#{@file_id}/data", file_name
+    register_fake_response_from_file :get, "/api/files/#{@file_id}", file_name
+    studio_file = StudioApi::File.find(@file_id)
+    response = StringIO.new
+    File.open(File.join(file_path, file_name), 'r') do |file|
+      assert_equal studio_file.content, file.read
+      studio_file.content do |body|
+        response << body
+      end
+      file.rewind
+      assert_equal file.read, response.string
+    end
   end
 end
 

data/test/rpm_test.rb

@@ -50,4 +50,16 @@ class RpmTest < Test::Unit::TestCase
      assert StudioApi::Rpm.upload(@rpm_data, "SLE11")
    end
 
+   def test_download_with_block
+     register_fake_response :get, "/api/rpms/#{@rpm_id}/data", @rpm_data
+     file_content = nil
+     rpm = StudioApi::Rpm.new(:id=> @rpm_id)
+     response = StringIO.new
+     rpm.content do |body|
+       response << body
+     end
+     assert_equal @rpm_data, response.string
+   end
+
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: studio_api
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 15
   prerelease: 
   segments: 
   - 3
-  - 1
-  - 4
-  version: 3.1.4
+  - 2
+  - 0
+  version: 3.2.0
 platform: ruby
 authors: 
 - Josef Reidinger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-28 00:00:00 +00:00
+date: 2012-02-21 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency