createsend 0.1.1 → 0.2.0

data/lib/segment.rb

@@ -1,83 +1,85 @@
 require 'createsend'
 require 'json'
 
-# Represents a subscriber list segment and associated functionality.
-class Segment
-  attr_reader :segment_id
+module CreateSend
+  # Represents a subscriber list segment and associated functionality.
+  class Segment
+    attr_reader :segment_id
 
-  def initialize(segment_id)
-    @segment_id = segment_id
-  end
+    def initialize(segment_id)
+      @segment_id = segment_id
+    end
 
-  # Creates a new segment.
-  def self.create(list_id, title, rules)
-    options = { :body => {
-      :Title => title,
-      :Rules => rules }.to_json }
-    response = CreateSend.post "/segments/#{list_id}.json", options
-    response.parsed_response
-  end
+    # Creates a new segment.
+    def self.create(list_id, title, rules)
+      options = { :body => {
+        :Title => title,
+        :Rules => rules }.to_json }
+      response = CreateSend.post "/segments/#{list_id}.json", options
+      response.parsed_response
+    end
 
-  # Updates this segment.
-  def update(title, rules)
-    options = { :body => {
-      :Title => title,
-      :Rules => rules }.to_json }
-    response = CreateSend.put "/segments/#{segment_id}.json", options
-  end
+    # Updates this segment.
+    def update(title, rules)
+      options = { :body => {
+        :Title => title,
+        :Rules => rules }.to_json }
+      response = CreateSend.put "/segments/#{segment_id}.json", options
+    end
 
-  # Adds a rule to this segment.
-  def add_rule(subject, clauses)
-    options = { :body => {
-      :Subject => subject,
-      :Clauses => clauses }.to_json }
-    response = CreateSend.post "/segments/#{segment_id}/rules.json", options
-  end
+    # Adds a rule to this segment.
+    def add_rule(subject, clauses)
+      options = { :body => {
+        :Subject => subject,
+        :Clauses => clauses }.to_json }
+      response = CreateSend.post "/segments/#{segment_id}/rules.json", options
+    end
 
-  # Gets the active subscribers in this segment.
-  def subscribers(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)
-  end
+    # Gets the active subscribers in this segment.
+    def subscribers(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)
+    end
 
-  # Gets the details of this segment
-  def details
-    response = CreateSend.get "/segments/#{segment_id}.json", {}
-    Hashie::Mash.new(response)
-  end
+    # Gets the details of this segment
+    def details
+      response = CreateSend.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", {}
-  end
+    # Clears all rules of this segment.
+    def clear_rules
+      response = CreateSend.delete "/segments/#{segment_id}/rules.json", {}
+    end
 
-  # Deletes this segment.
-  def delete
-    response = CreateSend.delete "/segments/#{segment_id}.json", {}
-  end
+    # Deletes this segment.
+    def delete
+      response = CreateSend.delete "/segments/#{segment_id}.json", {}
+    end
   
-  private
+    private
 
-  def get(action, options = {})
-    CreateSend.get uri_for(action), options
-  end
+    def get(action, options = {})
+      CreateSend.get uri_for(action), options
+    end
 
-  def post(action, options = {})
-    CreateSend.post uri_for(action), options
-  end
+    def post(action, options = {})
+      CreateSend.post uri_for(action), options
+    end
 
-  def put(action, options = {})
-    CreateSend.put uri_for(action), options
-  end
+    def put(action, options = {})
+      CreateSend.put uri_for(action), options
+    end
 
-  def uri_for(action)
-    "/segments/#{segment_id}/#{action}.json"
-  end
+    def uri_for(action)
+      "/segments/#{segment_id}/#{action}.json"
+    end
 
+  end
 end

data/lib/subscriber.rb

@@ -1,67 +1,69 @@
 require 'createsend'
 require 'json'
 
-# Represents a subscriber and associated functionality.
-class Subscriber
-  attr_reader :list_id
-  attr_reader :email_address
+module CreateSend
+  # Represents a subscriber and associated functionality.
+  class Subscriber
+    attr_reader :list_id
+    attr_reader :email_address
 
-  def initialize(list_id, email_address)
-    @list_id = list_id
-    @email_address = email_address
-  end
+    def initialize(list_id, email_address)
+      @list_id = list_id
+      @email_address = email_address
+    end
 
-  # Gets a subscriber by list ID and email address.
-  def self.get(list_id, email_address)
-    options = { :query => { :email => email_address } }
-    response = CreateSend.get "/subscribers/#{list_id}.json", options
-    Hashie::Mash.new(response)
-  end
+    # Gets a subscriber by list ID and email address.
+    def self.get(list_id, email_address)
+      options = { :query => { :email => email_address } }
+      response = CreateSend.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)
-    options = { :body => {
-      :EmailAddress => email_address,
-      :Name => name,
-      :CustomFields => custom_fields,
-      :Resubscribe => resubscribe }.to_json }
-    response = CreateSend.post "/subscribers/#{list_id}.json", options
-    response.parsed_response
-  end
+    # Adds a subscriber to a subscriber list.
+    def self.add(list_id, email_address, name, custom_fields, resubscribe)
+      options = { :body => {
+        :EmailAddress => email_address,
+        :Name => name,
+        :CustomFields => custom_fields,
+        :Resubscribe => resubscribe }.to_json }
+      response = CreateSend.post "/subscribers/#{list_id}.json", options
+      response.parsed_response
+    end
 
-  # Imports subscribers into a subscriber list.
-  def self.import(list_id, subscribers, resubscribe)
-    options = { :body => {
-      :Subscribers => subscribers,
-      :Resubscribe => resubscribe }.to_json }
-    begin
-      response = CreateSend.post "/subscribers/#{list_id}/import.json", options
-    rescue BadRequest => br
-      # Subscriber import will throw BadRequest if some subscribers are not imported
-      # successfully. If this occurs, we want to return the ResultData property of
-      # the BadRequest exception (which is of the same "form" as the response we'd 
-      # receive upon a completely successful import)
-      if br.data.ResultData
-        return br.data.ResultData
-      else
-        raise br
+    # Imports subscribers into a subscriber list.
+    def self.import(list_id, subscribers, resubscribe)
+      options = { :body => {
+        :Subscribers => subscribers,
+        :Resubscribe => resubscribe }.to_json }
+      begin
+        response = CreateSend.post "/subscribers/#{list_id}/import.json", options
+      rescue BadRequest => br
+        # Subscriber import will throw BadRequest if some subscribers are not imported
+        # successfully. If this occurs, we want to return the ResultData property of
+        # the BadRequest exception (which is of the same "form" as the response we'd 
+        # receive upon a completely successful import)
+        if br.data.ResultData
+          return br.data.ResultData
+        else
+          raise br
+        end
       end
+      Hashie::Mash.new(response)
     end
-    Hashie::Mash.new(response)
-  end
 
-  # Unsubscribes this subscriber from the associated list.
-  def unsubscribe
-    options = { :body => {
-      :EmailAddress => @email_address }.to_json }
-    CreateSend.post "/subscribers/#{@list_id}/unsubscribe.json", options
-  end
+    # Unsubscribes this subscriber from the associated list.
+    def unsubscribe
+      options = { :body => {
+        :EmailAddress => @email_address }.to_json }
+      CreateSend.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.map{|item| Hashie::Mash.new(item)}
-  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.map{|item| Hashie::Mash.new(item)}
+    end
 
+  end
 end

data/lib/template.rb

@@ -1,43 +1,45 @@
 require 'createsend'
 require 'json'
 
-# Represents an email template and associated functionality.
-class Template
-  attr_reader :template_id
+module CreateSend
+  # Represents an email template and associated functionality.
+  class Template
+    attr_reader :template_id
 
-  def initialize(template_id)
-    @template_id = template_id
-  end
+    def initialize(template_id)
+      @template_id = template_id
+    end
 
-  # Creates a new email template.
-  def self.create(client_id, name, html_url, zip_url, screenshot_url)
-    options = { :body => { 
-      :Name => name,
-      :HtmlPageURL => html_url,
-      :ZipFileURL => zip_url,
-      :ScreenshotURL => screenshot_url }.to_json }
-    response = CreateSend.post "/templates/#{client_id}.json", options
-    response.parsed_response
-  end
+    # Creates a new email template.
+    def self.create(client_id, name, html_url, zip_url, screenshot_url)
+      options = { :body => { 
+        :Name => name,
+        :HtmlPageURL => html_url,
+        :ZipFileURL => zip_url,
+        :ScreenshotURL => screenshot_url }.to_json }
+      response = CreateSend.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", {}
-    Hashie::Mash.new(response)
-  end
+    # Gets the details of this email template.
+    def details
+      response = CreateSend.get "/templates/#{template_id}.json", {}
+      Hashie::Mash.new(response)
+    end
 
-  # Updates this email template.
-  def update(name, html_url, zip_url, screenshot_url)
-    options = { :body => { 
-      :Name => name,
-      :HtmlPageURL => html_url,
-      :ZipFileURL => zip_url,
-      :ScreenshotURL => screenshot_url }.to_json }
-    response = CreateSend.put "/templates/#{template_id}.json", options
-  end
+    # Updates this email template.
+    def update(name, html_url, zip_url, screenshot_url)
+      options = { :body => { 
+        :Name => name,
+        :HtmlPageURL => html_url,
+        :ZipFileURL => zip_url,
+        :ScreenshotURL => screenshot_url }.to_json }
+      response = CreateSend.put "/templates/#{template_id}.json", options
+    end
 
-  # Deletes this email template.
-  def delete
-    response = CreateSend.delete "/templates/#{template_id}.json", {}
+    # Deletes this email template.
+    def delete
+      response = CreateSend.delete "/templates/#{template_id}.json", {}
+    end
   end
 end

data/test/campaign_test.rb

@@ -5,13 +5,13 @@ class CampaignTest < Test::Unit::TestCase
     setup do
       @api_key = '123123123123123123123'
       CreateSend.api_key @api_key
-      @campaign = Campaign.new(:campaign_id => '787y87y87y87y87y87y87')
+      @campaign = CreateSend::Campaign.new(:campaign_id => '787y87y87y87y87y87y87')
     end
 
     should "create a campaign" do
       client_id = '87y8d7qyw8d7yq8w7ydwqwd'
       stub_post(@api_key, "campaigns/#{client_id}.json", "create_campaign.json")
-      campaign_id = Campaign.create client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
+      campaign_id = CreateSend::Campaign.create client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
       "http://example.com/campaign.html", "http://example.com/campaign.txt", [ '7y12989e82ue98u2e', 'dh9w89q8w98wudwd989' ],
       [ 'y78q9w8d9w8ud9q8uw', 'djw98quw9duqw98uwd98' ]
       campaign_id.should == "787y87y87y87y87y87y87"

data/test/client_test.rb

@@ -5,12 +5,12 @@ class ClientTest < Test::Unit::TestCase
     setup do
       @api_key = '123123123123123123123'
       CreateSend.api_key @api_key
-      @client = Client.new(:client_id => '321iuhiuhi1u23hi2u3')
+      @client = CreateSend::Client.new(:client_id => '321iuhiuhi1u23hi2u3')
     end
 
     should "create a client" do
       stub_post(@api_key, "clients.json", "create_client.json")
-      client_id = Client.create "Client Company Name", "Client Contact Name", "client@example.com", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
+      client_id = CreateSend::Client.create "Client Company Name", "Client Contact Name", "client@example.com", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
       client_id.should == "32a381c49a2df99f1d0c6f3c112352b9"
     end
     

data/test/createsend_test.rb

@@ -6,7 +6,7 @@ class CreateSendTest < Test::Unit::TestCase
       @api_key = '123123123123123123123'
       @base_uri = 'http://api.createsend.com/api/v3'
       CreateSend.api_key @api_key
-      @cs = CreateSend.new
+      @cs = CreateSend::CreateSend.new
     end
     
     should "get api key" do
@@ -53,14 +53,14 @@ class CreateSendTest < Test::Unit::TestCase
       @api_key = '123123123123123123123'
       @base_uri = 'http://api.createsend.com/api/v3'
       CreateSend.api_key @api_key
-      @cs = CreateSend.new
-      @template = Template.new(:template_id => '98y2e98y289dh89h938389')
+      @cs = CreateSend::CreateSend.new
+      @template = CreateSend::Template.new(:template_id => '98y2e98y289dh89h938389')
     end
     
-    { ["400", "Bad Request"]  => BadRequest,
-      ["401", "Unauthorized"] => Unauthorized,
-      ["404", "Not Found"]    => NotFound,
-      ["500", "Server Error"] => ServerError
+    { ["400", "Bad Request"]  => CreateSend::BadRequest,
+      ["401", "Unauthorized"] => CreateSend::Unauthorized,
+      ["404", "Not Found"]    => CreateSend::NotFound,
+      ["500", "Server Error"] => CreateSend::ServerError
     }.each do |status, exception|
       context "#{status.first}, a get" do
         should "raise a #{exception.name} error" do
@@ -72,7 +72,7 @@ class CreateSendTest < Test::Unit::TestCase
       context "#{status.first}, a post" do
         should "raise a #{exception.name} error" do
           stub_post(@api_key, "clients.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
-          lambda { Client.create "Client Company Name", "Client Contact Name", "client@example.com", 
+          lambda { CreateSend::Client.create "Client Company Name", "Client Contact Name", "client@example.com", 
             "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia" }.should raise_error(exception)
         end
       end

data/test/fixtures/list_webhooks.json

@@ -1,10 +1,7 @@
 [
   {
     "WebhookID": "943678317049bc13",
-    "Events": [
-      "Bounce",
-      "Spam"
-    ],
+    "Events": [ "Deactivate" ],
     "Url": "http://www.postbin.org/d9w8ud9wud9w",
     "Status": "Active",
     "PayloadFormat": "Json"

data/test/list_test.rb

@@ -7,12 +7,12 @@ class ListTest < Test::Unit::TestCase
       CreateSend.api_key @api_key
       @client_id = "87y8d7qyw8d7yq8w7ydwqwd"
       @list_id = "e3c5f034d68744f7881fdccf13c2daee"
-      @list = List.new @list_id
+      @list = CreateSend::List.new @list_id
     end
 
     should "create a list" do
       stub_post(@api_key, "lists/#{@client_id}.json", "create_list.json")
-      list_id = List.create @client_id, "List One", "", false, ""
+      list_id = CreateSend::List.create @client_id, "List One", "", false, ""
       list_id.should == "e3c5f034d68744f7881fdccf13c2daee"
     end
     
@@ -148,8 +148,8 @@ class ListTest < Test::Unit::TestCase
       hooks = @list.webhooks
       hooks.size.should == 2
       hooks.first.WebhookID.should == "943678317049bc13"
-      hooks.first.Events.size.should == 2
-      hooks.first.Events.first.should == "Bounce"
+      hooks.first.Events.size.should == 1
+      hooks.first.Events.first.should == "Deactivate"
       hooks.first.Url.should == "http://www.postbin.org/d9w8ud9wud9w"
       hooks.first.Status.should == "Active"
       hooks.first.PayloadFormat.should == "Json"