Paychangu 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4064f2c7ef54302ac752392c02d19418342df8daf1fa8297b1945d131dcd7d6
+  data.tar.gz: 65025fdbdd67a02ea5609f6b0a168549d97153ac8a20a2af387595a9cadaf577
+SHA512:
+  metadata.gz: 239500d3f0413df60d0ad412bf0cf0f4db40f5a853ac3546e5823331431cd6322a7268c7386b82e65ba980002ec68dc1a78b1e472025032a74c0f01af02053d9
+  data.tar.gz: 8c5df35c4d2593384ee60b6e970284e4058a137448393a99225ec33228e66049d16fa432fa736a5478a98625feb225f0f71856309555fdc7fb289d85c7c94e47

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Enabled: true
+  Max: 260
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 30
+
+Metrics/BlockLength:
+  Enabled: true
+  Max: 60
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 150
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 45

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-12-12
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Danny Simfukwe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# Paychangu Rails Gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add paychangu
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install paychangu
+
+## Usage
+
+Create an initializer in your application's `config > initializers` folder, for example `paychangu.rb` and paste the following
+
+```
+require "paychangu"
+```
+
+Then use it in your application like below with your Paychangu secret key, you can get this key in your Paychangu account settings
+
+`paychangu = Paychangu::Payment.new("sec-test-SDsYTCSh...")`
+
+#### Creating a Payment Link
+
+```
+ payload = {
+        amount: "50000",
+        currency: "MWK",
+        email: "test@example.com",
+        first_name: "Danny",
+        last_name: "Simfukwe",
+        callback_url: "https://webhook.site/9d0b00ba-9a69-44fa-a43d-a82c33c36fdc",
+        return_url: "https://webhook.site",
+        tx_ref: SecureRandom.hex(10),
+        title: "Title of payment",
+        description: "Description of payment",
+        logo: "https://assets.piedpiper.com/logo.png"
+    }
+```
+
+ `link = paychangu.create_payment_link(payload)`
+
+ #### Creating a Virtual Card
+
+```
+card_payload = {
+        amount: "500",
+        currency: "USD",
+        first_name: "Danny",
+        last_name: "Simfukwe",
+        callback_url: "https://webhook.site/9d0b00ba-9a69-44fa-a43d-a82c33c36fdc"
+    }
+```
+
+`card = paychangu.create_virtual_card(card_payload)`
+
+ #### Funding a Virtual Card
+
+```
+ fund_card_payload = {
+      amount: "50000",
+      card_hash: card[:card_hash],
+    }
+```
+
+ `paychangu.fund_card(fund_card_payload)`
+
+ #### Withdrawing from a Virtual Card
+
+  `withdraw = paychangu.withdraw_card_funds(fund_card_payload)`
+
+  #### Buying Airtime
+
+  First get all operators
+
+  ```
+   operators = paychangu.airtime_operators
+
+  ```
+
+  Then use the operator's ID to buy Airtime
+
+  ```
+    airtime_payment_payload = {
+        operator: "123",
+        amount: "300",
+        phone: "0900000000",
+        callback_url: "https://webhook.site/9d0b00ba-9a69-44fa-a43d-a82c33c36fdc"
+    }
+
+    paychangu.airtime_payment(airtime_payment_payload)
+  ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dannysimfukwe/paychangugem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/paychangu/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Paychangu
+  VERSION = "0.2.4"
+end

data/lib/paychangu.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require "uri"
+require "json"
+require "net/http"
+require "securerandom"
+
+require_relative "paychangu/version"
+
+module Paychangu
+  # Main Payemnt Class
+  class Payment
+    API_URL = URI("https://api.paychangu.com/").freeze
+    SUPPORTED_CURRENCIES = %w[MWK NGN ZAR GBP USD ZMW].freeze
+    SUPPORTED_CARD_CURRENCIES = %w[USD].freeze
+
+    API_ENDPOINTS = {
+      payment: "payment",
+      create_card: "virtual_card/create",
+      fund_card: "virtual_card/fund",
+      withdraw: "virtual_card/withdraw",
+      get_operators: "bill_payment/get-operators",
+      airtime_payment: "bill_payment/create",
+      verify_payment: "verify-payment"
+    }.freeze
+
+    REQUEST_METHODS = {
+      post: "POST",
+      get: "GET",
+      put: "PUT",
+      delete: "DELETE"
+    }.freeze
+
+    def initialize(secret_key)
+      @secret = paychangu_secret(secret_key)
+    end
+
+    def create_payment_link(data = {})
+      payload = create_link_payload(data)
+
+      process_request(payload, API_ENDPOINTS[:payment], REQUEST_METHODS[:post])
+    end
+
+    def create_virtual_card(data = {})
+      payload = create_card_payload(data)
+
+      process_request(payload, API_ENDPOINTS[:create_card], REQUEST_METHODS[:post])
+    end
+
+    def fund_card(data = {})
+      payload = fund_card_payload(data)
+
+      process_request(payload, API_ENDPOINTS[:fund_card], REQUEST_METHODS[:post])
+    end
+
+    def withdraw_card_funds(data = {})
+      payload = withdraw_card_funds_payload(data)
+
+      process_request(payload, API_ENDPOINTS[:withdraw], REQUEST_METHODS[:post])
+    end
+
+    def airtime_operators
+      process_request(nil, API_ENDPOINTS[:get_operators], REQUEST_METHODS[:get])
+    end
+
+    def airtime_payment(data = {})
+      payload = create_airtime_payment_payload(data)
+
+      process_request(payload, API_ENDPOINTS[:airtime_payment], REQUEST_METHODS[:post])
+    end
+
+    def verify_payment(data = {})
+      process_request(nil, "#{API_ENDPOINTS[:verify_payment]}/#{data[:tx_ref]}", REQUEST_METHODS[:get])
+    end
+
+    private
+
+    def paychangu_secret(secret_key)
+      raise "Secret key not provided!" unless secret_key
+
+      secret_key
+    end
+
+    def get_supported_currencies(currency)
+      raise "#{currency} currency not supported!" unless SUPPORTED_CURRENCIES.include?(currency)
+
+      currency
+    end
+
+    def get_card_supported_currencies(currency)
+      raise "#{currency} currency not supported" unless SUPPORTED_CARD_CURRENCIES.include?(currency)
+
+      currency
+    end
+
+    def create_link_payload(data)
+      {
+        amount: data[:amount],
+        currency: get_supported_currencies(data[:currency]),
+        email: data[:email],
+        first_name: data[:first_name],
+        last_name: data[:last_name],
+        callback_url: data[:callback_url],
+        return_url: data[:return_url],
+        tx_ref: data[:tx_ref] || SecureRandom.hex(10),
+        customization: customization(data),
+        logo: data[:logo]
+      }.to_json
+    end
+
+    def create_card_payload(data)
+      {
+        amount: data[:amount],
+        currency: get_card_supported_currencies(data[:currency]),
+        first_name: data[:first_name],
+        last_name: data[:last_name],
+        callback_url: data[:callback_url]
+      }.to_json
+    end
+
+    def fund_card_payload(data)
+      {
+        amount: data[:amount],
+        card_hash: data[:card_hash]
+      }.to_json
+    end
+
+    def withdraw_card_funds_payload(data)
+      {
+        amount: data[:amount],
+        card_hash: data[:card_hash]
+      }.to_json
+    end
+
+    def customization(data)
+      {
+        title: data[:title],
+        description: data[:description]
+      }
+    end
+
+    def create_airtime_payment_payload(data)
+      {
+        operator: data[:operator],
+        amount: data[:amount],
+        phone: data[:phone],
+        callback_url: data[:callback_url]
+      }.to_json
+    end
+
+    def process_request(payload, path, method)
+      http = Net::HTTP.new(API_URL.host, API_URL.port)
+      http.use_ssl = true
+
+      case method
+      when "POST"
+        request = Net::HTTP::Post.new("#{API_URL}#{path}")
+        request["accept"] = "application/json"
+        request["Authorization"] = "Bearer #{@secret}"
+        request["content-type"] = "application/json"
+        request.body = payload
+      when "GET"
+        request = Net::HTTP::Get.new("#{API_URL}#{path}")
+        request["accept"] = "application/json"
+        request["Authorization"] = "Bearer #{@secret}"
+        request["content-type"] = "application/json"
+      when "PUT"
+        request = Net::HTTP::Put.new("#{API_URL}#{path}")
+        request["accept"] = "application/json"
+        request["Authorization"] = "Bearer #{@secret}"
+        request["content-type"] = "application/json"
+        request.body = payload
+      when "DELETE"
+        request = Net::HTTP::Delete.new("#{API_URL}#{path}")
+        request["accept"] = "application/json"
+        request["Authorization"] = "Bearer #{@secret}"
+        request["content-type"] = "application/json"
+        request.body = payload
+      end
+
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+  end
+end

data/paychangu.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/paychangu/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "Paychangu"
+  spec.version = Paychangu::VERSION
+  spec.authors = ["Danny Simfukwe"]
+  spec.email = ["dannysimfukwe@gmail.com"]
+
+  spec.summary = "Paychangu is a Ruby gem that allows you to interact with Paychangu.com's API."
+  spec.description = "Paychangu is a Ruby gem that allows you to interact with Paychangu.com's API and perform several operations like: creating payment links, creating virtual cards etc"
+  spec.homepage = "https://github.com/dannysimfukwe/paychangugem"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dannysimfukwe/paychangugem"
+  spec.metadata["changelog_uri"] = "https://github.com/dannysimfukwe/paychangugem"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "false"
+end

data/sig/paychangu.rbs

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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: Paychangu
+version: !ruby/object:Gem::Version
+  version: 0.2.4
+platform: ruby
+authors:
+- Danny Simfukwe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-02 00:00:00.000000000 Z
+dependencies: []
+description: 'Paychangu is a Ruby gem that allows you to interact with Paychangu.com''s
+  API and perform several operations like: creating payment links, creating virtual
+  cards etc'
+email:
+- dannysimfukwe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paychangu.rb
+- lib/paychangu/version.rb
+- paychangu.gemspec
+- sig/paychangu.rbs
+homepage: https://github.com/dannysimfukwe/paychangugem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dannysimfukwe/paychangugem
+  source_code_uri: https://github.com/dannysimfukwe/paychangugem
+  changelog_uri: https://github.com/dannysimfukwe/paychangugem
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Paychangu is a Ruby gem that allows you to interact with Paychangu.com's
+  API.
+test_files: []