trycourier 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40ffa9399327479e0f0fa89c350decd17f242caa48b91f1a772cebd4f25d5610
-  data.tar.gz: fd159122320af8ab96223890b78061dd21ce193adadceb146f7e18d36a798032
+  metadata.gz: 71daf0eb0e891e05d2a2f76461586d5af3fbd029d1c813c6df8dc41015329370
+  data.tar.gz: 54826227d59241eb5c0c4e382b9bdab12ce135eaaa4b5b7d17c2ba0bdc871f33
 SHA512:
-  metadata.gz: 524f60d42ec87e581ce591d7550f34ab0a5c592d33618465eba1d26a25822b8c8d3974ad188ef5cc089d24947424ffebe434655e64481b81fed244b95fd22fbf
-  data.tar.gz: bb97291b655840c5051b78beb48d345827be048392e16c7b7486749eac80e45f111cedc216448d8a93997eaae2f57c90c089c7ff1abbc00ad66aa9930bba9212
+  metadata.gz: 20f4fdbc92da8822a01110a7480113ef09fd1e76b2d1ee4045aadebf617930c1eba2a9756e785764b9a4487ff2df8b23fb09d393b27b07e3f4d1d5e1e6a921f2
+  data.tar.gz: 0e6f85140f74677ffbe309ecebc0194974ee4c7e97959fc9a94bb5ea838a27d75e780c5028de9dc43e9b3f8caee9ddae9ffaa9b500b2f37391485afe75fb1460

data/CHANGELOG.md

@@ -5,8 +5,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v1.2.0] - 2021-04-08
+
+### Added
+
+- Support for [Automation API](https://docs.courier.com/reference/automation-api) by @tk26
+  - `POST /automations/invoke` with `client.automations.invoke` method
+  - `POST /automations/{template_id}/invoke` with `client.automations.invoke_template` method
+
 ## [v1.1.0] - 2021-01-26
+
 ### Added
+
 - Support for Basic Auth
   - ENV variables `COURIER_AUTH_USERNAME` and `COURIER_AUTH_PASSWORD` OR set with params
 - Token Auth using ENV variables
@@ -14,6 +24,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Base URL parameter (with default of api.courier.com)
   - ENV variable `COURIER_BASE_URL`
 - Support for Lists API by @jrweingart
+
   - `POST /send/list` with `client.lists.send` method
   - `GET /lists` with `client.lists.list` method
   - `GET /lists/{list_id}` with `client.lists.get` method
@@ -26,6 +37,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   - `DELETE /lists/{list_id}/subscriptions/{recipient_id}` with `client.lists.unsubscribe` method
 
 - Support for Profiles API by @jrweingart
+
   - `GET /profiles/{recipient_id}` with `client.profiles.get` method
   - `GET /profiles/{recipient_id}/lists` with `client.profiles.get_subscriptions` method
   - `PUT /profiles/{recipient_id}` with `client.profiles.replace` and `client.profiles.add` methods
@@ -33,11 +45,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   - `POST /profiles/{recipient_id}` with `client.profiles.merge` method
 
 - Support for Messages API by @jrweingart
+
   - `GET /messages` with `client.messages.list` method
   - `GET /messages/{message_id}` with `client.messages.get` method
   - `GET /messages/{message_id}/history` with `client.messages.get_history` method
 
 - Support for Events API by @jrweingart
+
   - `GET /events` with `client.events.list` method
   - `GET /events/{event_id}` with `client.event.get` method
   - `PUT /events/{event_id}` with `client.events.replace` and `client.events.add` methods
@@ -50,17 +64,23 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   - `DELETE /brands/brand_id` with `client.brands.delete` method
 
 ## [v1.0.2] - 2021-01-06
+
 ### Added
+
 - Minor bug fixes to ensure proper SSL certification by @scarney81
 
 ## [v1.0.1] - 2020-03-04
+
 ### Added
+
 - Support for Send API by @troy
 
 ## v1.0.0 - 2020-03-03
+
 Initial release by @troygoode
 
-[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.1.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.2.0...HEAD
+[v1.2.0]: https://github.com/trycourier/courier-ruby/compare/v1.1.0...v1.2.0
 [v1.1.0]: https://github.com/trycourier/courier-ruby/compare/v1.0.2...v1.1.0
 [v1.0.2]: https://github.com/trycourier/courier-ruby/compare/v1.0.1...v1.0.2
 [v1.0.1]: https://github.com/trycourier/courier-ruby/compare/v1.0.0...v1.0.1

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trycourier/courier-ruby
+
+## Local development
+
+- Fork this repository
+- Clone your fork
+- Run `bundle install`
+- Write code!
+- Test your code using `bundle exec rspec spec`
+
+## Releasing New Versions
+
+To publish Courier Ruby to RUBYGEMS.ORG
+
+- Update the CHANGELOG.md
+- Bump the package version in `lib/trycourier/version.rb`
+- Submit a PR to merge changes into main
+- Create and push a new version tag
+
+  ```bash
+  git tag -a v<VERSION> -m v<VERSION>
+  git push origin v<VERSION>
+  ```
+
+- Wait for GitHub Action to test and deploy
+- Confirm you are able to successfully install the new version by running `gem install trycourier`

data/README.md

@@ -19,21 +19,29 @@ Or install it yourself as:
     $ gem install trycourier
 
 ## Usage
+
 After installing, make sure to include this line at the top of your ruby file:
+
 ```ruby
 require "trycourier"
 ```
+
 To create a Courier Ruby client, all you need to do is pass in your authentication information. Then, you can start sending!
+
 ### Using token authentication (most secure)
+
 ```ruby
 client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var (recommended)
 ```
 
 ### Using basic authentication
+
 ```ruby
 client = Courier::Client.new(username: "USERNAME", password: "PASSWORD") # or set via COURIER_AUTH_USERNAME and COURIER_AUTH_PASSWORD env vars
 ```
+
 ### Sending a message to an individual recipient
+
 ```ruby
 client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
 res = client.send({
@@ -55,9 +63,11 @@ rescue Courier::CourierAPIError => re #error sent from from the API
   puts re.message
 end
 ```
+
 ## Advanced Usage
 
 ### Lists
+
 ```ruby
 require "trycourier"
 client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
@@ -143,7 +153,9 @@ Example: unsubscribe recipient from list
 """
 client.lists.unsubscribe(list_id: "your-list-id", recipient_id: "your-recipient-id")
 ```
+
 ### Profiles
+
 ```Ruby
 """
 Example: create a recipient's profile
@@ -188,13 +200,13 @@ resp = client.profiles.get_subscriptions(
 puts resp
 
 """
-Example: edit the contents of a recipient's profile with a patch operation 
-(follows JSON Patch conventions: RFC 6902). 
+Example: edit the contents of a recipient's profile with a patch operation
+(follows JSON Patch conventions: RFC 6902).
 """
 resp = client.profiles.patch(
   recipient_id: "your-recipient-id",
   operations: [
-    { 
+    {
       "op" => "add", #operation 1: add this email to profile
       "path" => "/parent",
       "value" => "example@example.com"
@@ -223,6 +235,7 @@ puts resp
 ```
 
 ### Messages
+
 ```Ruby
 """
 Example: fetch the statuses of messages you've previously sent.
@@ -254,6 +267,7 @@ puts resp
 ```
 
 ### Events
+
 ```Ruby
 """
 Example: fetch the list of events
@@ -296,7 +310,7 @@ Example: create a brand
 """
 resp = client.brands.create(
   name: "brand-name",
-  settings: { 
+  settings: {
     "color" => {
       "primary" => "#0000FF",
       "secondary" => "#FF0000",
@@ -333,16 +347,60 @@ resp = client.brands.delete(brand_id: "your-brand-id")
 puts resp
 ```
 
+### Automations
+
+````Ruby
+"""
+Example: invoke ad-hoc automation
+"""
+steps = [
+  {
+    "action" => "send"
+  }
+]
+automation = {
+  "steps" => steps
+}
+
+resp = client.automations.invoke(
+  automation: automation,
+  brand: "your-brand-id", # optional
+  data: {}, # optional
+  profile: {
+    "email" => "example@example.com",
+  }, # optional
+  recipient: "your-recipient-id", # optional
+  template: "your-notification-template-id" # optional
+)
+puts resp['runId']
+
+"""
+Example: invoke automation template
+"""
+resp = client.automations.invoke_template(
+  template_id: "your-automation-template-id",
+  brand: "your-brand-id", # optional
+  data: {}, # optional
+  profile: {
+    "email" => "example@example.com",
+  }, # optional
+  recipient: "your-recipient-id", # optional
+  template: "your-notification-template-id" # optional
+)
+puts resp['runId']
+
 ### Notes on input and errors
 With the exception of passing an auth token to create a client, and ```client.send(body)```, every parameter (optional or required) is sent using keyword arguments.
 In the case of ```client.send(body)```, if the hash does not have the required components, it will throw an InputError exception, which can be caught with rescue blocks:
 ```ruby
 rescue InputError
-``` 
+````
+
 Any other errors from the API are thrown as a CourierAPIError. Catch these errors by putting this after your method calls:
+
 ```ruby
 rescue CourierAPIError
-``` 
+```
 
 ## Development
 

data/lib/trycourier.rb

@@ -4,6 +4,7 @@ require "trycourier/lists"
 require "trycourier/profiles"
 require "trycourier/session"
 require "trycourier/messages"
+require "trycourier/automations"
 require "trycourier/version"
 require "trycourier/exceptions"
 require "net/http"
@@ -48,6 +49,7 @@ module Courier
       @lists = Courier::Lists.new(@session)
       @events = Courier::Events.new(@session)
       @brands = Courier::Brands.new(@session)
+      @automations = Courier::Automations.new(@session)
     end
 
     def send(body)
@@ -90,5 +92,7 @@ module Courier
     attr_reader :lists
 
     attr_reader :brands
+
+    attr_reader :automations
   end
 end

data/lib/trycourier/automations.rb

@@ -0,0 +1,67 @@
+module Courier
+  class Automations
+    KEY = "/automations"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def invoke(automation:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil)
+      path = "#{KEY}/invoke"
+      payload = {
+        "automation": automation
+      }
+
+      if brand
+        payload["brand"] = brand
+      end
+
+      if data
+        payload["data"] = data
+      end
+
+      if profile
+        payload["profile"] = profile
+      end
+
+      if recipient
+        payload["recipient"] = recipient
+      end
+
+      if template
+        payload["template"] = template
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: {})
+      ErrorHandler.check_err(res)
+    end
+
+    def invoke_template(template_id:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil)
+      path = "#{KEY}/#{template_id}/invoke"
+      payload = {}
+
+      if brand
+        payload["brand"] = brand
+      end
+
+      if data
+        payload["data"] = data
+      end
+
+      if profile
+        payload["profile"] = profile
+      end
+
+      if recipient
+        payload["recipient"] = recipient
+      end
+
+      if template
+        payload["template"] = template
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: {})
+      ErrorHandler.check_err(res)
+    end
+  end
+end

data/lib/trycourier/version.rb

@@ -1,3 +1,3 @@
 module Courier
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Courier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,6 +52,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -60,6 +61,7 @@ files:
 - bin/console
 - bin/setup
 - lib/trycourier.rb
+- lib/trycourier/automations.rb
 - lib/trycourier/brands.rb
 - lib/trycourier/events.rb
 - lib/trycourier/exceptions.rb