bronto 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c681496d7016c12c58c845bb6ab4015023cadb5e
-  data.tar.gz: a8fcc747ccf3adb5be9eca0b9702c4cfeedf9e3c
+  metadata.gz: b01f64270c336075cec3e434fd8a71380e5bc112
+  data.tar.gz: d5d1df226d643bb5f584656ef7dd07e6db02243e
 SHA512:
-  metadata.gz: 3463350ab61e037b53800d411241fa52613729381a5d69ad4e4858aa296fd9d237765120fe7436d05febb80ba1a440f87e640c6cfbb2bc01e035fe474d3436dd
-  data.tar.gz: cbdb62c5c2374f8fee881c15e834515afa5ce15f64c88eac6189b6ce4ccc907f925370af7b3487fe701fa8598510f3691d06bdd298af966fbcfdc1e2828130b0
+  metadata.gz: 435c05d68a57d9373f7f508bba5cb89a48fe955642c2b333ba3b5f4ee22a882fd3e96dcc04949a88c8f49e27b6c3c51ded734dc3ef50ec414863ccbabef7a9e2
+  data.tar.gz: f2101130f91052286675ba0003180a18f7f55f0861b693dc1d3e595eeb1ff173128e356d355667b05f1174a68ad8b64eb501c05a4192af43fb16560d17c6bac3

data/README.md

@@ -61,17 +61,21 @@ Let's setup some contacts, add them to a list, and then send them a message.
 
 4. Create a new message and add content:
 
+    ```
     message = Bronto::Message.new(name: "Test Message")
     message.add_content("html", "HTML Subject", "HTML Content")
     message.add_content("text", "Text Subject", "Text Content")
     message.save
+    ```
 
 5. Create a new delivery with a message and recipients and send it ASAP:
 
+    ```
     delivery = Bronto::Delivery.new(start: Time.now, type: "normal", from_name: "Test", from_email: "test@example.com")
     delivery.message_id = message.id
     delivery.add_recipient(list)
     delivery.save
+    ```
 
 ## Contributing
 

data/bronto.gemspec

@@ -15,9 +15,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Bronto::VERSION
 
-  gem.add_dependency "savon", '1.2.0'
+  gem.add_dependency "savon"
 
-  gem.add_development_dependency "debugger"
+  gem.add_development_dependency "byebug"
   gem.add_development_dependency "turn"
   gem.add_development_dependency "shoulda"
 

data/lib/bronto.rb

@@ -1,17 +1,17 @@
 require "savon"
 
-require "bronto/base"
-require "bronto/contact"
-require "bronto/delivery"
-require "bronto/field"
-require "bronto/filter"
-require "bronto/list"
-require "bronto/message"
-require "bronto/version"
-
-require "core_ext/array"
-require "core_ext/object"
-require "core_ext/string"
+require_relative "bronto/base"
+require_relative "bronto/contact"
+require_relative "bronto/delivery"
+require_relative "bronto/field"
+require_relative "bronto/filter"
+require_relative "bronto/list"
+require_relative "bronto/message"
+require_relative "bronto/version"
+
+require_relative "core_ext/array"
+require_relative "core_ext/object"
+require_relative "core_ext/string"
 
 module Bronto
   class Error < StandardError

data/lib/bronto/base.rb

@@ -2,7 +2,7 @@ module Bronto
 
   # According to Bronto's API documentation, the session credential returned by the
   # login() API call remains active for 20 minutes.  In addition, the expiration time
-  # is reset after each successful use.  We will trigger a refresh before 20 minutes 
+  # is reset after each successful use.  We will trigger a refresh before 20 minutes
   # to be on the safe side
   SESSION_REUSE_SECONDS = 120
 
@@ -26,60 +26,39 @@ module Bronto
     end
 
     # The primary method used to interface with the SOAP API.
-    # This method automatically adds the required session header and returns the actual response section of the SOAP response body.
     #
     # If a symbol is passed in, it is converted to "method_plural_class_name" (e.g., :read => read_lists). A string
     # method is used as-is.
-    # Pass in a block and assign a hash to soap.body with a structure appropriate to the method call.
-    def self.request(method, api_key = nil, refresh_header = false, &_block)
-      _soap_header = self.soap_header(api_key, refresh_header)
+    # The message is a hash and becomes the body of the SOAP request
+    def self.request(method, message = {})
       api_key = api_key || self.api_key
 
       method = "#{method}_#{plural_class_name}" if method.is_a? Symbol
 
-      resp = api.request(:v4, method.to_sym) do
-        soap.header = _soap_header
-        instance_eval(&_block) if _block # See Savon::Client#evaluate; necessary to preserve scope.
-      end
+      resp = api(api_key).call(method.to_sym, message: message)
 
       @last_used = Time.now
 
       resp.body["#{method}_response".to_sym]
     end
 
-    # Sets up the Savon SOAP client object (if necessary) and returns it.
-    def self.api
-      return @api unless @api.nil?
-
-      @api = Savon::Client.new do
-        wsdl.endpoint = "https://api.bronto.com/v4"
-        wsdl.namespace = "http://api.bronto.com/v4"
-      end
-
-      # Give Bronto up to 10 minutes to reply
-      @api.http.read_timeout = 600
-
-      @api
-    end
-
-    # Helper method to retrieve the session ID and return a SOAP header.
-    # Will return a header with the same initial session ID unless the `refresh`
-    # argument is `true`.
-    def self.soap_header(api_key, refresh = false)
-      return @soap_header if !refresh and @soap_header.present? and !session_expired
+    # Sets up the Savon SOAP client object, including sessionHeaders and returns the client.
+    def self.api(api_key, refresh = false)
+      return @api unless refresh || session_expired || @api.nil?
 
-      resp = api.request(:v4, :login) do
-        soap.body = { api_token: api_key }
-      end
+      client = Savon.client(wsdl: 'https://api.bronto.com/v4?wsdl')
+      resp = client.call(:login, message: { api_token: api_key })
 
-      @last_used = Time.now
-      @soap_header = { "v4:sessionHeader" => { session_id: resp.body[:login_response][:return] } }
+      @api = Savon.client(wsdl: 'https://api.bronto.com/v4?wsdl', soap_header: {
+                                                                   "tns:sessionHeader" => { session_id: resp.body[:login_response][:return] }
+                                                                  },
+                                                                  read_timeout: 600) # Give Bronto up to 10 minutes to reply
     end
 
     # returns true if a cached session identifier is missing or is too old
     def self.session_expired
       return true if (@last_used == nil)
-      return true if (Time.now.tv_sec - @last_used.tv_sec > SESSION_REUSE_SECONDS) 
+      return true if (Time.now.tv_sec - @last_used.tv_sec > SESSION_REUSE_SECONDS)
 
       false
     end
@@ -104,9 +83,7 @@ module Bronto
     def self.find(filter = Bronto::Filter.new, page_number = 1, api_key = nil)
       api_key = api_key || self.api_key
 
-      resp = request(:read, api_key) do
-        soap.body = { filter: filter.to_hash, page_number: page_number }
-      end
+      resp = request(:read, { filter: filter.to_hash, page_number: page_number })
 
       Array.wrap(resp[:return]).map { |hash| new(hash) }
     end
@@ -121,11 +98,7 @@ module Bronto
       objs = objs.flatten
       api_key = objs.first.is_a?(String) ? objs.shift : self.api_key
 
-      resp = request(:add, api_key) do
-        soap.body = {
-          plural_class_name => objs.map(&:to_hash)
-        }
-      end
+      resp = request(:add, {plural_class_name => objs.map(&:to_hash)})
 
       objs.each { |o| o.errors.clear }
 
@@ -147,11 +120,7 @@ module Bronto
       objs = objs.flatten
       api_key = objs.first.is_a?(String) ? objs.shift : self.api_key
 
-      resp = request(:update, api_key) do
-        soap.body = {
-          plural_class_name => objs.map(&:to_hash)
-        }
-      end
+      resp = request(:update, {plural_class_name => objs.map(&:to_hash)})
 
       objs.each { |o| o.errors.clear }
       objs
@@ -167,11 +136,7 @@ module Bronto
       objs = objs.flatten
       api_key = objs.first.is_a?(String) ? objs.shift : self.api_key
 
-      resp = request(:delete, api_key) do
-        soap.body = {
-          plural_class_name => objs.map { |o| { id: o.id }}
-        }
-      end
+      resp = request(:delete, {plural_class_name => objs.map { |o| { id: o.id }}})
 
       Array.wrap(resp[:return][:results]).each_with_index do |result, i|
         if result[:is_error]
@@ -197,8 +162,8 @@ module Bronto
     end
 
     # Convenience instance method that calls the class `request` method.
-    def request(method, &block)
-      self.class.request(method, self.api_key, false, &block)
+    def request(method, message = {})
+      self.class.request(method, message)
     end
 
     def reload
@@ -207,9 +172,7 @@ module Bronto
       # The block below is evaluated in a weird scope so we need to capture self as _self for use inside the block.
       _self = self
 
-      resp = request(:read) do
-        soap.body = { filter: { id: _self.id } }
-      end
+      resp = request(:read, { filter: { id: _self.id } })
 
       resp[:return].each do |k, v|
         self.send("#{k}=", v) if self.respond_to? "#{k}="

data/lib/bronto/contact.rb

@@ -13,9 +13,7 @@ module Bronto
       body[:fields] = Array.wrap(fields).map { |f| f.is_a?(Bronto::Field) ? f.id : f } if Array(fields).length > 0
       body[:include_lists] = include_lists
 
-      resp = request(:read, api_key) do
-        soap.body = body
-      end
+      resp = request(:read, body)
 
       Array.wrap(resp[:return]).map { |hash| new(hash) }
     end
@@ -24,11 +22,7 @@ module Bronto
       objs = objs.flatten
       api_key = objs.first.is_a?(String) ? objs.shift : self.api_key
 
-      resp = request(:add_or_update, api_key) do
-        soap.body = {
-          plural_class_name => objs.map(&:to_hash)
-        }
-      end
+      resp = request(:add_or_update, {plural_class_name => objs.map(&:to_hash)})
 
       objs.each { |o| o.errors.clear }
 

data/lib/bronto/delivery.rb

@@ -13,9 +13,7 @@ module Bronto
           include_content: include_content }
       api_key = api_key || self.api_key
 
-      resp = request(:read, api_key) do
-        soap.body = body
-      end
+      resp = request(:read, body)
 
       Array.wrap(resp[:return]).map { |hash| new(hash) }
     end
@@ -27,7 +25,7 @@ module Bronto
 
     def to_hash
       hash = {
-        id: id, start: start, message_id: message_id, type: type, from_email: from_email, from_name: from_name,
+        id: id, start: start, message_id: message_id, from_email: from_email, from_name: from_name,
         reply_email: reply_email, recipients: recipients, fields: fields, authentication: authentication,
         reply_tracking: reply_tracking
       }
@@ -44,7 +42,7 @@ module Bronto
         [args.first.class.to_s.split("::").last.downcase, args.first.id]
       end
 
-      self.recipients << { type: type, id: id }
+      self.recipients << { id: id, type: type }
     end
   end
 end

data/lib/bronto/list.rb

@@ -7,11 +7,7 @@ module Bronto
       lists = lists.flatten
       api_key = lists.first.is_a?(String) ? lists.shift : self.api_key
 
-      resp = request(:clear, api_key) do
-        soap.body = {
-          list: lists.map { |l| { id: l.id } }
-        }
-      end
+      resp = request(:clear, {list: lists.map { |l| { id: l.id } }})
 
       lists.each { |l| l.reload }
 
@@ -39,12 +35,7 @@ module Bronto
       # The block below is evaluated in a weird scope so we need to capture self as _self for use inside the block.
       _self = self
 
-      resp = request("add_to_list") do
-        soap.body = {
-          list: { id: _self.id },
-          contacts: contacts.map { |c| { id: c.id } }
-        }
-      end
+      resp = request("add_to_list", {list: { id: _self.id }, contacts: contacts.map { |c| { id: c.id } }})
 
       errors = Array.wrap(resp[:return][:results]).select { |r| r[:is_error] }
       errors.each do |error|
@@ -59,15 +50,7 @@ module Bronto
       return false if !self.id.present?
       contacts = contacts.flatten
 
-      # The block below is evaluated in a weird scope so we need to capture self as _self for use inside the block.
-      _self = self
-
-      resp = request("remove_from_list") do
-        soap.body = {
-          list: _self.to_hash,
-          contacts: contacts.map(&:to_hash)
-        }
-      end
+      resp = request("remove_from_list", {list: self.to_hash, contacts: contacts.map(&:to_hash)})
 
       Array.wrap(resp[:return][:results]).select { |r| r[:is_error] }.count == 0
     end

data/lib/bronto/version.rb

@@ -1,3 +1,3 @@
 module Bronto
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/test/contact_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class ContactTest < Test::Unit::TestCase
   context "" do

data/test/delivery_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class DeliveryTest < Test::Unit::TestCase
   context "" do
@@ -11,9 +11,8 @@ class DeliveryTest < Test::Unit::TestCase
       @contact = Bronto::Contact.new(email: "#{Time.now.to_i}-#{rand(1000)}@example.com", status: "active")
       @contact.save
 
-      @delivery = Bronto::Delivery.new(start: Time.now, type: "normal", from_name: "Hello", from_email: "test@example.com")
-      @delivery_2 = Bronto::Delivery.new(start: Time.now + (60 * 60 * 24 * 5), type: "normal", from_name: "Hello",
-          from_email: "test2@example.com")
+      @delivery = Bronto::Delivery.new(start: Time.now.strftime("%Y-%m-%dT%H:%M:%S.%6N%:z"), from_name: "Hello", from_email: "test@example.com")
+      @delivery_2 = Bronto::Delivery.new(start: (Time.now + (60 * 60 * 24 * 5)).strftime("%Y-%m-%dT%H:%M:%S.%6N%:z"), from_name: "Hello", from_email: "test2@example.com")
     end
 
     teardown do

data/test/field_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class FieldTest < Test::Unit::TestCase
   context "" do

data/test/list_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class ListTest < Test::Unit::TestCase
   context "" do
@@ -88,6 +88,9 @@ class ListTest < Test::Unit::TestCase
       assert_equal 0, @list.active_count
 
       assert @list.add_to_list(contact)
+
+      sleep(5)
+
       @list.reload
       assert_equal 1, @list.active_count
     end
@@ -105,10 +108,14 @@ class ListTest < Test::Unit::TestCase
       assert_equal 0, contact2.errors.count
 
       assert @list.add_to_list(contact, contact2)
+
+      sleep(5)
+
       @list.reload
       assert_equal 2, @list.active_count
 
       assert @list.remove_from_list(contact)
+
       @list.reload
       assert_equal 1, @list.active_count
     end
@@ -125,10 +132,16 @@ class ListTest < Test::Unit::TestCase
       assert_equal 0, contact2.errors.count
 
       assert @list.add_to_list(contact, contact2)
+
+      sleep(5)
+
       @list.reload
       assert_equal 2, @list.active_count
 
       assert Bronto::List.clear_lists(@list)
+
+      sleep(5)
+
       @list.reload
       assert_equal 0, @list.active_count
     end

data/test/message_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class MessageTest < Test::Unit::TestCase
   context "" do

data/test/test_helper.rb

@@ -1,20 +1,12 @@
-require 'test/unit'
 require 'turn'
+require 'minitest/autorun'
 require 'shoulda'
 
-require 'bronto'
+require_relative '../lib/bronto'
 Bronto::Base.api_key = ""
 
-Savon.configure { |config| config.log = false }
-
 HTTPI.log = false
 
-def log_savon(&block)
-  Savon.configure { |config| config.log = true }
-  block.call()
-  Savon.configure { |config| config.log = false }
-end
-
 def reset_all
   types = [Bronto::Contact, Bronto::Field, Bronto::List, Bronto::Message]
 

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: bronto
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Bronto SOAP API