frame_payments 0.1.0

data/lib/frame/resources/refund.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Frame
+  class Refund < APIResource
+    extend Frame::APIOperations::Create
+    extend Frame::APIOperations::List
+
+    OBJECT_NAME = "refund"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/refunds",
+        params,
+        opts
+      )
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(
+        :get,
+        "/v1/refunds",
+        params,
+        opts
+      )
+    end
+
+    def self.retrieve(id, opts = {})
+      id = Util.normalize_id(id)
+      request_object(
+        :get,
+        "/v1/refunds/#{CGI.escape(id)}",
+        {},
+        opts
+      )
+    end
+
+    def cancel(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/refunds/#{CGI.escape(self["id"])}/cancel",
+        params,
+        opts
+      )
+    end
+
+    def self.cancel(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/refunds/#{CGI.escape(id)}/cancel",
+        params,
+        opts
+      )
+    end
+  end
+end

data/lib/frame/resources/subscription.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Frame
+  class Subscription < APIResource
+    extend Frame::APIOperations::Create
+    extend Frame::APIOperations::List
+    include Frame::APIOperations::Delete
+    include Frame::APIOperations::Save
+
+    OBJECT_NAME = "subscription"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions",
+        params,
+        opts
+      )
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(
+        :get,
+        "/v1/subscriptions",
+        params,
+        opts
+      )
+    end
+
+    def self.retrieve(id, opts = {})
+      id = Util.normalize_id(id)
+      request_object(
+        :get,
+        "/v1/subscriptions/#{CGI.escape(id)}",
+        {},
+        opts
+      )
+    end
+
+    def self.delete(id, params = {}, opts = {})
+      request_object(
+        :delete,
+        "/v1/subscriptions/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
+    def save(params = {}, opts = {})
+      values = serialize_params(self).merge(params)
+
+      if values.empty?
+        return self
+      end
+
+      updated = request_object(
+        :patch,
+        "/v1/subscriptions/#{CGI.escape(self["id"])}",
+        values,
+        opts
+      )
+
+      initialize_from(updated)
+      self
+    end
+
+    def delete(params = {}, opts = {})
+      request_object(
+        :delete,
+        "/v1/subscriptions/#{CGI.escape(self["id"])}",
+        params,
+        opts
+      )
+    end
+
+    def cancel(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(self["id"])}/cancel",
+        params,
+        opts
+      )
+    end
+
+    def self.cancel(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(id)}/cancel",
+        params,
+        opts
+      )
+    end
+
+    def resume(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(self["id"])}/resume",
+        params,
+        opts
+      )
+    end
+
+    def self.resume(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(id)}/resume",
+        params,
+        opts
+      )
+    end
+
+    def pause(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(self["id"])}/pause",
+        params,
+        opts
+      )
+    end
+
+    def self.pause(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(id)}/pause",
+        params,
+        opts
+      )
+    end
+  end
+end

data/lib/frame/resources/subscription_phase.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Frame
+  class SubscriptionPhase < APIResource
+    extend Frame::APIOperations::Create
+    extend Frame::APIOperations::List
+    include Frame::APIOperations::Delete
+    include Frame::APIOperations::Save
+
+    OBJECT_NAME = "subscription_phase"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscription_phases",
+        params,
+        opts
+      )
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(
+        :get,
+        "/v1/subscription_phases",
+        params,
+        opts
+      )
+    end
+
+    def self.retrieve(id, opts = {})
+      id = Util.normalize_id(id)
+      request_object(
+        :get,
+        "/v1/subscription_phases/#{CGI.escape(id)}",
+        {},
+        opts
+      )
+    end
+
+    def self.delete(id, params = {}, opts = {})
+      request_object(
+        :delete,
+        "/v1/subscription_phases/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
+    def save(params = {}, opts = {})
+      values = serialize_params(self).merge(params)
+
+      if values.empty?
+        return self
+      end
+
+      updated = request_object(
+        :patch,
+        "/v1/subscription_phases/#{CGI.escape(self["id"])}",
+        values,
+        opts
+      )
+
+      initialize_from(updated)
+      self
+    end
+
+    def delete(params = {}, opts = {})
+      request_object(
+        :delete,
+        "/v1/subscription_phases/#{CGI.escape(self["id"])}",
+        params,
+        opts
+      )
+    end
+  end
+end

data/lib/frame/resources/webhook_endpoint.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Frame
+  class WebhookEndpoint < APIResource
+    extend Frame::APIOperations::Create
+    extend Frame::APIOperations::List
+    include Frame::APIOperations::Delete
+    include Frame::APIOperations::Save
+
+    OBJECT_NAME = "webhook_endpoint"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/webhook_endpoints",
+        params,
+        opts
+      )
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(
+        :get,
+        "/v1/webhook_endpoints",
+        params,
+        opts
+      )
+    end
+
+    def self.retrieve(id, opts = {})
+      id = Util.normalize_id(id)
+      request_object(
+        :get,
+        "/v1/webhook_endpoints/#{CGI.escape(id)}",
+        {},
+        opts
+      )
+    end
+
+    def self.delete(id, params = {}, opts = {})
+      request_object(
+        :delete,
+        "/v1/webhook_endpoints/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
+    def save(params = {}, opts = {})
+      values = serialize_params(self).merge(params)
+
+      if values.empty?
+        return self
+      end
+
+      updated = request_object(
+        :patch,
+        "/v1/webhook_endpoints/#{CGI.escape(self["id"])}",
+        values,
+        opts
+      )
+
+      initialize_from(updated)
+      self
+    end
+
+    def delete(params = {}, opts = {})
+      request_object(
+        :delete,
+        "/v1/webhook_endpoints/#{CGI.escape(self["id"])}",
+        params,
+        opts
+      )
+    end
+
+    def enable(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/webhook_endpoints/#{CGI.escape(self["id"])}/enable",
+        params,
+        opts
+      )
+    end
+
+    def self.enable(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/webhook_endpoints/#{CGI.escape(id)}/enable",
+        params,
+        opts
+      )
+    end
+
+    def disable(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/webhook_endpoints/#{CGI.escape(self["id"])}/disable",
+        params,
+        opts
+      )
+    end
+
+    def self.disable(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/webhook_endpoints/#{CGI.escape(id)}/disable",
+        params,
+        opts
+      )
+    end
+  end
+end

data/lib/frame/resources.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# This file loads all Frame Payments API resources.
+# Resources are organized alphabetically for maintainability.
+
+# Customer management
+require "frame/resources/customer"
+require "frame/resources/customer_identity_verification"
+
+# Payment processing
+require "frame/resources/charge_intent"
+require "frame/resources/payment_method"
+require "frame/resources/refund"
+
+# Invoicing
+require "frame/resources/invoice"
+require "frame/resources/invoice_line_item"
+
+# Subscriptions
+require "frame/resources/product"
+require "frame/resources/product_phase"
+require "frame/resources/subscription"
+require "frame/resources/subscription_phase"
+
+# Webhooks
+require "frame/resources/webhook_endpoint"

data/lib/frame/util.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Frame
+  module Util
+    OBJECT_CLASSES = {
+      "customer" => "Customer",
+      "charge_intent" => "ChargeIntent",
+      "payment_method" => "PaymentMethod",
+      "refund" => "Refund",
+      "invoice" => "Invoice",
+      "invoice_line_item" => "InvoiceLineItem",
+      "subscription" => "Subscription",
+      "subscription_phase" => "SubscriptionPhase",
+      "product" => "Product",
+      "product_phase" => "ProductPhase",
+      "webhook_endpoint" => "WebhookEndpoint",
+      "customer_identity_verification" => "CustomerIdentityVerification",
+      "list" => "ListObject"
+    }.freeze
+
+    def self.object_classes
+      OBJECT_CLASSES
+    end
+
+    def self.convert_to_frame_object(resp, opts = {})
+      case resp
+      when Array
+        resp.map { |i| convert_to_frame_object(i, opts) }
+      when Hash
+        # Try converting to a specific object class if this is a response with an object key
+        object_name = resp[:object]
+
+        if object_name && object_classes[object_name]
+          klass = object_classes_to_constants[object_name]
+          klass.construct_from(resp, opts)
+        elsif resp[:data]&.is_a?(Array)
+          # This is a list object
+          ListObject.construct_from(resp, opts)
+        else
+          FrameObject.construct_from(resp, opts)
+        end
+      else
+        resp
+      end
+    end
+
+    def self.symbolize_names(object)
+      case object
+      when Hash
+        new_hash = {}
+        object.each do |key, value|
+          key = begin
+            key.to_sym
+          rescue
+            key
+          end || key
+          new_hash[key] = symbolize_names(value)
+        end
+        new_hash
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+
+    def self.normalize_id(id)
+      id&.to_s
+    end
+
+    def self.normalize_opts(opts)
+      opts.clone
+    end
+
+    def self.object_classes_to_constants
+      @object_classes_to_constants ||= begin
+        constants = {}
+        object_classes.each do |object_name, class_name|
+          # Store with both string and symbol keys for flexibility
+          constants[object_name] = Frame.const_get(class_name, false)
+          constants[object_name.to_sym] = Frame.const_get(class_name, false)
+        end
+        constants
+      end
+    end
+  end
+end

data/lib/frame/version.rb

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

data/lib/frame_payments.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Core dependencies
+require "json"
+require "logger"
+require "uri"
+require "cgi"
+require "forwardable"
+require "faraday"
+
+# Frame SDK core components
+require "frame/version"
+require "frame/error"
+require "frame/util"
+require "frame/configuration"
+require "frame/frame_client"
+require "frame/frame_object"
+
+# API operation modules (must be loaded before classes that use them)
+require "frame/api_operations/create"
+require "frame/api_operations/delete"
+require "frame/api_operations/list"
+require "frame/api_operations/request"
+require "frame/api_operations/save"
+
+# Core resource classes
+require "frame/list_object"
+require "frame/api_resource"
+
+# All API resources
+require "frame/resources"
+
+# Main Frame module
+#
+# The Frame module provides the main interface for interacting with the Frame Payments API.
+# Configure your API key and start making requests:
+#
+#   Frame.api_key = 'your_api_key_here'
+#   customer = Frame::Customer.create(name: 'John Doe', email: 'john@example.com')
+#
+# @see https://docs.framepayments.com for API documentation
+module Frame
+  @config = Configuration.setup
+
+  class << self
+    extend Forwardable
+
+    # @return [Configuration] the current configuration object
+    attr_reader :config
+
+    # Delegates to the configuration object for easy access to settings
+    def_delegators :@config, :api_key, :api_key=
+    def_delegators :@config, :api_base, :api_base=
+    def_delegators :@config, :open_timeout, :open_timeout=
+    def_delegators :@config, :read_timeout, :read_timeout=
+    def_delegators :@config, :verify_ssl_certs, :verify_ssl_certs=
+    def_delegators :@config, :log_level, :log_level=
+    def_delegators :@config, :logger, :logger=
+  end
+end

data/sig/frame.rbs

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

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: frame_payments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frame Payments
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+description: A Ruby library for Frame Payments API that provides a convenient interface
+  for making requests and handling responses.
+email:
+- support@framepayments.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- PRODUCTION_READINESS.md
+- README.md
+- Rakefile
+- lib/frame/api_operations/create.rb
+- lib/frame/api_operations/delete.rb
+- lib/frame/api_operations/list.rb
+- lib/frame/api_operations/request.rb
+- lib/frame/api_operations/save.rb
+- lib/frame/api_resource.rb
+- lib/frame/configuration.rb
+- lib/frame/error.rb
+- lib/frame/frame_client.rb
+- lib/frame/frame_object.rb
+- lib/frame/list_object.rb
+- lib/frame/resources.rb
+- lib/frame/resources/charge_intent.rb
+- lib/frame/resources/customer.rb
+- lib/frame/resources/customer_identity_verification.rb
+- lib/frame/resources/invoice.rb
+- lib/frame/resources/invoice_line_item.rb
+- lib/frame/resources/payment_method.rb
+- lib/frame/resources/product.rb
+- lib/frame/resources/product_phase.rb
+- lib/frame/resources/refund.rb
+- lib/frame/resources/subscription.rb
+- lib/frame/resources/subscription_phase.rb
+- lib/frame/resources/webhook_endpoint.rb
+- lib/frame/util.rb
+- lib/frame/version.rb
+- lib/frame_payments.rb
+- sig/frame.rbs
+homepage: https://github.com/framepayments/frame-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/framepayments/frame-ruby
+  source_code_uri: https://github.com/framepayments/frame-ruby
+  changelog_uri: https://github.com/framepayments/frame-ruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Ruby bindings for the Frame Payments API
+test_files: []