createsend 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+config.yaml
+config.jdennes.yaml
+rdoc
+pkg
+*.gem
+example.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# createsend
+
+A wrapper for the createsend API v3.

data/Rakefile

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "bundler/version"
+require "shoulda/tasks"
+require 'lib/createsend'
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.ruby_opts = ["-rubygems"] if defined? Gem
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+end
+
+desc "Build the gem"
+task :build do
+  system "gem build createsend.gemspec"
+end
+
+desc "Build and release the gem"
+task :release => :build do
+  system "gem push createsend-#{CreateSend::VER}.gem"
+end
+
+task :default => :test

data/config.example.yaml

@@ -0,0 +1,2 @@
+base_uri: 'http://api.createsend.com/api/v3'
+api_key: 'your_api_key'

data/createsend.gemspec

@@ -0,0 +1,26 @@
+require 'bundler'
+require 'bundler/version'
+
+require File.expand_path('lib/createsend')
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('fakeweb', '~> 1.3')
+  s.add_development_dependency('jnunemaker-matchy', '~> 0.4.0')
+  s.add_development_dependency('mocha', '~> 0.9')
+  s.add_development_dependency('shoulda', '~> 2.11')
+  s.add_runtime_dependency('hashie', '~> 0.4.0')
+  s.add_runtime_dependency('httparty', '~> 0.6.1')
+  s.name = "createsend"
+  s.author = "James Dennes"
+  s.description = %q{A wrapper for the CreateSend API v3}
+  s.email = ["jdennes@gmail.com"]
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.files = `git ls-files`.split("\n")
+  s.homepage = "http://github.com/campaignmonitor/createsend-ruby/"
+  s.require_paths = ["lib"]
+  s.summary = %q{Wrapper for the CreateSend API v3}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = CreateSend::VER
+  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

@@ -0,0 +1,90 @@
+require 'createsend'
+require 'json'
+
+class Campaign
+  attr_reader :campaign_id
+
+  def initialize(campaign_id)
+    @campaign_id = campaign_id
+  end
+
+  def self.create(client_id, subject, name, from_name, from_email, reply_to, html_url,
+    text_url, list_ids, segments)
+    options = { :body => { 
+      :Subject => subject,
+      :Name => name,
+      :FromName => from_name,
+      :FromEmail => from_email,
+      :ReplyTo => reply_to,
+      :HtmlUrl => html_url,
+      :TextUrl => text_url,
+      :ListIDs => list_ids ,
+      :Segments => segments }.to_json }
+    response = CreateSend.post "/campaigns/#{client_id}.json", options
+    response.parsed_response
+  end
+  
+  def send(confirmation_email, send_date="immediately")
+    options = { :body => {
+      :ConfirmationEmail => confirmation_email,
+      :SendDate => send_date }.to_json }
+    response = post "send", options
+  end
+
+  def delete
+    response = CreateSend.delete "/campaigns/#{campaign_id}.json", {}
+  end
+  
+  def summary
+    response = get "summary", {}
+    Hashie::Mash.new(response)
+  end
+  
+  def lists
+    response = get "lists", {}
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+  
+  def segments
+    # TODO: This needs to be implemented
+    []
+  end
+  
+  def opens(date)
+    options = { :query => { :date => date } }
+    response = get "opens", options
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+  
+  def clicks(date)
+    options = { :query => { :date => date } }
+    response = get "clicks", options
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+  
+  def unsubscribes(date)
+    options = { :query => { :date => date } }
+    response = get "unsubscribes", options
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+  
+  def bounces
+    response = get "bounces", {}
+    response.map{|item| Hashie::Mash.new(item)}
+  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

data/lib/client.rb

@@ -0,0 +1,117 @@
+require 'createsend'
+require 'json'
+
+class Client
+  attr_reader :client_id
+
+  def initialize(client_id)
+    @client_id = client_id
+  end
+
+  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
+
+  def details
+    response = CreateSend.get "/clients/#{client_id}.json", {}
+    Hashie::Mash.new(response)
+  end
+
+  def campaigns
+    response = get 'campaigns'
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  def drafts
+    response = get 'drafts'
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  def lists
+    response = get 'lists'
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  def segments
+    response = get 'segments'
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  def suppressionlist
+    response = get 'suppressionlist'
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+  
+  def templates
+    response = get 'templates'
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  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
+
+  def set_access(username, password, access_level)
+    options = { :body => { 
+      :Username => username, 
+      :Password => password, 
+      :AccessLevel => access_level }.to_json }
+    put 'setaccess', options
+  end
+
+  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
+
+  def set_monthly_billing(currency, can_purchase_credits, client_pays, markup_percentage)
+    options = { :body => { 
+      :Currency => currency,
+      :CanPurchaseCredits => can_purchase_credits,
+      :ClientPays => client_pays,
+      :MarkupPercentage => markup_percentage }.to_json }
+    put 'setmonthlybilling', options
+  end
+
+  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

data/lib/createsend.rb

@@ -0,0 +1,103 @@
+require 'cgi'
+require 'uri'
+require 'httparty'
+require 'hashie'
+Hash.send :include, Hashie::HashExtensions
+
+CreateSendOptions = { 'api_key' => nil, 'base_uri' => "http://api.createsend.com/api/v3" } if not Object.const_defined? :CreateSendOptions # :nodoc:
+if File.exists?('config.yaml')
+  config = YAML.load_file('config.yaml')
+  CreateSendOptions['base_uri'] = config['base_uri']
+  CreateSendOptions['api_key'] = config['api_key']
+end
+
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'client'
+require 'campaign'
+require 'list'
+require 'subscriber'
+require 'template'
+
+class CreateSendError < StandardError
+  attr_reader :data
+  def initialize(data)
+    @data = data
+    super "The CreateSend API responded with the following error - #{@data.Code}: #{@data.Message}"
+  end
+end
+
+class ClientError < StandardError; end
+class ServerError < StandardError; end
+class BadRequest < CreateSendError; end
+class Unauthorized < ClientError; end
+class NotFound < ClientError; end
+class Unavailable < StandardError; end
+
+class CreateSend
+  include HTTParty
+  headers 'Content-Type' => 'application/json'
+  base_uri CreateSendOptions['base_uri']
+  basic_auth CreateSendOptions['api_key'], 'x'
+  
+  VER = "0.0.1" unless defined?(CreateSend::VER)
+  
+  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
+  
+  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
+
+  def clients
+    response = CreateSend.get('/clients.json')
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  def countries
+    response = CreateSend.get('/countries.json')
+    response.parsed_response
+  end
+
+  def systemdate
+    response = CreateSend.get('/systemdate.json')
+    Hashie::Mash.new(response)
+  end
+
+  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)
+    case response.code
+    when 400
+      raise BadRequest.new(Hashie::Mash.new response)
+    when 401
+      raise Unauthorized.new
+    when 404
+      raise NotFound.new
+    when 400...500
+      raise ClientError.new
+    when 500...600
+      raise ServerError.new
+    else
+      response
+    end
+  end
+end

data/lib/list.rb

@@ -0,0 +1,99 @@
+require 'createsend'
+require 'json'
+
+class List
+  attr_reader :list_id
+
+  def initialize(list_id)
+    @list_id = list_id
+  end
+
+  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
+
+  def delete
+    response = CreateSend.delete "/lists/#{list_id}.json", {}
+  end
+  
+  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
+
+  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
+  
+  def details
+    response = CreateSend.get "/lists/#{list_id}.json", {}
+    Hashie::Mash.new(response)
+  end
+  
+  def custom_fields
+    response = get "customfields"
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+  
+  def stats
+    response = get "stats"
+    Hashie::Mash.new(response)
+  end
+
+  def active(date)
+    options = { :query => { :date => date } }
+    response = get "active", options
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  def bounced(date)
+    options = { :query => { :date => date } }
+    response = get "bounced", options
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  def unsubscribed(date)
+    options = { :query => { :date => date } }
+    response = get "unsubscribed", options
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+  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
+
+  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