cxf 0.0.1

data/lib/contact.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+require_relative './client'
+require_relative './cxf/helpers/cxf_helper'
+require_relative './cxf/helpers/threads_helper'
+require_relative './contact/content/content'
+require_relative './contact/config/config'
+require_relative './contact/ecommerce/ecommerce'
+
+include ActionController::Cookies
+
+module Cxf
+  class Contact
+    include ContactConfig
+    include ContactContent
+    include ContactEcommerce
+    include CxfHelper
+    include ThreadsHelper
+
+    attr_reader :client
+
+    ##
+    # === Initialize.
+    # Class constructor.
+    #
+    # ==== Parameters
+    # host:: (String) -- It's the visitor IP.
+    # api_key:: (String) -- Cxf instance api key.
+    # contact_token_id:: (Integer) --  Cookie 'cxf_contact_id' value (cxf_contact_token).
+    #
+    # ==== Return
+    # Returns a Contact object
+    def initialize(
+      host,
+      api_key,
+      session_token = nil,
+      refresh_token = nil,
+      contact_token_id = nil,
+      debug = false,
+      timeouts = {}
+    )
+      @contact_v1_url = '/api/contact/v1'
+      @client = Cxf::Client.new(
+        host,
+        api_key,
+        'contact',
+        session_token,
+        refresh_token,
+        contact_token_id,
+        nil,
+        debug,
+        timeouts
+      )
+    end
+
+    ### V1/CONTACTS ###
+
+    ##
+    # === Register.
+    # Register a contact.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- It's the register data.
+    #
+    # ==== Example
+    #     data = {
+    #       email: 'email@example.com',
+    #       given_name: 'Given Name',
+    #       last_name: 'Last Name',
+    #       password: 'password'
+    #     }
+    #     @cxf_contact.register(data);
+    def register(data)
+      @client.raw('post', '/contacts/register', nil, data_transform(data))
+    end
+
+    ##
+    # === Login.
+    # Starts a contact session.
+    #
+    # ==== Parameters
+    # email:: (String) -- The email that will be logged.
+    # password:: (String) -- The password of the email.
+    #
+    # ==== Example
+    #     @cxf_contact.login('email@example.com', 'password')
+    def login(email, password)
+      data = {
+        email: email,
+        password: password
+      }
+      response = @client.raw('post', '/contacts/login', nil, data_transform(data))
+      if response.key? 'data' and response['data'].key? 'access_token'
+        @client.session_token = response['data']['access_token']
+        @client.refresh_token = response['data']['refresh_token']
+      end
+      response
+    end
+
+    ##
+    # === Recover Password.
+    # Send a email that contains a token to a contact. That token will be used in reset_password to establish a new password.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- It's a data key where will be hosted the destination email.
+    #
+    # ==== Example
+    #     data = { email: 'email@example.com' }
+    #     @cxf_contact.recover_password(data)
+    def recover_password(data)
+      @client.raw('post', '/contacts/recover-password', nil, data_transform(data))
+    end
+
+    ##
+    # === Reset Password.
+    # Reset password using a token. The token is obtained by recover_password method.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- It's a set of data which contains all the information to reset a contact password.
+    #
+    # ==== Example
+    #     data = {
+    #       email: 'email@example.com',
+    #       password: 'password',
+    #       password_confirmation: 'password',
+    #       token: '644aa3aa0831d782cc42e42b11aedea9a2234389af4f429a8d96651295ecfa09'
+    #     }
+    #     @cxf_contact.reset_password(data)
+    def reset_password(data)
+      @client.raw('post', '/contacts/reset-password', nil, data_transform(data))
+    end
+
+    ##
+    # === OAuth Login.
+    # Login a contact using oauth.
+    def oauth_login(data)
+      @client.raw('post', '/contacts/oauth-login', nil, data)
+    end
+
+    ##
+    # === Magic Link Login.
+    # Starts a contact session with a token received in the contact email. The token will be received by send_magic_link method.
+    #
+    # ==== Parameters
+    # token:: (String) -- The email token that will be used to log in.
+    #
+    # ==== Example
+    #     @cxf_contact.magic_link_login(
+    #       'd8618c6d-a165-41cb-b3ec-d053cbf30059:zm54HtRdfHED8dpILZpjyqjPIceiaXNLfOklqM92fveBS0nDtyPYBlI4CPlPe3zq'
+    #     )
+    def magic_link_login(token)
+      response = @client.raw('get', "/contacts/magic-link-login/#{token}", nil, '/api/v1')
+      @client.session_token = response['session_token'] if response.key? 'session_token'
+
+      response
+    end
+
+    ##
+    # === Send Magic Link.
+    # Send magic link to contact by email. That magic link will be used in magic_link_login method.
+    #
+    # ==== Parameters
+    # email_or_phone:: (String) -- Contact's email.
+    # template_slug:: (String) -- Email template's slug to be used in the email.
+    # redirectUrl:: (String) -- Url to be redirected in the implemented page.
+    # lifeTime:: (Integer) -- Maximum time of use in minutes.
+    # maxVisits:: (Integer) -- The maximum number of uses of a token.
+    #
+    # ==== First Example
+    #     @cxf_contact.send_magic_link('email@example.com', 'template_slug')
+    #
+    # ==== Second Example
+    #     @cxf_contact.send_magic_link('+526561234567', 'template_slug', '', 1440, 3, 'whatsapp')
+    def send_magic_link(email_or_phone, template_slug, redirect_url = '', life_time = 1440, max_visits = nil, driver = 'email')
+      data = {
+        driver: driver,
+        lifeTime: life_time,
+        maxVisits: max_visits,
+        redirectUrl: redirect_url,
+        templateId: template_slug
+      }
+      if %w[sms whatsapp].include? driver
+        data['phone'] = email_or_phone
+      else
+        data['email'] = email_or_phone
+      end
+      @client.raw('post', '/contacts/magic-link', nil, data_transform(data), '/api/v1')
+    end
+
+    ### CONTACT/V1 ###
+
+    ##
+    # === Me.
+    # Get contact logged info.
+    #
+    # ==== Parameters
+    # # options:: (Hash) -- List of {Resource collection Options}[#class-Cxf::Pub-label-Resource+collections+options+] shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @cxf_contact.me
+    #
+    # ==== Second Example
+    #     options = {
+    #       attributes: true,
+    #       taxonomies: true
+    #     }
+    #     @data = @cxf_contact.me(options)
+    def me(options = nil)
+      @client.raw('get', '/me', options, nil, @contact_v1_url)
+    end
+
+    ##
+    # === Status.
+    # Get contact logged status.
+    #
+    # ==== Example
+    #     @data = @cxf_contact.status
+    def status
+      @client.raw('get', '/status', nil, nil, @contact_v1_url)
+    end
+
+    ##
+    # === Update.
+    # Update logged contact attributes.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- It's the data to update with a session active.
+    #
+    # ==== Example
+    #     data = {
+    #       given_name: 'Given Name',
+    #       last_name: 'Last Name'
+    #     }
+    #     @data = @cxf_contact.update(data)
+    def update(data)
+      @client.raw('put', '/update', nil, data_transform(data), @contact_v1_url)
+    end
+
+    ##
+    # === Logout.
+    # Ends a contact session previously logged.
+    #
+    # ==== Example
+    #     @data = @cxf_contact.logout
+    def logout
+      if session_token?
+        response = @client.raw('post', '/logout', nil, nil, @contact_v1_url)
+        @client.session_token = nil if response['success']
+
+        response
+      end
+    end
+
+    ##
+    # === Change Password.
+    # Change password without email. To change the password a contact must be logged.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- A new password allocated in a data key.
+    #
+    # ==== Example
+    #     data = { password: 'new_password' }
+    #     @data = @cxf_contact.change_password(data)
+    def change_password(data)
+      @client.raw('post', '/change-password', nil, data_transform(data), @contact_v1_url)
+    end
+
+    def get_client
+      @client
+    end
+
+    private
+
+    include CxfHelper
+
+    def session_token?
+      unless @client.session_token
+        Cxf::DynamicError.new(@client, 'Unauthorized', 'Attach contact session token', 401, nil)
+      end
+
+      true
+    end
+  end
+end

data/lib/cxf/controllers/admin_base_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative './concerns/cxf_clients'
+require_relative '../helpers/user_auth_helper'
+
+module Cxf
+  class AdminBaseController < ActionController::Base
+
+    include CxfClients
+    include UserAuthHelper
+
+    # Override default values for cxf clients concern
+    def define_cxf_clients
+      %w[user service_account]
+    end
+  end
+end

data/lib/cxf/controllers/base_api_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative './concerns/cxf_clients'
+require_relative '../helpers/user_auth_helper'
+require_relative '../helpers/contact_auth_helper'
+
+module Cxf
+  class BaseApiController < ActionController::Base
+    # Concerns
+    include CxfClients
+
+    # Helpers
+    include ContactAuthHelper
+    include UserAuthHelper
+
+    def define_cxf_clients
+      %w[contact pub]
+    end
+
+    ##
+    # === Cxf contact Login.
+    # This method works to override the base to add the redirect parameter
+    # The main method is located in contact_auth_helper.rb
+    def cxf_contact_magic_link_login(hash)
+      super(hash, true)
+    end
+  end
+end

data/lib/cxf/controllers/base_controller.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative './concerns/cxf_clients'
+require_relative '../helpers/contact_auth_helper'
+
+module Cxf
+  class BaseController < ActionController::Base
+    # Concerns
+    include CxfClients
+
+    # Helpers
+    include ContactAuthHelper
+
+    before_action :register_visit
+
+    # Override default values for cxf clients concern
+    def define_cxf_clients
+      %w[contact pub]
+    end
+
+    private
+
+    ##
+    # === Register visit.
+    # Call register visit method from the public client and set/renew the cookie cxf_contact_id
+    def register_visit
+      if @debug
+        puts "REQUEST IN REGISTER VISIT: #{request}"
+        puts "BODY REQUEST: #{request.body}"
+        puts "AUTH REQUEST: #{request.authorization}"
+        puts "LENGTH REQUEST: #{request.content_length}"
+        puts "FORM DATA REQUEST: #{request.form_data?}"
+        puts "FULLPATH REQUEST: #{request.fullpath}"
+        puts "HEADERS REQUEST: #{request.headers}"
+        puts "IP REQUEST: #{request.ip}"
+        puts "REQUEST IP ADDRESS: #{request['ip_address']}"
+        puts "REQUEST REMOTE IP: #{request['remote_ip']}"
+      end
+
+      response = @cxf_pub.register_visit(request)
+
+      puts "RESPONSE IN REGISTER VISIT: #{response}" if @debug
+
+      @contact_token = response['contact_token'] || response['user_token']
+      @visit_id = response['visit_id']
+
+      puts "VISIT ID: #{@visit_id}" if @debug
+
+      cookies.permanent[:cxf_contact_id] = { value: @contact_token, secure: true, httponly: true }
+      cookies.permanent[:cxf_visit_id] = { value: @visit_id, secure: true, httponly: true }
+    end
+
+  end
+end

data/lib/cxf/controllers/concerns/cxf_clients.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "./read_config_file"
+
+module CxfClients
+  extend ActiveSupport::Concern
+
+  included do
+    include ReadConfigFile
+    before_action :set_cxf_clients
+  end
+
+  # Define the clients that will have
+  # Override in the controller if you dont wanna all clients
+  def define_cxf_clients
+    %w[contact user pub service_account]
+  end
+
+  private
+
+  ##
+  # === Set cxf clients (pub, user and contact)
+  # Initialize all clients from cxf
+  def set_cxf_clients
+    valid_clients = %w[contact user pub service_account]
+
+    clients = define_cxf_clients&.select { |client| valid_clients.include? client } || []
+
+    if @debug
+      puts "Clients to initialize:", clients
+      puts "Host:", @host
+    end
+
+    if clients.kind_of?(Array) and @host
+      clients.each do |client|
+        send("set_cxf_#{client}_client")
+      end
+    end
+  end
+
+  ##
+  # === Set cxf pub.
+  # Initialize the public client and set the contact token
+  def set_cxf_pub_client
+    # Initialize cxf pub client, credentials taken from cxf_config.yml.erb file
+    visit_id = cookies[:cxf_visit_id]
+    contact_token_id = cookies[:cxf_contact_id]
+
+    @cxf_pub = Cxf::Pub.new(
+      @host,
+      @api_key,
+      contact_token_id,
+      visit_id,
+      @debug
+    )
+  end
+
+  ##
+  # === Set cxf contact client.
+  # Initialize the contact client and set the contact token
+  def set_cxf_contact_client
+    # Initialize cxf contact client
+    contact_session_token = cookies[:cxf_contact_session_token]
+    contact_refresh_token = cookies[:cxf_contact_refresh_token]
+    contact_token_id = cookies[:cxf_contact_id]
+    @cxf_contact = Cxf::Contact.new(
+      @host,
+      @api_key,
+      contact_session_token,
+      contact_refresh_token,
+      contact_token_id,
+      @debug
+    )
+  end
+
+  ##
+  # === Set Cxf user client.
+  # Initialize the user client
+  def set_cxf_user_client
+    # Initialize cxf user client
+    user_session_token = cookies[:cxf_user_session_token]
+    user_refresh_token = cookies[:cxf_user_refresh_token]
+    @cxf_user = Cxf::User.new(
+      @host,
+      @api_key,
+      user_session_token,
+      user_refresh_token,
+      @debug
+    )
+  end
+
+  ##
+  # === Set Cxf service account
+  # Initialize the service account client
+  def set_cxf_service_account_client
+    # Initialize service account client
+    @cxf_service_account = Cxf::User.new(
+      @host,
+      @api_key,
+      @api_key,
+      @debug
+    )
+  end
+end

data/lib/cxf/controllers/concerns/read_config_file.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ReadConfigFile
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :set_config_variables
+  end
+
+  def set_config_variables
+    if File.exists?("#{Rails.root}/cxf_config.yml.erb")
+      template = ERB.new File.new("#{Rails.root}/cxf_config.yml.erb").read
+      config = YAML.safe_load template.result(binding)
+
+      @host = config.dig('cxf', 'host')
+      @api_key = config.dig('cxf', 'api_key')
+      @debug = !!config.dig('cxf', 'debug')
+      @redis_config = config.dig('cxf', 'redis_cache')
+      @use_cache = config.dig('cxf', 'redis_cache', 'use_cache')
+
+      if @use_cache
+        @redis_server = Redis.new(
+          host: config.dig('cxf', 'redis_cache', 'redis_host'),
+          port: config.dig('cxf', 'redis_cache', 'redis_port') || 6379,
+          db: config.dig('cxf', 'redis_cache', 'redis_db') || 1
+        )
+      end
+    end
+  end
+end

data/lib/cxf/controllers/contact_api_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative './concerns/read_config_file'
+require_relative '../helpers/proxy_controllers_methods'
+
+module Cxf
+  class ContactAPIController < ActionController::API
+    include AbstractController::Helpers
+    include ReverseProxy::Controller
+    include ReadConfigFile
+    include ProxyControllersMethods
+
+    def index
+      super('contact')
+    end
+  end
+end

data/lib/cxf/controllers/public_api_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative './concerns/read_config_file'
+require_relative '../helpers/proxy_controllers_methods'
+
+module Cxf
+  class PublicAPIController < ActionController::API
+    include ReverseProxy::Controller
+    include AbstractController::Helpers
+    include ReadConfigFile
+    include ProxyControllersMethods
+
+  end
+end

data/lib/cxf/controllers/user_api_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative './concerns/read_config_file'
+require_relative '../helpers/proxy_controllers_methods'
+
+module Cxf
+  class UserAPIController < ActionController::API
+    include AbstractController::Helpers
+    include ReadConfigFile
+    include ProxyControllersMethods
+
+    def index
+      super('user')
+    end
+  end
+end

data/lib/cxf/helpers/contact_auth_helper.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module ContactAuthHelper
+  ##
+  # === Cxf Contact Login.
+  # Starts a contact session in cxf.cloud and set a session cookie
+  def cxf_contact_login(email, password)
+    # Login in cxf
+    response = @cxf_contact.login(email, password)
+    # Get session token from response
+    if response.key? 'data'
+      session_token = response['data']['session_token']
+      refresh_token = response['data']['refresh_token']
+    end
+    # id_token = response['contact']['contact_token'] ? response['contact']['contact_token'] : response['contact']['id_token']
+    # Set a permanent cookie with the session token
+    cookies.permanent[:cxf_contact_session_token] = { value: session_token, secure: true, httponly: true }
+    cookies.permanent[:cxf_contact_refresh_token] = { value: refresh_token, secure: true, httponly: true }
+    # cookies.permanent[:cxf_contact_id] = { value: id_token, secure: true, httponly: true }
+    @contact_token = id_token
+  end
+
+  ##
+  # === Cxf contact Login.
+  # Starts a contact session in cxf.cloud and set a session cookie
+  def cxf_contact_magic_link_login(hash, redirect_in_error = false)
+    # Login in cxf
+    response = @cxf_contact.magic_link_login(hash)
+
+    if response['data']
+      # Get session token from response
+      session_token = response['data']['session_token']
+      refresh_token = response['data']['refresh_token']
+      # id_token = response['data']['contact']['contact_token'] ? response['data']['contact']['contact_token'] : response['data']['contact']['id_token']
+      # Set a permanent cookie with the session token
+      cookies.permanent[:cxf_contact_session_token] = { value: session_token, secure: true, httponly: true }
+      cookies.permanent[:cxf_contact_refresh_token] = { value: refresh_token, secure: true, httponly: true }
+      # cookies.permanent[:cxf_contact_id] = { value: id_token, secure: true, httponly: true }
+      # @contact_token = id_token
+      redirect_to response['data']['redirect_url'] || '/' if redirect_in_error
+    else
+      redirect_to '/' if redirect_in_error
+    end
+  end
+
+  ##
+  # === Cxf Contact Logout.
+  # Destroy session from cxf.cloud and delete local session cookie
+  def cxf_contact_logout
+    # Logout from cxf
+    @cxf_contact.logout
+    # Delete session token and keep the contact token id
+    # Never delete the cxf_contact_id cookie to avoid the creation of ghosts
+    cookies.delete(:cxf_contact_session_token)
+    cookies.delete(:cxf_contact_refresh_token)
+    @contact_token = nil
+  end
+
+  def cxf_contact_signed_in?
+
+    begin
+      # Check status in cxf
+      # Check status in cxf
+      response = @cxf_contact.status
+      status = response['success'] || false
+    rescue => e
+      # Handle the client Unauthorized error
+      # if cxf response is negative delete the session cookie
+      cookies.delete(:cxf_contact_session_token)
+      cookies.delete(:cxf_contact_refresh_token)
+      status = false
+    end
+
+    status
+  end
+
+  def update_contact_tokens
+    access_token = @cxf_user.get_client.session_token
+    refresh_token = @cxf_user.get_client.refresh_token
+    access_token_expires_at = @cxf_user.get_client.session_token_expires_at
+    refresh_token_expires_at = @cxf_user.get_client.refresh_token_expires_at
+
+    cookies[:cxf_contact_session_token] = { value: access_token, secure: true, httponly: true, expires: Time.at(access_token_expires_at) } if access_token && access_token_expires_at
+    cookies[:cxf_contact_refresh_token] = { value: refresh_token, secure: true, httponly: true, expires: Time.at(refresh_token_expires_at) } if refresh_token && refresh_token_expires_at
+  end
+end