messagebus_ruby_api 0.4.0 → 0.4.4

data/README.rdoc

@@ -1,65 +1,47 @@
 = Messagebus Ruby API
-
-== Installation
-
+=Installation
   gem install messagebus_ruby_api
-
-
-== Examples
-
+= Examples
 Start by requiring MessagebusRubyApi:
-
   require 'messagebus_ruby_api'
-
-=== Create the Api Client with your API key
-
+== Create the Api Client with your API key
   client = MessagebusRubyApi::Client.new("<INSERT_YOUR_API_KEY>")
-
+==Sending Emails
 === Setting common fields for your emails
   client.common_info={:fromEmail="from@example.com"}
-
 ==== When not using an API template
-===== Required common_info field
+=====Required common_info fields
   :fromEmail
-===== Optional common_info fields
-  :fromName, :replayTo, :tags
+=====Optional common_info fields
+  :fromName, :tags, :customHeaders
 ==== When using an API template
-===== Required common_info field
+=====Required common_info fields
   :templateKey
-===== No Optional Fields
-
+=====Optional common_info field
+  None
 === Adding messages to the send buffer
   result=client.add_message({:toEmail=>"to@example.com"})
-
-  If you get a result >0 you get back the number of messages waiting to get sent
-  If you get a result = 0 that means the buffer was flushed and you can get results from client.return_status
-  Note: you should read from client.return_status before adding more messages since client.return_status will get cleared during the next auto-flush
-
+If you get a result >0 you get back the number of messages waiting to get sent
+If you get a result = 0 that means the buffer was flushed and you can get results from client.return_status
+Note: you should read from client.return_status before adding more messages since client.return_status will get cleared during the next auto-flush
 ==== When not using an API template
-===== Required message fields
+=====Required message fields
   :toEmail, :subject, :plaintextBody or :htmlBody
-===== Optional message fields
+=====Optional message fields
   :tag, :toName,
 ==== When using an API template
-===== Required common_info field
+=====Required message fields
   :mergeFields={"%EMAIL"=>"to@example.com", "%KEY1%"="testing"}
-
   Note: the merge fields entries chould contain the keys used in the template, but only the %EMAIL% is required
-
-===== No Optional Fields
-
+=====Optional message fields
+  None
 === Flushing the send buffer
   client.flush
-
-  Note: Flushing returns the status of the messages that were sent (see bellow). It also clears old values to client.return_status
-
-  Warning: You always need to flush your buffer when you are done adding messages to be sent or if you want to send messages with a different common_info (failure to do so could result in unsent messages getting lost or old messages getting sent with your new common_info
-
+Note: Flushing returns the status of the messages that were sent (see bellow). It also clears old values to client.return_status
+Warning: You always need to flush your buffer when you are done adding messages to be sent or if you want to send messages with a different common_info (failure to do so could result in unsent messages getting lost or old messages getting sent with your new common_info
 === Checking on message ids sent
   client.return_status
-
-  Status messages will be in the following form:
-
+Status messages will be in the following form:
   {
       "statusMessage" => "OK",
       "successCount" => 2,
@@ -75,15 +57,23 @@ Start by requiring MessagebusRubyApi:
             }
       ]
     }
-
-    If there are failures you will get 400 or 500 status codes as well as error messages
-
-== Older Versions
-
-  If you are using the old api with the text OK:<UUID> responses, please be sure to get the 'v1' branch
-
-  If you are using the old api with the 'body' parameter (instead of the new 'plaintextBody' and 'htmlBody' parameters), please be sure to get the 'v0' branch
-
-== More info
-
+If there are failures you will get 400 or 500 status codes as well as error messages
+==Viewing Error Reports
+  client.error_report
+results will be in the following form:
+  [
+    {:date=>"2011-08-16T21:19:20+00:00", :address=>"someguy@example.com", :errorCode=>"4.2.1"},
+    {:date=>"2011-08-17T21:19:20+00:00", :address=>"someguy@example.com", :errorCode=>"5.0.0"}
+  ]
+==Viewing Unsubscribes By Date
+  client.blocked_emails
+results will be in the following form:
+  [
+    {:email=>"test558_7283@example.com",:unsubscribe_time=>"2011-08-31T19:24:00+00:00","message_send_time"=>"2011-08-31T17:29:16+00:00","message_id"=>"testid"},
+    {:email=>"test558_7283@example.com",:unsubscribe_time=>"2011-08-31T19:24:00+00:00","message_send_time"=>"2011-08-31T17:29:16+00:00","message_id"=>"testid2"}
+  ]
+= Older Versions
+If you are using the old api with the text OK:<UUID> responses, please be sure to get the 'v1' branch
+If you are using the old api with the 'body' parameter (instead of the new 'plaintextBody' and 'htmlBody' parameters), please be sure to get the 'v0' branch
+= More info
 Contact MessageBus if you have questions or problems (https://www.messagebus.com/contact)

data/lib/messagebus_ruby_api/client.rb

@@ -3,55 +3,77 @@ module MessagebusRubyApi
 
   class Client
     attr_reader :api_key, :endpoint_url, :http
-    attr_reader :buffer, :return_status, :email_buffer_size
-    attr_writer :common_info
-    @empty_results=nil
-    
+    attr_reader :email_buffer, :send_return_status, :email_buffer_size
+    attr_writer :send_common_info
+    @empty_send_results=nil
+
     def initialize(api_key, endpoint_url_string = DEFAULT_API_ENDPOINT_STRING)
       @api_key = verified_reasonable_api_key(api_key)
       @endpoint_url = URI.parse(endpoint_url_string)
-      @endpoint_bulk_path = "/api/v2/emails/send"
+      @endpoint_send_path = "/api/v2/emails/send"
+      @endpoint_error_report_path = "/api/v2/emails/error_report"
+      @endpoint_blocked_emails_path = "/api/v2/blocked_emails"
       @http = Net::HTTP.new(@endpoint_url.host, @endpoint_url.port)
       @http.use_ssl = true
+
       @email_buffer_size=20
-      @buffer=[]
-      @empty_results= {
+      @email_buffer=[]
+      @empty_send_results= {
         :statusMessage => "",
         :successCount => 0,
         :failureCount => 0,
         :results => []
       }
-      @return_status=@empty_results
-      @common_info={}
+      @send_return_status=@empty_send_results
+      @send_common_info={}
     end
 
     def add_message(email_options)
-      @buffer<<email_options
-      if (@buffer.size >= @email_buffer_size)
+      @email_buffer<<email_options
+      if (@email_buffer.size >= @email_buffer_size)
         self.flush
         return 0
       else
-        return @buffer.size
+        return @email_buffer.size
       end
     end
 
     def flush
-      if (@buffer.size==0)
-        @return_status=@empty_results
+      if (@email_buffer.size==0)
+        @send_return_status=@empty_send_results
         return
       end
-      @return_status=self.buffered_send(@buffer, @common_info)
-      @buffer.clear
-      @return_status
+      @send_return_status=self.buffered_send(@email_buffer, @send_common_info)
+      @email_buffer.clear
+      @send_return_status
+    end
+
+    def error_report
+      request=create_api_get_request("#{@endpoint_error_report_path}?apiKey=#{@api_key}")
+      request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
+      self.make_api_call(request)
+    end
+
+    def blocked_emails(start_date,end_date=nil)
+      additional_params="startDate=#{URI.escape(start_date.to_datetime.new_offset(0).rfc3339)}"
+      unless (end_date.nil?)
+        additional_params+="&endDate=#{URI.escape(end_date.to_datetime.new_offset(0).rfc3339)}"
+      end
+      request=create_api_get_request("#{@endpoint_blocked_emails_path}?apiKey=#{@api_key}&#{additional_params}")
+      request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
+      self.make_api_call(request)
     end
 
     def basic_auth_credentials=(credentials)
       @credentials = credentials
     end
 
+    def create_api_post_request(path)
+      Net::HTTP::Post.new(path)
+    end
 
-    def create_api_request(path)
-      Net::HTTP::Post.new(path) #, {"User-Agent" => "messagebus.com Messagebus Ruby API v2"})
+    def create_api_get_request(path)
+      Net::HTTP::Get.new(path)
     end
 
     def check_priority(priority)
@@ -79,35 +101,10 @@ module MessagebusRubyApi
           :successCount => 0,
           :failureCount => 0}
       end
-      response = @http.start do |http|
-        request = create_api_request(@endpoint_bulk_path)
-        request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
-        request.form_data={'json' => make_json_message_from_list(message_list, common_options)}
-        http.request(request)
-      end
-      case response
-        when Net::HTTPSuccess
-          begin
-
-            return JSON.parse(response.body, :symbolize_names => true)
-          rescue JSON::ParserError => e
-            raise MessagebusRubyApi::RemoteServerError.new("Remote server returned unrecognized response: #{e.message}")
-          end
-        when Net::HTTPClientError, Net::HTTPServerError
-          if (response.body && response.body.size > 0)
-            result = begin
-              JSON.parse(response.body, :symbolize_names => true)
-            rescue JSON::ParserError
-              nil
-            end
-            raise MessagebusRubyApi::RemoteServerError.new("Remote Server Returned: #{response.code.to_s}.  #{result[:statusMessage] if result}", result)
-          else
-            raise MessagebusRubyApi::RemoteServerError.new("Remote Server Returned: #{response.code.to_s}")
-          end
-        else
-          raise "Unexpected HTTP Response: #{response.class.name}"
-      end
-      raise "Could not determine response"
+      request = create_api_post_request(@endpoint_send_path)
+      request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
+      request.form_data={'json' => make_json_message_from_list(message_list, common_options)}
+      self.make_api_call(request)
     end
 
     def make_json_message(options)
@@ -119,10 +116,6 @@ module MessagebusRubyApi
       map["htmlBody"]=options[:htmlBody] if (options.has_key? :htmlBody)
       map["fromName"]=options[:fromName] if (options.has_key? :fromName)
       map["tag"]=options[:tag] if (options.has_key? :tag)
-      map["replyTo"]=options[:replyTo] if (options.has_key? :replyTo)
-      map["errorsTo"]=options[:errorsTo] if (options.has_key? :errorsTo)
-      map["unsubscribeEmail"]=options[:unsubscribeEmail] if (options.has_key? :unsubscribeEmail)
-      map["unsubscribeURL"]=options[:unsubscribeURL] if (options.has_key? :unsubscribeURL)
       map["mergeFields"]=options[:mergeFields] if (options.has_key? :mergeFields)
       map
     end
@@ -140,12 +133,41 @@ module MessagebusRubyApi
       if (common_options!=nil)
         json["fromEmail"]=common_options[:fromEmail] if (common_options.has_key? :fromEmail)
         json["fromName"]=common_options[:fromName] if (common_options.has_key? :fromName)
-        json["replyTo"]=common_options[:replyTo] if (common_options.has_key? :replyTo)
         json["tags"]=common_options[:tags] if (common_options.has_key? :tags)
+        json["customHeaders"]=common_options[:customHeaders] if (common_options.has_key? :customHeaders)
         json["templateKey"]=common_options[:templateKey] if (common_options.has_key? :templateKey)
       end
-      
+
       json.reject { |k, v| v == nil }.to_json
     end
+
+    def make_api_call(request, symbolize_names=true)
+      response = @http.start do |http|
+        request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
+        http.request(request)
+      end
+      case response
+        when Net::HTTPSuccess
+          begin
+            return JSON.parse(response.body, :symbolize_names => symbolize_names)
+          rescue JSON::ParserError => e
+            raise MessagebusRubyApi::RemoteServerError.new("Remote server returned unrecognized response: #{e.message}")
+          end
+        when Net::HTTPClientError, Net::HTTPServerError
+          if (response.body && response.body.size > 0)
+            result = begin
+              JSON.parse(response.body, :symbolize_names => symbolize_names)
+            rescue JSON::ParserError
+              nil
+            end
+            raise MessagebusRubyApi::RemoteServerError.new("Remote Server Returned: #{response.code.to_s}.  #{result[:statusMessage] if result}", result)
+          else
+            raise MessagebusRubyApi::RemoteServerError.new("Remote Server Returned: #{response.code.to_s}")
+          end
+        else
+          raise "Unexpected HTTP Response: #{response.class.name}"
+      end
+      raise "Could not determine response"
+    end
   end
 end

data/lib/messagebus_ruby_api/version.rb

@@ -1,3 +1,3 @@
 module MessagebusRubyApi
-  VERSION = "0.4.0"
+  VERSION = "0.4.4"
 end

data/spec/messagebus_ruby_api/client_spec.rb

@@ -23,7 +23,7 @@ describe MessagebusRubyApi::Client do
 
     @api_key = "3"*32
     @client = MessagebusRubyApi::Client.new(api_key)
-    @required_params = {:toEmail => "bob@example.com", :fromEmail => "alice@example.com", :plaintextBody => "a nice ocean", :subject => "test subject"}
+    @required_params = {:toEmail => "bob@example.com", :plaintextBody => "a nice ocean", :subject => "test subject"}
     @success_message={
       "status" => 200,
       "messageId" => "e460d7f0-908e-012e-80b4-58b035f30fd1"
@@ -34,45 +34,45 @@ describe MessagebusRubyApi::Client do
   describe "#bulk_send" do
 
     before do
-      @common_options={:fromEmail => "bob@example.com"}
+      @common_options={:fromEmail => "bob@example.com", :customHeaders => {"customfield1"=>"custom value 1", "customfield2"=>"custom value 2"}}
     end
 
     describe "#add_message" do
       it "buffered send that adds to empty buffer" do
-        client.common_info=@common_options
-        client.buffer.size.should == 0
+        client.send_common_info=@common_options
+        client.email_buffer.size.should == 0
         client.add_message(required_params)
-        client.buffer.size.should == 1
+        client.email_buffer.size.should == 1
       end
-      
+
       it "buffered send that adds to a buffer and auto-flushes" do
         FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v2/emails/send", :body => create_success_result(client.email_buffer_size).to_json)
-        client.common_info=@common_options
-        client.return_status[:results].size.should == 0
+        client.send_common_info=@common_options
+        client.send_return_status[:results].size.should == 0
         (client.email_buffer_size-1).times do |idx|
           client.add_message(required_params).should == idx+1
-          client.return_status[:results].size.should == 0
+          client.send_return_status[:results].size.should == 0
         end
         client.add_message(required_params).should == 0
-        client.return_status[:results].size.should == client.email_buffer_size
+        client.send_return_status[:results].size.should == client.email_buffer_size
       end
     end
 
     describe "#flush" do
       it "flush called on empty buffer" do
-        client.common_info=@common_options
-        client.return_status[:results].size.should == 0
+        client.send_common_info=@common_options
+        client.send_return_status[:results].size.should == 0
         client.flush
-        client.return_status[:results].size.should == 0
+        client.send_return_status[:results].size.should == 0
       end
       it "flush called on filled buffer" do
         FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v2/emails/send", :body => create_success_result(10).to_json)
-        client.common_info=@common_options
+        client.send_common_info=@common_options
         10.times do
           client.add_message(required_params)
         end
         client.flush
-        client.return_status[:results].size.should == 10
+        client.send_return_status[:results].size.should == 10
       end
     end
 
@@ -86,10 +86,11 @@ describe MessagebusRubyApi::Client do
     it "send a single item buffer" do
       buffer=[required_params]
       FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v2/emails/send", :body => @simple_success_result.to_json)
-      expect do
-        response = client.buffered_send(buffer, @common_options)
-        response[:successCount].should == 1
-      end.should_not raise_error
+      #expect do
+      response = client.buffered_send(buffer, @common_options)
+      FakeWeb.last_request.body.should =~ /json=/
+      response[:successCount].should == 1
+      #end.should_not raise_error
     end
 
     it "send a several item buffer" do
@@ -111,9 +112,55 @@ describe MessagebusRubyApi::Client do
       FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v2/emails/send", :body => @success_result2.to_json)
       expect do
         response = client.buffered_send(buffer, @common_options)
+        FakeWeb.last_request.body.should =~ /json=/
         response[:successCount].should == 2
       end.should_not raise_error
     end
   end
+
+  describe "#error_report" do
+
+    it "request error report" do
+      @success_result={
+        :reportSize=>2,
+        :results=>
+        [
+        {:date => (Time.now-(60*60*24)).utc.to_datetime.rfc3339, :address => "someguy@example.com", :errorCode => "4.2.1"},
+        {:date => Time.now.utc.to_datetime.rfc3339, :address => "someguy@example.com", :errorCode => "5.0.0"}
+        ]
+      }
+
+      FakeWeb.register_uri(:get, "https://api.messagebus.com/api/v2/emails/error_report?apiKey=#{@api_key}", :body => @success_result.to_json)
+      expect do
+        response = client.error_report
+        FakeWeb.last_request.body.should be_nil
+        response.should == @success_result
+      end.should_not raise_error
+    end
+  end
+
+   describe "#blocked_emails" do
+
+    it "request blocked emails list" do
+
+      start_date_str="2011-01-01T04:30:00+00:00"
+      end_date_str="2011-01-02T04:30:00+00:00"
+      start_date=DateTime.parse(start_date_str)
+      end_date=DateTime.parse(end_date_str)
+      @success_result=[
+        {:email=>"test1@example.com", :message_send_time=>"2011-01-01T03:02:00", :unsubscribe_time=>"2011-01-02T04:32:00", :message_id=>"testmessageid1"},
+        {:email=>"test2@example.com",:message_send_time=>"2011-01-01T02:02:00", :unsubscribe_time=>"2011-01-02T02:32:00", :message_id=>"testmessageid2"}
+      ]
+      expected_rquest="https://api.messagebus.com/api/v2/blocked_emails?apiKey=#{@api_key}&startDate=#{URI.escape(start_date_str)}&endDate=#{URI.escape(end_date_str)}"
+
+      FakeWeb.register_uri(:get, expected_rquest, :body => @success_result.to_json)
+      expect do
+        response = client.blocked_emails(start_date,end_date)
+        FakeWeb.last_request.body.should be_nil
+        response.should == @success_result
+      end.should_not raise_error
+    end
+  end
+
 end
 

data/spec/ruby/1.9.1/bin/autospec

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'rspec-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'rspec-core', version
+load Gem.bin_path('rspec-core', 'autospec', version)

data/spec/ruby/1.9.1/bin/htmldiff

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'htmldiff', version)

data/spec/ruby/1.9.1/bin/ldiff

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'ldiff', version)

data/spec/ruby/1.9.1/bin/rspec

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'rspec-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'rspec-core', version
+load Gem.bin_path('rspec-core', 'rspec', version)