workarea-mapp_integration 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae5c7353f71a5fb8ad16ae7b1c9197793c64427162c8557078b0c0c23b79f89e
+  data.tar.gz: 04bbfc6a9e20a4dbc160bcefc7fa0a74379475e98666d555abe8f99cdfebc59d
+SHA512:
+  metadata.gz: 0f8c67fc7e20b37ce826ff514dc0e7a1fc6bff8dd6fca00daa747d4511647b0cafb48dd3a413ab78f57729ef12d851de3bef73b831d8fd09f2c641d295790342
+  data.tar.gz: 0b4f05df233b4e7d3f45625b302e2e9c14303d089c49aa421fef7ec07924a17bee0ce61cf9bb537fb490d28ec849506201255c919df8dc2e61eea4bc69d1d36a

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/yarn-error.log
+test/dummy/tmp/

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in workarea-mapp_integration.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Satya.Tejadvs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Workarea::MappIntegration
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'workarea-mapp_integration'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install workarea-mapp_integration
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Workarea::MappIntegration'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/services/workarea/mapp_integration/mapp_integration_gateway.rb

@@ -0,0 +1,242 @@
+require 'net/http'
+require 'httparty'
+
+module Workarea
+  module MappIntegration
+    # Sending the data to MAPP via Api upon several actions on design toscano site.
+    class MappIntegrationGateway
+      # Converting username and password to ruby basic auth.
+      def basic_auth
+        auth = "Basic " + Base64::encode64("#{Rails.application.secrets.mapp_integration[:username]}:#{Rails.application.secrets.mapp_integration[:password]}")
+      end
+
+      # Generating headers for succesfull api.
+      def headers
+        {
+          "Authorization" => basic_auth,
+          "Content-Type" => "application/json",
+          "Accept" => "application/json"
+        }
+      end
+
+      # Membership subscribe API#
+      def membership_subscribe_by_email(user)
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/membership/subscribeByEmail", headers: headers, query: membership_subscribe_by_email_api_query(user.email) )
+      end
+
+      def membership_subscribe_by_email_api_query(email)
+        {
+          "email" => email,
+          "groupId" => "#{Rails.application.secrets.mapp_integration[:group_id]}",
+          "subscriptionMode" => "#{Rails.application.secrets.mapp_integration[:subscription_mode]}"
+        }
+      end
+
+      # Membership Unsubscribe API#
+      def membership_unsubscribe_by_email(user)
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/membership/unsubscribeByEmail", headers: headers, query: membership_unsubscribe_by_email_api_query(user))
+      end
+ 
+      def membership_unsubscribe_by_email_api_query(user)
+        {
+          "email" => user.email,
+          "groupId" => "#{Rails.application.secrets.mapp_integration[:group_id]}"
+        }
+      end
+
+      # Account Creation API#
+      def mapp_integration_for_user_creation(user) # Method triggers when creating the account in workarea
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/user/create", headers: headers, query: user_creation_api_query(user), body: user_creation_api_body(user))
+        membership_subscribe_by_email(user)
+        user_creation_transaction_api(response)
+      end
+
+      def user_creation_api_query(user) # This method greps the user and assaigns the value to email.
+        {
+          "email" => user.email,
+          "messageId" => "#{Rails.application.secrets.mapp_integration[:user_create_api_message_id]}"
+        }
+      end
+      
+      def user_creation_api_body(user) # This method greps the user and assaigns the values and especially written for api body.
+        [
+          {
+          "name" => 'email',
+          "value" => user.email
+          }
+        ].to_json
+      end
+
+      def user_creation_transaction_api(response)
+        transaction = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/message/sendTransactional", headers: headers, query: user_creation_transaction_api_query(response), body: mapp_email_signup_transaction_api_body(response))
+      end
+
+      def user_creation_transaction_api_query(response)
+        {
+          "recipientId" => response.parsed_response["id"],
+          "messageId" => "#{Rails.application.secrets.mapp_integration[:user_create_api_message_id]}",
+          "externalTransactionFormula" => "null"
+        }
+      end
+
+      # Email signup API#
+      def mapp_integration_email_signup_api(signup_data)
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/user/create", headers: headers, query: mapp_email_signup_api_query(signup_data), body: mapp_email_signup_api_body(signup_data))
+        membership_subscribe_by_email(signup_data)
+        mapp_email_signup_transaction_api(response)
+      end
+
+      def mapp_email_signup_api_query(signup_data)
+        {
+          "email" => signup_data.email
+        }
+      end
+
+      def mapp_email_signup_api_body(signup_data)
+        [
+          {
+          "name" => 'email',
+          "value" => signup_data.email
+          }
+        ].to_json
+      end
+
+      def mapp_email_signup_transaction_api(response)
+        HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/message/sendTransactional", headers: headers, query: mapp_email_signup_transaction_api_query(response), body: mapp_email_signup_transaction_api_body(response))
+      end
+
+      def mapp_email_signup_transaction_api_query(response)
+        {
+          "recipientId" => response.parsed_response["id"],
+          "messageId" => "#{Rails.application.secrets.mapp_integration[:email_signup_api_message_id]}",
+          "externalTransactionFormula" => "null"
+        }
+      end
+
+      def mapp_email_signup_transaction_api_body(response)
+        {
+        "parameters" =>
+          [
+            {"name" => "Parameter Name 1","value" => "Parameter Value 1"},
+            {"name" => "Parameter Name 2","value" => "Parameter Value 2"}
+          ]
+        }.to_json
+      end
+      # Update User API#
+      def mapp_integration_for_update_user(user) # Method triggers when user is updated in workarea
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/user/updateProfileByEmail", headers: headers, query: update_user_creation_api_query(user), body: update_user_creation_api_body(user))
+      end
+
+      def update_user_creation_api_query(user)
+        {
+          "email" => user.email
+        }
+      end
+      
+      def update_user_creation_api_body(user) # Request body for update_user api
+        [
+          {
+            "name" => "email",
+            "value" => user.email
+          },
+          {
+            "name" =>"email",
+            "value" => user.email
+          }
+        ].to_json
+      end
+
+      # Catalog Form API#
+      def mapp_email_signup_from_catalog_form(user)
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/user/create", headers: headers, query: catalog_form_user_creation_api_query(user), body: catalog_form_user_creation_api_body(user))
+        membership_subscribe_by_email(user)
+        catalog_form_transaction_api(response)
+      end
+
+      def catalog_form_user_creation_api_query(user)
+        {
+          "email" => user.email,
+          "messageId" => "#{Rails.application.secrets.mapp_integration[:catalog_request_api_message_id]}"
+        }
+      end
+
+      def catalog_form_user_creation_api_body(user)
+        [
+          {
+          "name" => 'email',
+          "value" => user.email
+          }
+        ].to_json
+      end
+
+      def catalog_form_transaction_api(response)
+        HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/message/sendTransactional", headers: headers, query: catalog_form_transaction_api_query(response), body: mapp_email_signup_transaction_api_body(response))
+      end
+
+      def catalog_form_transaction_api_query(response)
+        {
+          "recipientId" => response.parsed_response["id"],
+          "messageId" => "#{Rails.application.secrets.mapp_integration[:catalog_request_api_message_id]}",
+          "externalTransactionFormula" => "null"
+        }
+      end
+
+      # Order placed API #
+      # Hitting order placed api when we place order in workarea.
+      def mapp_integration_for_order_placed(order, user_id)
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/message/sendTransactionalWithEventDetails", headers: headers, query: order_placed_api_query(order, user_id), body: order_placed_api_body(order, user_id))
+      end
+
+      def order_placed_api_query(order, user_id)
+        {
+          "recipientId" => "#{user_id}",
+          "messageId" => "#{Rails.application.secrets.mapp_integration[:order_placed_api_message_id]}",
+          "externalTransactionFormula" => "#{order.id}"
+        }
+      end
+
+      def order_placed_api_body(order, user_id) # Calling the sendTransactionalWithEventDetails api body from order.decorator in the DT project
+        order.mapp_order_placed_api_body(order, user_id)
+      end
+      # Hitting user get by email api to verify the user existance. If yes, we are calling the sendTransactionalWithEventDetails api.
+      # If user is not present(i.e., guest user in workarea) in mapp, we are calling user_creation api and from there fetching the mappuser_id. 
+      def get_user_by_email(order)
+        response = HTTParty.get("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/user/getByEmail", headers: headers, query: user_get_by_email_query(order.email))
+        user_id_from_response = response.parsed_response["id"]
+
+        begin
+          if user_id_from_response.nil?
+            guest_user_response = Workarea::MappIntegration::MappIntegrationGateway.new.user_creation_for_guest_user(order)
+            user_id = guest_user_response.parsed_response["id"]
+            Workarea::MappIntegration::MappIntegrationGateway.new.mapp_integration_for_order_placed(order, user_id)
+          else
+            Workarea::MappIntegration::MappIntegrationGateway.new.mapp_integration_for_order_placed(order, user_id_from_response)
+          end
+        rescue Timeout::Error => e
+          Rails.logger.info "Rescued #{e.message}"
+        end
+      end
+
+      def user_get_by_email_query(email)
+        {
+          "email" => email
+        }
+      end
+
+      # Creating the account in mapp for guest user in workarea. 
+      def user_creation_for_guest_user(user)
+        response = HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/user/create", headers: headers, query: user_creation_api_query(user), body: user_creation_api_body(user))
+      end
+
+      # Subscribe by Email API when subscribing from billing address#
+      def membership_subscribe_from_billing_address(email)
+        HTTParty.post("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/membership/subscribeByEmail", headers: headers, query: membership_subscribe_by_email_api_query(email) )
+      end
+
+      def subscribe_from_billing_address_transaction(email)
+        response = HTTParty.get("#{Rails.application.secrets.mapp_integration[:api_endpoint]}"+"/user/getByEmail", headers: headers, query: user_get_by_email_query(email))
+        mapp_email_signup_transaction_api(response)
+      end
+    end
+  end
+end

data/app/workers/workarea/mapp_integration_create_user_worker.rb

@@ -0,0 +1,21 @@
+module Workarea
+  #Worker for mapp integration includes Creating the user and membership_subscribe_by_email api's.
+  class MappIntegrationCreateUserWorker
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      retry: true,
+      enqueue_on: { Workarea::User => :create }
+    )
+
+    #Triggers the perform method depending on the actions represented in enqueue_on
+    def perform(id)
+      mapp_integration_flag = Rails.application.secrets.mapp_integration[:flag] rescue nil
+      if mapp_integration_flag == true
+        user = Workarea::User.find(id)
+        Workarea::MappIntegration::MappIntegrationGateway.new.mapp_integration_for_user_creation(user)
+      end
+    end
+  end
+end

data/app/workers/workarea/mapp_integration_email_signup_worker.rb

@@ -0,0 +1,22 @@
+module Workarea
+  #Worker for mapp integration includes when email signup is done on the DT site.
+  class MappIntegrationEmailSignupWorker
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      retry: true,
+      enqueue_on: { Workarea::Email::Signup => :create }
+    )
+
+    #Triggers the perform method depending on email signup create action.
+    def perform(id)
+      mapp_integration_flag = Rails.application.secrets.mapp_integration[:flag] rescue nil
+      if mapp_integration_flag == true
+        signup_data = Workarea::Email::Signup.find(id)
+        #Hitting user_create and membership_subscribe_by_email api's by hitting 'mapp_integration_for_user_creation' method.
+        Workarea::MappIntegration::MappIntegrationGateway.new.mapp_integration_email_signup_api(signup_data)
+      end
+    end
+  end
+end

data/app/workers/workarea/mapp_integration_order_place_worker.rb

@@ -0,0 +1,30 @@
+module Workarea
+  #Worker for mapp integration includes hitting the order placed api.
+  class MappIntegrationOrderPlaceWorker
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      retry: true,
+      enqueue_on: { Workarea::Order => :place }
+    )
+
+    #Triggers the perform method depending on the order place action.
+    def perform(id)
+      mapp_integration_flag = Rails.application.secrets.mapp_integration[:flag] rescue nil
+      if mapp_integration_flag == true
+        order = Workarea::Order.find(id)
+        # For making 'sendTransactionalWithEventDetails' api, we are first hitting get_user_by email api.
+        Workarea::MappIntegration::MappIntegrationGateway.new.get_user_by_email(order)
+        # While doing checkout process, when user selects the sign-me-up checkbox from billing address, we are hitting "membership subscribe by email" api. 
+        order_view_model = Workarea::Storefront::OrderViewModel.new(order)
+        checkbox = order_view_model.billing_address.signup_checkbox
+
+        if checkbox == true
+          Workarea::MappIntegration::MappIntegrationGateway.new.membership_subscribe_from_billing_address(order.email)
+          Workarea::MappIntegration::MappIntegrationGateway.new.subscribe_from_billing_address_transaction(order.email)
+        end
+      end
+    end
+  end
+end