myropay 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 196da98afb50b4e7b7245ba316967188f7c6179716da2f1292c1db32aa14f4a9
+  data.tar.gz: 2bda993df588d5d7820b61058b03c28c551d4e1e10cc8db5e3f6ce5c0e0ecc03
+SHA512:
+  metadata.gz: f0dab237670d845ec81d93147977178b23078049cd73c3114bb1eef6ddc92c5d510b7cdee3077f73cd23e252069df9fbba4519f372fe862be62f8cc30e6a0560
+  data.tar.gz: e0112b4ab13ad02da5e829f07d341d724536b902ec3bce4b2de7a4c784b3c14e2962073d873ce6c1193b1f87512a92f8dbc11a54d85dcb3ebea09d996eb8f62a

data/README.md

@@ -0,0 +1,63 @@
+# myropay-ruby
+
+Official Ruby library for the [MyroPay](https://myropay.com) API. No dependencies beyond the standard library (`net/http`, `json`).
+
+## Install
+
+```
+gem install myropay
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'myropay'
+```
+
+## Usage
+
+```ruby
+require 'myropay'
+Myropay.api_key = 'sk_test_...'
+
+charge = Myropay::Charge.create(
+  email: 'customer@email.com',
+  amount: 500000,       # whole currency units — ₦500,000, not kobo
+  currency: 'NGN',       # optional, defaults to NGN
+  reference: 'ORD-1029', # optional, your own order id
+)
+
+redirect_to charge['checkout_url']
+```
+
+Retrieve a charge later:
+
+```ruby
+charge = Myropay::Charge.retrieve('cs_test_...')
+if charge['status'] == 'completed'
+  # fulfil the order
+end
+```
+
+## Important
+
+- Your API key (`sk_live_...` / `sk_test_...`) must **never** reach a browser — use this library from your own server only. Get your keys from the MyroPay business dashboard under **API & Apps**.
+- Amounts are in the currency's own whole units (e.g. `500000` NGN = ₦500,000), not subunits like kobo or cents.
+- For a client-side "Pay with MyroPay" button/modal that never needs your secret key, use the [Checkout SDK](https://dev.myropay.com#sdk) (`myropay.js`) instead — this gem is for server-side charge creation and verification.
+
+## Errors
+
+```ruby
+begin
+  Myropay::Charge.create(amount: 5000) # missing email
+rescue Myropay::InvalidRequestError => e
+  # missing/invalid parameters, no request was sent
+rescue Myropay::APIError => e
+  # the API itself returned an error
+  puts "#{e.message} (HTTP #{e.http_status})"
+end
+```
+
+## License
+
+MIT

data/lib/myropay/api_requestor.rb

@@ -0,0 +1,52 @@
+module Myropay
+  module APIRequestor
+    module_function
+
+    def request(method, query: {}, body: nil, api_key: nil)
+      key = api_key || Myropay.api_key
+      if key.nil? || key.empty?
+        raise InvalidRequestError, 'No API key provided. Set Myropay.api_key = "sk_test_..." before making ' \
+          'a request, or pass api_key: directly to the call.'
+      end
+
+      uri = URI(Myropay::API_BASE)
+      uri.query = URI.encode_www_form(query) unless query.empty?
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.read_timeout = 30
+
+      req = case method
+            when :get  then Net::HTTP::Get.new(uri)
+            when :post then Net::HTTP::Post.new(uri)
+            else raise ArgumentError, "Unsupported HTTP method: #{method}"
+            end
+      req['X-API-Key'] = key
+      req['Content-Type'] = 'application/json'
+      req.body = body.to_json if body
+
+      begin
+        res = http.request(req)
+      rescue StandardError => e
+        raise APIError, "Could not reach the MyroPay API: #{e.message}"
+      end
+
+      data =
+        begin
+          JSON.parse(res.body || '{}')
+        rescue JSON::ParserError
+          raise APIError.new('Invalid (non-JSON) response from the MyroPay API', http_status: res.code.to_i)
+        end
+
+      status = res.code.to_i
+      if status == 401
+        raise AuthenticationError.new(data['message'] || 'Invalid API key', http_status: status, response: data)
+      end
+      if status >= 400 || data['success'] == false
+        raise APIError.new(data['message'] || 'MyroPay API request failed', http_status: status, response: data)
+      end
+
+      data
+    end
+  end
+end

data/lib/myropay/charge.rb

@@ -0,0 +1,49 @@
+module Myropay
+  # A charge — a MyroPay hosted checkout session — for a customer to pay.
+  class Charge
+    class << self
+      # Create a charge.
+      #
+      # @param email [String] Customer email (required).
+      # @param amount [Numeric] Amount in the currency's own whole units —
+      #   e.g. 500000 = ₦500,000 for NGN — NOT subunits/kobo.
+      # @param currency [String] Defaults to 'NGN'.
+      # @param reference [String] Your own order reference (optional).
+      # @param api_key [String] Overrides Myropay.api_key for this call only.
+      # @return [Hash] The created charge, including 'checkout_url' to
+      #   redirect the customer to.
+      def create(email:, amount:, currency: 'NGN', reference: nil, description: nil,
+                 success_url: nil, cancel_url: nil, metadata: nil, name: nil, api_key: nil)
+        raise InvalidRequestError, 'amount is required' if amount.nil? || amount.to_f <= 0
+        raise InvalidRequestError, 'email is required' if email.nil? || email.empty?
+
+        body = {
+          amount: amount,
+          currency: currency,
+          order_ref: reference,
+          description: description,
+          customer: { email: email, name: name },
+          success_url: success_url,
+          cancel_url: cancel_url,
+          metadata: metadata,
+        }
+        res = APIRequestor.request(:post, query: { action: 'create' }, body: body, api_key: api_key)
+        normalize(res)
+      end
+
+      # Retrieve a charge by id (the session_id returned from create()).
+      def retrieve(id, api_key: nil)
+        raise InvalidRequestError, 'id is required' if id.nil? || id.empty?
+        res = APIRequestor.request(:get, query: { session_id: id }, api_key: api_key)
+        normalize(res['session'] || res)
+      end
+
+      private
+
+      def normalize(raw)
+        raw['id'] = raw['session_id']
+        raw
+      end
+    end
+  end
+end

data/lib/myropay/errors.rb

@@ -0,0 +1,21 @@
+module Myropay
+  class MyropayError < StandardError
+    attr_reader :http_status, :response
+
+    def initialize(message = nil, http_status: nil, response: nil)
+      super(message)
+      @http_status = http_status
+      @response = response
+    end
+  end
+
+  # Raised before a request is even sent — e.g. no api_key configured,
+  # or a required parameter (amount, email) is missing.
+  class InvalidRequestError < MyropayError; end
+
+  # Raised when the MyroPay API itself returns an error response.
+  class APIError < MyropayError; end
+
+  # Raised on a 401 — invalid or missing API key.
+  class AuthenticationError < APIError; end
+end

data/lib/myropay/version.rb

@@ -0,0 +1,3 @@
+module Myropay
+  VERSION = '1.0.0'.freeze
+end

data/lib/myropay.rb

@@ -0,0 +1,25 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+require 'myropay/version'
+require 'myropay/errors'
+require 'myropay/api_requestor'
+require 'myropay/charge'
+
+# Official Ruby library for the MyroPay API.
+#
+#   require 'myropay'
+#   Myropay.api_key = 'sk_test_...'
+#
+#   charge = Myropay::Charge.create(
+#     email: 'customer@email.com',
+#     amount: 500000,
+#   )
+module Myropay
+  API_BASE = 'https://checkout.myropay.com/api/sessions.php'.freeze
+
+  class << self
+    attr_accessor :api_key
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: myropay
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MyroPay
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Create and verify MyroPay checkout charges from Ruby. No dependencies
+  beyond the standard library.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/myropay.rb
+- lib/myropay/api_requestor.rb
+- lib/myropay/charge.rb
+- lib/myropay/errors.rb
+- lib/myropay/version.rb
+homepage: https://dev.myropay.com
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/myropayme/myropay-ruby
+  documentation_uri: https://dev.myropay.com
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Official Ruby library for the MyroPay API
+test_files: []