createsend 2.5.1 → 3.0.0

data/lib/createsend/list.rb

@@ -1,13 +1,11 @@
-require 'createsend'
-require 'json'
-
 module CreateSend
   # Represents a subscriber list and associated functionality.
-  class List
+  class List < CreateSend
     attr_reader :list_id
 
-    def initialize(list_id)
+    def initialize(auth, list_id)
       @list_id = list_id
+      super
     end
 
     # Creates a new list for a client.
@@ -23,7 +21,7 @@ module CreateSend
     # unsubscribe_setting - A String which must be either "AllClientLists" or
     #   "OnlyThisList". See the documentation for details:
     #   http://www.campaignmonitor.com/api/lists/#creating_a_list
-    def self.create(client_id, title, unsubscribe_page, confirmed_opt_in,
+    def self.create(auth, client_id, title, unsubscribe_page, confirmed_opt_in,
       confirmation_success_page, unsubscribe_setting="AllClientLists")
       options = { :body => {
         :Title => title,
@@ -31,13 +29,14 @@ module CreateSend
         :ConfirmedOptIn => confirmed_opt_in,
         :ConfirmationSuccessPage => confirmation_success_page,
         :UnsubscribeSetting => unsubscribe_setting }.to_json }
-      response = CreateSend.post "/lists/#{client_id}.json", options
+      cs = CreateSend.new auth
+      response = cs.post "/lists/#{client_id}.json", options
       response.parsed_response
     end
 
     # Deletes this list.
     def delete
-      response = CreateSend.delete "/lists/#{list_id}.json", {}
+      response = super "/lists/#{list_id}.json", {}
     end
 
     # Creates a new custom field for this list.
@@ -78,7 +77,7 @@ module CreateSend
     # Deletes a custom field associated with this list.
     def delete_custom_field(custom_field_key)
       custom_field_key = CGI.escape(custom_field_key)
-      response = CreateSend.delete(
+      response = cs_delete(
         "/lists/#{list_id}/customfields/#{custom_field_key}.json", {})
     end
 
@@ -94,7 +93,7 @@ module CreateSend
 
     # Gets the details of this list.
     def details
-      response = CreateSend.get "/lists/#{list_id}.json", {}
+      response = cs_get "/lists/#{list_id}.json"
       Hashie::Mash.new(response)
     end
 
@@ -119,66 +118,36 @@ module CreateSend
     # Gets the active subscribers for this list.
     def active(date="", page=1, page_size=1000, order_field="email",
       order_direction="asc")
-      options = { :query => {
-        :date => date,
-        :page => page,
-        :pagesize => page_size,
-        :orderfield => order_field,
-        :orderdirection => order_direction } }
-      response = get "active", options
-      Hashie::Mash.new(response)
+      paged_result_by_date("active", date, page, page_size, order_field,
+        order_direction)
     end
 
     # Gets the unconfirmed subscribers for this list.
     def unconfirmed(date="", page=1, page_size=1000, order_field="email",
       order_direction="asc")
-      options = { :query => {
-        :date => date,
-        :page => page,
-        :pagesize => page_size,
-        :orderfield => order_field,
-        :orderdirection => order_direction } }
-      response = get "unconfirmed", options
-      Hashie::Mash.new(response)
+      paged_result_by_date("unconfirmed", date, page, page_size, order_field,
+        order_direction)
     end
 
     # Gets the bounced subscribers for this list.
     def bounced(date="", page=1, page_size=1000, order_field="email",
       order_direction="asc")
-      options = { :query => {
-        :date => date,
-        :page => page,
-        :pagesize => page_size,
-        :orderfield => order_field,
-        :orderdirection => order_direction } }
-      response = get "bounced", options
-      Hashie::Mash.new(response)
+      paged_result_by_date("bounced", date, page, page_size, order_field,
+        order_direction)
     end
 
     # Gets the unsubscribed subscribers for this list.
     def unsubscribed(date="", page=1, page_size=1000, order_field="email",
       order_direction="asc")
-      options = { :query => {
-        :date => date,
-        :page => page,
-        :pagesize => page_size,
-        :orderfield => order_field,
-        :orderdirection => order_direction } }
-      response = get "unsubscribed", options
-      Hashie::Mash.new(response)
+      paged_result_by_date("unsubscribed", date, page, page_size, order_field,
+        order_direction)
     end
 
     # Gets the deleted subscribers for this list.
     def deleted(date="", page=1, page_size=1000, order_field="email",
       order_direction="asc")
-      options = { :query => {
-        :date => date,
-        :page => page,
-        :pagesize => page_size,
-        :orderfield => order_field,
-        :orderdirection => order_direction } }
-      response = get "deleted", options
-      Hashie::Mash.new(response)
+      paged_result_by_date("deleted", date, page, page_size, order_field,
+        order_direction)
     end
 
     # Updates this list.
@@ -209,7 +178,7 @@ module CreateSend
         :UnsubscribeSetting => unsubscribe_setting,
         :AddUnsubscribesToSuppList => add_unsubscribes_to_supp_list,
         :ScrubActiveWithSuppList => scrub_active_with_supp_list }.to_json }
-      response = CreateSend.put "/lists/#{list_id}.json", options
+      response = cs_put "/lists/#{list_id}.json", options
     end
 
     # Gets the webhooks for this list.
@@ -239,7 +208,7 @@ module CreateSend
 
     # Deletes a webhook associated with this list.
     def delete_webhook(webhook_id)
-      response = CreateSend.delete(
+      response = cs_delete(
         "/lists/#{list_id}/webhooks/#{webhook_id}.json", {})
     end
 
@@ -256,17 +225,29 @@ module CreateSend
     end
 
     private
+    
+    def paged_result_by_date(resource, date, page, page_size, order_field,
+      order_direction)
+      options = { :query => {
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get resource, options
+      Hashie::Mash.new(response)
+    end
 
     def get(action, options = {})
-      CreateSend.get uri_for(action), options
+      super uri_for(action), options
     end
 
     def post(action, options = {})
-      CreateSend.post uri_for(action), options
+      super uri_for(action), options
     end
 
     def put(action, options = {})
-      CreateSend.put uri_for(action), options
+      super uri_for(action), options
     end
 
     def uri_for(action)

data/lib/createsend/person.rb

@@ -1,33 +1,33 @@
-require 'createsend'
-require 'json'
-
 module CreateSend
   # Represents a person and associated functionality.
-  class Person
+  class Person < CreateSend
     attr_reader :client_id
     attr_reader :email_address
 
-    def initialize(client_id, email_address)
+    def initialize(auth, client_id, email_address)
       @client_id = client_id
       @email_address = email_address
+      super
     end
 
     # Gets a person by client ID and email address.
-    def self.get(client_id, email_address)
+    def self.get(auth, client_id, email_address)
       options = { :query => { :email => email_address } }
-      response = CreateSend.get "/clients/#{client_id}/people.json", options
+      cs = CreateSend.new auth
+      response = cs.get "/clients/#{client_id}/people.json", options
       Hashie::Mash.new(response)
     end
 
-    # Adds a person to the client. password is optional. if ommitted, an
+    # Adds a person to the client. Password is optional. If ommitted, an
     # email invitation will be sent to the person
-    def self.add(client_id, email_address, name, access_level, password)
+    def self.add(auth, client_id, email_address, name, access_level, password)
       options = { :body => {
         :EmailAddress => email_address,
         :Name => name,
         :AccessLevel => access_level,
         :Password => password }.to_json }
-      response = CreateSend.post "/clients/#{client_id}/people.json", options
+      cs = CreateSend.new auth
+      response = cs.post "/clients/#{client_id}/people.json", options
       Hashie::Mash.new(response)
     end
 
@@ -41,7 +41,7 @@ module CreateSend
           :Name => name,
           :AccessLevel => access_level,
           :Password => password }.to_json }
-      CreateSend.put uri_for(client_id), options
+      put uri_for(client_id), options
       # Update @email_address, so this object can continue to be used reliably
       @email_address = new_email_address
     end
@@ -49,11 +49,11 @@ module CreateSend
     # deletes this person from the client
     def delete
       options = { :query => { :email => @email_address } }
-      CreateSend.delete uri_for(client_id), options
+      super uri_for(client_id), options
     end
 
     def uri_for(client_id)
-         "/clients/#{client_id}/people.json"
+      "/clients/#{client_id}/people.json"
     end
   end
 end

data/lib/createsend/segment.rb

@@ -1,21 +1,20 @@
-require 'createsend'
-require 'json'
-
 module CreateSend
   # Represents a subscriber list segment and associated functionality.
-  class Segment
+  class Segment < CreateSend
     attr_reader :segment_id
 
-    def initialize(segment_id)
+    def initialize(auth, segment_id)
       @segment_id = segment_id
+      super
     end
 
     # Creates a new segment.
-    def self.create(list_id, title, rules)
+    def self.create(auth, list_id, title, rules)
       options = { :body => {
         :Title => title,
         :Rules => rules }.to_json }
-      response = CreateSend.post "/segments/#{list_id}.json", options
+      cs = CreateSend.new auth
+      response = cs.post "/segments/#{list_id}.json", options
       response.parsed_response
     end
 
@@ -24,7 +23,7 @@ module CreateSend
       options = { :body => {
         :Title => title,
         :Rules => rules }.to_json }
-      response = CreateSend.put "/segments/#{segment_id}.json", options
+      response = cs_put "/segments/#{segment_id}.json", options
     end
 
     # Adds a rule to this segment.
@@ -32,7 +31,7 @@ module CreateSend
       options = { :body => {
         :Subject => subject,
         :Clauses => clauses }.to_json }
-      response = CreateSend.post "/segments/#{segment_id}/rules.json", options
+      response = post "rules", options
     end
 
     # Gets the active subscribers in this segment.
@@ -50,32 +49,32 @@ module CreateSend
 
     # Gets the details of this segment
     def details
-      response = CreateSend.get "/segments/#{segment_id}.json", {}
+      response = cs_get "/segments/#{segment_id}.json", {}
       Hashie::Mash.new(response)
     end
 
     # Clears all rules of this segment.
     def clear_rules
-      response = CreateSend.delete "/segments/#{segment_id}/rules.json", {}
+      response = cs_delete "/segments/#{segment_id}/rules.json", {}
     end
 
     # Deletes this segment.
     def delete
-      response = CreateSend.delete "/segments/#{segment_id}.json", {}
+      response = super "/segments/#{segment_id}.json", {}
     end
 
     private
 
     def get(action, options = {})
-      CreateSend.get uri_for(action), options
+      super uri_for(action), options
     end
 
     def post(action, options = {})
-      CreateSend.post uri_for(action), options
+      super uri_for(action), options
     end
 
     def put(action, options = {})
-      CreateSend.put uri_for(action), options
+      super uri_for(action), options
     end
 
     def uri_for(action)

data/lib/createsend/subscriber.rb

@@ -1,26 +1,25 @@
-require 'createsend'
-require 'json'
-
 module CreateSend
   # Represents a subscriber and associated functionality.
-  class Subscriber
+  class Subscriber < CreateSend
     attr_reader :list_id
     attr_reader :email_address
 
-    def initialize(list_id, email_address)
+    def initialize(auth, list_id, email_address)
       @list_id = list_id
       @email_address = email_address
+      super
     end
 
     # Gets a subscriber by list ID and email address.
-    def self.get(list_id, email_address)
+    def self.get(auth, list_id, email_address)
       options = { :query => { :email => email_address } }
-      response = CreateSend.get "/subscribers/#{list_id}.json", options
+      cs = CreateSend.new auth
+      response = cs.get "/subscribers/#{list_id}.json", options
       Hashie::Mash.new(response)
     end
 
     # Adds a subscriber to a subscriber list.
-    def self.add(list_id, email_address, name, custom_fields, resubscribe,
+    def self.add(auth, list_id, email_address, name, custom_fields, resubscribe,
       restart_subscription_based_autoresponders=false)
       options = { :body => {
         :EmailAddress => email_address,
@@ -29,12 +28,13 @@ module CreateSend
         :Resubscribe => resubscribe,
         :RestartSubscriptionBasedAutoresponders =>
           restart_subscription_based_autoresponders }.to_json }
-      response = CreateSend.post "/subscribers/#{list_id}.json", options
+      cs = CreateSend.new auth
+      response = cs.post "/subscribers/#{list_id}.json", options
       response.parsed_response
     end
 
     # Imports subscribers into a subscriber list.
-    def self.import(list_id, subscribers, resubscribe,
+    def self.import(auth, list_id, subscribers, resubscribe,
       queue_subscription_based_autoresponders=false,
       restart_subscription_based_autoresponders=false)
       options = { :body => {
@@ -45,7 +45,8 @@ module CreateSend
         :RestartSubscriptionBasedAutoresponders =>
           restart_subscription_based_autoresponders }.to_json }
       begin
-        response = CreateSend.post(
+        cs = CreateSend.new auth
+        response = cs.post(
           "/subscribers/#{list_id}/import.json", options)
       rescue BadRequest => br
         # Subscriber import will throw BadRequest if some subscribers are not
@@ -75,7 +76,7 @@ module CreateSend
           :Resubscribe => resubscribe,
           :RestartSubscriptionBasedAutoresponders =>
             restart_subscription_based_autoresponders }.to_json }
-      CreateSend.put "/subscribers/#{@list_id}.json", options
+      put "/subscribers/#{@list_id}.json", options
       # Update @email_address, so this object can continue to be used reliably
       @email_address = new_email_address
     end
@@ -84,20 +85,20 @@ module CreateSend
     def unsubscribe
       options = { :body => {
         :EmailAddress => @email_address }.to_json }
-      CreateSend.post "/subscribers/#{@list_id}/unsubscribe.json", options
+      post "/subscribers/#{@list_id}/unsubscribe.json", options
     end
 
     # Gets the historical record of this subscriber's trackable actions.
     def history
       options = { :query => { :email => @email_address } }
-      response = CreateSend.get "/subscribers/#{@list_id}/history.json", options
+      response = cs_get "/subscribers/#{@list_id}/history.json", options
       response.map{|item| Hashie::Mash.new(item)}
     end
 
     # Moves this subscriber to the Deleted state in the associated list.
     def delete
       options = { :query => { :email => @email_address } }
-      CreateSend.delete "/subscribers/#{@list_id}.json", options
+      super "/subscribers/#{@list_id}.json", options
     end
   end
 end

data/lib/createsend/template.rb

@@ -1,28 +1,27 @@
-require 'createsend'
-require 'json'
-
 module CreateSend
   # Represents an email template and associated functionality.
-  class Template
+  class Template < CreateSend
     attr_reader :template_id
 
-    def initialize(template_id)
+    def initialize(auth, template_id)
       @template_id = template_id
+      super
     end
 
     # Creates a new email template.
-    def self.create(client_id, name, html_url, zip_url)
+    def self.create(auth, client_id, name, html_url, zip_url)
       options = { :body => {
         :Name => name,
         :HtmlPageURL => html_url,
         :ZipFileURL => zip_url }.to_json }
-      response = CreateSend.post "/templates/#{client_id}.json", options
+      cs = CreateSend.new auth
+      response = cs.post "/templates/#{client_id}.json", options
       response.parsed_response
     end
 
     # Gets the details of this email template.
     def details
-      response = CreateSend.get "/templates/#{template_id}.json", {}
+      response = get "/templates/#{template_id}.json", {}
       Hashie::Mash.new(response)
     end
 
@@ -32,12 +31,12 @@ module CreateSend
         :Name => name,
         :HtmlPageURL => html_url,
         :ZipFileURL => zip_url }.to_json }
-      response = CreateSend.put "/templates/#{template_id}.json", options
+      response = put "/templates/#{template_id}.json", options
     end
 
     # Deletes this email template.
     def delete
-      response = CreateSend.delete "/templates/#{template_id}.json", {}
+      response = super "/templates/#{template_id}.json", {}
     end
   end
 end