promonizr 1.13.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fed309f65e8324d77b60af02b5175fb67e5b98121106bb0960b95c3e9668c129
+  data.tar.gz: 30a328b823f945fceeaaaf7f29ad7f3d2ce1037e262f1a568bd0ba2b8b64c0b5
+SHA512:
+  metadata.gz: cf43239476710236ed5c5692520176e803f2380cc90ef4716e62729e4894fa55d21e425a1caa027b4f938b5f99f8764e5a0cea140b29983c85e059382ff34f8b
+  data.tar.gz: 554e4409828c3f2e836d8a179c3943a1860eaa072b5d2125ac73d83959eee030dd3ead4d6a43863dc8b3dde19d90cba14d0b4ba746b21e710a35a888e6d7190f

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/configuration.rb

@@ -0,0 +1 @@
+load 'promotion_api'

data/config/locales/br.yml

@@ -0,0 +1,103 @@
+---
+br:
+  promonizr:
+    actions: Acciones
+    add: Añadir
+    add_condition: Añadir condición
+    already_applied: ¿El beneficio ya fue aplicado?
+    amount: Cantidad
+    amount_hint: Cuántos 2x1 hay disponibles. Déjalo en blanco si no hay limites
+    applies:
+      from: Desde
+      to: Hasta
+    applies_to_installments: Aplica a las cuotas
+    applies_to_passengers: Aplica a los pasajeros
+    applies_to_passengers_hint: El primer pasajero es el %{first} y el último %{last}
+    benefits:
+      discount: Descuento
+      discount_percentage: Porcentaje de descuento
+    campaigns: Campañas
+    check_all: Marcar todas
+    clone: Clonar campaña
+    companies: Compañías
+    condition: Condición
+    condition_value: Valor
+    conditions:
+      between: Entre
+      eq: Igual a
+      gt: Mayor a
+      gte: Mayor o igual a
+      in: Dentro de
+      lt: Menor a
+      lte: Menor o igual a
+      neq: Distinto a
+      notIn: Fuera de
+    confirm_delete: "¿Estás seguro?"
+    countries:
+      br: Brasil
+      cl: Chile
+      co: Colombia
+    country: País
+    destroy: Borrar
+    discount_type: Tipo descuento
+    discount_value: Valor descuento
+    display_config: Configuración de visualización
+    edit: Editar campaña
+    end_date: Fecha de término
+    exclusions: Exclusiones
+    exclusions_hint: La promoción no se mostrará en estas páginas
+    featured_image: Imagen destacada
+    featured_label: "¿Es destacada?"
+    from_service: Procedencia
+    from_service_label: "¿La promoción proviene de un Web Service?"
+    gift_description: Descripción del regalo
+    gift_hint: Opcional, una breve descripción sobre el regalo
+    image: Imagen
+    kind: Tipo
+    kinds:
+      discount: Descuento
+      gift: Regalo
+      two_x_one: 2x1
+    new_campaign: Nueva campaña
+    not_rules_yet: No hay reglas aún
+    not_rules_yet_product_country: No hay reglas para esta combinación de país y producto
+    operator: Operador lógico
+    operators:
+      and: Y
+      or: O
+    payment_method: Medio de pago
+    payment_methods:
+      any: Cualquiera
+    product: Producto
+    products:
+      car_insurance: Seguro de auto
+      travel_assistance: Asistencia en viaje
+    remaining_characters: Caracteres restantes
+    required_dimensions: 'Dimensión requerida: %{height}×%{width} px'
+    rules: Reglas
+    save: Guardar
+    saving: Guardando...
+    simple_rules: Reglas simples
+    stage_pages:
+      landing: Landing
+      results: Página de resultados
+      sale: Sale page
+    start_date: Fecha de inicio
+    subtitle: Bajada
+    terms_of_service: Términos y condiciones
+    title: Título
+    uncheck_all: Desmarcar todas
+    update: Actualizar
+    hour: Hora
+    name: Nombre
+    short_description: Descripción breve
+    long_description: Descripción larga
+    special_event: Evento especial
+    special_events: Eventos especiales
+    new_special_event: Nuevo evento especial
+    edit_special_event: Editar evento especial
+    contest: Concurso
+    contests: Concursos
+    new_contest: Nuevo concurso
+    edit_contest: Editar concurso
+

data/config/locales/cl.yml

@@ -0,0 +1,102 @@
+---
+cl:
+  promonizr:
+    actions: Acciones
+    add: Añadir
+    add_condition: Añadir condición
+    already_applied: "¿El beneficio ya fue aplicado?"
+    amount: Cantidad
+    amount_hint: Cuántos 2x1 hay disponibles. Déjalo en blanco si no hay limites
+    applies:
+      from: Desde
+      to: Hasta
+    applies_to_installments: Aplica a las cuotas
+    applies_to_passengers: Aplica a los pasajeros
+    applies_to_passengers_hint: El primer pasajero es el %{first} y el último %{last}
+    benefits:
+      discount: Descuento
+      discount_percentage: Porcentaje de descuento
+    campaigns: Campañas
+    check_all: Marcar todas
+    clone: Clonar campaña
+    companies: Compañías
+    condition: Condición
+    condition_value: Valor
+    conditions:
+      between: Entre
+      eq: Igual a
+      gt: Mayor a
+      gte: Mayor o igual a
+      in: Dentro de
+      lt: Menor a
+      lte: Menor o igual a
+      neq: Distinto a
+      notIn: Fuera de
+    confirm_delete: "¿Estás seguro?"
+    countries:
+      br: Brasil
+      cl: Chile
+      co: Colombia
+    country: País
+    destroy: Borrar
+    discount_type: Tipo descuento
+    discount_value: Valor descuento
+    display_config: Configuración de visualización
+    edit: Editar campaña
+    end_date: Fecha de término
+    exclusions: Exclusiones
+    exclusions_hint: La promoción no se mostrará en estas páginas
+    featured_image: Imagen destacada
+    featured_label: "¿Es destacada?"
+    from_service: Procedencia
+    from_service_label: "¿La promoción proviene de un Web Service?"
+    gift_description: Descripción del regalo
+    gift_hint: Opcional, una breve descripción sobre el regalo
+    image: Imagen
+    kind: Tipo
+    kinds:
+      discount: Descuento
+      gift: Regalo
+      two_x_one: 2x1
+    new_campaign: Nueva campaña
+    not_rules_yet: No hay reglas aún
+    not_rules_yet_product_country: No hay reglas para esta combinación de país y producto
+    operator: Operador lógico
+    operators:
+      and: Y
+      or: O
+    payment_method: Medio de pago
+    payment_methods:
+      any: Cualquiera
+    product: Producto
+    products:
+      car_insurance: Seguro de auto
+      travel_assistance: Asistencia en viaje
+    remaining_characters: Caracteres restantes
+    required_dimensions: 'Dimensión requerida: %{height}×%{width} px'
+    rules: Reglas
+    save: Guardar
+    saving: Guardando...
+    simple_rules: Reglas simples
+    stage_pages:
+      landing: Landing
+      results: Página de resultados
+      sale: Sale page
+    start_date: Fecha de inicio
+    subtitle: Bajada
+    terms_of_service: Términos y condiciones
+    title: Título
+    uncheck_all: Desmarcar todas
+    update: Actualizar
+    hour: Hora
+    name: Nombre
+    short_description: Descripción breve
+    long_description: Descripción larga
+    special_event: Evento especial
+    special_events: Eventos especiales
+    new_special_event: Nuevo evento especial
+    edit_special_event: Editar evento especial
+    contest: Concurso
+    contests: Concursos
+    new_contest: Nuevo concurso
+    edit_contest: Editar concurso

data/config/locales/co.yml

@@ -0,0 +1,102 @@
+---
+co:
+  promonizr:
+    actions: Acciones
+    add: Añadir
+    add_condition: Añadir condición
+    already_applied: ¿El beneficio ya fue aplicado?
+    amount: Cantidad
+    amount_hint: Cuántos 2x1 hay disponibles. Déjalo en blanco si no hay limites
+    applies:
+      from: Desde
+      to: Hasta
+    applies_to_installments: Aplica a las cuotas
+    applies_to_passengers: Aplica a los pasajeros
+    applies_to_passengers_hint: El primer pasajero es el %{first} y el último %{last}
+    benefits:
+      discount: Descuento
+      discount_percentage: Porcentaje de descuento
+    campaigns: Campañas
+    check_all: Marcar todas
+    clone: Clonar campaña
+    companies: Compañías
+    condition: Condición
+    condition_value: Valor
+    conditions:
+      between: Entre
+      eq: Igual a
+      gt: Mayor a
+      gte: Mayor o igual a
+      in: Dentro de
+      lt: Menor a
+      lte: Menor o igual a
+      neq: Distinto a
+      notIn: Fuera de
+    confirm_delete: "¿Estás seguro?"
+    countries:
+      br: Brasil
+      cl: Chile
+      co: Colombia
+    country: País
+    destroy: Borrar
+    discount_type: Tipo descuento
+    discount_value: Valor descuento
+    display_config: Configuración de visualización
+    edit: Editar campaña
+    end_date: Fecha de término
+    exclusions: Exclusiones
+    exclusions_hint: La promoción no se mostrará en estas páginas
+    featured_image: Imagen destacada
+    featured_label: "¿Es destacada?"
+    from_service: Procedencia
+    from_service_label: "¿La promoción proviene de un Web Service?"
+    gift_description: Descripción del regalo
+    gift_hint: Opcional, una breve descripción sobre el regalo
+    image: Imagen
+    kind: Tipo
+    kinds:
+      discount: Descuento
+      gift: Regalo
+      two_x_one: 2x1
+    new_campaign: Nueva campaña
+    not_rules_yet: No hay reglas aún
+    not_rules_yet_product_country: No hay reglas para esta combinación de país y producto
+    operator: Operador lógico
+    operators:
+      and: Y
+      or: O
+    payment_method: Medio de pago
+    payment_methods:
+      any: Cualquiera
+    product: Producto
+    products:
+      car_insurance: Seguro de auto
+      travel_assistance: Asistencia en viaje
+    remaining_characters: Caracteres restantes
+    required_dimensions: 'Dimensión requerida: %{height}×%{width} px'
+    rules: Reglas
+    save: Guardar
+    saving: Guardando...
+    simple_rules: Reglas simples
+    stage_pages:
+      landing: Landing
+      results: Página de resultados
+      sale: Sale page
+    start_date: Fecha de inicio
+    subtitle: Bajada
+    terms_of_service: Términos y condiciones
+    title: Título
+    uncheck_all: Desmarcar todas
+    update: Actualizar
+    hour: Hora
+    name: Nombre
+    short_description: Descripción breve
+    long_description: Descripción larga
+    special_event: Evento especial
+    special_events: Eventos especiales
+    new_special_event: Nuevo evento especial
+    edit_special_event: Editar evento especial
+    contest: Concurso
+    contests: Concursos
+    new_contest: Nuevo concurso
+    edit_contest: Editar concurso

data/config/locales/en.yml

@@ -0,0 +1,102 @@
+---
+en:
+  promonizr:
+    actions: Actions
+    add: Add
+    add_condition: Add condition
+    already_applied: is benefit already applied?
+    amount: Amount
+    amount_hint: How many 2x1 are available. Leave it blank if there is no limits.
+    applies:
+      from: From
+      to: To
+    applies_to_installments: Applies to instalments
+    applies_to_passengers: Applies to passengers
+    applies_to_passengers_hint: El primer pasajero es el %{first} y el último %{last}
+    benefits:
+      discount: Discount
+      discount_percentage: Percentage discount
+    campaigns: Campaign
+    check_all: Check all
+    clone: Clone campaign
+    companies: Companies
+    condition: Condition
+    condition_value: Value
+    conditions:
+      between: Between
+      eq: Equal
+      gt: Greater than
+      gte: Great than or equal to
+      in: In
+      lt: Less than
+      lte: Less than or equal to
+      neq: Not equal
+      notIn: Not in
+    confirm_delete: Are you sure?
+    countries:
+      br: Brazil
+      cl: Chile
+      co: Colombia
+    country: Country
+    destroy: Destroy
+    discount_type: Discount type
+    discount_value: Discount value
+    display_config: Display config
+    edit: Edit campaign
+    end_date: End date
+    exclusions: Exclusions
+    exclusions_hint: La promoción no se mostrará en estas páginas
+    featured_image: Featured image
+    featured_label: Is it featured ?
+    from_service: From service
+    from_service_label: "¿La promoción proviene de un Web Service?"
+    gift_description: Gift description
+    gift_hint: Optional, a brief description about the gift
+    image: Image
+    kind: Type
+    kinds:
+      discount: Discount
+      gift: Gift
+      two_x_one: 2x1
+    new_campaign: New Campaign
+    not_rules_yet: There are not rules yet
+    not_rules_yet_product_country: There are not simple rules for this combination of product and country
+    operator: Logical operator
+    operators:
+      and: And
+      or: Or
+    payment_method: Payment method
+    payment_methods:
+      any: Any
+    product: Product
+    products:
+      car_insurance: Car insurance
+      travel_assistance: Travel assistance
+    remaining_characters: Remaining characters
+    required_dimensions: 'Required dimensions: %{height}×%{width} px'
+    rules: Rules
+    save: Save
+    saving: Saving...
+    simple_rules: Simple rules
+    stage_pages:
+      landing: Landing page
+      results: Results page
+      sale: Sale page
+    start_date: Start date
+    subtitle: Subtitle
+    terms_of_service: Terms of service
+    title: Title
+    uncheck_all: Uncheck all
+    update: Update
+    hour: Hour
+    name: Name
+    short_description: Short description
+    long_description: Long description
+    special_event: Special Event
+    special_events: Special Events
+    new_special_event: New Special Event
+    edit_special_event: Edit Special Event
+    contest: Contest
+    contests: Contests
+    new_contest: New contest
+    edit_contest: Edit contest

data/config/promotion_api.yml

@@ -0,0 +1,19 @@
+defaults: &defaults
+  url: https://ms-staging.comparaonline.com/promotions
+  cdn: https://webimg.comparaonline.com
+
+development:
+  <<: *defaults
+  cdn: ''
+
+qc:
+  <<: *defaults
+  cdn: https://qc.webimg.comparaonline.com
+
+staging:
+  <<: *defaults
+  cdn: https://staging.webimg.comparaonline.com
+
+production:
+  <<: *defaults
+  url: https://ms.comparaonline.com/promotions

data/lib/promonizr/campaigns.rb

@@ -0,0 +1,73 @@
+module Promonizr
+  # Campaigns implements CRUD methods on the Campaign resource from the
+  # Promotions web service.
+  module Campaigns
+    JSON_ATTRIBUTES = %i(rules conditions benefits display_config companies).freeze
+
+    STAGE_CODES   = %w(landing results).freeze
+    COUNTRY_CODES = %w(cl br co).freeze
+    KIND_CODES    = %w(two_x_one discount gift).freeze
+    BENEFITS_BY_PRODUCT = {
+      car_insurance:  %w(discount gift),
+      travel_assistance: %w(two_x_one discount)
+    }.freeze
+    RULE_OPERATORS  = %w(and or).freeze
+    RULE_CONDITIONS = %w(eq neq lt gt lte gte in notIn between).freeze
+
+    VALIDATION_RULES = {
+      title: {
+        max_length: 62
+      },
+      subtitle: {
+        max_length: 200
+      }
+    }.freeze
+
+    module_function
+
+    def api_url
+      CoConfig::PROMOTION_API[:url] + '/campaigns'
+    end
+
+    def all
+      @campaigns = Request.execute(:get, api_url)
+      @campaigns.is_a?(Array) ? @campaigns : []
+    end
+
+    def create(params)
+      Request.execute(:post, api_url, sanitized_params(params))
+    end
+
+    def update(id, params)
+      Request.execute(:put, url_with_id(id), sanitized_params(params))
+    end
+
+    def destroy(id)
+      Request.execute(:delete, url_with_id(id))
+    end
+
+    def get(id)
+      Request.execute(:get, url_with_id(id))
+    end
+
+    def url_with_id(id)
+      "#{api_url}/#{id}"
+    end
+
+    # Ensures that columns defined in JSON_ATTRIBUTES are json strings.
+    # boolean values will be casted
+    def sanitized_params(params)
+      JSON_ATTRIBUTES.each do |json_column|
+        next unless params.key?(json_column)
+
+        if params[json_column].is_a?(String)
+          params[json_column] = JSON.parse(params[json_column])
+        end
+
+        params[json_column] = Utils.cast_values(params[json_column]).to_json
+      end
+
+      params
+    end
+  end
+end

data/lib/promonizr/companies.rb

@@ -0,0 +1,23 @@
+module Promonizr
+  module Companies
+    module_function
+
+    # The gem's client must implement this in order to
+    # provide its own way to fetch all companies names.
+    # Returns: Array[String]
+    # Example:
+    # def all(...); Company.pluck(:name); end
+    def all(country_code, product_code_name)
+      raise NotImplementedError
+    end
+
+    # The gem's client must implement this in order to
+    # provide its own way to fetch companies using its url_name
+    # Returns: Array[String]
+    # Example:
+    # def by_url_names(...); Company.where(url_name: url_names); end
+    def by_url_names(url_names, country_code, product_code_name)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/promonizr/contests.rb

@@ -0,0 +1,63 @@
+module Promonizr
+  # Campaigns implements CRUD methods on the Campaign resource from the
+  # Promotions web service.
+  module Contests
+    JSON_ATTRIBUTES = %i(images).freeze
+
+    module_function
+
+    def api_url
+      CoConfig::PROMOTION_API[:url] + '/contests'
+    end
+
+    def all
+     @contests = Request.execute(:get, api_url)
+     @contests.is_a?(Array) ?@contests : []
+    end
+
+    def create(params)
+      Request.execute(:post, api_url, sanitized_params(params))
+    end
+
+    def update(id, params)
+      Request.execute(:put, url_with_id(id), sanitized_params(params))
+    end
+
+    def destroy(id)
+      Request.execute(:delete, url_with_id(id))
+    end
+
+    def get(id)
+      Request.execute(:get, url_with_id(id))
+    end
+
+    def url_with_id(id)
+      "#{api_url}/#{id}"
+    end
+
+    def search(params)
+      Request.execute(:post, url_with_id('search'), sanitized_params(params))
+    end
+
+    def find_current(params)
+      events = search(params)
+      events.empty? ? nil : events[0]
+    end
+
+    # Ensures that columns defined in JSON_ATTRIBUTES are json strings.
+    # boolean values will be casted
+    def sanitized_params(params)
+      JSON_ATTRIBUTES.each do |json_column|
+        next unless params.key?(json_column)
+
+        if params[json_column].is_a?(String)
+          params[json_column] = JSON.parse(params[json_column])
+        end
+
+        params[json_column] = params[json_column].to_json
+      end
+
+      params
+    end
+  end
+end

data/lib/promonizr/engine.rb

@@ -0,0 +1,4 @@
+module Promonizr
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/promonizr/evaluations.rb

@@ -0,0 +1,41 @@
+module Promonizr
+  module Evaluations
+    module_function
+
+    def api_url(rest)
+      "#{CoConfig::PROMOTION_API[:url]}/#{rest}"
+    end
+
+    def headers
+      {content_type: :json}
+    end
+
+    def evaluate(product, country_code, attributes = {})
+      attributes = attributes.with_indifferent_access
+
+      params = {
+        countryCode: country_code,
+        product: product,
+        form: attributes,
+        companyName: attributes[:company_name]
+      }.to_json
+
+      campaigns = Request.execute(:post, api_url('evaluate'), params, headers)
+      build_promotions(campaigns)
+    end
+
+    def evaluate_in_bulk(url, form_data, offers_data)
+      params = {
+        form: form_data,
+        offers: offers_data
+      }.to_json
+      Request.execute(:post, api_url("#{url}/campaigns_for_offers"), params, headers)
+        .map { |offer_id, campaigns| [offer_id, build_promotions(campaigns)] }
+        .to_h
+    end
+
+    def build_promotions(campaigns)
+      campaigns.map { |c| Promotion.new(c) }
+    end
+  end
+end

data/lib/promonizr/factories.rb

@@ -0,0 +1,2 @@
+GEM_ROOT = File.dirname(File.dirname(File.dirname(__FILE__)))
+Dir[File.join(GEM_ROOT, 'spec', 'factories', '*.rb')].each { |file| require(file) }