createsend 3.4.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 926050427071f8eb42ba429844c13ead89fb2d28
-  data.tar.gz: 372eab0ffce313a08dc718ec3f5f5f04578dedab
+  metadata.gz: da211cead45e0ca1c6b083f7b53c535212885abe
+  data.tar.gz: b27340d9c34db21fc2cf3aa12886c482854b75f7
 SHA512:
-  metadata.gz: 67b44541f73648f0b80ddfc4980ccb520cdb9b94f13ee6f7a81729171eef73979f829495ce54c3d1aadc8710580d61b6fded6cda331521995dbce594a66e85e8
-  data.tar.gz: cea89d6dc9058a3d64c56547fb2d253b73e141a3e5e75425d5e684f2a0a86f0bdc4b901dba1bc2efc24f584b6c59f8e0e556853709805172b84ee7bd2cbf566a
+  metadata.gz: d0d99c593cd1beb56782bca4664d51ad8794ef4445e4953a47f200977d8ce186b64ec63e4616b7a22fb18fd394e4e1a73c52ed9ef88801db32468df5602ca8a5
+  data.tar.gz: 84c93a100fcb6fff17e48d6fe00ccd332252dd4f8f54467452b1b7a20ddb4324b51902878b3c59840f08446cf3fe79377434931ff1a64856f728fbc4763ab00f

data/.gitignore

@@ -1,7 +1,9 @@
 .DS_Store
+.bundle
 coverage
 rdoc
 pkg
 *.gem
 example.rb
 .idea/
+Gemfile.lock

data/.travis.yml

@@ -1,12 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
-  - 1.9.2
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - jruby-head
-  - 1.8.7
-  - ree

data/CONTRIBUTING.md

@@ -1,8 +1,8 @@
 # Guidelines for contributing
 
 1. [Fork the repository](https://help.github.com/articles/fork-a-repo).
-2. [Create a topic branch](http://learn.github.com/p/branching.html).
+2. Create a topic branch.
 3. Make your changes, including tests for your changes which maintain [coverage](https://coveralls.io/r/campaignmonitor/createsend-ruby).
-4. Ensure that all tests pass, by running `bundle exec rake`. The [Travis CI build](https://travis-ci.org/campaignmonitor/createsend-ruby) runs on Ruby `2.0.0`, `1.9.3`, `1.9.2`, `jruby-18mode`, `jruby-19mode`, `rbx-18mode`, `rbx-19mode`, `ruby-head`, `jruby-head`, `1.8.7`, and `ree`.
+4. Ensure that all tests pass, by running `bundle exec rake`.
 5. It should go without saying, but do not increment the version number in your commits.
 6. [Submit a pull request](https://help.github.com/articles/using-pull-requests).

data/HISTORY.md

@@ -1,5 +1,47 @@
 # createsend-ruby history
 
+## v4.0.0 - 19 Feb, 2014
+
+* Removed `CreateSend::CreateSend#apikey` to promote using OAuth rather than basic auth with an API key.
+* Started using the `https://api.createsend.com/api/v3.1/` API endpoint.
+* Added support for new segments structure.
+  * Create and Update calls now require the new `rule_groups` structure, instead of a `rules` structure.
+
+    ```ruby
+    CreateSend::Segment.create(auth, list_id, title, rule_groups)
+    CreateSend::Segment.update(title, rule_groups)
+    ```
+
+    So for example, when you _previously_ would have created an argument like so:
+
+    ```ruby
+    rules = [ { :Subject => "EmailAddress", :Clauses => [ "CONTAINS example.com" ] } ]
+    ```
+
+    You would _now_ do this:
+
+    ```ruby
+    rule_groups = [ { :Rules => [ { :RuleType => "EmailAddress", :Clause => "CONTAINS example.com" } ] } ]
+    ```
+    
+  * The Add Rule call is now Add Rule Group, taking a collection of rules in a single `rule_group` argument instead of separate `subject` & `clauses` arguments.
+
+    ```ruby
+    CreateSend::Segment.add_rule_group(rule_group)
+    ```
+
+    So for example, when you _previously_ would have added a rule like so:
+
+    ```ruby
+    @segment.add_rule "EmailAddress", [ "CONTAINS example.com" ]
+    ```
+
+    You would _now_ do this:
+
+    ```ruby
+    @segment.add_rule_group [ { :RuleType => "EmailAddress", :Clause => "CONTAINS @hello.com" } ]
+    ```
+
 ## v3.4.0 - 5 Jul, 2013
 
 * Added support for validating SSL certificates to avoid man-in-the-middle attacks.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2013 James Dennes
+Copyright (c) 2010-2014 James Dennes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/RELEASE.md

@@ -14,12 +14,6 @@
 
 - Increment the `VERSION` constant in the `lib/createsend/version.rb` file, ensuring that you use [Semantic Versioning](http://semver.org/).
 - Add an entry to `HISTORY.md` which clearly explains the new release.
-- Ensure that the `Gemfile.lock` file is updated correctly by running:
-
-  ```
-  bundle install
-  ```
-
 - Commit your changes:
 
   ```
@@ -40,6 +34,8 @@
 
 - Ensure that all [tests](https://travis-ci.org/campaignmonitor/createsend-ruby) pass, and that [coverage](https://coveralls.io/r/campaignmonitor/createsend-ruby) is maintained or improved.
 
+- Add a new [GitHub Release](https://github.com/campaignmonitor/createsend-ruby/releases) using the newly created tag.
+
 ## Build the gem
 
 ```

data/createsend.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |s|
   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=
+  s.licenses = ['MIT']
 end

data/lib/createsend/campaign.rb

@@ -84,7 +84,7 @@ module CreateSend
         :PreviewRecipients => recipients.kind_of?(String) ?
           [ recipients ] : recipients,
         :Personalize => personalize }.to_json }
-      response = post "sendpreview", options
+      post "sendpreview", options
     end
 
     # Sends this campaign.
@@ -92,18 +92,18 @@ module CreateSend
       options = { :body => {
         :ConfirmationEmail => confirmation_email,
         :SendDate => send_date }.to_json }
-      response = post "send", options
+      post "send", options
     end
 
     # Unschedules this campaign if it is currently scheduled.
     def unschedule
       options = { :body => "" }
-      response = post "unschedule", options
+      post "unschedule", options
     end
 
     # Deletes this campaign.
     def delete
-      response = super "/campaigns/#{campaign_id}.json", {}
+      super "/campaigns/#{campaign_id}.json", {}
     end
 
     # Gets a summary of this campaign

data/lib/createsend/client.rb

@@ -97,14 +97,14 @@ module CreateSend
       options = { :body => {
         :EmailAddresses => emails.kind_of?(String) ?
           [ emails ] : emails }.to_json }
-      response = post "suppress", options
+      post "suppress", options
     end
 
     # Unsuppresses an email address by removing it from the the client's
     # suppression list
     def unsuppress(email)
       options = { :query => { :email => email }, :body => '' }
-      response = put "unsuppress", options
+      put "unsuppress", options
     end
 
     # Gets the templates belonging to this client.

data/lib/createsend/createsend.rb

@@ -109,7 +109,7 @@ module CreateSend
       end
     end
 
-    @@base_uri = "https://api.createsend.com/api/v3"
+    @@base_uri = "https://api.createsend.com/api/v3.1"
     @@oauth_base_uri = "https://api.createsend.com/oauth"
     @@oauth_token_uri = "#{@@oauth_base_uri}/token"
     headers({
@@ -139,16 +139,6 @@ module CreateSend
       [access_token, expires_in, refresh_token]
     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)
-      options = {:basic_auth => {:username => username, :password => password}}
-      response = get("/apikey.json?SiteUrl=#{site_url}", options)
-      result = Hashie::Mash.new(response)
-      auth({:api_key => result.ApiKey}) if not @auth_details
-      result
-    end
-
     # Gets your clients.
     def clients
       response = get('/clients.json')

data/lib/createsend/list.rb

@@ -36,7 +36,7 @@ module CreateSend
 
     # Deletes this list.
     def delete
-      response = super "/lists/#{list_id}.json", {}
+      super "/lists/#{list_id}.json", {}
     end
 
     # Creates a new custom field for this list.
@@ -77,8 +77,7 @@ module CreateSend
     # Deletes a custom field associated with this list.
     def delete_custom_field(custom_field_key)
       custom_field_key = CGI.escape(custom_field_key)
-      response = cs_delete(
-        "/lists/#{list_id}/customfields/#{custom_field_key}.json", {})
+      cs_delete("/lists/#{list_id}/customfields/#{custom_field_key}.json", {})
     end
 
     # Updates the options of a multi-optioned custom field on this list.
@@ -88,7 +87,7 @@ module CreateSend
       options = { :body => {
         :Options => new_options,
         :KeepExistingOptions => keep_existing_options }.to_json }
-      response = put "customfields/#{custom_field_key}/options", options
+      put "customfields/#{custom_field_key}/options", options
     end
 
     # Gets the details of this list.
@@ -178,7 +177,7 @@ module CreateSend
         :UnsubscribeSetting => unsubscribe_setting,
         :AddUnsubscribesToSuppList => add_unsubscribes_to_supp_list,
         :ScrubActiveWithSuppList => scrub_active_with_supp_list }.to_json }
-      response = cs_put "/lists/#{list_id}.json", options
+      cs_put "/lists/#{list_id}.json", options
     end
 
     # Gets the webhooks for this list.
@@ -202,26 +201,25 @@ module CreateSend
     # 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"
+      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 = cs_delete(
-        "/lists/#{list_id}/webhooks/#{webhook_id}.json", {})
+      cs_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
+      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
+      put "webhooks/#{webhook_id}/deactivate", options
     end
 
     private

data/lib/createsend/segment.rb

@@ -9,29 +9,28 @@ module CreateSend
     end
 
     # Creates a new segment.
-    def self.create(auth, list_id, title, rules)
+    def self.create(auth, list_id, title, rule_groups)
       options = { :body => {
         :Title => title,
-        :Rules => rules }.to_json }
+        :RuleGroups => rule_groups }.to_json }
       cs = CreateSend.new auth
       response = cs.post "/segments/#{list_id}.json", options
       response.parsed_response
     end
 
     # Updates this segment.
-    def update(title, rules)
+    def update(title, rule_groups)
       options = { :body => {
         :Title => title,
-        :Rules => rules }.to_json }
-      response = cs_put "/segments/#{segment_id}.json", options
+        :RuleGroups => rule_groups }.to_json }
+      cs_put "/segments/#{segment_id}.json", options
     end
 
     # Adds a rule to this segment.
-    def add_rule(subject, clauses)
+    def add_rule_group(rule_group)
       options = { :body => {
-        :Subject => subject,
-        :Clauses => clauses }.to_json }
-      response = post "rules", options
+        :Rules => rule_group }.to_json }
+      post "rules", options
     end
 
     # Gets the active subscribers in this segment.
@@ -55,12 +54,12 @@ module CreateSend
 
     # Clears all rules of this segment.
     def clear_rules
-      response = cs_delete "/segments/#{segment_id}/rules.json", {}
+      cs_delete "/segments/#{segment_id}/rules.json", {}
     end
 
     # Deletes this segment.
     def delete
-      response = super "/segments/#{segment_id}.json", {}
+      super "/segments/#{segment_id}.json", {}
     end
 
     private

data/lib/createsend/template.rb

@@ -31,12 +31,12 @@ module CreateSend
         :Name => name,
         :HtmlPageURL => html_url,
         :ZipFileURL => zip_url }.to_json }
-      response = put "/templates/#{template_id}.json", options
+      put "/templates/#{template_id}.json", options
     end
 
     # Deletes this email template.
     def delete
-      response = super "/templates/#{template_id}.json", {}
+      super "/templates/#{template_id}.json", {}
     end
   end
 end

data/lib/createsend/version.rb

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

data/test/createsend_test.rb

@@ -100,19 +100,6 @@ class CreateSendTest < Test::Unit::TestCase
       FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=#{CGI.escape(refresh_token)}"
     end
 
-    should "get a person's api key" do
-      base_uri = "https://api.createsend.com/api/v3"
-      uri = URI.parse(base_uri)
-      site_url = "http://iamadesigner.createsend.com/"
-      username = "myusername"
-      password = "mypassword"
-      cs = CreateSend::CreateSend.new
-      stub_get(nil, "https://#{username}:#{password}@#{uri.host}#{uri.path}/apikey.json?SiteUrl=#{CGI.escape(site_url)}", "apikey.json")
-      apikey = cs.apikey(site_url, username, password).ApiKey
-      apikey.should == "981298u298ue98u219e8u2e98u2"
-      cs.auth_details.should == {:api_key => apikey}
-    end
-
   end
 
   context "when an api caller is authenticated using oauth" do

data/test/fixtures/segment_details.json

@@ -1,16 +1,20 @@
 {
   "ActiveSubscribers": 0,
-  "Rules": [
+  "RuleGroups": [
     {
-      "Subject": "EmailAddress",
-      "Clauses": [
-        "CONTAINS @hello.com"
+      "Rules": [
+        {
+          "RuleType": "EmailAddress",
+          "Clause": "CONTAINS @hello.com"
+        }
       ]
     },
     {
-      "Subject": "Name",
-      "Clauses": [
-        "PROVIDED"
+      "Rules": [
+        {
+          "RuleType": "Name",
+          "Clause": "PROVIDED"
+        }
       ]
     }
   ],

data/test/helper.rb

@@ -30,7 +30,7 @@ def createsend_url(auth, url)
   if not url =~ /^http/
     auth_section = ''
     auth_section = "#{auth[:api_key]}:x@" if auth and auth.has_key? :api_key
-    result = "https://#{auth_section}api.createsend.com/api/v3/#{url}"
+    result = "https://#{auth_section}api.createsend.com/api/v3.1/#{url}"
   else
     result = url
   end

data/test/segment_test.rb

@@ -8,22 +8,22 @@ class SegmentTest < Test::Unit::TestCase
 
     should "create a new segment" do
       list_id = "2983492834987394879837498"
-      rules = [ { :Subject => "EmailAddress", :Clauses => [ "CONTAINS example.com" ] } ]
+      rule_groups = [ { :Rules => [ { :RuleType => "EmailAddress", :Clause => "CONTAINS example.com" } ] } ]
       stub_post(@auth, "segments/#{list_id}.json", "create_segment.json")
-      res = CreateSend::Segment.create @auth, list_id, "new segment title", rules
+      res = CreateSend::Segment.create @auth, list_id, "new segment title", rule_groups
       res.should == "0246c2aea610a3545d9780bf6ab89006"
     end
 
     should "update a segment" do
-      rules = [ { :Subject => "Name", :Clauses => [ "EQUALS subscriber" ] } ]
+      rules = [ { :Rules => [ { :RuleType => "Name", :Clause => "PROVIDED" } ] } ]
       stub_put(@auth, "segments/#{@segment.segment_id}.json", nil)
       @segment.update "new title for segment", rules
     end
 
-    should "add a rule to a segment" do
-      clauses = [ "CONTAINS example.com" ]
+    should "add a rule group to a segment" do
+      rule_group = [ { :RuleType => "EmailAddress", :Clause => "CONTAINS @hello.com" } ]
       stub_post(@auth, "segments/#{@segment.segment_id}/rules.json", nil)
-      @segment.add_rule "EmailAddress", clauses
+      @segment.add_rule_group rule_group
     end
 
     should "get the active subscribers for a particular segment in the list" do
@@ -55,10 +55,10 @@ class SegmentTest < Test::Unit::TestCase
       stub_get(@auth, "segments/#{@segment.segment_id}.json", "segment_details.json")
       res = @segment.details
       res.ActiveSubscribers.should == 0
-      res.Rules.size.should == 2
-      res.Rules.first.Subject.should == "EmailAddress"
-      res.Rules.first.Clauses.size.should == 1
-      res.Rules.first.Clauses.first.should == "CONTAINS @hello.com"
+      res.RuleGroups.size.should == 2
+      res.RuleGroups.first.Rules.size.should == 1
+      res.RuleGroups.first.Rules.first.RuleType.should == "EmailAddress"
+      res.RuleGroups.first.Rules.first.Clause.should == "CONTAINS @hello.com"
       res.ListID.should == "2bea949d0bf96148c3e6a209d2e82060"
       res.SegmentID.should == "dba84a225d5ce3d19105d7257baac46f"
       res.Title.should == "My Segment"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - James Dennes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-06 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -154,7 +154,6 @@ files:
 - .travis.yml
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - HISTORY.md
 - LICENSE
 - README.md
@@ -185,7 +184,6 @@ files:
 - test/fixtures/admin_get_primary_contact.json
 - test/fixtures/admin_set_primary_contact.json
 - test/fixtures/administrators.json
-- test/fixtures/apikey.json
 - test/fixtures/billingdetails.json
 - test/fixtures/bounced_subscribers.json
 - test/fixtures/campaign_bounces.json
@@ -253,7 +251,8 @@ files:
 - test/subscriber_test.rb
 - test/template_test.rb
 homepage: http://campaignmonitor.github.io/createsend-ruby/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -271,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A library which implements the complete functionality of the Campaign Monitor
@@ -289,7 +288,6 @@ test_files:
 - test/fixtures/admin_get_primary_contact.json
 - test/fixtures/admin_set_primary_contact.json
 - test/fixtures/administrators.json
-- test/fixtures/apikey.json
 - test/fixtures/billingdetails.json
 - test/fixtures/bounced_subscribers.json
 - test/fixtures/campaign_bounces.json

data/Gemfile.lock

@@ -1,64 +0,0 @@
-PATH
-  remote: .
-  specs:
-    createsend (3.4.0)
-      hashie (>= 1.2, < 3)
-      httparty (~> 0.10)
-      json
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.2.11)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    bourne (1.1.2)
-      mocha (= 0.10.5)
-    colorize (0.5.8)
-    coveralls (0.6.3)
-      colorize
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      thor
-    fakeweb (1.3.0)
-    hashie (2.0.4)
-    httparty (0.11.0)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    i18n (0.6.1)
-    jnunemaker-matchy (0.4.0)
-    json (1.7.7)
-    metaclass (0.0.1)
-    mime-types (1.21)
-    mocha (0.10.5)
-      metaclass (~> 0.0.1)
-    multi_json (1.5.0)
-    multi_xml (0.5.3)
-    rake (10.0.3)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    shoulda (3.3.2)
-      shoulda-context (~> 1.0.1)
-      shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.2)
-    shoulda-matchers (1.4.2)
-      activesupport (>= 3.0.0)
-      bourne (~> 1.1.2)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    thor (0.18.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  coveralls
-  createsend!
-  fakeweb (~> 1.3)
-  jnunemaker-matchy (~> 0.4)
-  rake (~> 10.0)
-  shoulda (~> 3.3)
-  simplecov

data/test/fixtures/apikey.json

@@ -1,3 +0,0 @@
-{
-  "ApiKey": "981298u298ue98u219e8u2e98u2"
-}