cxf 0.0.1

data/lib/pub.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative './client'
+require_relative './cxf/helpers/cxf_helper'
+require_relative './cxf/helpers/threads_helper'
+require_relative './pub/content/content'
+require_relative './pub/ecommerce/ecommerce'
+require_relative './pub/config/config'
+
+module Cxf
+  ##
+  # == Public context API
+  # Pub class contains functions that needs only an API key as authentication
+  # == Usage example
+  # === For Cxf::BaseController inheritance:
+  # If the controller is inheriting from Cxf::BaseController, Only use the class variable *cxf_pub*  _Example:_
+  #     @cxf_pub.get_stories
+  # === For standalone usage:
+  # Initialize
+  #     pub = Cxf::Pub.new(cxf_url, api_key)
+  # or if host and api_key are provided by cxf_config.yml.erb
+  #     pub = Cxf::Pub.new
+  # Call any function
+  #     pub.get_products
+  # == Single resource options
+  # * +include+ - [_String_] Specify additional information to be included in the results from the objects relations. _Example:_
+  #     { "include": "events" }
+  # * +attributes+ - [_Boolean_] If present, attributes will be returned for each record in the results. _Example:_
+  #     { "attributes": true }
+  # * +taxonomies+ - [_Boolean_] If present, taxonomies will be returned for each record in the results. _Example:_
+  #     { "taxonomies": true }
+  # * +tags+ - [_Boolean_] If present, tags will be returned for each record in the results. _Example:_
+  #     { "tags": true }
+  # * +fields+ - [_String_] Specify the fields that you want to be returned. If empty, all fields are returned. The object index can also be used to specify specific fields from relations. _Example:_
+  #     { fields: "id, title, slug" }
+  #     { "fields[products]": "id, title, slug" }
+  #
+  # == Resource collections options
+  # * +search+ - [_String_] If present, it will search for records matching the search string. _Example:_
+  #     { "search": "search string" }
+  # * +scopes+ - [_String_] If present, it will apply the specified Model's scopes. _Example:_
+  #     { "scopes": "approved, recent" }
+  # * +filters+ - [_String_] This is a powerful parameter that allows the data to be filtered by any of its fields. Currently only exact matches are supported. _Example:_
+  #     { "filters[title]": "titleToFilter" }
+  # * +jfilters+ - [_String_] A complex filter configuration, as used in segments, in JSON format, base64 encoded and URLencoded. _Example:_
+  #     jfilter = {
+  #       "type":"group",
+  #       "items":[
+  #         {
+  #           "type":"attribute",
+  #           "operator":"==",
+  #           slug:"title",
+  #           "value":"Action movies"
+  #         }
+  #       ],
+  #       "operator":"or"
+  #     }
+  #     options = { "jfilters": jfilter }
+  # * +sort+ - [_String_] The name of the field to perform the sort. Prefix the value with a minus sign - for ascending order. _Example:_
+  #     { sort: "title" }
+  #     { sort: "-title" }
+
+  class Pub
+    attr_reader :client
+
+    include CxfHelper
+    include PublicContent
+    include PublicEcommerce
+    include PublicConfig
+    include ThreadsHelper
+
+    ##
+    # === 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 Client object.
+    def initialize(
+      host,
+      api_key,
+      contact_token_id = nil,
+      visit_id = nil,
+      debug = false,
+      timeouts = {}
+    )
+      @client = Cxf::Client.new(
+        host,
+        api_key,
+        'public',
+        nil,
+        contact_token_id,
+        visit_id,
+        debug,
+        timeouts
+      )
+    end
+
+    ##
+    # === Register Visit.
+    # Register a ghost/contact visit in Cxf.Cloud.
+    #
+    # ==== Parameters
+    # request:: (ActionDispatch::Request) -- request.
+    # ip:: (String) -- It's the visitor IP.
+    # user_agent:: (String) -- The visitor's browser user agent.
+    # url:: (String) -- URL visited.
+    #
+    # ==== Example
+    #     request = {
+    #       "remote_ip" => "http://1.1.1.1/",
+    #       "user_agent" => "User Agent",
+    #       "fullpath" => "https://fullpath/example"
+    #     }
+    #     @data = @cxf_pub.register_visit(request, request["remote_ip"], request["user_agent"], request["fullpath"])
+    def register_visit(request, ip = nil, user_agent = nil, url = nil)
+      data = {
+        ip_address: ip || request.remote_ip,
+        user_agent: user_agent || request.user_agent,
+        url: url || request.fullpath
+      }
+
+      @client.raw('post', '/register-visit', nil, data.to_json)
+    end
+
+    ##
+    # === Register Visit timer.
+    # Register a page visit time.
+    #
+    # ==== Parameters
+    # visit:: (String) -- It's the visitor IP.
+    # time:: (Integer) -- The visitor's browser user agent.
+    #
+    # ==== Example
+    #     @data = @cxf_pub.register_visit_timer("60da2325d29acc7e55684472", 4)
+    def register_visit_timer(visit, time)
+      @client.raw('get', "/register-visit-timer?visit=#{visit}&time=#{time}")
+    end
+
+    def send_user_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
+      }
+
+      key = %w[sms whatsapp].include? driver ? 'phone' : 'email'
+      data[key] = email_or_phone
+      @client.raw('post', '/users/magic-link', nil, { data: data }.to_json, '/api/v1')
+    end
+
+    def get_client
+      @client
+    end
+  end
+end

data/lib/user/config/attribute_groups.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module AttributeGroups
+  ##
+  # == Attribute Groups
+  #
+
+  # === Get attribute groups data types.
+  # Get data types used in attribute groups.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_attribute_groups_data_types
+  def get_attribute_groups_data_types
+    @client.raw('get', '/config/attribute-groups/object-types')
+  end
+
+  # === Get attribute groups.
+  # Get a collection of attribute groups.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_attribute_groups
+  #
+  # ==== Second Example
+  #     options = { sort: 'id' }
+  #     @data = @cxf_user.get_attribute_groups(options)
+  def get_attribute_groups(options = nil)
+    @client.raw('get', '/config/attribute-groups', options)
+  end
+
+  # === Get attribute group.
+  # Get an attribute group info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Attribute group id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_attribute_group(10)
+  def get_attribute_group(id)
+    @client.raw('get', "/config/attribute-groups/#{id}")
+  end
+
+  # === Create attribute group.
+  # Create an attribute group with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Attribute Group',
+  #       object_type: 'contacts'
+  #     }
+  #     @data = @cxf_user.create_attribute_group(data)
+  def create_attribute_group(data)
+    @client.raw('post', '/config/attribute-groups', nil, data_transform(data))
+  end
+
+  # === Update attribute group.
+  # Update an attribute group info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Attribute group id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Attribute Group Modified',
+  #       object_type: 'contacts',
+  #       slug: 'new-attribute-group',
+  #       description: 'New description'
+  #     }
+  #     @data = @cxf_user.update_attribute_group(36, data)
+  def update_attribute_group(id, data)
+    @client.raw('put', "/config/attribute-groups/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/config/attributes.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Attributes
+  ##
+  # == Attributes
+  #
+
+  # === Get attributes data types.
+  # Get data types used in attributes.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_attributes_data_types
+  def get_attributes_data_types
+    @client.raw('get', '/config/attributes/data-types')
+  end
+
+  # === Get sub attributes.
+  # Get sub attributes with a slug.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #
+  def get_sub_attributes(options)
+    @client.raw('get', '/config/attributes/sub-attributes', options)
+  end
+
+  # === Get attributes.
+  # Get a collection of attributes.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_attributes
+  def get_attributes
+    @client.raw('get', '/config/attributes')
+  end
+
+  # === Get attribute.
+  # Get an attribute info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Attribute id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_attribute(1)
+  def get_attribute(id)
+    @client.raw('get', "/config/attributes/#{id}")
+  end
+
+  # === Create attribute.
+  # Create an attribute with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: "New Attribute",
+  #       object_type: "orders",
+  #       slug: "new_attribute",
+  #       attribute_group_id: 1,
+  #       data_type_enum: 10
+  #     }
+  #     @data = @cxf_user.create_attribute(data)
+  def create_attribute(data)
+    @client.raw('post', '/config/attributes', nil, data_transform(data))
+  end
+
+  # === Update attribute.
+  # Update an attribute info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Attribute id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Attribute Modified',
+  #       object_type: 'orders',
+  #       slug: 'new_attribute',
+  #       attribute_group_id: 1,
+  #       data_type_enum: 10
+  #     }
+  #     @data = @cxf_user.update_attribute(292, data)
+  def update_attribute(id, data)
+    @client.raw('put', "/config/attributes/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/config/calendars.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Calendars
+  ##
+  # == Calendars
+  #
+
+  # === Get calendars.
+  # Get a collection of calendars.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_calendars
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @cxf_user.get_calendars(options)
+  def get_calendars(options = nil)
+    @client.raw('get', '/config/calendars', options)
+  end
+
+  # === Get calendar.
+  # Get a calendar info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Calendar id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_calendar(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @cxf_user.get_calendar(1, options)
+  def get_calendar(id, options = nil)
+    @client.raw('get', "/config/calendars/#{id}", options)
+  end
+
+  # === Create calendar.
+  # Create a calendar with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Calendar',
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @cxf_user.create_calendar(data)
+  def create_calendar(data)
+    @client.raw('post', '/config/calendars', nil, data_transform(data))
+  end
+
+  # === Update calendar.
+  # Update a calendar info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Calendar id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Calendar Modified',
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @cxf_user.update_calendar(4, data)
+  def update_calendar(id, data)
+    @client.raw('put', "/config/calendars/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete calendar.
+  # Delete a calendar.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Calendar id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_calendar(4)
+  def delete_calendar(id)
+    @client.raw('delete', "/config/calendars/#{id}")
+  end
+end

data/lib/user/config/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative './attribute_groups'
+require_relative './attributes'
+require_relative './views'
+require_relative './relationships'
+require_relative './seeds'
+require_relative './system_settings'
+require_relative './tags'
+require_relative './taxonomies'
+require_relative './users'
+
+module Config
+  include AttributeGroups
+  include Attributes
+  include Views
+  include Relationships
+  include Seeds
+  include SystemSettings
+  include Tags
+  include Taxonomies
+  include Users
+end

data/lib/user/config/relationships.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Relationships
+  ##
+  # == Relationships
+  #
+  # === Get relationships available for.
+  # Get relationships available.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = {
+  #       objectType: 'contacts'
+  #     }
+  #     @data = @cxf_user.get_relationships_available_for(options)
+  def get_relationships_available_for(options)
+    @client.raw('get', '/config/relationships/available-for', options)
+  end
+
+  # === Attach relationship.
+  # Attach a relationship.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #
+  def attach_relationship(data)
+    # FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
+    @client.raw('post', '/config/relationships/attach', nil, data_transform(data))
+  end
+
+  # === Detach relationship.
+  # Detach a relationship.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #
+  def detach_relationship(data)
+    # FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
+    @client.raw('post', '/config/relationships/detach', nil, data_transform(data))
+  end
+
+  # === Relationship has objects.
+  # Get relationships that has objects.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.relationship_has_objects(1)
+  def relationship_has_objects(id)
+    @client.raw('get', "/config/relationships/#{id}/hasObjects")
+  end
+
+  # === Get relationships.
+  # Get a collection of relationships.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_relationships
+  #
+  # ==== Second Example
+  #     options = { fields: 'id' }
+  #     @data = @cxf_user.get_relationships(options)
+  def get_relationships(options = nil)
+    @client.raw('get', '/config/relationships', options)
+  end
+
+  # === Get relationship.
+  # Get a relationship info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_relationship(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id' }
+  #     @data = @cxf_user.get_relationship(1, options)
+  def get_relationship(id, options = nil)
+    @client.raw('get', "/config/relationships/#{id}", options)
+  end
+
+  # === Create relationship.
+  # Create a relationship with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       alias_1: 'eventsCopy',
+  #       alias_2: 'ticketsCopy',
+  #       object_model_1: 'Story',
+  #       object_model_2: 'Product'
+  #     }
+  #     @data = @cxf_user.create_relationship(data)
+  def create_relationship(data)
+    @client.raw('post', '/config/relationships', nil, data_transform(data))
+  end
+
+  # === Update relationship.
+  # Update a relationship info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       alias_1: 'eventsCopyModified',
+  #       alias_2: 'ticketsCopyModified',
+  #       object_model_1: 'Story',
+  #       object_model_2: 'Product'
+  #     }
+  #     @data = @cxf_user.update_relationship(5, data)
+  def update_relationship(id, data)
+    @client.raw('put', "/config/relationships/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete relationship.
+  # Delete a relationship.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_relationship(5)
+  def delete_relationship(id)
+    @client.raw('delete', "/config/relationships/#{id}")
+  end
+end

data/lib/user/config/seeds.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Seeds
+  ##
+  # == Seeds
+  #
+  # === Apply seeds.
+  # Apply seeds.
+  #
+  # ==== Example
+  #
+  def apply_seeds(data, async: false)
+    url = '/config/seeds'
+    url = "#{url}?async" if async
+    @client.raw('post', url, nil, data)
+  end
+
+  # === Get seed processes.
+  # Get a collection of seed processes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_seed_processes
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @cxf_user.get_seed_processes(options)
+  def get_seed_processes(options = nil)
+    @client.raw('post', '/config/seed-processes', options)
+  end
+
+  # === Get seed process.
+  # Get a seed process info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Seed process id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_seed_process(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_seed_process(1, options)
+  def get_seed_process(id, options = nil)
+    @client.raw('get', "/config/seed-processes/#{id}", options)
+  end
+end

data/lib/user/config/system_settings.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SystemSettings
+  ##
+  # == System Settings
+  #
+  # === Get settings by keys.
+  # Get a collection of settings using keys.
+  #
+  # ==== Example
+  #     options = {
+  #       setting_keys: 'email_transport_provider,email_template_provider,email_template_default_from_address'
+  #     }
+  #     @data = @cxf_user.get_settings_by_keys(options)
+  def get_settings_by_keys(options)
+    @client.raw('get', '/config/settings/by-keys', options)
+  end
+
+  # === Get settings.
+  # Get a collection of settings.
+  #
+  # ====  Example
+  #     @data = @cxf_user.get_settings
+  def get_settings
+    @client.raw('get', '/config/settings')
+  end
+
+  # === Create setting.
+  # Create a setting title with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'new_settings'
+  #     }
+  #     @data = @cxf_user.create_setting(data)
+  def create_setting(data)
+    @client.raw('post', '/config/settings', nil, data_transform(data))
+  end
+
+  # === Clear tag.
+  # Clear a tag info.
+  #
+  # ==== Parameters
+  # tag:: (Integer) -- Tag id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.clear_tag(1)
+  def clear_tag(tag)
+    @client.raw('get', "/config/settings/tags/#{tag}/clear")
+  end
+end