trycourier 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71daf0eb0e891e05d2a2f76461586d5af3fbd029d1c813c6df8dc41015329370
-  data.tar.gz: 54826227d59241eb5c0c4e382b9bdab12ce135eaaa4b5b7d17c2ba0bdc871f33
+  metadata.gz: e9bd120c1a6bd12bf0960fae9661848fe6a6e41c2782baa6eb3ae166882c428b
+  data.tar.gz: 4d2f6ba063c1dfb2270feaab7c0763c7aafb88920ea1f327d91bdc681abbc975
 SHA512:
-  metadata.gz: 20f4fdbc92da8822a01110a7480113ef09fd1e76b2d1ee4045aadebf617930c1eba2a9756e785764b9a4487ff2df8b23fb09d393b27b07e3f4d1d5e1e6a921f2
-  data.tar.gz: 0e6f85140f74677ffbe309ecebc0194974ee4c7e97959fc9a94bb5ea838a27d75e780c5028de9dc43e9b3f8caee9ddae9ffaa9b500b2f37391485afe75fb1460
+  metadata.gz: 56c1130d7caa6e4484ce56ff35dbce92518cd5559c32cf2895a18c45227bd81c49f27fb376e45d8c610eef5c49c2857265233028a5020bcf76a8f8a8630cb671
+  data.tar.gz: 1680c9bf19b28f762ce9ec73c01c33f6ae7035a0a824f4a013f5d489471c54ef2dde450f85729aba4658ff7b8db129f6e898b1bc77bd3cce8e3e867c5a03807f

data/.github/workflows/gem-push.yml

@@ -12,14 +12,17 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', 'head']
+
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.7
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7.x
-      - name: Install dependencies
-        run: bundle install
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run tests
         # Skipping rubocop for now
         # run: bundle exec rake
@@ -32,11 +35,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.7
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7.x
-
+          ruby-version: 2.7
       - name: Publish to RubyGems
         run: |
           mkdir -p $HOME/.gem

data/CHANGELOG.md

@@ -5,6 +5,21 @@ 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
+
+- Support for enhanced Send API by @tk26
+
+## [v1.3.0] - 2022-01-26
+
+### Added
+
+- Support for Bulk API by @tk26
+
 ## [v1.2.0] - 2021-04-08
 
 ### Added
@@ -79,7 +94,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 Initial release by @troygoode
 
-[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.2.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
 [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

data/Gemfile.lock

@@ -1,60 +1,60 @@
 PATH
   remote: .
   specs:
-    trycourier (1.0.2)
+    trycourier (1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     crack (0.4.5)
       rexml
-    diff-lcs (1.3)
+    diff-lcs (1.5.0)
     hashdiff (1.0.1)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.2)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (1.4.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.25.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.1.1)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.1)
-      rubocop (>= 0.90.0, < 2.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    standard (0.10.2)
-      rubocop (= 1.4.2)
-      rubocop-performance (= 1.9.1)
-    unicode-display_width (1.7.0)
-    webmock (3.11.0)
-      addressable (>= 2.3.6)
+    standard (1.7.0)
+      rubocop (= 1.25.0)
+      rubocop-performance (= 1.13.2)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
@@ -69,4 +69,4 @@ DEPENDENCIES
   webmock (>= 1.24.2)
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

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,6 +87,37 @@ rescue Courier::CourierAPIError => re #error sent from from the API
 end
 ```
 
+### 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" => {
+      "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"
+      }
+    }
+  })
+  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
+```
+
 ## Advanced Usage
 
 ### Lists
@@ -402,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.
@@ -415,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/bulk.rb

@@ -0,0 +1,79 @@
+module Courier
+  class Bulk
+    KEY = "/bulk"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def create_job(message:, idempotency_key: nil, idempotency_expiry: nil)
+      path = KEY.to_s
+      payload = {
+        "message": message
+      }
+
+      headers = {}
+      if idempotency_key
+        headers["idempotency_key"] = idempotency_key
+      end
+      if idempotency_expiry
+        headers["x-idempotency-expiration"] = idempotency_expiry
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: headers)
+      ErrorHandler.check_err(res)
+    end
+
+    def ingest_job(job_id:, users:, idempotency_key: nil, idempotency_expiry: nil)
+      path = "#{KEY}/#{job_id}"
+      payload = {
+        "users": users
+      }
+
+      headers = {}
+      if idempotency_key
+        headers["idempotency_key"] = idempotency_key
+      end
+      if idempotency_expiry
+        headers["x-idempotency-expiration"] = idempotency_expiry
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: headers)
+      ErrorHandler.check_err(res)
+    end
+
+    def run_job(job_id:, idempotency_key: nil, idempotency_expiry: nil)
+      path = "#{KEY}/#{job_id}/run"
+      payload = {}
+
+      headers = {}
+      if idempotency_key
+        headers["idempotency_key"] = idempotency_key
+      end
+      if idempotency_expiry
+        headers["x-idempotency-expiration"] = idempotency_expiry
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: headers)
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def get_job(job_id:)
+      path = "#{KEY}/#{job_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def get_job_users(job_id:, cursor: nil)
+      path = "#{KEY}/#{job_id}/users"
+
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+
+      res = @session.send(path, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+  end
+end

data/lib/trycourier/exceptions.rb

@@ -4,10 +4,12 @@ require "json"
 require "openssl"
 
 module Courier
-  #ResponseError in order to maintain v1.0.2 signature.
+  # ResponseError in order to maintain v1.0.2 signature.
   class InputError < StandardError; end
+
   class ResponseError < StandardError; end
-  class CourierAPIError < ResponseError; end  
+
+  class CourierAPIError < ResponseError; end
 
   class ErrorHandler
     def self.check_err(res)

data/lib/trycourier/messages.rb

@@ -39,7 +39,7 @@ module Courier
     end
 
     def get_history(message_id:, type: nil)
-      path ="#{KEY}/#{message_id}/history"
+      path = "#{KEY}/#{message_id}/history"
       params = {}
       if type
         params["type"] = type

data/lib/trycourier/session.rb

@@ -4,7 +4,6 @@ require "openssl"
 
 module Courier
   class CourierAPISession
-
     def initialize(base_url)
       @base_url = base_url
     end
@@ -75,7 +74,7 @@ module Courier
       end
     end
 
-    #getter for base url (for testing)
+    # getter for base url (for testing)
     attr_reader :base_url
   end
 end

data/lib/trycourier/version.rb

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

data/lib/trycourier.rb

@@ -5,8 +5,11 @@ require "trycourier/profiles"
 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"
@@ -22,6 +25,16 @@ module Courier
     end
   end
 
+  class SendMessageResponse
+    attr_reader :code
+    attr_reader :request_id
+
+    def initialize(code, request_id)
+      @code = code
+      @request_id = request_id
+    end
+  end
+
   class Client
     def initialize(auth_token = nil, username: nil, password: nil, base_url: nil)
       base = if base_url
@@ -50,18 +63,20 @@ module Courier
       @events = Courier::Events.new(@session)
       @brands = Courier::Brands.new(@session)
       @automations = Courier::Automations.new(@session)
+      @bulk = Courier::Bulk.new(@session)
+      @audiences = Courier::Audiences.new(@session)
     end
 
     def send(body)
-      if not body.is_a?(Hash)
+      if !body.is_a?(Hash)
         raise InputError, "Client#send must be passed a Hash as first argument."
-      elsif body["event"] == nil && body[:event] == nil
+      elsif body["event"].nil? && body[:event].nil?
         raise InputError, "Must specify the 'event' key in Hash supplied to Client#send."
-      elsif body["recipient"] == nil && body[:recipient] == nil
+      elsif body["recipient"].nil? && body[:recipient].nil?
         raise InputError, "Must specify the 'recipient' key in Hash supplied to Client#send."
-      elsif (body["data"] != nil and not body["data"].is_a?(Hash)) || (body[:data] != nil and not body[:data].is_a?(Hash))
+      elsif (!body["data"].nil? && !body["data"].is_a?(Hash)) || (!body[:data].nil? && !body[:data].is_a?(Hash))
         raise InputError, "The 'data' key in the Hash supplied to Client#send must also be a Hash."
-      elsif (body["profile"] != nil and not body["profile"].is_a?(Hash)) || (body[:profile] != nil and not body[:profile].is_a?(Hash))
+      elsif (!body["profile"].nil? && !body["profile"].is_a?(Hash)) || (!body[:profile].nil? && !body[:profile].is_a?(Hash))
         raise InputError, "The 'profile' key in the Hash supplied to Client#send must also be a Hash."
       end
 
@@ -79,6 +94,27 @@ module Courier
       end
     end
 
+    def send_message(body)
+      if !body.is_a?(Hash)
+        raise InputError, "Client#send_message must be passed a Hash as first argument."
+      elsif (!body["message"].nil? && !body["message"].is_a?(Hash)) || (!body[:message].nil? && !body[:message].is_a?(Hash))
+        raise InputError, "The 'message' key in the Hash supplied to Client#send_message must also be a Hash."
+      end
+
+      res = @session.send("/send", "POST", body: body)
+
+      code = res.code.to_i
+      obj = JSON.parse res.read_body
+
+      if code == 202
+        request_id = obj["requestId"]
+        SendMessageResponse.new(code, request_id)
+      elsif (message = obj["Message"].nil? ? obj["message"] : obj["Message"])
+        err = "#{code}: #{message}"
+        raise CourierAPIError, err
+      end
+    end
+
     # getters for all class variables
 
     attr_reader :session
@@ -94,5 +130,11 @@ module Courier
     attr_reader :brands
 
     attr_reader :automations
+
+    attr_reader :bulk
+
+    attr_reader :audiences
+
+
   end
 end

data/trycourier.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name = "trycourier"
   spec.version = Courier::VERSION
   spec.authors = ["Courier"]
-spec.email = ["support@courier.com"]
+  spec.email = ["support@courier.com"]
 
   spec.summary = "Wraps calls to the Courier REST API"
   spec.description = "Courier is the smartest way to design & deliver notifications. Design your notifications once, deliver them to any channel through one API."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Courier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,8 +61,10 @@ files:
 - bin/console
 - bin/setup
 - lib/trycourier.rb
+- lib/trycourier/audiences.rb
 - lib/trycourier/automations.rb
 - lib/trycourier/brands.rb
+- lib/trycourier/bulk.rb
 - lib/trycourier/events.rb
 - lib/trycourier/exceptions.rb
 - lib/trycourier/lists.rb
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Wraps calls to the Courier REST API