ruby-eupago 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43a13811487c270301ef4dc2e07cdd5036c11de8981e821ba119017c14ce6a23
+  data.tar.gz: 72307c343896aa908f4d25757a5764d5aaee1bc08d43c480b8b4a628e0e871fd
+SHA512:
+  metadata.gz: 1393f9d679601c196e3b104fcaf17f27f4830a6b71d849e5a8279561af9d4d5879c7d34c2b3ea3c2142be9b674548b10c294591491e978edbc5cf3d0025568fe
+  data.tar.gz: 558528c12d48b575a6447c4835f1dccdf6f0f680574b0675bf85e52afb6f5527bb895043c18485855a808a816b79c2a669ce4cfc0834ddac8e1de3d4d688baf9

data/README.md

@@ -0,0 +1,19 @@
+# EuPago Ruby SDK
+
+This is a not official Ruby SDK for the EuPago payment gateway.
+
+## Installation
+
+WIP
+
+## Testing
+
+```bash
+bundle exec rspec
+```
+
+## Contributing
+
+I am open to contributions! But with limited time, I cannot promise to respond to every issue or pull request. However, I will do my best to review and merge contributions that align with the project's goals.
+
+If you have some questions about the structure of the project, i am following the [ruby-auth0](https://github.com/auth0/ruby-auth0) structure. They have a great SDK and a well defined structure.

data/lib/ruby-eupago/api/auth.rb

@@ -0,0 +1,14 @@
+module EuPago
+  module Api
+    module Auth
+      # https://eupago.readme.io/reference/generate-bearer-token
+      def self.token(body)
+        result = EuPago::Client.new.post("/auth/token", body: body, headers: {
+          "Content-Type" => "application/x-www-form-urlencoded",
+        })
+        EuPago::Current.auth = result
+        result
+      end
+    end
+  end
+end

data/lib/ruby-eupago/api/v1/credit_card.rb

@@ -0,0 +1,17 @@
+module EuPago
+  module Api
+    module V1
+      class CreditCard
+        # https://eupago.readme.io/reference/credit-card-recurrence-authorization
+        def self.subscription(params)
+          V1.client.post("/v1.02/creditcard/subscription", body: params)
+        end
+
+        # https://eupago.readme.io/reference/credit-card-recurrence-payment
+        def self.payment(recurrent_id, params)
+          V1.client.post("/v1.02/creditcard/payment/#{recurrent_id}", body: params)
+        end
+      end
+    end
+  end
+end

data/lib/ruby-eupago/api/v1/direct_debit.rb

@@ -0,0 +1,17 @@
+module EuPago
+  module Api
+    module V1
+      class DirectDebit
+        # https://eupago.readme.io/reference/direct-debit-authorization
+        def self.authorization(params)
+          V1.client.post("/v1.02/directdebit/authorization", body: params)
+        end
+
+        # https://eupago.readme.io/reference/direct-debit-payment
+        def self.payment(reference, params)
+          V1.client.post("/v1.02/directdebit/payment/#{reference}", body: params)
+        end
+      end
+    end
+  end
+end

data/lib/ruby-eupago/api/v1/mbway.rb

@@ -0,0 +1,12 @@
+module EuPago
+  module Api
+    module V1
+      class MBWay
+        # https://eupago.readme.io/reference/mbway
+        def self.payment(params)
+          V1.client.post("/v1.02/mbway/create", body: params)
+        end
+      end
+    end
+  end
+end

data/lib/ruby-eupago/api/v1.rb

@@ -0,0 +1,13 @@
+module EuPago
+  module Api
+    module V1
+      def self.client
+        @client ||= EuPago::Api.client
+      end
+    end
+  end
+end
+
+require "ruby-eupago/api/v1/credit_card"
+require "ruby-eupago/api/v1/mbway"
+require "ruby-eupago/api/v1/direct_debit"

data/lib/ruby-eupago/api.rb

@@ -0,0 +1,7 @@
+module EuPago
+  module Api
+    def self.client
+      @client ||= EuPago::Client.new({ include_api_key: true })
+    end
+  end
+end

data/lib/ruby-eupago/client.rb

@@ -0,0 +1,7 @@
+require "ruby-eupago/mixins/initializer"
+
+module EuPago
+  class Client
+    include EuPago::Mixins::Client
+  end
+end

data/lib/ruby-eupago/constants.rb

@@ -0,0 +1,24 @@
+module EuPago
+  module Constants
+    GRANT_TYPES = {
+      client_credentials: "client_credentials",
+      refresh: "refresh_token",
+      password: "password",
+    }.freeze
+
+    RECURRENT_PAYMENT_INTERVALS = {
+      weekly: "Semanal",
+      biweekly: "Quinzenal",
+      monthly: "Mensal",
+      trimesterly: "Trimestral",
+      semiannual: "Semestral",
+      annual: "Anual",
+    }.freeze
+
+    PAYMENT_TYPES = {
+      once: "OOFF",
+      recurring: "RCUR",
+      final: "FNAL",
+    }
+  end
+end

data/lib/ruby-eupago/current.rb

@@ -0,0 +1,17 @@
+module EuPago
+  module Current
+    @auth = {}
+
+    def self.auth=(value)
+      @auth = Hash[value.map { |(k, v)| [k.to_sym, v] }]
+    end
+
+    def self.access_token
+      @auth[:access_token] if @auth && !@auth.empty?
+    end
+
+    def self.logged_in?
+      !access_token.nil? && !access_token.empty?
+    end
+  end
+end

data/lib/ruby-eupago/mixins/initializer.rb

@@ -0,0 +1,93 @@
+require "httparty"
+
+module EuPago
+  module Mixins
+    module Client
+      def initialize(config = {})
+        options = Hash[config.map { |(k, v)| [k.to_sym, v] }]
+        @base_url = options[:base_url] || build_base_url
+        @include_api_key = options.fetch(:include_api_key, false)
+      end
+
+      def build_base_url(append_base_url = "")
+        if ENV["EUPAGO_PRODUCTION"].to_s.empty?
+          "https://sandbox.eupago.pt/api#{append_base_url}"
+        else
+          "https://clientes.eupago.pt/api#{append_base_url}"
+        end
+      end
+
+      def get(api_url, query: {}, headers: {})
+        result = HTTParty.get(
+          api_url,
+          base_uri: @base_url,
+          format: :json,
+          headers: build_headers(headers),
+          query: query,
+        )
+
+        parse_result(result)
+      end
+
+      def post(api_url, body: {}, headers: {})
+        kheader = build_headers(headers)
+        kbody = kheader["Content-Type"] == "application/json" ? body.to_json : body
+
+        result = HTTParty.post(
+          api_url,
+          base_uri: @base_url,
+          format: :json,
+          headers: kheader,
+          body: kbody,
+        )
+
+        parse_result(result)
+      end
+
+      private
+
+      def build_headers(additional_headers = {})
+        headers = {
+          "Content-Type" => "application/json",
+          "Accept" => "application/json",
+          "User-Agent" => "",
+        }.merge(additional_headers)
+
+        if @include_api_key && ENV["EUPAGO_API_KEY"]
+          headers["Authorization"] = "ApiKey #{ENV["EUPAGO_API_KEY"]}"
+        end
+
+        headers
+      end
+
+      def parse_result(result)
+        if result.headers["content-type"] == "application/json"
+          response = result.parsed_response
+        else
+          response = result.body
+        end
+
+        case result.code
+        when 200..299
+          result.parsed_response
+        when 401
+          raise EuPago::UnauthorizedError, "[Eupago SDK] Unauthorized: #{response}"
+        when 400
+          raise EuPago::BadRequestError, "[Eupago SDK] Bad Request: #{response}"
+        when 404
+          raise EuPago::NotFoundError, "[Eupago SDK] Not Found: #{response}"
+        when 403
+          raise EuPago::ForbiddenError, "[Eupago SDK] Forbidden: #{response}"
+        else
+          raise EuPago::ClientError, "[Eupago SDK] Error (#{result.code}): #{response}"
+        end
+      end
+    end
+  end
+
+  class ClientError < StandardError; end
+  class UnauthorizedError < StandardError; end
+  class BadRequestError < StandardError; end
+  class NotFoundError < StandardError; end
+  class ForbiddenError < StandardError; end
+end

data/lib/ruby-eupago/version.rb

@@ -0,0 +1,8 @@
+module EuPago
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/ruby-eupago.rb

@@ -0,0 +1,7 @@
+require_relative "ruby-eupago/constants"
+require_relative "ruby-eupago/current"
+require_relative "ruby-eupago/client"
+
+require_relative "ruby-eupago/api"
+require_relative "ruby-eupago/api/v1"
+require_relative "ruby-eupago/api/auth"

data/ruby-eupago.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/ruby-eupago/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ruby-eupago'
+  spec.version     = EuPago::Version::STRING
+  spec.date        = '2025-09-10'
+  spec.summary     = 'Eupago Ruby SDK'
+  spec.description = 'Eupago Ruby SDK'
+  spec.authors     = ['Alexandro Castro']
+  spec.email       = 'alexoliveira7x@gmail.com'
+  spec.license = 'MIT'
+
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.require_paths = ['lib']
+  spec.files = Dir['{lib}/**/*'] + ['README.md', 'CHANGELOG.md', 'ruby-eupago.gemspec']
+
+  spec.add_dependency 'httparty', '~> 0.23.1'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake', '~> 13.1.0'
+  spec.add_development_dependency 'rubocop', '~> 1.59'
+  spec.add_development_dependency 'rubocop-shopify', '~> 2.14'
+  spec.add_development_dependency 'simplecov', '0.17.1'
+  spec.add_development_dependency 'faker', '~> 3.5.2'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: ruby-eupago
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandro Castro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Eupago Ruby SDK
+email: alexoliveira7x@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/ruby-eupago.rb
+- lib/ruby-eupago/api.rb
+- lib/ruby-eupago/api/auth.rb
+- lib/ruby-eupago/api/v1.rb
+- lib/ruby-eupago/api/v1/credit_card.rb
+- lib/ruby-eupago/api/v1/direct_debit.rb
+- lib/ruby-eupago/api/v1/mbway.rb
+- lib/ruby-eupago/client.rb
+- lib/ruby-eupago/constants.rb
+- lib/ruby-eupago/current.rb
+- lib/ruby-eupago/mixins/initializer.rb
+- lib/ruby-eupago/version.rb
+- ruby-eupago.gemspec
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Eupago Ruby SDK
+test_files: []