runcible 0.4.8 → 0.4.9

data/README.md

@@ -108,7 +108,17 @@ To see RestClient logs while testing:
   
     logging=true
 
+## Updating Documentation
 
+The documentation is built with yard and hosted on Github via the gh-pages branch of the repository. To update the documentation on Github:
+
+    yard doc
+    git checkout gh-pages
+    cp -rf doc/* ./
+    git add ./
+    git commit -a -m 'Updating docs to version X.X'
+    git push <upstream> gh-pages
+    
 ## Building and Releasing
 
 ### Gem

data/lib/runcible/base.rb

@@ -48,9 +48,13 @@ module Runcible
         :logging    => {}
       }.merge(conf)
     end
-    
-    def self.config 
-      @@config
+
+    def self.config
+      if defined?(@@config)
+        @@config
+      else
+        raise Runcible::ConfigurationUndefinedError, Runcible::ConfigurationUndefinedError.message
+      end
     end
 
     def self.call(method, path, options={})
@@ -209,4 +213,12 @@ module Runcible
     end
 
   end 
+
+  class ConfigurationUndefinedError < StandardError
+
+    def self.message
+      # override me to change the error message
+      "Configuration not set. Runcible::Base.config= must be called before Runcible::Base.config."
+    end
+  end
 end

data/lib/runcible/extensions/consumer.rb

@@ -30,10 +30,11 @@ module Runcible
       #
       # @param  [String]               id       the consumer ID
       # @param  [String]               repo_id  the repo ID to bind to
+      # @param  [Boolean]              notify_agent sends consumer a notification
       # @return [RestClient::Response]          set of tasks representing each bind operation
-      def self.bind_all(id, repo_id)
+      def self.bind_all(id, repo_id, notify_agent=true)
         Runcible::Extensions::Repository.retrieve_with_details(repo_id)['distributors'].collect do |d|
-          self.bind(id, repo_id, d['id'])
+          self.bind(id, repo_id, d['id'], {:notify_agent=>notify_agent})
         end.flatten
       end
 
@@ -53,9 +54,10 @@ module Runcible
       # @param  [String]               id       the consumer ID
       # @param  [String]               type_id  the type of content to install (e.g. rpm, errata)
       # @param  [Array]                units    array of units to install
+      # @param  [Hash]                 options to pass to content install
       # @return [RestClient::Response]          task representing the install operation
-      def self.install_content(id, type_id, units)
-        self.install_units(id, generate_content(type_id, units))
+      def self.install_content(id, type_id, units, options={})
+        self.install_units(id, generate_content(type_id, units), options)
       end
 
       # Update content on a consumer
@@ -63,9 +65,10 @@ module Runcible
       # @param  [String]               id       the consumer ID
       # @param  [String]               type_id  the type of content to update (e.g. rpm, errata)
       # @param  [Array]                units    array of units to update
+      # @param  [Hash]                 options to pass to content update
       # @return [RestClient::Response]          task representing the update operation
-      def self.update_content(id, type_id, units)
-        self.update_units(id, generate_content(type_id, units))
+      def self.update_content(id, type_id, units, options={})
+        self.update_units(id, generate_content(type_id, units), options)
       end
 
       # Uninstall content from a consumer

data/lib/runcible/resources/consumer.rb

@@ -113,10 +113,11 @@ module Runcible
       # @param  [String]                id              the ID of the consumer
       # @param  [String]                repo_id         the ID of the repository
       # @param  [String]                distributor_id  the ID of the distributor
+      # @param  [Hash]                  optional optional parameters
       # @return [RestClient::Response]
-      def self.bind(id, repo_id, distributor_id)
+      def self.bind(id, repo_id, distributor_id, optional={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
-        call(:post, path("#{id}/bindings/"), :payload => { :required => required })
+        call(:post, path("#{id}/bindings/"), :payload => { :required => required, :optional=>optional })
       end
 
       # Unbind a consumer to a repository for a given distributor

data/lib/runcible/version.rb

@@ -1,3 +1,3 @@
 module Runcible
-  VERSION = "0.4.8"
+  VERSION = "0.4.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runcible
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -95,6 +95,42 @@ dependencies:
     none: false
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: yard
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: maruku
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
 description: Exposing Pulp's juiciest components to the Ruby world.
 email:
 - ehelms@redhat.com, jsherril@redhat.com