messagebus_ruby_api 1.0.11 → 3.0.6

data/Gemfile

@@ -2,11 +2,13 @@ source "http://rubygems.org"
 
 gem 'activesupport'
 
+gem 'multipart-post'
+
 group :test, :development do
   gem 'rspec', '2.5.0'
   gem 'rr', '1.0.2'
   gem 'fakeweb'
-  gem 'multipart-post'
+  gem 'actionmailer'
 end
 
 # Specify your gem's dependencies in messagebus.gemspec

data/README.rdoc

@@ -44,6 +44,15 @@
     - list recent email statistics
     - list recent delivery errors
 
+== ActionMailer
+
+    If you are using ActionMailer (ex. in Rails,) you can leverage the Messagebus API via the following to send emails.  You can add the following lines to your environmental configuration such as ./rails_project/config/environments/production.rb
+
+      ActionMailer::Base.add_delivery_method :messagebus, MessagebusApi::Messagebus, "<APIKEY>"
+      config.action_mailer.delivery_method = :messagebus
+
+    Be sure to replace <APIKEY> with your APIKEY.
+
 == SSL Certificates
 
     If you encounter SSL certificate problems, use the cacert_info() method to specify a

data/lib/messagebus_ruby_api/messagebus.rb

@@ -23,8 +23,7 @@ module MessagebusApi
 
     def initialize(api_key)
       @api_key = api_key
-      init_http_connection
-      @user_agent = "MessagebusAPI:#{MessagebusApi::VERSION}-Ruby:#{RUBY_VERSION}"
+      init_http_connection(domain)
 
       @msg_buffer_size = 20
       @msg_buffer = []
@@ -84,7 +83,7 @@ module MessagebusApi
 
       json = json_message_from_list(@msg_buffer)
       if (@last_init_time < Time.now.utc - 60)
-        init_http_connection
+        init_http_connection(domain)
       end
       @results=make_api_post_call(endpoint, json)
       @msg_buffer.clear
@@ -106,6 +105,16 @@ module MessagebusApi
       check_response(@results)
     end
 
+    def overwrite_mailing_list(file_name, file_path, mailing_list_key)
+      path = @rest_endpoints[:mailing_list_overwrite].gsub("%KEY%", mailing_list_key)
+      File.open(file_path) do |f|
+        headers = common_http_headers.merge(rest_upload_headers)
+        req = Net::HTTP::Post::Multipart.new path, {:jsonData => "{\"name\":\"#{file_name}\"}", "fileData" => UploadIO.new(f, "text/plain", file_path)}, headers
+        @results = @http.request(req)
+      end
+      check_response(@results)
+    end
+
     def mailing_list_delete(mailing_list_key)
       path = @rest_endpoints[:mailing_list_delete].gsub("%KEY%", mailing_list_key)
       @results = make_api_delete_call(path)
@@ -181,9 +190,55 @@ module MessagebusApi
       time.strftime("%Y-%m-%dT%H:%M:%SZ")
     end
 
+    #used by ActionMailer
+    def deliver!(message)
+      #minimum required headers
+
+      if message.to.first.nil? ||message.subject.nil? || message.from.first.nil? then
+        raise "Messagebus API error=Missing required header: :toEmail => #{message.to.first} :subject => #{message.subject} :fromEmail => #{message.from.first}"
+      end
+
+      message_from_email = from_email_with_name(message.header[:from].to_s)
+
+      from_name = ""
+      from_email = message.from.first
+      if !message_from_email.nil?
+        from_name = message_from_email[1]
+      end
+
+      if !well_formed_address?(from_email)
+        raise "Messagebus API error=From Address is invalid :toEmail => #{message.to.first} :subject => #{message.subject} :fromEmail => #{message.from.first}"
+      end
+
+      msg = {
+        :toEmail => message.to.first,
+        :subject => message.subject,
+        :fromEmail => from_email,
+        :fromName => from_name
+      }
+
+      message.header.fields.delete_if { |k|
+        ( k.name.casecmp('bcc') == 0 ||
+          k.name.casecmp('cc') == 0 )
+      }
+
+      msg[:plaintextBody] = ( message.body ) ? "#{message.body}" : "No plaintext version was supplied."
+
+      if message.multipart?
+        msg[:plaintextBody] = (message.text_part) ? message.text_part.body.to_s : "No plaintext version was supplied."
+        msg[:htmlBody] = message.html_part.body.to_s if message.html_part
+      end
+
+      begin
+        add_message(msg, true)
+      rescue => message_bus_api_error
+        raise "Messagebus API error=#{message_bus_api_error}, message=#{msg.inspect}"
+      end
+    end
+
     private
 
-    def init_http_connection(target_server=DEFAULT_API_ENDPOINT_STRING)
+    def init_http_connection(target_server)
       if (@http and @http.started?)
         @http.finish
       end
@@ -194,8 +249,12 @@ module MessagebusApi
       @http
     end
 
+    def domain
+      DEFAULT_API_ENDPOINT_STRING
+    end
+
     def common_http_headers
-      {'User-Agent' => @user_agent, 'X-MessageBus-Key' => @api_key}
+      {'User-Agent' => MessagebusApi::Info.get_user_agent, 'X-MessageBus-Key' => @api_key}
     end
 
     def rest_post_headers
@@ -242,6 +301,14 @@ module MessagebusApi
       format_iso_time(Time.now.utc - (days_ago*86400))
     end
 
+    def from_email_with_name(address)
+      address.match(/^(.*)\s<(.*?)>/)
+    end
+
+    def well_formed_address?(address)
+      !address.match(/^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i).nil?
+    end
+
     def json_message_from_list(messages)
       {:messages => messages}.to_json
     end
@@ -279,9 +346,9 @@ module MessagebusApi
             rescue JSON::ParserError
               nil
             end
-            raise MessagebusApi::RemoteServerError.new("#{response.code.to_s}:#{rest_http_error_message(response.code.to_s)}")
+            raise MessagebusApi::RemoteServerError.new("#{response.code.to_s}:#{rest_http_error_message(response)}")
           else
-            raise MessagebusApi::RemoteServerError.new("#{response.code.to_s}:#{rest_http_error_message(response.code.to_s)}")
+            raise MessagebusApi::RemoteServerError.new("#{response.code.to_s}:#{rest_http_error_message(response)}")
           end
         else
           raise "Unexpected HTTP Response: #{response.class.name}"
@@ -293,9 +360,16 @@ module MessagebusApi
       @rest_http_errors.key?(status_code)
     end
 
-    def rest_http_error_message(status_code)
+    def rest_http_error_message(response)
       message = "Unknown Error Code"
-      message = @rest_http_errors[status_code] if rest_http_error?(status_code)
+      message = @rest_http_errors[response.code.to_s] if rest_http_error?(response.code.to_s)
+      if (response.body.size > 0)
+        values = JSON.parse(response.body)
+
+        if (values['statusMessage'])
+          message += " - " + values['statusMessage']
+        end
+      end
       message
     end
 
@@ -309,6 +383,7 @@ module MessagebusApi
         :feedbackloops => "/api/v3/feedbackloops",
         :mailing_lists => "/api/v3/mailing_lists",
         :mailing_lists_upload => "/api/v3/mailing_lists/upload",
+        :mailing_list_overwrite => "/api/v3/mailing_list/%KEY%/upload",
         :mailing_list_delete => "/api/v3/mailing_list/%KEY%",
         :mailing_lists_entries => "/api/v3/mailing_list/%KEY%/entries",
         :mailing_lists_entry_email => "/api/v3/mailing_list/%KEY%/entry/%EMAIL%",

data/lib/messagebus_ruby_api/version.rb

@@ -13,5 +13,15 @@
 # under the License.
 
 module MessagebusApi
-  VERSION = "1.0.11"
+  VERSION = "3.0.6"
+
+  class Info
+    @@ClientVersion = MessagebusApi::VERSION
+    @@RubyVersion = RUBY_VERSION
+    @@UserAgent = "MessagebusAPI:#{@@ClientVersion}-Ruby:#{@@RubyVersion}";
+
+    def self.get_user_agent
+      return @@UserAgent
+    end
+  end
 end

data/spec/messagebus_ruby_api/messagebus_spec.rb

@@ -324,6 +324,32 @@ describe MessagebusApi::Messagebus do
       end.should_not raise_error
     end
 
+    it "overwrites a mailing list" do
+      name = 'mylist'
+      filename = File.dirname(__FILE__) + '/../../examples/example_maillist.txt'
+      overwritefilename = File.dirname(__FILE__) + '/../../examples/overwritelist.txt'
+
+      begin
+        FileUtils.cp filename, overwritefilename
+      rescue Exception=>e
+        puts(e)
+      end
+
+      open(overwritefilename, 'a') do |f|
+        f.puts "test@nowhere.example.com,test,tester"
+      end
+
+      expected_request="https://api.messagebus.com/api/v3/mailing_list/392d08c0694811e1a7dd4040f34d0a26/upload"
+
+      FakeWeb.register_uri(:post, expected_request, :body => json_mailing_list_overwrite)
+
+      expect do
+        response = client.overwrite_mailing_list(name,overwritefilename, '392d08c0694811e1a7dd4040f34d0a26')
+        response[:mailingListKey].should == '392d08c0694811e1a7dd4040f34d0a26'
+        response
+      end.should_not raise_error
+    end
+
     it "deletes a mailing list" do
       mailing_list_key = "7215ee9c7d9dc229d2921a40e899ec5f"
       expected_request="https://api.messagebus.com/api/v3/mailing_list/7215ee9c7d9dc229d2921a40e899ec5f"
@@ -358,6 +384,30 @@ describe MessagebusApi::Messagebus do
       end.should_not raise_error
     end
 
+    it "raises an error with an error message when the mailingListKey is not found" do
+
+      campaign_params = {:campaignName => 'MessageBus Test Campaign',
+                         :fromName => 'Message Bus',
+                         :fromEmail => 'do.not.reply@messagebus.com',
+                         :subject => 'This is a test campaign',
+                         :mailingListKey => '7215ee9c7d9dc229d2921a40e899ec5f',
+                         :htmlBody => "<html><body>This message is only a test sent by the Ruby Message Bus client library.</body></html>",
+                         :plaintextBody => 'This message is only a test sent by the Ruby Message Bus client library.',
+                         :tags => ['RUBY', 'Unit Test Ruby'],
+                         :customHeaders => {"sender"=>"apitest1@messagebus.com"}}
+
+      expected_request="https://api.messagebus.com/api/v3/campaigns/send"
+
+      FakeWeb.register_uri(:post, expected_request, :body => json_response_404)
+
+      expect do
+        response = client.campaigns_send(campaign_params)
+        response[:statusCode].should == 404
+        response[:statusMessage].should == "Invalid URL - Mailing list key not found."
+      end.should_not raise_error
+
+    end
+
     it "retrieves completed status with campaign key" do
       campaign_key="7215ee9c7d9dc229d2921a40e899ec5f"
 
@@ -401,6 +451,37 @@ describe MessagebusApi::Messagebus do
     end
   end
 
+  describe "#version" do
+    it "Confirm API version string" do
+      MessagebusApi::Info.get_user_agent.should =~ /MessagebusAPI:3\.\d\.\d-Ruby:\d+.\d+.\d+/
+    end
+  end
+
+  describe "#deliver!" do
+    it "works with action mailer" do
+      to_email = "hello@example.com"
+      message = MessageBusActionMailerTest.new_message(to_email)
+
+      FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v3/emails/send", :body => json_valid_send)
+      client.deliver!(message)
+
+      message_body = JSON.parse(FakeWeb.last_request.body)
+      message_body["messages"][0]["fromName"].should == ""
+      message_body["messages"][0]["fromEmail"].should == to_email
+    end
+
+    it "works with from with nice name in address" do
+      to_email = "Joe Mail <hello_joe@example.com>"
+      message = MessageBusActionMailerTest.new_message(to_email)
+
+      FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v3/emails/send", :body => json_valid_send)
+      client.deliver!(message)
+
+      message_body = JSON.parse(FakeWeb.last_request.body)
+      message_body["messages"][0]["fromName"].should == "Joe Mail"
+      message_body["messages"][0]["fromEmail"].should == "hello_joe@example.com"
+    end
+  end
 
 end
 

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ require 'rubygems'
 require 'fakeweb'
 require 'rr'
 require 'json'
-
+require 'action_mailer'
 require "#{dir}/spec_core_extensions"
 require "#{dir}/../lib/messagebus_ruby_api"
 
@@ -58,6 +58,13 @@ JAVASCRIPT
   json
 end
 
+def json_mailing_list_overwrite
+  json = <<JAVASCRIPT
+{"invalidCount":0,"invalidLines":[0],"mailingListKey":"392d08c0694811e1a7dd4040f34d0a26","statusCode":201,"statusMessage":"","statusTime":"2012-03-08T17:57:51.596Z","validCount":3}
+JAVASCRIPT
+  json
+end
+
 def json_mailing_list_create
   json = <<JAVASCRIPT
 {"statusCode":201,"statusMessage":"","statusTime":"2011-10-10T21:32:14.195Z","key":"51efcf00f38711e0a93640405cc99fee"}
@@ -113,3 +120,22 @@ def json_response_200
 JAVASCRIPT
   json
 end
+
+def json_response_404
+  json = <<JAVASCRIPT
+{"statusCode":404,"statusMessage":"Invalid URL - Mailing list key not found.","statusTime":"2011-10-10T21:32:14.195Z"}
+JAVASCRIPT
+  json
+end
+
+ActionMailer::Base.add_delivery_method :messagebus, MessagebusApi::Messagebus, @api_key
+class MessageBusActionMailerTest < ActionMailer::Base
+  default :to => "someone@example.com",
+          :from => "no-reply@messagebus.com",
+          :body => "This is a test",
+          :subject => "Unit Test"
+
+  def new_message(from_email)
+    mail(:from => from_email)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messagebus_ruby_api
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 3.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-26 00:00:00.000000000Z
-dependencies: []
+date: 2012-08-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: &70268165864740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70268165864740
 description: ! 'Allows you to use the Message Bus API '
 email:
 - messagebus@googlegroups.com
@@ -51,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: messagebus_ruby_api
-rubygems_version: 1.8.19
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Send email through the Message Bus service