rotp 6.3.1 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c2b1404b98062478370f77b91348c5480783bbf6353fcc4d1beea0603bea63f
-  data.tar.gz: 2134d1e2ce2af29a4b72f75a8c7b8bea073b215f2ace05be9e3cefd2f10e7587
+  metadata.gz: 19178f891005be16f5ade5f33a43c8cc77a38e1ccdd81ca62285b32cc2dd3090
+  data.tar.gz: 40f54eaf3c58f09af3c9fe55aa232c97a49a4df581f3293f04bd906f89f1df06
 SHA512:
-  metadata.gz: 1b787d125aa066e36a2f905bd9e707253c77f75a8abe189ca6eb6f160fa4203960064089ec6ba15ea3e16d83826d6f2346528b95942681226fca32b47a09763a
-  data.tar.gz: 1396bb30353567e42df1ecd602b6c93c88034d9755be47a1848b70200ceb1111cf35fcad0abd8c5d44881563821ae3d555be222153141da6723b1648072895c3
+  metadata.gz: f2ad58aa47f5781b2a15891a1cad38a3cab52e9b93a6e4b7ade3e0d18bce1e887d25369f3fdfd11e0752992cd78f66fccf2cc2cefcdb83671af4d73776eb3d3d
+  data.tar.gz: e3f243779f0dab586cb8307ebc40fed5ed4572d314b056a766a00baaa949971e085fb05557c23947715d5205e0048b0162554d69392e4772304e611fdceee8ce

data/.github/workflows/release.yaml

@@ -2,35 +2,77 @@ name: Release
 
 on:
   push:
-    branches:    
+    branches:
       - 'main'
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Existing tag to build and publish (e.g. v6.3.1). Used to backfill a release that never reached RubyGems.'
+        required: false
+        type: string
+      skip_tests:
+        description: 'Skip the test suite before publishing (only for backfilling an already-tagged release).'
+        required: false
+        default: false
+        type: boolean
+
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
-  release:
+  release-please:
+    if: ${{ github.event_name == 'push' }}
     runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
     steps:
-      - uses: google-github-actions/release-please-action@v4
+      - uses: googleapis/release-please-action@v4
         id: release
         with:
-          release-type: ruby
-          package-name: rotp
-          version-file: "lib/rotp/version.rb"
-      # Checkout code if release was created
-      - uses: actions/checkout@v4
-        if: ${{ steps.release.outputs.release_created }}
-      # Setup ruby if a release was created
-      - uses: ruby/setup-ruby@v1
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+  publish:
+    needs: [release-please]
+    if: ${{ always() && ((github.event_name == 'workflow_dispatch' && inputs.tag != '') || needs.release-please.outputs.release_created == 'true') }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    permissions:
+      contents: write
+      id-token: write
+    env:
+      TAG: ${{ inputs.tag || needs.release-please.outputs.tag_name }}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ env.TAG }}
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2
-          bundler-cache: true
-        if: ${{ steps.release.outputs.release_created }}
+          ruby-version: '3.3'
+          bundler-cache: ${{ !inputs.skip_tests }}
+      - name: Verify gem version matches tag
+        run: |
+          tag_version="${TAG#v}"
+          gem_version="$(ruby -Ilib -e "require 'rotp/version'; print ROTP::VERSION")"
+          echo "tag=$tag_version gem=$gem_version"
+          test "$tag_version" = "$gem_version"
       - name: Run tests
+        if: ${{ !inputs.skip_tests }}
         run: bundle exec rspec
-        if: ${{ steps.release.outputs.release_created }}
-      # build gem and add to release
-      - name: Upload Release Artifact
-        if: ${{ steps.release.outputs.release_created }}
+      - name: Configure RubyGems credentials (trusted publishing)
+        uses: rubygems/configure-rubygems-credentials@v2.1.0
+      - name: Build and publish gem
+        run: |
+          gem build *.gemspec
+          gem push *.gem
+      - name: Attach gem to the GitHub release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run:
-          gem build *.gemspec
-          gh release upload ${{ steps.release.outputs.tag_name }} *.gem
+        run: |
+          gh release view "$TAG" >/dev/null 2>&1 || gh release create "$TAG" --title "$TAG" --generate-notes
+          gh release upload "$TAG" *.gem --clobber

data/.github/workflows/test.yaml

@@ -12,11 +12,10 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      # Include '3.5.0-preview1' to test compatibility with the upcoming Ruby 3.5 release.
       matrix:
-        ruby-version: ['3.5.0-preview1', '3.4', '3.3', '3.2', '3.0', '2.7', '2.3', 'truffleruby-head']
+        ruby-version: ['4.0', '3.4', '3.3', '3.2', '3.0', '2.7', '2.3', 'truffleruby-head']
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "6.3.0"
+  ".": "6.4.0"
 }

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [6.4.0](https://github.com/mdp/rotp/compare/v6.3.1...v6.4.0) (2026-10-29)
+
+
+### Features
+
+* add skip_default_uri_params option to provisioning URIs ([16e873c](https://github.com/mdp/rotp/commit/16e873c68e0736f8ce019252985ad0e9fcce95f1))
+
 ## [6.3.1] (2025-06-03)
 
 * Fix: Drop usage of OpenStruct to support Ruby 3.5

data/README.md

@@ -8,7 +8,7 @@ Although this library will continue to be maintained, if you're implementing a 2
 - [Webauthn Ruby Gem](https://github.com/cedarcode/webauthn-ruby)
 - [Rails demo app with Webauthn](https://github.com/cedarcode/webauthn-rails-demo-app)
 
-----
+---
 
 # The Ruby One Time Password Library
 
@@ -17,7 +17,6 @@ Although this library will continue to be maintained, if you're implementing a 2
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/mdp/rotp/master)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/mdp/rotp/blob/master/LICENSE)
 
-
 A ruby library for generating and validating one time passwords (HOTP & TOTP) according to [RFC 4226](https://datatracker.ietf.org/doc/html/rfc4226) and [RFC 6238](https://datatracker.ietf.org/doc/html/rfc6238).
 
 ROTP is compatible with [Google Authenticator](https://github.com/google/google-authenticator) available for [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) and [iPhone](https://itunes.apple.com/en/app/google-authenticator/id388497605) and any other TOTP based implementations.
@@ -150,6 +149,10 @@ totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/My%20Service:alic
 
 hotp = ROTP::HOTP.new("base32secret3232", issuer: "My Service")
 hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/My%20Service:alice%40google.com?secret=base32secret3232&issuer=My%20Service&counter=0'
+
+# By default optional values will be skipped from URI. But you can force to specify all values in the URI by passing `skip_default_uri_params: false`
+totp = ROTP::TOTP.new("base32secret3232", issuer: "My Service", skip_default_uri_params: false)
+totp.provisioning_uri("alice@google.com") # => otpauth://totp/My%20Service:alice%40google.com?secret=base32secret3232&issuer=My%20Service&algorithm=SHA1&digits=6&period=30
 ```
 
 This can then be rendered as a QR Code which the user can scan using their mobile phone and the appropriate application.

data/lib/rotp/otp/uri.rb

@@ -15,7 +15,7 @@ module ROTP
       private
 
       def algorithm
-        return unless %w[sha256 sha512].include?(@otp.digest)
+        return if skip_default_uri_params && @otp.digest == DEFAULT_DIGEST
 
         @otp.digest.upcase
       end
@@ -28,7 +28,7 @@ module ROTP
       end
 
       def digits
-        return if @otp.digits == DEFAULT_DIGITS
+        return if skip_default_uri_params && @otp.digits == DEFAULT_DIGITS
 
         @otp.digits
       end
@@ -62,7 +62,7 @@ module ROTP
 
       def period
         return if @otp.is_a?(HOTP)
-        return if @otp.interval == DEFAULT_INTERVAL
+        return if skip_default_uri_params && @otp.interval == DEFAULT_INTERVAL
 
         @otp.interval
       end
@@ -73,6 +73,10 @@ module ROTP
         when HOTP then 'hotp'
         end
       end
+
+      def skip_default_uri_params
+        @otp.skip_default_uri_params
+      end
     end
   end
 end

data/lib/rotp/otp.rb

@@ -1,7 +1,8 @@
 module ROTP
   class OTP
-    attr_reader :secret, :digits, :digest, :name, :issuer, :provisioning_params
+    attr_reader :secret, :digits, :digest, :name, :issuer, :provisioning_params, :skip_default_uri_params
     DEFAULT_DIGITS = 6
+    DEFAULT_DIGEST = 'sha1'
 
     # @param [String] secret in the form of base32
     # @option options digits [Integer] (6)
@@ -19,13 +20,18 @@ module ROTP
     # @option options provisioning_params [Hash] ({})
     #     Additional non-standard params you may want appended to the
     #     provisioning URI. Ex. `image: 'https://example.com/icon.png'`
+    # @option options skip_default_uri_params [Boolean] (true)
+    #     When true, parameters that match the RFC defaults (SHA1, 6 digits,
+    #     30 second period) are omitted from the provisioning URI. Set to
+    #     false to always include them.
     # @returns [OTP] OTP instantiation
     def initialize(s, options = {})
       @digits = options[:digits] || DEFAULT_DIGITS
-      @digest = options[:digest] || 'sha1'
+      @digest = options[:digest] || DEFAULT_DIGEST
       @name = options[:name]
       @issuer = options[:issuer]
       @provisioning_params = options[:provisioning_params] || {}
+      @skip_default_uri_params = options.fetch(:skip_default_uri_params, true)
       @secret = s
     end
 

data/lib/rotp/version.rb

@@ -1,3 +1,3 @@
 module ROTP
-  VERSION = '6.3.1'.freeze
+  VERSION = '6.4.0'.freeze
 end

data/release-please-config.json

@@ -1,6 +1,9 @@
 {
+  "release-type": "ruby",
   "packages": {
     ".": {
+      "release-type": "ruby",
+      "version-file": "lib/rotp/version.rb",
       "changelog-path": "CHANGELOG.md",
       "bump-minor-pre-major": false,
       "bump-patch-for-minor-pre-major": false,
@@ -9,4 +12,4 @@
     }
   },
   "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
-}
+}

data/spec/lib/rotp/hotp_spec.rb

@@ -110,7 +110,7 @@ RSpec.describe ROTP::HOTP do
 
   describe '#provisioning_uri' do
     let(:hotp) { ROTP::HOTP.new('a' * 32, name: "m@mdp.im") }
-    let(:params) { CGI.parse URI.parse(uri).query }
+    let(:params) { query_params_for(uri) }
 
     it 'created from the otp instance data' do
       expect(hotp.provisioning_uri())

data/spec/lib/rotp/otp/uri_spec.rb

@@ -37,6 +37,12 @@ RSpec.describe ROTP::OTP::URI do
     expect(uri.to_s).to eq 'otpauth://totp/alice%40google.com?secret=JBSWY3DPEHPK3PXP&algorithm=SHA512'
   end
 
+  it 'includes an uppercase non-default digest' do
+    otp = ROTP::TOTP.new('JBSWY3DPEHPK3PXP', digest: 'SHA256')
+    uri = described_class.new(otp, account_name: 'alice@google.com')
+    expect(uri.to_s).to eq 'otpauth://totp/alice%40google.com?secret=JBSWY3DPEHPK3PXP&algorithm=SHA256'
+  end
+
   it 'includes non-default 8 digits' do
     otp = ROTP::TOTP.new('JBSWY3DPEHPK3PXP', digits: 8)
     uri = described_class.new(otp, account_name: 'alice@google.com')
@@ -96,4 +102,37 @@ RSpec.describe ROTP::OTP::URI do
     uri = described_class.new(otp, account_name: 'alice+1234@google.com')
     expect(uri.to_s).to eq 'otpauth://totp/alice%2B1234%40google.com?secret=JBSWY3DPEHPK3PXP'
   end
+
+  context 'with skip_default_uri_params' do
+    it 'excludes default SHA1 algorithm' do
+      otp = ROTP::TOTP.new('JBSWY3DPEHPK3PXP', digest: 'sha1', skip_default_uri_params: true)
+      uri = described_class.new(otp, account_name: 'alice@google.com')
+      expect(uri.to_s).to eq 'otpauth://totp/alice%40google.com?secret=JBSWY3DPEHPK3PXP'
+    end
+
+    it 'excludes default 6 digits' do
+      otp = ROTP::TOTP.new('JBSWY3DPEHPK3PXP', digits: 6, skip_default_uri_params: true)
+      uri = described_class.new(otp, account_name: 'alice@google.com')
+      expect(uri.to_s).to eq 'otpauth://totp/alice%40google.com?secret=JBSWY3DPEHPK3PXP'
+    end
+
+    it 'excludes default 30 second period' do
+      otp = ROTP::TOTP.new('JBSWY3DPEHPK3PXP', interval: 30, skip_default_uri_params: true)
+      uri = described_class.new(otp, account_name: 'alice@google.com')
+      expect(uri.to_s).to eq 'otpauth://totp/alice%40google.com?secret=JBSWY3DPEHPK3PXP'
+    end
+
+    it 'includes all parameters when skip_default_uri_params is false' do
+      otp = ROTP::TOTP.new(
+        'JBSWY3DPEHPK3PXP',
+        digest: 'sha1',
+        digits: 6,
+        interval: 30,
+        issuer: 'ACME Co',
+        skip_default_uri_params: false
+      )
+      uri = described_class.new(otp, account_name: 'alice@google.com')
+      expect(uri.to_s).to eq 'otpauth://totp/ACME%20Co:alice%40google.com?secret=JBSWY3DPEHPK3PXP&issuer=ACME%20Co&algorithm=SHA1&digits=6&period=30'
+    end
+  end
 end

data/spec/lib/rotp/totp_spec.rb

@@ -223,7 +223,7 @@ RSpec.describe ROTP::TOTP do
 
 
   describe '#provisioning_uri' do
-    let(:params) { CGI.parse URI.parse(uri).query }
+    let(:params) { query_params_for(uri) }
 
     context "with a provided name on the TOTP instance" do
       let(:totp) { ROTP::TOTP.new(TEST_SECRET, name: "m@mdp.im") }

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ SimpleCov.start do
   add_filter '/spec/'
 end
 
+require 'uri'
 require 'rotp'
 require 'timecop'
 
@@ -17,4 +18,10 @@ RSpec.configure do |config|
   end
 end
 
+def query_params_for(uri)
+  URI.decode_www_form(URI.parse(uri).query).each_with_object(Hash.new { |hash, key| hash[key] = [] }) do |(key, value), params|
+    params[key] << value
+  end
+end
+
 require_relative '../lib/rotp'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rotp
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.4.0
 platform: ruby
 authors:
 - Mark Percival