tamara 0.1.0

data/lib/tamara/json_schemas/risk_assessment.rb

@@ -0,0 +1,65 @@
+module Tamara
+  module JsonSchemas
+    module RiskAssessment
+      extend CheckoutOptionalKeys
+
+      GENDERS       = %w[Male Female].freeze
+      REQUIRED_KEYS = %w[
+        customer_age customer_dob customer_gender customer_nationality
+        is_premium_customer is_existing_customer is_guest_user
+        account_creation_date platform_account_creation_date
+        date_of_first_transaction is_card_on_file is_COD_customer
+        has_delivered_order is_phone_verified is_fraudulent_customer
+        total_ltv total_order_count order_amount_last3months
+        order_count_last3months last_order_date last_order_amount
+        reward_program_enrolled reward_program_points
+      ].freeze
+
+      # rubocop:disable Metrics/AbcSize
+      def self.schema(allows_null: false, params: nil)
+        @params = params
+        {
+          "$schema": "http://json-schema.org/draft-06/schema",
+          type: ["object", (allows_null ? "null" : nil)].compact,
+          properties: {
+            customer_age: Types::Integer.schema(min: 1, default: 21, allows_null: filtered_keys.exclude?("customer_age")),
+            customer_dob: Types::Date.schema(default: "01-12-2000", allows_null: filtered_keys.exclude?("customer_dob")),
+            customer_gender: Types::Enum.schema(values: GENDERS, default: "Female", allows_null: filtered_keys.exclude?("customer_gender")),
+            customer_nationality: Types::Enum.schema(values: COUNTRY_CODES, default: "SA", allows_null: filtered_keys.exclude?("customer_nationality")),
+            is_premium_customer: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("is_premium_customer")),
+            is_existing_customer: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("is_existing_customer")),
+            is_guest_user: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("is_guest_user")),
+            is_card_on_file: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("is_card_on_file")),
+            is_COD_customer: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("is_COD_customer")),
+            has_delivered_order: Types::Boolean.schema(default: true, allows_null: filtered_keys.exclude?("has_delivered_order")),
+            is_phone_verified: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("is_phone_verified")),
+            is_fraudulent_customer: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("is_fraudulent_customer")),
+            reward_program_enrolled: Types::Boolean.schema(default: false, allows_null: filtered_keys.exclude?("reward_program_enrolled")),
+
+            account_creation_date: Types::Date.schema(default: "12-06-2020", allows_null: filtered_keys.exclude?("account_creation_date")),
+            platform_account_creation_date: Types::Date.schema(default: "12-06-2020", allows_null: filtered_keys.exclude?("platform_account_creation_date")),
+            date_of_first_transaction: Types::Date.schema(default: "12-06-2020", allows_null: filtered_keys.exclude?("date_of_first_transaction")),
+            last_order_date: Types::Date.schema(allows_null: filtered_keys.exclude?("last_order_date")),
+
+            order_count_last3months: Types::Integer.schema(min: 0, allows_null: filtered_keys.exclude?("order_count_last3months")),
+            total_order_count: Types::Integer.schema(min: 0, allows_null: filtered_keys.exclude?("total_order_count")),
+            reward_program_points: Types::Integer.schema(min: 0, allows_null: filtered_keys.exclude?("reward_program_points")),
+            total_ltv: Types::Float.schema(min: 0, allows_null: filtered_keys.exclude?("total_ltv")),
+            order_amount_last3months: Types::Float.schema(min: 0, allows_null: filtered_keys.exclude?("order_amount_last3months")),
+            last_order_amount: Types::Float.schema(min: 0, allows_null: filtered_keys.exclude?("last_order_amount"))
+          },
+          required: REQUIRED_KEYS
+        }
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def self.filtered_keys
+        @filtered_keys ||= begin
+          optional_keys = (checkout_optional_keys[:risk_assessment] || []).map(&:to_s)
+
+          REQUIRED_KEYS - optional_keys
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/boolean.rb

@@ -0,0 +1,15 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module Boolean
+        def self.schema(default: nil, allows_null: false)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            type: ["boolean", (allows_null ? "null" : nil)].compact,
+            default: default
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/date.rb

@@ -0,0 +1,17 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module Date
+        def self.schema(allows_null: false, default: nil)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            type: ["string", (allows_null ? "null" : nil)].compact,
+            pattern: "^\\d{2}-\\d{2}-\\d{4}$",
+            default: default,
+            maxLength: 10
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/enum.rb

@@ -0,0 +1,15 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module Enum
+        def self.schema(values:, default: nil, allows_null: false)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            enum: allows_null ? [*values, nil] : values,
+            default: default
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/float.rb

@@ -0,0 +1,16 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module Float
+        def self.schema(allows_null: false, min: nil, max: nil)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            type: ["number", (allows_null ? "null" : nil)].compact,
+            minimum: min,
+            maximum: max
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/integer.rb

@@ -0,0 +1,17 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module Integer
+        def self.schema(allows_null: false, min: nil, max: nil, default: nil)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            type: ["integer", (allows_null ? "null" : nil)].compact,
+            minimum: min,
+            maximum: max,
+            default: default
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/string.rb

@@ -0,0 +1,21 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module String
+        def self.schema(allows_null: false, max_length: nil, default: nil)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            type: ["string", (allows_null ? "null" : nil)].compact,
+            minLength: allows_null ? 0 : 1,
+            maxLength: max_length,
+            default: default
+          }.compact
+        end
+
+        def schema
+          Tamara::JsonSchemas::Types::String.schema
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/url.rb

@@ -0,0 +1,15 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module Url
+        def self.schema(allows_null: false)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            type: ["string", (allows_null ? "null" : nil)].compact,
+            pattern: URI::DEFAULT_PARSER.make_regexp
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/types/uuid.rb

@@ -0,0 +1,19 @@
+module Tamara
+  module JsonSchemas
+    module Types
+      module Uuid
+        def self.schema(allows_null: false)
+          {
+            "$schema": "http://json-schema.org/draft-06/schema",
+            type: ["string", (allows_null ? "null" : nil)].compact,
+            pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+          }
+        end
+
+        def schema
+          Tamara::JsonSchemas::Types::Uuid.schema
+        end
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/validator.rb

@@ -0,0 +1,66 @@
+module Tamara
+  module JsonSchemas
+    module Validator
+      ERROR_MESSAGES = {
+        Pattern: "%{property} has invalid format",
+        Type: "%{property} must be a %{type}",
+        Required: "%{property} is required",
+        Minimum: "%{property} is too small",
+        Maximum: "%{property} is too large",
+        MinLength: "%{property} is too short",
+        MaxLength: "%{property} is too long",
+        Format: "%{property} has invalid format",
+        AnyOf: "%{property} has invalid value",
+        Enum: "%{property} must be one of: %{allowed_values}"
+      }.freeze
+
+      def validate_params!
+        JSON::Validator.validate!(schema, api_params)
+      rescue JSON::Schema::ValidationError => e
+        handle_validation_error(e)
+      end
+
+      private
+
+      def handle_validation_error(error)
+        error_key = normalize_error_key(error)
+        property = extract_property_name(error)
+        error_params = extract_error_params(error)
+
+        raise InvalidRequestError.new(
+          format_error_message(error_key, property, error_params),
+          error.message
+        )
+      end
+
+      def normalize_error_key(error)
+        error.failed_attribute.to_s
+          .split("::")
+          .last
+          .delete_suffix("Attribute")
+      end
+
+      def extract_property_name(error)
+        path = error.message[/'#\/([^']+)'/i, 1]
+        path&.humanize || "Field"
+      end
+
+      def extract_error_params(error)
+        schema_data = error.schema.instance_variable_get(:@schema)
+        {
+          type: schema_data["type"],
+          pattern: schema_data["pattern"],
+          allowed_values: Array(schema_data["enum"])&.join(", ")
+        }.compact
+      end
+
+      def format_error_message(error_key, property, error_params)
+        format(
+          ERROR_MESSAGES.fetch(error_key.to_sym, "%{property} is invalid"),
+          property: property,
+          **error_params
+        )
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/webhook.rb

@@ -0,0 +1,33 @@
+module Tamara
+  module JsonSchemas
+    module Webhook
+      include Validator
+
+      ORDER = "order".freeze
+      DISPUTE = "dispute".freeze
+
+      TYPES = [ORDER, DISPUTE].freeze
+
+      private
+
+      def schema
+        {
+          "$schema": "http://json-schema.org/draft-06/schema",
+          type: "object",
+          properties: {
+            type: Types::Enum.schema(values: TYPES),
+            events: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            url: Types::Url.schema
+          },
+          required: %w[type events url],
+          oneOf: Tamara::JsonSchemas::WebhookEvent.schema
+        }
+      end
+    end
+  end
+end

data/lib/tamara/json_schemas/webhook_event.rb

@@ -0,0 +1,37 @@
+module Tamara
+  module JsonSchemas
+    module WebhookEvent
+      EVENTS = {
+        Tamara::JsonSchemas::Webhook::ORDER =>
+        %w[order_approved order_authorised order_canceled order_updated order_captured order_refunded].freeze,
+        Tamara::JsonSchemas::Webhook::DISPUTE =>
+        %w[OrderDisputeAwaitingMerchantResponse OrderDisputeClosedMerchantAcceptedClaim
+           OrderDisputeClosedTamaraAcceptedClaim OrderDisputeClosedTamaraAcceptedAndMerchantRefundedClaim
+           OrderDisputeClosedClaimCancelled OrderDisputeWasUpdated].freeze
+      }.freeze
+
+      def self.schema
+        [
+          {
+            properties: {
+              type: { const: Tamara::JsonSchemas::Webhook::ORDER },
+              events: {
+                type: "array",
+                items: Types::Enum.schema(values: EVENTS[Tamara::JsonSchemas::Webhook::ORDER])
+              }
+            }
+          },
+          {
+            properties: {
+              type: { const: Tamara::JsonSchemas::Webhook::DISPUTE },
+              events: {
+                type: "array",
+                items: Types::Enum.schema(values: EVENTS[Tamara::JsonSchemas::Webhook::DISPUTE])
+              }
+            }
+          }
+        ]
+      end
+    end
+  end
+end

data/lib/tamara/version.rb

@@ -0,0 +1,3 @@
+module Tamara
+  VERSION = "0.1.0".freeze
+end

data/lib/tamara.rb

@@ -0,0 +1,101 @@
+require "logger"
+require "active_support"
+require "active_support/core_ext"
+require "faraday"
+require "json-schema"
+
+require_relative "tamara/version"
+
+# API resource support classes
+require "tamara/errors"
+require "tamara/configuration"
+
+# JSON schemas
+require "tamara/json_schemas/checkout_optional_keys"
+require "tamara/json_schemas/validator"
+
+# Primitive types
+require "tamara/json_schemas/types/boolean"
+require "tamara/json_schemas/types/date"
+require "tamara/json_schemas/types/enum"
+require "tamara/json_schemas/types/float"
+require "tamara/json_schemas/types/integer"
+require "tamara/json_schemas/types/string"
+require "tamara/json_schemas/types/url"
+require "tamara/json_schemas/types/uuid"
+
+require "tamara/json_schemas/address"
+require "tamara/json_schemas/amount"
+require "tamara/json_schemas/consumer"
+require "tamara/json_schemas/discount"
+require "tamara/json_schemas/item"
+require "tamara/json_schemas/merchant_url"
+require "tamara/json_schemas/orders/cancel"
+require "tamara/json_schemas/orders/create"
+require "tamara/json_schemas/payments/capture"
+require "tamara/json_schemas/payment_options/check"
+require "tamara/json_schemas/payment_types"
+require "tamara/json_schemas/risk_assessment"
+require "tamara/json_schemas/webhook"
+require "tamara/json_schemas/webhook_event"
+
+# API operations
+require "tamara/api/request"
+require "tamara/api/application_service"
+require "tamara/api/api_token"
+require "tamara/api/orders/authorize"
+require "tamara/api/orders/cancel"
+require "tamara/api/orders/create"
+require "tamara/api/orders/details/merchant_order"
+require "tamara/api/orders/details/tamara_order"
+require "tamara/api/payment_options/check"
+require "tamara/api/payments/capture"
+require "tamara/api/orders"
+require "tamara/api/payments"
+require "tamara/api/payment_options"
+require "tamara/api/payment_types"
+require "tamara/api/signature"
+require "tamara/api/webhooks"
+
+module Tamara
+  SANDBOX_URI     = "https://api-sandbox.tamara.co".freeze
+  PRODUCTION_URI  = "https://api.tamara.co".freeze
+
+  COUNTRY_CODES = %w[SA AE BH KW OM].freeze
+
+  class << self
+    attr_accessor :api_token, :notification_token, :public_key
+
+    def base_uri
+      if defined?(Rails) && Rails.respond_to?(:env)
+        Rails.env.production? ? PRODUCTION_URI : SANDBOX_URI
+      else
+        SANDBOX_URI
+      end
+    end
+
+    def checkout_uri
+      "#{base_uri}/checkout"
+    end
+
+    def orders_uri
+      "#{base_uri}/orders"
+    end
+
+    def payments_uri
+      "#{base_uri}/payments"
+    end
+
+    def webhooks_uri
+      "#{base_uri}/webhooks"
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/sig/tamara.rbs

@@ -0,0 +1,4 @@
+module Tamara
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: tamara
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Youssef Ossama
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+description:
+email:
+- y.ossama@qoyod.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/tamara/install_generator.rb
+- lib/generators/tamara/templates/tamara.rb
+- lib/tamara.rb
+- lib/tamara/api/api_token.rb
+- lib/tamara/api/application_service.rb
+- lib/tamara/api/orders.rb
+- lib/tamara/api/orders/authorize.rb
+- lib/tamara/api/orders/cancel.rb
+- lib/tamara/api/orders/create.rb
+- lib/tamara/api/orders/details/merchant_order.rb
+- lib/tamara/api/orders/details/tamara_order.rb
+- lib/tamara/api/payment_options.rb
+- lib/tamara/api/payment_options/check.rb
+- lib/tamara/api/payment_types.rb
+- lib/tamara/api/payments.rb
+- lib/tamara/api/payments/capture.rb
+- lib/tamara/api/request.rb
+- lib/tamara/api/signature.rb
+- lib/tamara/api/webhooks.rb
+- lib/tamara/configuration.rb
+- lib/tamara/errors.rb
+- lib/tamara/hmac.rb
+- lib/tamara/json_schemas/address.rb
+- lib/tamara/json_schemas/amount.rb
+- lib/tamara/json_schemas/checkout_optional_keys.rb
+- lib/tamara/json_schemas/consumer.rb
+- lib/tamara/json_schemas/discount.rb
+- lib/tamara/json_schemas/item.rb
+- lib/tamara/json_schemas/merchant_url.rb
+- lib/tamara/json_schemas/orders/cancel.rb
+- lib/tamara/json_schemas/orders/create.rb
+- lib/tamara/json_schemas/payment_options/check.rb
+- lib/tamara/json_schemas/payment_types.rb
+- lib/tamara/json_schemas/payments/capture.rb
+- lib/tamara/json_schemas/risk_assessment.rb
+- lib/tamara/json_schemas/types/boolean.rb
+- lib/tamara/json_schemas/types/date.rb
+- lib/tamara/json_schemas/types/enum.rb
+- lib/tamara/json_schemas/types/float.rb
+- lib/tamara/json_schemas/types/integer.rb
+- lib/tamara/json_schemas/types/string.rb
+- lib/tamara/json_schemas/types/url.rb
+- lib/tamara/json_schemas/types/uuid.rb
+- lib/tamara/json_schemas/validator.rb
+- lib/tamara/json_schemas/webhook.rb
+- lib/tamara/json_schemas/webhook_event.rb
+- lib/tamara/version.rb
+- sig/tamara.rbs
+homepage: https://github.com/autocloud/tamara-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/autocloud/tamara-rails
+  source_code_uri: https://github.com/autocloud/tamara-rails
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Rails integration for Tamara payment solution.
+test_files: []