payfast_za 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b973493a34161391e4ab35b8edbe3fd177a5c8a8ecbbcfe5ab97a0de4d7fab06
+  data.tar.gz: 46012f1ad0e3b04a9a309d3d6db4a1ae0c783d27b48661543c9522d23b3d7060
+SHA512:
+  metadata.gz: 076cb4e6505960d7b62afea1184ac6abda5dba0acb802d88ee6b95634b10f274e24b3f200a9012b59a1f563bf23aa6a870c16a8e266c8bb87389f8f1df6e54ba
+  data.tar.gz: 35828488a21633a5fadfd73b65b568351802fc6aa7b4ee31dab9580fb3a3742dc8b8c969a399e4848eb0a95506faccb737ee03dc522903fe1961b0412483810d

data/config/initializers/payfast.rb

@@ -0,0 +1,25 @@
+#Use this hook to configure the parameters necessary for your payments to work
+#Uncomment all the commented configs and use values applicable to your own application
+#Payfast credentials can be obtained from the Payfast website 
+#Consider using rails credentials for sensitive secrets 
+Payfast.setup do |config|
+
+  # ==> Configure Payfast Secrets
+  #config.payment_url = Rails.application.credentials.payfast[:payment_url]
+
+  #config.merchant_id = Rails.application.credentials.payfast[:merchant_id]
+  #config.merchant_key = Rails.application.credentials.payfast[:merchant_key]
+
+  #config.passphrase = Rails.application.credentials.payfast[:passphrase]
+
+  # ==> Configure Payfast Urls
+  #config.return_url = Rails.application.credentials.payfast[:return_url]
+  #config.cancel_url = Rails.application.credentials.payfast[:cancel_url]
+  #config.notify_url = Rails.application.credentials.payfast[:notify_url]
+
+  # ==> Configure Payfast confirmation email, if you've set email confirmation to true
+  #config.email_confirmation_address = Rails.application.credentials.payfast[:email_confirmation_address]
+
+  # ==> Configure Payfast payment methods, if you only want to use a specific payment method
+  #config.payment_method = Rails.application.credentials.payfast[:payment_method]
+end

data/lib/generators/payfast/install_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module Payfast
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      desc "Create Payfast configuration file"
+
+      def copy_config
+        directory "config/initializers", "config/initializers"
+      end
+    end
+  end
+end

data/lib/payfast/attributes.rb

@@ -0,0 +1,68 @@
+module Payfast
+  class Attributes
+    REQUIRED_FIELDS = {
+      merchant: [
+        'merchant_id',
+        'merchant_key' 
+      ],
+      transaction: [
+        'amount',
+        'item_name'
+      ]
+    }.freeze
+
+    OPTIONAL_FIELDS = {
+      merchant: [
+        'return_url',
+        'cancel_url',
+        'notify_url',
+        'fica_idnumber',
+      ],
+      customer: [
+        'name_first',
+        'name_last',
+        'email_address',
+        'cell_number'
+      ],
+      transaction: [
+        'm_payment_id',
+        'item_description',
+        'custom_int1',
+        'custom_int2',
+        'custom_int3',
+        'custom_int4',
+        'custom_int5',
+        'custom_str1',
+        'custom_str2',
+        'custom_str3',
+        'custom_str4',
+        'custom_str5'
+      ],
+      transaction_options: [
+        'email_confirmation'
+      ],
+      payment_methods: [
+        'payment_method'
+      ]
+    }.freeze
+
+    PAYFAST_RESPONSE = [
+      'uuid'
+    ],
+
+    HTTP_RESPONSE = [
+      'status',
+      'message'
+    ]
+
+    class << self
+      def required_fields
+        REQUIRED_FIELDS.values.flatten
+      end
+
+      def all_fields
+        (REQUIRED_FIELDS.values + OPTIONAL_FIELDS.values + PAYFAST_RESPONSE + HTTP_RESPONSE).flatten
+      end
+    end
+  end
+end

data/lib/payfast/client.rb

@@ -0,0 +1,68 @@
+require 'net/http'
+require 'json'
+
+module Payfast
+  class Client
+    attr_reader :payment_params
+
+    def self.create_payment(payment_params)
+      new(payment_params).create_payment
+    end
+
+    def initialize(payment_params)
+      @payment_params = payment_params
+    end
+
+    def create_payment
+      logger.info("[PAYFAST] STARTED POST to #{uri}")
+
+      response = Net::HTTP.post(uri, payment_data, headers)
+    
+      if response.code =~ /^[4-5]/
+        raise Payfast::PaymentError, "[PAYFAST] Error: Failed POST to #{uri}. HTTP #{response.code} - #{response.message}"
+      else
+        logger.info("[PAYFAST] COMPLETED POST to #{uri} - status: #{response.code}, message: #{response.message}")
+      end
+
+      endpoint_response = JSON.parse(response.body).transform_keys(&:to_sym)
+
+      response_hash = { uuid: endpoint_response[:uuid], status: response.code, message: response.message }
+
+      payment.new(payload.merge(response_hash))
+    end
+
+    private 
+
+    def uri
+      URI(Payfast.payment_url)
+    end
+
+    def payment_data
+      URI.encode_www_form(payload.merge({signature: signature}))
+    end
+
+    def signature
+      Payfast::SignatureGenerator.new(payload).digest
+    end
+
+    def payload
+      payment_builder.build(payment_params)
+    end
+
+    def headers
+      { 'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json' }
+    end
+
+    def logger
+      Payfast::Config.logger
+    end
+
+    def payment_builder
+      Payfast::PaymentBuilder
+    end
+
+    def payment
+      Payfast::Payment
+    end
+  end
+end

data/lib/payfast/config.rb

@@ -0,0 +1,25 @@
+require "logger"
+
+module Payfast
+  class << self
+    attr_accessor :merchant_id, :merchant_key, :passphrase, :payment_url, :cancel_url, :notify_url, :return_url, :payment_method
+
+    def setup(&block)
+      instance_eval(&block)
+    end
+  end
+
+  class Config
+    attr_writer :logger
+
+    class << self
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+
+      def client
+        Payfast::Client
+      end
+    end
+  end
+end

data/lib/payfast/errors.rb

@@ -0,0 +1,15 @@
+module Payfast
+  class PaymentError < StandardError; end
+
+  class UnknownValueError < StandardError
+    def initialize(msg="Unknown. Refer to docs")
+      super
+    end
+  end 
+  
+  class MissingAttributeError < StandardError
+    def initialize(msg="Required Attribute is missing. Refer to docs")
+      super
+    end
+  end 
+end

data/lib/payfast/payment.rb

@@ -0,0 +1,64 @@
+module Payfast
+  class Payment
+    ATTRIBUTES = Payfast::Attributes.all_fields.map(&:to_sym)
+
+    attr_reader(*ATTRIBUTES)
+
+    def initialize(args = {})
+      args.each do |k,v|
+        run_validations(args)
+        variable_name = "@#{k}"
+        instance_variable_set(variable_name,v) unless v.nil?
+      end
+    end
+
+    def self.create(args = {})
+      Payfast::Config.client.create_payment(args)
+    end
+
+    def success?
+      status == '200' && message == 'OK'
+    end
+
+    def failed?
+      !success?
+    end
+
+    private
+
+    def run_validations(args)
+      filter_attributes(args)
+      check_required_attributes(args)
+      check_payment_method(args)
+    end
+
+    def filter_attributes(args)
+      valid_attributes = Payfast::Attributes.all_fields.map(&:to_sym)
+      invalid_keys = args.keys - valid_attributes
+
+      unless invalid_keys.empty?
+        raise KeyError, "Unknown attribute(s): #{invalid_keys.join(', ')}"
+      end
+    end
+
+    def check_required_attributes(args)
+      required_fields = Payfast::Attributes.required_fields.map(&:to_sym)
+      missing_fields = required_fields - args.keys
+
+      unless missing_fields.empty?
+        raise KeyError, "Missing required attribute(s): #{missing_fields.join(', ')}"
+      end
+    end
+
+    def check_payment_method(args)
+      if args.key?(:payment_method)
+        payment_method = args[:payment_method]
+        accepted_methods = Payfast::PaymentMethods::ACCEPTED.keys.map(&:to_sym)
+        
+        unless accepted_methods.include?(payment_method)
+          raise UnknownValueError, "Unknown payment method: #{payment_method}. Accepted methods are #{accepted_methods.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/payfast/payment_builder.rb

@@ -0,0 +1,69 @@
+module Payfast
+  class PaymentBuilder
+    attr_reader :params
+
+    def self.build(params)
+      new(params).build
+    end
+
+    def initialize(params)
+      @params = params
+    end
+
+    def build
+      merchant_details.merge(customer_details, transaction_details, payment_methods).compact
+    end
+
+    private
+
+    def merchant_details
+      { 
+        merchant_id: Payfast.merchant_id, 
+        merchant_key: Payfast.merchant_key,
+        return_url: Payfast.return_url,
+        cancel_url: Payfast.cancel_url,
+        notify_url: Payfast.notify_url,
+        fica_idnumber: params[:fica_idnumber]
+      }
+    end
+
+    def customer_details
+      {
+        name_first: params[:first_name],
+        name_last: params[:last_name],
+        email_address: params[:email],
+        cell_number: params[:cell_number]
+      }
+    end
+
+    def transaction_details
+      {
+        amount: sprintf('%.2f', params[:amount]),
+        item_name: params[:item_name],
+        m_payment_id: params[:payment_id],
+        item_description: params[:description],
+        custom_int1: params[:metadata_int1],
+        custom_int2: params[:metadata_int2],
+        custom_int3: params[:metadata_int3],
+        custom_int4: params[:metadata_int4],
+        custom_int5: params[:metadata_int5],
+        custom_str1: params[:metadata_str1],
+        custom_str2: params[:metadata_str2],
+        custom_str3: params[:metadata_str3],
+        custom_str4: params[:metadata_str4],
+        custom_str5: params[:metadata_str5]
+      }
+    end
+
+    def transaction_options
+      {
+        email_confirmation: params[:email_confirmation],
+        confirmation_address: Payfast.email_confirmation_address
+      }
+    end
+
+    def payment_methods
+      { payment_method: Payfast.payment_method }
+    end
+  end
+end

data/lib/payfast/payment_methods.rb

@@ -0,0 +1,20 @@
+module Payfast
+  class PaymentMethods
+    ACCEPTED = {
+      ef: 'EFT',
+      cc: 'Credit card',
+      dc: 'Debit card',
+      mp: 'Masterpass Scan to Pay',
+      mc: 'Mobicred',
+      sc: 'SCode',
+      ss: 'SnapScan',
+      zp: 'Zapper',
+      mt: 'MoreTyme',
+      rc: 'Store card',
+      mu: 'Mukuru',
+      ap: 'Apple Pay',
+      sp: 'Samsung Pay',
+      cp: 'Capitec Pay'
+    }.freeze
+  end
+end

data/lib/payfast/signature_generator.rb

@@ -0,0 +1,26 @@
+require 'uri'
+require 'digest/md5'
+
+module Payfast
+  class SignatureGenerator
+    attr_reader :payment_params
+
+    def initialize(payment_params)
+      @payment_params = payment_params
+    end
+
+    def digest
+      Digest::MD5.hexdigest(encoded_params)
+    end
+
+    private
+
+    def encoded_params
+      URI.encode_www_form(payment_params.merge(passphrase: passphrase))
+    end
+
+    def passphrase
+      Payfast.passphrase
+    end
+  end
+end

data/lib/payfast/version.rb

@@ -0,0 +1,3 @@
+module Payfast
+  VERSION = '0.0.0'
+end

data/lib/payfast.rb

@@ -0,0 +1,8 @@
+require "payfast/attributes"
+require "payfast/client"
+require "payfast/errors"
+require "payfast/config"
+require "payfast/payment_builder"
+require "payfast/payment_methods"
+require "payfast/payment"
+require "payfast/signature_generator"

data/lib/payfast_za.rb

@@ -0,0 +1 @@
+require_relative "payfast"

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: payfast_za
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Blessing Muchaya
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description:
+email: btmuchaya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/initializers/payfast.rb
+- lib/generators/payfast/install_generator.rb
+- lib/payfast.rb
+- lib/payfast/attributes.rb
+- lib/payfast/client.rb
+- lib/payfast/config.rb
+- lib/payfast/errors.rb
+- lib/payfast/payment.rb
+- lib/payfast/payment_builder.rb
+- lib/payfast/payment_methods.rb
+- lib/payfast/signature_generator.rb
+- lib/payfast/version.rb
+- lib/payfast_za.rb
+homepage: https://rubygems.org/gems/payfast_za
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Payments with Payfast for Ruby on Rails apps in South Africa
+test_files: []