messagebus_ruby_api 0.4.4 → 0.4.7

data/README.rdoc

@@ -58,6 +58,15 @@ Status messages will be in the following form:
       ]
     }
 If there are failures you will get 400 or 500 status codes as well as error messages
+==Mailing List Management
+Calls take a mailing list key which can be found on the mailing list management page on messagebus.com
+Responses are of the form
+  {:statusMessage => "OK"}
+===Adding to a mailing list
+  merge_fields={"%EMAIL%"=>"a@example.com","%PARAM1%"=>"value 1"}
+  client.add_to_mailing_list(mailing_list_key, merge_fields)
+===Removing from a mailing list
+  client.remove_from_mailing_list(mailing_list_key, "a@example.com")
 ==Viewing Error Reports
   client.error_report
 results will be in the following form:

data/lib/messagebus_ruby_api/client.rb

@@ -10,9 +10,7 @@ module MessagebusRubyApi
     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_send_path = "/api/v2/emails/send"
-      @endpoint_error_report_path = "/api/v2/emails/error_report"
-      @endpoint_blocked_emails_path = "/api/v2/blocked_emails"
+      @end_point_v2_base_path="/api/v2/"
       @http = Net::HTTP.new(@endpoint_url.host, @endpoint_url.port)
       @http.use_ssl = true
 
@@ -31,7 +29,7 @@ module MessagebusRubyApi
     def add_message(email_options)
       @email_buffer<<email_options
       if (@email_buffer.size >= @email_buffer_size)
-        self.flush
+        flush
         return 0
       else
         return @email_buffer.size
@@ -43,31 +41,70 @@ module MessagebusRubyApi
         @send_return_status=@empty_send_results
         return
       end
-      @send_return_status=self.buffered_send(@email_buffer, @send_common_info)
+      @send_return_status=buffered_send(@email_buffer, @send_common_info)
       @email_buffer.clear
       @send_return_status
     end
 
+    def add_to_mailing_list(mailing_list_key, merge_fields)
+      request = create_api_post_request("#{@end_point_v2_base_path}mailing_list_entry/add_entry")
+      request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
+      json = {
+        "apiKey" => @api_key,
+        "mailingListKey" => mailing_list_key,
+        "mergeFields" => merge_fields
+      }.to_json
+      request.form_data={'json' => json}
+      make_api_call(request)
+    end
+
+    def remove_from_mailing_list(mailing_list_key, to_email)
+      request = create_api_delete_request("#{@end_point_v2_base_path}mailing_list_entry")
+      request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
+      json = {
+        "apiKey" => @api_key,
+        "mailingListKey" => mailing_list_key,
+        "email" => to_email
+      }.to_json
+      request.form_data={'json' => json}
+      make_api_call(request)
+    end
+
     def error_report
-      request=create_api_get_request("#{@endpoint_error_report_path}?apiKey=#{@api_key}")
+      request=create_api_get_request("#{@end_point_v2_base_path}emails/error_report?apiKey=#{@api_key}")
       request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
-      self.make_api_call(request)
+      make_api_call(request)
     end
 
-    def blocked_emails(start_date,end_date=nil)
+    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=create_api_get_request("#{@end_point_v2_base_path}blocked_emails?apiKey=#{@api_key}&#{additional_params}")
       request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
-      self.make_api_call(request)
+      make_api_call(request)
     end
 
     def basic_auth_credentials=(credentials)
       @credentials = credentials
     end
 
+    def buffered_send(message_list, common_options)
+      if (message_list.length==0)
+        return {
+          :statusMessage => "OK",
+          :successCount => 0,
+          :failureCount => 0}
+      end
+      request = create_api_post_request("#{@end_point_v2_base_path}emails/send")
+      request.basic_auth(@credentials[:user], @credentials[:password]) if @credentials
+      request.form_data={'json' => make_json_message_from_list(message_list, common_options)}
+      make_api_call(request)
+    end
+
+    private
+
     def create_api_post_request(path)
       Net::HTTP::Post.new(path)
     end
@@ -76,6 +113,10 @@ module MessagebusRubyApi
       Net::HTTP::Get.new(path)
     end
 
+    def create_api_delete_request(path)
+      Net::HTTP::Delete.new(path)
+    end
+
     def check_priority(priority)
       raise APIParameterError.new(":priority can only be an integer between 1 and 5, not \"#{priority}\"") unless priority.is_a?(Integer) && (1..5).include?(priority)
       priority.to_s
@@ -94,19 +135,6 @@ module MessagebusRubyApi
       params[:priority] = check_priority(params[:priority]) unless params[:priority].nil?
     end
 
-    def buffered_send(message_list, common_options)
-      if (message_list.length==0)
-        return {
-          :statusMessage => "OK",
-          :successCount => 0,
-          :failureCount => 0}
-      end
-      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)
       map={}
       map["toEmail"]=options[:toEmail] if (options.has_key? :toEmail)

data/lib/messagebus_ruby_api/version.rb

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

data/spec/messagebus_ruby_api/client_spec.rb

@@ -139,7 +139,7 @@ describe MessagebusRubyApi::Client do
     end
   end
 
-   describe "#blocked_emails" do
+  describe "#blocked_emails" do
 
     it "request blocked emails list" do
 
@@ -149,18 +149,54 @@ describe MessagebusRubyApi::Client do
       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"}
+        {: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)}"
+      expected_request="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)
+      FakeWeb.register_uri(:get, expected_request, :body => @success_result.to_json)
       expect do
-        response = client.blocked_emails(start_date,end_date)
+        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
 
+  describe "#remove_from_mailing_list" do
+
+    it "remove from mailing list" do
+      mailing_list_key="test_key"
+      to_email="test@example.com"
+
+      expected_request="https://api.messagebus.com/api/v2/mailing_list_entry"
+
+      FakeWeb.register_uri(:delete, expected_request, :body => {"statusMessage" => "OK"}.to_json)
+      expect do
+        response = client.remove_from_mailing_list(mailing_list_key, to_email)
+        FakeWeb.last_request.body.should =~ /json=/
+        response.should == {:statusMessage => "OK"}
+        FakeWeb.last_request.body
+      end.should_not raise_error
+
+    end
+  end
+
+  describe "#add_to_mailing_list" do
+
+    it "add to mailing list" do
+      mailing_list_key="test_key"
+      merge_fields={"%EMAIL%"=>"a@example.com", "%PARAM1%"=>"test value"}
+      expected_request="https://api.messagebus.com/api/v2/mailing_list_entry/add_entry"
+
+      FakeWeb.register_uri(:post, expected_request, :body => {"statusMessage" => "OK"}.to_json)
+      expect do
+        response = client.add_to_mailing_list(mailing_list_key, merge_fields)
+        FakeWeb.last_request.body.should =~ /json=/
+        response.should == {:statusMessage => "OK"}
+      end.should_not raise_error
+
+    end
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messagebus_ruby_api
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000Z
+date: 2011-09-20 00:00:00.000000000Z
 dependencies: []
 description: ! 'Allows you to use the Messagebus API '
 email: