messagebus_ruby_api 1.0.6 → 1.0.10

data/Gemfile

@@ -6,6 +6,7 @@ group :test, :development do
   gem 'rspec', '2.5.0'
   gem 'rr', '1.0.2'
   gem 'fakeweb'
+  gem 'multipart-post'
 end
 
 # Specify your gem's dependencies in messagebus.gemspec

data/lib/messagebus_ruby_api/messagebus.rb

@@ -11,6 +11,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
+require 'net/http/post/multipart'
 
 module MessagebusApi
   DEFAULT_API_ENDPOINT_STRING = 'https://api.messagebus.com'
@@ -95,6 +96,42 @@ module MessagebusApi
       make_api_get_call(@rest_endpoints[:mailing_lists])
     end
 
+    def upload_mailing_list(name, file_path)
+      path = @rest_endpoints[:mailing_lists_upload]
+      File.open(file_path) do |f|
+        headers = common_http_headers.merge(rest_upload_headers)
+        req = Net::HTTP::Post::Multipart.new path, {:jsonData => "{\"name\":\"#{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)
+      @results
+    end
+
+    def campaigns
+      path = @rest_endpoints[:campaigns]
+      @results = make_api_get_call(path)
+      @results
+    end
+
+    def campaigns_send(params)
+      path = @rest_endpoints[:campaigns_send]
+      campaign_params = base_campaign_params.merge!(params)
+      json = campaign_params.to_json
+      @results = make_api_post_call(path, json)
+      @results
+    end
+
+    def campaign_status(campaign_key)
+      path = @rest_endpoints[:campaign_status].gsub("%KEY%", campaign_key)
+      @results = make_api_get_call(path)
+      @results
+    end
+
     def delete_mailing_list_entry(mailing_list_key, email)
       path = @rest_endpoints[:mailing_lists_entry_email].gsub("%KEY%", mailing_list_key).gsub("%EMAIL%", email)
       @results = make_api_delete_call(path)
@@ -165,6 +202,10 @@ module MessagebusApi
       {"Content-Type" => "application/json; charset=utf-8"}
     end
 
+    def rest_upload_headers
+      {"Content-Type" => "multipart/form-data; charset=utf-8"}
+    end
+
     def add_email_message(params)
       @msg_type = EMAIL if @msg_type == nil
       @msg_buffer << base_message_params.merge!(params)
@@ -267,8 +308,13 @@ module MessagebusApi
         :unsubscribes => "/api/v3/unsubscribes",
         :feedbackloops => "/api/v3/feedbackloops",
         :mailing_lists => "/api/v3/mailing_lists",
+        :mailing_lists_upload => "/api/v3/mailing_lists/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%",
+        :campaigns_send => "/api/v3/campaigns/send",
+        :campaign_status => "/api/v3/campaign/%KEY%/status",
+        :campaigns => "/api/v3/campaigns",
         :version => "/api/version"
       }
     end
@@ -320,5 +366,16 @@ module MessagebusApi
        :customHeaders => {}}
     end
 
+    def base_campaign_params
+      {:campaignName => '',
+       :fromName => '',
+       :fromEmail => '',
+       :subject => '',
+       :mailingListKey => '',
+       :htmlBody => '',
+       :plaintextBody => '',
+       :tags => [],
+       :customHeaders => {}}
+    end
   end
 end

data/lib/messagebus_ruby_api/version.rb

@@ -13,5 +13,5 @@
 # under the License.
 
 module MessagebusApi
-  VERSION = "1.0.6"
+  VERSION = "1.0.10"
 end

data/spec/messagebus_ruby_api/messagebus_spec.rb

@@ -302,6 +302,18 @@ describe MessagebusApi::Messagebus do
   end
 
   describe "#mailing_lists" do
+    it "uploads a mailing list" do
+      name = 'mylist'
+      filename = File.dirname(__FILE__) + '/../../examples/example_maillist.txt'
+      expected_request="https://api.messagebus.com/api/v3/mailing_lists/upload"
+
+      FakeWeb.register_uri(:post, expected_request, :body => json_mailing_list_upload)
+      expect do
+        response = client.upload_mailing_list(name, filename)
+        response.should == json_parse(json_mailing_list_upload)
+      end.should_not raise_error
+    end
+
     it "get mailing lists" do
       expected_request="https://api.messagebus.com/api/v3/mailing_lists"
 
@@ -311,6 +323,61 @@ describe MessagebusApi::Messagebus do
         response.should == json_parse(json_mailing_lists)
       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"
+
+      FakeWeb.register_uri(:delete, expected_request, :body => json_mailing_lists)
+      expect do
+        response = client.mailing_list_delete(mailing_list_key)
+        response.should == json_parse(json_mailing_lists)
+      end.should_not raise_error
+    end
+  end
+
+  describe "#campaigns" do
+    it "sends a campaign with a mailing list key" 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_campaign_send)
+      expect do
+        response = client.campaigns_send(campaign_params)
+        response.should == json_parse(json_campaign_send)
+      end.should_not raise_error
+    end
+
+    it "retrieves completed status with campaign key" do
+      campaign_key="7215ee9c7d9dc229d2921a40e899ec5f"
+
+      expected_request="https://api.messagebus.com/api/v3/campaign/#{campaign_key}/status"
+
+      FakeWeb.register_uri(:get, expected_request, :body => json_stats)
+      expect do
+        response = client.campaign_status(campaign_key)
+        response.should == json_parse(json_stats)
+      end.should_not raise_error
+    end
+
+    it "retrieves a list of campaigns" do
+      expected_request="https://api.messagebus.com/api/v3/campaigns"
+      FakeWeb.register_uri(:get, expected_request, :body => json_stats)
+      expect do
+        response = client.campaigns
+        response.should == json_parse(json_stats)
+      end.should_not raise_error
+    end
   end
 
   describe "#stats" do

data/spec/spec_helper.rb

@@ -51,6 +51,13 @@ JAVASCRIPT
   json
 end
 
+def json_mailing_list_upload
+  json = <<JAVASCRIPT
+{"invalidCount":1,"invalidLines":[3],"key":"392d08c0694811e1a7dd4040f34d0a26","statusCode":201,"statusMessage":"","statusTime":"2012-03-08T17:57:51.596Z","validCount":2}
+JAVASCRIPT
+  json
+end
+
 def json_mailing_list_create
   json = <<JAVASCRIPT
 {"statusCode":201,"statusMessage":"","statusTime":"2011-10-10T21:32:14.195Z","key":"51efcf00f38711e0a93640405cc99fee"}
@@ -58,6 +65,13 @@ JAVASCRIPT
   json
 end
 
+def json_campaign_send
+  json = <<JAVASCRIPT
+{"statusCode":202,"statusMessage":"","statusTime":"2011-10-10T21:32:14.195Z","campaignKey":"51efcf00f38711e0a93640405cc99fee"}
+JAVASCRIPT
+  json
+end
+
 def json_unsubscribes
   json = <<JAVASCRIPT
 {"statusCode":200,"statusMessage":"","statusTime":"2011-10-10T21:32:14.195Z","results":[{"toEmail":"joe@example.com","time":"2011-10-10T21:32:14.195Z"}]}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messagebus_ruby_api
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000Z
+date: 2012-03-23 00:00:00.000000000Z
 dependencies: []
 description: ! 'Allows you to use the Message Bus API '
 email:
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: messagebus_ruby_api
-rubygems_version: 1.8.15
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Send email through the Message Bus service