trycourier 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23f5a0957ead43adbaf9f97c33e6236149902be1df820f120214515d36a2d26b
-  data.tar.gz: 304eff5f123c7adf297bb6e4b1d3a2eb620295bc3a9c2e254e2f369ba194befe
+  metadata.gz: 40ffa9399327479e0f0fa89c350decd17f242caa48b91f1a772cebd4f25d5610
+  data.tar.gz: fd159122320af8ab96223890b78061dd21ce193adadceb146f7e18d36a798032
 SHA512:
-  metadata.gz: 5423807878697faef75fd27e31aee0dd43ce669f176275d6b321d57f03b38736c5a96d1ad9a0baff93c6f83442b22f1fe80efce496de6e6c0f1dd3bbdb8cbae8
-  data.tar.gz: db0ad387345128716957853b682c0f6639e6a4f14978b7787383228ee76bcccbe97837b8503a840c68bdbe4e18d5d3e078920a21c2ded5a8125c1689031132a5
+  metadata.gz: 524f60d42ec87e581ce591d7550f34ab0a5c592d33618465eba1d26a25822b8c8d3974ad188ef5cc089d24947424ffebe434655e64481b81fed244b95fd22fbf
+  data.tar.gz: bb97291b655840c5051b78beb48d345827be048392e16c7b7486749eac80e45f111cedc216448d8a93997eaae2f57c90c089c7ff1abbc00ad66aa9930bba9212

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

@@ -0,0 +1,49 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [master]
+    tags:
+      - v*
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.7
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        # Skipping rubocop for now
+        # run: bundle exec rake
+        run: bundle exec rspec spec
+  build:
+    name: Build + Publish
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.7
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.md

@@ -0,0 +1,66 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+
+## [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
+  - `COURIER_AUTH_TOKEN`
+- 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
+  - `PUT /lists/{list_id}` with `client.lists.put` method
+  - `DELETE /lists/{list_id}` with `client.lists.delete` method
+  - `PUT /lists/{list_id}/restore` with `client.lists.restore` method
+  - `GET /lists/{list_id}/subscriptions` with `client.lists.get_subscriptions` method
+  - `PUT /lists/{list_id}/subscriptions` with `client.lists.put_subscriptions` method
+  - `PUT /lists/{list_id}/subscriptions/{recipient_id}` with `client.lists.subscribe` method
+  - `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
+  - `PATCH /profiles/{recipient_id}` with `client.profiles.patch` method
+  - `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
+
+- Support for Brands API by @jrweingart
+  - `GET /brands` with `client.brands.list` method
+  - `GET /brands/brand_id` with `client.brands.get` method
+  - `POST /brands` with `client.brands.create` method
+  - `PUT /brands/brand_id` with `client.brands.replace` method
+  - `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
+[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/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem "standard", group: [:development, :test]

data/Gemfile.lock

@@ -6,8 +6,21 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.3)
+    hashdiff (1.0.1)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
     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)
@@ -21,6 +34,29 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    rubocop (1.4.2)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      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)
+      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)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -28,7 +64,9 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
+  standard
   trycourier!
+  webmock (>= 1.24.2)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -19,35 +19,330 @@ 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)
+```
 
-begin
-  client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
-  res = client.send({
+### 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({
     "event" => "your-event-id",
     "recipient" => "your-recipient-id",
 
-    "profile" => {
+    "profile" => { #optional (include any key-value pairs required by your chosen integrations. This information can also be stored in the recipient's profile in Courier)
       "email": "example@example.com",
       "phone_number": "555-867-5309"
     },
 
-    "data" => {
+    "data" => { #any data you want to pass to a message template
       "world" => "Ruby!"
     }
   })
-
   puts res.code # the HTTP response code
-  puts res.message_id # if 200, this will be the Courier message ID for this notification
-rescue Courier::ResponseError => re
+  puts res.message_id # if the code is 200, this will be the Courier message ID for this notification
+rescue Courier::CourierAPIError => re #error sent from from the API
   puts re.message
-rescue Courier::InputError => ie
-  puts ie.message
 end
+```
+## Advanced Usage
+
+### Lists
+```ruby
+require "trycourier"
+client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
+
+"""
+Creating a List
+"""
+res = client.lists.put(list_id, name)
+puts res
 
+"""
+Example: send a message to a list
+"""
+resp = client.lists.send(
+  event: "your-event-id",
+  list: "your.list.id",
+  brand: "your-brand-id", # optional
+  data: {}, # optional
+  override: {} # optional
+)
+puts resp['messageId'])
+
+"""
+Example: send a message to a list pattern
+"""
+resp = client.lists.send(
+  event: "your-event-id",
+  pattern: "your.list.*", #PATTERN (will send to all list ids that start with "your.list.")
+  brand: "your-brand-id", # optional
+  data: {}, # optional
+  override: {} # optional
+)
+puts resp['messageId'])
+
+"""
+Example: get all lists
+"""
+resp = client.lists.list(
+  cursor: "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA", # optional
+)
+puts resp
+
+"""
+Example: get a specific list
+"""
+resp = client.lists.get(list_id: "your-list-id")
+puts resp
+
+
+"""
+Example: delete a list
+"""
+client.lists.delete(list_id: "your-list-id")
+
+"""
+Example: restore a list
+"""
+client.lists.restore(list_id: "your-list-id")
+
+"""
+Example: get a list's subscribptions
+"""
+resp = client.lists.get_subscriptions(list_id: "your-list-id",
+  cursor: "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA", # optional
+)
+puts resp
+
+"""
+Example: replace many recipients to a new or existing list
+"""
+client.lists.put_subscriptions(list_id: "your-list-id", recipients: [
+  "RECIPIENT_ID_1",
+  "RECIPIENT_ID_2"
+])
+
+"""
+Example: Example: subscribe single recipient to a new or existing list
+"""
+client.lists.subscribe(list_id: "your-list-id", recipient_id: "your-recipient-id")
+
+"""
+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
+"""
+resp = client.profiles.add(
+  recipient_id: "your-recipient-id",
+  profile: {
+    "email" => "example@example.com",
+    "name" => "Example Name"
+  }
+)
+
+"""
+Example: replace or create a recipient's profile
+"""
+resp = client.profiles.replace(
+  recipient_id: "your-recipient-id",
+  profile: {
+    "email" => "example@example.com"
+  }
+)
+puts resp['status']
+
+"""
+Example: merge or create a recipient's profile
+"""
+resp = client.profiles.merge(
+  recipient_id: "your-recipient-id",
+  profile: {
+    "phone_number" => "+15555555555"
+  }
+)
+puts resp['status']
+
+"""
+Example: get the subscribed lists of a recipient
+"""
+resp = client.profiles.get_subscriptions(
+  recipient_id: "your-recipient-id",
+  cursor: "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA" #optional
+)
+puts resp
+
+"""
+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"
+    }
+    {
+      "op" => "replace", #operation 2: update with new email
+      "path" => "/parent",
+      "value" => "jane@doe.com"
+    }
+    {
+      "op" => "copy", #operation 3: copy that email to /emergency_contact
+      "from" => "/parent",
+      "path" => "/emergency_contact"
+    }
+    ...
+  ]
+)
+puts resp
+
+
+"""
+Example: get a recipient's profile
+"""
+resp = client.profiles.get(recipient_id: "your-recipient-id")
+puts resp
+```
+
+### Messages
+```Ruby
+"""
+Example: fetch the statuses of messages you've previously sent.
+"""
+resp = client.messages.list(
+  cursor: "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA", # optional
+  event: "your-event-id", # optional
+  list: "your-list-id", #optional
+  message_id: "your-message-id" #optional
+  notification: ["message-status-1", "message-status-2",...] #optional
+  recipient: "recipient-id" # optional
+)
+puts resp
+
+"""
+Example: fetch the status of a message you've previously sent
+"""
+resp = client.messages.get(message_id: "your-message-id")
+puts resp
+
+"""
+Example: fetch the array of events of a message you've previously sent.
+"""
+resp = client.messages.get_history(
+message_id: "your-message-id",
+type: "list-type" #optional ("FILTERED", "RENDERED", "MAPPED", "PROFILE_LOADED")
+)
+puts resp
+```
+
+### Events
+```Ruby
+"""
+Example: fetch the list of events
+"""
+resp = client.events.list
+puts resp
+
+"""
+Example: fetch a specific event by event ID
+"""
+resp = client.events.get(event_id: "your-event-id")
+puts resp
+
+"""
+Example: create or replace an event
+"""
+resp = client.events.replace(
+  event_id: "your-event-id",
+  notification_id: "notification_id",
+  type: "notificaton" ## optional, defaults to notification
+)
+puts resp
+
+"""
+Example: get all brands
+"""
+resp = client.brands.list(
+  cursor: "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA", # optional
+)
+puts resp
+
+"""
+Example: get a specific brand
+"""
+resp = client.brands.get(brand_id: "brand_id")
+puts resp
+
+"""
+Example: create a brand
+"""
+resp = client.brands.create(
+  name: "brand-name",
+  settings: { 
+    "color" => {
+      "primary" => "#0000FF",
+      "secondary" => "#FF0000",
+      "tertiary" => "#00FF00"
+    }
+  },
+  id: "my-brand-id", #optional
+  snippets: {}, #optional
+  idempotency_key: "my-idemp-key", #optional
+)
+puts resp
+
+"""
+Example: replace a brand
+"""
+resp = client.brands.replace(
+  brand_id: "your-brand-id",
+  name: "brand-name",
+  settings: {}
+    "color" => {
+      "primary" => "#FF0000",
+      "secondary" => "#00FF00",
+      "tertiary" => "#0000FF"
+    }
+  },
+  snippets: {} #optional
+)
+puts resp
+
+"""
+Example: delete a brand
+"""
+resp = client.brands.delete(brand_id: "your-brand-id")
+puts resp
+```
+
+### 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/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: %i[spec standard]

data/lib/trycourier.rb

@@ -1,12 +1,16 @@
+require "trycourier/events"
+require "trycourier/brands"
+require "trycourier/lists"
+require "trycourier/profiles"
+require "trycourier/session"
+require "trycourier/messages"
 require "trycourier/version"
+require "trycourier/exceptions"
 require "net/http"
 require "json"
 require "openssl"
 
 module Courier
-  class ResponseError < StandardError; end
-  class InputError < StandardError; end
-
   class SendResponse
     attr_reader :code
     attr_reader :message_id
@@ -18,49 +22,73 @@ module Courier
   end
 
   class Client
-    def initialize(auth_token = nil)
-      @auth_token = auth_token || ENV['COURIER_AUTH_TOKEN']
-      @uri = URI.parse('https://api.trycourier.app/send')
-      if @auth_token == nil or @auth_token == ""
-        raise InputError, "Client requires an auth_token be supplied."
+    def initialize(auth_token = nil, username: nil, password: nil, base_url: nil)
+      base = if base_url
+        base_url
+      elsif ENV["COURIER_BASE_URL"]
+        ENV["COURIER_BASE_URL"]
+      else
+        "https://api.courier.com"
+      end
+
+      @session = Courier::CourierAPISession.new(base)
+
+      if auth_token
+        @session.init_token_auth(auth_token)
+      elsif ENV["COURIER_AUTH_TOKEN"]
+        @session.init_token_auth(ENV["COURIER_AUTH_TOKEN"])
+      elsif username && password
+        @session.init_basic_auth(username, password)
+      elsif ENV["COURIER_AUTH_USERNAME"] && ENV["COURIER_AUTH_PASSWORD"]
+        @session.init_basic_auth(ENV["COURIER_AUTH_USERNAME"], ENV["COURIER_AUTH_PASSWORD"])
       end
+
+      @messages = Courier::Messages.new(@session)
+      @profiles = Courier::Profiles.new(@session)
+      @lists = Courier::Lists.new(@session)
+      @events = Courier::Events.new(@session)
+      @brands = Courier::Brands.new(@session)
     end
 
     def send(body)
       if not body.is_a?(Hash)
         raise InputError, "Client#send must be passed a Hash as first argument."
-      elsif 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
+      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)
+      elsif (body["data"] != nil and not body["data"].is_a?(Hash)) || (body[:data] != nil and not 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)
+      elsif (body["profile"] != nil and not body["profile"].is_a?(Hash)) || (body[:profile] != nil and not body[:profile].is_a?(Hash))
         raise InputError, "The 'profile' key in the Hash supplied to Client#send must also be a Hash."
       end
 
-      http = Net::HTTP.new(@uri.host, @uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-
-      req = Net::HTTP::Post.new(@uri)
-      req["authorization"] = "Bearer #{@auth_token}"
-      req["content-type"] = "application/json"
-      req["User-Agent"] = "courier-ruby/#{Courier::VERSION}"
-      req.body = body.to_json
+      res = @session.send("/send", "POST", body: body)
 
-      res = http.request(req)
       code = res.code.to_i
       obj = JSON.parse res.read_body
 
       if code == 200
         message_id = obj["messageId"]
-        return SendResponse.new(code, message_id)
-      elsif
-        message = obj["Message"] == nil ? obj["message"] : obj["Message"]
+        SendResponse.new(code, message_id)
+      elsif (message = obj["Message"].nil? ? obj["message"] : obj["Message"])
         err = "#{code}: #{message}"
-        raise ResponseError, err
+        raise CourierAPIError, err
       end
     end
+
+    # getters for all class variables
+
+    attr_reader :session
+
+    attr_reader :messages
+
+    attr_reader :profiles
+
+    attr_reader :events
+
+    attr_reader :lists
+
+    attr_reader :brands
   end
 end

data/lib/trycourier/brands.rb

@@ -0,0 +1,70 @@
+module Courier
+  class Brands
+    KEY = "/brands"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def list(cursor: nil)
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+      res = @session.send(KEY, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+
+    def get(brand_id:)
+      path = "#{KEY}/#{brand_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def add(name:, settings:, id: nil, snippets: nil, idempotency_key: nil)
+      create(name: name, settings: settings, id: id, snippets: snippets, idempotency_key: idempotency_key)
+    end
+
+    def create(name:, settings:, id: nil, snippets: nil, idempotency_key: nil)
+      headers = {}
+      if idempotency_key
+        headers["idempotency_key"] = idempotency_key
+      end
+
+      payload = {
+        "name" => name,
+        "settings" => settings
+      }
+      if id
+        payload["id"] = id
+      end
+      if snippets
+        payload["snippets"] = snippets
+      end
+
+      res = @session.send(KEY, "POST", body: payload, headers: headers)
+      ErrorHandler.check_err(res)
+    end
+
+    def replace(brand_id:, name:, settings:, snippets: nil)
+      path = "#{KEY}/#{brand_id}"
+
+      payload = {
+        "name" => name,
+        "settings" => settings
+      }
+      if snippets
+        payload["snippets"] = snippets
+      end
+
+      res = @session.send(path, "PUT", body: payload)
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def delete(brand_id:)
+      path = "#{KEY}/#{brand_id}"
+      res = @session.send(path, "DELETE")
+      ErrorHandler.check_err_non_json(res)
+    end
+  end
+end

data/lib/trycourier/events.rb

@@ -0,0 +1,35 @@
+module Courier
+  class Events
+    KEY = "/events"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def list
+      res = @session.send(KEY, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def get(event_id:)
+      path = "#{KEY}/#{event_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def add(event_id:, id:, type: "notification")
+      replace(event_id: event_id, id: id, type: type)
+    end
+
+    def replace(event_id:, id:, type: "notification")
+      path = "#{KEY}/#{event_id}"
+
+      payload = {
+        "id" => id,
+        "type" => type
+      }
+      res = @session.send(path, "PUT", body: payload)
+      ErrorHandler.check_err_non_json(res)
+    end
+  end
+end

data/lib/trycourier/exceptions.rb

@@ -0,0 +1,37 @@
+require "trycourier/version"
+require "net/http"
+require "json"
+require "openssl"
+
+module Courier
+  #ResponseError in order to maintain v1.0.2 signature.
+  class InputError < StandardError; end
+  class ResponseError < StandardError; end
+  class CourierAPIError < ResponseError; end  
+
+  class ErrorHandler
+    def self.check_err(res)
+      code = res.code.to_i
+      obj = JSON.parse res.read_body
+
+      if code < 400
+        obj
+      elsif (message = obj["Message"].nil? ? obj["message"] : obj["Message"])
+        err = "#{code}: #{message}"
+        raise CourierAPIError.new err
+      end
+    end
+
+    def self.check_err_non_json(res)
+      code = res.code.to_i
+      if code >= 400
+        obj = JSON.parse res.read_body
+        if (message = obj["Message"].nil? ? obj["message"] : obj["Message"])
+          err = "#{code}: #{message}"
+          raise CourierAPIError.new err
+        end
+      end
+      res
+    end
+  end
+end

data/lib/trycourier/lists.rb

@@ -0,0 +1,109 @@
+module Courier
+  class Lists
+    KEY = "/lists"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def send(event:, list: nil, pattern: nil, data: {}, brand: nil, override: nil, idempotency_key: nil)
+      path = "/send/list"
+      payload = {
+        "event": event,
+        "data": data
+      }
+      if list
+        payload["list"] = list
+      end
+      if pattern
+        payload["pattern"] = pattern
+      end
+      if brand
+        payload["brand"] = brand
+      end
+      if override
+        payload["override"] = override
+      end
+
+      headers = {}
+      if idempotency_key
+        headers["idempotency_key"] = idempotency_key
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: headers)
+      ErrorHandler.check_err(res)
+    end
+
+    def list(cursor: nil, pattern: nil)
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+      if pattern
+        params["pattern"] = pattern
+      end
+      res = @session.send(KEY, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+
+    def get(list_id:)
+      path = "#{KEY}/#{list_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def put(list_id:, name:)
+      path = "#{KEY}/#{list_id}"
+
+      payload = {
+        "name": name.to_s
+      }
+
+      res = @session.send(path, "PUT", body: payload)
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def delete(list_id:)
+      path = "#{KEY}/#{list_id}"
+      res = @session.send(path, "DELETE")
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def restore(list_id:)
+      path = "#{KEY}/#{list_id}/restore"
+      res = @session.send(path, "PUT")
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def get_subscriptions(list_id:, cursor: nil)
+      path = "#{KEY}/#{list_id}/subscriptions"
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+      res = @session.send(path, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+
+    def put_subscriptions(list_id:, recipients:)
+      path = "#{KEY}/#{list_id}/subscriptions"
+      payload = {
+        "recipients": recipients
+      }
+      res = @session.send(path, "PUT", body: payload)
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def subscribe(list_id:, recipient_id:)
+      path = "#{KEY}/#{list_id}/subscriptions/#{recipient_id}"
+      res = @session.send(path, "PUT")
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def unsubscribe(list_id:, recipient_id:)
+      path = "#{KEY}/#{list_id}/subscriptions/#{recipient_id}"
+      res = @session.send(path, "DELETE")
+      ErrorHandler.check_err_non_json(res)
+    end
+  end
+end

data/lib/trycourier/messages.rb

@@ -0,0 +1,51 @@
+module Courier
+  class Messages
+    KEY = "/messages"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def list(cursor: nil, event: nil, list_id: nil, message_id: nil,
+      notification: nil, recipient: nil)
+      params = {}
+
+      if cursor
+        params["cursor"] = cursor
+      end
+      if event
+        params["event"] = event
+      end
+      if list_id
+        params["list"] = list_id
+      end
+      if message_id
+        params["messageId"] = message_id
+      end
+      if notification
+        params["notification"] = notification
+      end
+      if recipient
+        params["recipient"] = recipient
+      end
+      res = @session.send(KEY, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+
+    def get(message_id:)
+      path = "#{KEY}/#{message_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def get_history(message_id:, type: nil)
+      path ="#{KEY}/#{message_id}/history"
+      params = {}
+      if type
+        params["type"] = type
+      end
+      res = @session.send(path, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+  end
+end

data/lib/trycourier/profiles.rb

@@ -0,0 +1,64 @@
+module Courier
+  class Profiles
+    KEY = "/profiles"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def get(recipient_id:)
+      path = "#{KEY}/#{recipient_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def get_subscriptions(recipient_id:, cursor: nil)
+      path = "#{KEY}/#{recipient_id}/subscriptions"
+
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+
+      res = @session.send(path, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+
+    def add(recipient_id:, profile:)
+      replace(recipient_id: recipient_id, profile: profile)
+    end
+
+    def replace(recipient_id:, profile:)
+      path = "#{KEY}/#{recipient_id}"
+
+      payload = {
+        'profile': profile
+      }
+
+      res = @session.send(path, "PUT", body: payload)
+      ErrorHandler.check_err_non_json(res)
+    end
+
+    def merge(recipient_id:, profile:, idempotency_key: nil)
+      path = "#{KEY}/#{recipient_id}"
+      payload = {
+        'profile': profile
+      }
+      headers = {}
+      if idempotency_key
+        headers["Idempotency-Key"] = idempotency_key
+      end
+      res = @session.send(path, "POST", body: payload, headers: headers)
+      ErrorHandler.check_err(res)
+    end
+
+    def patch(recipient_id:, operations:)
+      path = "#{KEY}/#{recipient_id}"
+      payload = {
+        'patch': operations
+      }
+      res = @session.send(path, "PATCH", body: payload)
+      ErrorHandler.check_err(res)
+    end
+  end
+end

data/lib/trycourier/session.rb

@@ -0,0 +1,81 @@
+require "net/http"
+require "json"
+require "openssl"
+
+module Courier
+  class CourierAPISession
+
+    def initialize(base_url)
+      @base_url = base_url
+    end
+
+    def init_token_auth(auth_token)
+      @auth_token = "Bearer #{auth_token}"
+      @auth_method = "token"
+    end
+
+    def init_basic_auth(username, password)
+      @username = username
+      @password = password
+      @auth_method = "basic"
+    end
+
+    def send(path, method, params: nil, body: nil, headers: nil)
+      uri = URI.parse(@base_url + path.to_s)
+      if params
+        uri.query = URI.encode_www_form(params)
+      end
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+      req = case method
+      when "GET"
+        Net::HTTP::Get.new(uri)
+      when "POST"
+        Net::HTTP::Post.new(uri)
+      when "PUT"
+        Net::HTTP::Put.new(uri)
+      when "PATCH"
+        Net::HTTP::Patch.new(uri)
+      when "DELETE"
+        Net::HTTP::Delete.new(uri)
+      else
+        Net::HTTP::Get.new(uri)
+      end
+
+      case @auth_method
+      when "token"
+        req["authorization"] = @auth_token
+      when "basic"
+        req.basic_auth @username, @password
+      end
+
+      req["content-type"] = "application/json"
+      req["User-Agent"] = "courier-ruby/#{Courier::VERSION}"
+
+      if body
+        req.body = body.to_json
+      end
+
+      if headers
+        headers.each do |k, v|
+          req.add_field(k.to_s, v.to_s)
+        end
+      end
+
+      http.request(req)
+    end
+
+    def is_authenticated
+      if !@auth_method.nil?
+        true
+      else
+        false
+      end
+    end
+
+    #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.0.2"
+  VERSION = "1.1.0"
 end

data/trycourier.gemspec

@@ -1,15 +1,15 @@
-require_relative 'lib/trycourier/version'
+require_relative "lib/trycourier/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "trycourier"
-  spec.version       = Courier::VERSION
-  spec.authors       = ["Courier"]
-  spec.email         = ["support@trycourier.com"]
+  spec.name = "trycourier"
+  spec.version = Courier::VERSION
+  spec.authors = ["Courier"]
+spec.email = ["support@courier.com"]
 
-  spec.summary       = %q{Wraps calls to the Courier REST API}
-  spec.description   = %q{Courier is the smartest way to design & deliver notifications. Design your notifications once, deliver them to any channel through one API.}
-  spec.homepage      = "https://github.com/trycourier/courier-ruby"
-  spec.license       = "MIT"
+  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."
+  spec.homepage = "https://github.com/trycourier/courier-ruby"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
@@ -20,10 +20,13 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock", ">=1.24.2"
 end

metadata

@@ -1,28 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Courier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
-dependencies: []
+date: 2021-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.2
 description: Courier is the smartest way to design & deliver notifications. Design
   your notifications once, deliver them to any channel through one API.
 email:
-- support@trycourier.com
+- support@courier.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -31,6 +60,13 @@ files:
 - bin/console
 - bin/setup
 - lib/trycourier.rb
+- lib/trycourier/brands.rb
+- lib/trycourier/events.rb
+- lib/trycourier/exceptions.rb
+- lib/trycourier/lists.rb
+- lib/trycourier/messages.rb
+- lib/trycourier/profiles.rb
+- lib/trycourier/session.rb
 - lib/trycourier/version.rb
 - trycourier.gemspec
 homepage: https://github.com/trycourier/courier-ruby
@@ -56,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Wraps calls to the Courier REST API

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.4