ruby_aem 0.9.0

data/lib/ruby_aem/package.rb

@@ -0,0 +1,187 @@
+=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
+  # 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::Package instance
+    def initialize(client, group_name, package_name, package_version)
+      @client = client
+      @info = {
+        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, @info)
+    end
+
+    # Update the package with specific filter.
+    #
+    # @param filter package filter JSON string
+    # @return RubyAem::Result
+    def update(filter)
+      @info[:filter] = filter
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Delete the package.
+    #
+    # @return RubyAem::Result
+    def delete()
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Build the package.
+    #
+    # @return RubyAem::Result
+    def build()
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Install the package.
+    #
+    # @return RubyAem::Result
+    def install()
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Replicate the package.
+    # Package will then be added to replication agents.
+    #
+    # @return RubyAem::Result
+    def replicate()
+      @client.call(self.class, __callee__.to_s, @info)
+    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)
+      @info[:file_path] = file_path
+      @client.call(self.class, __callee__.to_s, @info)
+    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
+    # @return RubyAem::Result
+    def upload(file_path, force)
+      @info[:file_path] = file_path
+      @info[:force] = force
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Get the package filter value.
+    # Filter value is stored in result's data.
+    #
+    # @return RubyAem::Result
+    def get_filter()
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Activate all paths within a package filter.
+    #
+    # @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 RubyAem::Result
+    def activate_filter(ignore_deactivated, modified_only)
+      result = get_filter()
+
+      results = [result]
+      result.data.each { |filter_path|
+        path = RubyAem::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, @info)
+    end
+
+    # Check if this package is uploaded.
+    # Success result indicates that the package is uploaded.
+    # Otherwise a failure result indicates that package is not uploaded.
+    #
+    # @return RubyAem::Result
+    def is_uploaded()
+      result = list_all()
+
+      if result.is_success?
+        packages = result.data
+        package = packages.xpath("//packages/package[group=\"#{@info[:group_name]}\" and name=\"#{@info[:package_name]}\" and version=\"#{@info[:package_version]}\"]")
+
+        if package.to_s != ''
+          status = 'success'
+          message = "Package #{@info[:group_name]}/#{@info[:package_name]}-#{@info[:package_version]} is uploaded"
+        else
+          status = 'failure'
+          message = "Package #{@info[:group_name]}/#{@info[:package_name]}-#{@info[:package_version]} is not uploaded"
+        end
+        result = RubyAem::Result.new(status, message)
+        result.data = package
+      end
+
+      result
+    end
+
+    # Check if this package is installed.
+    # Success result indicates that the package is installed.
+    # Otherwise a failure result indicates that package is not installed.
+    #
+    # @return RubyAem::Result
+    def is_installed()
+      result = is_uploaded()
+
+      if result.is_success?
+        package = result.data
+        last_unpacked_by = package.xpath('lastUnpackedBy')
+
+        if not ['<lastUnpackedBy/>', '<lastUnpackedBy>null</lastUnpackedBy>'].include? last_unpacked_by.to_s
+          status = 'success'
+          message = "Package #{@info[:group_name]}/#{@info[:package_name]}-#{@info[:package_version]} is installed"
+        else
+          status = 'failure'
+          message = "Package #{@info[:group_name]}/#{@info[:package_name]}-#{@info[:package_version]} is not installed"
+        end
+        result = RubyAem::Result.new(status, message)
+      end
+
+      result
+    end
+
+  end
+end

data/lib/ruby_aem/path.rb

@@ -0,0 +1,46 @@
+=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
+  # 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::Path instance
+    def initialize(client, name)
+      @client = client
+      @info = {
+        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)
+      @info[:ignoredeactivated] = ignore_deactivated
+      @info[:onlymodified] = only_modified
+
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+  end
+end

data/lib/ruby_aem/replication_agent.rb

@@ -0,0 +1,65 @@
+=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
+  # 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::ReplicationAgent instance
+    def initialize(client, run_mode, name)
+      @client = client
+      @info = {
+        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
+    # @return RubyAem::Result
+    def create_update(title, description, dest_base_url)
+      @info[:title] = title
+      @info[:description] = description
+      @info[:dest_base_url] = dest_base_url
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Delete the replication agent.
+    #
+    # @return RubyAem::Result
+    def delete()
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Check whether the replication agent exists or not.
+    # If the replication agent  exists, this method returns a success result.
+    # Otherwise it returns a failure result.
+    #
+    # @return RubyAem::Result
+    def exists()
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+  end
+end

data/lib/ruby_aem/repository.rb

@@ -0,0 +1,45 @@
+=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
+  # Repository class contains API calls related to managing an AEM repository.
+  class Repository
+
+    # 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
+
+    # Unblock repository writes.
+    #
+    # @return RubyAem::Result
+    def unblock_writes
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+  end
+end

data/lib/ruby_aem/result.rb

@@ -0,0 +1,66 @@
+=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
+  # 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.
+  class Result
+
+    attr_reader :message
+    attr_accessor :data
+
+    # Initialise a result.
+    #
+    # @param status the result status: success, warning, or failure
+    # @param message the result message
+    # @return new RubyAem::Result instance
+    def initialize(status, message)
+      @status = status
+      @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'
+    end
+
+  end
+end

data/lib/ruby_aem/swagger.rb

@@ -0,0 +1,51 @@
+=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
+  # Swagger module contains logic related to swagger_aem.
+  module Swagger
+
+    # Convert ruby_aem spec's operation (consistent with Swagger spec's operationId)
+    # into swagger_aem's generated method name.
+    #
+    # @param operation operation ID
+    # @return swagger_aem method name
+    def Swagger.operation_to_method(operation)
+      operation.gsub(/[A-Z]/) { |char|
+        '_' + char.downcase
+      }
+    end
+
+    # Convert ruby_aem spec's property name (by replacing dots with underscores)
+    # into swagger_aem's generated parameter name.
+    #
+    # @param property property name
+    # @return swagger_aem parameter name
+    def Swagger.property_to_parameter(property)
+      property.gsub(/\./, '_')
+    end
+
+    # Sanitise path value by removing leading and trailing slashes
+    # swagger_aem accepts paths without those slashes.
+    #
+    # @param path path name
+    # @return sanitised path name
+    def Swagger.path(path)
+      path.gsub(/^\//, '').gsub(/\/$/, '')
+    end
+
+  end
+end

data/lib/ruby_aem/user.rb

@@ -0,0 +1,110 @@
+=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
+  # 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::User instance
+    def initialize(client, path, name)
+      @client = client
+      @info = {
+        path: path,
+        name: name
+      }
+    end
+
+    # Create a new user.
+    #
+    # @param password the password of the AEM user
+    # @return RubyAem::Result
+    def create(password)
+      @info[:password] = password
+      if !@info[:path].match(/^\//)
+        @info[:path] = "/#{@info[:path]}"
+      end
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Delete the user.
+    #
+    # @return RubyAem::Result
+    def delete()
+      result = find_authorizable_id
+      if result.data
+        @info[:path] = RubyAem::Swagger.path(@info[:path])
+        @client.call(self.class, __callee__.to_s, @info)
+      else
+        result
+      end
+    end
+
+    # Check whether the user exists or not.
+    # If the user exists, this method returns a success result.
+    # Otherwise it returns a failure result.
+    #
+    # @return RubyAem::Result
+    def exists()
+      @info[:path] = RubyAem::Swagger.path(@info[:path])
+      @client.call(self.class, __callee__.to_s, @info)
+    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)
+      @info[:permission_path] = permission_path
+      @info[:permission_csv] = permission_csv
+      @client.call(self.class, __callee__.to_s, @info)
+    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::Group.new(@client, group_path, group_name)
+      group.add_member(@info[: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)
+      @info[:old_password] = old_password
+      @info[:new_password] = new_password
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Find the user's authorizable ID.
+    #
+    # @return RubyAem::Result
+    def find_authorizable_id()
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+  end
+end