createsend 0.1.1 → 0.2.0

data/lib/createsend.rb

@@ -21,94 +21,108 @@ require 'segment'
 require 'subscriber'
 require 'template'
 
-# Represents a CreateSend API error and contains specific data about the error.
-class CreateSendError < StandardError
-  attr_reader :data
-  def initialize(data)
-    @data = data
-    # @data should contain Code, Message and optionally ResultData
-    extra = @data.ResultData ? "\nExtra result data: #{@data.ResultData}" : ""
-    super "The CreateSend API responded with the following error - #{@data.Code}: #{@data.Message}#{extra}"
-  end
-end
+module CreateSend
+  VERSION = "0.2.0" unless defined?(CreateSend::VERSION)
 
-class ClientError < StandardError; end
-class ServerError < StandardError; end
-class BadRequest < CreateSendError; end
-class Unauthorized < CreateSendError; end
-class NotFound < ClientError; end
-class Unavailable < StandardError; end
-
-# Provides high level CreateSend functionality/data you'll probably need.
-class CreateSend
-  include HTTParty
-
-  VER = "0.1.1" unless defined?(CreateSend::VER)
-  headers({ 'User-Agent' => "createsend-ruby-#{CreateSend::VER}", 'Content-Type' => 'application/json' })
-  base_uri CreateSendOptions['base_uri']
-  basic_auth CreateSendOptions['api_key'], 'x'
-
-  # Sets the API key which will be used to make calls to the CreateSend API.
-  def self.api_key(api_key=nil)
-    return @@api_key unless api_key
-    CreateSendOptions['api_key'] = api_key
-    @@api_key = api_key
-    basic_auth @@api_key, 'x'
+  # Just allows callers to do CreateSend.api_key "..." rather than CreateSend::CreateSend.api_key "..." etc
+  class << self
+    def api_key(api_key=nil)
+      r = CreateSend.api_key api_key
+    end
+    
+    def base_uri(uri)
+      r = CreateSend.base_uri uri
+    end
   end
 
-  # Gets your CreateSend API key, given your site url, username and password.
-  def apikey(site_url, username, password) 
-    site_url = CGI.escape(site_url)
-    self.class.basic_auth username, password
-    response = CreateSend.get("/apikey.json?SiteUrl=#{site_url}")
-    # Revert basic_auth to use @@api_key, 'x'
-    self.class.basic_auth @@api_key, 'x'
-    Hashie::Mash.new(response)
+  # Represents a CreateSend API error and contains specific data about the error.
+  class CreateSendError < StandardError
+    attr_reader :data
+    def initialize(data)
+      @data = data
+      # @data should contain Code, Message and optionally ResultData
+      extra = @data.ResultData ? "\nExtra result data: #{@data.ResultData}" : ""
+      super "The CreateSend API responded with the following error - #{@data.Code}: #{@data.Message}#{extra}"
+    end
   end
 
-  # Gets your clients.
-  def clients
-    response = CreateSend.get('/clients.json')
-    response.map{|item| Hashie::Mash.new(item)}
-  end
+  class ClientError < StandardError; end
+  class ServerError < StandardError; end
+  class BadRequest < CreateSendError; end
+  class Unauthorized < CreateSendError; end
+  class NotFound < ClientError; end
+  class Unavailable < StandardError; end
 
-  # Gets valid countries.
-  def countries
-    response = CreateSend.get('/countries.json')
-    response.parsed_response
-  end
+  # Provides high level CreateSend functionality/data you'll probably need.
+  class CreateSend
+    include HTTParty
 
-  # Gets the current date in your account's timezone.
-  def systemdate
-    response = CreateSend.get('/systemdate.json')
-    Hashie::Mash.new(response)
-  end
+    headers({ 'User-Agent' => "createsend-ruby-#{CreateSend::VERSION}", 'Content-Type' => 'application/json' })
+    base_uri CreateSendOptions['base_uri']
+    basic_auth CreateSendOptions['api_key'], 'x'
 
-  # Gets valid timezones.
-  def timezones
-    response = CreateSend.get('/timezones.json')
-    response.parsed_response
-  end
+    # Sets the API key which will be used to make calls to the CreateSend API.
+    def self.api_key(api_key=nil)
+      return @@api_key unless api_key
+      CreateSendOptions['api_key'] = api_key
+      @@api_key = api_key
+      basic_auth @@api_key, 'x'
+    end
+
+    # Gets your CreateSend API key, given your site url, username and password.
+    def apikey(site_url, username, password) 
+      site_url = CGI.escape(site_url)
+      self.class.basic_auth username, password
+      response = CreateSend.get("/apikey.json?SiteUrl=#{site_url}")
+      # Revert basic_auth to use @@api_key, 'x'
+      self.class.basic_auth @@api_key, 'x'
+      Hashie::Mash.new(response)
+    end
+
+    # Gets your clients.
+    def clients
+      response = CreateSend.get('/clients.json')
+      response.map{|item| Hashie::Mash.new(item)}
+    end
 
-  def self.get(*args); handle_response super end
-  def self.post(*args); handle_response super end
-  def self.put(*args); handle_response super end
-  def self.delete(*args); handle_response super end
-
-  def self.handle_response(response) # :nodoc:
-    case response.code
-    when 400
-      raise BadRequest.new(Hashie::Mash.new response)
-    when 401
-      raise Unauthorized.new(Hashie::Mash.new response)
-    when 404
-      raise NotFound.new
-    when 400...500
-      raise ClientError.new
-    when 500...600
-      raise ServerError.new
-    else
-      response
+    # Gets valid countries.
+    def countries
+      response = CreateSend.get('/countries.json')
+      response.parsed_response
+    end
+
+    # Gets the current date in your account's timezone.
+    def systemdate
+      response = CreateSend.get('/systemdate.json')
+      Hashie::Mash.new(response)
+    end
+
+    # Gets valid timezones.
+    def timezones
+      response = CreateSend.get('/timezones.json')
+      response.parsed_response
+    end
+
+    def self.get(*args); handle_response super end
+    def self.post(*args); handle_response super end
+    def self.put(*args); handle_response super end
+    def self.delete(*args); handle_response super end
+
+    def self.handle_response(response) # :nodoc:
+      case response.code
+      when 400
+        raise BadRequest.new(Hashie::Mash.new response)
+      when 401
+        raise Unauthorized.new(Hashie::Mash.new response)
+      when 404
+        raise NotFound.new
+      when 400...500
+        raise ClientError.new
+      when 500...600
+        raise ServerError.new
+      else
+        response
+      end
     end
   end
-end
+end

data/lib/list.rb

@@ -1,186 +1,185 @@
 require 'createsend'
 require 'json'
 
-# Represents a subscriber list and associated functionality.
-class List
-  attr_reader :list_id
+module CreateSend
+  # Represents a subscriber list and associated functionality.
+  class List
+    attr_reader :list_id
+
+    def initialize(list_id)
+      @list_id = list_id
+    end
+
+    # Creates a new list for a client.
+    def self.create(client_id, title, unsubscribe_page, confirmed_opt_in, confirmation_success_page)
+      options = { :body => {
+        :Title => title,
+        :UnsubscribePage => unsubscribe_page,
+        :ConfirmedOptIn => confirmed_opt_in,
+        :ConfirmationSuccessPage => confirmation_success_page }.to_json }
+      response = CreateSend.post "/lists/#{client_id}.json", options
+      response.parsed_response
+    end
+
+    # Deletes this list.
+    def delete
+      response = CreateSend.delete "/lists/#{list_id}.json", {}
+    end
+
+    # Creates a new custom field for this list.
+    def create_custom_field(field_name, data_type, options=[])
+      options = { :body => {
+        :FieldName => field_name,
+        :DataType => data_type,
+        :Options => options }.to_json }
+      response = post "customfields", options
+      response.parsed_response
+    end
+
+    # 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 "/lists/#{list_id}/customfields/#{custom_field_key}.json", {}
+    end
+
+    # Updates the options of a multi-optioned custom field on this list.
+    def update_custom_field_options(custom_field_key, new_options, keep_existing_options)
+      custom_field_key = CGI.escape(custom_field_key)
+      options = { :body => {
+        :Options => new_options,
+        :KeepExistingOptions => keep_existing_options }.to_json }
+      response = put "customfields/#{custom_field_key}/options", options
+    end
+
+    # Gets the details of this list.
+    def details
+      response = CreateSend.get "/lists/#{list_id}.json", {}
+      Hashie::Mash.new(response)
+    end
+
+    # Gets the custom fields for this list.
+    def custom_fields
+      response = get "customfields"
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the segments for this list.
+    def segments
+      response = get "segments"
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Gets the stats for this list.
+    def stats
+      response = get "stats"
+      Hashie::Mash.new(response)
+    end
+
+    # 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)
+    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)
+    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)
+    end
+
+    # Updates this list.
+    def update(title, unsubscribe_page, confirmed_opt_in, confirmation_success_page)
+      options = { :body => {
+        :Title => title,
+        :UnsubscribePage => unsubscribe_page,
+        :ConfirmedOptIn => confirmed_opt_in,
+        :ConfirmationSuccessPage => confirmation_success_page }.to_json }
+      response = CreateSend.put "/lists/#{list_id}.json", options
+    end
+
+    # Gets the webhooks for this list.
+    def webhooks
+      response = get "webhooks"
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
+    # Creates a new webhook for the specified events (an array of strings). 
+    # Valid events are "Subscribe", "Deactivate", and "Update".
+    # Valid payload formats are "json", and "xml".
+    def create_webhook(events, url, payload_format)
+      options = { :body => {
+        :Events => events,
+        :Url => url,
+        :PayloadFormat => payload_format }.to_json }
+      response = post "webhooks", options
+      response.parsed_response
+    end
+
+    # Tests that a post can be made to the endpoint specified for the webhook
+    # identified by webhook_id.
+    def test_webhook(webhook_id)
+      response = get "webhooks/#{webhook_id}/test"
+      true # An exception will be raised if any error occurs
+    end
+
+    # Deletes a webhook associated with this list.
+    def delete_webhook(webhook_id)
+      response = CreateSend.delete "/lists/#{list_id}/webhooks/#{webhook_id}.json", {}
+    end
+
+    # Activates a webhook associated with this list.
+    def activate_webhook(webhook_id)
+      options = { :body => '' }
+      response = put "webhooks/#{webhook_id}/activate", options
+    end
+
+    # De-activates a webhook associated with this list.
+    def deactivate_webhook(webhook_id)
+      options = { :body => '' }
+      response = put "webhooks/#{webhook_id}/deactivate", options
+    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)
+      "/lists/#{list_id}/#{action}.json"
+    end
 
-  def initialize(list_id)
-    @list_id = list_id
   end
-
-  # Creates a new list for a client.
-  def self.create(client_id, title, unsubscribe_page, confirmed_opt_in, confirmation_success_page)
-    options = { :body => {
-      :Title => title,
-      :UnsubscribePage => unsubscribe_page,
-      :ConfirmedOptIn => confirmed_opt_in,
-      :ConfirmationSuccessPage => confirmation_success_page }.to_json }
-    response = CreateSend.post "/lists/#{client_id}.json", options
-    response.parsed_response
-  end
-
-  # Deletes this list.
-  def delete
-    response = CreateSend.delete "/lists/#{list_id}.json", {}
-  end
-
-  # Creates a new custom field for this list.
-  def create_custom_field(field_name, data_type, options=[])
-    options = { :body => {
-      :FieldName => field_name,
-      :DataType => data_type,
-      :Options => options }.to_json }
-    response = post "customfields", options
-    response.parsed_response
-  end
-
-  # 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 "/lists/#{list_id}/customfields/#{custom_field_key}.json", {}
-  end
-
-  # Updates the options of a multi-optioned custom field on this list.
-  def update_custom_field_options(custom_field_key, new_options, keep_existing_options)
-    custom_field_key = CGI.escape(custom_field_key)
-    options = { :body => {
-      :Options => new_options,
-      :KeepExistingOptions => keep_existing_options }.to_json }
-    response = put "customfields/#{custom_field_key}/options", options
-  end
-
-  # Gets the details of this list.
-  def details
-    response = CreateSend.get "/lists/#{list_id}.json", {}
-    Hashie::Mash.new(response)
-  end
-
-  # Gets the custom fields for this list.
-  def custom_fields
-    response = get "customfields"
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Gets the segments for this list.
-  def segments
-    response = get "segments"
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Gets the stats for this list.
-  def stats
-    response = get "stats"
-    Hashie::Mash.new(response)
-  end
-
-  # 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)
-  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)
-  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)
-  end
-
-  # Updates this list.
-  def update(title, unsubscribe_page, confirmed_opt_in, confirmation_success_page)
-    options = { :body => {
-      :Title => title,
-      :UnsubscribePage => unsubscribe_page,
-      :ConfirmedOptIn => confirmed_opt_in,
-      :ConfirmationSuccessPage => confirmation_success_page }.to_json }
-    response = CreateSend.put "/lists/#{list_id}.json", options
-  end
-
-  # Please note: Any webhook-related methods below are not yet supported in production.
-  # The gem version will be bumped when these are released in production.
-
-  # Gets the webhooks for this list.
-  def webhooks
-    response = get "webhooks"
-    response.map{|item| Hashie::Mash.new(item)}
-  end
-
-  # Creates a new webhook for the specified events (an array of strings). 
-  # Valid events are "Subscribe", "Unsubscribe", "Bounce", "Spam", and 
-  # "SubscriberUpdate". Valid payload formats are "json", and "xml".
-  def create_webhook(events, url, payload_format)
-    options = { :body => {
-      :Events => events,
-      :Url => url,
-      :PayloadFormat => payload_format }.to_json }
-    response = post "webhooks", options
-    response.parsed_response
-  end
-
-  # Tests that a post can be made to the endpoint specified for the webhook
-  # identified by webhook_id.
-  def test_webhook(webhook_id)
-    response = get "webhooks/#{webhook_id}/test"
-    true # An exception will be raised if any error occurs
-  end
-
-  # Deletes a webhook associated with this list.
-  def delete_webhook(webhook_id)
-    response = CreateSend.delete "/lists/#{list_id}/webhooks/#{webhook_id}.json", {}
-  end
-
-  # Activates a webhook associated with this list.
-  def activate_webhook(webhook_id)
-    options = { :body => '' }
-    response = put "webhooks/#{webhook_id}/activate", options
-  end
-
-  # De-activates a webhook associated with this list.
-  def deactivate_webhook(webhook_id)
-    options = { :body => '' }
-    response = put "webhooks/#{webhook_id}/deactivate", options
-  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)
-    "/lists/#{list_id}/#{action}.json"
-  end
-
 end