cakemail-next-gen 1.0.0

data/lib/cakemail/contact.rb

@@ -0,0 +1,57 @@
+module Cakemail
+  # @attr [String]          email         Email of the contact
+  # @attr [String]          status        Status ex. "active"
+  # @attr [Integer]         subscribed_on Date of subscription (timestamp)
+  # @attr [Integer]         bounces_count Number of bounces
+  # @attr [List]            list          List of the contact
+  class Contact < Base
+    attr_accessor :email, :status, :subscribed_on, :bounces_count
+
+    # Unsubscribe contact
+    #
+    # @return Contact
+    #
+    # @example
+    #           contact = Cakemail::Contact.find(1, parent: list)
+    #           contact.unsubscribe
+    def unsubscribe(options = {})
+      parent = get_parent(options)
+
+      path = "#{self.class.object_class.path}/#{id}/unsubscribe"
+      path = self.class.path_with_parent(path, parent) if parent
+
+      response = Cakemail.post path, {}.to_json
+
+      return response unless self.class.response_ok?(response)
+
+      self.class.instantiate_object(response["data"]) unless response.nil?
+    end
+
+    def self.parent_required
+      true
+    end
+
+    def self.no_parent_exception
+      raise Cakemail::Base::NoParentError,
+        "To request contacts, a list is required. Please use the parent option to pass it."
+    end
+
+    def self.object_class
+      Cakemail::Contact
+    end
+
+    def self.path
+      "contacts"
+    end
+
+    def initialize(options = {})
+      super(options)
+
+      @email         = options["email"]
+      @status        = options["status"]
+      @subscribed_on = options["subscribed_on"]
+      @bounces_count = options["bounces_count"]
+      @list          = parent
+    end
+  end
+end

data/lib/cakemail/list.rb

@@ -0,0 +1,35 @@
+module Cakemail
+  # @attr [String]         name        Name of the list
+  # @attr [String]         status      Ex. "active"
+  # @attr [String]         language    Ex. "fr_CA"
+  # @attr [Integer]        created_on  Timestamp Ex.1688012089
+  # @attr [Array<Contact>] contacts    The contacts of the list
+  class List < Base
+    attr_accessor :name, :status, :language, :created_on
+
+    def self.object_class
+      Cakemail::List
+    end
+
+    def self.path
+      "lists"
+    end
+
+    def contacts(options = {})
+      Cakemail::Contact.list(options.merge(parent: self))
+    end
+
+    def create_contact(params, options = {})
+      Cakemail::Contact.create(params, options.merge(parent: self))
+    end
+
+    def initialize(options = {})
+      super(options)
+
+      @name       = options["name"]
+      @status     = options["status"]
+      @language   = options["language"]
+      @created_on = options["created_on"]
+    end
+  end
+end

data/lib/cakemail/sender.rb

@@ -0,0 +1,30 @@
+module Cakemail
+  # @attr [String]        name                      Name of the sender
+  # @attr [String]        email                     Email of the sender
+  # @attr [Boolean]       confirmed                 Is sender confirmed
+  # @attr [Integer]       confirmed_on              Timestamp Ex.1688012089
+  # @attr [String]        language                  Ex. "fr_CA"
+  # @attr [Integer|null]  last_confirmation_sent_on Timestamp Ex.1688012089
+  class Sender < Base
+    attr_accessor :name, :email, :confirmed, :confirmed_on, :language, :last_confirmation_sent_on
+
+    def self.object_class
+      Cakemail::Sender
+    end
+
+    def self.path
+      "brands/default/senders"
+    end
+
+    def initialize(options = {})
+      super(options)
+
+      @name                      = options["name"]
+      @email                     = options["email"]
+      @confirmed                 = options["confirmed"]
+      @confirmed_on              = options["confirmed_on"]
+      @language                  = options["language"]
+      @last_confirmation_sent_on = options["last_confirmation_sent_on"]
+    end
+  end
+end

data/lib/cakemail/token.rb

@@ -0,0 +1,59 @@
+module Cakemail
+  # @attr [String]   access_token
+  # @attr [String]   refresh_token
+  # @attr [Integer]  expires_in
+  # @attr [String]   token_type
+  class Token < Base
+    attr_accessor :access_token, :refresh_token, :expires_in, :token_type
+
+    # Create new token with username and password provided
+    #
+    # @param username  [String]
+    # @param password  [String]
+    # @return [Token]
+    #
+    # @example
+    #           token = Cakemail::Token.create('toto', 'password123')
+    def self.create(username = nil, password = nil)
+      path = object_class.path
+
+      response = Cakemail.post path, authentication_params(username, password),
+{ "content-type": "application/x-www-form-urlencoded" }
+
+      if response_ok? response
+        instantiate_object response
+      else
+        response
+      end
+    end
+
+    def self.path
+      "token"
+    end
+
+    def self.object_class
+      Cakemail::Token
+    end
+
+    def initialize(options = {})
+      super(options)
+
+      @access_token  = options["access_token"]
+      @refresh_token = options["refresh_token"]
+      @expires_in    = options["expires_in"]
+      @token_type    = options["token_type"]
+    end
+
+    def self.authentication_params(username, password)
+      username = ENV["CAKEMAIL_USERNAME"] if username.nil?
+      password = ENV["CAKEMAIL_PASSWORD"] if password.nil?
+
+      {
+        grant_type: "password",
+        scopes: "user",
+        username: username,
+        password: password
+      }
+    end
+  end
+end

data/lib/cakemail/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cakemail
+  VERSION = "1.0.0"
+end

data/lib/cakemail.rb

@@ -0,0 +1,21 @@
+require_relative "cakemail/version"
+require_relative "cakemail/configuration"
+require_relative "cakemail/connection"
+
+module Cakemail
+  class Error < StandardError; end
+
+  def self.configure
+    yield Cakemail::Configuration
+  end
+
+  def self.config
+    Cakemail::Configuration
+  end
+
+  autoload :Base, "cakemail/base"
+  autoload :Token, "cakemail/token"
+  autoload :Sender, "cakemail/sender"
+  autoload :List, "cakemail/list"
+  autoload :Contact, "cakemail/contact"
+end

data/sig/cakemail.rbs

@@ -0,0 +1,4 @@
+module Cakemail
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/vcr_cassettes/contact_create.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.cakemail.dev/lists/8944823/contacts
+    body:
+      encoding: UTF-8
+      string: "<FILTERED>"
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:10 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '231'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"id":4,"object":"contact","created":true,"data":{"id":4,"email":"nathan.lopez042@gmail.com","status":"active","subscribed_on":1688792470,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[],"tags":[],"interests":[]}}'
+  recorded_at: Sat, 08 Jul 2023 05:01:10 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contact_create_from_list.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.cakemail.dev/lists/8944823/contacts
+    body:
+      encoding: UTF-8
+      string: "<FILTERED>"
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:11 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '231'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"id":4,"object":"contact","created":true,"data":{"id":4,"email":"nathan.lopez042@gmail.com","status":"active","subscribed_on":1688792470,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[],"tags":[],"interests":[]}}'
+  recorded_at: Sat, 08 Jul 2023 05:01:11 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contact_unsubscribe.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.cakemail.dev/lists/8944823/contacts/4/unsubscribe
+    body:
+      encoding: UTF-8
+      string: "<FILTERED>"
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:13 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '229'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"object":"contact","subscribed":false,"data":{"id":4,"email":"1688792472@gmail.com","status":"unsubscribed","subscribed_on":1688792470,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[],"tags":[],"interests":[]}}'
+  recorded_at: Sat, 08 Jul 2023 05:01:13 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contact_update.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://api.cakemail.dev/lists/8944823/contacts/4
+    body:
+      encoding: UTF-8
+      string: "<FILTERED>"
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:12 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '226'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"id":4,"object":"contact","updated":true,"data":{"id":4,"email":"1688792472@gmail.com","status":"active","subscribed_on":1688792470,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[],"tags":[],"interests":[]}}'
+  recorded_at: Sat, 08 Jul 2023 05:01:12 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contacts_all_without_error.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.cakemail.dev/lists/8944823/contacts?page=1&per_page=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:10 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '101'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"pagination":{"count":null,"page":1,"per_page":50,"cursor":{"previous":null,"next":null}},"data":[]}'
+  recorded_at: Sat, 08 Jul 2023 05:01:10 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contacts_delete.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api.cakemail.dev/lists/8944823/contacts/4
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:14 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '42'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"id":4,"object":"contact","deleted":true}'
+  recorded_at: Sat, 08 Jul 2023 05:01:15 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contacts_for_deletation.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.cakemail.dev/lists/8944823/contacts?page=1&per_page=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:14 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '283'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"pagination":{"count":null,"page":1,"per_page":50,"cursor":{"previous":null,"next":null}},"data":[{"id":4,"email":"1688792472@gmail.com","status":"unsubscribed","subscribed_on":1688792470,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[],"tags":[],"interests":[]}]}'
+  recorded_at: Sat, 08 Jul 2023 05:01:14 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contacts_for_unsubscribe.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.cakemail.dev/lists/8944823/contacts?page=1&per_page=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:13 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '277'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"pagination":{"count":null,"page":1,"per_page":50,"cursor":{"previous":null,"next":null}},"data":[{"id":4,"email":"1688792472@gmail.com","status":"active","subscribed_on":1688792470,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[],"tags":[],"interests":[]}]}'
+  recorded_at: Sat, 08 Jul 2023 05:01:13 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contacts_for_update.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.cakemail.dev/lists/8944823/contacts?page=1&per_page=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:12 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '282'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"pagination":{"count":null,"page":1,"per_page":50,"cursor":{"previous":null,"next":null}},"data":[{"id":4,"email":"nathan.lopez042@gmail.com","status":"active","subscribed_on":1688792470,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[],"tags":[],"interests":[]}]}'
+  recorded_at: Sat, 08 Jul 2023 05:01:12 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/contacts_lists.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.cakemail.dev/lists?page=1&per_page=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.7
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer <TOKEN_PLACEHOLDER>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 08 Jul 2023 05:01:09 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '583'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"pagination":{"count":null,"page":1,"per_page":50},"data":[{"id":8944823,"name":"Liste
+        de Nathan Lopez","status":"active","language":"fr_CA","created_on":1688012089,"default_sender":{"name":"Nathan
+        Lopez","email":"nathan.lopez042@gmail.com"}},{"id":8947181,"name":"Test","status":"active","language":"fr_FR","created_on":1688445887,"default_sender":{"name":"Nathan
+        Lopez","email":"nathan.lopez042@gmail.com"}},{"id":8947185,"name":"New name","status":"active","language":"fr_CA","created_on":1688447179,"default_sender":{"name":"Nathan
+        Lopez","email":"nathan.lopez042@gmail.com"}}]}'
+  recorded_at: Sat, 08 Jul 2023 05:01:09 GMT
+recorded_with: VCR 6.2.0