sfmc_emailer 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448eb69f87f9a77282d4dc1c57b5e879e4de26f9c96b81846110e149fdf470d6
-  data.tar.gz: c38d4bf42c04c4f57f073d149378f8cb0607de54481808ad08ecb69e33db433a
+  metadata.gz: 1adf9b8e0dad89341a1112c11f39d4d3a941ac4939aa9765a903b3110ee733fc
+  data.tar.gz: 7d16ea5996dfd53e530a96c6017a9bb26151adb44c8ca7a6f9eb81c6ecb2f1f1
 SHA512:
-  metadata.gz: 172ec43624074ec05f0aec9409149f1cb1502e97c222fe6c6763bae9f7d1992e1a9bc6322337a4d951bd8f3f9a0ad341a73e727a18d7045f67a57ed2d6cb3955
-  data.tar.gz: ddfb0a5d3b071aa28cb5c49c8ab7fcf2058e0a82e863c79b88037a1a6c72b106f2727d5c3c08ec7884e0d708d288acf0d2a84193ee7ff5be8b6c6a846789efa9
+  metadata.gz: 6f707821530e877188f0aa5a1ec4fc67a855aff8340387d40ddf08f005cf2cd9f595a5ee2ec34095819a8c09763585adefbe574618a91487ae33b51c72ad344a
+  data.tar.gz: 72a0150f271142c8be252b58da1a35e62564ff675b8e618d932e690db211de1965fbb2224f098bfca21c440c4a7fb8261165df22e2f27b05a348cbf61500b6df

data/README.md

@@ -0,0 +1,60 @@
+# Salesforce Marketing Cloud (SFMC) Emailer
+Supports sending both transactional & triggered send (marketing) emails
+
+## How to use
+### Config
+```ruby
+# config/initializers/sfmc.rb
+
+SFMC::SFMCBase.init(
+  subdomain: 'mchf5m7e9wjxn-f2xxn6l5ul1x0q',
+  client_id: 'client_id',
+  client_secret: 'super_secret',
+  default_send_classification: 'Default Send Classification - 293',
+  default_subscriber_list: 'All Subscribers - 9136',
+  default_data_extension: 'C4530F44-5C72-4113-8EA0-5210C9222455',
+  default_bcc: ['example@example.com'] # optional
+)
+```
+
+### Transactional Emails
+
+```ruby
+SFMC::Transactional::Email.send_email(
+  email: 'email_name',
+  to: 'example@example.com',
+  params: { # Each attribute should be present in the corresponding data extension in SFMC
+    First_Name: "Bob",
+  }
+)
+```
+
+### Triggered Send Emails
+
+```ruby
+SFMC::Triggered::Email.send_email(
+  email: 'email_name',
+  to: 'example@example.com',
+  params: { # Each attribute should be present in the corresponding data extension in SFMC
+    First_Name: "Bob",
+  }
+)
+```
+
+<b>Note:</b> Changes to transactional emails only take effect once its send definition is refreshed:
+```ruby
+SFMC::Transactional::SendDefinition.refresh 'email_name'
+```
+
+### Creating a Transactional Email Send Definition
+<b>Note:</b> The first time an email is sent a send definition for it will be created with the default values. This definition take about a minute to actually become active, so try sending again after that. You can also manually create a send definition using:
+```ruby
+SFMC::Transactional::SendDefinition(
+  definition_key: 'definition_key', 
+  customer_key: 'customer_key', 
+  send_classification: 'send_classification', 
+  subscriber_list: 'subscriber_list', 
+  data_extension: 'data_extension', 
+  bcc: ['example@example.com'] # optional
+)
+```

data/lib/sfmc/errors.rb

@@ -1,13 +1,11 @@
 module SFMC
   module Errors
-    # rubocop:disable Layout/EmptyLineBetweenDefs
     class BadRequestError < StandardError; end
     class UnauthorizedError < StandardError; end
     class ForbiddenError < StandardError; end
     class NotFoundError < StandardError; end
     class UnprocessableEntityError < StandardError; end
     class APIError < StandardError; end
-    # rubocop:enable Layout/EmptyLineBetweenDefs
 
     def error_class(code)
       case code.to_i

data/lib/sfmc/sfmc_base.rb

@@ -29,7 +29,7 @@ module SFMC
         end
 
         received = method(http_method).call(endpoint, body: params, headers: SFMCBase.headers)
-        payload = OpenStruct.new(received)
+        payload = JSON.parse(received.to_json, object_class: OpenStruct)
 
         return payload if received.response.is_a? Net::HTTPSuccess
 

data/lib/sfmc/transactional/email.rb

@@ -6,16 +6,16 @@ module SFMC
       # If an email hasn't ever been sent then we will not have an email send definition
       # We're waiting a minute for the send definition to fully be initialized
       # Thankfully this is a rare edge case
-      def self.create_email_send_definition_and_retry(name, to, params)
+      def self.create_email_send_definition(name)
         asset = SFMC::Assets::Asset.query("name eq '#{name}'", 'customerKey')
         raise SFMC::Errors::BadRequestError, "No emails found with name #{name}" if asset.count == 0
 
         consumer_key = asset.items.first["customerKey"]
 
-        SFMC::Transactional::SendDefinition.create(name, consumer_key)
+        SFMC::Transactional::SendDefinition.create(definition_key: name, customer_key: consumer_key)
 
         # Even though the send def is "Active" it won't function for another minute
-        delay(run_at: 70.seconds.from_now).send_email(email: name, to: to, params: params, create_email_if_needed: false)
+        pp "Email send definition inactive. Try again in a minute"
       end
 
       # Will attempt once to create a new email send definition if one isn't found
@@ -43,7 +43,7 @@ module SFMC
         rescue SFMC::Errors::NotFoundError
           raise unless create_email_if_needed
 
-          create_email_send_definition_and_retry(email, to, params)
+          create_email_send_definition(email)
         end
       end
     end

data/lib/sfmc/transactional/send_definition.rb

@@ -9,12 +9,12 @@ module SFMC
       end
 
       def self.create(
-        definition_key,
-        customer_key,
-        send_classification = nil,
-        subscriber_list = nil,
-        data_extension = nil,
-        bcc = []
+        definition_key:,
+        customer_key:,
+        send_classification: nil,
+        subscriber_list: nil,
+        data_extension: nil,
+        bcc: []
       )
         params = {
           classification: SFMCBase.default_send_classification || send_classification,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfmc_emailer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Angel Ruiz-Bates
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
 description: API wrapper for Salesforce Marketing Cloud's Transactional and Triggered
   Send APIs
 email: angeljrbt@gmail.com
@@ -31,6 +57,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/sfmc/assets/asset.rb
 - lib/sfmc/authentication.rb
 - lib/sfmc/contacts/contact_key.rb