messagebus-sdk 4.1.0

data/lib/messagebus-sdk/messagebus_base.rb

@@ -0,0 +1,247 @@
+# 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 'json'
+require 'net/http'
+require 'messagebus_version'
+require 'messagebus_errors'
+
+
+module MessagebusSDK
+
+  class MessagebusBase
+    DEFAULT_API_ENDPOINT = 'https://api-v4.messagebus.com'
+    DEFAULT = 'DEFAULT'
+    HEADER_SESSION_KEY = 'X-MESSAGEBUS-SESSIONKEY'
+    SCOPE_ALL = 'all'
+    TRUE_VALUE = 'true'
+    MAX_TEMPLATE_MESSAGES = 25
+
+    HTTP_GET = "GET"
+    HTTP_POST = "POST"
+    HTTP_PUT = "PUT"
+    HTTP_DELETE = "DELETE"
+
+    def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+      @api_endpoint = api_endpoint
+      @api_key = api_key
+      init_http_connection(@api_endpoint)
+
+      @results = base_response_params
+      @rest_http_errors = define_rest_http_errors
+    end
+
+    def api_version
+      make_api_request("/api/version")
+    end
+
+    def cacert_info(cert_file)
+      @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      if !File.exists?(cert_file)
+        raise MessagebusSDK::MissingFileError.new("Unable to read file #{cert_file}")
+      end
+      @http.ca_file = File.join(cert_file)
+    end
+
+    def format_iso_time(time)
+      time.strftime("%Y-%m-%dT%H:%M:%SZ")
+    end
+
+    private
+
+    def init_http_connection(target_server)
+      if (@http and @http.started?)
+        @http.finish
+      end
+      @last_init_time = Time.now.utc
+      endpoint_url = URI.parse(target_server)
+      @http = Net::HTTP.new(endpoint_url.host, endpoint_url.port)
+      @http.use_ssl = true
+      @http
+    end
+
+    def common_http_headers
+      {'User-Agent' => MessagebusSDK::Info.get_user_agent, 'X-MessageBus-Key' => @api_key}
+    end
+
+    def rest_post_headers
+      {"Content-Type" => "application/json; charset=utf-8"}
+    end
+
+    def date_range(start_date, end_date)
+      date_range_str=""
+      if (start_date!="")
+        date_range_str+="startDate=#{start_date}"
+      end
+      if (end_date!="")
+        if (date_range_str!="")
+          date_range_str+="&"
+        end
+        date_range_str+="endDate=#{end_date}"
+      end
+      date_range_str
+    end
+
+    def set_date(date_string, days_ago)
+      if date_string.length == 0
+        return date_str_for_time_range(days_ago)
+      end
+      date_string
+    end
+
+    def date_str_for_time_range(days_ago)
+      format_iso_time(Time.now.utc - (days_ago*86400))
+    end
+
+    def well_formed_address?(address)
+      !address.match(/^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i).nil?
+    end
+
+    def make_api_request(path, request_type=HTTP_GET, data='')
+      if (@last_init_time < Time.now.utc - 60)
+        init_http_connection(@api_endpoint)
+      end
+
+      headers = common_http_headers
+      case request_type
+        when HTTP_GET
+          response = @http.request_get(path, headers)
+        when HTTP_PUT
+          headers = common_http_headers.merge(rest_post_headers)
+          response = @http.request_put(path, data, headers)
+        when HTTP_POST
+          headers = common_http_headers.merge(rest_post_headers)
+          response = @http.request_post(path, data, headers)
+        when HTTP_DELETE
+          response = @http.delete(path, headers)
+      end
+      check_response(response)
+    end
+
+    def check_response(response, symbolize_names=true)
+      case response
+        when Net::HTTPSuccess
+          begin
+            return JSON.parse(response.body, :symbolize_names => symbolize_names)
+          rescue JSON::ParserError => e
+            raise MessagebusSDK::RemoteServerError.new("JSON parsing error.  Response started with #{response.body.slice(0..9)}")
+          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 MessagebusSDK::RemoteServerError.new("#{response.code.to_s}:#{rest_http_error_message(response)}")
+          else
+            raise MessagebusSDK::RemoteServerError.new("#{response.code.to_s}:#{rest_http_error_message(response)}")
+          end
+        else
+          raise "Unexpected HTTP Response: #{response.class.name}"
+      end
+      raise "Could not determine response"
+    end
+
+    def rest_http_error?(status_code)
+      @rest_http_errors.key?(status_code)
+    end
+
+    def rest_http_error_message(response)
+      message = "Unknown Error 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
+
+    def replace_token_with_key(path, token, key)
+      path.gsub(token, key)
+    end
+
+    def replace_channel_key(path, channel_key)
+      replace_token_with_key(path, "%CHANNEL_KEY%", channel_key)
+    end
+
+    def replace_channel_and_session_key(path, channel_key, session_key)
+      replace_channel_key(replace_token_with_key(path, "%SESSION_KEY%", session_key), channel_key)
+    end
+
+    def feedback_query_args(start_date, end_date, use_send_time, scope)
+      query_string_parts = ["useSendTime=#{use_send_time}", "scope=#{scope}"]
+      date_range = "#{date_range(start_date, end_date)}"
+      query_string_parts << date_range if date_range != ""
+      "?" + query_string_parts.join("&")
+    end
+
+    def underscore(camel_cased_word)
+       camel_cased_word.to_s.gsub(/::/, '/').
+         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+         gsub(/([a-z\d])([A-Z])/,'\1_\2').
+         tr("-", "_").
+         downcase
+     end
+
+    def snake_case
+      return downcase if match(/\A[A-Z]+\z/)
+      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z])([A-Z])/, '\1_\2').
+      downcase
+    end
+
+    def define_rest_http_errors
+      {
+        "400" => "Invalid Request",
+        "401" => "Unauthorized-Missing API Key",
+        "403" => "Unauthorized-Invalid API Key",
+        "404" => "Incorrect URL",
+        "405" => "Method not allowed",
+        "406" => "Format not acceptable",
+        "408" => "Request Timeout",
+        "409" => "Conflict",
+        "410" => "Object missing or deleted",
+        "413" => "Too many messages in request",
+        "415" => "POST JSON data invalid",
+        "422" => "Unprocessable Entity",
+        "500" => "Internal Server Error",
+        "501" => "Not Implemented",
+        "503" => "Service Unavailable",
+        "507" => "Insufficient Storage"
+      }
+    end
+
+    def base_response_params
+      {:statusCode => 0,
+       :statusMessage => "",
+       :statusTime => "1970-01-01T00:00:00.000Z"}
+    end
+
+    def base_message_params
+      {:toEmail => '',
+       :fromEmail => '',
+       :subject => '',
+       :toName => '',
+       :fromName => '',
+       :plaintextBody => '',
+       :htmlBody => '',
+       :sessionKey => DEFAULT,
+       :customHeaders => {} }
+    end
+
+  end
+end

data/lib/messagebus-sdk/messagebus_errors.rb

@@ -0,0 +1,40 @@
+# 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.
+
+module MessagebusSDK
+
+  class APIParameterError < StandardError
+    def initialize(problematic_parameter="")
+      super("missing or malformed parameter #{problematic_parameter}")
+    end
+  end
+
+  class TemplateError < StandardError
+  end
+
+  class BadAPIKeyError < StandardError
+  end
+
+  class MissingFileError <StandardError
+  end
+
+  class RemoteServerError < StandardError
+    attr_reader :result
+    def initialize(message, result={})
+      super(message)
+      @result = result
+    end
+  end
+  
+end

data/lib/messagebus-sdk/messagebus_version.rb

@@ -0,0 +1,27 @@
+# Copyright 2012 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.
+
+module MessagebusSDK
+  VERSION = "4.1.0"
+
+  class Info
+    @@ClientVersion = MessagebusSDK::VERSION
+    @@RubyVersion = RUBY_VERSION
+    @@UserAgent = "MessagebusAPI:#{@@ClientVersion}-Ruby:#{@@RubyVersion}";
+
+    def self.get_user_agent
+      return @@UserAgent
+    end
+  end
+end

data/lib/messagebus-sdk/stats_client.rb

@@ -0,0 +1,50 @@
+# 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 MessagebusStatsClient < MessagebusSDK::MessagebusBase
+
+  def initialize(api_key, api_endpoint = DEFAULT_API_ENDPOINT)
+    super(api_key, api_endpoint)
+    @rest_endpoints = define_rest_endpoints
+  end
+
+  def stats(start_date = '', end_date = '')
+    path = "#{@rest_endpoints[:stats]}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def stats_by_channel(channel_key, start_date = '', end_date = '')
+    path = "#{replace_channel_key(@rest_endpoints[:stats_channel], channel_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  def stats_by_session(channel_key, session_key, start_date = '', end_date = '')
+    path = "#{replace_channel_and_session_key(@rest_endpoints[:stats_session], channel_key, session_key)}?#{date_range(start_date, end_date)}"
+    make_api_request(path)
+  end
+
+  private
+
+  def define_rest_endpoints
+    {
+      :stats => "/api/v4/stats/email",
+      :stats_channel => "/api/v4/stats/email/channel/%CHANNEL_KEY%",
+      :stats_session => "/api/v4/stats/email/channel/%CHANNEL_KEY%/session/%SESSION_KEY%",
+    }
+  end
+
+end
+

data/lib/messagebus-sdk/template_client.rb

@@ -0,0 +1,79 @@
+# 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 MessagebusTemplateClient < MessagebusSDK::MessagebusBase
+  DEFAULT_TEMPLATE_ENDPOINT = 'https://templates-v4-jy01-prod.messagebus.com'
+
+  def initialize(api_key, api_endpoint = DEFAULT_TEMPLATE_ENDPOINT)
+    super(api_key, api_endpoint)
+    @rest_endpoints = define_rest_endpoints
+  end
+
+  def template_version
+    make_api_request(@rest_endpoints[:template_version])
+  end
+
+  def create_template(params)
+    path = @rest_endpoints[:templates]
+    template_params = base_template_params.merge!(params)
+    make_api_request(path, HTTP_POST, template_params.to_json)
+  end
+
+  def get_template(template_key)
+    path = replace_token_with_key(@rest_endpoints[:template], "%TEMPLATE_KEY%", template_key)
+    make_api_request(path)
+  end
+
+  def send_messages(template_key, params)
+    if params.length > MessagebusSDK::MessagebusBase::MAX_TEMPLATE_MESSAGES
+      raise MessagebusSDK::TemplateError.new("Max number of template messages per send exceeded #{MessagebusSDK::MessagebusBase::MAX_TEMPLATE_MESSAGES}")
+    end
+
+    path = @rest_endpoints[:templates_send]
+    json = {:templateKey => template_key, :messages => params}.to_json
+    make_api_request(path, HTTP_POST, json)
+  end
+
+  def templates
+    path = "#{@rest_endpoints[:templates]}"
+    make_api_request(path)
+  end
+end
+
+private
+def define_rest_endpoints
+  {
+    :template_version => "/api/v4/templates/version",
+    :template => "/api/v4/template/%TEMPLATE_KEY%",
+    :templates => "/api/v4/templates",
+    :templates_send => "/api/v4/templates/email/send"
+  }
+end
+
+def base_template_params
+  {:toEmail => '',
+   :fromEmail => '',
+   :subject => '',
+   :toName => '',
+   :fromName => '',
+   :returnPath => '',
+   :plaintextBody => '',
+   :htmlBody => '',
+   :sessionKey => DEFAULT,
+   :options => {},
+   :customHeaders => {} }
+end
+

data/lib/messagebus-sdk.rb

@@ -0,0 +1,23 @@
+# Copyright 2012 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.
+
+dir = File.dirname(__FILE__)
+
+require 'net/https'
+require 'uri'
+require 'cgi'
+
+require "#{dir}/messagebus-sdk/messagebus_errors"
+require "#{dir}/messagebus-sdk/messagebus_base"
+require "#{dir}/messagebus-sdk/messagebus_version"

data/spec/messagebus-sdk/actionmailer_client_spec.rb

@@ -0,0 +1,71 @@
+
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/messagebus-sdk/api_client"
+
+describe MessagebusActionMailerClient do
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "7215ee9c7d9dc229d2921a40e899ec5f"
+    @client = MessagebusApiClient.new(@api_key)
+  end
+
+  describe "#deliver" do
+    it "works with action mailer" do
+      to_email = "hello@example.com"
+      session_key = "DEFAULT"
+      message = MessageBusActionMailerTest.new_message(to_email, session_key)
+
+      FakeWeb.register_uri(:post, "#{API_URL}/message/email/send", :body => json_valid_send)
+      message.deliver
+
+      message_body = JSON.parse(FakeWeb.last_request.body)
+      message_params = message_body["messages"][0]
+      message_params["toName"].should == ""
+      message_params["toEmail"].should == to_email
+      message_params["sessionKey"].should == "DEFAULT"
+      message_params["customHeaders"].should == {"envelope-sender"=>"bounce@bounce.example.com"}
+    end
+
+    it "works with from with nice name in address" do
+      to_email = "Joe Mail <hello_joe@example.com>"
+      session_key = "5b39c8b553c821e7cddc6da64b5bd2ee"
+      message = MessageBusActionMailerTest.new_message(to_email, session_key)
+
+      FakeWeb.register_uri(:post, "#{API_URL}/message/email/send", :body => json_valid_send)
+      message.deliver
+
+      message_body = JSON.parse(FakeWeb.last_request.body)
+      message_params = message_body["messages"][0]
+      message_params["toName"].should == ""
+      message_params["toEmail"].should == "hello_joe@example.com"
+      message_params["fromName"].should == "Mail Test"
+      message_params["fromEmail"].should == "no-reply@messagebus.com"
+      message_params["sessionKey"].should == session_key
+    end
+
+    it "adds bcc and x-* headers to custom_headers" do
+      to_email = "hello@example.com"
+      session_key = "DEFAULT"
+      bcc = "goodbye@example.com"
+      x_headers = {"x-header-a" => "header1", "x-tracking" => "1234"}
+      message = MessageBusActionMailerTest.new_message(to_email, session_key, bcc, x_headers)
+
+      FakeWeb.register_uri(:post, "#{API_URL}/message/email/send", :body => json_valid_send)
+      message.deliver
+
+      message_body = JSON.parse(FakeWeb.last_request.body)
+      message_params = message_body["messages"][0]
+      message_params["toName"].should == ""
+      message_params["toEmail"].should == to_email
+      message_params["sessionKey"].should == "DEFAULT"
+      message_params["customHeaders"]["envelope-sender"].should == "bounce@bounce.example.com"
+      message_params["customHeaders"]["bcc"].should == "goodbye@example.com"
+      message_params["customHeaders"]["x-header-a"].should == "header1"
+      message_params["customHeaders"]["x-tracking"].should == "1234"
+      message_params["customHeaders"]["X-MESSAGEBUS-SESSIONKEY"].should be_nil
+    end
+  end
+end

data/spec/messagebus-sdk/api_client_spec.rb

@@ -0,0 +1,75 @@
+
+dir = File.dirname(__FILE__)
+require "#{dir}/../spec_helper"
+require "#{dir}/../../lib/messagebus-sdk/api_client"
+
+describe MessagebusApiClient do
+
+  class MessagebusApiTest < MessagebusApiClient
+    attr_accessor :last_init_time
+  end
+
+  def default_message_params
+    {:toEmail => 'apitest1@messagebus.com',
+     :toName => 'EmailUser',
+     :fromEmail => 'api@messagebus.com',
+     :fromName => 'API',
+     :subject => 'Unit Test Message',
+     :customHeaders => ["sender"=>"apitest1@messagebus.com"],
+     :plaintextBody => 'This message is only a test sent by the Ruby Message Bus client library.',
+     :htmlBody => "<html><body>This message is only a test sent by the Ruby Message Bus client library.</body></html>",
+     :sessionKey => "dab775c6e6aa203324598fefbd1e8baf"
+    }
+  end
+
+  attr_reader :client, :api_key
+
+  before do
+    FakeWeb.allow_net_connect = false
+    @api_key = "7215ee9c7d9dc229d2921a40e899ec5f"
+    @client = MessagebusApiClient.new(@api_key)
+  end
+
+  describe "#send_messages" do
+    it "should have user-agent and x-messagebus-key set in request headers" do
+      FakeWeb.register_uri(:post, "#{API_URL}/message/email/send", :body => json_valid_send)
+      client.send_messages(default_message_params)
+
+      FakeWeb.last_request.get_fields("X-MessageBus-Key").should_not be_nil
+      FakeWeb.last_request.get_fields("User-Agent").should_not be_nil
+      FakeWeb.last_request.get_fields("Content-Type").should_not be_nil
+    end
+
+    it "sends messages" do
+      FakeWeb.register_uri(:post, "#{API_URL}/message/email/send", :body => json_valid_send)
+      results = client.send_messages(default_message_params)
+      results[:results].size.should == 1
+    end
+  end
+
+  describe "http connection" do
+    before do
+      @http_client = MessagebusApiTest.new(@api_key)
+    end
+
+    it "doesnt reset connection if under a minute old" do
+      current_init_time=@http_client.last_init_time
+      current_init_time.should be > Time.now.utc-5
+      FakeWeb.register_uri(:post, "#{API_URL}/message/email/send", :body => json_valid_send)
+      results = @http_client.send_messages(default_message_params)
+      results[:results].size.should == 1
+      @http_client.last_init_time.should == current_init_time
+    end
+
+    it "resets connection if over a minute old" do
+      @http_client.last_init_time=Time.now.utc-60
+      current_init_time=@http_client.last_init_time
+      current_init_time.should be < Time.now.utc-59
+      FakeWeb.register_uri(:post, "#{API_URL}/message/email/send", :body => json_valid_send)
+      results = @http_client.send_messages(default_message_params)
+      results[:results].size.should == 1
+      @http_client.last_init_time.should be > current_init_time
+    end
+  end
+
+end