duo_universal_ruby 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d8b04367166707ba3036e2f31abe79fe59e1ae37e9e804d6494d5399d92a98f
-  data.tar.gz: 7d71a751b484f66f29d62226c9807217aa8287408ca2a4645a8aca58e9611b84
+  metadata.gz: f55b56ad695ff78ddadb49c27c10a9184dd62e68101221cb8eee2474226b1ec0
+  data.tar.gz: 4db1b2d803e2692fbcf32da757e101335db542caf3fd7d78e9296e4c3452e7b7
 SHA512:
-  metadata.gz: 015ed26f061ce08c4d2265bf192bfc79e196d8804bd6a3893845ca87c483605da0738117cfb2bf44d09c0eaa425615e2dadc3e5c6cebff6a64cb8f11ba3c6497
-  data.tar.gz: 5c24588c3626c91923dbbec002fdbb72786bcac43ba2674856ec29a486a1b9458f69a18a2f8f65c1055e98bda3061cb3c5f1056bc22f3e5d3e0d96681cc40a22
+  metadata.gz: e79206db4e70a6bd9944ce4799bbc661a7580d8a96855c2bfb8f069f9081d79d21b8c71854c074d044034f29a67bb6b9628f3dad4a8cb80aa439287356b6ba6f
+  data.tar.gz: 560c28117ec3a588ec77f0a10cf5397813ab4af5159d62afc05e584457c1e18cd113b8fd6caa1b1bfa27c0ee843ed9c272b6c4d0675d1014606f6a274936ddfd

data/CHANGELOG.md

@@ -1,5 +1,7 @@
-## [Unreleased]
-
-## [0.1.0] - 2025-07-28
+## [0.1.0] - 2025-08-14
 
 - Initial release
+
+## [0.1.1] - 2025-08-15
+
+- minor changes to gemfile, gemspec dependencies and documentation.

data/README.md

@@ -1,6 +1,6 @@
 # DuoUniversalRuby
 
-## A Ruby implementation of the Duo WebSDKv4 with Universal Prompt
+## A Ruby implementation of the 2FA API to Duo WebSDKv4 apps using the Universal Prompt
 - https://duo.com/docs/duoweb
 - https://duo.com/docs/oauthapi
 
@@ -19,7 +19,13 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ```ruby
-client = DuoUniversalRails::Client.new(
+# Replace fake DUO constant values with real values obtained from DUO
+DUO_CLIENT_ID = "X" * 20
+DUO_CLIENT_SECRET = "x" * 40
+DUO_HOST = "api-xxxxxxxx.duosecurity.com"
+DUO_REDIRECT_URI =  "https://localhost/duo-callback"
+
+client = DuoUniversalRuby::Client.new(
             client_id: DUO_CLIENT_ID,
             client_secret: DUO_CLIENT_SECRET,
             api_host: DUO_HOST,
@@ -46,8 +52,11 @@ client.health_check
 
 state = client.generate_state
     # Random value that is checked after interactions to protect against CSRF attacks
-   
-client.create_auth_url(username, state)
+
+username = "test@example.com"
+    # user authenticating with Duo
+
+client.create_auth_url(username: username, state: state)
     # Generate uri to Duo's prompt
     # GET /oauth/v1/authorize
 
@@ -59,31 +68,30 @@ client.create_auth_url(username, state)
     # Returns:
     # Authorization uri to redirect to for the Duo prompt
 
-    # After a successful Duo login, Duo redirect the user to the redirect_uri, e.g. /duo_callback with a duoCode and state
+    # After a successful Duo authentication, Duo redirects the user to the redirect_uri, e.g. /duo_callback with the params: duo_code and state
+    
+decoded_token = client.exchange_authorization_code_for_2fa_result(duo_code: duo_code, username: username)
+    # Exchange the duo_code for a token with Duo to determine
+    # if the auth was successful.
 
-decoded_token = client.exchange_authorization_code_for_2fa_result(duoCode, username)
-      # Exchange the duo_code for a token with Duo to determine
-      # if the auth was successful.
+    # POST /oauth/v1/token
 
-      # POST /oauth/v1/token
-
-      # Arguments:
-      # duoCode         -- Authentication session transaction id
-      #                    returned by Duo
-      # username        -- Name of the user authenticating with Duo
+    # Arguments:
+    # duo_code        -- Authentication session transaction id returned by Duo
+    # username        -- Name of the user authenticating with Duo
 
-      # Return:
-      # A token with meta-data about the auth
+    # Return:
+    # A token with meta-data about the auth
 
-      # Raises:
-      # DuoException on error for invalid duo_codes, invalid credentials,
-      # or problems connecting to Duo
+    # Raises:
+    # DuoException on error for invalid duo_codes, invalid credentials,
+    # or problems connecting to Duo
 
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/duo_universal_ruby/client.rb

@@ -119,7 +119,7 @@ module DuoUniversalRuby
       # if the auth was successful.
 
       # Arguments:
-      # duoCode         -- Authentication session transaction id
+      # duo_code         -- Authentication session transaction id
       #                    returned by Duo
       # username        -- Name of the user authenticating with Duo
       # nonce           -- (Optional) Random 36B string used to associate

data/lib/duo_universal_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duo_universal_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Todd Parsnick
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.2
 description: Easily add two-factor authentication to any Ruby web authentication flow
   using a Web SDKv4 app with the universal prompt in Duo.
 email:
@@ -36,7 +36,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- duo_universal_ruby.gemspec
 - lib/duo_universal_ruby.rb
 - lib/duo_universal_ruby/ca_certs.pem
 - lib/duo_universal_ruby/client.rb
@@ -50,7 +49,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tparsnick/duo_universal_ruby
   source_code_uri: https://github.com/tparsnick/duo_universal_ruby
-  changelog_uri: https://github.com/tparsnick/duo_universal_ruby/CHANGELOG.md
+  changelog_uri: https://github.com/tparsnick/duo_universal_ruby/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
 - lib

data/duo_universal_ruby.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/duo_universal_ruby/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "duo_universal_ruby"
-  spec.version = DuoUniversalRuby::VERSION
-  spec.authors = ["Todd Parsnick"]
-  spec.email = ["tparsnick@gmail.com"]
-
-  spec.summary = "Easily add two-factor authentication to any Ruby web authentication flow using a Web SDKv4 app with the universal prompt in Duo."
-  spec.description = "Easily add two-factor authentication to any Ruby web authentication flow using a Web SDKv4 app with the universal prompt in Duo."
-  spec.homepage = 'https://github.com/tparsnick/duo_universal_ruby'
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.2"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = 'https://github.com/tparsnick/duo_universal_ruby'
-  spec.metadata["changelog_uri"] = 'https://github.com/tparsnick/duo_universal_ruby/CHANGELOG.md'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Runtime dependencies
-  spec.add_runtime_dependency 'jwt'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end