messagebus_ruby_api 0.0.1

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1 @@
+.idea/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree-1.8.7-2010.02@messagebus_ruby_api

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+
+
+group :test, :development do
+  gem 'rspec', '2.5.0'
+  gem 'rr', '1.0.2'
+  gem 'fakeweb'
+end
+
+# Specify your gem's dependencies in messagebus.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    messagebus_ruby_api (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    rr (1.0.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  messagebus_ruby_api!
+  rr (= 1.0.2)
+  rspec (= 2.5.0)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/messagebus_ruby_api/client.rb

@@ -0,0 +1,72 @@
+module MessagebusRubyApi
+  API_ENDPOINT = URI.parse('https://api.messagebus.com:443')
+
+  class Client
+    attr_reader :api_key
+
+    def initialize(api_key)
+      @api_key = verified_reasonable_api_key(api_key)
+      @http = api_endpoint_http_connection
+      @http.use_ssl = true
+    end
+
+    def api_endpoint_http_connection
+      Net::HTTP.new(API_ENDPOINT.host, API_ENDPOINT.port)
+    end
+
+    def complete_url(options)
+      params_string = to_param(check_params(options))
+      url = "/send?operation=sendEmail&#{params_string}"
+      url
+    end
+
+    def api_request(options)
+      Net::HTTP::Post.new(complete_url(options)) #, {"User-Agent" => "messagebus.com Messagebus Ruby API v1"})
+    end
+
+    def send_email(options)
+      verify_required_params(options)
+      response = @http.start do |http|
+        request = api_request(options)
+        http.request(request)
+      end
+
+      raise MessagebusRubyApi::UnknownError unless response.body.match(/^OK/)
+      response
+    end
+
+    def check_params(params)
+      params[:plain_text] = check_plain_text(params[:plain_text]) unless params[:plain_text].nil?
+      params[:priority] = check_priority(params[:priority]) unless params[:priority].nil?
+      params
+    end
+
+    def to_param(params)
+      params.map { |name, val| [name.to_s.camelize, val] }.sort.map { |param_name, param_value| "#{CGI.escape(param_name)}=#{CGI.escape(param_value)}" }.join("&")
+    end
+
+    private
+
+    def check_plain_text(plain_text)
+      raise APIParameterError.new(":plain_text can only be true or false, not \"#{plain_text}\" of type #{plain_text.class}") unless [true, false].include?(plain_text)
+      plain_text ? "1" : "0"
+    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
+    end
+
+    def verified_reasonable_api_key(api_key)
+      raise BadAPIKeyError unless api_key.match(/[a-zA-Z0-9]{20}/)
+      api_key
+    end
+
+    def verify_required_params(params)
+      raise APIParameterError.new("to_email") unless params[:to_email]
+      raise APIParameterError.new("from_email") unless params[:from_email]
+      raise APIParameterError.new("subject") unless params[:subject]
+      raise APIParameterError.new("body") unless params[:body]
+    end
+  end
+end

data/lib/messagebus_ruby_api/core_extensions.rb

@@ -0,0 +1,5 @@
+class String
+  def camelize
+    self.split(/[^a-z0-9]/i).map(&:capitalize).join.tap { |string| string[0, 1] = string[0, 1].downcase }
+  end
+end

data/lib/messagebus_ruby_api/errors.rb

@@ -0,0 +1,15 @@
+module MessagebusRubyApi
+
+  class APIParameterError < StandardError
+    def initialize(problematic_parameter="")
+      super("missing or malformed parameter #{problematic_parameter}")
+    end
+  end
+
+  class BadAPIKeyError < StandardError;
+  end
+
+  class UnknownError < StandardError;
+  end
+  
+end

data/lib/messagebus_ruby_api/version.rb

@@ -0,0 +1,3 @@
+module MessagebusRubyApi
+  VERSION = "0.0.1"
+end

data/lib/messagebus_ruby_api.rb

@@ -0,0 +1,7 @@
+require 'net/https'
+require 'uri'
+require 'cgi'
+
+require 'messagebus_ruby_api/core_extensions'
+require 'messagebus_ruby_api/errors'
+require 'messagebus_ruby_api/client'

data/messagebus.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "messagebus_ruby_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "messagebus_ruby_api"
+  s.version     = MessagebusRubyApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Messagebus dev team"]
+  s.email       = ["messagebus@googlegroups.com"]
+  s.homepage    = ""
+  s.summary     = %q{Send email through Messagebus service}
+  s.description = %q{Allows you to use the Messagebus API }
+
+  s.rubyforge_project = "messagebus_ruby_api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/messagebus_ruby_api/client_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe MessagebusRubyApi::Client do
+  attr_reader :client, :api_key, :required_params
+  before do
+    FakeWeb.allow_net_connect = false
+
+    @api_key = "3"*32
+    @client = MessagebusRubyApi::Client.new(api_key)
+    @required_params = {:to_email => "bob@example.com", :from_email => "alice@example.com", :body => "a nice ocean", :subject => "test subject"}
+  end
+
+  it "requires an api key" do
+    expect do
+      MessagebusRubyApi::Client.new("foo")
+    end.should raise_error(MessagebusRubyApi::BadAPIKeyError)
+  end
+
+  it "knows its API key" do
+    client.api_key.should == api_key
+  end
+
+  describe "required parameters" do
+    it "works when the minimum params are sent" do
+      url_params = client.to_param(required_params)
+      FakeWeb.register_uri(:post, api_url_from_params(url_params), :body => "OK:OK")
+      expect do
+        client.send_email(required_params)
+      end.should_not raise_error
+    end
+
+    it "raises errors when missing to_email param" do
+      api_response = "ERR :Missing required paramater toEmail"
+      expect_api_errors(required_params.without(:to_email), api_response, "to_email")
+    end
+
+    it "raises errors when missing from_email param" do
+      api_response = "ERR:Missing required paramater fromEmail"
+      expect_api_errors(required_params.without(:from_email), api_response, "from_email")
+    end
+
+    it "raises errors when missing subject param" do
+      api_response = "ERR:Missing required paramater subject"
+      expect_api_errors(required_params.without(:subject), api_response, "subject")
+    end
+
+    it "raises errors when missing body param" do
+      api_response = "ERR:Missing required paramater body"
+      expect_api_errors(required_params.without(:body), api_response, "body")
+    end
+  end
+
+  describe "optional parameters" do
+    it "allows to_name" do
+      expect_api_success(required_params.merge(:to_name => "Chuck Norris"))
+    end
+
+    it "allows from_name" do
+      expect_api_success(required_params.merge(:from_name => "Sally Norris"))
+    end
+
+    it "allows tag" do
+      expect_api_success(required_params.merge(:tag => "weekly"))
+    end
+
+    it "allows priority with values 1 through 5" do
+      expect_api_success(required_params.merge(:priority => 1))
+      expect_api_success(required_params.merge(:priority => 2))
+      expect_api_success(required_params.merge(:priority => 3))
+      expect_api_success(required_params.merge(:priority => 4))
+      expect_api_success(required_params.merge(:priority => 5))
+
+      expect do
+        client.send_email(required_params.merge(:priority => "foo"))
+      end.should raise_error(MessagebusRubyApi::APIParameterError)
+
+      expect do
+        client.send_email(required_params.merge(:priority => 0))
+      end.should raise_error(MessagebusRubyApi::APIParameterError)
+
+      expect do
+        client.send_email(required_params.merge(:priority => 6))
+      end.should raise_error(MessagebusRubyApi::APIParameterError)
+    end
+
+    it "allows reply_to" do
+      expect_api_success(required_params.merge(:reply_to => "obiwan@example.com"))
+    end
+
+    it "allows unsubscribe_email" do
+      expect_api_success(required_params.merge(:unsubscribe_email => "unsubscribe@aol.com"))
+    end
+
+    it "allows unsubscribe_url" do
+      expect_api_success(required_params.merge(:unsubscribe_url => "http://foobar.com/unsubscribe"))
+    end
+
+    it "allows plain_text" do
+      expect_api_success(required_params.merge(:plain_text => false))
+      expect_api_success(required_params.merge(:plain_text => true))
+
+      expect do
+        client.send_email(required_params.merge(:plain_text => "omg not a boolean or nil"))
+      end.should raise_error(MessagebusRubyApi::APIParameterError)
+    end
+  end
+
+  describe "#to_param" do
+    it "camelizes param names and sorts them" do
+      client.to_param({:to_email => "bob@example.com", :from_email => "alex@example.com"}).should == "fromEmail=alex%40example.com&toEmail=bob%40example.com"
+    end
+  end
+end
+
+def expect_api_success(params)
+  expected_url = api_url_from_params(client.to_param(client.check_params(params.dup)))
+  FakeWeb.register_uri(:post, expected_url, :body => "OK:OK")
+  expect do
+    response = client.send_email(params)
+    response.body.should == "OK:OK"
+  end.should_not raise_error
+end
+
+def expect_api_errors(params, fake_response, expected_error_message="")
+  expected_params = client.to_param(params.dup)
+  FakeWeb.register_uri(:post, api_url_from_params(expected_params),
+                       :body => fake_response)
+  expect do
+    client.send_email(params)
+  end.should raise_error(MessagebusRubyApi::APIParameterError, "missing or malformed parameter #{expected_error_message}")
+end
+
+def api_url_from_params(url_param_string)
+  "https://api.messagebus.com/send?operation=sendEmail&#{url_param_string}"
+end

data/spec/messagebus_ruby_api/spec_core_extensions.rb

@@ -0,0 +1,5 @@
+class Hash
+  def without(key)
+    self.dup.tap{|hash| hash.delete(key)}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+dir = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'fakeweb'
+
+require 'messagebus_ruby_api/spec_core_extensions'
+
+require "#{dir}/../lib/messagebus_ruby_api"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: messagebus_ruby_api
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Messagebus dev team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "Allows you to use the Messagebus API "
+email: 
+- messagebus@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .bundle/config
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/messagebus_ruby_api.rb
+- lib/messagebus_ruby_api/client.rb
+- lib/messagebus_ruby_api/core_extensions.rb
+- lib/messagebus_ruby_api/errors.rb
+- lib/messagebus_ruby_api/version.rb
+- messagebus.gemspec
+- spec/messagebus_ruby_api/client_spec.rb
+- spec/messagebus_ruby_api/spec_core_extensions.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: messagebus_ruby_api
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Send email through Messagebus service
+test_files: 
+- spec/messagebus_ruby_api/client_spec.rb
+- spec/messagebus_ruby_api/spec_core_extensions.rb
+- spec/spec_helper.rb