trycourier 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ad4d30cf60c972878593e731297e16218eb733d5f234d42630c76ee4e61b70
-  data.tar.gz: 1cf5722063320f2a9bd2365b28da54c2aed796c80fe26b5fd36f1e6409579c1e
+  metadata.gz: 4aa5b8cf9e2e4554e7238b5001707c706bb9e7c8cdceab309fce4ba805601e5a
+  data.tar.gz: 4396885d4f4f0da37c37896653850c74ba434eba8e01c44ba368bc4452892205
 SHA512:
-  metadata.gz: '08b2ec48d0f42bc45e87cfa2877d100b5deb2eb9927985a6544dbce6546a7950819a8d7885ffcd1d86c94c300ca2246d536ff57cb6589db0bb6f67be34c20107'
-  data.tar.gz: d4a47fc88397e68f9160fb03fcee6ed11591c2d78eb044e279ab0463b225c22ebc2c0eb78a0eb4f879c79c76e65851a4d807f960676f1cce2424bae072e1198d
+  metadata.gz: ec711df626dea24a00a5038f2da814f040499972cbf841e8d747ff841162ff4ed7207b081aae704aa4f7f1740f15bf6d6fc2867d2315d107577a70d7364fc9aa
+  data.tar.gz: 24c12be8b4042da8188d54059395fc849d95ddf1e1c4ac03d1a5f5199a5d6e3f87ee62376fd1b5d383704af592e7767934c58214a8d483f0fbbc739023333d9d

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,20 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v1.6.0] - 2022-07-25
+
+- Support for audit events API
+
+## [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
@@ -85,7 +99,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 Initial release by @troygoode
 
-[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.3.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.6.0...HEAD
+[v1.6.0]: https://github.com/trycourier/courier-ruby/compare/v1.5.0...v1.6.0
+[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

data/Gemfile.lock

@@ -1,60 +1,60 @@
 PATH
   remote: .
   specs:
-    trycourier (1.0.2)
+    trycourier (1.6.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,107 @@ 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"
+        },
+        "tags" => ["tag-1", "tag-2"],
+        "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
+```
+
+### Sending a message to an individual with granular 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" => {
+			  "version" => "2020-01-01",
+        "elements" => [
+				  {
+            "type" => "text",
+            "content" => "Thanks for signing up, {{name}}"
+          },
+          {
+            "type" => "action",
+            "content" => "Click Me!",
+            "href" => "https://www.example.com"
+          }
+        ]
+		  },
+      "routing" => {
+        "method" => "all",
+        "channels" => [
+          "email"
+        ]
+		  },
+      "data" => {
+        "name" => "Ruby"
+      },
+      "metadata" => {
+        "utm" => {
+          "source" => "Ruby"
+        },
+      },
+      "channels" => {
+        "email" => {
+          "routing_method" => "all",
+          "providers" => [
+            "sendgrid",
+            "mailjet"
+          ],
+          "metadata" => {
+            "utm" => {
+              "medium" => "email"
+            }
+          }
+        }
+      },
+      "providers" => {
+        "sendgrid" => {
+          "metadata" => {
+            "utm" => {
+              "source" => "sendgrid"
+            }
+          }
+        }
+      }
+    }
+  })
+  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 +526,71 @@ 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
+```
+
+### Audit Events
+
+```Ruby
+"""
+Example: List audit events
+"""
+resp = client.audit_events.list()
+
+"""
+Example: Get a specific audit event
+"""
+resp = client.audit_events.get(audit_event_id: "audit-event-id")
+```
+
 ## 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 +604,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/audit_events.rb

@@ -0,0 +1,27 @@
+module Courier
+  class AuditEvents
+    KEY = "/audit-events"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def get(audit_event_id:)
+      path = "#{KEY}/#{audit_event_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def list(cursor: nil)
+      path = "#{KEY}"
+
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+
+      res = @session.send(path, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+  end
+end

data/lib/trycourier/bulk.rb

@@ -7,7 +7,7 @@ module Courier
     end
 
     def create_job(message:, idempotency_key: nil, idempotency_expiry: nil)
-      path = "#{KEY}"
+      path = KEY.to_s
       payload = {
         "message": message
       }

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.3.0"
+  VERSION = "1.6.0"
 end

data/lib/trycourier.rb

@@ -6,8 +6,11 @@ require "trycourier/session"
 require "trycourier/messages"
 require "trycourier/automations"
 require "trycourier/bulk"
+require "trycourier/audiences"
+require "trycourier/audit_events"
 require "trycourier/version"
 require "trycourier/exceptions"
+
 require "net/http"
 require "json"
 require "openssl"
@@ -23,6 +26,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
@@ -52,18 +65,20 @@ module Courier
       @brands = Courier::Brands.new(@session)
       @automations = Courier::Automations.new(@session)
       @bulk = Courier::Bulk.new(@session)
+      @audiences = Courier::Audiences.new(@session)
+      @audit_events = Courier::AuditEvents.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
 
@@ -81,6 +96,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
@@ -98,5 +134,10 @@ module Courier
     attr_reader :automations
 
     attr_reader :bulk
+
+    attr_reader :audiences
+
+    attr_reader :audit_events
+
   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.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Courier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,6 +61,8 @@ files:
 - bin/console
 - bin/setup
 - lib/trycourier.rb
+- lib/trycourier/audiences.rb
+- lib/trycourier/audit_events.rb
 - lib/trycourier/automations.rb
 - lib/trycourier/brands.rb
 - lib/trycourier/bulk.rb