createsend 0.1.1 → 0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    createsend (0.1.0)
+    createsend (0.2.0)
       hashie (~> 0.4.0)
       httparty (~> 0.6.1)
       json

data/README.md

@@ -15,7 +15,7 @@ Retrieve a list of all your clients.
 
     CreateSend.api_key 'your_api_key'
 
-    cs = CreateSend.new
+    cs = CreateSend::CreateSend.new
     clients = cs.clients
     
     clients.each do |c|
@@ -35,10 +35,10 @@ If the createsend API returns an error, an exception will be thrown. For example
     CreateSend.api_key 'your_api_key'
 
     begin
-      cl = Client.new "4a397ccaaa55eb4e6aa1221e1e2d7122"
-      id = Campaign.create cl.client_id, "", "", "", "", "", "", "", [], []
+      cl = CreateSend::Client.new "4a397ccaaa55eb4e6aa1221e1e2d7122"
+      id = CreateSend::Campaign.create cl.client_id, "", "", "", "", "", "", "", [], []
       puts "New campaign ID: #{id}"
-      rescue BadRequest => br
+      rescue CreateSend::BadRequest => br
         puts "Bad request error: #{br}"
         puts "Error Code:    #{br.data.Code}"
         puts "Error Message: #{br.data.Message}"
@@ -55,11 +55,11 @@ Results in:
 ### Expected input and output
 The best way of finding out the expected input and output of a particular method in a particular class is to use the unit tests as a reference.
 
-For example, if you wanted to find out how to call the Subscriber.add method, you would look at the file test/subscriber_test.rb
+For example, if you wanted to find out how to call the CreateSend::Subscriber.add method, you would look at the file test/subscriber_test.rb
 
     should "add a subscriber with custom fields" do
       stub_post(@api_key, "subscribers/#{@list_id}.json", "add_subscriber.json")
       custom_fields = [ { :Key => 'website', :Value => 'http://example.com/' } ]
-      email_address = Subscriber.add @list_id, "subscriber@example.com", "Subscriber", custom_fields, true
+      email_address = CreateSend::Subscriber.add @list_id, "subscriber@example.com", "Subscriber", custom_fields, true
       email_address.should == "subscriber@example.com"
     end

data/Rakefile

@@ -17,7 +17,7 @@ end
 
 desc "Build and release the gem"
 task :release => :build do
-  system "gem push createsend-#{CreateSend::VER}.gem"
+  system "gem push createsend-#{CreateSend::VERSION}.gem"
 end
 
 task :default => :test

data/createsend.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.summary = %q{A library which implements the complete functionality of v3 of the createsend API.}
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.version = CreateSend::VER
+  s.version = CreateSend::VERSION
   s.platform = Gem::Platform::RUBY
   s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
 end

data/lib/campaign.rb

@@ -1,134 +1,136 @@
 require 'createsend'
 require 'json'
 
-# Represents a campaign and provides associated funtionality.
-class Campaign
-  attr_reader :campaign_id
+module CreateSend
+  # Represents a campaign and provides associated funtionality.
+  class Campaign
+    attr_reader :campaign_id
+
+    def initialize(campaign_id)
+      @campaign_id = campaign_id
+    end
+
+    # Creates a new campaign for a client.
+    def self.create(client_id, subject, name, from_name, from_email, reply_to, html_url,
+      text_url, list_ids, segment_ids)
+      options = { :body => { 
+        :Subject => subject,
+        :Name => name,
+        :FromName => from_name,
+        :FromEmail => from_email,
+        :ReplyTo => reply_to,
+        :HtmlUrl => html_url,
+        :TextUrl => text_url,
+        :ListIDs => list_ids,
+        :SegmentIDs => segment_ids }.to_json }
+      response = CreateSend.post "/campaigns/#{client_id}.json", options
+      response.parsed_response
+    end
+
+    # Sends a preview of this campaign.
+    def send_preview(recipients, personalize="fallback")
+      options = { :body => {
+        :PreviewRecipients => recipients.kind_of?(String) ? [ recipients ] : recipients,
+        :Personalize => personalize }.to_json }
+      response = post "sendpreview", options
+    end
+
+    # Sends this campaign.
+    def send(confirmation_email, send_date="immediately")
+      options = { :body => {
+        :ConfirmationEmail => confirmation_email,
+        :SendDate => send_date }.to_json }
+      response = post "send", options
+    end
+
+    # Deletes this campaign.
+    def delete
+      response = CreateSend.delete "/campaigns/#{campaign_id}.json", {}
+    end
+
+    # Gets a summary of this campaign
+    def summary
+      response = get "summary", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the lists and segments to which this campaaign will be (or was) sent.
+    def lists_and_segments
+      response = get "listsandsegments", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the recipients of this campaign.
+    def recipients(page=1, page_size=1000, order_field="email", order_direction="asc")
+      options = { :query => { 
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get 'recipients', options
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the opens for this campaign.
+    def opens(date, page=1, page_size=1000, order_field="date", order_direction="asc")
+      options = { :query => { 
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get "opens", options
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the subscriber clicks for this campaign.
+    def clicks(date, page=1, page_size=1000, order_field="date", order_direction="asc")
+      options = { :query => { 
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get "clicks", options
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the unsubscribes for this campaign.
+    def unsubscribes(date, page=1, page_size=1000, order_field="date", order_direction="asc")
+      options = { :query => { 
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get "unsubscribes", options
+      Hashie::Mash.new(response)
+    end
+
+    # Retrieves the bounces for this campaign.
+    def bounces(page=1, page_size=1000, order_field="date", order_direction="asc")
+      options = { :query => { 
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get "bounces", options
+      Hashie::Mash.new(response)
+    end
+
+    private
+
+    def get(action, options = {})
+      CreateSend.get uri_for(action), options
+    end
+
+    def post(action, options = {})
+      CreateSend.post uri_for(action), options
+    end
+
+    def uri_for(action)
+      "/campaigns/#{campaign_id}/#{action}.json"
+    end
 
-  def initialize(campaign_id)
-    @campaign_id = campaign_id
   end
-
-  # Creates a new campaign for a client.
-  def self.create(client_id, subject, name, from_name, from_email, reply_to, html_url,
-    text_url, list_ids, segment_ids)
-    options = { :body => { 
-      :Subject => subject,
-      :Name => name,
-      :FromName => from_name,
-      :FromEmail => from_email,
-      :ReplyTo => reply_to,
-      :HtmlUrl => html_url,
-      :TextUrl => text_url,
-      :ListIDs => list_ids,
-      :SegmentIDs => segment_ids }.to_json }
-    response = CreateSend.post "/campaigns/#{client_id}.json", options
-    response.parsed_response
-  end
-
-  # Sends a preview of this campaign.
-  def send_preview(recipients, personalize="fallback")
-    options = { :body => {
-      :PreviewRecipients => recipients.kind_of?(String) ? [ recipients ] : recipients,
-      :Personalize => personalize }.to_json }
-    response = post "sendpreview", options
-  end
-
-  # Sends this campaign.
-  def send(confirmation_email, send_date="immediately")
-    options = { :body => {
-      :ConfirmationEmail => confirmation_email,
-      :SendDate => send_date }.to_json }
-    response = post "send", options
-  end
-
-  # Deletes this campaign.
-  def delete
-    response = CreateSend.delete "/campaigns/#{campaign_id}.json", {}
-  end
-
-  # Gets a summary of this campaign
-  def summary
-    response = get "summary", {}
-    Hashie::Mash.new(response)
-  end
-
-  # Retrieves the lists and segments to which this campaaign will be (or was) sent.
-  def lists_and_segments
-    response = get "listsandsegments", {}
-    Hashie::Mash.new(response)
-  end
-
-  # Retrieves the recipients of this campaign.
-  def recipients(page=1, page_size=1000, order_field="email", order_direction="asc")
-    options = { :query => { 
-      :page => page,
-      :pagesize => page_size,
-      :orderfield => order_field,
-      :orderdirection => order_direction } }
-    response = get 'recipients', options
-    Hashie::Mash.new(response)
-  end
-
-  # Retrieves the opens for this campaign.
-  def opens(date, page=1, page_size=1000, order_field="date", order_direction="asc")
-    options = { :query => { 
-      :date => date,
-      :page => page,
-      :pagesize => page_size,
-      :orderfield => order_field,
-      :orderdirection => order_direction } }
-    response = get "opens", options
-    Hashie::Mash.new(response)
-  end
-
-  # Retrieves the subscriber clicks for this campaign.
-  def clicks(date, page=1, page_size=1000, order_field="date", order_direction="asc")
-    options = { :query => { 
-      :date => date,
-      :page => page,
-      :pagesize => page_size,
-      :orderfield => order_field,
-      :orderdirection => order_direction } }
-    response = get "clicks", options
-    Hashie::Mash.new(response)
-  end
-
-  # Retrieves the unsubscribes for this campaign.
-  def unsubscribes(date, page=1, page_size=1000, order_field="date", order_direction="asc")
-    options = { :query => { 
-      :date => date,
-      :page => page,
-      :pagesize => page_size,
-      :orderfield => order_field,
-      :orderdirection => order_direction } }
-    response = get "unsubscribes", options
-    Hashie::Mash.new(response)
-  end
-
-  # Retrieves the bounces for this campaign.
-  def bounces(page=1, page_size=1000, order_field="date", order_direction="asc")
-    options = { :query => { 
-      :page => page,
-      :pagesize => page_size,
-      :orderfield => order_field,
-      :orderdirection => order_direction } }
-    response = get "bounces", options
-    Hashie::Mash.new(response)
-  end
-
-  private
-
-  def get(action, options = {})
-    CreateSend.get uri_for(action), options
-  end
-
-  def post(action, options = {})
-    CreateSend.post uri_for(action), options
-  end
-
-  def uri_for(action)
-    "/campaigns/#{campaign_id}/#{action}.json"
-  end
-
-end
+end

data/lib/client.rb

@@ -1,135 +1,137 @@
 require 'createsend'
 require 'json'
 
-# Represents a client and associated functionality.
-class Client
-  attr_reader :client_id
-
-  def initialize(client_id)
-    @client_id = client_id
-  end
-
-  # Creates a client.
-  def self.create(company, contact_name, email, timezone, country)
-    options = { :body => { 
-      :CompanyName => company, 
-      :ContactName => contact_name,
-      :EmailAddress => email,
-      :TimeZone => timezone,
-      :Country => country }.to_json }
-    CreateSend.post "/clients.json", options
-  end
-
-  # Gets the details of this client.
-  def details
-    response = CreateSend.get "/clients/#{client_id}.json", {}
-    Hashie::Mash.new(response)
-  end
-
-  # Gets the sent campaigns belonging to this client.
-  def campaigns
-    response = get 'campaigns'
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Gets the draft campaigns belonging to this client.
-  def drafts
-    response = get 'drafts'
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Gets the subscriber lists belonging to this client.
-  def lists
-    response = get 'lists'
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Gets the segments belonging to this client.
-  def segments
-    response = get 'segments'
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Gets this client's suppression list.
-  def suppressionlist(page=1, page_size=1000, order_field="email", order_direction="asc")
-    options = { :query => { 
-      :page => page,
-      :pagesize => page_size,
-      :orderfield => order_field,
-      :orderdirection => order_direction } }
-    response = get 'suppressionlist', options
-    Hashie::Mash.new(response)
-  end
-
-  # Gets the templates belonging to this client.
-  def templates
-    response = get 'templates'
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Sets the basic details for this client.
-  def set_basics(company, contact_name, email, timezone, country)
-    options = { :body => { 
-      :CompanyName => company, 
-      :ContactName => contact_name,
-      :EmailAddress => email,
-      :TimeZone => timezone,
-      :Country => country }.to_json }
-    put 'setbasics', options
-  end
-
-  # Sets the access settings for this client.
-  def set_access(username, password, access_level)
-    options = { :body => { 
-      :Username => username, 
-      :Password => password, 
-      :AccessLevel => access_level }.to_json }
-    put 'setaccess', options
-  end
-
-  # Sets the PAYG billing settings for this client.
-  def set_payg_billing(currency, can_purchase_credits, client_pays, markup_percentage, 
-    markup_on_delivery=0, markup_per_recipient=0, markup_on_design_spam_test=0)
-    options = { :body => { 
-      :Currency => currency,
-      :CanPurchaseCredits => can_purchase_credits,
-      :ClientPays => client_pays,
-      :MarkupPercentage => markup_percentage,
-      :MarkupOnDelivery => markup_on_delivery,
-      :MarkupPerRecipient => markup_per_recipient,
-      :MarkupOnDesignSpamTest => markup_on_design_spam_test }.to_json }
-    put 'setpaygbilling', options
-  end
-
-  # Sets the monthly billing settings for this client.
-  def set_monthly_billing(currency, client_pays, markup_percentage)
-    options = { :body => { 
-      :Currency => currency,
-      :ClientPays => client_pays,
-      :MarkupPercentage => markup_percentage }.to_json }
-    put 'setmonthlybilling', options
-  end
-
-  # Deletes this client.
-  def delete
-    CreateSend.delete "/clients/#{client_id}.json", {}
-  end
-
-  private
-
-  def get(action, options = {})
-    CreateSend.get 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 uri_for(action)
-    "/clients/#{client_id}/#{action}.json"
-  end
-end
+module CreateSend
+  # Represents a client and associated functionality.
+  class Client
+    attr_reader :client_id
+
+    def initialize(client_id)
+      @client_id = client_id
+    end
+
+    # Creates a client.
+    def self.create(company, contact_name, email, timezone, country)
+      options = { :body => { 
+        :CompanyName => company, 
+        :ContactName => contact_name,
+        :EmailAddress => email,
+        :TimeZone => timezone,
+        :Country => country }.to_json }
+      CreateSend.post "/clients.json", options
+    end
+
+    # Gets the details of this client.
+    def details
+      response = CreateSend.get "/clients/#{client_id}.json", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Gets the sent campaigns belonging to this client.
+    def campaigns
+      response = get 'campaigns'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the draft campaigns belonging to this client.
+    def drafts
+      response = get 'drafts'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the subscriber lists belonging to this client.
+    def lists
+      response = get 'lists'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the segments belonging to this client.
+    def segments
+      response = get 'segments'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets this client's suppression list.
+    def suppressionlist(page=1, page_size=1000, order_field="email", order_direction="asc")
+      options = { :query => { 
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get 'suppressionlist', options
+      Hashie::Mash.new(response)
+    end
+
+    # Gets the templates belonging to this client.
+    def templates
+      response = get 'templates'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Sets the basic details for this client.
+    def set_basics(company, contact_name, email, timezone, country)
+      options = { :body => { 
+        :CompanyName => company, 
+        :ContactName => contact_name,
+        :EmailAddress => email,
+        :TimeZone => timezone,
+        :Country => country }.to_json }
+      put 'setbasics', options
+    end
+
+    # Sets the access settings for this client.
+    def set_access(username, password, access_level)
+      options = { :body => { 
+        :Username => username, 
+        :Password => password, 
+        :AccessLevel => access_level }.to_json }
+      put 'setaccess', options
+    end
+
+    # Sets the PAYG billing settings for this client.
+    def set_payg_billing(currency, can_purchase_credits, client_pays, markup_percentage, 
+      markup_on_delivery=0, markup_per_recipient=0, markup_on_design_spam_test=0)
+      options = { :body => { 
+        :Currency => currency,
+        :CanPurchaseCredits => can_purchase_credits,
+        :ClientPays => client_pays,
+        :MarkupPercentage => markup_percentage,
+        :MarkupOnDelivery => markup_on_delivery,
+        :MarkupPerRecipient => markup_per_recipient,
+        :MarkupOnDesignSpamTest => markup_on_design_spam_test }.to_json }
+      put 'setpaygbilling', options
+    end
+
+    # Sets the monthly billing settings for this client.
+    def set_monthly_billing(currency, client_pays, markup_percentage)
+      options = { :body => { 
+        :Currency => currency,
+        :ClientPays => client_pays,
+        :MarkupPercentage => markup_percentage }.to_json }
+      put 'setmonthlybilling', options
+    end
+
+    # Deletes this client.
+    def delete
+      CreateSend.delete "/clients/#{client_id}.json", {}
+    end
+
+    private
+
+    def get(action, options = {})
+      CreateSend.get 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 uri_for(action)
+      "/clients/#{client_id}/#{action}.json"
+    end
+  end
+end