mailchimp3 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564fb3786d7423ea5a754d20a27ebf36fd74d2632dccad2a44519f244f9d9659
-  data.tar.gz: b5c95259d49bcc670e4f8056dd6e095dafa2fb6a65760f379907fef9d0d1f0eb
+  metadata.gz: f1cc50c5f6d8d2898fe0bf2a0f862fc88c3cdb07cfde3b7e09f8027cd7be7ef2
+  data.tar.gz: b9544cac7e434bdec8b7c50ec7e6343fefb03dcc2c45b379b6c11d9803d2c3fb
 SHA512:
-  metadata.gz: f651eb58e4dd3400ed26a7e5f961e2bfd099b3a169df6cfa35ac5c2f2f812c25d7d8abe4d4ebacab64437882264a9fe8d1e26d395e6c43cbcd12fa77a82dedc4
-  data.tar.gz: 2682cad9d1731968fc2c889454f0c9bb2f8f55212be1e795f227b910ca1c849ab72462f8ca00c6a37e8a618d81212dccd35f744cba273c133a904b2fcbee5a04
+  metadata.gz: 53d816a6bb62f88d0f4e6700d6a7952c781ebdd09af0aa439cc0e0f199e4109c54588ba1bde5e4976d2c3f9c7938205715bd016dd5f44405be8f3c006f44272f
+  data.tar.gz: eddcf4862840096d46f5cc49e2cd14ce87eb0a8282e6bcdafdf243a67c372ac7eab94aaf294ac3485e35fcbfc3239b1c5bcb6fc06376212f5bbfb83828a5d9c2

data/README.md

@@ -1,10 +1,9 @@
 # MailChimp3
 
-[![Circle CI](https://circleci.com/gh/seven1m/mailchimp3/tree/master.svg?style=svg)](https://circleci.com/gh/seven1m/mailchimp3/tree/master)
+[![CircleCI](https://circleci.com/gh/planningcenter/mailchimp3/tree/master.svg?style=svg)](https://circleci.com/gh/planningcenter/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/). (The wrapper also works with the 2.0 API if you
-just use the `post` method. See 2.0 section later in this document.)
+`mailchimp3` is a Rubygem that provides a very thin, simple wrapper around the MailChimp RESTful JSON "Marketing" API version 3
+documented at [mailchimp.com/developer/marketing/api](https://mailchimp.com/developer/marketing/api/).
 
 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
@@ -185,7 +184,18 @@ api.lists.post(
 }
 ```
 
-## get()
+## method_missing(endpoint_name)
+
+Anything you append to the end gets handled by `method_missing` and returns a new Endpoint object.
+This is what allows this gem work with any endpoint without the library code needing to be updated.
+
+## \[](endpoint_name_or_id)
+
+Similar to the `method_missing` above, `endpoint['whatever']` and `endpoint[123]` are handled dynamically,
+which allows you to build endpoints containing numbers, hyphens, or other characters not allowed by a
+Ruby method name.
+
+## get(params = {})
 
 `get()` works for a collection (index) and a single resource (show).
 
@@ -199,7 +209,9 @@ api.lists['abc123'].members['cde345'].get
 # => resource_hash
 ```
 
-## post()
+If the endpoint accepts parameters, you can pass them in the `params` hash.
+
+## post(body = {})
 
 `post()` sends a POST request to create a new resource.
 
@@ -208,7 +220,9 @@ api.lists['abc123'].members.post(...)
 # => resource_hash
 ```
 
-## patch()
+The parameter given is sent as the body of the request. See [Example](#example) above.
+
+## patch(body = {})
 
 `patch()` sends a PATCH request to update an existing resource.
 
@@ -217,6 +231,8 @@ api.lists['abc123'].members['cde345'].patch(...)
 # => resource_hash
 ```
 
+The parameter given is sent as the body of the request. See [Example](#example) above.
+
 ## delete()
 
 `delete()` sends a DELETE request to delete an existing resource. This method returns `true` if the delete was successful.
@@ -273,21 +289,6 @@ 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.
+Copyright 2021, Planning Center. Licensed MIT.

data/lib/mailchimp3/endpoint.rb

@@ -16,12 +16,12 @@ module MailChimp3
       @cache = {}
     end
 
-    def method_missing(method_name, *_args)
-      _build_endpoint(method_name.to_s)
+    def method_missing(endpoint_name, *_args)
+      _build_endpoint(endpoint_name.to_s)
     end
 
-    def [](id)
-      _build_endpoint(id.to_s)
+    def [](endpoint_name_or_id)
+      _build_endpoint(endpoint_name_or_id.to_s)
     end
 
     def get(params = {})
@@ -81,23 +81,23 @@ module MailChimp3
       when 200..299
         body
       when 400
-        fail Errors::BadRequest, status: status, body: body
+        fail Errors::BadRequest.new(status: status, body: body)
       when 401
-        fail Errors::Unauthorized, status: status, body: body
+        fail Errors::Unauthorized.new(status: status, body: body)
       when 403
-        fail Errors::Forbidden, status: status, body: body
+        fail Errors::Forbidden.new(status: status, body: body)
       when 404
-        fail Errors::NotFound, status: status, body: body
+        fail Errors::NotFound.new(status: status, body: body)
       when 405
-        fail Errors::MethodNotAllowed, status: status, body: body
+        fail Errors::MethodNotAllowed.new(status: status, body: body)
       when 422
-        fail Errors::UnprocessableEntity, status: status, body: body
+        fail Errors::UnprocessableEntity.new(status: status, body: body)
       when 400..499
-        fail Errors::ClientError, status: status, body: body
+        fail Errors::ClientError.new(status: status, body: body)
       when 500
-        fail Errors::InternalServerError, status: status, body: body
+        fail Errors::InternalServerError.new(status: status, body: body)
       when 500..599
-        fail Errors::ServerError, status: status, body: body
+        fail Errors::ServerError.new(status: status, body: body)
       else
         fail "unknown status #{status}"
       end
@@ -106,7 +106,7 @@ module MailChimp3
     def _parse_body(result)
       JSON.parse(result.body)
     rescue JSON::ParserError
-      raise Errors::ServerError, status: result.status, body: result.body
+      raise Errors::ServerError.new(status: result.status, body: result.body)
     end
 
     def _build_endpoint(path)

data/lib/mailchimp3/version.rb

@@ -1,3 +1,3 @@
 module MailChimp3
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

data/lib/mailchimp3.rb

@@ -5,8 +5,8 @@ require_relative 'mailchimp3/errors'
 module MailChimp3
   module_function
 
-  def new(*args)
-    Endpoint.new(*args)
+  def new(**kwargs)
+    Endpoint.new(**kwargs)
   end
 
   def config

data/spec/mailchimp3_spec.rb

@@ -1,6 +1,12 @@
 require_relative 'spec_helper'
 
 describe MailChimp3 do
+  describe '#new' do
+    it 'smoke test' do
+      expect(subject.new(basic_auth_key: 'key-us2').url).not_to be_nil
+    end
+  end
+
   describe '#config' do
     it 'returns configuration object' do
       subject.config.client_id = 'foo'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailchimp3
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Tim Morgan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -117,7 +117,7 @@ homepage: https://github.com/seven1m/mailchimp3
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,12 +132,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.2
+signing_key:
 specification_version: 4
 summary: wrapper for MailChimp's 3.0 API
 test_files:
-- spec/spec_helper.rb
-- spec/mailchimp3_spec.rb
 - spec/mailchimp3/endpoint_spec.rb
 - spec/mailchimp3/oauth_spec.rb
+- spec/mailchimp3_spec.rb
+- spec/spec_helper.rb