kinde_sdk 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8682cdbb9fc753d2d2709a6af5daa79bbf0e58277a11140e12b77726bd69d58e
-  data.tar.gz: bef3ea899737940e81b08de2341f4f588640339b85b7ed607320f10e447cfb5e
+  metadata.gz: 3166fc3f21315cb21235d7c303440266daef8b2d4b37d983e2bc06bb28fd5acd
+  data.tar.gz: 7421f7964d90a458b47724a4073711480a6caeac1cc6fe3e68989dfbe2045821
 SHA512:
-  metadata.gz: 71eb38523a787138251941b911893f4343f155db71c43dccc6b07946a12b7e67e589caeff5546ec793d5a9005ef84e68dc9ad13cb979737b57504bcc02d71127
-  data.tar.gz: 21b7c9219f45e7ecf2f7d7b8b4a2f549926c23b29553ba817d04db0b962f2ee4dda38e9f6de03042153a1072cbe28b62c4e92d3d5e6138ba106d624be13bfd0f
+  metadata.gz: 380bac0d796adc5daf5b55faea19d130e32fc248b2e2fb5f91e0e74bb267b4ac617fb1f51163ce2871a0c78ed2447161a8be316f972a20d694dfd9a665b9fb2c
+  data.tar.gz: d667129a0d21dca7dd07baecedc96e78470eb0952744c7921e2bdb96445524bb378eef2625c99c87b6357ff1183b44e32e1df93fea1f05bf518bb926f53a51d8

data/README.md

@@ -83,8 +83,9 @@ defined in allowed logout urls of your kinde organization's application config
 - `Authorize url` and `Token url` are paths to oauth2 methods in kinde. You don't need to change it.
 - `Debugging` set to true start writing verbose request logs. Might be useful while developing your application.
 - `Business name` is a parameter which is used in requests building. By default it is extracted from your
-`domain` endpoint. For example, if your domain is `your-biz.kinde.com`, then business name will be set to`your-biz`.
-You don't need to change it in general.
+`domain` endpoint. For example, if your domain is `https://your-biz.kinde.com`, then business name will be set 
+to `your-biz`, for `https://example-chamois.au.kinde.com` it'll be `example-chamois.au` and so on.
+You don't need to change it in general, but it is possible to override if needed.
 - `Logger` might be set to any kind of loggers you are using. By default it is set to `Rails.logger` if gem is used in
 rails application or `Logger.new(STDOUT)` if it is not a rails app.
 
@@ -238,15 +239,23 @@ instance_client.create_user(args)
 ```
 
 #### Logout
-For logout you need to call:
+For logout you need to call (in case of rails app) in your controller:
 ```ruby
-instance_client.logout
-# or
-KindeSdk.logout(access_token)
+redirect_to KindeSdk.logout_url, allow_other_host: true
+```
+Your app should handle logout callback url (which was configured separately).
+After calling redirect to logout_url (if set), Kinde redirect it back to logout callback path, where you need to clear your session:
+```ruby
+  # .......
+  def logout_callback
+    Rails.logger.info("logout callback successfully received")
+    reset_session
+    redirect_to root_path
+  end
+  # ......
 ```
-then clear your session or storage (delete your token) and redirect wherever you want to.
 If you configured logout redirect url correct (e.g. added in the admin panel allowed logout redirect), you can receive 
-a logout callback. Use it if it needs to perform some clean-ups or any other jobs.
+a logout callback. Otherwise Kinde logout message will be shown.
 
 ### Organizations
 #### Create an organization

data/lib/kinde_sdk/client.rb

@@ -30,10 +30,6 @@ module KindeSdk
       get_claim("permissions").include?(permission)
     end
 
-    def logout
-      KindeSdk.logout(bearer_token, kinde_api_client)
-    end
-
     ::KindeApi.constants.filter { |klass| klass.to_s.end_with?("Api") }.each do |klass|
       api_klass = Kernel.const_get("KindeApi::#{klass}")
 

data/lib/kinde_sdk/version.rb

@@ -1,3 +1,3 @@
 module KindeSdk
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/kinde_sdk.rb

@@ -56,13 +56,10 @@ module KindeSdk
       KindeSdk::Client.new(sdk_api_client, bearer_token)
     end
 
-    def logout(bearer_token, sdk_api_client = nil)
-      (sdk_api_client || api_client(bearer_token))
-        .call_api(
-          :get, '/logout',
-          query_params: { 'redirect' => @config.logout_url },
-          header_params: { 'Authorization' => "Bearer #{bearer_token}" }
-        )
+    def logout_url
+      query = @config.logout_url ? URI.encode_www_form(redirect: @config.logout_url) : nil
+      host = URI::parse(@config.domain).host
+      URI::HTTP.build(host: host, path: '/logout', query: query).to_s
     end
 
     def client_credentials_access(
@@ -97,7 +94,7 @@ module KindeSdk
       config = KindeApi::Configuration.default
       config.configure do |c|
         c.access_token = bearer_token
-        c.server_variables = { businessName: @config.business_name || @config.domain.split("//")[1].split(".")[0] }
+        c.server_variables = { businessName: business_name }
         c.host = @config.domain
         c.debugging = @config.debugging
         c.logger = @config.logger
@@ -105,5 +102,13 @@ module KindeSdk
 
       KindeApi::ApiClient.new(config)
     end
+
+    private
+
+    def business_name
+      # from https://example.kinde.com fetches `example`
+      # from https://example-chamois.au.kinde.com fetches `example-chamois.au`
+      @config.business_name || @config.domain.split("//")[1].split(".")[0..-3].join(".")
+    end
   end
 end

data/spec/kinde_sdk_spec.rb

@@ -5,6 +5,7 @@ describe KindeSdk do
   let(:client_id) { "client_id" }
   let(:client_secret) { "client_secret" }
   let(:callback_url) { "http://localhost:3000/callback" }
+  let(:logout_url) { "http://localhost/logout-callback" }
 
   before do
     KindeSdk.configure do |c|
@@ -12,6 +13,7 @@ describe KindeSdk do
       c.client_id = client_id
       c.client_secret = client_secret
       c.callback_url = callback_url
+      c.logout_url = logout_url
     end
   end
 
@@ -23,6 +25,20 @@ describe KindeSdk do
     end
   end
 
+  describe "#logout_url" do
+    it "returns logout url" do
+      expect(described_class.logout_url)
+        .to eq("http://example.com/logout?redirect=http%3A%2F%2Flocalhost%2Flogout-callback")
+    end
+
+    context "when logout url not set" do
+      let(:logout_url) { nil }
+      it "returns logout url without redirect query" do
+        expect(described_class.logout_url).to eq("http://example.com/logout")
+      end
+    end
+  end
+
   describe "#api_client" do
     it "returns initialized api_client instance of KindeApi" do
       expect(described_class.api_client("bearer-token")).to be_instance_of(KindeApi::ApiClient)
@@ -59,16 +75,16 @@ describe KindeSdk do
   describe "client" do
     let(:hash_to_encode) do
       { "aud" => [],
-       "azp" => "19ebb687cd2f405c9f2daf645a8db895",
-       "exp" => 1679600554,
-       "feature_flags" => nil,
-       "iat" => 1679514154,
-       "iss" => "https://qwv2.kinde.com",
-       "jti" => "22c48b2c-da46-4661-a7ff-425c23eceab5",
-       "org_code" => "org_cb4544175bc",
-       "permissions" => ["read:todos", "create:todos"],
-       "scp" => ["openid", "offline"],
-       "sub" => "kp:b17adf719f7d4b87b611d1a88a09fd15" }
+        "azp" => "19ebb687cd2f405c9f2daf645a8db895",
+        "exp" => 1679600554,
+        "feature_flags" => nil,
+        "iat" => 1679514154,
+        "iss" => "https://example.kinde.com",
+        "jti" => "22c48b2c-da46-4661-a7ff-425c23eceab5",
+        "org_code" => "org_cb4544175bc",
+        "permissions" => ["read:todos", "create:todos"],
+        "scp" => ["openid", "offline"],
+        "sub" => "kp:b17adf719f7d4b87b611d1a88a09fd15" }
     end
     let(:token) { JWT.encode(hash_to_encode, nil, "none") }
     let(:client) { described_class.client(token) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinde_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kinde Australia Pty Ltd
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -100,7 +100,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,119 +0,0 @@
-PATH
-  remote: .
-  specs:
-    kinde_sdk (1.0.0)
-      faraday-follow_redirects
-      oauth2 (~> 2.0)
-      pkce_challenge
-      typhoeus (~> 1.0, >= 1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.3)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    byebug (11.1.3)
-    coderay (1.1.3)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.5.0)
-    ethon (0.16.0)
-      ffi (>= 1.15.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-follow_redirects (0.3.0)
-      faraday (>= 1, < 3)
-    faraday-net_http (3.0.2)
-    ffi (1.15.5)
-    hashdiff (1.0.1)
-    hashie (5.0.0)
-    json (2.6.3)
-    jwt (2.7.0)
-    method_source (1.0.0)
-    multi_xml (0.6.0)
-    oauth2 (2.0.9)
-      faraday (>= 0.17.3, < 3.0)
-      jwt (>= 1.0, < 3.0)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 4)
-      snaky_hash (~> 2.0)
-      version_gem (~> 1.1)
-    parallel (1.22.1)
-    parser (3.2.2.0)
-      ast (~> 2.4.1)
-    pkce_challenge (1.0.0)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
-    public_suffix (5.0.1)
-    rack (3.0.7)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.49.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
-      rubocop (~> 1.41)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (2.19.0)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    snaky_hash (2.0.1)
-      hashie
-      version_gem (~> 1.1, >= 1.1.1)
-    typhoeus (1.4.0)
-      ethon (>= 0.9.0)
-    unicode-display_width (2.4.2)
-    version_gem (1.1.2)
-    webmock (3.18.1)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  arm64-darwin-21
-
-DEPENDENCIES
-  kinde_sdk!
-  pry-byebug
-  rake (~> 13.0.1)
-  rspec (~> 3.6, >= 3.6.0)
-  rubocop
-  rubocop-rake
-  rubocop-rspec
-  webmock
-
-BUNDLED WITH
-   2.3.16