ihunter-whatcounts 0.3.4 → 0.3.5

data/README.rdoc

@@ -4,23 +4,71 @@
 
 == DESCRIPTION:
 
-FIX (describe your package)
+Ruby library with Rails Mailer class for working with WhatCounts mail provider.
+
+1) Make sure to configure WhatCounts:
+  
+  WhatCounts::HttpClient.configure do 
+    realm "my_realm"
+    password "foobar"
+  end
+  
+  Then to use (better usages soon):
+  
+  Lists
+  WhatCounts::List.create! { :name => 'name', :template_id => 'template', 
+                             :from_address => '', :reply_to_address => '', :bounce_address => '', 
+                             :track_clicks => true, :track_opens => true }
+  
+  One Off Messages
+  WhatCounts::OneOffMessage.new :list_id => 1234, :template_id => 5678, :to => 'person@example.com', :format => 99
+  
+  WhatCounts::OneOffMessage.send! :list_id => 1234, :template_id => 5678, :format => 99,
+                                  :to => "recipient@test.com", :from => "sender@example.com", 
+                                  :subject => headline,
+                                  :data => { :url => "http://example.com",
+                                             :some_number => 1234
+                                           }
+  
+  Rails Integration (place in environments/#{RAILS_ENV}.rb)
+  config.after_initialize do
+    module ::WhatCounts
+      Rails::Mailer.default_url_options = {:host => 'assets.example.com'} # needed for url_for to work
+      HttpClient.configure do 
+        realm "my_realm"
+        password "foobar"
+      end
+    end
+  end
+  
+  Then extend the WhatCounts::Rails::Mailer class and use similar to ActionMailer::Base
+  class SomeMailer < WhatCounts::Rails::Mailer
+    # I will be adding method_missing logic so you can call the mailer like you would in Rails.  
+    class << self
+      def deliver_something(*args)
+        self.new.something(*args)
+      end
+    end
+  
+    def something(*args)
+      # do yer mailing
+    end
+  end
+  
+  It's still largely incomplete as it was designed to serve specific needs.  Feel free to contribute.
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
-
 == SYNOPSIS:
 
-  FIX (code sample of usage)
-
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* curb
+* fastercsv
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+gem install ihunter-whatcounts 
 
 == LICENSE:
 

data/lib/whatcounts.rb

@@ -1,23 +1,12 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-# begin
-  require 'curb' 
-# rescue Exception => e
-#   puts "curb is required for whatcounts gem\n"
-#   puts "gem install curb"
-#   exit
-# end
-# 
-# begin
-  require 'fastercsv'
-# rescue
-#   puts "fastercsv is required for whatcounts gem\n"
-#   exit
-# end
+require 'curb' 
+require 'cgi'
+# require 'fastercsv'
 
 module WhatCounts
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
   class WhatCountsError < StandardError; end
 
   class CreationError < WhatCountsError; end

data/lib/whatcounts/one_off_message.rb

@@ -3,7 +3,7 @@ module WhatCounts
 
     private
     OPTIONS_TO_HTTP_PARAMS_MAP = {:list_id => :list_id, :template_id => :template_id, :format => :format, :to => :to, :from => :from,
-                                  :subject => :subject, :body => :body, :data => :data}
+                                  :subject => :subject, :body => :body, :data => :data, :virtual_mta => :vmta}
     attr_writer *(OPTIONS_TO_HTTP_PARAMS_MAP.keys)
 
     public

data/lib/whatcounts/response.rb

@@ -26,7 +26,7 @@ module WhatCounts
       end
     end
     
-    def success?; self.result end
+    def success?; !!self.result end
     def failure?; !self.result end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ihunter-whatcounts
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - Ian Hunter
@@ -74,6 +74,6 @@ rubyforge_project: whatcounts
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: FIX (describe your package)
+summary: WhatCounts HTTP API interface
 test_files: []