workarea-emarsys 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94cf477df712c5d3c8a1b2151f48ef900faea02c58cb7f3fda832a5199d3b21b
-  data.tar.gz: f450274e16cbf9d7f3f1bc629b0eb9743537bb87b29b5d2bb7e0f20a862b24e5
+  metadata.gz: cbd86411c06a0d679c36fb94fd306cf4a59ae8e317942662c1876ac1ba55feff
+  data.tar.gz: 522f659b1fcc8f48fa121385f7fdceaeb22b3447a4a87549eed1da37a19ac5b6
 SHA512:
-  metadata.gz: f40bf6d8f666c3c478cace1a8e8e8d440bfc5bcb3189e44707954762140869731e0e4dff938949fefa520195909f5c8c560cb6d3aad5b8a739c6663bedc3d544
-  data.tar.gz: 7057465c102e2ad513dd8124fefaaa854d5021f317a21ecbffd41cf52051c74119219e5a0bc6290b60da094811e4c8bda5ddc313cd47935f9524a4150cea30a6
+  metadata.gz: 1db42cb6e397dae575fb79fb79abf911cad243121d0404ccc8f9faa62abb21ee1f97998806f6cfe22d264ec6fc371873d9260af20228e03b5302b38f3b7b152e
+  data.tar.gz: 1e1c2c2a035eb09d7ca79720501ab8b38108a2cf06818a5ba9e830e0308b5f945f7cf453a7a994d8ea90444fe197017730d410694a4b674d10c2379fed146e42

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+Workarea Emarsys 2.0.0 (2020-01-21)
+--------------------------------------------------------------------------------
+
+*   Update Emarsys to use public API's
+
+    Commit removes escher request signing and uses the public APIs. Sets
+    the gateway to production by default because sandboxes are only issues by special
+    request.
+    Jeff Yucis
+
+
+
 Workarea Emarsys 1.1.0 (2019-11-26)
 --------------------------------------------------------------------------------
 

data/Gemfile

@@ -3,7 +3,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
-gem 'workarea', github: 'workarea-commerce/workarea'
+gem 'workarea', github: 'workarea-commerce/workarea', branch: 'v3.5-stable'
 
 group :test do
   gem 'simplecov', require: false

data/README.md

@@ -35,17 +35,17 @@ Configuration
 --------------------------------------------------------------------------------
 The following fields can be edited via the admin site settings:
 
-1. **Production:** A toggle switch to set the integration into production mode, defaults to false.
-2. **Customer ID:** The customer ID of account. Ask your Emarsys account manager for this value.
-3. **Merchant ID:** The merchant ID of the Emarsys account. This value is required for the Web Extend Analytics Integration
+1. **Production:** A toggle switch to set the integration into production mode, defaults to true.
+2. **Merchant ID:** The merchant ID of the Emarsys account. This value is required for the Web Extend Analytics Integration
 
 
-The contact and sales data APIs require different access keys that require storage in the secrets file.
+The contact and sales data APIs require different access keys that require storage in the secrets file. You can generate a user for the contact API in the Emarsys admin.
 
 Add the following to your secrets:
 
     emarsys:
-      secret_key: YOUR_SECRET_KEY_HERE
+      user_name: YOUR_API_USER_NAME_HERE
+      secret_key: YOUR_API_SECRET_KEY_HERE
     emarsys_sales:
       api_token: YOUR_TOKEN_HERE
 

data/Rakefile

@@ -37,10 +37,9 @@ task :release do
   Rake::Task['workarea:changelog'].execute
   system 'git add CHANGELOG.md'
   system 'git commit -m "Update CHANGELOG"'
-  system 'git push origin HEAD'
 
   system "git tag -a v#{Workarea::Emarsys::VERSION} -m 'Tagging #{Workarea::Emarsys::VERSION}'"
-  system 'git push --tags'
+  system 'git push origin HEAD --follow-tags'
 
   system "gem build workarea-emarsys.gemspec"
   system "gem push workarea-emarsys-#{Workarea::Emarsys::VERSION}.gem"

data/app/lib/workarea/emarsys/gateway.rb

@@ -1,33 +1,26 @@
 module Workarea
   module Emarsys
     class Gateway
-      attr_reader :secret_key, :customer_id, :options
+      attr_reader :secret_key, :user_name, :options
 
-      def initialize(secret_key, customer_id, options = {})
+      def initialize(secret_key, user_name, options = {})
         @secret_key = secret_key
-        @customer_id = customer_id
+        @user_name = user_name
         @options = options
       end
 
       def create_contact(attrs)
-        base_uri = "/api/v2/internal/#{customer_id}/contact/"
+        base_uri = "/api/v2/contact/"
         params = { create_if_not_exists: 1 }
         query_values = "?" + params.to_query
 
         path = base_uri + query_values
 
-        request_data = sign_request('put', path, attrs.to_json)
-
         response = connection.put do |req|
           req.url path
           req.params = params
           req.body = attrs.to_json
-
-          request_data[:headers].each do |k, v|
-            req.headers[k] = v
-          end
         end
-
         Response.new(response)
       end
 
@@ -39,36 +32,28 @@ module Workarea
             open_timeout: Workarea::Emarsys.config.open_timeout
           }
 
-          Faraday.new(url: rest_endpoint, request: request_timeouts)
-        end
-
-        def sign_request(method, path, body = nil)
-          escher = Escher::Auth.new('eu/suite/ems_request', escher_options)
-
-          request_data = {
-            method: method.upcase,
-            uri: path,
-            body: body,
-            headers: [['Content-Type', 'application/json'], ['host', host]]
+          headers = {
+            "Content-Type" => "application/json",
+            "Accept"       => "application/json",
+            "X-WSSE" => auth_header
           }
 
-          escher.sign!(request_data, { api_key_id: escher_key, api_secret: secret_key })
-
-          request_data
+          Faraday.new(url: rest_endpoint, request: request_timeouts, headers: headers)
         end
 
-        def escher_options
-          {
-            algo_prefix: 'EMS',
-            vendor_key: 'EMS',
-            auth_header_name: 'X-Ems-Auth',
-            date_header_name: 'X-Ems-Date',
-            current_time: Time.current
-          }
-        end
+        def auth_header
+          nonce = SecureRandom.base64(32).first(32)
+          timestamp = Time.now.utc.iso8601
+
+          password_digest = Base64.encode64(Digest::SHA1.new.hexdigest(nonce + timestamp + secret_key)).strip
 
-        def escher_key
-          Workarea.config.emarsys.escher_key
+          header = 'UsernameToken ' +
+            "Username=\"#{user_name}\", " +
+            "PasswordDigest=\"#{password_digest}\", " +
+            "Nonce=\"#{nonce}\", " +
+            "Created=\"#{timestamp}\""
+
+          header
         end
 
         def rest_endpoint
@@ -83,12 +68,8 @@ module Workarea
           end
         end
 
-        def uri_base
-          "/api/v2/internal/#{customer_id}/"
-        end
-
          def test?
-          (options.has_key?(:test) ? options[:test] : true)
+          (options.has_key?(:test) ? options[:test] : false)
         end
     end
   end

data/app/workers/workarea/emarsys/save_order.rb

@@ -10,8 +10,6 @@ module Workarea
       )
 
       def perform(id)
-        return unless Emarsys.customer_id.present?
-
         order = Workarea::Order.find(id)
         address = Workarea::Payment.find(order.id).address
 

data/app/workers/workarea/emarsys/save_user.rb

@@ -10,14 +10,11 @@ module Workarea
       )
 
       def perform(id)
-        return unless Emarsys.customer_id.present?
-
         user = Workarea::User.find(id)
 
         attrs = Emarsys::Contact.new(user, { address: address(user), contact_from: 'user' }).to_h
 
         response = gateway.create_contact(attrs)
-
         user.set(emarsys_exported_at: Time.current)
         external_id = response.body["data"]["id"] || response.body["data"]["ids"].first
         user.set(emarsys_external_id: external_id)

data/config/initializers/fields.rb

@@ -1,11 +1,5 @@
 Workarea::Configuration.define_fields do
   fieldset 'Emarsys', namespaced: false do
-    field 'Customer ID',
-      type: :string,
-      default: '',
-      description: 'Emarsys customer ID. Required for using API endpoints. Contact your Emarays Support team to get this value.',
-      allow_blank: true
-
     field 'Merchant ID',
       type: :string,
       default: '',
@@ -13,9 +7,9 @@ Workarea::Configuration.define_fields do
       allow_blank: true
 
     field 'Emarsys Production API',
-      id: :emarsys_production,
+      id: :emarsys_production_api,
       type: :boolean,
-      default: false,
+      default: true,
       description: 'Whether to use the production API endpoints.'
   end
 end

data/config/initializers/workarea.rb

@@ -1,10 +1,5 @@
 Workarea.configure do |config|
   config.emarsys ||= ActiveSupport::Configurable::Configuration.new
-
-  config.emarsys.escher_key = 'suite_workarea_v1'
-  config.emarsys.scope = 'eu/workarea/ems_request'
-  config.emarsys.partner_scope = 'eu/suite/ems_request'
-
   config.emarsys.export_interval = 1.day
 
   config.emarsys.api_timeout = 3

data/config/locales/en.yml

@@ -13,7 +13,6 @@ en:
           title: Emarsys Configuration
           button: Save Emarsys Configuration
           production: Use Production API?
-          customer_id: Customer ID
           merchant_id: Merchant ID
           api_key: API Key
           sales_api_key: Sales Data API Key
@@ -22,7 +21,6 @@ en:
           help:
             api_key: API Key for customer synchronization. Can be found in the Emarsys adminstration system.
             sales_api_key: API Key for order file synchronization. Can be found in the Emarsys adminstration system.
-            production: Use the Live/Production API endpoints. Turn this on when ready to go live with your integration.
-            customer_id: Emarsys customer ID. Required for using API endpoints. Contact your Emarays Support team to get this value.
+            production: Use the Live/Production API endpoints.
             merchant_id: Emarsys merchant ID. This value is required for the Web Extend data integration.
 

data/lib/workarea/emarsys/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Emarsys
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/workarea/emarsys.rb

@@ -1,12 +1,10 @@
 require 'workarea'
 require 'workarea/storefront'
 require 'workarea/admin'
-require 'workarea/google_product_feed'
 
 require 'workarea/emarsys/engine'
 require 'workarea/emarsys/version'
-
-require 'escher'
+require 'workarea/google_product_feed'
 
 module Workarea
   module Emarsys
@@ -22,18 +20,18 @@ module Workarea
       credentials[:secret_key]
     end
 
-    def self.api_token
-      sales_data_credentials[:api_token]
-    end
-
-    def self.customer_id
-      Workarea.config.customer_id
+    def self.user_name
+      credentials[:user_name]
     end
 
     def self.merchant_id
       Workarea.config.merchant_id
     end
 
+    def self.api_token
+      sales_data_credentials[:api_token]
+    end
+
     def self.config
       Workarea.config.emarsys
     end
@@ -44,7 +42,7 @@ module Workarea
     # @return [Emarsys::Gateway]
     def self.gateway
       if credentials.present?
-        Emarsys::Gateway.new(secret_key, Emarsys.customer_id, { test: !Workarea.config.emarsys_production_api })
+        Emarsys::Gateway.new(secret_key, user_name, { test: !Workarea.config.emarsys_production_api })
       else
         Emarsys::BogusGateway.new
       end

data/test/lib/workarea/emarsys/gateway_test.rb

@@ -9,13 +9,13 @@ module Workarea
         customer_id = '215861890'
         Workarea::Emarsys::Gateway.new(
           Rails.application.secrets.emarsys[:secret_key],
-          customer_id
+          Rails.application.secrets.emarsys[:user_name]
         )
       end
 
       def test_create_contact
         VCR.use_cassette("emarsys/add_contact", match_requests_on: [:method, :uri]) do
-          attrs = { contacts: [ "3" => "jyucis-emarsys@workarea.com" ] }
+          attrs = { contacts: [ "3" => "jyucis-emarsys-test@workarea.com" ] }
           response = gateway.create_contact(attrs)
 
           assert(response.success?)

data/test/support/workarea/emarsys_api_config.rb

@@ -8,7 +8,8 @@ module Workarea
 
     def set_key
       Rails.application.secrets.emarsys = {
-        secret_key: "a"
+        secret_key: "a",
+        user_name: "b"
       }
     end
 

data/test/vcr_cassettes/emarsys/add_contact.yml

@@ -2,24 +2,22 @@
 http_interactions:
 - request:
     method: put
-    uri: https://api-proxy.s.emarsys.com/api/v2/internal/215861890/contact/?create_if_not_exists=1
+    uri: https://api.emarsys.net/api/v2/contact/?create_if_not_exists=1
     body:
       encoding: UTF-8
-      string: '{"contacts":[{"3":"jyucis-emarsys@workarea.com"}]}'
+      string: '{"contacts":[{"3":"jyucis-emarsys-test@workarea.com"}]}'
     headers:
-      User-Agent:
-      - Faraday v0.15.4
       Content-Type:
       - application/json
-      X-Ems-Date:
-      - 20190313T181243Z
-      X-Ems-Auth:
-      - EMS-HMAC-SHA256 Credential=suite_workarea_v1/20190313/eu/suite/ems_request,
-        SignedHeaders=host;x-ems-date, Signature=a
+      Accept:
+      - application/json
+      X-Wsse:
+      - UsernameToken Username="un", PasswordDigest="PW",
+        Nonce="d36e316282959a9ed4c89851497a717f", Created="2020-01-15T16:41:44Z"
+      User-Agent:
+      - Faraday v0.15.4
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
   response:
     status:
       code: 200
@@ -30,38 +28,36 @@ http_interactions:
       Content-Length:
       - '74'
       Content-Type:
-      - application/json
+      - text/html; charset=utf-8
       Date:
-      - Wed, 13 Mar 2019 18:12:48 GMT
+      - Wed, 15 Jan 2020 16:41:44 GMT
       Pragma:
       - no-cache
       Server:
-      - openresty/1.11.2.1
+      - Apache
       Strict-Transport-Security:
-      - max-age=86400; includeSubDomains; preload
+      - max-age=15552000; includeSubDomains; preload
       Vary:
       - Accept-Encoding
       Via:
       - kong/0.14.1
       X-Emarsys-Request-Id:
-      - 5fa693f7-8fe3-4b50-a766-7488acf6c08d#17813
-      X-Fe:
-      - suitesapipxy01.emarsys.at
+      - 337be0c0-317b-4e6a-a934-0593170e4d31#1295874
       X-Kong-Proxy-Latency:
-      - '18'
+      - '2'
       X-Kong-Upstream-Latency:
-      - '737'
+      - '110'
       X-Ratelimit-Limit:
-      - '200'
+      - '1000'
       X-Ratelimit-Remaining:
-      - '199'
+      - '999'
       X-Ratelimit-Reset:
-      - '1552500780'
+      - '1579106564'
       X-Suite-Response-Time:
-      - '697'
+      - '69'
     body:
       encoding: ASCII-8BIT
-      string: '{"replyCode":0,"replyText":"OK","data":{"ids":[500767919]}}'
+      string: '{"replyCode":0,"replyText":"OK","data":{"ids":[106504559]}}'
     http_version:
-  recorded_at: Wed, 13 Mar 2019 18:12:48 GMT
+  recorded_at: Wed, 15 Jan 2020 16:41:44 GMT
 recorded_with: VCR 2.9.3

data/test/workers/workarea/emarsys/save_user_test.rb

@@ -3,7 +3,6 @@ require 'test_helper'
 module Workarea
   class Emarsys::SaveUserTest < TestCase
     def test_save_user_sets_time_stamp
-      Workarea.config.customer_id = '1234'
       user = create_user
 
       Workarea::Emarsys::SaveUser.new.perform(user.id)
@@ -13,17 +12,5 @@ module Workarea
       assert(user.emarsys_exported_at.present?)
       assert(user.emarsys_external_id.present?)
     end
-
-    def test_save_user_does_nothing_without_customer_id_set
-      Workarea.config.customer_id = nil
-      user = create_user
-
-      Workarea::Emarsys::SaveUser.new.perform(user.id)
-
-      user.reload
-
-      refute(user.emarsys_exported_at.present?)
-      refute(user.emarsys_external_id.present?)
-    end
   end
 end

data/workarea-emarsys.gemspec

@@ -19,6 +19,5 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'workarea', '>=  3.5.x'
   s.add_dependency 'workarea-google_product_feed', '~> 3.x'
-  s.add_dependency "escher"
   s.add_dependency "faraday", "~> 0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-emarsys
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeff Yucis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-26 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.x
-- !ruby/object:Gem::Dependency
-  name: escher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +164,6 @@ files:
 - test/teaspoon_env.rb
 - test/test_helper.rb
 - test/vcr_cassettes/emarsys/add_contact.yml
-- test/vcr_cassettes/emarsys/get_contact.yml
 - test/vcr_cassettes/emarsys/sales/send_data.yml
 - test/workers/workarea/emarsys/save_user_test.rb
 - test/workers/workarea/emarsys/sync_orders_test.rb
@@ -202,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Emarsys email service provider

data/test/vcr_cassettes/emarsys/get_contact.yml

@@ -1,129 +0,0 @@
----
-http_interactions:
-- request:
-    method: put
-    uri: https://api-proxy.s.emarsys.com/api/v2/internal/215861890/contact/?create_if_not_exists=1
-    body:
-      encoding: UTF-8
-      string: '{"contacts":[{"3":"jyucis-emarsys-get@workarea.com"}]}'
-    headers:
-      User-Agent:
-      - Faraday v0.15.4
-      Content-Type:
-      - application/json
-      X-Ems-Date:
-      - 20190313T195319Z
-      X-Ems-Auth:
-      - EMS-HMAC-SHA256 Credential=suite_workarea_v1/20190313/eu/suite/ems_request,
-        SignedHeaders=host;x-ems-date, Signature=b
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - max-age=0, no-cache, no-store, must-revalidate
-      Content-Length:
-      - '76'
-      Content-Type:
-      - application/json
-      Date:
-      - Wed, 13 Mar 2019 19:53:20 GMT
-      Pragma:
-      - no-cache
-      Server:
-      - openresty/1.11.2.1
-      Strict-Transport-Security:
-      - max-age=86400; includeSubDomains; preload
-      Vary:
-      - Accept-Encoding
-      Via:
-      - kong/0.14.1
-      X-Emarsys-Request-Id:
-      - 71e137ab-b703-4f06-8a33-acf9b8a1097a#4171
-      X-Fe:
-      - suitesapipxy01.emarsys.at
-      X-Kong-Proxy-Latency:
-      - '17'
-      X-Kong-Upstream-Latency:
-      - '697'
-      X-Ratelimit-Limit:
-      - '200'
-      X-Ratelimit-Remaining:
-      - '199'
-      X-Ratelimit-Reset:
-      - '1552506840'
-      X-Suite-Response-Time:
-      - '655'
-    body:
-      encoding: ASCII-8BIT
-      string: '{"replyCode":0,"replyText":"OK","data":{"ids":["504947875"]}}'
-    http_version:
-  recorded_at: Wed, 13 Mar 2019 19:53:20 GMT
-- request:
-    method: post
-    uri: https://api-proxy.s.emarsys.com/api/v2/internal/215861890/contact/getdata
-    body:
-      encoding: UTF-8
-      string: '{"keyID":"3","keyValues":["jyucis-emarsys-get@workarea.com"],"fields":null}'
-    headers:
-      User-Agent:
-      - Faraday v0.15.4
-      Content-Type:
-      - application/json
-      X-Ems-Date:
-      - 20190313T195320Z
-      X-Ems-Auth:
-      - EMS-HMAC-SHA256 Credential=suite_workarea_v1/20190313/eu/suite/ems_request,
-        SignedHeaders=host;x-ems-date, Signature=ed8e9505a29c80fbf411f09c9903943a9b2e8af0e5de9221daaccfd588b67a7a
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-  response:
-    status:
-      code: 400
-      message: Bad Request
-    headers:
-      Cache-Control:
-      - max-age=0, no-cache, no-store, must-revalidate
-      Content-Length:
-      - '79'
-      Content-Type:
-      - application/json
-      Date:
-      - Wed, 13 Mar 2019 19:53:21 GMT
-      Pragma:
-      - no-cache
-      Server:
-      - openresty/1.11.2.1
-      Strict-Transport-Security:
-      - max-age=86400; includeSubDomains; preload
-      Vary:
-      - Accept-Encoding
-      Via:
-      - kong/0.14.1
-      X-Emarsys-Request-Id:
-      - 71e137ab-b703-4f06-8a33-acf9b8a1097a#4172
-      X-Kong-Proxy-Latency:
-      - '26'
-      X-Kong-Upstream-Latency:
-      - '62'
-      X-Ratelimit-Limit:
-      - '200'
-      X-Ratelimit-Remaining:
-      - '198'
-      X-Ratelimit-Reset:
-      - '1552506840'
-      X-Suite-Response-Time:
-      - '21'
-    body:
-      encoding: ASCII-8BIT
-      string: '{"replyCode":2004,"replyText":"Invalid key field id: ","data":""}'
-    http_version:
-  recorded_at: Wed, 13 Mar 2019 19:53:21 GMT
-recorded_with: VCR 2.9.3