createsend 3.1.1 → 3.2.0

data/CONTRIBUTING.md

@@ -0,0 +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).
+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`, `1.8.7`, and `ree`.
+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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    createsend (3.1.1)
+    createsend (3.2.0)
       hashie (>= 1.2, < 3)
       httparty (~> 0.10)
       json

data/HISTORY.md

@@ -1,5 +1,9 @@
 # createsend-ruby history
 
+## v3.2.0 - 15 Apr, 2013
+
+* Added support for [single sign on](http://www.campaignmonitor.com/api/account/#single_sign_on) which allows initiation of external login sessions to Campaign Monitor.
+
 ## v3.1.1 - 10 Apr, 2013
 
 * Fixed a bug occurring sometimes when refreshing OAuth access tokens, because of a URL encoding issue.

data/README.md

@@ -1,7 +1,7 @@
 # createsend
 [![Build Status](https://secure.travis-ci.org/campaignmonitor/createsend-ruby.png)][travis] [![Coverage Status](https://coveralls.io/repos/campaignmonitor/createsend-ruby/badge.png?branch=master)][coveralls] [![Dependency Status](https://gemnasium.com/campaignmonitor/createsend-ruby.png)][gemnasium] [![Gem Version](https://badge.fury.io/rb/createsend.png)][gembadge]
 
-A ruby library which implements the complete functionality of the [Campaign Monitor API](http://www.campaignmonitor.com/api/).
+A Ruby library which implements the complete functionality of the [Campaign Monitor API](http://www.campaignmonitor.com/api/).
 
 [travis]: http://travis-ci.org/campaignmonitor/createsend-ruby
 [coveralls]: https://coveralls.io/r/campaignmonitor/createsend-ruby
@@ -208,8 +208,5 @@ end
 Full documentation is hosted by [RubyDoc.info](http://rubydoc.info/gems/createsend/frames).
 
 ## Contributing
-1. Fork the repository
-2. Make your changes, including tests for your changes which maintain [coverage][coveralls].
-3. Ensure that the build passes, by running `bundle exec rake` (CI runs on: `2.0.0`, `1.9.3`, `1.9.2`, `1.8.7`, and `ree`)
-4. It should go without saying, but do not increment the version number in your commits.
-5. Submit a pull request.
+
+Please check the [guidelines for contributing](https://github.com/campaignmonitor/createsend-ruby/blob/master/CONTRIBUTING.md) to this repository.

data/lib/createsend/createsend.rb

@@ -183,6 +183,33 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Get a URL which initiates a new external session for the user with the
+    # given email.
+    # Full details: http://www.campaignmonitor.com/api/account/#single_sign_on
+    #
+    # email         - The email address of the Campaign Monitor user for whom
+    #                 the login session should be created.
+    # chrome        - Which 'chrome' to display - Must be either "all",
+    #                 "tabs", or "none".
+    # url           - The URL to display once logged in. e.g. "/subscribers/"
+    # integrator_id - The integrator ID. You need to contact Campaign Monitor
+    #                 support to get an integrator ID.
+    # client_id     - The Client ID of the client which should be active once
+    #                 logged in to the Campaign Monitor account.
+    #
+    # Returns An object containing a single field SessionUrl which represents
+    # the URL to initiate the external Campaign Monitor session.
+    def external_session_url(email, chrome, url, integrator_id, client_id)
+      options = { :body => {
+        :Email => email,
+        :Chrome => chrome,
+        :Url => url,
+        :IntegratorID => integrator_id,
+        :ClientID => client_id }.to_json }
+      response = put("/externalsession.json", options)
+      Hashie::Mash.new(response)
+    end
+
     def get(*args)
       args = add_auth_details_to_options(args)
       handle_response CreateSend.get(*args)

data/lib/createsend/version.rb

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

data/test/createsend_test.rb

@@ -261,6 +261,17 @@ class CreateSendTest < Test::Unit::TestCase
       result.EmailAddress.should == 'admin@blackhole.com'
     end
 
+    should "get an external session url" do
+      email = "exammple@example.com"
+      chrome = "None"
+      url = "/subscribers"
+      integrator_id = "qw989q8wud98qwyd"
+      client_id = "9q8uw9d8u9wud"
+      stub_put(@auth, "externalsession.json", "external_session.json")
+      result = @cs.external_session_url email, chrome, url, integrator_id, client_id
+      result.SessionUrl.should == "https://external1.createsend.com/cd/create/ABCDEF12/DEADBEEF?url=FEEDDAD1"
+    end
+
   end
 
   context "when the CreateSend API responds with an error" do

data/test/fixtures/external_session.json

@@ -0,0 +1,3 @@
+{
+  "SessionUrl": "https://external1.createsend.com/cd/create/ABCDEF12/DEADBEEF?url=FEEDDAD1"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -171,6 +171,7 @@ files:
 - .coveralls.yml
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - HISTORY.md
@@ -231,6 +232,7 @@ files:
 - test/fixtures/drafts.json
 - test/fixtures/email_client_usage.json
 - test/fixtures/expired_oauth_token_api_error.json
+- test/fixtures/external_session.json
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/invalid_oauth_token_api_error.json
@@ -335,6 +337,7 @@ test_files:
 - test/fixtures/drafts.json
 - test/fixtures/email_client_usage.json
 - test/fixtures/expired_oauth_token_api_error.json
+- test/fixtures/external_session.json
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/invalid_oauth_token_api_error.json