diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..ec446ba --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,66 @@ +name: CI + +on: + push: + pull_request: + +permissions: + contents: read + +jobs: + linux: + name: Linux (Swift ${{ matrix.swift }}, ${{ matrix.configuration }}) + runs-on: ubuntu-24.04 + container: swift:${{ matrix.swift }}-noble + timeout-minutes: 30 + strategy: + fail-fast: false + matrix: + # The oldest supported Swift (swift-tools-version 6.2) and the newest. + swift: ["6.2", "6.4"] + configuration: [debug, release] + steps: + - uses: actions/checkout@v7 + + - name: Toolchain + run: swift --version + + - name: Build (warnings are errors) + run: | + flags="-c ${{ matrix.configuration }} -Xswiftc -warnings-as-errors" + # @testable imports need testing enabled in an optimized build. + [ "${{ matrix.configuration }}" = release ] && flags="$flags -Xswiftc -enable-testing" + echo "FLAGS=$flags" >> "$GITHUB_ENV" + swift build --build-tests $flags + + - name: Test + run: swift test $FLAGS + + macos: + name: macOS (Xcode ${{ matrix.xcode }}, ${{ matrix.configuration }}) + runs-on: macos-26 + timeout-minutes: 30 + strategy: + fail-fast: false + matrix: + # The oldest Xcode with Swift 6.2, and the runner's default. + xcode: ["26.0.1", "26.6"] + configuration: [debug, release] + steps: + - uses: actions/checkout@v7 + + - name: Select Xcode + run: | + sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app + swift --version + + - name: Build (warnings are errors) + run: | + flags="-c ${{ matrix.configuration }} -Xswiftc -warnings-as-errors" + # @testable imports need testing enabled in an optimized build. + [ "${{ matrix.configuration }}" = release ] && flags="$flags -Xswiftc -enable-testing" + echo "FLAGS=$flags" >> "$GITHUB_ENV" + swift build --build-tests $flags + + - name: Test + run: swift test $FLAGS diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Package.swift b/Package.swift index 94c9045..0781577 100644 --- a/Package.swift +++ b/Package.swift @@ -3,7 +3,7 @@ import PackageDescription let package = Package( name: "PerfectAuthNet", - platforms: [.macOS(.v26)], + platforms: [.macOS(.v12)], products: [ .library(name: "PerfectAuthNet", targets: ["PerfectAuthNet"]), ], diff --git a/README.md b/README.md index acf2e36..f5c107c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,31 @@ -# Perfect-AuthNet +# Perfect AuthNet -A small, clean-room Swift 6 client for the [Authorize.net](https://developer.authorize.net/) payment gateway. +

+ Swift 6.2+ + Platforms macOS 12+ | Linux + + License Apache 2.0 + +

-**Requirements:** Swift tools 6.2, macOS 26 (Tahoe) — the only platform currently declared in `Package.swift`. No iOS/watchOS/tvOS/Linux target is declared yet, so despite the "mobile and web storefronts" framing below (describing the *payment flows* it supports, i.e. Accept.js/Accept Mobile nonces — not that the package itself runs on iOS today), this only builds on macOS 26+ for now. +A small Swift client for the [Authorize.net](https://developer.authorize.net/) payment gateway's +JSON API (`request.api`). It doesn't support the legacy AIM/SIM name-value interface. -**Status:** staged, unintegrated infrastructure. This package has zero consumers in the Perfect-Resurrection ecosystem right now — no other package depends on or imports it, and the Lasso site's own code does not call into it either. Authorize.net gateway calls in that codebase currently go through raw `Pair()`/`include_url` natives directly in `includes/efs_process.lasso`, exercised during Perfect-Lasso's validation testing (a Swift reimplementation of the Lasso language, still in active development and not yet production-ready — sandbox gateway only, no real transactions). Perfect-AuthNet is meant to eventually formalize/replace that ad-hoc integration with a proper native Swift client; it is planned future work, not dead code. +- No package dependencies: Foundation only (`URLSession` and `Codable`). +- Charges Accept.js and Accept Mobile payment nonces (`opaqueData`), so raw card numbers never + reach your server. +- Swift 6 strict concurrency; every public type is `Sendable`. -- **Zero dependencies** — Foundation only (`URLSession` + `Codable`). -- Targets the **modern Authorize.net JSON API** (`request.api`), not the legacy AIM/SIM name-value interface. -- Supports **mobile and web storefront payment flows**: charge Accept.js / Accept Mobile payment nonces (`opaqueData`) so raw card numbers never touch your backend. -- Swift 6 strict concurrency; everything is `Sendable`. +## Requirements -## Install +- Swift 6.2 or later (`swift-tools-version: 6.2`, Swift 6 language mode). +- macOS 12 or later, or Linux (`FoundationNetworking`). CI covers Swift 6.2 and 6.4 on Ubuntu + 24.04 and Xcode 26.0.1 and 26.6 on macOS, in debug and release, with warnings as errors. + +## Using in your project ```swift -.package(path: "../Perfect-AuthNet"), // or your fork's URL +.package(url: "https://github.com/PerfectlySoft/Perfect-AuthNet.git", from: "1.0.0"), ``` ```swift @@ -32,49 +43,51 @@ let client = AuthNetClient( environment: .sandbox // .production when you go live ) -// Mobile/web: charge a tokenized nonce from Accept.js / Accept Mobile. +// Charge a nonce produced by Accept.js or Accept Mobile on the client. let result = try await client.charge( amount: 49.99, payment: .nonce(value: opaqueDataValueFromClient), - order: OrderInfo(invoiceNumber: "INV-1001", description: "Scrubs set") + order: OrderInfo(invoiceNumber: "INV-1001", description: "Order 1001") ) if result.approved { - print("charged — transaction \(result.transactionID)") + print("charged: transaction \(result.transactionID)") } else { print("declined: \(result.error ?? "unknown reason")") } ``` -A **declined** card is a normal returned `TransactionResult` with `approved == false` — not a thrown error. Errors are thrown only for transport failures, malformed responses, and gateway-level rejections (bad credentials, validation), via `AuthNetError`. +A declined card isn't an error. `charge` returns a `TransactionResult` with `approved == false`. +`AuthNetError` is thrown only for transport failures, malformed responses, and gateway-level +rejections such as bad credentials or validation failures. ## Payment input ```swift -// Preferred for storefronts — a nonce from the Accept.js / Accept Mobile SDK: +// Preferred: a nonce from the Accept.js or Accept Mobile SDK. .nonce(value: "") .opaqueData(descriptor: "COMMON.ACCEPT.INAPP.PAYMENT", value: "") -// Server-to-server or testing only — a raw card (you own the PCI scope): +// Server-to-server or testing only. You take on the PCI scope. .creditCard(number: "4111111111111111", expiration: "2030-12", code: "123") ``` ## Operations ```swift -// Authorize + capture in one step (a standard charge) +// Authorize and capture in one step (a standard charge). try await client.charge(amount: 49.99, payment: .nonce(value: nonce)) -// Authorize now, capture later +// Authorize now, capture later. let auth = try await client.authorize(amount: 49.99, payment: .nonce(value: nonce)) -try await client.capture(transactionID: auth.transactionID) // full amount -try await client.capture(transactionID: auth.transactionID, amount: 40) // or a lower amount +try await client.capture(transactionID: auth.transactionID) // full amount +try await client.capture(transactionID: auth.transactionID, amount: 40) // or less -// Refund a settled transaction (needs the original card's last 4 + expiration) +// Refund a settled transaction (needs the original card's last four digits and expiration). try await client.refund(transactionID: txnID, amount: 49.99, cardLastFour: "1111", expiration: "2030-12") -// Void an unsettled transaction +// Void an unsettled transaction. try await client.void(transactionID: txnID) ``` @@ -82,28 +95,30 @@ try await client.void(transactionID: txnID) ```swift public struct TransactionResult { - let responseCode: ResponseCode // .approved / .declined / .error / .heldForReview - let transactionID: String // use to capture, refund, or void later + let responseCode: ResponseCode // .approved, .declined, .error or .heldForReview + let transactionID: String // for a later capture, refund or void let authCode: String? let accountNumber: String? // masked, e.g. "XXXX1111" let accountType: String? // e.g. "Visa" let avsResultCode: String? let cvvResultCode: String? let message: String? // "code: description" - let error: String? // "code: text" for declines/errors + let error: String? // "code: text" for declines and errors var approved: Bool // responseCode == .approved } ``` ## Testing -Offline tests (request encoding, response decoding, BOM handling, amount formatting) run with no network via a mocked `URLSession`: +The offline tests (request encoding, response decoding, BOM handling, amount formatting) use a +mocked `URLSession` and need no network: ```sh swift test ``` -Live sandbox tests are gated — supply sandbox credentials to run them against `apitest.authorize.net`: +The live tests run against the Authorize.net sandbox (`apitest.authorize.net`) when you supply +sandbox credentials: ```sh AUTHNET_TESTS=1 AUTHNET_LOGIN_ID=... AUTHNET_TRANSACTION_KEY=... swift test @@ -111,11 +126,14 @@ AUTHNET_TESTS=1 AUTHNET_LOGIN_ID=... AUTHNET_TRANSACTION_KEY=... swift test ## Notes -- The JSON API returns responses prefixed with a UTF-8 BOM; the client strips it before decoding (a common integration gotcha). -- Pass a custom `URLSession` to `AuthNetClient(urlSession:)` for certificate pinning or test injection. -- **Not yet covered:** customer profiles (CIM / saved cards), recurring billing (ARB), and webhooks — planned once the storefront needs stored payment methods. -- This is early-stage, single-commit infrastructure (see Status above) — not yet exercised against production traffic. +- The JSON API prefixes its responses with a UTF-8 byte-order mark. The client strips it before + decoding. +- To pin certificates or inject a test session, pass your own `URLSession` to + `AuthNetClient(urlSession:)`. +- Not yet covered: customer profiles (CIM, saved cards), recurring billing (ARB), and webhooks. +- This package hasn't handled production traffic yet. Test against the sandbox before going + live. ## License -No `LICENSE` file is present in this repository yet, and none is implied by this README. Until one is added, treat the source as all-rights-reserved; contact the repo owner before reuse. +Apache 2.0. See [LICENSE](LICENSE). diff --git a/Sources/PerfectAuthNet/AuthNetClient.swift b/Sources/PerfectAuthNet/AuthNetClient.swift index 43f9a7c..faebb79 100644 --- a/Sources/PerfectAuthNet/AuthNetClient.swift +++ b/Sources/PerfectAuthNet/AuthNetClient.swift @@ -1,4 +1,7 @@ import Foundation +#if canImport(FoundationNetworking) +import FoundationNetworking +#endif /// A client for the Authorize.net JSON API (the modern `request.api` endpoint). /// diff --git a/Tests/PerfectAuthNetTests/PerfectAuthNetTests.swift b/Tests/PerfectAuthNetTests/PerfectAuthNetTests.swift index b5cd06a..eb2c8af 100644 --- a/Tests/PerfectAuthNetTests/PerfectAuthNetTests.swift +++ b/Tests/PerfectAuthNetTests/PerfectAuthNetTests.swift @@ -1,5 +1,8 @@ import Testing import Foundation +#if canImport(FoundationNetworking) +import FoundationNetworking +#endif @testable import PerfectAuthNet // MARK: - URLProtocol mock (captures the outgoing request, returns a canned response)