ruby_aem 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 017b94ee59bf80abe0156c15ec3d70c200b122a9
-  data.tar.gz: 27a555764cd6460d277d1658fc7c0bf0311ee71b
+  metadata.gz: bd2ed673ae15b68e95ab826d68fcbe626be9d311
+  data.tar.gz: 05a5ce3cbb7b71bd803e0e84ea3bde75c8f5cfe9
 SHA512:
-  metadata.gz: c0f06810662d558aa580fac1939fafe6a98e5c7edba6342ac4be1e4dab9467a04ee9d08ec7601ae06403804ffa9bf72a9327e326c81598321ea06b588344ddd1
-  data.tar.gz: d8e300cefacd46d650a11da26cd0cca16d1e950e2efbc45e219da0fb8e31d1fe055aa186eb0a744e1157fdd31d57d04ed341e164b99d7cdfb50ea7d8499f115f
+  metadata.gz: a9575353f79e67a36b1ff72c710ab178e8589459e07a415fd4597809b9e95911cd1f55f2cf54e7fd15708adab7094d5a433bb3a718617f08e169fef485d9754e
+  data.tar.gz: d031a4e54a02d5fd02313e91ae108ba01495dd892b1b69e8b1c5d0736840ac369778846648784ead03a45af3296044568f563ee8110e6c0df18bb873277cd52e

data/conf/spec.yaml

@@ -1,3 +1,14 @@
+aem:
+  actions:
+    get_login_page:
+      api: cq
+      operation: getLoginPage
+      params:
+        required:
+      responses:
+        200:
+          handler: simple
+          message: 'Login page retrieved'
 bundle:
   responses:
     404:
@@ -358,11 +369,11 @@ configproperty:
   actions:
     create:
       api: sling
-      operation: postPath
+      operation: postConfig
       params:
         required:
           runmode: '%{run_mode}'
-          name: '%{name}'
+          name: '%{node_name}'
         optional:
           - org_apache_felix_https_nio
           - org_apache_felix_https_nio_type_hint
@@ -387,10 +398,10 @@ configproperty:
       responses:
         200:
           handler: simple
-          message: 'Set %{run_mode} config %{type} property %{name}=%{value}'
+          message: 'Set %{run_mode} %{node_name} config %{type} property %{name}=%{value}'
         201:
           handler: simple
-          message: 'Set %{run_mode} config %{type} property %{name}=%{value}'
+          message: 'Set %{run_mode} %{node_name} config %{type} property %{name}=%{value}'
 replicationagent:
   responses:
     404:

data/lib/ruby_aem/resources/aem.rb

@@ -0,0 +1,67 @@
+=begin
+Copyright 2016 Shine Solutions
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require 'retries'
+require 'ruby_aem/error'
+
+module RubyAem
+  module Resources
+    # AEM class contains API calls related to managing the AEM instance itself.
+    class Aem
+
+      # Initialise an AEM instance.
+      #
+      # @param client RubyAem::Client
+      # @return new RubyAem::Resources::Aem instance
+      def initialize(client)
+        @client = client
+        @call_params = {
+        }
+      end
+
+      # Retrieve AEM login page.
+      #
+      # @return RubyAem::Result
+      def get_login_page()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Retrieve AEM login page with retries until it is successful.
+      # This is handy for waiting for AEM to start or restart Jetty.
+      #
+      # @return RubyAem::Result
+      def get_login_page_wait_until_ready()
+        result = nil
+        with_retries(:max_tries => 30, :base_sleep_seconds => 2, :max_sleep_seconds => 2) { |retries_count|
+          begin
+            result = get_login_page()
+            if result.response.body !~ /QUICKSTART_HOMEPAGE/
+              puts 'Retrieve login page attempt #%d: %s but not ready yet' % [retries_count, result.message]
+              raise StandardError.new(result.message)
+            else
+              puts 'Retrieve login page attempt #%d: %s and ready' % [retries_count, result.message]
+            end
+          rescue RubyAem::Error => err
+            puts 'Retrieve login page attempt #%d: %s' % [retries_count, err.message]
+            raise StandardError.new(err.message)
+          end
+        }
+        result
+      end
+
+    end
+  end
+end

data/lib/ruby_aem/resources/config_property.rb

@@ -38,11 +38,13 @@ module RubyAem
       # Create a new config property.
       #
       # @param run_mode AEM run mode: author or publish
+      # @param node_name the node name under /apps/system/config.{run_mode}/ where the property will be part of
       # @return RubyAem::Result
-      def create(run_mode)
+      def create(run_mode, node_name)
 
         name = RubyAem::Swagger.property_to_parameter(@call_params[:name])
 
+        @call_params[:node_name] = node_name
         @call_params[:run_mode] = run_mode
         @call_params["#{name}".to_sym] = @call_params[:value]
         @call_params["#{name}_type_hint".to_sym] = @call_params[:type]

data/lib/ruby_aem/resources/package.rb

@@ -174,7 +174,7 @@ module RubyAem
         package = packages.xpath("//packages/package[group=\"#{@call_params[:group_name]}\" and name=\"#{@call_params[:package_name]}\" and version=\"#{@call_params[:package_version]}\"]")
         last_unpacked_by = package.xpath('lastUnpackedBy')
 
-        if not ['<lastUnpackedBy/>', '<lastUnpackedBy>null</lastUnpackedBy>'].include? last_unpacked_by.to_s
+        if not ['', '<lastUnpackedBy/>', '<lastUnpackedBy>null</lastUnpackedBy>'].include? last_unpacked_by.to_s
           message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is installed"
           is_installed = true
         else

data/lib/ruby_aem/resources/replication_agent.rb

@@ -40,7 +40,7 @@ module RubyAem
       # @param dest_base_url base URL of the agent target destination, e.g. https://somepublisher:4503
       # @param opts optional parameters:
       # - transport_user: username for transport user, default is admin
-      # - transport_password: username for transport user, default is admin
+      # - transport_password: password for transport user, default is admin
       # - log_level: error, info, debug, default is error
       # - retry_delay: in milliseconds, default is 30000
       # @return RubyAem::Result

data/lib/ruby_aem.rb

@@ -15,6 +15,7 @@ limitations under the License.
 =end
 
 require 'ruby_aem/client'
+require 'ruby_aem/resources/aem'
 require 'ruby_aem/resources/bundle'
 require 'ruby_aem/resources/config_property'
 require 'ruby_aem/resources/flush_agent'
@@ -71,6 +72,13 @@ module RubyAem
       @client = RubyAem::Client.new(apis, spec)
     end
 
+    # Create an AEM instance.
+    #
+    # @return new RubyAem::Resources::Aem instance
+    def aem()
+      RubyAem::Resources::Aem.new(@client)
+    end
+
     # Create a bundle instance.
     #
     # @param name the bundle's name, e.g. com.adobe.cq.social.cq-social-forum

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_aem
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - Shine Solutions
@@ -9,106 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: retries
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: swagger_aem
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.9.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.5
 description: ruby_aem is a Ruby client for Adobe Experience Manager (AEM) API, written
@@ -129,6 +99,7 @@ files:
 - lib/ruby_aem/handlers/json.rb
 - lib/ruby_aem/handlers/simple.rb
 - lib/ruby_aem/handlers/xml.rb
+- lib/ruby_aem/resources/aem.rb
 - lib/ruby_aem/resources/bundle.rb
 - lib/ruby_aem/resources/config_property.rb
 - lib/ruby_aem/resources/flush_agent.rb
@@ -152,12 +123,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []