mailchimp3 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ed47a5c9aa596d1bd8ab0960067fecd28276112
-  data.tar.gz: c4106451d50a559f56e15b552d76e26cfbabfb93
+  metadata.gz: 86cbb578a02bfc1b1f33bf8a3394f5a4d324adb8
+  data.tar.gz: 41a06107a92fce74c0a282972fc9994acd6d7ec5
 SHA512:
-  metadata.gz: c58c68f2c6b1fcff8db1f90bf260ecf565ed74384053635353470f9512a6eb1591d186a35b186e72cb968ae98c2b6ff535a1e7de37aa29ba6a88d5e9d7974f81
-  data.tar.gz: 1a4a7c917560dba01b9e71a39f5570dc432af9a0589c0641c4ada87dc726d4fc23e233b802f24d663617df721ac12902856b3ff144653907652ea2f9bd651e39
+  metadata.gz: 2f88cecce1c849cfdcb88a77dd4a8b73a4effbd1b0539e7f979d1d2db4d06871c4914de90e058d261860972246efadde5e667d5ee09f3f05cb51b40eb4577cb4
+  data.tar.gz: 40cbb2dcf74b50a58a6faf091904fa24d37c0eeb25a42a1997bff0738d90f592638bfbbd7fb805723b6f62290290c881f8cb4222ab2799ab0595cf20acbd19f8

data/README.md

@@ -3,12 +3,17 @@
 [![Circle CI](https://circleci.com/gh/seven1m/mailchimp3/tree/master.svg?style=svg)](https://circleci.com/gh/seven1m/mailchimp3/tree/master)
 
 `mailchimp3` is a Rubygem that provides a very thin, simple wrapper around the MailChimp RESTful JSON API version 3.0
-documented at [kb.mailchimp.com/api](http://kb.mailchimp.com/api/).
+documented at [kb.mailchimp.com/api](http://kb.mailchimp.com/api/). (The wrapper also works with the 2.0 API if you
+just use the `post` method. See 2.0 section later in this document.)
+
+This wrapper is very low-level -- you'll still be dealing with individual GET, POST, PATCH, and DELETE requests, but the gem
+handles the OAuth2 flow (getting a token), passing the auth token in every request, and raises descriptive errors you can easily rescue
+in your own code.
 
 ## Installation
 
 ```
-gem install mailchimp3 (eventually)
+gem install mailchimp3
 ```
 
 ## Usage with HTTP Basic Auth
@@ -225,17 +230,17 @@ api.lists['abc123'].members['cde345'].delete
 
 The following errors may be raised by the library, depending on the API response status code.
 
-| HTTP Status Codes   | Error Class                                                                   |
-| ------------------- | ----------------------------------------------------------------------------- |
-| 400                 | `MailChimp3::Errors::BadRequest` < `MailChimp3::Errors::ClientError`          |
-| 401                 | `MailChimp3::Errors::Unauthorized` < `MailChimp3::Errors::ClientError`        |
-| 403                 | `MailChimp3::Errors::Forbidden` < `MailChimp3::Errors::ClientError`           |
-| 404                 | `MailChimp3::Errors::NotFound` < `MailChimp3::Errors::ClientError`            |
-| 405                 | `MailChimp3::Errors::MethodNotAllowed` < `MailChimp3::Errors::ClientError`    |
-| 422                 | `MailChimp3::Errors::UnprocessableEntity` < `MailChimp3::Errors::ClientError` |
-| other 4xx errors    | `MailChimp3::Errors::ClientError`                                             |
-| 500                 | `MailChimp3::Errors::InternalServerError` < `MailChimp3::Errors::ServerError` |
-| other 5xx errors    | `MailChimp3::Errors::ServerError`                                             |
+| HTTP Status Codes   | Specific Error Class                      | Generic Error Class               |
+| ------------------- | ----------------------------------------- | --------------------------------- |
+| 400                 | `MailChimp3::Errors::BadRequest`          | `MailChimp3::Errors::ClientError` |
+| 401                 | `MailChimp3::Errors::Unauthorized`        | `MailChimp3::Errors::ClientError` |
+| 403                 | `MailChimp3::Errors::Forbidden`           | `MailChimp3::Errors::ClientError` |
+| 404                 | `MailChimp3::Errors::NotFound`            | `MailChimp3::Errors::ClientError` |
+| 405                 | `MailChimp3::Errors::MethodNotAllowed`    | `MailChimp3::Errors::ClientError` |
+| 422                 | `MailChimp3::Errors::UnprocessableEntity` | `MailChimp3::Errors::ClientError` |
+| other 4xx errors    | `MailChimp3::Errors::ClientError`         |                                   |
+| 500                 | `MailChimp3::Errors::InternalServerError` | `MailChimp3::Errors::ServerError` |
+| other 5xx errors    | `MailChimp3::Errors::ServerError`         |                                   |
 
 The exception object has the following methods:
 
@@ -268,6 +273,21 @@ The `message` should be a simple string given by the API, e.g. "Resource Not Fou
 Alternatively, you may rescue `MailChimp3::Errors::BaseError` and branch your code based on
 the status code returned by calling `error.status`.
 
+## MailChimp 2.0 API
+
+This wrapper works with MailChimp's soon-to-be-deprecated 2.0 API. You need only use the `v2` path and the `post` method
+for all your calls, like so:
+
+```ruby
+api.v2.lists['member-activity'].post(id: 'abc123', emails: [{email: 'tim@timmorgan.org'}])
+```
+
+Some notes:
+
+1. Call `v2` to switch to the 2.0 API, then add other path elements after that.
+2. Any path element with a hyphen will need to use the array access syntax, e.g. `lists['member-activity']` not `lists.member-activity`.
+3. You must use the `post` method for every call.
+
 ## Copyright & License
 
 Copyright 2015, Tim Morgan. Licensed MIT.

data/lib/mailchimp3/endpoint.rb

@@ -5,12 +5,13 @@ module MailChimp3
   class Endpoint
     attr_reader :url, :last_result
 
-    def initialize(oauth_access_token: nil, basic_auth_key: nil, dc: nil, url: nil)
+    def initialize(oauth_access_token: nil, basic_auth_key: nil, dc: nil, url: nil, version: 3)
       @oauth_access_token = oauth_access_token
       @basic_auth_key = basic_auth_key
       @dc = dc
       @dc ||= @basic_auth_key.split('-').last if @basic_auth_key
       @url = url || _build_url
+      @version = version
       fail Errors::DataCenterRequiredError, 'You must pass dc.' unless @dc || @url
       @cache = {}
     end
@@ -30,6 +31,7 @@ module MailChimp3
 
     def post(body = {})
       @last_result = _connection.post(@url) do |req|
+        body[:apikey] = @oauth_access_token || @basic_auth_key if @version == 2
         req.body = body.to_json
       end
       _build_response(@last_result)
@@ -51,6 +53,15 @@ module MailChimp3
       end
     end
 
+    def v2
+      self.class.new(
+        url: _build_v2_url,
+        basic_auth_key: @basic_auth_key,
+        oauth_access_token: @oauth_access_token,
+        version: 2
+      )
+    end
+
     private
 
     def _build_response(result)
@@ -86,15 +97,18 @@ module MailChimp3
         self.class.new(
           url: File.join(url, path.to_s),
           basic_auth_key: @basic_auth_key,
-          oauth_access_token: @oauth_access_token
+          oauth_access_token: @oauth_access_token,
+          version: @version
         )
       end
     end
 
     def _build_url
-      url = "https://#{@dc}.api.mailchimp.com/3.0"
-      url << '/' if url =~ /3\.0\z/ # workaround for the api requiring a slash on the root urls
-      url
+      "https://#{@dc}.api.mailchimp.com/3.0/"
+    end
+
+    def _build_v2_url
+      "https://#{@dc}.api.mailchimp.com/2.0/"
     end
 
     def _connection

data/lib/mailchimp3/errors.rb

@@ -8,7 +8,9 @@ module MailChimp3
 
       def initialize(response)
         @status = response.status
-        @message = if response.body.is_a?(Hash)
+        @message = if response.body.is_a?(Hash) && response.body['error']
+                     "#{response.body['name']}: #{response.body['error']}"
+                   elsif response.body.is_a?(Hash)
                      "#{response.body['title']}: #{response.body['detail']}"
                    else
                      response.body.to_s

data/lib/mailchimp3/version.rb

@@ -1,3 +1,3 @@
 module MailChimp3
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailchimp3
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday