runcible 1.2.0 → 1.3.0

data/lib/runcible/resources/consumer_group.rb

@@ -27,22 +27,21 @@ module Runcible
   module Resources
     # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/consumer/group/index.html
     class ConsumerGroup < Runcible::Base
-
       # Generates the API path for Consumer Groups
       #
       # @param  [String]  id  the ID of the consumer group
-      # @return [String]      the consumer group path, may contain the id if passed      
-      def path(id=nil)
-        groups = "consumer_groups/"
+      # @return [String]      the consumer group path, may contain the id if passed
+      def path(id = nil)
+        groups = 'consumer_groups/'
         id.nil? ? groups : groups + "#{id}/"
       end
-      
+
       # Creates a Consumer Group
       #
       # @param  [String]                id        the ID of the consumer
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def create(id, optional={})
+      def create(id, optional = {})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
@@ -69,7 +68,7 @@ module Runcible
       # @param  [Hash]                  criteria  criteria based on Mongo syntax representing consumers to associate
       # @return [RestClient::Response]
       def associate(id, criteria)
-        call(:post, path(id) + "actions/associate/", :payload => {:required => criteria})
+        call(:post, path(id) + 'actions/associate/', :payload => {:required => criteria})
       end
 
       # Unassociates Consumers with a Consumer Group
@@ -78,7 +77,7 @@ module Runcible
       # @param  [Hash]                  criteria  criteria based on Mongo syntax representing consumers ta unassociate
       # @return [RestClient::Response]
       def unassociate(id, criteria)
-        call(:post, path(id) + "actions/unassociate/", :payload => {:required => criteria})
+        call(:post, path(id) + 'actions/unassociate/', :payload => {:required => criteria})
       end
 
       # Install a set of units to a Consumer Group
@@ -87,8 +86,8 @@ module Runcible
       # @param  [Array]                 units   array of units to install
       # @param  [Hash]                  options hash of install options
       # @return [RestClient::Response]
-      def install_units(id, units, options={})
-        required = required_params(binding.send(:local_variables), binding, ["id"])
+      def install_units(id, units, options = {})
+        required = required_params(binding.send(:local_variables), binding, ['id'])
         call(:post, path("#{id}/actions/content/install"), :payload => { :required => required })
       end
 
@@ -98,8 +97,8 @@ module Runcible
       # @param  [Array]                 units   array of units to update
       # @param  [Hash]                  options hash of update options
       # @return [RestClient::Response]
-      def update_units(id, units, options={})
-        required = required_params(binding.send(:local_variables), binding, ["id"])
+      def update_units(id, units, options = {})
+        required = required_params(binding.send(:local_variables), binding, ['id'])
         call(:post, path("#{id}/actions/content/update"), :payload => { :required => required })
       end
 
@@ -109,11 +108,10 @@ module Runcible
       # @param  [Array]                 units   array of units to uninstall
       # @param  [Hash]                  options hash of uninstall options
       # @return [RestClient::Response]
-      def uninstall_units(id, units, options={})
-        required = required_params(binding.send(:local_variables), binding, ["id"])
+      def uninstall_units(id, units, options = {})
+        required = required_params(binding.send(:local_variables), binding, ['id'])
         call(:post, path("#{id}/actions/content/uninstall"), :payload => { :required => required })
       end
-
     end
   end
 end

data/lib/runcible/resources/content.rb

@@ -27,13 +27,12 @@ module Runcible
   module Resources
     # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/content/index.html
     class Content < Runcible::Base
-
       # Generates the API path for Contents
       #
       # @param  [String]  upload_id  the id of the upload_request
       # @return [String]             the content path, may contain the upload_id if passed
-      def upload_path(upload_id=nil)
-        (upload_id == nil) ? "content/uploads/" : "content/uploads/#{upload_id}/"
+      def upload_path(upload_id = nil)
+        (upload_id.nil?) ? 'content/uploads/' : "content/uploads/#{upload_id}/"
       end
 
       # Creates an Upload Request
@@ -59,12 +58,14 @@ module Runcible
       # @param  [String]  repo_id       identifies the associated repository
       # @param  [String]  unit_type_id  identifies the type of unit the upload represents
       # @param  [String]  upload_id     the id of the upload_request returned by create_upload_request
-      # @param  [Object]  unit_key      unique identifier for the new unit; the contents are contingent on the type of unit being uploaded
+      # @param  [Object]  unit_key      unique identifier for the new unit; the contents are contingent
+      #                                  on the type of unit being uploaded
       # @param  [Hash]    optional      container for all optional parameters
       # @return [RestClient::Response]  none
-      def import_into_repo(repo_id, unit_type_id, upload_id,  unit_key, optional={})
+      def import_into_repo(repo_id, unit_type_id, upload_id, unit_key, optional = {})
         required = required_params(binding.send(:local_variables), binding)
-        call(:post, Repository.path("#{repo_id}/actions/import_upload/"), :payload => { :required =>required, :optional => optional })
+        call(:post, Repository.path("#{repo_id}/actions/import_upload/"),
+                                    :payload => { :required => required, :optional => optional })
       end
 
       # Delete an upload request
@@ -79,7 +80,8 @@ module Runcible
       # List all upload requests
       #
       # Query Parameters: None
-      # @return [RestClient::Response]  the list of IDs for all upload requests on the server; empty list if there are none
+      # @return [RestClient::Response]  the list of IDs for all upload requests
+      #                                 on the server; empty list if there are none
       def list_all_requests
         call(:get, upload_path)
       end
@@ -89,7 +91,7 @@ module Runcible
       # @param  [String]  type_id  the type id of the orphaned content
       # @return [String]  the content path, may contain the type_id if passed
       def orphan_path(type_id = nil)
-        path = "content/orphans/"
+        path = 'content/orphans/'
         path << "#{type_id}/" if type_id
         path
       end
@@ -109,8 +111,6 @@ module Runcible
       def remove_orphans(type_id = nil)
         call(:delete, orphan_path(type_id))
       end
-
     end
   end
 end
-

data/lib/runcible/resources/event_notifier.rb

@@ -21,12 +21,10 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-
 module Runcible
   module Resources
     # @see https://pulp-dev-guide.readthedocs.org/en/latest/events/index.html
     class EventNotifier < Runcible::Base
-
       class EventTypes
         REPO_SYNC_COMPLETE    = 'repo.sync.finish'
         REPO_SYNC_START       = 'repo.sync.start'
@@ -42,8 +40,8 @@ module Runcible
       #
       # @param  [String]  id  the ID of the event notifier
       # @return [String]      the event notifier path, may contain the ID if passed
-      def self.path(id=nil)
-        (id == nil) ? "events/" : "events/#{id}/"
+      def self.path(id = nil)
+        (id.nil?) ? 'events/' : "events/#{id}/"
       end
 
       # Creates an Event Notification
@@ -51,7 +49,7 @@ module Runcible
       # @param  [String]                notifier_type_id  the type ID of the event notifier
       # @param  [Hash]                  notifier_config   configuration options for the notifier
       # @param  [Hash]                  event_types       event types to include in the notifier
-      # @return [RestClient::Response]            
+      # @return [RestClient::Response]
       def create(notifier_type_id, notifier_config, event_types)
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => {:required => required})
@@ -60,7 +58,7 @@ module Runcible
       # Deletes an Event Notification
       #
       # @param  [String]                id  the ID of the event notifier
-      # @return [RestClient::Response]            
+      # @return [RestClient::Response]
       def delete(id)
         call(:delete, path(id))
       end
@@ -68,12 +66,10 @@ module Runcible
       # List all Event Notifiers
       #
       # @param  [String]                id  the ID of the event notifier
-      # @return [RestClient::Response]            
+      # @return [RestClient::Response]
       def list
         call(:get, path)
       end
-
     end
   end
 end
-

data/lib/runcible/resources/repository.rb

@@ -31,8 +31,8 @@ module Runcible
       #
       # @param  [String]  id  the id of the repository
       # @return [String]      the repository path, may contain the id if passed
-      def self.path(id=nil)
-        (id == nil) ? "repositories/" : "repositories/#{id}/"
+      def self.path(id = nil)
+        (id.nil?) ? 'repositories/' : "repositories/#{id}/"
       end
 
       # Creates a repository
@@ -40,7 +40,7 @@ module Runcible
       # @param  [String]                id        the id of the repository
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def create(id, optional={})
+      def create(id, optional = {})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
@@ -50,7 +50,7 @@ module Runcible
       # @param  [String]                id      the id of the repository
       # @param  [Hash]                  params  container for optional query parameters
       # @return [RestClient::Response]
-      def retrieve(id, params={})
+      def retrieve(id, params = {})
         call(:get, path(id), :params => params)
       end
 
@@ -59,7 +59,7 @@ module Runcible
       # @param  [String]                id        the id of the repository
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def update(id, optional={})
+      def update(id, optional = {})
         call(:put, path(id), :payload => { :delta => optional })
       end
 
@@ -75,7 +75,7 @@ module Runcible
       #
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def retrieve_all(optional={})
+      def retrieve_all(optional = {})
         call(:get, path, :payload => { :optional => optional })
       end
 
@@ -84,9 +84,9 @@ module Runcible
       # @param  [Hash]                  criteria  criteria object containing Mongo syntax
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def search(criteria, optional={})
+      def search(criteria, optional = {})
         required = required_params(binding.send(:local_variables), binding)
-        call(:post, path("search"), :payload => { :required => required, :optional => optional })
+        call(:post, path('search'), :payload => { :required => required, :optional => optional })
       end
 
       # Associates an importer to a repository
@@ -107,8 +107,8 @@ module Runcible
       # @param  [Hash]                  distributor_config  configuration options for the distributor
       # @param  [Hash]                  optional            container for all optional parameters
       # @return [RestClient::Response]
-      def associate_distributor(id, distributor_type_id, distributor_config, optional={})
-        required = required_params(binding.send(:local_variables), binding, ["id"])
+      def associate_distributor(id, distributor_type_id, distributor_config, optional = {})
+        required = required_params(binding.send(:local_variables), binding, ['id'])
         call(:post, path("#{id}/distributors"), :payload => { :required => required, :optional => optional })
       end
 
@@ -117,7 +117,7 @@ module Runcible
       # @param  [String]                id        the id of the repository
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def sync(id, optional={})
+      def sync(id, optional = {})
         call(:post, "#{path(id)}actions/sync/", :payload => { :optional => optional })
       end
 
@@ -135,8 +135,8 @@ module Runcible
       # @param  [String]                source_repo_id      the id of the source repository
       # @param  [Hash]                  optional            container for all optional parameters
       # @return [RestClient::Response]
-      def unit_copy(destination_repo_id, source_repo_id, optional={})
-        required = required_params(binding.send(:local_variables), binding, ["destination_repo_id"])
+      def unit_copy(destination_repo_id, source_repo_id, optional = {})
+        required = required_params(binding.send(:local_variables), binding, ['destination_repo_id'])
         call(:post, "#{path(destination_repo_id)}actions/associate/",
              :payload => { :required => required, :optional => optional })
       end
@@ -146,8 +146,8 @@ module Runcible
       # @param  [String]                source_repo_id  the id of the source repository
       # @param  [Hash]                  criteria        criteria object containing Mongo syntax
       # @return [RestClient::Response]
-      def unassociate_units(source_repo_id, criteria={})
-        required = required_params(binding.send(:local_variables), binding, ["source_repo_id"])
+      def unassociate_units(source_repo_id, criteria = {})
+        required = required_params(binding.send(:local_variables), binding, ['source_repo_id'])
         call(:post, "#{path(source_repo_id)}actions/unassociate/",
              :payload => { :required => required })
       end
@@ -157,8 +157,8 @@ module Runcible
       # @param  [String]                id        the id of the repository
       # @param  [Hash]                  criteria  criteria object containing Mongo syntax
       # @return [RestClient::Response]
-      def unit_search(id, criteria={})
-        call(:post, "#{path(id)}search/units/", :payload=>{:required=>{:criteria=>criteria}})
+      def unit_search(id, criteria = {})
+        call(:post, "#{path(id)}search/units/", :payload => {:required => {:criteria => criteria}})
       end
 
       # Publishes a repository using the specified distributor
@@ -167,8 +167,9 @@ module Runcible
       # @param  [String]                distributor_id  the id of the distributor
       # @param  [Hash]                  optional  optional params
       # @return [RestClient::Response]
-      def publish(id, distributor_id, optional={})
-        call(:post, "#{path(id)}actions/publish/", :payload=>{:required=>{:id=>distributor_id}, :optional=>optional})
+      def publish(id, distributor_id, optional = {})
+        call(:post, "#{path(id)}actions/publish/",
+             :payload => {:required => {:id => distributor_id}, :optional => optional})
       end
 
       # Deletes the specified distributor from the repository
@@ -187,7 +188,7 @@ module Runcible
       # @param  [Hash]                  distributor_config attributes to change
       # @return [RestClient::Response]
       def update_distributor(id, distributor_id, distributor_config)
-        required = required_params(binding.send(:local_variables), binding, ["id", "distributor_id"])
+        required = required_params(binding.send(:local_variables), binding, ['id', 'distributor_id'])
         call(:put, path("#{id}/distributors/#{distributor_id}/"), :payload => { :required => required})
       end
 
@@ -207,7 +208,7 @@ module Runcible
       # @param  [Hash]                  importer_config  attributes to change
       # @return [RestClient::Response]
       def update_importer(id, importer_id, importer_config)
-        required = required_params(binding.send(:local_variables), binding, ["id", "importer_id"])
+        required = required_params(binding.send(:local_variables), binding, ['id', 'importer_id'])
         call(:put, path("#{id}/importers/#{importer_id}/"), :payload => { :required => required})
       end
 
@@ -216,9 +217,8 @@ module Runcible
       # @param  [Hash]                   options payload representing criteria
       # @return [RestClient::Response]
       def regenerate_applicability(options = {})
-        call(:post, path("actions/content/regenerate_applicability/"), :payload => { :required => options})
+        call(:post, path('actions/content/regenerate_applicability/'), :payload => { :required => options})
       end
-
     end
   end
 end

data/lib/runcible/resources/repository_group.rb

@@ -27,13 +27,12 @@ module Runcible
   module Resources
     # @see https://pulp-dev-guide.readthedocs.org/en/latest/integration/rest-api/repo/groups/
     class RepositoryGroup < Runcible::Base
-
       # Generates the API path for Repository Groups
       #
       # @param  [String]  id  the ID of the Repository group
       # @return [String]      the Repository group path, may contain the id if passed
-      def self.path(id=nil)
-        groups = "repo_groups/"
+      def self.path(id = nil)
+        groups = 'repo_groups/'
         id.nil? ? groups : groups + "#{id}/"
       end
 
@@ -42,7 +41,7 @@ module Runcible
       # @param  [String]                id        the ID of the group
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def create(id, optional={})
+      def create(id, optional = {})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
@@ -76,7 +75,7 @@ module Runcible
       # @param  [Hash]                  criteria  criteria based on Mongo syntax representing repos to associate
       # @return [RestClient::Response]
       def associate(id, criteria)
-        call(:post, path(id) + "actions/associate/", :payload => {:required => criteria})
+        call(:post, path(id) + 'actions/associate/', :payload => {:required => criteria})
       end
 
       # Unassociates Repositories with a Repository Group
@@ -85,9 +84,8 @@ module Runcible
       # @param  [Hash]                  criteria  criteria based on Mongo syntax representing repos ta unassociate
       # @return [RestClient::Response]
       def unassociate(id, criteria)
-        call(:post, path(id) + "actions/unassociate/", :payload => {:required => criteria})
+        call(:post, path(id) + 'actions/unassociate/', :payload => {:required => criteria})
       end
-
     end
   end
 end

data/lib/runcible/resources/repository_schedule.rb

@@ -27,17 +27,16 @@ module Runcible
   module Resources
     # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/repo/sync.html#scheduling-a-sync
     class RepositorySchedule < Runcible::Base
-
       # Generates the API path for Repository Schedules
       #
       # @param  [String]  repo_id     the ID of the repository
       # @param  [String]  importer_id the ID of the importer
       # @param  [String]  schedule_id the ID of the schedule
       # @return [String]              the repository schedule path, may contain the ID of the schedule if passed
-      def self.path(repo_id, importer_id, schedule_id=nil)
+      def self.path(repo_id, importer_id, schedule_id = nil)
         repo_path = Runcible::Resources::Repository.path(repo_id)
         path = "#{repo_path}importers/#{importer_id}/schedules/sync/"
-        (schedule_id == nil) ? path : "#{path}#{schedule_id}/"
+        (schedule_id.nil?) ? path : "#{path}#{schedule_id}/"
       end
 
       # List the schedules for a repository for a given importer type
@@ -56,9 +55,9 @@ module Runcible
       # @param  [Hash]                  schedule      a hash representing a schedule
       # @param  [Hash]                  optional      container for all optional parameters
       # @return [RestClient::Response]
-      def create(repo_id, importer_type, schedule, optional={})
+      def create(repo_id, importer_type, schedule, optional = {})
         call(:post, path(repo_id, importer_type),
-             :payload => { :required => {:schedule=>schedule}, :optional => optional })
+             :payload => { :required => {:schedule => schedule}, :optional => optional })
       end
 
       # Update a schedule for a repository for a given importer type
@@ -68,7 +67,7 @@ module Runcible
       # @param  [String]                schedule_id   the ID of the schedule
       # @param  [Hash]                  optional      container for all optional parameters
       # @return [RestClient::Response]
-      def update(repo_id, importer_type, schedule_id, optional={})
+      def update(repo_id, importer_type, schedule_id, optional = {})
         call(:put, path(repo_id, importer_type, schedule_id),
              :payload => {:optional => optional })
       end
@@ -82,7 +81,6 @@ module Runcible
       def delete(repo_id, importer_type, schedule_id)
         call(:delete, path(repo_id, importer_type, schedule_id))
       end
-
     end
   end
 end

data/lib/runcible/resources/role.rb

@@ -21,27 +21,25 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-
 module Runcible
   module Resources
     # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/role/index.html
     class Role < Runcible::Base
-
       # Generates the API path for Roles
       #
       # @param  [String]  id  the ID of the role
       # @return [String]      the role path, may contain the ID if passed
-      def self.path(id=nil)
-        (id == nil) ? "roles/" : "roles/#{id}/" 
+      def self.path(id = nil)
+        (id.nil?) ? 'roles/' : "roles/#{id}/"
       end
 
       # Adds a user to a role
       #
       # @param  [String]                id    the ID of the role
       # @param  [String]                login the login of the user being added
-      # @return [RestClient::Response]            
+      # @return [RestClient::Response]
       def add(id, login)
-        required = required_params(binding.send(:local_variables), binding, ["id"])
+        required = required_params(binding.send(:local_variables), binding, ['id'])
         call(:post, "#{path(id)}users/", :payload => { :required => required })
       end
 
@@ -49,11 +47,10 @@ module Runcible
       #
       # @param  [String]                id    the ID of the role
       # @param  [String]                login the login of the user being removed
-      # @return [RestClient::Response]            
+      # @return [RestClient::Response]
       def remove(id, login)
         call(:delete, "#{path(id)}users/#{login}/")
       end
-
     end
   end
 end