createsend 1.0.4 → 1.1.0

data/.gitignore

@@ -3,3 +3,5 @@ rdoc
 pkg
 *.gem
 example.rb
+/.buildpath
+/.project

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    createsend (1.0.3)
+    createsend (1.1.0)
       hashie (~> 1.0)
       httparty (~> 0.8)
       json

data/lib/createsend.rb

@@ -13,6 +13,8 @@ require 'createsend/list'
 require 'createsend/segment'
 require 'createsend/subscriber'
 require 'createsend/template'
+require 'createsend/person'
+require 'createsend/administrator'
 
 module CreateSend
 
@@ -110,6 +112,23 @@ module CreateSend
       response = CreateSend.get('/timezones.json')
       response.parsed_response
     end
+    
+    # Gets the administrators
+    def administrators
+      response = CreateSend.get('/admins.json')
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+    
+    def get_primary_contact
+      response = CreateSend.get('/primarycontact.json')
+      Hashie::Mash.new(response)
+    end
+    
+    def set_primary_contact(email)
+      options = { :query => { :email => email } }
+      response = CreateSend.put("/primarycontact.json", options)
+      Hashie::Mash.new(response)
+    end
 
     def self.get(*args); handle_response super end
     def self.post(*args); handle_response super end

data/lib/createsend/administrator.rb

@@ -0,0 +1,49 @@
+require 'createsend'
+require 'json'
+
+module CreateSend
+  # Represents an administrator and associated functionality.
+  class Administrator
+    attr_reader :email_address
+
+    def initialize(email_address)
+      @email_address = email_address
+    end
+
+    # Gets an adminsitrator by email address.
+    def self.get(email_address)
+      options = { :query => { :email => email_address } }
+      response = CreateSend.get "/admins.json", options
+      Hashie::Mash.new(response)
+    end
+
+    # Adds an adminstrator to the account
+    def self.add(email_address, name)
+      options = { :body => {
+        :EmailAddress => email_address,
+        :Name => name
+      }.to_json }
+      response = CreateSend.post "/admins.json", options
+      Hashie::Mash.new(response)
+    end
+  
+    # Updates the administator details
+    def update(new_email_address, name)
+      options = {
+        :query => { :email => @email_address },
+        :body => {
+          :EmailAddress => new_email_address,
+          :Name => name
+        }.to_json }
+      CreateSend.put '/admins.json', options
+      # Update @email_address, so this object can continue to be used reliably
+      @email_address = new_email_address
+    end
+
+    # deletes this administrator from the account
+    def delete
+      options = { :query => { :email => @email_address } }
+      CreateSend.delete '/admins.json', options
+    end   
+  end
+end

data/lib/createsend/client.rb

@@ -12,6 +12,9 @@ module CreateSend
 
     # Creates a client.
     def self.create(company, contact_name, email, timezone, country)
+      warn "[DEPRECATION] Use person.add or person.update to set the name on a particular person in a client. For now, we will create a default person with the name provided." unless contact_name.to_s == ''
+      warn "[DEPRECATION] Use person.add or person.update to set the email on a particular person in a client. For now, we will create a default person with the email provided." unless email.to_s == ''
+      
       options = { :body => { 
         :CompanyName => company, 
         :ContactName => contact_name,
@@ -56,6 +59,23 @@ module CreateSend
       response = get 'segments'
       response.map{|item| Hashie::Mash.new(item)}
     end
+    
+    # Gets the people associated with this client
+    def people
+      response = get "people"
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+    
+    def get_primary_contact
+      response = get "primarycontact"
+      Hashie::Mash.new(response)
+    end
+    
+    def set_primary_contact(email)
+      options = { :query => { :email => email } }
+      response = put "primarycontact", options
+      Hashie::Mash.new(response)
+    end
 
     # Gets this client's suppression list.
     def suppressionlist(page=1, page_size=1000, order_field="email", order_direction="asc")
@@ -76,6 +96,9 @@ module CreateSend
 
     # Sets the basic details for this client.
     def set_basics(company, contact_name, email, timezone, country)
+      warn "[DEPRECATION] Use person.update to set name on a particular person in a client. This will fail if there are multiple persons in a client." unless contact_name.to_s == ''
+      warn "[DEPRECATION] Use person.update to set email on a particular person in a client. This will fail if there are multiple persons in a client." unless email.to_s == ''
+            
       options = { :body => { 
         :CompanyName => company, 
         :ContactName => contact_name,
@@ -85,15 +108,6 @@ module CreateSend
       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)
@@ -116,6 +130,18 @@ module CreateSend
         :MarkupPercentage => markup_percentage }.to_json }
       put 'setmonthlybilling', options
     end
+    
+    # THIS METHOD IS DEPRECATED. It should only be used with existing integrations.
+    # Sets the access settings for this client.
+    def set_access(username, password, access_level)
+      warn "[DEPRECATION] `set_access` is deprecated. Use Person.update to set access on a particular person in a client."
+          
+      options = { :body => { 
+        :Username => username, 
+        :Password => password, 
+        :AccessLevel => access_level }.to_json }
+      put 'setaccess', options
+    end
 
     # Deletes this client.
     def delete

data/lib/createsend/person.rb

@@ -0,0 +1,58 @@
+require 'createsend'
+require 'json'
+
+module CreateSend
+  # Represents a person and associated functionality.
+  class Person
+    attr_reader :client_id
+    attr_reader :email_address
+
+    def initialize(client_id, email_address)
+      @client_id = client_id
+      @email_address = email_address
+    end
+
+    # Gets a person by client ID and email address.
+    def self.get(client_id, email_address)
+      options = { :query => { :email => email_address } }
+      response = CreateSend.get "/clients/#{client_id}/people.json", options
+      Hashie::Mash.new(response)
+    end
+
+    # 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)
+      options = { :body => {
+        :EmailAddress => email_address,
+        :Name => name,
+        :AccessLevel => access_level,
+        :Password => password }.to_json }
+      response = CreateSend.post "/clients/#{client_id}/people.json", options
+      Hashie::Mash.new(response)
+    end
+  
+    # Updates the person details. password is optional and will only be updated if supplied
+    def update(new_email_address, name, access_level, password)
+      options = {
+        :query => { :email => @email_address },
+        :body => {
+          :EmailAddress => new_email_address,
+          :Name => name,
+          :AccessLevel => access_level,
+          :Password => password }.to_json }
+      CreateSend.put uri_for(client_id), options
+      # Update @email_address, so this object can continue to be used reliably
+      @email_address = new_email_address
+    end
+
+    # deletes this person from the client
+    def delete
+      options = { :query => { :email => @email_address } }
+      CreateSend.delete uri_for(client_id), options
+    end
+    
+    def uri_for(client_id)
+         "/clients/#{client_id}/people.json"
+    end
+  end
+end

data/lib/createsend/version.rb

@@ -1,3 +1,3 @@
 module CreateSend
-  VERSION = "1.0.4" unless defined?(CreateSend::VERSION)
+  VERSION = "1.1.0" unless defined?(CreateSend::VERSION)
 end

data/test/administrator_test.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/helper'
+
+class AdministratorTest < Test::Unit::TestCase
+  context "when an api caller is authenticated" do
+    setup do
+      @api_key = '123123123123123123123'
+      CreateSend.api_key @api_key
+      @admin = CreateSend::Administrator.new "admin@example.com"
+    end
+    
+    should "get a administrator by email address" do
+      email = "admin@example.com"
+      stub_get(@api_key, "admins.json?email=#{CGI.escape(email)}", "admin_details.json")      
+      admin = CreateSend::Administrator.get email
+      admin.EmailAddress.should == email
+      admin.Name.should == "Admin One"
+      admin.Status.should == "Active"
+    end
+
+    should "add an administrator" do
+      stub_post(@api_key, "admins.json", "add_admin.json")
+      result = CreateSend::Administrator.add "admin@example.com", "Admin"
+      result.EmailAddress.should == "admin@example.com"
+    end
+
+    should "update an administrator" do
+      email = "admin@example.com"
+      new_email = "new_email_address@example.com"
+      stub_put(@api_key, "admins.json?email=#{CGI.escape(email)}", nil)
+      @admin.update new_email, "Admin Name"
+      @admin.email_address.should == new_email
+    end
+      
+    should "delete an admin" do
+      stub_delete(@api_key, "admins.json?email=#{CGI.escape(@admin.email_address)}", nil)
+      @admin.delete
+    end
+  end
+end

data/test/client_test.rb

@@ -94,6 +94,16 @@ class ClientTest < Test::Unit::TestCase
       res.Results.first.Date.should == "2010-10-26 10:55:31"
       res.Results.first.State.should == "Suppressed"
     end
+    
+    should "get all people" do
+      stub_get(@api_key, "clients/#{@client.client_id}/people.json", "people.json")
+      people = @client.people
+      people.size.should == 2
+      people.first.EmailAddress.should == "person1@blackhole.com"
+      people.first.Name.should == "Person One"
+      people.first.Status.should == "Active"
+      people.first.AccessLevel.should == 31
+    end
 
     should "get all templates" do
       stub_get(@api_key, "clients/#{@client.client_id}/templates.json", "templates.json")
@@ -103,6 +113,19 @@ class ClientTest < Test::Unit::TestCase
       templates.first.Name.should == 'Template One'
     end
     
+    should "set primary contact" do
+      email = 'person@blackhole.com'
+      stub_put(@api_key, "clients/#{@client.client_id}/primarycontact.json?email=#{CGI.escape(email)}", 'client_set_primary_contact.json')
+      result = @client.set_primary_contact email
+      result.EmailAddress.should == email
+    end
+    
+    should "get primary contact" do
+      stub_get(@api_key, "clients/#{@client.client_id}/primarycontact.json", 'client_get_primary_contact.json')
+      result = @client.get_primary_contact
+      result.EmailAddress.should == 'person@blackhole.com'
+    end
+    
     should "set basics" do
       stub_put(@api_key, "clients/#{@client.client_id}/setbasics.json", nil)
       @client.set_basics "Client Company Name", "Client Contact Name", "client@example.com", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"

data/test/createsend_test.rb

@@ -54,6 +54,29 @@ class CreateSendTest < Test::Unit::TestCase
       timezones.size.should == 97
       assert timezones.include? "(GMT+12:00) Fiji"
     end
+    
+    should "get all administrators" do
+      stub_get(@api_key, "admins.json", "administrators.json")
+      administrators = @cs.administrators
+      administrators.size.should == 2
+      administrators.first.EmailAddress.should == "admin1@blackhole.com"
+      administrators.first.Name.should == 'Admin One'
+      administrators.first.Status.should == 'Active'
+    end
+      
+    should "set primary contact" do
+      email = 'admin@blackhole.com'
+      stub_put(@api_key, "primarycontact.json?email=#{CGI.escape(email)}", 'admin_set_primary_contact.json')
+      result = @cs.set_primary_contact email
+      result.EmailAddress.should == email
+    end
+    
+    should "get primary contact" do
+      stub_get(@api_key, "primarycontact.json", 'admin_get_primary_contact.json')
+      result = @cs.get_primary_contact
+      result.EmailAddress.should == 'admin@blackhole.com'
+    end
+        
   end
 
   context "when the CreateSend API responds with an error" do

data/test/fixtures/add_admin.json

@@ -0,0 +1,3 @@
+{
+    "EmailAddress": "admin@example.com"
+}

data/test/fixtures/add_person.json

@@ -0,0 +1,3 @@
+{
+    "EmailAddress": "person@example.com"
+}

data/test/fixtures/admin_details.json

@@ -0,0 +1,5 @@
+{
+    "EmailAddress": "admin@example.com",
+    "Name": "Admin One",
+    "Status": "Active"
+}

data/test/fixtures/admin_get_primary_contact.json

@@ -0,0 +1,3 @@
+{
+    "EmailAddress": "admin@blackhole.com"
+}

data/test/fixtures/admin_set_primary_contact.json

@@ -0,0 +1,3 @@
+{
+    "EmailAddress": "admin@blackhole.com"
+}

data/test/fixtures/administrators.json

@@ -0,0 +1,12 @@
+[
+  {
+    "EmailAddress": "admin1@blackhole.com",
+    "Name": "Admin One",
+    "Status": "Active"
+  },
+  {
+    "EmailAddress": "admin2@blackhole.com",
+    "Name": "Admin Two",
+    "Status": "Active"
+  }
+]

data/test/fixtures/client_get_primary_contact.json

@@ -0,0 +1,3 @@
+{
+    "EmailAddress": "person@blackhole.com"
+}

data/test/fixtures/client_set_primary_contact.json

@@ -0,0 +1,3 @@
+{
+    "EmailAddress": "person@blackhole.com"
+}

data/test/fixtures/people.json

@@ -0,0 +1,14 @@
+[
+  {
+    "EmailAddress": "person1@blackhole.com",
+    "Name": "Person One",
+    "Status": "Active",
+    "AccessLevel": 31
+  },
+  {
+    "EmailAddress": "person2@blackhole.com",
+    "Name": "Person Two",
+    "Status": "Active",
+    "AccessLevel": 0
+  }
+]

data/test/fixtures/person_details.json

@@ -0,0 +1,6 @@
+{
+    "EmailAddress": "person@example.com",
+    "Name": "Person One",
+    "AccessLevel": 1023,
+    "Status": "Active"
+}

data/test/person_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/helper'
+
+class PersonTest < Test::Unit::TestCase
+  context "when an api caller is authenticated" do
+    setup do
+      @api_key = '123123123123123123123'
+      CreateSend.api_key @api_key
+      @client_id = "d98h2938d9283d982u3d98u88"
+      @person = CreateSend::Person.new @client_id, "person@example.com"
+    end
+    
+    should "get a person by client id and email address" do
+      email = "person@example.com"
+      stub_get(@api_key, "clients/#{@client_id}/people.json?email=#{CGI.escape(email)}", "person_details.json")      
+      person = CreateSend::Person.get @client_id, email
+      person.EmailAddress.should == email
+      person.Name.should == "Person One"
+      person.AccessLevel.should == 1023
+      person.Status.should == "Active"
+    end
+
+    should "add a person" do
+      stub_post(@api_key, "clients/#{@client_id}/people.json", "add_person.json")
+      result = CreateSend::Person.add @client_id, "person@example.com", "Person", 0, "Password"
+      result.EmailAddress.should == "person@example.com"
+    end
+
+    should "update a person" do
+      email = "person@example.com"
+      new_email = "new_email_address@example.com"
+      stub_put(@api_key, "clients/#{@client_id}/people.json?email=#{CGI.escape(email)}", nil)
+      @person.update new_email, "Person", 1023, "NewPassword"
+      @person.email_address.should == new_email
+    end
+      
+    should "delete a person" do
+      stub_delete(@api_key, "clients/#{@person.client_id}/people.json?email=#{CGI.escape(@person.email_address)}", nil)
+      @person.delete
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: createsend
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Dennes
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-04 00:00:00 Z
+date: 2012-07-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -119,18 +119,27 @@ files:
 - Rakefile
 - createsend.gemspec
 - lib/createsend.rb
+- lib/createsend/administrator.rb
 - lib/createsend/campaign.rb
 - lib/createsend/client.rb
 - lib/createsend/list.rb
+- lib/createsend/person.rb
 - lib/createsend/segment.rb
 - lib/createsend/subscriber.rb
 - lib/createsend/template.rb
 - lib/createsend/version.rb
+- test/administrator_test.rb
 - test/campaign_test.rb
 - test/client_test.rb
 - test/createsend_test.rb
 - test/fixtures/active_subscribers.json
+- test/fixtures/add_admin.json
+- test/fixtures/add_person.json
 - test/fixtures/add_subscriber.json
+- test/fixtures/admin_details.json
+- test/fixtures/admin_get_primary_contact.json
+- test/fixtures/admin_set_primary_contact.json
+- test/fixtures/administrators.json
 - test/fixtures/apikey.json
 - test/fixtures/bounced_subscribers.json
 - test/fixtures/campaign_bounces.json
@@ -142,6 +151,8 @@ files:
 - test/fixtures/campaign_unsubscribes.json
 - test/fixtures/campaigns.json
 - test/fixtures/client_details.json
+- test/fixtures/client_get_primary_contact.json
+- test/fixtures/client_set_primary_contact.json
 - test/fixtures/clients.json
 - test/fixtures/countries.json
 - test/fixtures/create_campaign.json
@@ -161,6 +172,8 @@ files:
 - test/fixtures/list_stats.json
 - test/fixtures/list_webhooks.json
 - test/fixtures/lists.json
+- test/fixtures/people.json
+- test/fixtures/person_details.json
 - test/fixtures/scheduled_campaigns.json
 - test/fixtures/segment_details.json
 - test/fixtures/segment_subscribers.json
@@ -175,6 +188,7 @@ files:
 - test/fixtures/unsubscribed_subscribers.json
 - test/helper.rb
 - test/list_test.rb
+- test/person_test.rb
 - test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb
@@ -206,11 +220,18 @@ signing_key:
 specification_version: 3
 summary: A library which implements the complete functionality of v3 of the createsend API.
 test_files: 
+- test/administrator_test.rb
 - test/campaign_test.rb
 - test/client_test.rb
 - test/createsend_test.rb
 - test/fixtures/active_subscribers.json
+- test/fixtures/add_admin.json
+- test/fixtures/add_person.json
 - test/fixtures/add_subscriber.json
+- test/fixtures/admin_details.json
+- test/fixtures/admin_get_primary_contact.json
+- test/fixtures/admin_set_primary_contact.json
+- test/fixtures/administrators.json
 - test/fixtures/apikey.json
 - test/fixtures/bounced_subscribers.json
 - test/fixtures/campaign_bounces.json
@@ -222,6 +243,8 @@ test_files:
 - test/fixtures/campaign_unsubscribes.json
 - test/fixtures/campaigns.json
 - test/fixtures/client_details.json
+- test/fixtures/client_get_primary_contact.json
+- test/fixtures/client_set_primary_contact.json
 - test/fixtures/clients.json
 - test/fixtures/countries.json
 - test/fixtures/create_campaign.json
@@ -241,6 +264,8 @@ test_files:
 - test/fixtures/list_stats.json
 - test/fixtures/list_webhooks.json
 - test/fixtures/lists.json
+- test/fixtures/people.json
+- test/fixtures/person_details.json
 - test/fixtures/scheduled_campaigns.json
 - test/fixtures/segment_details.json
 - test/fixtures/segment_subscribers.json
@@ -255,6 +280,7 @@ test_files:
 - test/fixtures/unsubscribed_subscribers.json
 - test/helper.rb
 - test/list_test.rb
+- test/person_test.rb
 - test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb