ruby_aem 0.9.0 → 1.0.0

data/lib/ruby_aem.rb

@@ -14,17 +14,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 =end
 
-require 'ruby_aem/bundle'
 require 'ruby_aem/client'
-require 'ruby_aem/config_property'
-require 'ruby_aem/flush_agent'
-require 'ruby_aem/group'
-require 'ruby_aem/node'
-require 'ruby_aem/package'
-require 'ruby_aem/path'
-require 'ruby_aem/replication_agent'
-require 'ruby_aem/repository'
-require 'ruby_aem/user'
+require 'ruby_aem/resources/bundle'
+require 'ruby_aem/resources/config_property'
+require 'ruby_aem/resources/flush_agent'
+require 'ruby_aem/resources/group'
+require 'ruby_aem/resources/node'
+require 'ruby_aem/resources/package'
+require 'ruby_aem/resources/path'
+require 'ruby_aem/resources/replication_agent'
+require 'ruby_aem/resources/repository'
+require 'ruby_aem/resources/user'
 require 'swagger_aem'
 require 'yaml'
 
@@ -74,17 +74,17 @@ module RubyAem
     # Create a bundle instance.
     #
     # @param name the bundle's name, e.g. com.adobe.cq.social.cq-social-forum
-    # @return new RubyAem::Bundle instance
+    # @return new RubyAem::Resources::Bundle instance
     def bundle(name)
-      RubyAem::Bundle.new(@client, name)
+      RubyAem::Resources::Bundle.new(@client, name)
     end
 
     # Create a path instance.
     #
     # @param name the name of the path, e.g. /etc/designs
-    # @return new RubyAem::Path instance
+    # @return new RubyAem::Resources::Path instance
     def path(name)
-      RubyAem::Path.new(@client, name)
+      RubyAem::Resources::Path.new(@client, name)
     end
 
     # Create a config property instance.
@@ -92,36 +92,36 @@ module RubyAem
     # @param name the property's name
     # @param type the property's type, e.g. Boolean
     # @param value the property's value, e.g. true
-    # @return new RubyAem::ConfigProperty instance
+    # @return new RubyAem::Resources::ConfigProperty instance
     def config_property(name, type, value)
-      RubyAem::ConfigProperty.new(@client, name, type, value)
+      RubyAem::Resources::ConfigProperty.new(@client, name, type, value)
     end
 
     # Create a flush agent instance.
     #
     # @param run_mode AEM run mode: author or publish
     # @param name the flush agent's name, e.g. some-flush-agent
-    # @return new RubyAem::FlushAgent instance
+    # @return new RubyAem::Resources::FlushAgent instance
     def flush_agent(name, run_mode)
-      RubyAem::FlushAgent.new(@client, name, run_mode)
+      RubyAem::Resources::FlushAgent.new(@client, name, run_mode)
     end
 
     # Create a group instance.
     #
     # @param path the path to group node, e.g. /home/groups/s/
     # @param name the name of the AEM group, e.g. somegroup
-    # @return new RubyAem::Group instance
+    # @return new RubyAem::Resources::Group instance
     def group(path, name)
-      RubyAem::Group.new(@client, path, name)
+      RubyAem::Resources::Group.new(@client, path, name)
     end
 
     # Create a node instance.
     #
     # @param path the path to the node, e.g. /apps/system/
     # @param name the node name, e.g. somenode
-    # @return new RubyAem::Node instance
+    # @return new RubyAem::Resources::Node instance
     def node(path, name)
-      RubyAem::Node.new(@client, path, name)
+      RubyAem::Resources::Node.new(@client, path, name)
     end
 
     # Create a package instance.
@@ -129,34 +129,34 @@ module RubyAem
     # @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
+    # @return new RubyAem::Resources::Package instance
     def package(group_name, package_name, package_version)
-      RubyAem::Package.new(@client, group_name, package_name, package_version)
+      RubyAem::Resources::Package.new(@client, group_name, package_name, package_version)
     end
 
     # Create a replication agent instance.
     #
     # @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
+    # @return new RubyAem::Resources::ReplicationAgent instance
     def replication_agent(name, run_mode)
-      RubyAem::ReplicationAgent.new(@client, name, run_mode)
+      RubyAem::Resources::ReplicationAgent.new(@client, name, run_mode)
     end
 
     # Create a repository instance.
     #
-    # @return new RubyAem::Repository instance
+    # @return new RubyAem::Resources::Repository instance
     def repository
-      RubyAem::Repository.new(@client)
+      RubyAem::Resources::Repository.new(@client)
     end
 
     # Create a user instance.
     #
     # @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
+    # @return new RubyAem::Resources::User instance
     def user(path, name)
-      RubyAem::User.new(@client, path, name)
+      RubyAem::Resources::User.new(@client, path, name)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_aem
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Shine Solutions
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -40,7 +40,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -102,24 +102,26 @@ extra_rdoc_files: []
 files:
 - conf/spec.yaml
 - lib/ruby_aem.rb
-- lib/ruby_aem/bundle.rb
 - lib/ruby_aem/client.rb
-- lib/ruby_aem/config_property.rb
-- lib/ruby_aem/flush_agent.rb
-- lib/ruby_aem/group.rb
+- lib/ruby_aem/error.rb
 - lib/ruby_aem/handlers/file.rb
 - lib/ruby_aem/handlers/html.rb
 - lib/ruby_aem/handlers/json.rb
 - lib/ruby_aem/handlers/simple.rb
 - lib/ruby_aem/handlers/xml.rb
-- lib/ruby_aem/node.rb
-- lib/ruby_aem/package.rb
-- lib/ruby_aem/path.rb
-- lib/ruby_aem/replication_agent.rb
-- lib/ruby_aem/repository.rb
+- lib/ruby_aem/resources/bundle.rb
+- lib/ruby_aem/resources/config_property.rb
+- lib/ruby_aem/resources/flush_agent.rb
+- lib/ruby_aem/resources/group.rb
+- lib/ruby_aem/resources/node.rb
+- lib/ruby_aem/resources/package.rb
+- lib/ruby_aem/resources/path.rb
+- lib/ruby_aem/resources/replication_agent.rb
+- lib/ruby_aem/resources/repository.rb
+- lib/ruby_aem/resources/user.rb
+- lib/ruby_aem/response.rb
 - lib/ruby_aem/result.rb
 - lib/ruby_aem/swagger.rb
-- lib/ruby_aem/user.rb
 homepage: https://github.com/shinesolutions/ruby_aem
 licenses:
 - Apache 2.0
@@ -140,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: AEM API Ruby client

data/lib/ruby_aem/bundle.rb

@@ -1,48 +0,0 @@
-=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
-  # Bundle class contains API calls related to managing an AEM bundle.
-  class Bundle
-
-    # Initialise a bundle.
-    #
-    # @param client RubyAem::Client
-    # @param name the bundle's name, e.g. com.adobe.cq.social.cq-social-forum
-    # @return new RubyAem::Bundle instance
-    def initialize(client, name)
-      @client = client
-      @info = {
-        name: name
-      }
-    end
-
-    # Start a bundle.
-    #
-    # @return RubyAem::Result
-    def start
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-    # Stop a bundle.
-    #
-    # @return RubyAem::Result
-    def stop
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-  end
-end

data/lib/ruby_aem/config_property.rb

@@ -1,53 +0,0 @@
-=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
-  # ConfigProperty class contains API calls related to managing an AEM config property.
-  class ConfigProperty
-
-    # Initialise a config property
-    #
-    # @param client RubyAem::Client
-    # @param name the property's name
-    # @param type the property's type, e.g. Boolean
-    # @param value the property's value, e.g. true
-    # @return new RubyAem::ConfigProperty instance
-    def initialize(client, name, type, value)
-      @client = client
-      @info = {
-        name: name,
-        type: type,
-        value: value
-      }
-    end
-
-    # Create a new config property.
-    #
-    # @param run_mode AEM run mode: author or publish
-    # @return RubyAem::Result
-    def create(run_mode)
-
-      name = RubyAem::Swagger.property_to_parameter(@info[:name])
-
-      @info[:run_mode] = run_mode
-      @info["#{name}".to_sym] = @info[:value]
-      @info["#{name}_type_hint".to_sym] = @info[:type]
-
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-  end
-end

data/lib/ruby_aem/flush_agent.rb

@@ -1,65 +0,0 @@
-=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
-  # FlushAgent class contains API calls related to managing an AEM flush agent.
-  class FlushAgent
-
-    # Initialise a flush agent.
-    #
-    # @param client RubyAem::Client
-    # @param run_mode AEM run mode: author or publish
-    # @param name the flush agent's name, e.g. some-flush-agent
-    # @return new RubyAem::FlushAgent instance
-    def initialize(client, run_mode, name)
-      @client = client
-      @info = {
-        run_mode: run_mode,
-        name: name
-      }
-    end
-
-    # Create or update a flush agent.
-    #
-    # @param title flush agent title
-    # @param description flush agent description
-    # @param dest_base_url base URL of the agent target destination, e.g. http://somedispatcher:8080
-    # @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 flush agent.
-    #
-    # @return RubyAem::Result
-    def delete()
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-    # Check whether the flush agent exists or not.
-    # If the flush 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/group.rb

@@ -1,101 +0,0 @@
-=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
-  # Group class contains API calls related to managing an AEM group.
-  class Group
-
-    # Initialise a group.
-    #
-    # @param client RubyAem::Client
-    # @param path the path to group node, e.g. /home/groups/s/
-    # @param name the name of the AEM group, e.g. somegroup
-    # @return new RubyAem::Group instance
-    def initialize(client, path, name)
-      @client = client
-      @info = {
-        path: path,
-        name: name
-      }
-    end
-
-    # Create a new group.
-    #
-    # @return RubyAem::Result
-    def create()
-      if !@info[:path].match(/^\//)
-        @info[:path] = "/#{@info[:path]}"
-      end
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-    # Delete the group.
-    #
-    # @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 group exists or not.
-    # If the group 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 group's permission.
-    #
-    # @param permission_path the path that the group's permission is to be set against, e.g. /etc/replication
-    # @param permission_csv comma-separated-values of the group'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 another group as a member of this group.
-    #
-    # @param member the name of the member group to be added
-    # @return RubyAem::Result
-    def add_member(member)
-      result = find_authorizable_id
-      if result.data
-        @info[:member] = member
-        @client.call(self.class, __callee__.to_s, @info)
-      else
-        result
-      end
-    end
-
-    # Find the group's authorizable ID.
-    #
-    # @return RubyAem::Result
-    def find_authorizable_id()
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-  end
-end

data/lib/ruby_aem/node.rb

@@ -1,63 +0,0 @@
-=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
-  # Node class contains API calls related to managing an AEM node.
-  class Node
-
-    # Initialise a node.
-    #
-    # @param client RubyAem::Client
-    # @param path the path to the node, e.g. /apps/system/
-    # @param name the node name, e.g. somenode
-    # @return new RubyAem::Node instance
-    def initialize(client, path, name)
-      @client = client
-      @info = {
-        path: path,
-        name: name
-      }
-
-      @info[:path] = RubyAem::Swagger.path(@info[:path])
-    end
-
-    # Create a new node.
-    #
-    # @param type the node type, e.g. sling:Folder
-    # @return RubyAem::Result
-    def create(type)
-      @info[:type] = type
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-    # Delete the node.
-    #
-    # @return RubyAem::Result
-    def delete()
-      @client.call(self.class, __callee__.to_s, @info)
-    end
-
-    # Check whether the node exists or not.
-    # If the node 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