postini 0.1.1 → 0.2.0pre

data/.gitignore

@@ -0,0 +1,7 @@
+nbproject
+pkg
+doc
+vendor/troelskn-handsoap-*
+*.swp
+.yardoc
+pkg

data/README.txt

@@ -13,7 +13,7 @@ Rubyisms.
 
 == FEATURES/PROBLEMS:
 
-* Built on top of handsoap[http://github.com/troelskn/handsoap], to
+* Built on top of handsoap[http://github.com/unwire/handsoap], to
   provide a lite hash-based interface to an otherwise crap API.
 
 == SYNOPSIS:
@@ -29,12 +29,15 @@ Rubyisms.
 
 * Approved access to the Postini Early Access Program (contact your Postini
   provider)
-* handsoap[http://github.com/troelskn/handsoap]
+* handsoap[http://github.com/unwire/handsoap]
+* nokogiri[http://nokogiri.org]
+* curb[http://github.com/taf2/curb]
 
 == INSTALL:
 
-* sudo gem install troelskn-handsoap --source http://gems.github.com
-* sudo gem install postini
+The postini gem is available on Gemcutter[http://gemcutter.org]
+
+* gem install postini
 
 == TRADEMARKS:
 

data/Rakefile

@@ -1,29 +1,38 @@
-require 'rubygems' unless ENV['NO_RUBYGEMS']
-%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/postini'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('postini', Postini::VERSION) do |p|
-  p.developer('Kenneth Kalmer', 'kenneth.kalmer@gmail.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = 'postini4r' # TODO this is default value
-  # p.extra_deps         = [
-  #   ['activesupport','>= 2.0.2'],
-  # ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'postini'
+    gemspec.version = Postini::VERSION
+    gemspec.summary = 'Library to make the Postini SOAP API more palatable'
+    gemspec.description = 'Library to make the Postini SOAP API more palatable'
+    gemspec.email = 'kenneth.kalmer@gmail.com'
+    gemspec.homepage = 'http://postini4r.rubyforge.org'
+    gemspec.authors = ['kenneth.kalmer@gmail.com']
+    gemspec.post_install_message = IO.read('PostInstall.txt')
+    gemspec.extra_rdoc_files.include '*.txt'
+
+    gemspec.add_dependency 'handsoap'
+    gemspec.add_dependency 'curb'
+    gemspec.add_dependency 'nokogiri'
+    gemspec.add_development_dependency 'rspec'
+    gemspec.add_development_dependency 'cucumber'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with 'gem install jeweler'"
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  desc "Build YARD documentation"
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]

data/config/website.yml

@@ -0,0 +1,2 @@
+host: kennethkalmer@rubyforge.org
+remote_dir: /var/www/gforge-projects/kit/postini4r/postini

data/lib/postini/automated_batch_service.rb

@@ -202,6 +202,46 @@ module Postini
     end
     requires_configured :display_user
 
+    # Return a list of orgs, possibly filtered and sorted. Refer to the Postini
+    # Automated Batch Service Manual for an explanation of each field.
+    #
+    # Possible options are:
+    #
+    # :targetOrg => string
+    # :childorgs => boolean
+    # :sort => string
+    # :fields => array (strings)
+    # :start => integer
+    # :end => integer
+    #
+    # Postini will return a maximum of 15,000 results
+    def list_orgs( query_string = 'ALL', options = {} )
+      valid_options = {}
+
+      # vanilla copes
+      [ :targetOrg, :sort, :start, :end ].each do |k|
+        valid_options[k] = options[k] if options.has_key?(k)
+      end
+
+      # boolean copies
+      valid_options[:childorgs] = ( options[:childorgs] ? '1' : '0' ) if options.has_key?(:childorgs)
+
+      valid_options[:fields] = options[:fields].join('|') if options.has_key?(:fields)
+
+      response = invoke("aut:listorgs") do |message|
+        build_auth!( message )
+        message.add('queryString', query_string)
+        message.add('queryParams') do |q|
+          valid_options.each do |k,v|
+            q.add( k.to_s, v )
+          end
+        end
+      end
+
+      parse_list_orgs_results( response.document.xpath('//tns:listorgsResponse', tns).first )
+    end
+    requires_configured :list_orgs
+
     # Return a list of users, possibly filtered and sorted. Refer to
     # the Postini Automated Batch Service Manual for an explanation of
     # each field.
@@ -514,6 +554,94 @@ module Postini
       data
     end
 
+    def parse_list_orgs_results( node )
+      # <tns:listorgsResponse>
+      #   <org>
+      #     <approved_senders>
+      #     <archive>
+      #     <async_bounce>
+      #     <at_notify_on>
+      #     <authentication_data>
+      #     <authentication_type>
+      #     <autocreate_smtp>
+      #     <autocreate_web>
+      #     <blatant_spam>
+      #     <blocked_senders>
+      #     <bounce_fragments>
+      #     <company_name>
+      #     <create_method>
+      #     <created_date>
+      #     <creator>
+      #     <default_message_limit>
+      #     <default_user>
+      #     <disable_first_spam>
+      #     <disposition_virus>
+      #     <ext_encrypt>
+      #     <footer_on>
+      #     <iid>
+      #     <im_enable>
+      #     <im_external_enable>
+      #     <im_proto_enable>
+      #     <is_email_config>
+      #     <lang_locale>
+      #     <lastmod_date>
+      #     <max_message_size>
+      #     <ndr>
+      #     <non_account_bounce>
+      #     <non_account_virus_scan>
+      #     <orgname>
+      #     <out_at_notify_on>
+      #     <outbound_max_message_size>
+      #     <outbound_virus>
+      #     <outbound_virus_disposition>
+      #     <parent_org>
+      #     <qsum_actionable>
+      #     <qsum_enable>
+      #     <qtine_redir_atq>
+      #     <qtine_redir_ndr>
+      #     <qtine_redir_out_atq>
+      #     <qtine_redir_out_virus>
+      #     <qtine_redir_spam>
+      #     <qtine_redir_virus>
+      #     <quarantine_links>
+      #     <remotecmd_secret>
+      #     <spam_notify_on>
+      #     <support_contact>
+      #     <tagonly_spam>
+      #     <timezone>
+      #     <tls_notify_admin>
+      #     <tls_notify_on>
+      #     <virus_clean>
+      #     <virus_notify>
+      #     <welcome_on>
+      #     <zero_hour_notify_on>
+      #     <zero_hour_scan>
+      #     <zero_hour_waiver>
+      #   </org>
+      #   <org>
+      #     ...
+      #   </org>
+      # </tns:listusersResponse>
+
+      data = {}
+
+      node.xpath('./org').each do |org|
+
+        name = org.xpath('./orgname/text()').to_s
+        fields = {}
+
+        org.children.each do |field|
+          next if field.node_name == 'orgname'
+
+          fields[ field.node_name.to_sym ] = field.to_s
+        end
+
+        data[ name ] = fields
+      end
+
+      data
+    end
+
     def parse_list_users_results( node )
       # <tns:listusersResponse>
       #   <user>
@@ -525,7 +653,7 @@ module Postini
       #   </user>
       #   <user>
       #     ...
-      #   </user
+      #   </user>
       # </tns:listusersResponse>
 
       data = {}
@@ -536,9 +664,9 @@ module Postini
         fields = {}
 
         user.children.each do |field|
-          next if field.name == 'address'
+          next if field.node_name == 'address'
 
-          fields[ field.name.to_sym ] = field.content
+          fields[ field.node_name.to_sym ] = field.to_s
         end
 
         data[ address ] = fields

data/lib/postini.rb

@@ -3,6 +3,8 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 # requirements
 require 'rubygems'
+require 'curb'
+require 'nokogiri'
 require 'handsoap'
 
 require 'postini/exceptions'
@@ -76,7 +78,7 @@ require 'postini/exceptions'
 # degrees, and allow you to access some soap4r internals as well.
 #
 module Postini
-  VERSION = "0.1.1"
+  VERSION = "0.2.0pre"
 
   autoload :ConfigurationCheck,      "postini/configuration_check"
   autoload :Endpoints,               "postini/endpoints"
@@ -92,9 +94,9 @@ module Postini
 
     def configured? #:nodoc:
       !self.api_key.nil? &&
-        !self.system_number.nil? &&
-        !self.username.nil? &&
-        !self.password.nil?
+      !self.system_number.nil? &&
+      !self.username.nil? &&
+      !self.password.nil?
     end
 
     # Configure the library from yaml configuration file or
@@ -114,6 +116,9 @@ module Postini
       data.each do |k,v|
         self.send( "#{k}=", v )
       end
+
+      # Cope with trans-continental links
+      Handsoap.timeout = 300
     end
   end
 end

data/postini.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{postini}
+  s.version = "0.2.0pre"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kenneth.kalmer@gmail.com"]
+  s.date = %q{2010-09-27}
+  s.description = %q{Library to make the Postini SOAP API more palatable}
+  s.email = %q{kenneth.kalmer@gmail.com}
+  s.extra_rdoc_files = [
+    "History.txt",
+     "License.txt",
+     "PostInstall.txt",
+     "README.txt",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "License.txt",
+     "PostInstall.txt",
+     "README.txt",
+     "Rakefile",
+     "TODO",
+     "config/website.yml",
+     "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/automated_batch_service.rb",
+     "lib/postini/configuration_check.rb",
+     "lib/postini/endpoint_resolver_service.rb",
+     "lib/postini/endpoints.rb",
+     "lib/postini/exceptions.rb",
+     "postini.gemspec",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "script/txt2html",
+     "spec/exceptions_spec.rb",
+     "spec/postini_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/rspec.rake",
+     "vendor/automatedbatch.wsdl",
+     "vendor/endpointresolver.wsdl",
+     "website/index.txt",
+     "website/javascripts/rounded_corners_lite.inc.js",
+     "website/spam_box.png",
+     "website/stylesheets/screen.css",
+     "website/template.html.erb"
+  ]
+  s.homepage = %q{http://postini4r.rubyforge.org}
+  s.post_install_message = %q{
+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.
+
+}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Library to make the Postini SOAP API more palatable}
+  s.test_files = [
+    "spec/exceptions_spec.rb",
+     "spec/postini_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<handsoap>, [">= 0"])
+      s.add_runtime_dependency(%q<curb>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<handsoap>, [">= 0"])
+      s.add_dependency(%q<curb>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<handsoap>, [">= 0"])
+    s.add_dependency(%q<curb>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end
+

data/website/index.txt

@@ -0,0 +1,60 @@
+h1. postini Gem
+h2. Part of the postini4r project
+
+The postini4r project is a collection of sub-projects that aim to implement a broad range of Postini-related tools.
+
+h2. What
+
+The postini gem is a Ruby wrapper library for the "Postini":http://www.postini.com/ SOAP API (Early Access Program).
+
+The postini gem aims to be fully compliant with the Postini API, starting off with what I need first, and then expanding to eventually cover all the available commands in the Batch Command Reference.
+
+h2. Requirements
+
+* The postini gem requires that you gain access to the Postini Early Access Program and an API key. You need to contact your Postini Service Provider (or Postini directly if you deal with them).
+* soap4r
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install postini</pre>
+
+h2. Demonstration of usage
+
+TODO - Coming soon, refer to the current specs for some samples
+
+h2. Forum
+
+"http://groups.google.com/group/postini-ruby":http://groups.google.com/group/postini-ruby
+
+Join us in the postini-ruby group for discussing everything aroung Postini and Ruby, and possibly Postini in general.
+
+h2. How to submit patches
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+You can fetch the source from:
+
+* github: "http://github.com/kennethkalmer/postini4r-postini/tree/master":http://github.com/kennethkalmer/postini4r-postini/tree/master
+
+<pre>git clone git://github.com/kennethkalmer/postini4r-postini.git</pre>
+
+
+h3. Build and test instructions
+
+<pre>cd postini4r-postini
+rake spec
+rake install_gem</pre>
+
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "me":mailto:kenneth.kalmer@gmail.com via the "forum":http://groups.google.com/group/postini4r
+
+h2. Credits
+
+postini4r is developed by "Kenneth Kalmer":http://www.opensourcery.co.za/ for "SPAM in a Box":http://www.spaminabox.co.za who has allowed the library to be released under the MIT License through their sponsorship.
+