messagebus-sdk 4.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2-p290 --create

data/Gemfile

@@ -0,0 +1,15 @@
+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 'actionmailer'
+end
+
+# Specify your gem's dependencies in messagebus.gemspec
+gemspec

data/README.md

@@ -0,0 +1,183 @@
+![MB icon](https://www.messagebus.com/wp-content/themes/msg/images/Message-Bus_LOGO.png)
+
+###Message Bus Ruby SDK
+
+Message Bus is a cloud-based platform for easily sending email at scale and with complete insight into your messaging traffic and how recipients are responding to it. All platform functions are available via [REST API](http://www.messagebus.com/documentation) as well as the language-specific documentation, sample code, libraries, and/or compiled binaries contained in this SDK.
+
+Samples include how to:
+
+* Create sessions
+* Send messages
+* Use templates
+* Check email stats
+
+If you have questions not answered by the samples or the online documentation, please contact [support](mailto:support@messagebus.com).
+
+
+####Installing the module
+
+    gem install messagebus-sdk
+
+    If running the examples from the project without installing the gem, you will
+    need to set RUBYLIB path.
+
+    Example: export RUBYLIB=/Users/<user_name>/workspace/messagebus-ruby-sdk/lib/messagebus-sdk
+
+####Sending emails
+
+    require 'messagebus-sdk/api_client'
+
+    api_key="12345678934628542E2599F7ED712345"
+    api_host="https://api-v4.messagebus.com"
+
+    client = MessagebusApiClient.new(api_key, api_host)
+
+    session_key = "DEFAULT"
+
+    messages = [
+        {:toEmail => 'bobby@example.com',
+         :toName => 'Bobby Flay',
+         :fromEmail => 'alice@example.com',
+         :fromName => 'Alice Waters',
+         :subject => 'Sample Message with HTML body.',
+         :customHeaders => {"x-messagebus-sdk"=>"ruby-sdk"},
+         :plaintextBody => 'This is the plain text body.',
+         :htmlBody => 'This is the <b>HTML</b>body.',
+         :sessionKey => session_key},
+        {:toEmail => 'jamie@example.com',
+         :toName => 'Jamie Lauren',
+         :fromEmail => 'alice@example.com',
+         :fromName => 'Alice Waters',
+         :subject => 'Simple Example with no HTML body.',
+         :customHeaders => {"x-messagebus-sdk"=>"ruby-sdk"},
+         :plaintextBody => 'This is the plaintext example.',
+         :sessionKey => session_key}
+      ]
+
+    begin
+      response = client.send_messages(messages)
+      if response[:statusCode] == 202
+        puts "Email send results"
+        response[:results].each do |message|
+          puts "To: #{message[:toEmail]} Message Id: #{message[:messageId]} Message Status: #{message[:messageStatus]}"
+        end
+      else
+        puts "#{response[:statusMessage]}"
+      end
+    rescue Exception=>e
+      puts "Exception thrown.  Error during send: #{e.message}"
+    end
+
+####Sending emails with ActionMailer
+
+    require 'action_mailer'
+    require 'messagebus-sdk/actionmailer_client'
+
+    class MessagebusMailer < MessagebusActionMailerClient
+      def initialize(*args)
+        api_key = "12345678934628542E2599F7ED712345"
+        api_endpoint = "https://api-v4.messagebus.com"
+        super(api_key, api_endpoint)
+      end
+    end
+
+    ActionMailer::Base.add_delivery_method :messagebus, MessagebusMailer
+    ActionMailer::Base.delivery_method = :messagebus
+
+    class MessageBusActionMailerTest < ActionMailer::Base
+      default :from => "no-reply@messagebus.com",
+              :body => "This is a test",
+              :subject => "Unit Test",
+              :return_path => "bounce@bounces.example.com"
+
+      def test_message(to_email, session_key)
+        headers[MessagebusSDK::MessagebusBase::HEADER_SESSION_KEY] = session_key
+        mail(:to => to_email)
+      end
+    end
+
+    to_email = "hello@example.com"
+    session_key = "DEFAULT"
+    message = MessageBusActionMailerTest.test_message(to_email, session_key)
+    message.deliver
+
+####Checking email statistics
+
+    require 'messagebus-sdk/stats_client'
+
+    api_key = "12345678934628542E2599F7ED712345"
+    api_host = "https://api-v4.messagebus.com"
+
+    client = MessagebusStatsClient.new(api_key, api_host)
+
+    begin
+      response = client.stats
+      if response[:statusCode] == 200
+        stats = response[:stats]
+        puts "Stats"
+        puts "\tMessages Attempted: #{stats[:msgsAttemptedCount]}"
+        puts "\tComplaint Count: #{stats[:complaintCount]}"
+        puts "\tUnsubscribe Count: #{stats[:unsubscribeCount]}"
+        puts "\tOpen Count: #{stats[:openCount]}"
+        puts "\tUnique Open Count: #{stats[:uniqueOpenCount]}"
+        puts "\tClick Count: #{stats[:clickCount]}"
+
+        smtp = response[:smtp]
+        puts "SMTP"
+        puts "\tAccept Count: #{smtp[:acceptCount]}"
+        puts "\tBounce Count: #{smtp[:bounceCount]}"
+        puts "\tReject Count: #{smtp[:rejectCount]}"
+        puts "\tError Count: #{smtp[:errorCount]}"
+
+        filter = response[:filter]
+        puts "Filter"
+        puts "\tBad Mailbox Count: #{filter[:rcptBadMailboxCount]}"
+        puts "\tChannel Block Count: #{filter[:rcptChannelBlockCount]}"
+
+      else
+        puts "#{response[:statusMessage]}"
+      end
+    rescue Exception=>e
+      puts "Exception thrown.  Error during stats retrieval: #{e.message}"
+    end
+
+#### Checking email feedback data
+
+    require 'messagebus-sdk/feedback_client'
+
+    api_key = "12345678934628542E2599F7ED712345"
+    api_host = "https://api-v4.messagebus.com"
+
+    client = MessagebusFeedbackClient.new(api_key, api_host)
+
+    begin
+      response = client.feedback
+      if response[:statusCode] == 200
+        puts "Bounces"
+        response[:bounces].each do |bounce|
+          puts "Email: #{bounce[:email]} Count: #{bounce[:count]} BounceCode: #{bounce[:bounceCode]} LastEventTime: #{bounce[:lastEventTime]}"
+        end
+        puts "Clicks"
+        response[:clicks].each do |click|
+          puts "Email: #{click[:email]} Count: #{click[:count]} LastEventTime: #{click[:lastEventTime]}"
+        end
+      else
+        puts "#{response[:statusMessage]}"
+      end
+    rescue Exception=>e
+      puts "Exception thrown.  Error during feedback retrieval: #{e.message}"
+    end
+
+#### License
+
+
+    Copyright (c) 2013 Mail Bypass, Inc.
+
+    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+    with the License. You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software distributed under the License is
+    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and limitations under the License

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = '-c -f d'
+end
+task :default => :spec

data/lib/messagebus-sdk/actionmailer_client.rb

@@ -0,0 +1,88 @@
+# Copyright 2013 Message Bus, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# 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 'api_client'
+
+class MessagebusActionMailerClient < MessagebusApiClient
+
+  #used by ActionMailer
+  def deliver(message)
+    deliver!(message)
+  end
+
+  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
+
+    custom_headers = {}
+
+    custom_headers["envelope-sender"] = message.return_path if !message.return_path.nil?
+    custom_headers["bcc"] = message.bcc[0] if !message.bcc.nil?
+
+    session_key = DEFAULT
+    message.header.fields.each do |f|
+      if f.name == HEADER_SESSION_KEY
+        session_key = f.value
+      else
+        if f.name =~ /x-.*/i
+          custom_headers[f.name] = f.value
+        end
+      end
+    end
+
+    msg = {
+      :toEmail => message.to.first,
+      :toName => "",
+      :subject => message.subject,
+      :fromEmail => from_email,
+      :fromName => from_name,
+      :sessionKey => session_key,
+      :customHeaders => custom_headers
+    }
+
+    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
+      send_messages([msg])
+    rescue => message_bus_api_error
+      raise "Messagebus API error=#{message_bus_api_error}, message=#{msg.inspect}"
+    end
+
+  end
+
+  private
+  def from_email_with_name(address)
+    address.match(/^(.*)\s<(.*?)>/)
+  end
+end
+

data/lib/messagebus-sdk/api_client.rb

@@ -0,0 +1,69 @@
+# Copyright 2013 Message Bus, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# 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 'messagebus_base'
+
+class MessagebusApiClient < MessagebusSDK::MessagebusBase
+
+  def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+    super(api_key, api_endpoint)
+    @rest_endpoints = define_rest_endpoints
+  end
+
+  def send_messages(params)
+    path =  @rest_endpoints[:message_emails_send]
+    json = {:messages => params}.to_json
+    make_api_request(path, HTTP_POST, json)
+  end
+
+  def channels
+    path = "#{@rest_endpoints[:channels]}"
+    make_api_request(path, HTTP_GET)
+  end
+
+  def channel_config(channel_key)
+    path =  replace_channel_key("#{@rest_endpoints[:channel_config]}", channel_key)
+    make_api_request(path, HTTP_GET)
+  end
+
+  def channel_sessions(channel_key)
+    path =  replace_channel_key("#{@rest_endpoints[:channel_sessions]}", channel_key)
+    make_api_request(path, HTTP_GET)
+  end
+
+  def channel_create_session(channel_key, session_name)
+    path =  replace_channel_key("#{@rest_endpoints[:channel_sessions]}", channel_key)
+    json = {:sessionName => session_name}.to_json
+    make_api_request(path, HTTP_POST, json)
+  end
+
+  def channel_rename_session(channel_key, session_key, session_name)
+    path = replace_channel_and_session_key("#{@rest_endpoints[:channel_session_rename]}", channel_key, session_key)
+    json = {:sessionName => session_name}.to_json
+    make_api_request(path, HTTP_PUT, json)
+  end
+
+  private
+
+  def define_rest_endpoints
+    {
+      :message_emails_send => "/api/v4/message/email/send",
+      :channels => "/api/v4/channels",
+      :channel_config => "/api/v4/channel/%CHANNEL_KEY%/config",
+      :channel_sessions => "/api/v4/channel/%CHANNEL_KEY%/sessions",
+      :channel_session_rename => "/api/v4/channel/%CHANNEL_KEY%/session/%SESSION_KEY%/rename"
+    }
+  end
+end
+

data/lib/messagebus-sdk/feedback_client.rb

@@ -0,0 +1,104 @@
+# Copyright 2013 Message Bus, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# 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 'messagebus_base'
+
+class MessagebusFeedbackClient < MessagebusSDK::MessagebusBase
+
+  def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+    super(api_key, api_endpoint)
+    @rest_endpoints = define_rest_endpoints
+  end
+
+  def feedback(start_date = '', end_date = '', scope = SCOPE_ALL, use_send_time = TRUE_VALUE)
+    path = "#{@rest_endpoints[:feedback]}#{feedback_query_args(start_date, end_date, use_send_time, scope)}"
+    make_api_request(path)
+  end
+
+  def feedback_by_channel(channel_key, start_date = '', end_date = '', scope = SCOPE_ALL, use_send_time  = TRUE_VALUE)
+    path = "#{replace_channel_key(@rest_endpoints[:feedback_channel], channel_key)}#{feedback_query_args(start_date, end_date, use_send_time, scope)}"
+    make_api_request(path)
+  end
+
+  def feedback_by_session(channel_key, session_key, start_date = '', end_date = '', scope = SCOPE_ALL, use_send_time  = TRUE_VALUE)
+    path = "#{replace_channel_and_session_key(@rest_endpoints[:feedback_session], channel_key, session_key)}#{feedback_query_args(start_date, end_date, use_send_time, scope)}"
+    make_api_request(path)
+  end
+
+  def unsubs(start_date = '', end_date = '')
+    path = "#{@rest_endpoints[:unsubs]}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def unsubs_by_channel(channel_key, start_date = '', end_date = '')
+    path = "#{replace_channel_key(@rest_endpoints[:unsubs_channel], channel_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def unsubs_by_session(channel_key, session_key, start_date = '', end_date = '')
+    path = "#{replace_channel_and_session_key(@rest_endpoints[:unsubs_session], channel_key, session_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def complaints(start_date = '', end_date = '')
+    path = "#{@rest_endpoints[:complaints]}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def complaints_by_channel(channel_key, start_date = '', end_date = '')
+    path = "#{replace_channel_key(@rest_endpoints[:complaints_channel], channel_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def complaints_by_session(channel_key, session_key, start_date = '', end_date = '')
+    path = "#{replace_channel_and_session_key(@rest_endpoints[:complaints_session], channel_key, session_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def bounces(start_date = '', end_date = '')
+    path = "#{@rest_endpoints[:bounces]}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def bounces_by_channel(channel_key, start_date = '', end_date = '')
+    path = "#{replace_channel_key(@rest_endpoints[:bounces_channel], channel_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def bounces_by_session(channel_key, session_key, start_date = '', end_date = '')
+    path = "#{replace_channel_and_session_key(@rest_endpoints[:bounces_session], channel_key, session_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  private
+
+  def define_rest_endpoints
+    {
+      :feedback => "/api/v4/feedback",
+      :feedback_channel => "/api/v4/feedback/channel/%CHANNEL_KEY%",
+      :feedback_session => "/api/v4/feedback/channel/%CHANNEL_KEY%/session/%SESSION_KEY%",
+      :unsubs => "/api/v4/unsubs",
+      :unsubs_channel => "/api/v4/unsubs/channel/%CHANNEL_KEY%",
+      :unsubs_session => "/api/v4/unsubs/channel/%CHANNEL_KEY%/session/%SESSION_KEY%",
+      :complaints => "/api/v4/complaints",
+      :complaints_channel => "/api/v4/complaints/channel/%CHANNEL_KEY%",
+      :complaints_session => "/api/v4/complaints/channel/%CHANNEL_KEY%/session/%SESSION_KEY%",
+      :bounces => "/api/v4/bounces",
+      :bounces_channel => "/api/v4/bounces/channel/%CHANNEL_KEY%",
+      :bounces_session => "/api/v4/bounces/channel/%CHANNEL_KEY%/session/%SESSION_KEY%"
+    }
+  end
+
+end
+