active_esp 0.1.0.alpha1 → 0.1.0.alpha2

data/active_esp.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["bmorton@sdreader.com"]
   gem.description   = %q{Framework and tools for managing email service providers.}
   gem.summary       = %q{ActiveESP is an abstraction library for managing subscribers, campaigns, and other email marketing facilities.  It provides a consistent interface to interact with the numerous ESPs.}
-  gem.homepage      = "http://1703india.st/active_esp"
+  gem.homepage      = "https://github.com/bmorton/active_esp"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "json", "> 1.4.0"
   gem.add_runtime_dependency "httparty", "~> 0.8.1"
-  gem.add_runtime_dependency "activesupport", ">= 3.0.0"
+  gem.add_runtime_dependency "activesupport", ">= 3.1.0"
   gem.add_runtime_dependency "shuber-interface", "~> 0.0.4"
 
   gem.add_development_dependency "rspec", "~> 2.8.0"

data/lib/active_esp/providers/icontact.rb

@@ -57,21 +57,24 @@ module ActiveESP
 
       # Interface implementation
 
-      # Create a contact and optionally subscribe them to a provided list.
-      #
-      # Note: On iContact, a user cannot be subscribed to a list that they have
-      # previously unsubscribed from.
+      # Find a contact stored in the iContact account.
       #
-      # @see ActiveESP::Providers::Interface#subscribe
-      def subscribe(subscriber, list = nil)
+      # @see ActiveESP::Providers::Interface#find_subscriber
+      def find_subscriber(params)
+        response = call(:get, "/a/#{account_id}/c/#{client_folder_id}/contacts", params)
+        return [] unless response['contacts']
+
+        response['contacts'].map do |contact|
+          contact_as_subscriber(contact)
+        end
+      end
+
+      def create_subscriber(subscriber)
         response = call(:post, "/a/#{account_id}/c/#{client_folder_id}/contacts", [{:email => subscriber.email, :firstName => subscriber.first_name, :lastName => subscriber.last_name}])
         subscriber.id = response['contacts'].first['contactId']
-        if list
-          list_response = call(:post, "/a/#{account_id}/c/#{client_folder_id}/subscriptions", [{:listId => list.id, :contactId => subscriber.id, :status => 'normal' }])
-          raise ActiveESP::Providers::CouldNotSubscribeToListException, list_response['warnings'] if list_response['warnings']
-        end
         subscriber
       end
+      alias :find_or_create_subscriber :create_subscriber
 
       # Unsubscribe a subscriber from the provided list.
       #
@@ -90,6 +93,19 @@ module ActiveESP
         call(:get, "/a/#{account_id}/c/#{client_folder_id}/lists")
       end
 
+      # Create a contact and optionally subscribe them to a provided list.
+      #
+      # Note: On iContact, a user cannot be subscribed to a list that they have
+      # previously unsubscribed from.
+      #
+      # @see ActiveESP::Providers::Interface#subscribe
+      def subscribe_to_list(subscriber, list)
+        subscriber = find_or_create_subscriber(subscriber) unless subscriber.id
+        list_response = call(:post, "/a/#{account_id}/c/#{client_folder_id}/subscriptions", [{:listId => list.id, :contactId => subscriber.id, :status => 'normal' }])
+        raise ActiveESP::Providers::CouldNotSubscribeToListException, list_response['warnings'] if list_response['warnings']
+        return subscriber
+      end
+
       # Getting iContact-specific account information
 
       # Retrieves the iContact account information attached to the credentials
@@ -142,6 +158,22 @@ module ActiveESP
       end
       attr_writer :client_folder_id
 
+      # Representing iContact models as ActiveESP models
+
+      # Returns a new ActiveESP::Subscriber object from a contact hash returned from
+      # an iContact response.
+      #
+      # @param [Hash] contact A single contact from an iContact response
+      # @return [Subscriber] Returns a new Subscriber object
+      def contact_as_subscriber(contact)
+        Subscriber.new(
+          :first_name => contact['firstName'],
+          :last_name => contact['lastName'],
+          :email => contact['email'],
+          :id => contact['contactId']
+        )
+      end
+
     private
       def call(method, resource, params = {})
         self.class.base_uri self.endpoint

data/lib/active_esp/providers/interface.rb

@@ -3,13 +3,15 @@ module ActiveESP
     module Interface
       # Subscription methods
 
-      def subscribe(subscriber, list = nil); end
+      def find_subscriber(params); end
+      def create_subscriber(subscriber); end
       def unsubscribe(subscriber, list = nil); end
       def subscribed?(subscriber, list = nil); end
 
       # List methods
       
       def lists; end
+      def subscribe_to_list(subscriber, list); end
     end
   end
 end

data/lib/active_esp/providers/mail_chimp.rb

@@ -17,6 +17,8 @@ module ActiveESP
       end
 
     private
+      # This implementation mostly comes from the MailChimp gibbon gem
+      # available at: https://github.com/amro/gibbon
       def call(method, params = {})
         api_url = endpoint + '/?method=' + method.to_s.camelize(:lower)
         params = api_params(params)

data/lib/active_esp/subscriber.rb

@@ -106,13 +106,18 @@ module ActiveESP
 
     # Accessing commonly used API calls
 
+    def create!
+      raise ActiveESP::ProviderNotConfiguredException unless ActiveESP.provider
+      ActiveESP.provider.create_subscriber(self)
+    end
+
     # Add the subscriber to the provider and optionally subscribe them to the
     # given list.
     #
     # @see ActiveESP::Providers::Interface#subscribe
     def subscribe!(list = nil)
       raise ActiveESP::ProviderNotConfiguredException unless ActiveESP.provider
-      ActiveESP.provider.subscribe(self, list)
+      ActiveESP.provider.subscribe_to_list(self, list)
     end
 
     # Remove the subscriber from the given list.
@@ -122,5 +127,12 @@ module ActiveESP
       raise ActiveESP::ProviderNotConfiguredException unless ActiveESP.provider
       ActiveESP.provider.unsubscribe(self, list)
     end
+
+    class << self
+      def find(params)
+        raise ActiveESP::ProviderNotConfiguredException unless ActiveESP.provider
+        ActiveESP.provider.find_subscriber(params)
+      end
+    end
   end
 end

data/lib/active_esp/version.rb

@@ -1,3 +1,3 @@
 module ActiveESP
-  VERSION = "0.1.0.alpha1"
+  VERSION = "0.1.0.alpha2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_esp
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha1
+  version: 0.1.0.alpha2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-18 00:00:00.000000000 Z
+date: 2012-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70366026630040 !ruby/object:Gem::Requirement
+  requirement: &70159683606680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70366026630040
+  version_requirements: *70159683606680
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70366026629440 !ruby/object:Gem::Requirement
+  requirement: &70159683606140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,21 +32,21 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70366026629440
+  version_requirements: *70159683606140
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70366026628960 !ruby/object:Gem::Requirement
+  requirement: &70159683605640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70366026628960
+  version_requirements: *70159683605640
 - !ruby/object:Gem::Dependency
   name: shuber-interface
-  requirement: &70366026628420 !ruby/object:Gem::Requirement
+  requirement: &70159683605160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *70366026628420
+  version_requirements: *70159683605160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70366026627840 !ruby/object:Gem::Requirement
+  requirement: &70159683604640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70366026627840
+  version_requirements: *70159683604640
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70366026627360 !ruby/object:Gem::Requirement
+  requirement: &70159683604160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 2.5.1
   type: :development
   prerelease: false
-  version_requirements: *70366026627360
+  version_requirements: *70159683604160
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70366026626880 !ruby/object:Gem::Requirement
+  requirement: &70159683603680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *70366026626880
+  version_requirements: *70159683603680
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70366026626380 !ruby/object:Gem::Requirement
+  requirement: &70159683603200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *70366026626380
+  version_requirements: *70159683603200
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70366026625920 !ruby/object:Gem::Requirement
+  requirement: &70159683602740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,7 +109,7 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *70366026625920
+  version_requirements: *70159683602740
 description: Framework and tools for managing email service providers.
 email:
 - bmorton@sdreader.com
@@ -142,7 +142,7 @@ files:
 - spec/providers/mail_chimp_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers/implement_interface.rb
-homepage: http://1703india.st/active_esp
+homepage: https://github.com/bmorton/active_esp
 licenses: []
 post_install_message: 
 rdoc_options: []