RubyGems - messagebus_ruby_api - Versions diffs - 1.0.1 → 1.0.3 - Mend

messagebus_ruby_api 1.0.1 → 1.0.3

Files changed (9) hide show

data/README.rdoc +18 -9
data/lib/messagebus_ruby_api/errors.rb +11 -5
data/lib/messagebus_ruby_api/messagebus.rb +44 -25
data/lib/messagebus_ruby_api/version.rb +11 -5
data/lib/messagebus_ruby_api.rb +11 -5
data/spec/messagebus_ruby_api/messagebus_spec.rb +65 -25
data/spec/spec_core_extensions.rb +11 -5
data/spec/spec_helper.rb +10 -4
metadata +5 -5

data/README.rdoc CHANGED Viewed

@@ -1,4 +1,4 @@
-= Messagebus Ruby API
+= Message Bus Ruby API
 == Installation
@@ -24,8 +24,8 @@
         :fromName => 'API',
         :subject => 'Unit Test Message',
         :customHeaders => ["sender"=>"apitest1@messagebus.com"],
-        :plaintextBody => 'This message is only a test sent by the Ruby MessageBus client library.',
-        :htmlBody => "<html><body>This message is only a test sent by the Ruby MessageBus client library.</body></html>",
+        :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>",
         :tags => ['RUBY']
       }
@@ -53,13 +53,22 @@
     http://curl.haxx.se/ca/cacert.pem
-== Older Versions
-If you are using the old api with the text OK:<UUID> responses, please be sure to get the 'v1' branch
-If you are using the old api with the 'body' parameter (instead of the new 'plaintextBody' and 'htmlBody' parameters), please be sure to get the 'v0' branch
 == Tests
   To run the tests, issue the following command from the root of the project:
   bundle exec rspec spec/messagebus_ruby_api/client_spec.rb
+== License
+  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.
 == More info
-  Contact MessageBus if you have questions or problems (https://www.messagebus.com/contact)
+  Contact Message Bus if you have questions or problems (https://www.messagebus.com/contact)

data/lib/messagebus_ruby_api/errors.rb CHANGED Viewed

@@ -1,10 +1,16 @@
-# Copyright (c) 2011. Message Bus
+# 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
+# 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
+#   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
+# 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 MessagebusApi
@@ -28,4 +34,4 @@ module MessagebusApi
     end
   end
-end
+end

data/lib/messagebus_ruby_api/messagebus.rb CHANGED Viewed

@@ -1,14 +1,19 @@
-# Copyright (c) 2011. Message Bus
+# 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
+# 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
+#   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
+# 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 MessagebusApi
   DEFAULT_API_ENDPOINT_STRING = 'https://api.messagebus.com'
   class Messagebus
     TEMPLATE = 'template'
     EMAIL= 'email'
@@ -17,8 +22,7 @@ module MessagebusApi
     def initialize(api_key)
       @api_key = api_key
-      @http = http_connection(DEFAULT_API_ENDPOINT_STRING)
+      init_http_connection
       @user_agent = "MessagebusAPI:#{MessagebusApi::VERSION}-Ruby:#{RUBY_VERSION}"
       @msg_buffer_size = 20
@@ -78,6 +82,9 @@ module MessagebusApi
       end
       json = json_message_from_list(@msg_buffer)
+      if (@last_init_time < Time.now.utc - 60)
+        init_http_connection
+      end
       @results=make_api_post_call(endpoint, json)
       @msg_buffer.clear
       @msg_buffer_flushed = true
@@ -108,25 +115,19 @@ module MessagebusApi
     end
     def unsubscribes(start_date = '', end_date = '')
-      end_date = set_date(end_date, 0)
-      start_date = set_date(start_date, 7)
       path = "#{@rest_endpoints[:unsubscribes]}?#{date_range(start_date, end_date)}"
       @results = make_api_get_call(path)
       @results
     end
-    def delivery_errors(start_date = '', end_date = '')
-      end_date = set_date(end_date, 0)
-      start_date = set_date(start_date, 1)
-      path = "#{@rest_endpoints[:delivery_errors]}?#{date_range(start_date, end_date)}"
+    def delivery_errors(start_date = '', end_date = '', tag='')
+      path = "#{@rest_endpoints[:delivery_errors]}?#{date_range(start_date, end_date)}&tag=#{URI.escape(tag)}"
       @results = make_api_get_call(path)
       @results
     end
     def stats(start_date = '', end_date = '', tag = '')
-      end_date = set_date(end_date, 0)
-      start_date = set_date(start_date, 30)
-      path = "#{@rest_endpoints[:stats]}?#{date_range(start_date, end_date)}&tag=#{tag}"
+      path = "#{@rest_endpoints[:stats]}?#{date_range(start_date, end_date)}&tag=#{URI.escape(tag)}"
       @results = make_api_get_call(path)
       @results
     end
@@ -139,13 +140,21 @@ module MessagebusApi
       @http.ca_file = File.join(cert_file)
     end
+    def format_iso_time(time)
+      time.strftime("%Y-%m-%dT%H:%M:%SZ")
+    end
     private
-    def http_connection(endpoint_url_string)
-      endpoint_url = URI.parse(endpoint_url_string)
-      http = Net::HTTP.new(endpoint_url.host, endpoint_url.port)
-      http.use_ssl = true
-      http
+    def init_http_connection(target_server=DEFAULT_API_ENDPOINT_STRING)
+      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
@@ -168,7 +177,17 @@ module MessagebusApi
     end
     def date_range(start_date, end_date)
-      "startDate=#{start_date}&endDate=#{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)
@@ -179,7 +198,7 @@ module MessagebusApi
     end
     def date_str_for_time_range(days_ago)
-      (Time.now.utc - (days_ago*86400)).strftime("%Y-%m-%d")
+      format_iso_time(Time.now.utc - (days_ago*86400))
     end
     def json_message_from_list(messages)
@@ -289,7 +308,7 @@ module MessagebusApi
        :plaintextBody => '',
        :htmlBody => '',
        :customHeaders => {},
-       :tags => [] }
+       :tags => []}
     end
     def base_template_params
@@ -297,7 +316,7 @@ module MessagebusApi
        :toName => '',
        :templateKey => '',
        :mergeFields => {},
-       :customHeaders => {} }
+       :customHeaders => {}}
     end
   end

data/lib/messagebus_ruby_api/version.rb CHANGED Viewed

@@ -1,11 +1,17 @@
-# Copyright (c) 2011. Message Bus
+# 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
+# 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
+#   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
+# 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 MessagebusApi
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

data/lib/messagebus_ruby_api.rb CHANGED Viewed

@@ -1,10 +1,16 @@
-# Copyright (c) 2011. Message Bus
+# 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
+# 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
+#   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
+# 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__)
@@ -14,4 +20,4 @@ require 'cgi'
 require "#{dir}/messagebus_ruby_api/errors"
 require "#{dir}/messagebus_ruby_api/messagebus"
-require "#{dir}/messagebus_ruby_api/version"
+require "#{dir}/messagebus_ruby_api/version"

data/spec/messagebus_ruby_api/messagebus_spec.rb CHANGED Viewed

@@ -1,36 +1,46 @@
-# Copyright (c) 2011. Message Bus
+# 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
+# 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
+#   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
+# 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 "#{dir}/../spec_helper"
+class MessagebusTest < MessagebusApi::Messagebus
+  attr_accessor :last_init_time
+end
 describe MessagebusApi::Messagebus do
   attr_reader :client, :api_key, :required_params
   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 MessageBus client library.',
-      :htmlBody => "<html><body>This message is only a test sent by the Ruby MessageBus client library.</body></html>",
-      :tags => ['RUBY', 'Unit Test Ruby']
+    {: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>",
+     :tags => ['RUBY', 'Unit Test Ruby']
     }
   end
   def default_template_message_params
-    { :toEmail => 'apitest1@messagebus.com',
-      :toName => 'John Smith',
-      :templateKey => '66f6181bcb4cff4cd38fbc804a036db6',
-      :customHeaders => ["reply-to"=>"apitest1@messagebus.com"],
-      :mergeFields => ["%NAME%" => "John"]
+    {:toEmail => 'apitest1@messagebus.com',
+     :toName => 'John Smith',
+     :templateKey => '66f6181bcb4cff4cd38fbc804a036db6',
+     :customHeaders => ["reply-to"=>"apitest1@messagebus.com"],
+     :mergeFields => ["%NAME%" => "John"]
     }
   end
@@ -39,7 +49,7 @@ describe MessagebusApi::Messagebus do
     num_result.times do
       list << @success_message
     end
     success_result = {
       "statusMessage" => "OK",
       "successCount" => num_result,
@@ -51,21 +61,21 @@ describe MessagebusApi::Messagebus do
   def create_results_array
     results = {
-        "statusMessage" => "OK",
-        "results" => []
+      "statusMessage" => "OK",
+      "results" => []
     }
     results
   end
   def json_parse(data)
-     JSON.parse(data, :symbolize_names => true)
+    JSON.parse(data, :symbolize_names => true)
   end
   before do
     FakeWeb.allow_net_connect = false
     @api_key = "7215ee9c7d9dc229d2921a40e899ec5f"
-    @client = MessagebusApi::Messagebus.new(@api_key)
+    @client = MessagebusTest.new(@api_key)
     @success_message={
       "status" => 200,
       "messageId" => "abcdefghijklmnopqrstuvwxyz012345"
@@ -159,6 +169,29 @@ describe MessagebusApi::Messagebus do
       client.flushed?.should be_true
       client.results[:results].size.should == message_count
     end
+    it "doesnt reset connection if under a minute old" do
+      current_init_time=client.last_init_time
+      current_init_time.should be > Time.now.utc-5
+      FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v3/emails/send", :body => create_success_result(1).to_json)
+      client.add_message(default_message_params)
+      client.flush
+      client.flushed?.should be_true
+      client.results[:results].size.should == 1
+      client.last_init_time.should == current_init_time
+    end
+    it "resets connection if over a minute old" do
+      client.last_init_time=Time.now.utc-60
+      current_init_time=client.last_init_time
+      current_init_time.should be < Time.now.utc-59
+      FakeWeb.register_uri(:post, "https://api.messagebus.com/api/v3/emails/send", :body => create_success_result(1).to_json)
+      client.add_message(default_message_params)
+      client.flush
+      client.flushed?.should be_true
+      client.results[:results].size.should == 1
+      client.last_init_time.should be > current_init_time
+    end
   end
   describe "#message_buffer_size=" do
@@ -192,7 +225,7 @@ describe MessagebusApi::Messagebus do
       start_date_str="2011-01-01"
       end_date_str="2011-01-02"
-      FakeWeb.register_uri(:get, "https://api.messagebus.com/api/v3/delivery_errors?startDate=#{start_date_str}&endDate=#{end_date_str}", :body => json_delivery_errors)
+      FakeWeb.register_uri(:get, "https://api.messagebus.com/api/v3/delivery_errors?startDate=#{start_date_str}&endDate=#{end_date_str}&tag=", :body => json_delivery_errors)
       expect do
         response = client.delivery_errors(start_date_str, end_date_str)
         FakeWeb.last_request.body.should be_nil
@@ -269,7 +302,7 @@ describe MessagebusApi::Messagebus do
       FakeWeb.register_uri(:post, expected_request, :body => json_mailing_list_create)
       expect do
-        response = client.create_mailing_lists("Test List", ["%EMAIL%","%SOME_TOKEN%"])
+        response = client.create_mailing_lists("Test List", ["%EMAIL%", "%SOME_TOKEN%"])
         response.should == json_parse(json_mailing_list_create)
       end.should_not raise_error
     end
@@ -290,5 +323,12 @@ describe MessagebusApi::Messagebus do
     end
   end
+  describe "#format_iso_time" do
+    it "formats ISO time in format YYYY-MM-DDTHH:mm:ssZ" do
+      client.format_iso_time(Time.now).should =~ /2\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ/
+    end
+  end
 end

data/spec/spec_core_extensions.rb CHANGED Viewed

@@ -1,13 +1,19 @@
-# Copyright (c) 2011. Message Bus
+# 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
+# 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
+#   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
+# 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.
 class Hash
   def without(key)
     self.dup.tap{|hash| hash.delete(key)}
   end
-end
+end

data/spec/spec_helper.rb CHANGED Viewed

@@ -1,10 +1,16 @@
-# Copyright (c) 2011. Message Bus
+# 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
+# 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
+#   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
+# 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__)

metadata CHANGED Viewed

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: messagebus_ruby_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
   prerelease:
 platform: ruby
 authors:
-- Messagebus dev team
+- Message Bus dev team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000Z
+date: 2012-01-20 00:00:00.000000000Z
 dependencies: []
-description: ! 'Allows you to use the Messagebus API '
+description: ! 'Allows you to use the Message Bus API '
 email:
 - messagebus@googlegroups.com
 executables: []
@@ -54,7 +54,7 @@ rubyforge_project: messagebus_ruby_api
 rubygems_version: 1.8.10
 signing_key:
 specification_version: 3
-summary: Send email through Messagebus service
+summary: Send email through the Message Bus service
 test_files:
 - spec/messagebus_ruby_api/cacert.pem
 - spec/messagebus_ruby_api/messagebus_spec.rb