createsend-sendowlfork 6.1.0.pre.hashie5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca60d5afa58a830b8adf97896ae64dba5bc8e97551b977739462c25720e3af33
+  data.tar.gz: 36b122611ce877ae30bec07846450a19279a3a5c713a7e1a0c32f9d8db360bdf
+SHA512:
+  metadata.gz: 845fdca84b22acaa047655d30730da0ed53bef30368b98a85c0fcb22661c8acb9d48f5c51ecc7193651fe6689bdf9a485d4d24d6565001120f587b2849d4cdf3
+  data.tar.gz: b7ea9e44cb6d65a3ddf4457a15d983bc97a4e81807edcae329c617dfaee4ead5ab99306b946e5830517cd17911b1b81f0d8b5e1cd842b7dea7e5f560346c7277

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3
+  - 2.2
+  - 2.1
+  - 2.0.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.
+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`.
+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

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/HISTORY.md

@@ -0,0 +1,299 @@
+# createsend-ruby history
+
+## v6.1.0 - 27 Oct 2023
+* Added support for add/update subscribers specifying mobile_number and/or consent_to_send_sms (optional parameters)
+  * Subscriber.Add 
+  * Subscriber.Update()
+* Added support for lists endpoints to be able to return the ConsentToSendSms (keyword parameter, is optional)
+  * List.Active(include_sms_preference:true)
+  * List.Bounced(include_sms_preference:true)
+  * List.Unsubscribed(include_sms_preference:true)
+  * List.Unconfirmed(include_sms_preference:true)
+  * List.Deleted(include_sms_preference:true)
+* Clean-up various warnings associated with this package (excluding dependency package warning)
+* Add more samples
+
+## v6.0.0 - 10 Feb, 2022
+* Upgrades to Createsend API v3.3 which includes new breaking changes
+* Breaking: 'client.campaigns' now returned an object to support pagination (use .Results to ge the array of campaigns)
+* Added 'Tags' as another field that is returned in 'client.scheduled', 'client.drafts' and 'client.campaigns'
+* Added 'Name' as another field that is returned in 'campaign.summary'
+* Add new support for 'client.tags' endpoint (ie: getting list of tags for the client)
+* Add support for pagination, filtering and sorting to 'client.campaigns' endpoint
+* Bump `rake` to `~> 12.3.3`
+* Adding support for returning ListJoinedDate for each subscriber. 
+  * List.Active()
+  * List.Bounced()
+  * List.Unsubscribed()
+  * List.Unconfirmed()
+  * List.Deleted()
+  * Segment.Subscribers()
+  * Subscriber.Get()
+
+## v5.1.1 - 8 Oct, 2021
+* increased default timeout for HTTP requests to 120secs
+
+## v5.1.0 - 3 Sep, 2019
+* Added support for [Journeys API](https://www.campaignmonitor.com/api/journeys/)
+
+## v5.0.0 - 19 Jun, 2018
+* Upgrades to Createsend API v3.2 which includes new breaking changes
+* Breaking: 'Consent to track' field is now mandatory for sending smart and classic transactionl emails
+* Breaking: 'Consent to track' field is now mandatory when adding or updating subscribers
+* Optional 'Include tracking preference' field when retrieving lists of subscribers
+
+## v4.1.2 - 27 Nov, 2017
+* Fix for the GZip compression issue: https://github.com/jnunemaker/httparty/issues/562
+
+## v4.1.1 - 14 Jan, 2016
+
+* Drop support for Ruby 1.9.3 ([#49](https://github.com/campaignmonitor/createsend-ruby/pull/49))
+* Allow JSON 2 to be used ([#48](https://github.com/campaignmonitor/createsend-ruby/pull/48) and  [#50](https://github.com/campaignmonitor/createsend-ruby/pull/50))
+* Bump `httparty` to `~> 0.14` ([#50](https://github.com/campaignmonitor/createsend-ruby/pull/50))
+
+## v4.1.0 - 4 Aug, 2015
+
+* Added support for Transactional Email
+
+## v4.0.2 - 15 Oct, 2014
+
+* Bumped and simplified `hashie` dependency to `~> 3.0`
+
+## v4.0.1 - 3 May, 2014
+
+* This is a patch release which only changes development dependencies.
+* Removed development dependency on `shoulda` and added more suitable dependency on `shoulda-context` instead.
+
+## 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.
+
+## 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.
+
+## v3.1.1 - 10 Apr, 2013
+
+* Fixed a bug occurring sometimes when refreshing OAuth access tokens, because of a URL encoding issue.
+
+## v3.1.0 - 28 Mar, 2013
+
+* Added `CreateSend::CreateSend.refresh_access_token` to allow easier refreshing of access tokens when using class methods.
+
+    So you can now refresh an access token using _any_ refresh token like so:
+
+    ```ruby
+    access_token, expires_in, refresh_token =
+      CreateSend::CreateSend.refresh_access_token 'refresh token'
+    ```
+
+    Or, you can refresh the _current_ access token (with your current refresh token) like so:
+
+    ```ruby
+    cs = CreateSend::CreateSend.new :access_token => 'access token',
+      :refresh_token => 'refresh token'
+    access_token, expires_in, refresh_token = cs.refresh_token
+    ```
+
+* Added `CreateSend::InvalidOAuthToken` and `CreateSend::RevokedOAuthToken` exceptions to make handling of OAuth exceptions in user code easier.
+
+## v3.0.0 - 25 Mar, 2013
+
+* Added support for authenticating using OAuth. See the [README](README.md#authenticating) for full usage instructions.
+* Refactored authentication so that it is _always_ done at the instance level. This introduces some breaking changes, which are clearly explained below.
+  * Authentication is now _always_ done at the instance level.
+
+      So when you _previously_ would have authenticated using an API key as follows:
+
+      ```ruby
+      CreateSend.api_key "your api key"
+      cs = CreateSend::CreateSend.new
+      cs.clients
+      ```
+
+      If you want to authenticate using an API key, you should _now_ do this:
+
+      ```ruby
+      auth = {:api_key => "your api key"}
+      cs = CreateSend::CreateSend.new auth
+      cs.clients
+      ```
+
+  * Instances of `CreateSend::CreateSend` (and all subclasses) are now _always_ created by passing an `auth` hash as the first argument.
+
+      So for example, when you _previously_ would have called `CreateSend::Client.new` like so:
+
+      ```ruby
+      CreateSend.api_key "your api key"
+      cl = CreateSend::Client.new "your client id"
+      ```
+
+      You _now_ call `CreateSend::Client.new` like so:
+
+      ```ruby
+      auth = {:api_key => "your api key"}
+      cl = CreateSend::Client.new auth, "your client id"
+      ```
+
+  * Any of the class methods on `CreateSend::CreateSend` (and all subclasses) are now _always_ called by passing an `auth` hash as the first argument.
+
+      So for example, when you _previously_ would have called `CreateSend::Subscriber.add` like so:
+
+      ```ruby
+      CreateSend.api_key "your api key"
+      sub = CreateSend::Subscriber.add "list id", "dave@example.com", "Dave", [], true
+      ```
+
+      You _now_ call `CreateSend::Subscriber.add` like so:
+
+      ```ruby
+      auth = {:api_key => "your api key"}
+      sub = CreateSend::Subscriber.add auth, "list id", "dave@example.com", "Dave", [], true
+      ```
+
+## v2.5.1 - 4 Feb, 2013
+
+* Updated dependencies in gemspec. Removed cane as a development dependency.
+
+## v2.5.0 - 11 Dec, 2012
+
+* Added support for including from name, from email, and reply to email in drafts, scheduled, and sent campaigns.
+* Added support for campaign text version urls.
+* Added support for transferring credits to/from a client.
+* Added support for getting account billing details as well as client credits.
+* Made all date fields optional when getting paged results.
+
+## v2.4.0 - 5 Nov, 2012
+
+* Added CreateSend::Campaign#email_client_usage.
+* Added support for ReadsEmailWith field on subscriber objects.
+* Added support for retrieving unconfirmed subscribers for a list.
+* Added support for suppressing email addresses.
+* Added support for retrieving spam complaints for a campaign, as well as
+adding SpamComplaints field to campaign summary output.
+* Added VisibleInPreferenceCenter field to custom field output.
+* Added support for setting preference center visibility when creating custom
+fields.
+* Added the ability to update a custom field name and preference visibility.
+* Added documentation explaining that text_url may now be nil or an empty
+string when creating a campaign.
+
+## v2.3.0 - 10 Oct, 2012
+
+* Added support for creating campaigns from templates.
+* Added support for unsuppressing an email address.
+* Improved documentation and tests for getting active subscribers. Clearly
+documented the data structure for multi option multi select fields.
+
+## v2.2.0 - 17 Sep, 2012
+
+* Added WorldviewURL field to campaign summary response.
+* Added Latitude, Longitude, City, Region, CountryCode, and CountryName fields
+to campaign opens and clicks response.
+
+## v2.1.0 - 30 Aug, 2012
+
+* Added support for basic / unlimited pricing.
+
+## v2.0.0 - 22 Aug, 2012
+
+* Added support for UnsubscribeSetting field when creating, updating and
+getting list details.
+* Added support for including AddUnsubscribesToSuppList and
+ScrubActiveWithSuppList fields when updating a list.
+* Added support for getting all client lists to which a subscriber with a
+specific email address belongs.
+* Removed deprecated warnings and disallowed calls to be made in a deprecated
+manner.
+
+## v1.1.1 - 24 Jul, 2012
+
+* Added support for specifying whether subscription-based autoresponders
+should be restarted when adding or updating subscribers.
+
+## v1.1.0 - 11 Jul, 2012
+
+* Added support for newly released team management functionality.
+
+## v1.0.4 - 4 May, 2012
+
+* Added Travis CI support.
+* Added Gemnasium support.
+* Fixes to usage of Shoulda and Hashie libraries.
+
+## v1.0.3 - 3 Dec, 2011
+
+* Fixes to support Ruby 1.9.* (both the library as well as the rake tasks).
+* Fixed the User-Agent header so that it now uses the correct module VERSION.
+
+## v1.0.2 - 31 Oct, 2011
+
+* Added support for deleting a subscriber.
+* Added support for specifying a 'clear' field when updating or importing
+subscribers.
+* Added support for queuing subscription-based autoresponders when importing
+subscribers.
+* Added support for retrieving deleted subscribers.
+* Added support for including more social sharing stats in campaign summary.
+* Added support for unscheduling a campaign.
+
+## v1.0.1 - 25 Oct, 2011
+
+* Remove CreateSendOptions and remove usage of yaml config file.
+
+## v1.0.0 - 26 Sep, 2011
+
+* Initial release which supports current Campaign Monitor API.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2015 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,220 @@
+# createsend [![Build Status](https://app.travis-ci.com/campaignmonitor/createsend-ruby.svg?branch=master)](https://app.travis-ci.com/campaignmonitor/createsend-ruby)
+
+A Ruby library which implements the complete functionality of the [Campaign Monitor API](http://www.campaignmonitor.com/api/). Requires Ruby >= 2.0.0.
+
+## Quick start
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem 'createsend'
+```
+
+Or, install the gem:
+
+```
+gem install createsend
+```
+
+## Authenticating
+
+The Campaign Monitor API supports authentication using either OAuth or an API key.
+
+### Using OAuth
+
+If you're developing a Rails or Rack based application, we recommend using [omniauth-createsend](https://github.com/jdennes/omniauth-createsend) to authenticate with the Campaign Monitor API. You might find this [example application](https://github.com/jdennes/createsendoauthtest) helpful.
+
+If you don't use [omniauth-createsend](https://github.com/jdennes/omniauth-createsend), you'll need to get access tokens for your users by following the instructions included in the Campaign Monitor API [documentation](http://www.campaignmonitor.com/api/getting-started/#authenticating_with_oauth). This gem provides functionality to help you do this, as described below. There's also another [example application](https://gist.github.com/jdennes/4945412) you may wish to reference, which doesn't depend on any OAuth libraries.
+
+#### Redirecting to the authorization URL
+
+The first thing your application should do is redirect your user to the Campaign Monitor authorization URL where they will have the opportunity to approve your application to access their Campaign Monitor account. You can get this authorization URL by using `CreateSend::CreateSend.authorize_url`, like so:
+
+```ruby
+require 'createsend'
+
+authorize_url = CreateSend::CreateSend.authorize_url(
+  'Client ID for your application',
+  'Redirect URI for your application',
+  'The permission level your application requires',
+  'Optional state data to be included'
+)
+# Redirect your users to authorize_url.
+```
+
+#### Exchanging an OAuth code for an access token
+
+If your user approves your application, they will then be redirected to the `redirect_uri` you specified, which will include a `code` parameter, and optionally a `state` parameter in the query string. Your application should implement a handler which can exchange the code passed to it for an access token, using `CreateSend::CreateSend.exchange_token` like so:
+
+```ruby
+require 'createsend'
+
+access_token, expires_in, refresh_token = CreateSend::CreateSend.exchange_token(
+  'Client ID for your application',
+  'Client Secret for your application',
+  'Redirect URI for your application',
+  'A unique code for your user' # Get the code parameter from the query string
+)
+# Save access_token, expires_in, and refresh_token.
+```
+
+At this point you have an access token and refresh token for your user which you should store somewhere convenient so that your application can look up these values when your user wants to make future Campaign Monitor API calls.
+
+#### Making API calls using an access token
+
+Once you have an access token and refresh token for your user, you can use the `createsend` gem to authenticate and make further API calls like so:
+
+```ruby
+require 'createsend'
+
+auth = {
+  :access_token => 'your access token',
+  :refresh_token => 'your refresh token'
+}
+cs = CreateSend::CreateSend.new auth
+clients = cs.clients
+```
+
+#### Refreshing access tokens
+
+All OAuth access tokens have an expiry time, and can be renewed with a refresh token. If your access token expires when attempting to make an API call, the `CreateSend::ExpiredOAuthToken` exception will be raised, so your code should handle this. You can handle this using either `CreateSend::CreateSend.refresh_access_token` (when calling class methods) or `CreateSend::CreateSend#refresh_token` (when calling instance methods).
+
+Here's an example of using `CreateSend::CreateSend#refresh_token` to refresh your current access token when calling `CreateSend::CreateSend#clients`:
+
+```ruby
+require 'createsend'
+
+auth = {
+  :access_token => 'your access token',
+  :refresh_token => 'your refresh token'
+}
+cs = CreateSend::CreateSend.new auth
+
+begin
+  tries ||= 2
+  clients = cs.clients
+  rescue CreateSend::ExpiredOAuthToken => eot
+    access_token, expires_in, refresh_token = cs.refresh_token
+    # Here you should save your updated access token, 'expire in' value,
+    # and refresh token. `cs` will automatically have the new access token
+    # set, so there is no need to set it again.
+    retry unless (tries -= 1).zero?
+    p "Error: #{eot}"
+  rescue Exception => e
+    p "Error: #{e}"
+end
+```
+
+In addition to raising `CreateSend::ExpiredOAuthToken` when an access token has expired, this library also raises `CreateSend::InvalidOAuthToken` if an invalid access token is used, and raises `CreateSend::RevokedOAuthToken` if a user has revoked the access token being used. This makes it easier for you to handle these cases in your code.
+
+### Using an API key
+
+```ruby
+require 'createsend'
+
+cs = CreateSend::CreateSend.new :api_key => 'your api key'
+clients = cs.clients
+```
+
+## Basic usage
+This example of listing all your clients and their campaigns demonstrates basic usage of the library and the data returned from the API:
+
+```ruby
+require 'createsend'
+
+auth = {
+  :access_token => 'your access token',
+  :refresh_token => 'your refresh token'
+}
+cs = CreateSend::CreateSend.new auth
+
+clients = cs.clients
+clients.each do |cl|
+  p "Client: #{cl.Name}"
+  client = CreateSend::Client.new auth, cl.ClientID
+  p "- Campaigns:"
+  client.drafts.each do |cm|
+    p "  - #{cm.Subject}"
+  end
+end
+```
+
+Running this example will result in something like:
+
+```
+Client: First Client
+- Campaigns:
+  - Newsletter Number One
+  - Newsletter Number Two
+Client: Second Client
+- Campaigns:
+  - News for January 2013
+```
+
+## Handling errors
+If the Campaign Monitor API returns an error, an exception will be raised. For example, if you attempt to create a campaign and enter empty values for subject and other required fields:
+
+```ruby
+require 'createsend'
+
+auth = {
+  :access_token => 'your access token',
+  :refresh_token => 'your refresh token'
+}
+
+begin
+  id = CreateSend::Campaign.create auth, "4a397ccaaa55eb4e6aa1221e1e2d7122",
+    "", "", "", "", "", "", "", [], []
+  p "New campaign ID: #{id}"
+  rescue CreateSend::BadRequest => br
+    p "Bad request error: #{br}"
+    p "Error Code:    #{br.data.Code}"
+    p "Error Message: #{br.data.Message}"
+  rescue Exception => e
+    p "Error: #{e}"
+end
+```
+
+Running this example will result in:
+
+```
+Bad request error: The CreateSend API responded with the following error - 304: Campaign Subject Required
+Error Code:    304
+Error Message: Campaign Subject Required
+```
+
+## Expected input and output
+
+The best way of finding out the expected input and output of a particular method in a particular class is to use the unit tests as a reference.
+
+For example, if you wanted to find out how to call the `CreateSend::Subscriber.add` method, you would look at the file [test/subscriber_test.rb](https://github.com/campaignmonitor/createsend-ruby/blob/master/test/subscriber_test.rb)
+
+```ruby
+should "add a subscriber with custom fields" do
+  stub_post(@auth, "subscribers/#{@list_id}.json", "add_subscriber.json")
+  custom_fields = [ { :Key => 'website', :Value => 'http://example.com/' } ]
+  email_address = CreateSend::Subscriber.add @auth, @list_id, "subscriber@example.com", "Subscriber", custom_fields, true, "Yes"
+  email_address.should be == "subscriber@example.com"
+end
+```
+
+## Documentation
+
+Ruby documentation is available at [RubyDoc.info](http://rubydoc.info/gems/createsend/frames).
+
+## 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.
+
+## This stuff should be green
+
+[![Build Status](https://app.travis-ci.com/campaignmonitor/createsend-ruby.svg?branch=master)](https://app.travis-ci.com/campaignmonitor/createsend-ruby) [![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]
+
+[travis]: http://travis-ci.org/campaignmonitor/createsend-ruby
+[coveralls]: https://coveralls.io/r/campaignmonitor/createsend-ruby
+[gemnasium]: https://gemnasium.com/campaignmonitor/createsend-ruby
+[gembadge]: http://badge.fury.io/rb/createsend

data/RELEASE.md

@@ -0,0 +1,53 @@
+# 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.
+- 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://app.travis-ci.com/github/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
+
+```
+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/Rakefile

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "bundler/version"
+require "rake/testtask"
+require "./lib/createsend"
+
+desc "Run tests"
+Rake::TestTask.new(:test) do |test|
+  test.ruby_opts = ["-rrubygems"] if defined? Gem
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  puts "running tests."
+end
+
+desc "Build the gem"
+task :build do
+  system "gem build createsend.gemspec"
+end
+
+desc "Build and release the gem"
+task :release => :build do
+  system "gem push createsend-#{CreateSend::VERSION}.gem"
+end
+
+task :default => :test