aem-deploy 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99e43a6be5116ece40f04dbc0dd05910bb161def
-  data.tar.gz: a4a4f54be4781a4149b5d6f5d7f675a090be7001
+  metadata.gz: e69f766f28e7f545c57730fefad25e50b7d27e48
+  data.tar.gz: 3588a996f8532eaa83ed276a3e56fb7370ba36d4
 SHA512:
-  metadata.gz: 153d7fefcf5ae10eb43ce4fa978b91e9794a26e1f70fee3199ef3ef6405f14b471d7f0680380f730e6dfb190929f9c690ba9eb271f9cb65566bb20338845053d
-  data.tar.gz: 028835d55af6cee408d1d77d1ca9d7f464e9e50bb70a49e4bf04b1f026a71e93ffbbb6c200c89b96f9d80203803abb2f62baa8c574d560edb9b85ada7545f6fd
+  metadata.gz: 23417b2a3ac428555e769bf2eed83df8d184aede33fb520fc435fac121854cf233d848b023afd95beafd04ccf3b3a5e6eb3218bb9054e38ec7993e1241c5fc61
+  data.tar.gz: ae975479436180413de50309d7b4d295a12855ff887773c2dc0b5a01458d6024073fc72353ae5be19fbc7e2e6c080b0b65018627a8649c4aeb5530d479839684

data/lib/aem/deploy/session.rb

@@ -9,6 +9,9 @@ module Aem::Deploy
   class Session
     attr_reader :host, :user, :pass, :retry, :upload_path
 
+    # Initialize the object
+    # @param [Hash] including :host, :user and :pass REQUIRED, optional :retry [Integer] which will retry failures x times.
+    # @raise [Error] if :host, :user and :pass are not passed on initialize
     def initialize(params)
       if [:host, :user, :pass].all? {|k| params.key?(k)}
         @host = params.fetch(:host)
@@ -20,13 +23,18 @@ module Aem::Deploy
       end
     end
 
-    #upload and install package
+    # See Upload and Install methods for individual descriptions
+    # @param [String] path to the package for upload and installation.
+    # @return [Hash] installation message from crx
     def easy_install(package_path)
       upload_package(package_path)
       install_package
     end
 
-    # upload package
+    # Uploads Package to CRX
+    # @param [String] path to the package for upload and installation.
+    # @return [Hash] installation message from crx.
+    # @raise [Error] if server returns anything but success.
     def upload_package(package_path)
       upload = RestClient.post("http://#{@user}:#{@pass}@#{@host}/crx/packmgr/service/.json", :cmd => 'upload', :package => File.new(package_path, 'rb'), :force => true, :timeout => 300)
       parse_response(upload)
@@ -39,7 +47,10 @@ module Aem::Deploy
       end
     end
 
-    # Install package
+    # Installs Package to CRX
+    # @param [Hash] Optionally install packages already on CRX uses :path key in options hash, if you know the path to the package on crx.
+    # @return [Hash] installation message from crx.
+    # @raise [Error] if server returns anything but success.
     def install_package(options = {})
       if options[:path]
         @upload_path = options[:path]
@@ -54,7 +65,9 @@ module Aem::Deploy
       end
     end
 
-    # Recompiles JSPs on CMS
+    # Recompiles JSPs
+    # @return [String] Recompile complete
+    # @raise [Error] if server returns anything but success.
     def recompile_jsps
       begin
         RestClient.post "http://#{@user}:#{@pass}@#{@host}/system/console/slingjsp", :cmd => 'recompile', :timeout => 120
@@ -69,7 +82,9 @@ module Aem::Deploy
       end
     end
 
-    # Checks response of any request to CMS. Breaks script if unexpected response.
+    # Parses message output from CRX
+    # @return [String] Recompile complete
+    # @raise [Error] if server returns anything but success.
     def parse_response(message)
       if JSON.parse(message)['success'] == true
         return "  #{message}"

data/lib/aem/deploy/version.rb

@@ -1,5 +1,5 @@
 module Aem
   module Deploy
-    VERSION = "0.1.9"
+    VERSION = "0.1.11"
   end
 end

data/lib/aem-deploy.rb

@@ -3,7 +3,7 @@ require "aem/deploy/session"
 
 module Aem
   module Deploy
-    # Create a new session with teh default options.
+    # Create a new session with the default options.
     def self.new(params = {})
       Session.new(params)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aem-deploy
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Mitch Eaton