postini 0.0.2 → 0.0.3

data/History.txt

@@ -1,3 +1,8 @@
+== 0.0.3 2008-08-21
+
+* Added options to allow for the capturing of soap4r wiredumps
+* Added missing validations to domain creation
+
 == 0.0.2 2008-08-19
 
 * Fixed broken code for adding new users, with the most basic of validations

data/PostInstall.txt

@@ -1,7 +1,8 @@
 
-For more information on postini4r, see http://postini4r.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
+For more information on postini4r's postini gem, see 
+http://postini4r.rubyforge.org/postini
 
+Remember to contact your Postini provider, or Postini directly, to gain access
+to the Postini Early Access Program. You'll need a unique API key to make use
+of this gem.
 

data/config/hoe.rb

@@ -64,7 +64,7 @@ $hoe = Hoe.new(GEM_NAME, VERS) do |p|
 
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  #p.extra_deps = EXTRA_DEPENDENCIES
+  p.extra_deps = EXTRA_DEPENDENCIES
 
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
 end

data/lib/postini/domain.rb

@@ -13,7 +13,7 @@ module Postini
       
       # Return an instance of #Domain with all the attributes populated
       def find( domain )
-        remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri )
+        remote = automated_batch_port
         request = Postini::API::AutomatedBatch::Displaydomain.new( Postini.auth, domain )
         response = remote.displaydomain( request )
         domain_record = response.domainRecord
@@ -31,6 +31,12 @@ module Postini
         )
       end
       
+      # Return a remote port with debug enabled if required
+      def automated_batch_port #:nodoc:
+        remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri )
+        remote.wiredump_dev = Postini.soap4r_wiredump_dev if Postini.soap4r_wiredump?
+        remote
+      end
     end
     
     # Setup a new instance with the combination of attributes set
@@ -50,9 +56,10 @@ module Postini
     def create
       return false unless new?
       
-      # TODO: Add missing validations here
+      # TODO: Add improved validations here
+      return false if @name.nil? || @org.nil?
       
-      remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri )
+      remote = automated_batch_port
       args = Postini::API::AutomatedBatch::Adddomainargs.new( @name )
       request = Postini::API::AutomatedBatch::Adddomain.new(
         Postini.auth, @org, args

data/lib/postini/user.rb

@@ -20,7 +20,7 @@ module Postini
       # Return a new instance of the user
       # TODO: Make this take various options just like ActiveRecord
       def find( user )
-        remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri( user ) )
+        remote = automated_batch_port( user )
         request = Postini::API::AutomatedBatch::Displayuser.new( Postini.auth, user )
         response = remote.displayuser( request )
         user_record = response.userRecord
@@ -38,11 +38,18 @@ module Postini
       
       # Permanently remove the user from Postini
       def destroy( address )
-        remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri( address ) )
+        remote = automated_batch_port( address )
         request = Postini::API::AutomatedBatch::Deleteuser.new( Postini.auth, address )
         remote.deleteuser( request )
       end
       
+      # Return a remote port for the address, with debug enabled if required
+      def automated_batch_port( address = nil ) #:nodoc:
+        remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri( address ) )
+        remote.wiredump_dev = Postini.soap4r_wiredump_dev if Postini.soap4r_wiredump?
+        remote
+      end
+      
     end
     
     # Setup a new instance with the combination of attributes set
@@ -64,7 +71,7 @@ module Postini
       # TODO: Add missing validations here
       return false if @address.nil? || @org.nil?
       
-      remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri )
+      remote = automated_batch_port
       args = Postini::API::AutomatedBatch::Adduserargs.new( @org, welcome )
       request = Postini::API::AutomatedBatch::Adduser.new( Postini.auth, @address, args )
       remote.adduser( request )
@@ -80,7 +87,7 @@ module Postini
     # Return the list of aliases for the mailbox
     def aliases
       if @aliases.nil?
-        remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri( @address ) )
+        remote = self.class.automated_batch_port( @address )
         query = Postini::API::AutomatedBatch::ListusersqueryParams.new
         query.aliases = 1
         query.childorgs = 1
@@ -104,7 +111,7 @@ module Postini
     # Add an alias to this user
     def add_alias( address )
       @aliases = nil # clear our cache
-      remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri( @address ) )
+      remote = self.class.automated_batch_port( @address )
       request = Postini::API::AutomatedBatch::Addalias.new( Postini.auth, @address, address )
       remote.addalias( request )
     end
@@ -112,7 +119,7 @@ module Postini
     # Removes the specified alias
     def remove_alias( address )
       @aliases = nil # clear our cache
-      remote = Postini::API::AutomatedBatch::AutomatedBatchPort.new( Postini.endpoint_uri( @address ) )
+      remote = self.class.automated_batch_port( @address )
       request = Postini::API::AutomatedBatch::Deletealias.new( Postini.auth, address )
       remote.deletealias( request )
     end

data/lib/postini/version.rb

@@ -2,7 +2,7 @@ module Postini
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/postini.rb

@@ -8,7 +8,9 @@ require 'postini/domain'
 
 require 'postini/api/endpointresolver/EndpointResolverDriver'
 
-# This module just provides access to configuration details used by the rest of
+# = Configuration
+# 
+#  This module just provides access to configuration details used by the rest of
 # the gem.
 # 
 # Current configuration values are:
@@ -44,10 +46,27 @@ require 'postini/api/endpointresolver/EndpointResolverDriver'
 #   Postini.password = 'secret'
 #   Postini.xauth = 'format_unknown_to_author'
 #
+# = Debugging
+# 
+# Lots to debug when an API is classified as "Early access", here are different
+# controls for setting the debugging verbosity
+# 
+# * logger = Ruby-logger compatibe logger
+# * debug = true/false - Enable more verbose logging
+# * soap4r_wiredump = true/false - Enable soap4r wiredumps
+# * soap4r_wiredump_dev = DEV - Alternative logfile or device for SOAP4R wiredumps
+# 
+# Specify a 'Logger' compatible logging facility in order to use the debug 
+# features of the gem. All the other settings increase the verbosity to varying
+# degrees, and allow you to access some soap4r internals as well.
+#
 module Postini
   
   # On the fly class variable, getter and setter generation...
-  %w{ api_key system_number username password xauth }.each do |config|
+  %w{ 
+    api_key system_number username password xauth
+    logger debug soap4r_debug soap4r_debug_dev soap4r_wiredump soap4r_wiredump_dev
+  }.each do |config|
     class_eval <<-EOF
       @@#{config} = nil
       def self.#{config}=( val )
@@ -59,42 +78,65 @@ module Postini
     EOF
   end
   
-  # Return the appropriate endpoint URI for the service calls. If +user+ is
-  # provided, the endpoint is determined using the Endpoint Resolver Service,
-  # otherwise it is contructed from the +system_number+ configuration value.
-  def self.endpoint_uri( user = nil, service = :automated_batch )
-    raise "System Number not known" if user.nil? && system_number.nil?
+  class << self
     
-    # Translate the service
-    service = case service
-    when :automated_batch
-      [ Postini::API::EndpointResolver::Service::V2AutomatedBatch, "automatedbatch" ]
+    # Return the appropriate endpoint URI for the service calls. If +user+ is
+    # provided, the endpoint is determined using the Endpoint Resolver Service,
+    # otherwise it is contructed from the +system_number+ configuration value.
+    def endpoint_uri( user = nil, service = :automated_batch )
+      raise "System Number not known" if user.nil? && system_number.nil?
+
+      # Translate the service
+      service = case service
+      when :automated_batch
+        [ Postini::API::EndpointResolver::Service::V2AutomatedBatch, "automatedbatch" ]
+      end
+
+      if user.nil?
+        "https://api-s#{system_number}.postini.com/api2/#{service[1]}"
+      else
+        remote = Postini::API::EndpointResolver::EndpointResolverPort.new
+        remote.wiredump_dev = soap4r_wiredump_dev if soap4r_wiredump?
+        
+        request = Postini::API::EndpointResolver::GetServiceEndpoint.new(
+          api_key, user, service[0]
+        )
+        response = remote.getServiceEndpoint( request )
+        response.endpointURI
+      end
+    end
+
+    def auth( service = :automated_batch, username = nil, password = nil, xauth = nil )
+      username ||= self.username
+      password ||= self.password
+      if password.nil?
+        xauth ||= self.xauth
+      end
+
+      case service
+      when :automated_batch
+        API::AutomatedBatch::AuthElem.new(
+          api_key, username, password, xauth
+        )
+      end
     end
     
-    if user.nil?
-      "https://api-s#{system_number}.postini.com/api2/#{service[1]}"
-    else
-      remote = Postini::API::EndpointResolver::EndpointResolverPort.new
-      request = Postini::API::EndpointResolver::GetServiceEndpoint.new(
-        Postini.api_key, user, service[0]
-      )
-      response = remote.getServiceEndpoint( request )
-      response.endpointURI
+    def debug?
+      @@debug ||= false
     end
-  end
-  
-  def self.auth( service = :automated_batch, username = nil, password = nil, xauth = nil )
-    username ||= self.username
-    password ||= self.password
-    if password.nil?
-      xauth ||= self.xauth
+    
+    def soap4r_wiredump?
+      @@soap4r_wiredump ||= false
+    end
+    
+    def logger
+      @@logger ||= Logger.new('/dev/null')
     end
     
-    case service
-    when :automated_batch
-      API::AutomatedBatch::AuthElem.new(
-        api_key, username, password, xauth
-      )
+    def soap4r_wiredump_dev
+      @@soap4r_wiredump_dev ||= soap4r_debug_dev
     end
+    
   end
+  
 end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>postini Gem</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/postini4r"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/postini4r" class="numbers">0.0.1</a>
+      <a href="http://rubyforge.org/projects/postini4r" class="numbers">0.0.3</a>
     </div>
     <h2>Part of the postini4r project</h2>
 <p>The postini4r project is a collection of sub-projects that aim to implement a broad range of Postini-related tools.</p>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: postini
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-19 00:00:00 +02:00
+date: 2008-08-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: soap4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.5.8
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -83,11 +93,12 @@ has_rdoc: true
 homepage: http://postini4r.rubyforge.org
 post_install_message: |+
   
-  For more information on postini4r, see http://postini4r.rubyforge.org
-  
-  NOTE: Change this information in PostInstall.txt 
-  You can also delete it if you don't want it.
+  For more information on postini4r's postini gem, see 
+  http://postini4r.rubyforge.org/postini
   
+  Remember to contact your Postini provider, or Postini directly, to gain access
+  to the Postini Early Access Program. You'll need a unique API key to make use
+  of this gem.
   
 rdoc_options: 
 - --main