unit-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa9a1cd6cf99b8de4df268d918b5be2d4fc722e90fd861ad9c25da4c50f31d41
-  data.tar.gz: b3d93e3c864e8578062514a92ebc7cb168a567da0b4304e608ed3cce9e231d84
+  metadata.gz: 18b867d8d8816b49b9f6fc3c5ad56cf9d8f880ef7cde8d00967ada67c466b382
+  data.tar.gz: 834f229a02e5d24662e4ac0ed9726d1c0bb1122bb29ec567ed63989bbcdf9be4
 SHA512:
-  metadata.gz: 4b95bd4f2ea05a77d8e3f7e8ab0592642ebe4b16ac4b42537b3c93f92b8ac8725365c2225b1d1960e50f9c5ee469200281a57fb59bea5ebbf5d694d845f205ec
-  data.tar.gz: e50fd998966dc6d6af5e24e23819ba0ce5655b3c767abf17e915a9669fbeed22e79294012a6dd10758679c8916e116dba3ff490e6070cf901c21c80bb02b9950
+  metadata.gz: 6c2dbbbd2b14d234b4452dfc6cbe1a425cb7709cf7577e3e3a7c616315efaab1c914b2471d7e3a1be0dd3e2c86b51c73bae75a0e7e6f949f7de5a6ed29436818
+  data.tar.gz: eeb6aff99dfd1c0cc9d3660714987a71ee7f269573f3a227bd532aa034eeb42e263ccce608bebc54e2f1f1dc9bef45ca312c56eb8140e1697bbdd8adbae5acfe

data/.github/workflows/release.yml

@@ -0,0 +1,86 @@
+# Publishes the gem to RubyGems.org via OIDC trusted publishing whenever
+# lib/unit-ruby/version.rb changes on main. No long-lived API key is stored:
+# configure-rubygems-credentials exchanges a short-lived GitHub OIDC token for
+# RubyGems credentials by assuming the OIDC API key role configured on
+# rubygems.org. `bundle exec rake release` then builds the gem, creates and
+# pushes the vX.Y.Z tag, and publishes to RubyGems.org.
+name: Release
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - lib/unit-ruby/version.rb
+
+# Never run two releases at once.
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # push the version tag
+      id-token: write # mint the OIDC token for trusted publishing
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@12fd324f1d0b43274fdc8130f6980590a667c455 # v1.312.0
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Read and validate gem version
+        id: version
+        run: |
+          version="$(ruby -e 'require "./lib/unit-ruby/version"; print Unit::VERSION')"
+          # Enforce semver before the value is used anywhere else, so a crafted
+          # version string can't smuggle shell metacharacters into later steps.
+          if [[ ! "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?$ ]]; then
+            echo "Invalid version format: $version" >&2
+            exit 1
+          fi
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+      - name: Check whether this version is already tagged
+        id: tag
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          if git rev-parse "v$VERSION" >/dev/null 2>&1; then
+            echo "Version v$VERSION already released; skipping."
+            echo "exists=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=false" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Configure RubyGems credentials
+        if: steps.tag.outputs.exists == 'false'
+        uses: rubygems/configure-rubygems-credentials@762a4b77c3300434bb57c7ce80b20e36231927aa # v2.0.0
+        with:
+          role-to-assume: rg_oidc_akr_54hgswsa4knajxk89skj
+      - name: Set git identity and push URL
+        if: steps.tag.outputs.exists == 'false'
+        run: |
+          # Attribute the release tag to the last committer on HEAD.
+          git config --global user.email "$(git log -1 --pretty=format:'%ae')"
+          git config --global user.name "$(git log -1 --pretty=format:'%an')"
+          # Restore push credentials (checkout ran with persist-credentials: false)
+          # so `rake release` can push the tag.
+          git remote set-url origin "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY"
+      - name: Release
+        if: steps.tag.outputs.exists == 'false'
+        run: bundle exec rake release
+      - name: Wait for release to propagate
+        if: steps.tag.outputs.exists == 'false'
+        run: |
+          gem install rubygems-await
+          gem_tuple="$(ruby -rbundler/setup -rbundler -e '
+              spec = Bundler.definition.specs.find {|s| s.name == ARGV[0] }
+              raise "No spec for #{ARGV[0]}" unless spec
+              print [spec.name, spec.version, spec.platform].join(":")
+            ' "unit-ruby")"
+          gem await "${gem_tuple}"

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
-## 0.1.0 
+## 1.2.0
 
-Initial release
+- Add `Unit::BookPayment` for booking transfers between Unit accounts.
+- Allow `belongs_to` relationships to specify the JSON:API `type` sent to Unit.
+
+## 1.1.1
+
+- Publish releases automatically to RubyGems.org via OIDC trusted publishing when `version.rb` changes on `main`.
+
+## 1.1.0
+
+- Support Rails 8 / Active Support 8 (widen the `activesupport` dependency to `>= 7.0, < 9`).
+- Stop committing `Gemfile.lock` so applications resolve dependencies against the gemspec
+
+## 1.0.1
+
+- Resolve dependency vulnerabilities by bumping vulnerable transitive dependencies.
+
+## 1.0.0
+
+- First stable release, promoting the 0.12.x API to 1.0 with no breaking changes.
+- Expanded README documentation and cleaned up the gemspec and CI configuration.
+
+## 0.1.0
+
+Initial release

data/README.md

@@ -95,6 +95,20 @@ debit_card = Unit::IndividualDebitCard.create(
     shipping_address: customer.address,
     tags: { externalUserId: my_user_id }
 )
+
+# Book a transfer between two Unit accounts
+other_account = Unit::DepositAccount.create(
+    deposit_product: 'checking',
+    customer: customer
+)
+
+book_payment = Unit::BookPayment.create(
+    amount: 10_000, # in cents
+    description: 'Transfer between accounts',
+    idempotency_key: "book-payment-for-#{my_user_id}",
+    account: deposit_account,
+    counterparty_account: other_account
+)
 ```
 
 > [!TIP]
@@ -129,15 +143,13 @@ $ bundle exec rake install
 
 ## Releasing
 
-In order to publish this gem on [RubyGems.org](https://rubygems.org/), you will need to create a RubyGems account. Note that multi-factor authentication must be set up on your account before a gem can be published.
+Releases are minted automatically. When a change to `lib/unit-ruby/version.rb` lands on `main`, the [Release workflow](.github/workflows/release.yml) builds the gem, tags the commit `vX.Y.Z`, and publishes to [RubyGems.org](https://rubygems.org/gems/unit-ruby/). No manual `gem push` is required, and no RubyGems API key is stored — the workflow authenticates via [OIDC trusted publishing](https://guides.rubygems.org/trusted-publishing/).
 
-Once your account is set up, the following operations will facilitate publishing the latest version of the gem:
+To cut a release:
 
-1. After making your changes to the gem, update the version number in `version.rb` and open a PR for review using semantic versioning
-2. Ensure that PR request is approved by appropriate member(s) of the engineering team before publishing the gem in the below steps
-3. Run `gem build unit-ruby`. This will build a version of the gem called `unit-ruby-[gem version number].gem`
-4. Push this latest version of the gem to RubyGems.org by calling `gem push unit-ruby-[gem version number].gem`
-5. Merge PR into `main` branch
+1. Make your changes, then bump the version in `lib/unit-ruby/version.rb` following [semantic versioning](https://semver.org/) and add an entry to `CHANGELOG.md`.
+2. Open a PR and get it approved by the appropriate member(s) of the engineering team.
+3. Merge to `main`. The Release workflow publishes the new version automatically. If the version is unchanged, no release is cut.
 
 ## Contributing
 

data/lib/unit-ruby/book_payment.rb

@@ -0,0 +1,25 @@
+module Unit
+  # A transfer of funds between two Unit accounts
+  class BookPayment < APIResource
+    path '/payments'
+
+    attribute :amount, Types::Integer # Amount to transfer in cents.
+    attribute :description, Types::String # Description of the payment. Max of 50 characters.
+    attribute :transaction_summary_override, Types::String # Optional. Overrides the transaction summary. Max of 100 characters.
+    attribute :idempotency_key, Types::String # Optional
+    attribute :tags, Types::Hash # Optional
+
+    attribute :direction, Types::String, readonly: true
+    attribute :summary, Types::String, readonly: true
+    attribute :status, Types::String, readonly: true
+    attribute :reason, Types::String, readonly: true
+    attribute :created_at, Types::DateTime, readonly: true
+
+    belongs_to :account, class_name: 'Unit::DepositAccount'
+    belongs_to :counterparty_account, class_name: 'Unit::DepositAccount', type: :depositAccount
+    belongs_to :customer, class_name: 'Unit::IndividualCustomer'
+    belongs_to :counterparty_customer, class_name: 'Unit::IndividualCustomer'
+
+    include ResourceOperations::Create
+  end
+end

data/lib/unit-ruby/util/api_resource.rb

@@ -98,8 +98,13 @@ module Unit
 
     # Creates an association to a related resource
     # This will create a helper method to traverse into a resource's related resource(s)
-    def self.belongs_to(resource_name, class_name: nil)
+    #
+    # @param resource_name [Symbol] the name of the relationship
+    # @param class_name [String] the class of the related resource
+    # @param type [Symbol] the JSON:API type sent for the relationship, when it differs from the relationship name
+    def self.belongs_to(resource_name, class_name: nil, type: nil)
       class_name ||= resource_name.to_s.camelize
+      type ||= resource_name.to_s.camelize(:lower).to_sym
 
       define_method(resource_name) do
         relationship_id = relationships.dig(resource_name, :data, :id)
@@ -111,7 +116,7 @@ module Unit
 
       define_method("#{resource_name}=") do |resource|
         relationships[resource_name] = {
-          data: { type: resource_name.to_s.camelize(:lower).to_sym, id: resource.id }
+          data: { type: type, id: resource.id }
         }
       end
     end

data/lib/unit-ruby/version.rb

@@ -1,3 +1,3 @@
 module Unit
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/unit-ruby.rb

@@ -29,6 +29,7 @@ require 'unit-ruby/ach_payment'
 require 'unit-ruby/application_form'
 require 'unit-ruby/atm_location'
 require 'unit-ruby/authorization'
+require 'unit-ruby/book_payment'
 require 'unit-ruby/ach_counterparty'
 require 'unit-ruby/customer_token_verification'
 require 'unit-ruby/customer_token'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unit-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chloe Isacke
@@ -153,6 +153,7 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -171,6 +172,7 @@ files:
 - lib/unit-ruby/application_form.rb
 - lib/unit-ruby/atm_location.rb
 - lib/unit-ruby/authorization.rb
+- lib/unit-ruby/book_payment.rb
 - lib/unit-ruby/customer_bank_migration.rb
 - lib/unit-ruby/customer_token.rb
 - lib/unit-ruby/customer_token_verification.rb