cakemail-next-gen 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95edcd5ef79bdd5c936ed0e1796dea3e69a2c0b9c91b7e8c22d4a96a35bdc022
-  data.tar.gz: 6c9771c0061bd3268833293db53f3b5caecadbf09389303333fa4056674cef11
+  metadata.gz: c93703fecdffbf27033542781c2c831f09b21b600f23b4ffaaa70f8e215f93e8
+  data.tar.gz: 84aaa4a0853645e060ec6701743138fde65b4fd416d28cf959f2ae76c47504a7
 SHA512:
-  metadata.gz: b7cfcf78af7aed0e39e83d6a507035631046aeeb7eec499b4cf23bbcadcf336ad76083bb5d64c73f65c6a98208a8667c83c421685c6b7785cdb5950a6d3a85cd
-  data.tar.gz: 06db8e184b081f991a2f35bc0ed76affd657a03b91a1545080d627b4a9f576ed261bdf58e02e13c13129e23c9443cbe2667cb681cd91972ba278e18767d7fc6a
+  metadata.gz: c16215bf239df9d1a494b2556bf211b61eadc8b3918b02b8281691c661afa65596809aac4721e6106152bef877e9a027d6fb25f4da0f373895693e7812e43cc7
+  data.tar.gz: d61aa75c0d3f929281445ff56c12f02992b55f128bae248f0f10915b7765eb61000287b90b526657fdda170b4d20c839110949d5cf3144cae3a54f2a9cf268d2

data/README.md

@@ -68,7 +68,7 @@ Here are some basic usage examples for managing lists:
 
 1. Fetching all lists:
 ```ruby
-lists = Cakemail::List.all
+lists = Cakemail::List.list
 lists.each do |list|
   puts "List ID: #{list.id}"
   puts "List Name: #{list.name}"
@@ -128,7 +128,7 @@ To retrieve all contacts in a given list, you can use the `list` method of the `
 
 ```ruby
 # Get lists
-lists = Cakemail::List.all
+lists = Cakemail::List.list
 
 # Retrieve all contacts in a list
 contacts = Cakemail::Contact.list(parent: lists.first)
@@ -192,3 +192,50 @@ contact = list.contacts.last
 contact.unsubscribe
 puts "Contact unsubscribed successfully."
 ```
+
+## Custom attributes
+
+Cakemail allows you to define custom attributes for your contacts. Here's how you can work with custom attributes:
+
+1. Get list of custom attributes from a list object:
+
+```ruby
+attributes = @list.custom_attributes
+
+attributes.each do |attribute|
+  puts "Attribute Name: #{attribute.name}"
+  puts "Attribute Type: #{attribute.type}"
+  # Additional attribute details can be accessed here
+end
+```
+
+2. Create a contact with custom attributes:
+
+```ruby
+attribute = @list.custom_attributes.first
+
+params = {
+  email: "nathan.lopez042@gmail.com",
+  custom_attributes: [
+    {
+      name: attribute.name,
+      value: "Nathan"
+    }
+  ]
+}
+
+contact = @list.create_contact(params)
+
+puts "Contact created successfully."
+puts "Email: #{contact.email}"
+puts "Status: #{contact.status}"
+puts "Custom Attribute: #{contact.custom_attributes.first['name']}: #{contact.custom_attributes.first['value']}"
+```
+
+You can create custom attributes on a list by using the `create` method of the `Cakemail::CustomAttributes` class. To do so, you need to provide the necessary information such as the name and type of the custom attribute. Here's an example code to create a text-type custom attribute with the name "firstname" on a given list:
+
+```ruby
+params = { name: "firstname", type: "text" }
+
+Cakemail::CustomAttributes.create(params, parent: @list)
+```

data/lib/cakemail/contact.rb

@@ -1,11 +1,12 @@
 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
+  # @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
+  # @attr [Array<Hash>]     custom_attributes List of the custom attributes (name: value)
   class Contact < Base
-    attr_accessor :email, :status, :subscribed_on, :bounces_count
+    attr_accessor :email, :status, :subscribed_on, :bounces_count, :custom_attributes
 
     # Unsubscribe contact
     #
@@ -47,11 +48,12 @@ module Cakemail
     def initialize(options = {})
       super(options)
 
-      @email         = options["email"]
-      @status        = options["status"]
-      @subscribed_on = options["subscribed_on"]
-      @bounces_count = options["bounces_count"]
-      @list          = parent
+      @email             = options["email"]
+      @status            = options["status"]
+      @subscribed_on     = options["subscribed_on"]
+      @bounces_count     = options["bounces_count"]
+      @custom_attributes = options["custom_attributes"]
+      @list              = parent
     end
   end
 end

data/lib/cakemail/custom_attribute.rb

@@ -0,0 +1,31 @@
+module Cakemail
+  # @attr [String]         name        Name of the list
+  # @attr [String]         type        Ex. "text", "integer"
+  class CustomAttributes < Base
+    attr_accessor :name, :type
+
+    def self.parent_required
+      true
+    end
+
+    def self.no_parent_exception
+      raise Cakemail::Base::NoParentError,
+        "To request custom attributes, a list is required. Please use the parent option to pass it."
+    end
+
+    def self.object_class
+      Cakemail::CustomAttributes
+    end
+
+    def self.path
+      "custom-attributes"
+    end
+
+    def initialize(options = {})
+      super(options)
+
+      @name = options["name"]
+      @type = options["type"]
+    end
+  end
+end

data/lib/cakemail/list.rb

@@ -19,6 +19,10 @@ module Cakemail
       Cakemail::Contact.list(options.merge(parent: self))
     end
 
+    def custom_attributes(options = {})
+      Cakemail::CustomAttributes.list(options.merge(parent: self))
+    end
+
     def create_contact(params, options = {})
       Cakemail::Contact.create(params, options.merge(parent: self))
     end

data/lib/cakemail/version.rb

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

data/lib/cakemail.rb

@@ -18,4 +18,5 @@ module Cakemail
   autoload :Sender, "cakemail/sender"
   autoload :List, "cakemail/list"
   autoload :Contact, "cakemail/contact"
+  autoload :CustomAttributes, "cakemail/custom_attribute"
 end

data/vcr_cassettes/attribute_create.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.cakemail.dev/lists/8944823/custom-attributes
+    body:
+      encoding: UTF-8
+      string: "<FILTERED>"
+    headers:
+      User-Agent:
+      - Faraday v2.7.10
+      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, 15 Jul 2023 04:42:46 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '98'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"name":"firstname","object":"attribute","created":true,"data":{"name":"firstname","type":"text"}}'
+  recorded_at: Sat, 15 Jul 2023 04:42:46 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/attribute_create_contact_with_custom_attribute.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.10
+      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, 15 Jul 2023 04:47:58 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '268'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      X-Krakend:
+      - Version 1.1.1
+      X-Krakend-Completed:
+      - 'false'
+    body:
+      encoding: UTF-8
+      string: '{"id":5,"object":"contact","created":true,"data":{"id":5,"email":"nathan.lopez042@gmail.com","status":"active","subscribed_on":1689396477,"last_bounce_type":"none","bounces_count":0,"custom_attributes":[{"name":"firstname","value":"Nathan"}],"tags":[],"interests":[]}}'
+  recorded_at: Sat, 15 Jul 2023 04:47:58 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/attributes_all_without_error.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.cakemail.dev/lists/8944823/custom-attributes?page=1&per_page=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.10
+      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, 15 Jul 2023 04:42:45 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '62'
+      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":[]}'
+  recorded_at: Sat, 15 Jul 2023 04:42:45 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/attributes_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.10
+      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, 15 Jul 2023 04:42:44 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, 15 Jul 2023 04:42:44 GMT
+recorded_with: VCR 6.2.0

data/vcr_cassettes/list_attributes.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.cakemail.dev/lists/8944823/custom-attributes?page=1&per_page=50
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v2.7.10
+      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, 15 Jul 2023 04:42:46 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '96'
+      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":[{"name":"firstname","type":"text"}]}'
+  recorded_at: Sat, 15 Jul 2023 04:42:46 GMT
+recorded_with: VCR 6.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cakemail-next-gen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nathan Lopez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-08 00:00:00.000000000 Z
+date: 2023-07-15 00:00:00.000000000 Z
 dependencies: []
 description: This library allows you to quickly and easily use the Cakemail Next-gen
   API via Ruby.
@@ -25,17 +25,23 @@ files:
 - README.md
 - Rakefile
 - cakemail.gemspec
+- gemfiles/cakemail-next-gen-1.0.0.gem
 - images/logo.png
 - lib/cakemail.rb
 - lib/cakemail/base.rb
 - lib/cakemail/configuration.rb
 - lib/cakemail/connection.rb
 - lib/cakemail/contact.rb
+- lib/cakemail/custom_attribute.rb
 - lib/cakemail/list.rb
 - lib/cakemail/sender.rb
 - lib/cakemail/token.rb
 - lib/cakemail/version.rb
 - sig/cakemail.rbs
+- vcr_cassettes/attribute_create.yml
+- vcr_cassettes/attribute_create_contact_with_custom_attribute.yml
+- vcr_cassettes/attributes_all_without_error.yml
+- vcr_cassettes/attributes_lists.yml
 - vcr_cassettes/contact_create.yml
 - vcr_cassettes/contact_create_from_list.yml
 - vcr_cassettes/contact_unsubscribe.yml
@@ -50,6 +56,7 @@ files:
 - vcr_cassettes/create_wrong_token.yml
 - vcr_cassettes/list.yml
 - vcr_cassettes/list_archive.yml
+- vcr_cassettes/list_attributes.yml
 - vcr_cassettes/list_contacts.yml
 - vcr_cassettes/list_create.yml
 - vcr_cassettes/list_delete.yml