k2-connect-ruby 3.1.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/pull_request_template.md +31 -0
- data/.gitignore +2 -0
- data/Gemfile.lock +38 -5
- data/README.md +499 -198
- data/k2-connect-ruby.gemspec +39 -35
- data/lib/k2-connect-ruby/entity.rb +39 -9
- data/lib/k2-connect-ruby/http_client.rb +43 -0
- data/lib/k2-connect-ruby/k2_entity/k2_entity.rb +12 -11
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/destination/destination_request.rb +27 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/destination/external_bank_account.rb +32 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/destination/external_mpesa_wallet.rb +38 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/destination/external_paybill.rb +31 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/destination/external_till.rb +30 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/destination/merchant_bank_account.rb +27 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/destination/merchant_mpesa_wallet.rb +27 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/external_recipient/bank_account.rb +17 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/external_recipient/mobile_wallet.rb +24 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/external_recipient/paybill.rb +17 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/external_recipient/recipient_request.rb +32 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/external_recipient/till.rb +17 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/external_recipient.rb +54 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_stk.rb +14 -31
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/payment_link.rb +53 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/payment_links/payment_link_request.rb +43 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/reversal.rb +39 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/reversals/reversal_request.rb +39 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/send_money/send_money_request.rb +53 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/send_money.rb +73 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/stk_push/stk_push_request.rb +51 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/transfer_account/merchant_bank_account.rb +35 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/transfer_account/merchant_mpesa_wallet.rb +38 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/transfer_account/transfer_account_request.rb +25 -0
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/transfer_account.rb +49 -0
- data/lib/k2-connect-ruby/k2_entity/k2_polling.rb +16 -13
- data/lib/k2-connect-ruby/k2_entity/k2_subscribe.rb +16 -14
- data/lib/k2-connect-ruby/k2_entity/k2_token.rb +14 -39
- data/lib/k2-connect-ruby/k2_entity/polling/polling_request.rb +48 -0
- data/lib/k2-connect-ruby/k2_entity/webhook/webhook_subscription_request.rb +66 -0
- data/lib/k2-connect-ruby/k2_errors.rb +15 -71
- data/lib/k2-connect-ruby/k2_services/base_service.rb +25 -0
- data/lib/k2-connect-ruby/k2_services/k2_client.rb +7 -6
- data/lib/k2-connect-ruby/k2_services/payloads/daraja_webhooks.rb +43 -0
- data/lib/k2-connect-ruby/k2_services/payloads/k2_transaction.rb +20 -18
- data/lib/k2-connect-ruby/k2_services/payloads/k2_webhooks.rb +36 -32
- data/lib/k2-connect-ruby/k2_services/payloads/transactions/incoming_payment.rb +31 -29
- data/lib/k2-connect-ruby/k2_services/payloads/transactions/outgoing_payment.rb +3 -1
- data/lib/k2-connect-ruby/k2_services/payloads/transactions/payment_link.rb +38 -0
- data/lib/k2-connect-ruby/k2_services/payloads/transactions/reversal.rb +35 -0
- data/lib/k2-connect-ruby/k2_services/payloads/transactions/send_money_payment.rb +25 -0
- data/lib/k2-connect-ruby/k2_services/payloads/transactions/transfer.rb +2 -0
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/b2b_transaction_received.rb +9 -3
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/b2b_transaction_reversed.rb +22 -0
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/buygoods_transaction_received.rb +6 -0
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/buygoods_transaction_reversed.rb +4 -0
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/card_transaction_received.rb +18 -0
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/card_transaction_reversed.rb +17 -0
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/card_transaction_voided.rb +17 -0
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/customer_created.rb +11 -7
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/transfer_webhook.rb +50 -0
- data/lib/k2-connect-ruby/k2_services/send_introspect_token_request_service.rb +56 -0
- data/lib/k2-connect-ruby/k2_services/send_k2_connect_get_request_service.rb +42 -0
- data/lib/k2-connect-ruby/k2_services/send_k2_connect_post_request_service.rb +44 -0
- data/lib/k2-connect-ruby/k2_services/send_request_token_request_service.rb +55 -0
- data/lib/k2-connect-ruby/k2_services/send_revoke_token_request_service.rb +56 -0
- data/lib/k2-connect-ruby/k2_services/send_token_info_request_service.rb +44 -0
- data/lib/k2-connect-ruby/k2_services.rb +29 -0
- data/lib/k2-connect-ruby/k2_utilities/config/k2_config.rb +18 -26
- data/lib/k2-connect-ruby/k2_utilities/config/k2_config.yml +9 -10
- data/lib/k2-connect-ruby/k2_utilities/k2_authenticator.rb +12 -5
- data/lib/k2-connect-ruby/k2_utilities/k2_connection.rb +0 -49
- data/lib/k2-connect-ruby/k2_utilities/k2_connection_helper.rb +21 -0
- data/lib/k2-connect-ruby/k2_utilities/k2_process_result.rb +16 -15
- data/lib/k2-connect-ruby/k2_utilities/k2_process_webhook.rb +34 -21
- data/lib/k2-connect-ruby/k2_utilities/k2_url_parse.rb +3 -1
- data/lib/k2-connect-ruby/k2_utilities/phone_number_validator.rb +15 -0
- data/lib/k2-connect-ruby/k2_utilities.rb +9 -20
- data/lib/k2-connect-ruby/version.rb +1 -1
- data/lib/k2-connect-ruby.rb +14 -13
- metadata +101 -33
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_pay.rb +0 -98
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_settlement.rb +0 -48
- data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_transfer.rb +0 -44
- data/lib/k2-connect-ruby/k2_entity/k2_notification.rb +0 -40
- data/lib/k2-connect-ruby/k2_services/payload_process.rb +0 -19
- data/lib/k2-connect-ruby/k2_services/payloads/webhooks/settlement_webhook.rb +0 -44
- data/lib/k2-connect-ruby/k2_utilities/k2_validation.rb +0 -128
|
@@ -1,128 +0,0 @@
|
|
|
1
|
-
module K2ConnectRuby
|
|
2
|
-
module K2Utilities
|
|
3
|
-
module K2Validation
|
|
4
|
-
ALL_EVENT_TYPES = %[buygoods_transaction_received b2b_transaction_received buygoods_transaction_reversed customer_created settlement_transfer_completed]
|
|
5
|
-
TILL_SCOPE_EVENT_TYPES = %[buygoods_transaction_received b2b_transaction_received buygoods_transaction_reversed]
|
|
6
|
-
|
|
7
|
-
# Validating Method
|
|
8
|
-
def validate_input(the_input, the_array)
|
|
9
|
-
if the_input.blank?
|
|
10
|
-
raise ArgumentError, "Empty or Nil Input!\n No Input Content has been given."
|
|
11
|
-
else
|
|
12
|
-
unless !!the_input == the_input
|
|
13
|
-
if the_input.is_a?(Hash)
|
|
14
|
-
validate_hash(the_input.with_indifferent_access, the_array)
|
|
15
|
-
else
|
|
16
|
-
begin
|
|
17
|
-
if the_input.is_a?(String)
|
|
18
|
-
raise ArgumentError, "Wrong Input Format.\n The Input is a String."
|
|
19
|
-
elsif the_input.is_a?(Integer)
|
|
20
|
-
raise ArgumentError, "Wrong Input Format.\n The Input is an Integer."
|
|
21
|
-
elsif the_input.key?(:authenticity_token)
|
|
22
|
-
nil_values(the_input.permit(the_array).to_hash.with_indifferent_access)
|
|
23
|
-
else
|
|
24
|
-
raise ArgumentError, "Undefined Input Format.\n The Input is Neither a Hash nor an ActionController::Parameter Object."
|
|
25
|
-
end
|
|
26
|
-
rescue NoMethodError => nme
|
|
27
|
-
if nme.message.include?('has_key?')
|
|
28
|
-
raise ArgumentError, "Undefined Input Format.\n The Input is Neither a Hash nor an ActionController::Parameter Object."
|
|
29
|
-
end
|
|
30
|
-
end
|
|
31
|
-
end
|
|
32
|
-
end
|
|
33
|
-
end
|
|
34
|
-
to_indifferent_access(the_input)
|
|
35
|
-
end
|
|
36
|
-
|
|
37
|
-
# Validate the Hash Input Parameters
|
|
38
|
-
def validate_hash(the_input, the_array)
|
|
39
|
-
nil_values(the_input)
|
|
40
|
-
incorrect_keys(the_input, the_array)
|
|
41
|
-
end
|
|
42
|
-
|
|
43
|
-
# Return Incorrect Key Symbols for Hashes
|
|
44
|
-
def incorrect_keys(the_input, invalid_hash = [], the_array)
|
|
45
|
-
the_input.each_key do |key|
|
|
46
|
-
validate_network(the_input[:network]) if key.eql?("network")
|
|
47
|
-
validate_settlement_method(the_input[:settlement_method]) if key.eql?("settlement_method")
|
|
48
|
-
invalid_hash << key unless the_array.include?(key.to_s)
|
|
49
|
-
end
|
|
50
|
-
raise K2IncorrectParams, invalid_hash if invalid_hash.present?
|
|
51
|
-
end
|
|
52
|
-
|
|
53
|
-
# Return Key Symbols with Blank Values
|
|
54
|
-
def nil_values(the_input, nil_keys_array = [])
|
|
55
|
-
the_input.select { |_, v| v.blank? }.each_key do |key|
|
|
56
|
-
nil_keys_array << key.to_s
|
|
57
|
-
end
|
|
58
|
-
raise K2EmptyParams, nil_keys_array unless nil_keys_array.blank?
|
|
59
|
-
end
|
|
60
|
-
|
|
61
|
-
# Validate Phone Number
|
|
62
|
-
def validate_phone(phone)
|
|
63
|
-
raise ArgumentError, "No Phone Number given." if phone.blank?
|
|
64
|
-
# Kenyan Phone Numbers
|
|
65
|
-
unless phone.blank?
|
|
66
|
-
if phone[-(number = phone.to_i.to_s.size).to_i, 3].eql?(254.to_s)
|
|
67
|
-
raise ArgumentError, 'Invalid Kenyan Phone Number.' unless phone[-9, 9][0].eql?(7.to_s)
|
|
68
|
-
else
|
|
69
|
-
raise ArgumentError, 'Invalid Phone Number.' unless number.eql?(9)
|
|
70
|
-
end
|
|
71
|
-
phone.tr('+', '')
|
|
72
|
-
end
|
|
73
|
-
end
|
|
74
|
-
|
|
75
|
-
# Validate Email Format
|
|
76
|
-
def validate_email(email)
|
|
77
|
-
unless email.blank?
|
|
78
|
-
raise ArgumentError, 'Invalid Email Address.' unless email.match(URI::MailTo::EMAIL_REGEXP).present?
|
|
79
|
-
end
|
|
80
|
-
email
|
|
81
|
-
end
|
|
82
|
-
|
|
83
|
-
# Validate the Network Operator
|
|
84
|
-
def validate_network(network)
|
|
85
|
-
raise ArgumentError, "Invalid Network Operator." unless K2ConnectRuby::K2Utilities::Config::K2Config.network_operators.include?(network.to_s.upcase)
|
|
86
|
-
end
|
|
87
|
-
|
|
88
|
-
def validate_settlement_method(settlement_method)
|
|
89
|
-
raise ArgumentError, "Wrong Settlement Method" unless settlement_method.eql?("EFT") || settlement_method.eql?("RTS")
|
|
90
|
-
end
|
|
91
|
-
|
|
92
|
-
# Converts Hash Objects to HashWithIndifferentAccess Objects
|
|
93
|
-
def to_indifferent_access(params)
|
|
94
|
-
params.with_indifferent_access
|
|
95
|
-
end
|
|
96
|
-
|
|
97
|
-
def validate_url(url)
|
|
98
|
-
raise ArgumentError, 'Invalid URL Format.' unless url =~ /\A#{URI.regexp(%w[https http])}\z/
|
|
99
|
-
url
|
|
100
|
-
end
|
|
101
|
-
|
|
102
|
-
def validate_till_number_prefix(till_number)
|
|
103
|
-
raise ArgumentError, "No Till Number given." if till_number.blank?
|
|
104
|
-
raise ArgumentError, "Invalid Till Number format." unless till_number[0, 1].eql?('K')
|
|
105
|
-
till_number
|
|
106
|
-
end
|
|
107
|
-
|
|
108
|
-
def validate_webhook(params)
|
|
109
|
-
raise ArgumentError, 'Subscription Service does not Exist!' unless params[:event_type].in?(ALL_EVENT_TYPES)
|
|
110
|
-
determine_scope_details(params)
|
|
111
|
-
end
|
|
112
|
-
|
|
113
|
-
def validate_webhook_input(params)
|
|
114
|
-
if params[:event_type].in?(TILL_SCOPE_EVENT_TYPES)
|
|
115
|
-
validate_input(params, %w[event_type scope scope_reference url])
|
|
116
|
-
else
|
|
117
|
-
validate_input(params.except(:scope_reference), %w[event_type scope url])
|
|
118
|
-
end
|
|
119
|
-
end
|
|
120
|
-
|
|
121
|
-
def determine_scope_details(params)
|
|
122
|
-
if params[:scope].eql?('till')
|
|
123
|
-
raise ArgumentError, "Invalid scope till for the event type" unless params[:event_type].in?(TILL_SCOPE_EVENT_TYPES)
|
|
124
|
-
end
|
|
125
|
-
end
|
|
126
|
-
end
|
|
127
|
-
end
|
|
128
|
-
end
|