ruby_aem 0.9.0 → 1.0.0

data/lib/ruby_aem/resources/package.rb

@@ -0,0 +1,190 @@
+=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
+
+module RubyAem
+  module Resources
+    # Package class contains API calls related to managing an AEM package.
+    class Package
+
+      # Initialise a package.
+      # Package name and version will then be used to construct the package file in the filesystem.
+      # E.g. package name 'somepackage' with version '1.2.3' will translate to somepackage-1.2.3.zip in the filesystem.
+      #
+      # @param client RubyAem::Client
+      # @param group_name the group name of the package, e.g. somepackagegroup
+      # @param package_name the name of the package, e.g. somepackage
+      # @param package_version the version of the package, e.g. 1.2.3
+      # @return new RubyAem::Resources::Package instance
+      def initialize(client, group_name, package_name, package_version)
+        @client = client
+        @call_params = {
+          group_name: group_name,
+          package_name: package_name,
+          package_version: package_version
+        }
+      end
+
+      # Create the package.
+      #
+      # @return RubyAem::Result
+      def create()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Update the package with specific filter.
+      #
+      # @param filter package filter JSON string
+      # example: [{"root":"/apps/geometrixx","rules":[]},{"root":"/apps/geometrixx-common","rules":[]}]
+      # @return RubyAem::Result
+      def update(filter)
+        @call_params[:filter] = filter
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Delete the package.
+      #
+      # @return RubyAem::Result
+      def delete()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Build the package.
+      #
+      # @return RubyAem::Result
+      def build()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Install the package.
+      #
+      # @return RubyAem::Result
+      def install()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Replicate the package.
+      # Package will then be added to replication agents.
+      #
+      # @return RubyAem::Result
+      def replicate()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Download the package to a specified directory.
+      #
+      # @param file_path the directory where the package will be downloaded to
+      # @return RubyAem::Result
+      def download(file_path)
+        @call_params[:file_path] = file_path
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Upload the package.
+      #
+      # @param file_path the directory where the package file to be uploaded is
+      # @param force if true, then overwrite if the package already exists
+      # @param opts optional parameters:
+      # - force: if false then a package file will not be uploaded when the package already exists with the same group, name, and version, default is true (will overwrite existing package file)
+      # @return RubyAem::Result
+      def upload(file_path,
+        opts = {
+          force: true
+        })
+        @call_params[:file_path] = file_path
+        @call_params = @call_params.merge(opts)
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Get the package filter value.
+      # Filter value is stored as result data as an array of paths.
+      #
+      # @return RubyAem::Result
+      def get_filter()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Activate all paths within a package filter.
+      # Returns an array of results:
+      # - the first result is the result from retrieving filter paths
+      # - the rest of the results are the results from activating the filter paths, one result for each activation
+      #
+      # @param ignore_deactivated if true, then deactivated items in the path will not be activated
+      # @param modified_only if true, then only modified items in the path will be activated
+      # @return an array of RubyAem::Result
+      def activate_filter(ignore_deactivated, modified_only)
+        result = get_filter()
+
+        results = [result]
+        result.data.each { |filter_path|
+          path = RubyAem::Resources::Path.new(@client, filter_path)
+          results.push(path.activate(ignore_deactivated, modified_only))
+        }
+        results
+      end
+
+      # List all packages available in AEM instance.
+      #
+      # @return RubyAem::Result
+      def list_all()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Check if this package is uploaded.
+      # True result data indicates that the package is uploaded, false otherwise.
+      #
+      # @return RubyAem::Result
+      def is_uploaded()
+        packages = list_all().data
+        package = packages.xpath("//packages/package[group=\"#{@call_params[:group_name]}\" and name=\"#{@call_params[:package_name]}\" and version=\"#{@call_params[:package_version]}\"]")
+
+        if package.to_s != ''
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is uploaded"
+          is_uploaded = true
+        else
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not uploaded"
+          is_uploaded = false
+        end
+        result = RubyAem::Result.new(message, nil)
+        result.data = is_uploaded
+
+        result
+      end
+
+      # Check if this package is installed.
+      # True result data indicates that the package is installed, false otherwise.
+      #
+      # @return RubyAem::Result
+      def is_installed()
+        packages = list_all().data
+        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
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is installed"
+          is_installed = true
+        else
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not installed"
+          is_installed = false
+        end
+        result = RubyAem::Result.new(message, nil)
+        result.data = is_installed
+
+        result
+      end
+
+    end
+  end
+end

data/lib/ruby_aem/resources/path.rb

@@ -0,0 +1,48 @@
+=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
+
+module RubyAem
+  module Resources
+    # Path class contains API calls related to managing an AEM path.
+    class Path
+
+      # Initialise a path.
+      #
+      # @param client RubyAem::Client
+      # @param name the name of the path, e.g. /etc/designs
+      # @return new RubyAem::Resources::Path instance
+      def initialize(client, name)
+        @client = client
+        @call_params = {
+          name: name
+        }
+      end
+
+      # Activate a path.
+      #
+      # @param ignore_deactivated if true, then deactivated items in the path will not be activated
+      # @param only_modified if true, then only modified items in the path will be activated
+      # @return RubyAem::Result
+      def activate(ignore_deactivated, only_modified)
+        @call_params[:ignoredeactivated] = ignore_deactivated
+        @call_params[:onlymodified] = only_modified
+
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+    end
+  end
+end

data/lib/ruby_aem/resources/replication_agent.rb

@@ -0,0 +1,79 @@
+=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
+
+module RubyAem
+  module Resources
+    # ReplicationAgent class contains API calls related to managing an AEM replication agent.
+    class ReplicationAgent
+
+      # Initialise a replication agent.
+      #
+      # @param client RubyAem::Client
+      # @param run_mode AEM run mode: author or publish
+      # @param name the replication agent's name, e.g. some-replication-agent
+      # @return new RubyAem::Resources::ReplicationAgent instance
+      def initialize(client, run_mode, name)
+        @client = client
+        @call_params = {
+          run_mode: run_mode,
+          name: name
+        }
+      end
+
+      # Create or update a replication agent.
+      #
+      # @param title replication agent title
+      # @param description replication agent description
+      # @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
+      # - log_level: error, info, debug, default is error
+      # - retry_delay: in milliseconds, default is 30000
+      # @return RubyAem::Result
+      def create_update(title, description, dest_base_url,
+        opts = {
+          transport_user: 'admin',
+          transport_password: 'admin',
+          log_level: 'error',
+          retry_delay: 30000
+        })
+        @call_params[:title] = title
+        @call_params[:description] = description
+        @call_params[:dest_base_url] = dest_base_url
+        @call_params = @call_params.merge(opts)
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Delete the replication agent.
+      #
+      # @return RubyAem::Result
+      def delete()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Check whether the replication agent exists or not.
+      # If the replication agent  exists, this method returns a true result data,
+      # false otherwise.
+      #
+      # @return RubyAem::Result
+      def exists()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+    end
+  end
+end

data/lib/ruby_aem/resources/repository.rb

@@ -0,0 +1,47 @@
+=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
+
+module RubyAem
+  module Resources
+    # Repository class contains API calls related to managing an AEM repository.
+    class Repository
+
+      # Initialise repository.
+      #
+      # @param client RubyAem::Client
+      # @return new RubyAem::Resources::Repository instance
+      def initialize(client)
+        @client = client
+        @call_params = {}
+      end
+
+      # Block repository writes.
+      #
+      # @return RubyAem::Result
+      def block_writes
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Unblock repository writes.
+      #
+      # @return RubyAem::Result
+      def unblock_writes
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+    end
+  end
+end

data/lib/ruby_aem/resources/user.rb

@@ -0,0 +1,113 @@
+=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
+
+module RubyAem
+  module Resources
+    # User class contains API calls related to managing an AEM user.
+    class User
+
+      # Initialise a user.
+      #
+      # @param client RubyAem::Client
+      # @param path the path to user node, e.g. /home/users/s/
+      # @param name the username of the AEM user, e.g. someuser, admin, johncitizen
+      # @return new RubyAem::Resources::User instance
+      def initialize(client, path, name)
+        @client = client
+        @call_params = {
+          path: path,
+          name: name
+        }
+      end
+
+      # Create a new user.
+      #
+      # @param password the password of the AEM user
+      # @return RubyAem::Result
+      def create(password)
+        @call_params[:password] = password
+        if !@call_params[:path].match(/^\//)
+          @call_params[:path] = "/#{@call_params[:path]}"
+        end
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Delete the user.
+      #
+      # @return RubyAem::Result
+      def delete()
+        result = find_authorizable_id
+        @call_params[:authorizable_id] = result.data
+        @call_params[:path] = RubyAem::Swagger.path(@call_params[:path])
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Check whether the user exists or not.
+      # If the user exists, this method returns a true result data, false
+      # otherwise.
+      #
+      # @return RubyAem::Result
+      def exists()
+        result = find_authorizable_id
+        @call_params[:authorizable_id] = result.data
+        @call_params[:path] = RubyAem::Swagger.path(@call_params[:path])
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Set the user's permission.
+      #
+      # @param permission_path the path that the user's permission is to be set against, e.g. /etc/replication
+      # @param permission_csv comma-separated-values of the user's permission, e.g. read:true,modify:true
+      # @return RubyAem::Result
+      def set_permission(permission_path, permission_csv)
+        @call_params[:permission_path] = permission_path
+        @call_params[:permission_csv] = permission_csv
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Add user to a group.
+      #
+      # @param group_path the path to group node, e.g. /home/groups/s/
+      # @param group_name the name of the AEM group, e.g. somegroup
+      # @return RubyAem::Result
+      def add_to_group(group_path, group_name)
+        group = RubyAem::Resources::Group.new(@client, group_path, group_name)
+        group.add_member(@call_params[:name])
+      end
+
+      # Change the user's password.
+      #
+      # @param old_password the user's old password to be changed from
+      # @param new_password the user's new password to be changed to
+      # @return RubyAem::Result
+      def change_password(old_password, new_password)
+        @call_params[:old_password] = old_password
+        @call_params[:new_password] = new_password
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Find the user's authorizable ID.
+      # Return authorizable ID as result data, or nil if authorizable ID
+      # cannot be found.
+      #
+      # @return RubyAem::Result
+      def find_authorizable_id()
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+    end
+  end
+end

data/lib/ruby_aem/{repository.rb → response.rb}

@@ -15,30 +15,23 @@ limitations under the License.
 =end
 
 module RubyAem
-  # Repository class contains API calls related to managing an AEM repository.
-  class Repository
+  # Response wraps HTTP response data returned by swagger_aem.
+  class Response
 
-    # Initialise repository.
-    #
-    # @param client RubyAem::Client
-    # @return new RubyAem::Repository instance
-    def initialize(client)
-      @client = client
-      @info = {}
-    end
-
-    # Block repository writes.
-    #
-    # @return RubyAem::Result
-    def block_writes
-      @client.call(self.class, __callee__.to_s, @info)
-    end
+    attr_accessor :status_code
+    attr_accessor :body
+    attr_accessor :headers
 
-    # Unblock repository writes.
+    # Initialise a result.
     #
-    # @return RubyAem::Result
-    def unblock_writes
-      @client.call(self.class, __callee__.to_s, @info)
+    # @param status_code HTTP status code
+    # @param body HTTP response body
+    # @param headers HTTP headers
+    # @return new RubyAem::Response instance
+    def initialize(status_code, body, headers)
+      @status_code = status_code
+      @body = body
+      @headers = headers
     end
 
   end

data/lib/ruby_aem/result.rb

@@ -15,51 +15,27 @@ limitations under the License.
 =end
 
 module RubyAem
-  # Result represents the result of a client call.
-  #
-  # It has 3 statuses: success, warning, and failure.
-  # A success indicates that the client call was completed successfully.
-  # A failure indicates that the client call was completed but it failed with error.
-  # A warning indicates that the client call was completed but with warnings.
-  #
-  # Result message is stored in message attribute.
-  #
-  # Some client calls respond with data payload, which is stored in data attribute.
+  # Result class represents the result of a client call.
+  # It contains the following attributes:
+  # - message: a message string containing the description of the result
+  # - response: a RubyAem::Response response from AEM
+  # - data: the data payload, which can be of any type depending on the API call
+  # e.g. is_* and exists method provide result with boolean data.
+  # Some API calls result doesn't contain any data.
   class Result
 
     attr_reader :message
+    attr_reader :response
     attr_accessor :data
 
     # Initialise a result.
     #
-    # @param status the result status: success, warning, or failure
-    # @param message the result message
+    # @param message result message
+    # @param response HTTP response
     # @return new RubyAem::Result instance
-    def initialize(status, message)
-      @status = status
+    def initialize(message, response)
       @message = message
-    end
-
-    # Check whether the client call was successful.
-    #
-    # @return true when the status is success
-    def is_success?
-      return @status == 'success'
-    end
-
-    # Check whether the client call was completed
-    # with warnings.
-    #
-    # @return true when the status is warning
-    def is_warning?
-      return @status == 'warning'
-    end
-
-    # Check whether the client call failed.
-    #
-    # @return true when the status is failure
-    def is_failure?
-      return @status == 'failure'
+      @response = response
     end
 
   end