trycourier 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ad4d30cf60c972878593e731297e16218eb733d5f234d42630c76ee4e61b70
-  data.tar.gz: 1cf5722063320f2a9bd2365b28da54c2aed796c80fe26b5fd36f1e6409579c1e
+  metadata.gz: 2e2e7e6f4ad2900f3ad0d118062208c74492851e96976da6795c6309c95ad9ea
+  data.tar.gz: ce78409870df6608de59bc5ea4a628732b09f8d3ec7b304202f1721d07ff5836
 SHA512:
-  metadata.gz: '08b2ec48d0f42bc45e87cfa2877d100b5deb2eb9927985a6544dbce6546a7950819a8d7885ffcd1d86c94c300ca2246d536ff57cb6589db0bb6f67be34c20107'
-  data.tar.gz: d4a47fc88397e68f9160fb03fcee6ed11591c2d78eb044e279ab0463b225c22ebc2c0eb78a0eb4f879c79c76e65851a4d807f960676f1cce2424bae072e1198d
+  metadata.gz: 060ff6e98ab2a50557b9e54cf2e1fe2f13d02a4569e335f4ffe31c7bd8fa55c8bbcaef7df686c19c9c98ae0c032e024ba6bc705242bc4df5f26bd9c780174538
+  data.tar.gz: fd9c70f99624a1d82e3a0c6825b17cea6526a0d8c46e0a221c8740514e366851ba59854454919f723cd8a3b205ae8800462fe8965fe05aab9fb2dafe667b0333

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,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v1.4.0] - 2022-01-31
+
+### Added
+
+- Support for enhanced Send API by @tk26
+
 ## [v1.3.0] - 2022-01-26
 
 ### Added
@@ -85,7 +91,8 @@ 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.4.0...HEAD
+[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.4.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

@@ -66,6 +66,25 @@ end
 
 ## Advanced Usage
 
+### Send API enhanced
+
+```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"
+      }
+    }
+  })
+  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
+```
+
 ### Lists
 
 ```ruby

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.4.0"
 end

data/lib/trycourier.rb

@@ -23,6 +23,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
@@ -55,15 +65,15 @@ module Courier
     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 +91,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

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.4.0
 platform: ruby
 authors:
 - Courier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec