postini 0.0.6 → 0.1.0

data/lib/postini.rb

@@ -3,145 +3,117 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 # requirements
 require 'rubygems'
-gem 'soap4r', '=1.5.8'
-unless defined?( ActiveSupport )
-  gem 'activesupport', '>=2.0.2'
-end
-require 'postini/helpers'
-require 'postini/user'
-require 'postini/domain'
+require 'handsoap'
 
-require 'postini/api/endpointresolver/EndpointResolverDriver'
+require 'postini/exceptions'
 
 # = Configuration
-# 
-#  This module just provides access to configuration details used by the rest of
+#
+# This module just provides access to configuration details used by the rest of
 # the gem.
-# 
+#
 # Current configuration values are:
 # * api_key
 # * system_number
 # * username
 # * password
-# * xauth
-# 
+#
 # The +api_key+ is your unique API keys obtained from Postini via their Early
 # Access program.
-# 
+#
 #   Postini.api_key = "your48characterkey"
-# 
+#
 # The +system_number+ can be any known system number (known to your account).
-# The gem uses the Postini Endpoint Resolver service, but in some cases needs a 
-# known system to work from. Refer to the "Locating Your System" section of the 
+# The gem uses the Postini Endpoint Resolver service, but in some cases needs a
+# known system to work from. Refer to the "Locating Your System" section of the
 # Early Access documentation for more information.
-# 
+#
 #   Postini.system_number = 8
-# 
+#
 # The +username+ parameter is required if:
 # 1. Your org is using POP authentication, and thus needs the admin user's
 # authentication details, not the end-user's.
-# 2. You omit the optional username and password/xauth string for the request
-# 
+# 2. You omit the optional username and password string for the request
+#
 #   Postini.username = 'administrat@jumboinc.com'
-# 
-# The +password+ and +xauth+ parameters are mutually exclusive, and cannot be
-# used together. This library will use the +password+ if present, ignoring the
-# +xauth+ string alltogether.
-# 
+#
+# The +password+ parameter is require if:
+# 1. Your org is using POP authentication, and thus needs the admin
+# user's authentication details, not the end-users's.
+# 2. You can omit the optional username and password arguments for a
+# specific request.
+#
 #   Postini.password = 'secret'
-#   Postini.xauth = 'format_unknown_to_author'
+#
+# All of the above configurations can either be preloaded from a yaml
+# file or environment variables. Create a yaml file with the following
+# structure:
+#
+#   api_key:
+#   system_number:
+#   username:
+#   password:
+#
+# And call +Postini.configure!('/path/to/file.yml')+ to load the
+# values. Alternatively you can set the following environment variables
+# and call +Postini.configure!+ without a path.
+#
+#   POSTINI_API_KEY
+#   POSTINI_SYSTEM_NUMBER
+#   POSTINI_USERNAME
+#   POSTINI_PASSWORD
 #
 # = 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 
+#
+# 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
-    logger debug soap4r_wiredump soap4r_wiredump_dev
-  }.each do |config|
-    class_eval <<-EOF
-      @@#{config} = nil
-      def self.#{config}=( val )
-        @@#{config} = val
-      end
-      def self.#{config}
-        @@#{config}
-      end
-    EOF
-  end
-  
+  VERSION = "0.1.0"
+
+  autoload :ConfigurationCheck,      "postini/configuration_check"
+  autoload :Endpoints,               "postini/endpoints"
+  autoload :EndpointResolverService, "postini/endpoint_resolver_service"
+  autoload :AutomatedBatchService,   "postini/automated_batch_service"
+
+  # Don't debug by default
+  @debug = false
+
   class << self
-    
-    # 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
+    attr_accessor :api_key, :system_number, :username, :password, :debug, :logger
 
-      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
+    def configured? #:nodoc:
+      !self.api_key.nil? &&
+        !self.system_number.nil? &&
+        !self.username.nil? &&
+        !self.password.nil?
     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
+    # Configure the library from yaml configuration file or
+    # environment variables
+    def configure!( yaml = nil )
+      data = if yaml
+               YAML.load_file( yaml )
+             else
+               {
+                 'api_key' => ENV['POSTINI_API_KEY'],
+                 'system_number' => ENV['POSTINI_SYSTEM_NUMBER'],
+                 'username' => ENV['POSTINI_USERNAME'],
+                 'password' => ENV['POSTINI_PASSWORD']
+               }
+             end
 
-      case service
-      when :automated_batch
-        API::AutomatedBatch::AuthElem.new(
-          api_key, username, password, xauth
-        )
+      data.each do |k,v|
+        self.send( "#{k}=", v )
       end
     end
-    
-    def debug?
-      @@debug ||= false
-    end
-    
-    def soap4r_wiredump?
-      @@soap4r_wiredump ||= false
-    end
-    
-    def logger
-      @@logger ||= Logger.new('/dev/null')
-    end
-    
-    def soap4r_wiredump_dev
-      @@soap4r_wiredump_dev ||= logger
-    end
-    
   end
-  
 end

data/script/console

@@ -7,4 +7,4 @@ libs =  " -r irb/completion"
 # libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
 libs <<  " -r #{File.dirname(__FILE__) + '/../lib/postini.rb'}"
 puts "Loading postini gem"
-exec "#{irb} #{libs} --simple-prompt"
+exec "#{irb} #{libs} --simple-prompt"

data/script/txt2html

@@ -1,27 +1,16 @@
 #!/usr/bin/env ruby
 
-GEM_NAME = 'postini' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'postini4r'
-
-require 'rubygems'
-begin
-  require 'newgem'
-  require 'rubyforge'
-rescue LoadError
-  puts "\n\nGenerating the website requires the newgem RubyGem"
-  puts "Install: gem install newgem\n\n"
-  exit(1)
-end
+load File.dirname(__FILE__) + "/../Rakefile"
+require 'rubyforge'
 require 'redcloth'
 require 'syntax/convertors/html'
 require 'erb'
-require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
 
-version  = Postini::VERSION::STRING
-download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+download = "http://rubyforge.org/projects/#{$hoe.rubyforge_name}"
+version  = $hoe.version
 
 def rubyforge_project_id
-  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+  RubyForge.new.configure.autoconfig["group_ids"][$hoe.rubyforge_name]
 end
 
 class Fixnum

data/spec/exceptions_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Remote exception handling" do
+  it "should parse the reason" do
+    reason = "StatusException:  You specified 'false' to the test operation - we have raised an exception as you have requested. () (Request ID B7BBF9D8-56D3-11DE-A949-FAAF5903FD3E)"
+
+    exception = Postini::RemoteException.new( reason )
+    exception.type.should == "StatusException"
+    exception.message.should == "You specified 'false' to the test operation - we have raised an exception as you have requested. ()"
+    exception.request_id.should == "B7BBF9D8-56D3-11DE-A949-FAAF5903FD3E"
+  end
+
+  it "should delegate the exception correctly" do
+    reason = "StatusException:  You specified 'false' to the test operation - we have raised an exception as you have requested. () (Request ID B7BBF9D8-56D3-11DE-A949-FAAF5903FD3E)"
+
+    exception = Postini::RemoteException.delegate( reason )
+    exception.should be_a_kind_of( Postini::StatusException )
+  end
+end

data/spec/postini_spec.rb

@@ -1,58 +1,25 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe "Postini master module" do
-  
+
   it "must allow for setting the API Access Key" do
     Postini.api_key = "1234567890"
     Postini.api_key.should eql("1234567890")
   end
-  
+
   it "must allow for setting the system number" do
     Postini.system_number = 200
     Postini.system_number.should be(200)
   end
-  
+
   it "must allow for setting a username" do
     Postini.username = 'administrator@jumboinc.com'
     Postini.username.should eql('administrator@jumboinc.com')
   end
-  
+
   it "must allow for setting a password" do
     Postini.password = 'secret'
     Postini.password.should eql('secret')
   end
-  
-  it "must allow for setting a XAuth string" do
-    Postini.xauth = 'format_unknown_to_author'
-    Postini.xauth.should eql('format_unknown_to_author')
-  end
-  
-  it "should return a pre-built URI if no user is provided" do
-    Postini.system_number = 0
-    Postini.endpoint_uri.should eql('https://api-s0.postini.com/api2/automatedbatch')
-  end
-  
-  it "should use the Endpoint Resolver service if a user is provided" do
-    mock_remote = Postini::API::EndpointResolver::EndpointResolverPort.new
-    mock_remote.expects( :getServiceEndpoint ).with(anything).returns(
-      OpenStruct.new( :endpointURI => 'https://api-s0.postini.com/api2/automatedbatch' )
-    )
-    Postini::API::EndpointResolver::EndpointResolverPort.expects(:new).returns(mock_remote)
-    
-    Postini.endpoint_uri( 'support@jumboinc.com' ).should eql('https://api-s0.postini.com/api2/automatedbatch')
-    
-    pending "IMPROVE"
-  end
-  
-  it "should generate auth elements without user details" do
-    pending
-  end
-  
-  it "should generate auth elements with username and passwords" do
-    pending
-  end
-  
-  it "should generate auth elements with usernames and xauth strings" do
-    pending
-  end
+
 end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*,gems/*"

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 begin
   require 'spec'
 rescue LoadError
-  require 'rubygems'
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
   gem 'rspec'
   require 'spec'
 end

data/tasks/rspec.rake

@@ -1,7 +1,7 @@
 begin
   require 'spec'
 rescue LoadError
-  require 'rubygems'
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
   require 'spec'
 end
 begin
@@ -19,21 +19,3 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
   t.spec_files = FileList['spec/**/*_spec.rb']
 end
-
-namespace :spec do
-  desc "Print Specdoc for all specs (excluding plugin specs)"
-  Spec::Rake::SpecTask.new(:doc) do |t|
-    t.spec_opts = ["--format", "specdoc", "--dry-run"]
-    t.spec_files = FileList['spec/**/*_spec.rb']
-  end
-  
-  desc "Run all specs in spec directory with RCov (excluding plugin specs)"
-  Spec::Rake::SpecTask.new(:rcov) do |t|
-    t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/../spec/spec.opts\""]
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.rcov = true
-    t.rcov_opts = lambda do
-      IO.readlines("#{File.dirname(__FILE__)}/../spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
-    end
-  end
-end

data/vendor/automatedbatch.wsdl

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- Originating Build y6_14_9c0, y6_14_9c0, Thu May 22 11:20:45 PDT 2008-->
+<!-- Originating Build y6_19_0c21, y6_19_0c21, Tue May 19 19:02:18 PDT 2009-->
 
 <wsdl:definitions
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: postini
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -9,28 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-24 00:00:00 +02:00
+date: 2009-06-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
-  type: :runtime
+  name: newgem
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.2
-    version: 
-- !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: 1.4.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -42,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: Ruby wrapper around the Postini SOAP API (Early Access Program)
+description: A Ruby wrapper library to make the Postini SOAP API more palatable.  Postini is the world leader in email message scanning, filtering and archiving. This library provides users of Postini with a convenient Ruby library that  exposes the Postini SOAP API (Early Access Program) through more familiar Rubyisms.
 email: 
 - kenneth.kalmer@gmail.com
 executables: []
@@ -55,7 +45,6 @@ extra_rdoc_files:
 - Manifest.txt
 - PostInstall.txt
 - README.txt
-- website/index.txt
 files: 
 - History.txt
 - License.txt
@@ -64,58 +53,36 @@ files:
 - README.txt
 - Rakefile
 - TODO
-- config/hoe.rb
-- config/requirements.rb
+- features/development.feature
+- features/step_definitions/common_steps.rb
+- features/support/common.rb
+- features/support/env.rb
+- features/support/matchers.rb
 - lib/postini.rb
-- lib/postini/api.rb
-- lib/postini/api/automatedbatch/AutomatedBatch.rb
-- lib/postini/api/automatedbatch/AutomatedBatchDriver.rb
-- lib/postini/api/automatedbatch/AutomatedBatchMappingRegistry.rb
-- lib/postini/api/automatedbatch/AutomatedBatchServiceClient.rb
-- lib/postini/api/endpointresolver/EndpointResolver.rb
-- lib/postini/api/endpointresolver/EndpointResolverDriver.rb
-- lib/postini/api/endpointresolver/EndpointResolverMappingRegistry.rb
-- lib/postini/api/endpointresolver/EndpointResolverServiceClient.rb
-- lib/postini/domain.rb
-- lib/postini/helpers.rb
-- lib/postini/helpers/attributes.rb
-- lib/postini/user.rb
-- lib/postini/users/aliases.rb
-- lib/postini/version.rb
+- lib/postini/automated_batch_service.rb
+- lib/postini/configuration_check.rb
+- lib/postini/endpoint_resolver_service.rb
+- lib/postini/endpoints.rb
+- lib/postini/exceptions.rb
 - script/console
 - script/destroy
 - script/generate
 - script/txt2html
 - setup.rb
-- spec/attribute_helper_spec.rb
-- spec/domain_spec.rb
+- spec/exceptions_spec.rb
 - spec/postini_spec.rb
+- spec/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/user_spec.rb
 - tasks/deployment.rake
 - tasks/environment.rake
 - tasks/rspec.rake
 - tasks/website.rake
 - vendor/automatedbatch.wsdl
 - vendor/endpointresolver.wsdl
-- website/index.html
-- website/index.txt
-- website/javascripts/rounded_corners_lite.inc.js
-- website/spam_box.png
-- website/stylesheets/screen.css
-- website/template.html.erb
 has_rdoc: true
-homepage: http://postini4r.rubyforge.org
-post_install_message: |+
-  
-  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.
-  
+homepage: http://postini4r.rubyforge.org/
+post_install_message: PostInstall.txt
 rdoc_options: 
 - --main
 - README.txt
@@ -139,6 +106,6 @@ rubyforge_project: postini4r
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Ruby wrapper around the Postini SOAP API (Early Access Program)
+summary: A Ruby wrapper library to make the Postini SOAP API more palatable
 test_files: []
 

data/config/hoe.rb

@@ -1,76 +0,0 @@
-require 'postini/version'
-
-AUTHOR = 'Kenneth Kalmer'  # can also be an array of Authors
-EMAIL = "kenneth.kalmer@gmail.com"
-DESCRIPTION = "Ruby wrapper around the Postini SOAP API (Early Access Program)"
-GEM_NAME = 'postini' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'postini4r' # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
-EXTRA_DEPENDENCIES = [
-  ['activesupport', '>=2.0.2'],
-  ['soap4r', '=1.5.8']
-]    # An array of rubygem dependencies [name, version]
-
-@config_file = "~/.rubyforge/user-config.yml"
-@config = nil
-RUBYFORGE_USERNAME = "kennethkalmer"
-def rubyforge_username
-  unless @config
-    begin
-      @config = YAML.load(File.read(File.expand_path(@config_file)))
-    rescue
-      puts <<-EOS
-ERROR: No rubyforge config file found: #{@config_file}
-Run 'rubyforge setup' to prepare your env for access to Rubyforge
- - See http://newgem.rubyforge.org/rubyforge.html for more details
-      EOS
-      exit
-    end
-  end
-  RUBYFORGE_USERNAME.replace @config["username"]
-end
-
-
-REV = nil
-# UNCOMMENT IF REQUIRED:
-# REV = YAML.load(`svn info`)['Revision']
-VERS = Postini::VERSION::STRING + (REV ? ".#{REV}" : "")
-RDOC_OPTS = ['--quiet', '--title', 'postini documentation',
-    "--opname", "index.html",
-    "--line-numbers",
-    "--main", "README",
-    "--inline-source",
-    "--exclude", "*.wsdl"
-    ]
-
-class Hoe
-  def extra_deps
-    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
-    @extra_deps
-  end
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.developer(AUTHOR, EMAIL)
-  p.description = DESCRIPTION
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test_*.rb"]
-  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
-
-  # == Optional
-  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.extra_deps = EXTRA_DEPENDENCIES
-
-  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
-end
-
-CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
-PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
-$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
-$hoe.rsync_args = '-av --delete --ignore-errors'
-$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -1,15 +0,0 @@
-require 'fileutils'
-include FileUtils
-
-require 'rubygems'
-%w[rake hoe newgem rubigen].each do |req_gem|
-  begin
-    require req_gem
-  rescue LoadError
-    puts "This Rakefile requires the '#{req_gem}' RubyGem."
-    puts "Installation: gem install #{req_gem} -y"
-    exit
-  end
-end
-
-$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))