stytch 3.3.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8df42027eb062c7be0ddfbe1f1ee11eece832c7ca442391421f7355a072c77e
-  data.tar.gz: 8df5887ad55b4f1c32efdcccf1873ffd371c4d2df3278ffbf290b1868cc56dad
+  metadata.gz: 4b0df049845701e13ae486eaf2031c118115588171ff8e486c7c5a7e0c6adc58
+  data.tar.gz: 7532843bccf0d29542b3a2358969085fc8faf9800010770b8d288d624713a0bf
 SHA512:
-  metadata.gz: fec2e73072c90bfc9d5d8c0ff7c29ccbb41e9979d117b1f5a91f2492a83a1f576390debf250a4e17d767a65d708799f48a4222ec79d4bddf27b79d3788f5670a
-  data.tar.gz: 77e7d520386a75d66b9aefc5052a93094d297d0764c5d7dc0c08757e9234c63ed0ead8cc17d9dd9160b404ea11c62ace810896e9b8c7dc98fa1a965bf0b7e6b6
+  metadata.gz: 0777de15b4986e805daf9640e178b479e28f5954d133dc2ed11e8c21c1ab192d3eb7917bde055dc7a23836ba112f8d446f4877c7fdbb6af711ae17f974352cda
+  data.tar.gz: d2ae3531f577256dceecd0d7e1326f65ceda2176bc27cb301409d6bf2a87cb5a5d9740ced383d7fafe83ba9673299db714e36d745e82e859e4badb48b2b4d324

data/README.md

@@ -32,9 +32,10 @@ This client library supports all of Stytch's live products:
   - [x] [WhatsApp passcodes](https://stytch.com/docs/api/whatsapp-send)
   - [x] [Email passcodes](https://stytch.com/docs/api/send-otp-by-email)
   - [x] [Session Management](https://stytch.com/docs/api/sessions-overview)
-  - [x] [WebAuthn (Beta)](https://stytch.com/docs/api/webauthn-overview)
-  - [x] [Time-based one-time passcodes (TOTPs) (Beta)](https://stytch.com/docs/api/totps-overview)
-  - [x] [Crypto wallets (Beta)](https://stytch.com/docs/api/crypto-wallet-overview)
+  - [x] [WebAuthn](https://stytch.com/docs/api/webauthn-overview)
+  - [x] [Time-based one-time passcodes (TOTPs)](https://stytch.com/docs/api/totps-overview)
+  - [x] [Crypto wallets](https://stytch.com/docs/api/crypto-wallet-overview)
+  - [x] [Passwords (Beta)](https://stytch.com/docs/api/password-overview)
 
 ### Example usage
 Create an API client:

data/lib/stytch/client.rb

@@ -8,12 +8,13 @@ require_relative 'sessions'
 require_relative 'totps'
 require_relative 'webauthn'
 require_relative 'crypto_wallets'
+require_relative 'passwords'
 
 module Stytch
   class Client
     ENVIRONMENTS = %i[live test].freeze
 
-    attr_reader :users, :magic_links, :oauth, :otps, :sessions, :totps, :webauthn, :crypto_wallets
+    attr_reader :users, :magic_links, :oauth, :otps, :sessions, :totps, :webauthn, :crypto_wallets, :passwords
 
     def initialize(env:, project_id:, secret:, &block)
       @api_host   = api_host(env)
@@ -30,6 +31,7 @@ module Stytch
       @totps = Stytch::TOTPs.new(@connection)
       @webauthn = Stytch::WebAuthn.new(@connection)
       @crypto_wallets = Stytch::CryptoWallets.new(@connection)
+      @passwords = Stytch::Passwords.new(@connection)
     end
 
     private
@@ -40,8 +42,11 @@ module Stytch
         'https://api.stytch.com'
       when :test
         'https://test.stytch.com'
+      when /\Ahttps?:\/\//
+        # If this is a string that looks like a URL, assume it's an internal development URL.
+        env
       else
-        raise ArgumentError, "Invalid value for env (#{@env}): should be live or test"
+        raise ArgumentError, "Invalid value for env (#{env}): should be :live or :test"
       end
     end
 

data/lib/stytch/crypto_wallets.rb

@@ -33,7 +33,8 @@ module Stytch
       signature:,
       session_token: nil,
       session_jwt: nil,
-      session_duration_minutes: nil
+      session_duration_minutes: nil,
+      session_custom_claims: nil
     )
       request = {
         crypto_wallet_address: crypto_wallet_address,
@@ -44,6 +45,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
       post_request("#{PATH}/authenticate", request)
     end

data/lib/stytch/magic_links.rb

@@ -38,6 +38,7 @@ module Stytch
       session_token: nil,
       session_jwt: nil,
       session_duration_minutes: nil,
+      session_custom_claims: nil,
       code_verifier: nil
     )
       request = {
@@ -49,6 +50,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
       request[:code_verifier] = code_verifier unless code_verifier.nil?
 
       post_request("#{PATH}/authenticate", request)

data/lib/stytch/oauth.rb

@@ -17,6 +17,7 @@ module Stytch
       session_token: nil,
       session_jwt: nil,
       session_duration_minutes: nil,
+      session_custom_claims: nil,
       code_verifier: nil
     )
       request = {
@@ -25,6 +26,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
       request[:code_verifier] = code_verifier unless code_verifier.nil?
 
       post_request("#{PATH}/authenticate", request)

data/lib/stytch/otps.rb

@@ -25,7 +25,8 @@ module Stytch
       options: {},
       session_token: nil,
       session_jwt: nil,
-      session_duration_minutes: nil
+      session_duration_minutes: nil,
+      session_custom_claims: nil
     )
       request = {
         method_id: method_id,
@@ -37,6 +38,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
       post_request("#{PATH}/authenticate", request)
     end

data/lib/stytch/passwords.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require_relative 'request_helper'
+
+module Stytch
+  class Passwords
+    include Stytch::RequestHelper
+
+    attr_reader :email
+
+    PATH = '/v1/passwords'
+
+    def initialize(connection)
+      @connection = connection
+
+      @email = Stytch::Passwords::Email.new(@connection)
+    end
+
+    def create(
+      email:,
+      password:,
+      session_duration_minutes: nil,
+      session_custom_claims: nil
+    )
+      request = {
+        email: email,
+        password: password
+      }
+
+      request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
+
+      post_request(PATH.to_s, request)
+    end
+
+    def authenticate(
+      email:,
+      password:,
+      session_token: nil,
+      session_jwt: nil,
+      session_duration_minutes: nil,
+      session_custom_claims: nil
+    )
+      request = {
+        email: email,
+        password: password
+      }
+
+      request[:session_token] = session_token unless session_token.nil?
+      request[:session_jwt] = session_jwt unless session_jwt.nil?
+      request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
+
+      post_request("#{PATH}/authenticate", request)
+    end
+
+    def strength_check(
+      password:,
+      email: nil
+    )
+      request = {
+        password: password
+      }
+
+      request[:email] = email unless email.nil?
+
+      post_request("#{PATH}/strength_check", request)
+    end
+
+    def migrate(
+      email:,
+      hash:,
+      hash_type:,
+      prepend_salt: nil,
+      append_salt: nil
+    )
+      request = {
+        email: email,
+        hash: hash,
+        hash_type: hash_type
+      }
+
+      request[:prepend_salt] = prepend_salt unless prepend_salt.nil?
+      request[:append_salt] = append_salt unless append_salt.nil?
+
+      post_request("#{PATH}/migrate", request)
+    end
+
+    class Email
+      include Stytch::RequestHelper
+
+      PATH = "#{Stytch::Passwords::PATH}/email"
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def reset_start(
+        email:,
+        login_redirect_url: nil,
+        reset_password_redirect_url: nil,
+        login_expiration_minutes: nil,
+        reset_password_expiration_minutes: nil,
+        attributes: {},
+        code_challenge: nil
+      )
+        request = {
+          email: email
+        }
+
+        request[:login_redirect_url] = login_redirect_url unless login_redirect_url.nil?
+        request[:reset_password_redirect_url] = reset_password_redirect_url unless reset_password_redirect_url.nil?
+        request[:login_expiration_minutes] = login_expiration_minutes unless login_expiration_minutes.nil?
+        unless reset_password_expiration_minutes.nil?
+          request[:reset_password_expiration_minutes] =
+            reset_password_expiration_minutes
+        end
+        request[:attributes] = attributes if attributes != {}
+        request[:code_challenge] = code_challenge unless code_challenge.nil?
+
+        post_request("#{PATH}/reset/start", request)
+      end
+
+      def reset(
+        token:,
+        password:,
+        session_token: nil,
+        session_jwt: nil,
+        session_duration_minutes: nil,
+        session_custom_claims: nil,
+        attributes: {},
+        options: {},
+        code_verifier: nil
+      )
+        request = {
+          token: token,
+          password: password
+        }
+
+        request[:session_token] = session_token unless session_token.nil?
+        request[:session_jwt] = session_jwt unless session_jwt.nil?
+        request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+        request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
+        request[:attributes] = attributes if attributes != {}
+        request[:options] = options if options != {}
+        request[:code_verifier] = code_verifier unless code_verifier.nil?
+
+        post_request("#{PATH}/reset", request)
+      end
+    end
+  end
+end

data/lib/stytch/sessions.rb

@@ -33,13 +33,15 @@ module Stytch
     def authenticate(
       session_token: nil,
       session_jwt: nil,
-      session_duration_minutes: nil
+      session_duration_minutes: nil,
+      session_custom_claims: nil
     )
       request = {}
 
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
       post_request("#{PATH}/authenticate", request)
     end
@@ -68,12 +70,14 @@ module Stytch
     def authenticate_jwt(
       session_jwt,
       max_token_age_seconds: nil,
-      session_duration_minutes: nil
+      session_duration_minutes: nil,
+      session_custom_claims: nil
     )
       if max_token_age_seconds == 0
         return authenticate(
           session_jwt: session_jwt,
           session_duration_minutes: session_duration_minutes,
+          session_custom_claims: session_custom_claims,
         )
       end
 
@@ -86,6 +90,7 @@ module Stytch
         return authenticate(
           session_jwt: session_jwt,
           session_duration_minutes: session_duration_minutes,
+          session_custom_claims: session_custom_claims,
         )
       end
     rescue StandardError
@@ -93,6 +98,7 @@ module Stytch
       return authenticate(
         session_jwt: session_jwt,
         session_duration_minutes: session_duration_minutes,
+        session_custom_claims: session_custom_claims,
       )
     end
 

data/lib/stytch/totps.rb

@@ -30,7 +30,8 @@ module Stytch
       totp_code:,
       session_token: nil,
       session_jwt: nil,
-      session_duration_minutes: nil
+      session_duration_minutes: nil,
+      session_custom_claims: nil
     )
       request = {
         user_id: user_id,
@@ -40,6 +41,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
       post_request("#{PATH}/authenticate", request)
     end
@@ -59,7 +61,8 @@ module Stytch
       recovery_code:,
       session_token: nil,
       session_jwt: nil,
-      session_duration_minutes: nil
+      session_duration_minutes: nil,
+      session_custom_claims: nil
     )
       request = {
         user_id: user_id,
@@ -69,6 +72,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
       post_request("#{PATH}/recover", request)
     end

data/lib/stytch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stytch
-  VERSION = '3.3.0'
+  VERSION = '3.6.0'
 end

data/lib/stytch/webauthn.rb

@@ -57,7 +57,8 @@ module Stytch
       public_key_credential:,
       session_token: nil,
       session_jwt: nil,
-      session_duration_minutes: nil
+      session_duration_minutes: nil,
+      session_custom_claims: nil
     )
       request = {
         public_key_credential: public_key_credential
@@ -66,6 +67,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
       post_request("#{PATH}/authenticate", request)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.6.0
 platform: ruby
 authors:
 - stytch
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-01 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,7 +92,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.3
-description: 
+description:
 email:
 - support@stytch.com
 executables: []
@@ -119,6 +119,7 @@ files:
 - lib/stytch/middleware.rb
 - lib/stytch/oauth.rb
 - lib/stytch/otps.rb
+- lib/stytch/passwords.rb
 - lib/stytch/request_helper.rb
 - lib/stytch/sessions.rb
 - lib/stytch/totps.rb
@@ -132,7 +133,7 @@ licenses:
 metadata:
   homepage_uri: https://stytch.com
   source_code_uri: https://github.com/stytchauth/stytch-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Stytch Ruby Gem
 test_files: []