createsend 3.2.0 → 3.3.0

data/.travis.yml

@@ -3,5 +3,11 @@ rvm:
   - 2.0.0
   - 1.9.3
   - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
   - 1.8.7
   - ree

data/CONTRIBUTING.md

@@ -3,6 +3,6 @@
 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`.
+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`.
 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.2.0)
+    createsend (3.3.0)
       hashie (>= 1.2, < 3)
       httparty (~> 0.10)
       json
@@ -22,8 +22,8 @@ GEM
       simplecov (>= 0.7)
       thor
     fakeweb (1.3.0)
-    hashie (2.0.3)
-    httparty (0.10.2)
+    hashie (2.0.4)
+    httparty (0.11.0)
       multi_json (~> 1.0)
       multi_xml (>= 0.5.2)
     i18n (0.6.1)

data/HISTORY.md

@@ -1,5 +1,16 @@
 # createsend-ruby history
 
+## v3.3.0 - 16 May, 2013
+
+* Added Ruby version and platform details to default user agent string.
+* Added support for setting a custom user agent string.
+
+  You can set a custom user agent string to be used for API calls by doing the following:
+
+  ```ruby
+  CreateSend::CreateSend.user_agent "custom user agent"
+  ```
+
 ## 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.

data/README.md

@@ -210,3 +210,7 @@ Full documentation is hosted by [RubyDoc.info](http://rubydoc.info/gems/createse
 ## Contributing
 
 Please check the [guidelines for contributing](https://github.com/campaignmonitor/createsend-ruby/blob/master/CONTRIBUTING.md) to this repository.
+
+## Releasing
+
+Please check the [instructions for releasing](https://github.com/campaignmonitor/createsend-ruby/blob/master/RELEASE.md) the `createsend` gem.

data/RELEASE.md

@@ -0,0 +1,57 @@
+# Releasing createsend-ruby
+
+## Requirements
+
+- You must have a [RubyGems.org](https://rubygems.org/) account and must be an owner of the [createsend](https://rubygems.org/gems/createsend) gem.
+
+  Owners can be added to the `createsend` gem like this:
+
+  ```
+  gem owner createsend -a newowner@example.com
+  ```
+
+## Prepare the release
+
+- 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:
+
+  ```
+  git commit -am "Version X.Y.Z"
+  ```
+
+- Tag the new version:
+
+  ```
+  git tag -a vX.Y.Z -m "Version X.Y.Z"
+  ```
+
+- Push your changes to GitHub, including the tag you just created:
+
+  ```
+  git push origin master --tags
+  ```
+
+- 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.
+
+## Build the gem
+
+```
+rake build
+```
+
+This builds the gem locally to a file named something like `createsend-X.Y.Z.gem`. You're now ready to release the gem.
+
+## Release the gem
+
+```
+rake release
+```
+
+This publishes the gem to [RubyGems.org](https://rubygems.org/gems/createsend). You should see the newly published version of the gem there. All done!

data/createsend.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   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://campaignmonitor.github.com/createsend-ruby/"
+  s.homepage = "http://campaignmonitor.github.io/createsend-ruby/"
   s.require_paths = ["lib"]
   s.summary = %q{A library which implements the complete functionality of the Campaign Monitor API.}
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/createsend/createsend.rb

@@ -6,6 +6,8 @@ require 'json'
 
 module CreateSend
 
+  USER_AGENT_STRING = "createsend-ruby-#{VERSION}-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM}"
+
   # Represents a CreateSend API error. Contains specific data about the error.
   class CreateSendError < StandardError
     attr_reader :data
@@ -44,6 +46,16 @@ module CreateSend
     include HTTParty
     attr_reader :auth_details
 
+    # Set a custom user agent string to be used when instances of
+    # CreateSend::CreateSend make API calls.
+    #
+    # user_agent - The user agent string to use in the User-Agent header when
+    #              instances of this class make API calls. If set to nil, the
+    #              default value of CreateSend::USER_AGENT_STRING will be used.
+    def self.user_agent(user_agent)
+      headers({'User-Agent' => user_agent || USER_AGENT_STRING})
+    end
+
     # Get the authorization URL for your application, given the application's
     # client_id, redirect_uri, scope, and optional state data.
     def self.authorize_url(client_id, redirect_uri, scope, state=nil)
@@ -98,7 +110,7 @@ module CreateSend
     @@oauth_base_uri = "https://api.createsend.com/oauth"
     @@oauth_token_uri = "#{@@oauth_base_uri}/token"
     headers({
-      'User-Agent' => "createsend-ruby-#{VERSION}",
+      'User-Agent' => USER_AGENT_STRING,
       'Content-Type' => 'application/json; charset=utf-8',
       'Accept-Encoding' => 'gzip, deflate' })
     base_uri @@base_uri

data/lib/createsend/version.rb

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

data/test/createsend_test.rb

@@ -197,14 +197,23 @@ class CreateSendTest < Test::Unit::TestCase
       @cs = CreateSend::CreateSend.new @auth
     end
 
-    should "include the CreateSend module VERSION constant as part of the user agent when making a call" do
-      # This test is done to ensure that the version from HTTParty isn't included instead
-      assert CreateSend::CreateSend.headers["User-Agent"] == "createsend-ruby-#{CreateSend::VERSION}"
+    should "include the correct user agent string when making a call" do
+      CreateSend::CreateSend.headers["User-Agent"].should ==
+        "createsend-ruby-#{CreateSend::VERSION}-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM}"
       stub_get(@auth, "clients.json", "clients.json")
       clients = @cs.clients
       clients.size.should == 2
     end
 
+    should "allow a custom user agent string to be set when making a call" do
+      CreateSend::CreateSend.user_agent "custom user agent"
+      CreateSend::CreateSend.headers["User-Agent"].should == "custom user agent"
+      stub_get(@auth, "clients.json", "clients.json")
+      clients = @cs.clients
+      clients.size.should == 2
+      CreateSend::CreateSend.user_agent nil
+    end
+
     should "get all clients" do
       stub_get(@auth, "clients.json", "clients.json")
       clients = @cs.clients

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -177,6 +177,7 @@ files:
 - HISTORY.md
 - LICENSE
 - README.md
+- RELEASE.md
 - Rakefile
 - createsend.gemspec
 - lib/createsend.rb
@@ -269,7 +270,7 @@ files:
 - test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb
-homepage: http://campaignmonitor.github.com/createsend-ruby/
+homepage: http://campaignmonitor.github.io/createsend-ruby/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -374,3 +375,4 @@ test_files:
 - test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb
+has_rdoc: