affirm-ruby-v1 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d757343882a217c366a9d099221b8bfd1fb6febead45ece7d4c17150ff107de
+  data.tar.gz: 79954f618bff7277906768f8fff4a88ab574ad1aaf5220a2eecebb0f41cfccd2
+SHA512:
+  metadata.gz: 4caaaed2deda060f25e2bfe1370e247cebfb998c833adb47e5dd5cf9671db77294ebdc4d7a331619c3cb35ba835027a6d2d5cafa66bd222a8934d32a69f17c8c
+  data.tar.gz: 6c7453b0a506718faeb054229facb3286d9b94e58896630379969c7661a69247ad7795890c2e596172029c7574f61fc6016de33300409cae4c684a5a9170d1f9

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [1.1.0][] (2026-05-27)
+
+- Remove v2 compatibility shims; expose v1 response fields only
+- Drop unused v2 object models from the gem load path
+
+## [1.0.0][] (2026-05-27)
+
+- Initial release of affirm-ruby-v1
+- Affirm `/api/v1/transactions` client
+- Ruby 4.0 compatible dependencies
+- Legacy response helpers for apps migrating from affirm-ruby v2 charges
+
+[Unreleased]: https://github.com/hknaksu/affirm-ruby-v1/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/hknaksu/affirm-ruby-v1/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/hknaksu/affirm-ruby-v1/releases/tag/v1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yury Velikanau
+
+MIT License
+
+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,113 @@
+# affirm-ruby-v1
+
+Ruby wrapper for the [Affirm Transactions API](https://docs.affirm.com/developers/docs/manage-transactions) (`/api/v1/transactions`).
+
+## Installation
+
+```ruby
+gem "affirm-ruby-v1", require: "affirm"
+```
+
+Local path:
+
+```ruby
+gem "affirm-ruby-v1", path: "../affirm-ruby-v1", require: "affirm"
+```
+
+## Configuration
+
+```ruby
+Affirm.configure do |config|
+  config.public_api_key  = "ABC"
+  config.private_api_key = "XYZ"
+  config.environment     = :sandbox # or :production
+end
+```
+
+## Usage
+
+### Authorize
+
+```ruby
+response = Affirm::Charge.authorize(checkout_token, order.id)
+# or
+response = Affirm::Charge.authorize(checkout_token, order_id: order.id.to_s)
+```
+
+### Read transaction
+
+```ruby
+Affirm::Charge.find(transaction_id)
+```
+
+### Capture
+
+```ruby
+Affirm::Charge.capture(transaction_id)
+Affirm::Charge.capture(transaction_id, amount: 5000) # partial capture
+```
+
+### Void
+
+```ruby
+Affirm::Charge.void(transaction_id)
+```
+
+### Refund
+
+```ruby
+Affirm::Charge.refund(transaction_id, amount: 500)
+```
+
+### Update
+
+```ruby
+Affirm::Charge.update(transaction_id,
+  order_id: "CUSTOM_ORDER_ID",
+  shipping_carrier: "USPS",
+  shipping_confirmation: "1Z23223"
+)
+```
+
+### Response handling
+
+```ruby
+if response.success?
+  response.id                        # Affirm transaction id (e.g. "AMLC-5X0W")
+  response.status                    # e.g. "authorized"
+  response.amount
+  response.checkout_id
+  response.order_id
+  response.authorization_expiration
+else
+  response.error.message
+end
+```
+
+## v1 authorize response fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | String | Transaction id — store this for capture/void/refund |
+| `status` | String | e.g. `authorized`, `captured`, `voided` |
+| `amount` | Integer | Amount in cents |
+| `currency` | String | e.g. `USD` |
+| `checkout_id` | String | Affirm checkout identifier |
+| `order_id` | String | Your merchant order id |
+| `authorization_expiration` | DateTime | When the authorization expires |
+| `amount_refunded` | Integer | Refunded amount in cents |
+| `events` | Array | Auth/capture/refund event history |
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Open a pull request
+
+## License
+
+Released under the MIT license which is included in the [MIT-LICENSE](https://github.com/kjvarga/sitemap_generator/blob/master/MIT-LICENSE) file.
+
+Copyright (c) Hakan Aksu

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new("spec") do |task|
+  task.verbose = false
+end
+
+desc "Console"
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "affirm"
+  require "byebug"
+  ARGV.clear
+  IRB.start
+end
+
+task default: :spec

data/lib/affirm/charge.rb

@@ -0,0 +1,63 @@
+module Affirm
+  module Charge
+    extend self
+
+    # Authorize a checkout token against the Affirm v1 Transactions API.
+    #
+    #   Affirm::Charge.authorize(checkout_token, order.id)
+    #   Affirm::Charge.authorize(checkout_token, order.id, reference_id: "REF-1")
+    #
+    def authorize(checkout_token, order_id, reference_id: nil)
+      if order_id.nil? || order_id.to_s.empty?
+        raise ArgumentError, "order_id is required for Affirm v1 authorize"
+      end
+
+      payload = {
+        transaction_id: checkout_token,
+        order_id: order_id.to_s
+      }
+      payload[:reference_id] = reference_id if reference_id
+
+      respond Client.request(:post, "transactions", **payload)
+    end
+
+    def find(transaction_id)
+      respond Client.request(:get, "transactions/#{transaction_id}")
+    end
+
+    def capture(transaction_id, **options)
+      respond Client.request(:post, "transactions/#{transaction_id}/capture", **options)
+    end
+
+    def void(transaction_id)
+      respond Client.request(:post, "transactions/#{transaction_id}/void")
+    end
+
+    def refund(transaction_id, amount:)
+      respond Client.request(:post, "transactions/#{transaction_id}/refund", amount: amount)
+    end
+
+    def update(transaction_id, **updates)
+      respond Client.request(:post, "transactions/#{transaction_id}/update", **updates)
+    end
+
+    private
+
+    def respond(response)
+      return FailureResult.new(response) unless response.success?
+
+      body = response.body
+      return FailureResult.new(response) unless body.is_a?(Hash)
+
+      type  = body["type"]
+      klass = case type
+      when *%w(capture void refund update)
+        Object.const_get("Affirm::Responses::#{type.capitalize}")
+      else
+        Affirm::Responses::Auth
+      end
+
+      SuccessResult.new(klass.new(body))
+    end
+  end
+end

data/lib/affirm/client.rb

@@ -0,0 +1,50 @@
+module Affirm
+  class Client
+    attr_reader :connection
+
+    attr_reader :url_prefix
+    private :url_prefix
+
+    class << self
+      def request(method, path, data={})
+        new.public_send(method, path, data)
+      end
+    end
+
+    def initialize
+      @url_prefix = "/api/v1"
+      @connection = Faraday.new(Affirm.configuration.endpoint) do |conn|
+        conn.request :authorization, :basic, basic_auth_user, basic_auth_password
+        conn.request  :json
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+
+    def get(path, data={})
+      connection.get(normalized_path(path), data)
+    end
+
+    def post(path, data={})
+      connection.post(normalized_path(path), data)
+    end
+
+    private
+
+    def basic_auth_user
+      Affirm.configuration.public_api_key
+    end
+
+    def basic_auth_password
+      Affirm.configuration.private_api_key
+    end
+
+    def normalized_path(path)
+      url_prefix + normalize_path(path)
+    end
+
+    def normalize_path(path)
+      Faraday::Utils.normalize_path(path)
+    end
+  end
+end

data/lib/affirm/configuration.rb

@@ -0,0 +1,38 @@
+module Affirm
+  class Configuration
+    attr_accessor :public_api_key
+    attr_accessor :private_api_key
+    attr_reader :environment
+
+    ENDPOINTS = {
+      production: "api.affirm.com",
+      sandbox:    "sandbox.affirm.com"
+    }
+
+    def initialize
+      @environment = :production
+    end
+
+    def environment=(env)
+      @environment = env.to_sym
+    end
+
+    def endpoint
+      "https://#{ENDPOINTS[environment]}"
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configuration=(config)
+      @configuration = config
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/affirm/failure_result.rb

@@ -0,0 +1,18 @@
+module Affirm
+  class FailureResult
+    extend Forwardable
+    def_delegators :response, :status, :success?
+
+    attr_reader :error
+
+    attr_reader :response
+    private :response
+
+    def initialize(response)
+      @response = response
+      body = response.body
+      body = { "message" => body.to_s } unless body.is_a?(Hash)
+      @error = Affirm::Responses::Error.new(body)
+    end
+  end
+end

data/lib/affirm/objects/event.rb

@@ -0,0 +1,14 @@
+module Affirm
+  module Objects
+    class Event
+      include Virtus.model
+
+      attribute :id,             String
+      attribute :transaction_id, String
+      attribute :currency,       String
+      attribute :amount,         Integer
+      attribute :type,           String
+      attribute :created,        DateTime
+    end
+  end
+end

data/lib/affirm/responses/auth.rb

@@ -0,0 +1,23 @@
+module Affirm
+  module Responses
+    class Auth
+      include Virtus.model
+
+      attribute :id,                       String
+      attribute :status,                   String
+      attribute :amount,                   Integer
+      attribute :amount_refunded,          Integer
+      attribute :authorization_expiration, DateTime
+      attribute :checkout_id,              String
+      attribute :created,                  DateTime
+      attribute :currency,                 String
+      attribute :events,                   Array[Objects::Event]
+      attribute :order_id,                 String
+      attribute :provider_id,              Integer
+      attribute :remove_tax,               Boolean
+      attribute :reference_id,             String
+      attribute :tax_amount,               Integer
+      attribute :shipping_amount,          Integer
+    end
+  end
+end

data/lib/affirm/responses/capture.rb

@@ -0,0 +1,16 @@
+module Affirm
+  module Responses
+    class Capture
+      include Virtus.model
+
+      attribute :id,           String
+      attribute :type,         String
+      attribute :amount,       Integer
+      attribute :currency,     String
+      attribute :fee,          Integer
+      attribute :created,      DateTime
+      attribute :order_id,     String
+      attribute :reference_id, String
+    end
+  end
+end

data/lib/affirm/responses/error.rb

@@ -0,0 +1,13 @@
+module Affirm
+  module Responses
+    class Error
+      include Virtus.model
+
+      attribute :status_code, Integer
+      attribute :type,        String
+      attribute :code,        String
+      attribute :message,     String
+      attribute :field,       String
+    end
+  end
+end

data/lib/affirm/responses/refund.rb

@@ -0,0 +1,14 @@
+module Affirm
+  module Responses
+    class Refund
+      include Virtus.model
+
+      attribute :id,           String
+      attribute :reference_id, String
+      attribute :amount,       Integer
+      attribute :fee_refunded,   Integer
+      attribute :created,        DateTime
+      attribute :type,           String
+    end
+  end
+end

data/lib/affirm/responses/update.rb

@@ -0,0 +1,14 @@
+module Affirm
+  module Responses
+    class Update
+      include Virtus.model
+
+      attribute :id,                    String
+      attribute :order_id,              String
+      attribute :shipping_carrier,      String
+      attribute :shipping_confirmation, String
+      attribute :created,               DateTime
+      attribute :type,                  String
+    end
+  end
+end

data/lib/affirm/responses/void.rb

@@ -0,0 +1,12 @@
+module Affirm
+  module Responses
+    class Void
+      include Virtus.model
+
+      attribute :id,           String
+      attribute :type,         String
+      attribute :created,      DateTime
+      attribute :reference_id, String
+    end
+  end
+end

data/lib/affirm/success_result.rb

@@ -0,0 +1,26 @@
+module Affirm
+  class SuccessResult
+    attr_reader :object
+    private :object
+
+    def initialize(object)
+      @object = object
+    end
+
+    def success?
+      true
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if object.respond_to?(method_name)
+        object.send(method_name, *arguments, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      object.respond_to?(method_name) || super
+    end
+  end
+end

data/lib/affirm/version.rb

@@ -0,0 +1,3 @@
+module Affirm
+  VERSION = "1.1.0"
+end

data/lib/affirm.rb

@@ -0,0 +1,19 @@
+require "forwardable"
+
+require "faraday"
+require "virtus"
+
+require "affirm/client"
+require "affirm/charge"
+require "affirm/configuration"
+require "affirm/success_result"
+require "affirm/failure_result"
+require "affirm/objects/event"
+require "affirm/responses/auth"
+require "affirm/responses/capture"
+require "affirm/responses/void"
+require "affirm/responses/refund"
+require "affirm/responses/update"
+require "affirm/responses/error"
+
+require "affirm/version"

data/spec/charge_object_interface.rb

@@ -0,0 +1,45 @@
+RSpec.shared_examples "a transaction object interface" do
+  %w(
+    id
+    status
+    currency
+    amount
+    order_id
+    checkout_id
+  ).each do |method|
+    it method do
+      expect(subject.public_send(method)).to eq(body[method])
+    end
+  end
+
+  it "created" do
+    expect(
+      to_seconds(subject.created)
+    ).to eq(to_seconds(body["created"]))
+  end
+
+  it "authorization_expiration" do
+    expect(
+      to_seconds(subject.authorization_expiration)
+    ).to eq(to_seconds(body["authorization_expiration"]))
+  end
+
+  %w(
+    id
+    currency
+    amount
+    type
+  ).each do |method|
+    it "events.#{method}" do
+      expect(
+        subject.events.first.public_send(method)
+      ).to eq(body["events"].first[method])
+    end
+  end
+
+  it "events.created" do
+    expect(
+      to_seconds(subject.events.first.created)
+    ).to eq(to_seconds(body["events"].first["created"]))
+  end
+end