trycourier 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e2e7e6f4ad2900f3ad0d118062208c74492851e96976da6795c6309c95ad9ea
-  data.tar.gz: ce78409870df6608de59bc5ea4a628732b09f8d3ec7b304202f1721d07ff5836
+  metadata.gz: e9bd120c1a6bd12bf0960fae9661848fe6a6e41c2782baa6eb3ae166882c428b
+  data.tar.gz: 4d2f6ba063c1dfb2270feaab7c0763c7aafb88920ea1f327d91bdc681abbc975
 SHA512:
-  metadata.gz: 060ff6e98ab2a50557b9e54cf2e1fe2f13d02a4569e335f4ffe31c7bd8fa55c8bbcaef7df686c19c9c98ae0c032e024ba6bc705242bc4df5f26bd9c780174538
-  data.tar.gz: fd9c70f99624a1d82e3a0c6825b17cea6526a0d8c46e0a221c8740514e366851ba59854454919f723cd8a3b205ae8800462fe8965fe05aab9fb2dafe667b0333
+  metadata.gz: 56c1130d7caa6e4484ce56ff35dbce92518cd5559c32cf2895a18c45227bd81c49f27fb376e45d8c610eef5c49c2857265233028a5020bcf76a8f8a8630cb671
+  data.tar.gz: 1680c9bf19b28f762ce9ec73c01c33f6ae7035a0a824f4a013f5d489471c54ef2dde450f85729aba4658ff7b8db129f6e898b1bc77bd3cce8e3e867c5a03807f

data/CHANGELOG.md

@@ -5,6 +5,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v1.5.0] - 2022-03-28
+- Support for audiences API
+
 ## [v1.4.0] - 2022-01-31
 
 ### Added
@@ -91,7 +94,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 Initial release by @troygoode
 
-[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.4.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.5.0...HEAD
+[v1.5.0]: https://github.com/trycourier/courier-ruby/compare/v1.4.0...v1.5.0
 [v1.4.0]: https://github.com/trycourier/courier-ruby/compare/v1.3.0...v1.4.0
 [v1.3.0]: https://github.com/trycourier/courier-ruby/compare/v1.2.0...v1.3.0
 [v1.2.0]: https://github.com/trycourier/courier-ruby/compare/v1.1.0...v1.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trycourier (1.4.0)
+    trycourier (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -42,6 +42,29 @@ client = Courier::Client.new(username: "USERNAME", password: "PASSWORD") # or se
 
 ### 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_message({
+    "message" => {
+      "to" => {
+        "email" => "foo@bar.com"
+      }
+      "content" => {
+        "title" => "hello {{name}}",
+        "body" => "Welcome to Courier!"
+      },
+      "data" => {
+        "name" => "Ruby"
+      }
+    }
+  })
+  puts res.code # the HTTP response code
+  puts res.request_id # if the code is 202, this will be the Courier request ID for this message
+rescue Courier::CourierAPIError => re #error sent from from the API
+  puts re.message
+end
+```
+
 ```ruby
 client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
 res = client.send({
@@ -64,17 +87,27 @@ rescue Courier::CourierAPIError => re #error sent from from the API
 end
 ```
 
-## Advanced Usage
-
-### Send API enhanced
+### Sending a message to an individual with metadata
 
 ```ruby
 client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
 res = client.send_message({
-    message => {
-      template => "my-template",
-      to => {
-        email => "foo@bar.com"
+    "message" => {
+      "to" => {
+        "email" => "foo@bar.com"
+      }
+      "content" => {
+        "title" => "hello {{name}}",
+        "body" => "Welcome to Courier!"
+      },
+      "data" => {
+        "name" => "Ruby"
+      },
+      "metadata" => {
+        "utm" => {
+          "source" => "Ruby"
+        },
+        "trace_id" => "feed-me-hungry"
       }
     }
   })
@@ -85,6 +118,8 @@ rescue Courier::CourierAPIError => re #error sent from from the API
 end
 ```
 
+## Advanced Usage
+
 ### Lists
 
 ```ruby
@@ -421,6 +456,57 @@ Any other errors from the API are thrown as a CourierAPIError. Catch these error
 rescue CourierAPIError
 ```
 
+### Audiences
+
+List of supported operators for audience filtering: https://www.courier.com/docs/reference/audieces/operators
+
+```Ruby
+"""
+Example: create or update an Audience
+"""
+resp = client.audiences.put(
+  audience_id: "your-audience-id",
+  filter: {
+    "operator": "EQ",
+    "value": "en-US",
+    "path": "locale"
+  }
+)
+
+"""
+Example: Get all members of an Audience
+"""
+resp = client.audiences.get_audience_members(
+  audience_id: "your-audience-id",
+  cursor: nil
+)
+puts resp['status']
+
+"""
+Example: Send to an Audience
+"""
+client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
+res = client.send_message({
+    "message" => {
+      "to" => {
+        "audience_id" => "your-audience-id"
+      }
+      "content" => {
+        "title" => "hello {{name}}",
+        "body" => "Welcome to Courier!"
+      },
+      "data" => {
+        "name" => "Ruby"
+      }
+    }
+  })
+  puts res.code # the HTTP response code
+  puts res.request_id # if the code is 202, this will be the Courier request ID for this message
+rescue Courier::CourierAPIError => re #error sent from from the API
+  puts re.message
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -434,3 +520,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/trycou
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+```
+
+```

data/lib/trycourier/audiences.rb

@@ -0,0 +1,45 @@
+module Courier
+  class Audiences
+    KEY = "/audiences"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def get_audience(audience_id:)
+      path = "#{KEY}/#{audience_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def get_audiences(cursor: nil)
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+
+      res = @session.send(KEY, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+
+    def get_audience_members(audience_id:, cursor: nil)
+      path = "#{KEY}/#{audience_id}/members"
+
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+
+      res = @session.send(path, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+
+    def put(audience_id:, payload:)
+      path = "#{KEY}/#{audience_id}"
+
+      res = @session.send(path, "PUT", body: payload)
+      ErrorHandler.check_err(res)
+    end
+
+  end
+end

data/lib/trycourier/version.rb

@@ -1,3 +1,3 @@
 module Courier
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/trycourier.rb

@@ -6,8 +6,10 @@ require "trycourier/session"
 require "trycourier/messages"
 require "trycourier/automations"
 require "trycourier/bulk"
+require "trycourier/audiences"
 require "trycourier/version"
 require "trycourier/exceptions"
+
 require "net/http"
 require "json"
 require "openssl"
@@ -62,6 +64,7 @@ module Courier
       @brands = Courier::Brands.new(@session)
       @automations = Courier::Automations.new(@session)
       @bulk = Courier::Bulk.new(@session)
+      @audiences = Courier::Audiences.new(@session)
     end
 
     def send(body)
@@ -129,5 +132,9 @@ module Courier
     attr_reader :automations
 
     attr_reader :bulk
+
+    attr_reader :audiences
+
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Courier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,6 +61,7 @@ files:
 - bin/console
 - bin/setup
 - lib/trycourier.rb
+- lib/trycourier/audiences.rb
 - lib/trycourier/automations.rb
 - lib/trycourier/brands.rb
 - lib/trycourier/bulk.rb