genesis_ruby 0.2.2 → 0.2.3

data/lib/genesis_ruby/api/requests/non_financial/billing_api/transactions.rb

@@ -0,0 +1,203 @@
+require 'date'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/order_by_fields'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/response_fields'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/transaction_types'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/sort_directions'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module BillingApi
+          # Billing Transactions API allows to programmatically retrieve information about billing transactions
+          # using given filters, pagination, and sort parameters.
+          class Transactions < Base::Graphql # rubocop:disable Metrics/ClassLength
+
+            include Api::Mixins::Requests::NonFinancial::BillingApi::SortAttributes
+            include Api::Mixins::Requests::NonFinancial::DateAttributes
+            include Api::Mixins::Requests::NonFinancial::PagingAttributes
+
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.root_key     = 'query'
+              self.request_name = 'billingTransactions'
+              self.request_path = 'billing_transactions'
+            end
+
+            # Response Fields
+            def response_fields
+              @response_fields || []
+            end
+
+            # Response Fields
+            def response_fields=(value)
+              parse_array_of_strings attribute: __method__,
+                                     value: value,
+                                     allowed: Api::Constants::Transactions::Parameters::NonFinancial::BillingApi::
+                                         ResponseFields.all
+            end
+
+            # List of billing transaction unique IDs. Max number of elements is 10000. Primary filter.
+            def unique_id
+              @unique_id || []
+            end
+
+            # List of billing transaction unique IDs. Max number of elements is 10000. Primary filter.
+            def unique_id=(value)
+              parse_array_of_strings attribute: __method__, value: value, allow_empty: true
+            end
+
+            # List of billing statement names. Max number of elements allowed is 10. Primary filter.
+            def billing_statement
+              @billing_statement || []
+            end
+
+            # List of billing statement names. Max number of elements allowed is 10. Primary filter.
+            def billing_statement=(value)
+              parse_array_of_strings attribute: __method__, value: value, allow_empty: true
+            end
+
+            # List of merchant transaction IDs. Max number of elements allowed is 10000. Primary filter.
+            def merchant_transaction_id
+              @merchant_transaction_id || []
+            end
+
+            # List of merchant transaction IDs. Max number of elements allowed is 10000. Primary filter.
+            def merchant_transaction_id=(value)
+              parse_array_of_strings attribute: __method__, value: value, allow_empty: true
+            end
+
+            # List of master account names. Max number of elements allowed is 10. Secondary filter.
+            def master_account_name
+              @master_account_name || []
+            end
+
+            # List of master account names. Max number of elements allowed is 10. Secondary filter.
+            def master_account_name=(value)
+              parse_array_of_strings attribute: __method__, value: value, allow_empty: true
+            end
+
+            # List of billing transaction types. Max number of elements allowed is 10.
+            def transaction_type
+              @transaction_type || []
+            end
+
+            # List of billing transaction types. Max number of elements allowed is 10.
+            def transaction_type=(value)
+              parse_array_of_strings attribute: __method__,
+                                     value: value,
+                                     allowed: Api::Constants::Transactions::Parameters::NonFinancial::BillingApi::
+                                         TransactionTypes.all,
+                                     allow_empty: true
+            end
+
+            protected
+
+            # Billing API Authorization Token
+            def init_authorization_token
+              api_config.bearer_token = configuration.billing_api_token
+            end
+
+            # Billing API Transactions field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[response_fields]
+              field_values.merge! sort_by_direction: Api::Constants::Transactions::Parameters::NonFinancial::
+                                      SortDirections.all,
+                                  sort_by_field: Api::Constants::Transactions::Parameters::NonFinancial::BillingApi::
+                                      OrderByFields.all
+            end
+
+            # Billing API Transactions custom validations
+            def check_requirements
+              super
+
+              validate_filters
+              validate_dates if @start_date || @end_date
+              validate_array_fields_size
+            end
+
+            # Transactions GraphQL query filters
+            def query_filters # rubocop:disable Metrics/MethodLength
+              {
+                filter: {
+                  startDate:             escape_argument(:start_date),
+                  endDate:               escape_argument(:end_date),
+                  uniqueId:              unique_id,
+                  billingStatement:      billing_statement,
+                  merchantTransactionId: merchant_transaction_id,
+                  masterAccountName:     master_account_name,
+                  transactionType:       transaction_type
+                },
+                sort:   {
+                  byDirection: sort_by_direction,
+                  byField:     sort_by_field
+                },
+                paging: {
+                  page:    page,
+                  perPage: per_page
+                }
+              }
+            end
+
+            # Transactions Response Fields
+            def query_response_fields
+              {
+                items:  response_fields,
+                paging: paging_query_fields
+              }
+            end
+
+            # Format given timestamp string to GraphQL suitable argument
+            def escape_argument(attribute)
+              __send__(attribute).to_s.empty? ? nil : "\"#{__send__(attribute)}\""
+            end
+
+            # Validate Billing API Primary filters
+            def validate_filters
+              unless start_date.nil? && end_date.nil? && unique_id.empty? && billing_statement.empty? &&
+                     merchant_transaction_id.empty?
+                return
+              end
+
+              raise ParameterError, 'At least one Primary filter is required!'
+            end
+
+            # Validate StartDate and EndDate
+            def validate_dates
+              message   = 'If filter startDate is provided, then endDate should also be provided and vice versa.'
+              raise ParameterError, message unless @start_date.is_a?(DateTime) && @end_date.is_a?(DateTime)
+
+              raise ParameterError, 'EndData must be after StartDate!' if @start_date == @end_date
+
+              days_diff = @end_date - @start_date
+              message   = 'Maximum difference between StartDate and EndDate is 7 days'
+              raise ParameterError, message unless days_diff >= 0 && days_diff <= 7
+            end
+
+            # Validate Billing API Array field requirements
+            def validate_array_fields_size
+              validate_array_size :unique_id, 10_000
+              validate_array_size :billing_statement, 10
+              validate_array_size :merchant_transaction_id, 10_000
+              validate_array_size :master_account_name, 10
+              validate_array_size :transaction_type, 10
+            end
+
+            # Validate Max size of the given Array attribute
+            def validate_array_size(attribute, size)
+              message = format 'Max array length on %{attribute} exceed allowed size of %{size}',
+                               attribute: attribute,
+                               size:      size
+
+              raise ParameterError, message if __send__(attribute).length > size
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/reconcile/date_range.rb

@@ -8,43 +8,9 @@ module GenesisRuby
           # The response is paginated, each request will return 100 entries max.
           class DateRange < Api::Request
 
-            attr_reader :page
-
-            # Start of the requested date range (time is optional)
-            def start_date
-              format = if start_date_time?
-                         Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
-                       else
-                         Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
-                       end
-
-              @start_date&.strftime format
-            end
-
-            # Start of the requested date range (time is optional)
-            def start_date=(value)
-              self.start_date_time = Utils::Common.date_has_time? value
-
-              parse_date attribute: __method__, value: value, allow_empty: false
-            end
-
-            # Start of the requested date range (time is optional)
-            def end_date
-              format = if end_date_time?
-                         Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
-                       else
-                         Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
-                       end
-
-              @end_date&.strftime format
-            end
+            include Api::Mixins::Requests::NonFinancial::DateAttributes
 
-            # End of the requested date range (time is optional)
-            def end_date=(value)
-              self.end_date_time = Utils::Common.date_has_time? value
-
-              parse_date attribute: __method__, value: value, allow_empty: true
-            end
+            attr_reader :page
 
             # The page within the paginated result, defaults to 1
             def page=(value)
@@ -75,20 +41,6 @@ module GenesisRuby
               }
             end
 
-            private
-
-            attr_accessor :start_date_time, :end_date_time
-
-            # Start Date has time within the given string
-            def start_date_time?
-              self.start_date_time ||= false
-            end
-
-            # End Date has time within the given string
-            def end_date_time?
-              self.end_date_time ||= false
-            end
-
           end
         end
       end

data/lib/genesis_ruby/builder.rb

@@ -1,6 +1,7 @@
 require 'genesis_ruby/builders/xml'
 require 'genesis_ruby/builders/form'
 require 'genesis_ruby/builders/json'
+require 'genesis_ruby/builders/graphql'
 require 'genesis_ruby/errors/builder_error'
 
 module GenesisRuby
@@ -16,12 +17,16 @@ module GenesisRuby
     # Builder FORM
     FORM = 'form'.freeze
 
+    # Builder GraphQL
+    GRAPHQL = 'graphql'.freeze
+
     # Initialize the Builder Interface based on the Request requirements
     def initialize(request_interface)
       case request_interface
       when XML then @builder_context = Builders::Xml.new
       when FORM then @builder_context = Builders::Form.new
       when JSON then @builder_context = Builders::Json.new
+      when GRAPHQL then @builder_context = Builders::Graphql.new
       else
         raise GenesisRuby::BuilderError, 'Invalid Builder interface!'
       end

data/lib/genesis_ruby/builders/graphql.rb

@@ -0,0 +1,118 @@
+require 'genesis_ruby/builders/base'
+require 'json'
+
+module GenesisRuby
+  module Builders
+    # GraphQL builder
+    class Graphql < Base
+
+      # Builder GraphQL constructor
+      def initialize
+        @document = ''
+        super
+      end
+
+      # Outputs generated document
+      def output
+        @document
+      end
+
+      # Created GraphQL query from provided structure
+      def populate_nodes(structure)
+        validate_structure(structure)
+
+        @document = build_query(structure)
+      end
+
+      private
+
+      # Validates given structure
+      def validate_structure(structure)
+        raise BuilderError, 'Invalid Hash structure given in Graphql builder!' unless structure.is_a? Hash
+
+        root_key = structure.keys.first
+
+        raise BuilderError, 'Missing structure root key in Graphql builder' if root_key.nil?
+        raise BuilderError, 'Invalid GraphQL structure given in GraphQL builder' unless structure[root_key].is_a? Hash
+      end
+
+      # Build GraphQL Query
+      def build_query(structure)
+        ident           = ' ' * 2
+        root_key        = structure.keys.first
+        filters         = build_filters structure[root_key][:filters]
+        response_fields = build_response_fields structure[root_key][:response_fields], ident * 2
+
+        format("%{root} {\n#{ident}%{action}(%{filters})\n#{ident}{\n%{response_fields}\n#{ident}}\n}",
+               root:            root_key,
+               action:          structure[root_key][:action].to_s,
+               filters:         filters,
+               response_fields: response_fields)
+      end
+
+      # Build GraphQL filters
+      def build_filters(data)
+        out = ''
+
+        return out unless data.is_a? Hash
+
+        data.each do |key, value|
+          out += splat_hash Hash[key, value]
+          out += ', ' unless data.keys.last == key
+        end
+
+        out
+      end
+
+      # Builds given hash in the GraphQL syntax
+      # { key: { key1: 'value1', key2: 'value2' } } becomes key: { key1: value1, key2: value2 }
+      def splat_hash(data)
+        out      = ''
+        root_key = data.keys.first
+
+        return out unless data[root_key].is_a? Hash
+
+        data[root_key].each do |key, value|
+          out += format '%{key}: %{value}', key: key.to_s, value: value.to_s
+          out += ', ' unless key == data[root_key].keys.last
+        end
+
+        format '%{key}: { %{out} }', key: root_key, out: out
+      end
+
+      # Build GraphQL query response fields
+      def build_response_fields(data, ident)
+        out = ''
+
+        return out unless data.is_a? Hash
+
+        data.each do |key, value|
+          out += formatted_array Hash[key, value], ident
+          out += "\n" unless key == data.keys.last
+        end
+
+        out
+      end
+
+      # Build given array into formatted GraphQL query items
+      # items: [item1 item2 item3] will output
+      #   items
+      #   {
+      #     item1
+      #     item2
+      #     item3
+      #   }
+      def formatted_array(data, ident)
+        out      = ''
+        root_key = data.keys.first
+
+        return out unless data[root_key].is_a? Array
+
+        out += data[root_key].map { |key| "#{ident}  #{key}" }.join("\n")
+
+        format "#{ident}%{key}\n#{ident}{\n%{out}\n#{ident}}", key: root_key, out: out
+      end
+
+    end
+  end
+end

data/lib/genesis_ruby/configuration.rb

@@ -20,8 +20,8 @@ module GenesisRuby
     # Default sanitize Response
     DEFAULT_SANITIZE_RESPONSE = true
 
-    # Genesis basic configuration - credentials, endpoint, environment, token
-    attr_writer :username, :password, :token, :interface, :format_response, :sanitize_response
+    # Genesis basic configuration - credentials, endpoint, environment, token, etc
+    attr_writer :username, :password, :token, :interface, :format_response, :sanitize_response, :billing_api_token
 
     # Configuration constructor
     def initialize
@@ -64,6 +64,11 @@ module GenesisRuby
       @force_smart_routing ||= false
     end
 
+    # Defines the Bearer token used for authorization in Billing API Service
+    def billing_api_token
+      @billing_api_token || ''
+    end
+
     # Genesis Request Timeout
     def timeout=(value)
       timeout = value.to_i
@@ -187,6 +192,10 @@ module GenesisRuby
         smart_router: {
           GenesisRuby::Api::Constants::Environments::PRODUCTION => 'prod.api.',
           GenesisRuby::Api::Constants::Environments::STAGING    => 'staging.api.'
+        },
+        api_service:  {
+          GenesisRuby::Api::Constants::Environments::PRODUCTION => 'prod.api.',
+          GenesisRuby::Api::Constants::Environments::STAGING    => 'staging.api.'
         }
       }
     end

data/lib/genesis_ruby/dependencies.rb

@@ -21,6 +21,8 @@ require 'genesis_ruby/api/requests/base/financials/credit_card'
 require 'genesis_ruby/api/requests/base/financials/south_american_payments'
 require 'genesis_ruby/api/requests/base/reference'
 require 'genesis_ruby/api/requests/base/versioned'
+require 'genesis_ruby/api/requests/financial/sdd/sale'
+require 'genesis_ruby/api/requests/base/graphql'
 require 'genesis_ruby/api/notification'
 
 # Load Financial and Non Financial API Requests

data/lib/genesis_ruby/network/adapter/net_http_adapter.rb

@@ -90,17 +90,28 @@ module GenesisRuby
 
         # Define Headers
         def headers
-          headers = {
-            'Authorization' => "Basic #{request_data.user_login}",
-            'User-Agent'    => request_data.user_agent
-          }
+          data = common_headers
 
-          unless request_data.type == Api::Request::METHOD_GET
-            headers.merge! 'Content-Type'   => request_data.format,
-                           'Content-Length' => request_data.body&.length.to_s
-          end
+          data.merge! payload_headers unless request_data.type == Api::Request::METHOD_GET
+          data.merge! request_data.headers if request_data.headers.is_a?(Hash) && !request_data.headers.empty?
+
+          data
+        end
+
+        # Provides default request headers
+        def common_headers
+          {
+            'Authorization' => request_data.user_login.to_s,
+            'User-Agent'    => request_data.user_agent.to_s
+          }
+        end
 
-          headers
+        # Payload Headers
+        def payload_headers
+          {
+            'Content-Type'   => request_data.format,
+            'Content-Length' => request_data.body&.length.to_s
+          }
         end
 
         # Safe Request execution

data/lib/genesis_ruby/network/base_network.rb

@@ -1,6 +1,4 @@
-require 'genesis_ruby/errors/invalid_argument_error'
 require 'genesis_ruby/utils/options/network_adapter_config'
-require 'base64'
 
 module GenesisRuby
   module Network
@@ -75,18 +73,7 @@ module GenesisRuby
 
       # Map the Request to the Network Adapter object
       def adapter_data_mapper(request)
-        network_adapter_config.map_from_request(request).merge(
-          {
-            user_login: build_user_login,
-            user_agent: network_user_agent,
-            timeout:    configuration.timeout
-          }
-        )
-      end
-
-      # Build the User login string used for the Authorization Header
-      def build_user_login
-        Base64.urlsafe_encode64("#{configuration.username}:#{configuration.password}")
+        network_adapter_config.map_from_request(request, configuration).merge({ user_agent: network_user_agent })
       end
 
       # The default user agent for every Network

data/lib/genesis_ruby/utils/formatters/response/formats/timestamp.rb

@@ -11,7 +11,7 @@ module GenesisRuby
 
             # The Response keys that the formatter will be applied to
             def formatting_keys
-              %w(timestamp)
+              %w(timestamp transactionDate valueDate)
             end
 
             # Format the given timestamp to DateTime object

data/lib/genesis_ruby/utils/options/api_config.rb

@@ -13,6 +13,8 @@ module GenesisRuby
           self.type                  = GenesisRuby::Api::Request::METHOD_POST
           self.format                = Builder::XML
           self.parser_skip_root_node = true
+          self.authorization         = GenesisRuby::Api::Request::AUTH_TYPE_BASIC
+          self.bearer_token          = nil
         end
 
         # Load pre-defined JSON configuration
@@ -22,6 +24,8 @@ module GenesisRuby
           self.type                  = GenesisRuby::Api::Request::METHOD_POST
           self.format                = Builder::JSON
           self.parser_skip_root_node = false
+          self.authorization         = GenesisRuby::Api::Request::AUTH_TYPE_BASIC
+          self.bearer_token          = nil
         end
 
         # Load pre-defined FORM configuration
@@ -31,6 +35,8 @@ module GenesisRuby
           self.type                  = GenesisRuby::Api::Request::METHOD_POST
           self.format                = Builder::FORM
           self.parser_skip_root_node = true
+          self.authorization         = GenesisRuby::Api::Request::AUTH_TYPE_BASIC
+          self.bearer_token          = nil
         end
 
         # Load pre-defined GET configuration
@@ -40,6 +46,19 @@ module GenesisRuby
           self.type                  = GenesisRuby::Api::Request::METHOD_GET
           self.format                = Builder::XML
           self.parser_skip_root_node = false
+          self.authorization         = GenesisRuby::Api::Request::AUTH_TYPE_BASIC
+          self.bearer_token          = nil
+        end
+
+        # Load pre-defined GraphQL configuration
+        def load_graphql_config
+          self.protocol              = GenesisRuby::Api::Request::PROTOCOL_HTTPS
+          self.port                  = GenesisRuby::Api::Request::PORT_HTTPS
+          self.type                  = GenesisRuby::Api::Request::METHOD_POST
+          self.format                = Builder::GRAPHQL
+          self.parser_skip_root_node = false
+          self.authorization         = GenesisRuby::Api::Request::AUTH_TYPE_TOKEN
+          self.bearer_token          = nil
         end
 
       end

data/lib/genesis_ruby/utils/options/network_adapter_config.rb

@@ -1,4 +1,6 @@
 require 'genesis_ruby/utils/options/base'
+require 'genesis_ruby/errors/invalid_argument_error'
+require 'base64'
 
 module GenesisRuby
   module Utils
@@ -7,13 +9,17 @@ module GenesisRuby
       class NetworkAdapterConfig < Base
 
         # Map the Adapter configuration from the Request object
-        def map_from_request(request) # rubocop:disable Metrics/AbcSize
-          self.body     = request.build_document
-          self.url      = request.api_config.url
-          self.type     = request.api_config.type
-          self.port     = request.api_config.port
-          self.protocol = request.api_config.protocol
-          self.format   = fetch_content_type(request.api_config.format)
+        def map_from_request(request, configuration) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          self.body          = request.build_document
+          self.url           = request.api_config.url
+          self.type          = request.api_config.type
+          self.port          = request.api_config.port
+          self.protocol      = request.api_config.protocol
+          self.format        = fetch_content_type request.api_config.format
+          self.authorization = request.api_config.authorization
+          self.user_login    = build_user_login request, configuration
+          self.setimeout     = configuration.timeout
+          self.headers       = build_additional_headers request
 
           self
         end
@@ -23,17 +29,46 @@ module GenesisRuby
         # Retrieve the Request data format that must be used as Content-Type header
         def fetch_content_type(data_format)
           case data_format
-          when Builder::XML
-            'text/xml'
-          when Builder::JSON
-            'application/json'
-          when Builder::FORM
-            'application/x-www-form-urlencoded'
+          when Builder::XML then 'text/xml'
+          when Builder::JSON then 'application/json'
+          when Builder::FORM then 'application/x-www-form-urlencoded'
+          when Builder::GRAPHQL then 'application/graphql'
+          else raise InvalidArgumentError, 'Invalid request format type. Allowed are XML, JSON and FORM'
+          end
+        end
+
+        # Build the User login string used for the Authorization Header
+        def build_user_login(request, configuration)
+          auth = request.api_config.authorization
+          kind = fetch_authorization_kind auth
+
+          return "#{kind} #{request.api_config.bearer_token}" if auth == Api::Request::AUTH_TYPE_TOKEN
+
+          "#{kind} #{Base64.urlsafe_encode64("#{configuration.username}:#{configuration.password}")}"
+        end
+
+        # Fetches the Request authorization kind
+        # TODO: Add AUTH_TYPE_NONE, should be used for METHOD CONTINUE request
+        def fetch_authorization_kind(auth)
+          case auth
+          when Api::Request::AUTH_TYPE_BASIC
+            'Basic'
+          when Api::Request::AUTH_TYPE_TOKEN
+            'Bearer'
           else
-            raise InvalidArgumentError, 'Invalid request format type. Allowed are XML, JSON and FORM'
+            raise InvalidArgumentError, 'Invalid Authorization given in the Request. Allowed: BASIC, TOKEN'
           end
         end
 
+        # Build additional headers to be added based on the specific request format
+        def build_additional_headers(request)
+          headers = {}
+
+          headers.merge! 'Accept' => 'application/json' if request.api_config.format == Builder::GRAPHQL
+
+          headers
+        end
+
       end
     end
   end

data/lib/genesis_ruby/utils/transactions/financial_types.rb

@@ -11,7 +11,7 @@ module GenesisRuby
           # Return array containing all available Web Payment Form transaction types
           def all # rubocop:disable Metrics/MethodLength
             [
-              AFRICAN_MOBILE_PAYOUT, AFRICAN_MOBILE_SALE, APPLE_PAY, ARGENCARD, AURA, AUTHORIZE, AUTHORIZE_3D,
+              AFRICAN_MOBILE_PAYOUT, AFRICAN_MOBILE_SALE, ALIPAY, APPLE_PAY, ARGENCARD, AURA, AUTHORIZE, AUTHORIZE_3D,
               BALOTO, BANCOMER, BANCONTACT, BANCO_DE_OCCIDENTE, BANCO_DO_BRASIL, BITPAY_PAYOUT, BITPAY_REFUND,
               BITPAY_SALE, BOLETO, BRADESCO,
               CABAL, CAPTURE, CASHU, CENCOSUD, CREDIT,