trycourier 1.0.2 → 1.4.0

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/automations.rb

@@ -0,0 +1,67 @@
+module Courier
+  class Automations
+    KEY = "/automations"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def invoke(automation:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil)
+      path = "#{KEY}/invoke"
+      payload = {
+        "automation": automation
+      }
+
+      if brand
+        payload["brand"] = brand
+      end
+
+      if data
+        payload["data"] = data
+      end
+
+      if profile
+        payload["profile"] = profile
+      end
+
+      if recipient
+        payload["recipient"] = recipient
+      end
+
+      if template
+        payload["template"] = template
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: {})
+      ErrorHandler.check_err(res)
+    end
+
+    def invoke_template(template_id:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil)
+      path = "#{KEY}/#{template_id}/invoke"
+      payload = {}
+
+      if brand
+        payload["brand"] = brand
+      end
+
+      if data
+        payload["data"] = data
+      end
+
+      if profile
+        payload["profile"] = profile
+      end
+
+      if recipient
+        payload["recipient"] = recipient
+      end
+
+      if template
+        payload["template"] = template
+      end
+
+      res = @session.send(path, "POST", body: payload, headers: {})
+      ErrorHandler.check_err(res)
+    end
+  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/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/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,39 @@
+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,80 @@
+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.4.0"
 end