createsend 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    createsend (0.1.0)
+      hashie (~> 0.4.0)
+      httparty (~> 0.6.1)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    fakeweb (1.3.0)
+    hashie (0.4.0)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    jnunemaker-matchy (0.4.0)
+    json (1.4.6)
+    mocha (0.9.10)
+      rake
+    rake (0.8.7)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  createsend!
+  fakeweb (~> 1.3)
+  hashie (~> 0.4.0)
+  httparty (~> 0.6.1)
+  jnunemaker-matchy (~> 0.4.0)
+  json
+  mocha (~> 0.9)
+  shoulda (~> 2.11)

data/createsend.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
   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('json')
   s.add_runtime_dependency('hashie', '~> 0.4.0')
   s.add_runtime_dependency('httparty', '~> 0.6.1')
   s.name = "createsend"

data/lib/createsend.rb

@@ -43,7 +43,7 @@ class Unavailable < StandardError; end
 class CreateSend
   include HTTParty
 
-  VER = "0.1.0" unless defined?(CreateSend::VER)
+  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'

data/lib/list.rb

@@ -120,6 +120,51 @@ class List
     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 = {})

data/test/fixtures/create_list_webhook.json

@@ -0,0 +1 @@
+"6a783d359bd44ef62c6ca0d3eda4412a"

data/test/fixtures/list_webhooks.json

@@ -0,0 +1,21 @@
+[
+  {
+    "WebhookID": "943678317049bc13",
+    "Events": [
+      "Bounce",
+      "Spam"
+    ],
+    "Url": "http://www.postbin.org/d9w8ud9wud9w",
+    "Status": "Active",
+    "PayloadFormat": "Json"
+  },
+  {
+    "WebhookID": "ee1b3864e5ca6161",
+    "Events": [
+      "Subscribe"
+    ],
+    "Url": "http://www.postbin.org/hiuhiu2h2u",
+    "Status": "Active",
+    "PayloadFormat": "Xml"
+  }
+]

data/test/list_test.rb

@@ -143,5 +143,47 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.CustomFields.size.should == 0
     end
 
+    should "get the webhooks for a list" do
+      stub_get(@api_key, "lists/#{@list.list_id}/webhooks.json", "list_webhooks.json")
+      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.Url.should == "http://www.postbin.org/d9w8ud9wud9w"
+      hooks.first.Status.should == "Active"
+      hooks.first.PayloadFormat.should == "Json"
+    end
+
+    should "create a webhook for a list" do
+      stub_post(@api_key, "lists/#{@list.list_id}/webhooks.json", "create_list_webhook.json")
+      webhook_id = @list.create_webhook ["Unsubscribe", "Spam"], "http://example.com/unsub", "json"
+      webhook_id.should == "6a783d359bd44ef62c6ca0d3eda4412a"
+    end
+    
+    should "test a webhook for a list" do
+      webhook_id = "jiuweoiwueoiwueowiueo"
+      stub_get(@api_key, "lists/#{@list.list_id}/webhooks/#{webhook_id}/test.json", nil)
+      @list.test_webhook webhook_id
+    end
+
+    should "delete a webhook for a list" do
+      webhook_id = "jiuweoiwueoiwueowiueo"
+      stub_delete(@api_key, "lists/#{@list.list_id}/webhooks/#{webhook_id}.json", nil)
+      @list.delete_webhook webhook_id
+    end
+    
+    should "activate a webhook for a list" do
+      webhook_id = "jiuweoiwueoiwueowiueo"
+      stub_put(@api_key, "lists/#{@list.list_id}/webhooks/#{webhook_id}/activate.json", nil)
+      @list.activate_webhook webhook_id
+    end
+
+    should "de-activate a webhook for a list" do
+      webhook_id = "jiuweoiwueoiwueowiueo"
+      stub_put(@api_key, "lists/#{@list.list_id}/webhooks/#{webhook_id}/deactivate.json", nil)
+      @list.deactivate_webhook webhook_id
+    end
+
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: createsend
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - James Dennes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-25 00:00:00 +11:00
+date: 2010-12-15 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,6 +81,20 @@ dependencies:
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  name: json
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -94,9 +108,9 @@ dependencies:
   type: :runtime
   prerelease: false
   name: hashie
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -110,7 +124,7 @@ dependencies:
   type: :runtime
   prerelease: false
   name: httparty
-  version_requirements: *id006
+  version_requirements: *id007
 description: A library which implements the complete functionality of v3 of the createsend API.
 email: 
 - jdennes@gmail.com
@@ -123,6 +137,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -157,6 +172,7 @@ files:
 - test/fixtures/create_client.json
 - test/fixtures/create_custom_field.json
 - test/fixtures/create_list.json
+- test/fixtures/create_list_webhook.json
 - test/fixtures/create_segment.json
 - test/fixtures/create_template.json
 - test/fixtures/custom_api_error.json
@@ -166,6 +182,7 @@ files:
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/list_details.json
 - test/fixtures/list_stats.json
+- test/fixtures/list_webhooks.json
 - test/fixtures/lists.json
 - test/fixtures/segment_details.json
 - test/fixtures/segment_subscribers.json
@@ -242,6 +259,7 @@ test_files:
 - test/fixtures/create_client.json
 - test/fixtures/create_custom_field.json
 - test/fixtures/create_list.json
+- test/fixtures/create_list_webhook.json
 - test/fixtures/create_segment.json
 - test/fixtures/create_template.json
 - test/fixtures/custom_api_error.json
@@ -251,6 +269,7 @@ test_files:
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/list_details.json
 - test/fixtures/list_stats.json
+- test/fixtures/list_webhooks.json
 - test/fixtures/lists.json
 - test/fixtures/segment_details.json
 - test/fixtures/segment_subscribers.json