learnworlds 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 326b7da781aae52fef008a7b6c28e38ac7df6bd5f7d3e7aaa63a2f49736e3422
-  data.tar.gz: 0d9967da29d5c941b8470d3d0baf4e2c3d6ed287314cd0faaa02afcd6113b795
+  metadata.gz: bc096fa0ea3dfb07f2c9449360cb7053702bc3b85858464915b8acd644fb16e1
+  data.tar.gz: 192238d15c821879e34516748b82fa76dc03cb276b40a91ab98abc49e647cff5
 SHA512:
-  metadata.gz: d4136813e98e0ab31e54a4abe278f66d6cc63c0eb887913be7cd2948589d4ae740bcc9091d149e49ee945f6655323de3a4560e1f45c1e326a342d7a3d43dc932
-  data.tar.gz: af249f49f09b4c2d7d1dc476f9bc0dee42c55a795e6cac0ff0a5f8833106bdeb03c8f81ae5c15cdfe5c8ae8a24bd4d0b52ee87d28fdbdf5d6568796a7e0262f4
+  metadata.gz: f607da52aa8f1f5c5bb29993770ec61f3f8abcd7b1518508a58354999d0a8e74f3189624403855a715584a07aec0254dedb28e31bfb0982f24fef6d6d68856ec
+  data.tar.gz: 6b090dabfab1cd717a7c6f6dfbbc292ef627480f30027b365fc39cbedac9d3df864ebc74e68a4cc4ba149effec228e331cb0156b1cff4a968f674d2cb3668bc9

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 ## [Unreleased]
 
-## [0.1.1] - 2022-06-29
+## [0.2.0] - 2022-07-11
+
+- Adds single sign on fucntionality
+- Default client secret to nil if not passed and not on env vars
+
+## [0.1.3] - 2022-07-08
+
+- Rename User to UserObject in order to avoid conflicts (breaking change)
+
+## [0.1.2] - 2022-07-06
+
+- Fix bug. Env var for client id was with double quotes
+- Documentation updated
+
+## [0.1.1] - 2022-07-06
 
 - Add expires_in as parameter to persist_access_token_method
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    learnworlds (0.1.1)
+    learnworlds (0.2.0)
       faraday (~> 2.3)
 
 GEM

data/README.md

@@ -61,7 +61,7 @@ LearnWorlds.configure do |config|
   # return nil if access_token is invalid and you want to proceed with the authentication process
   config.retrieve_access_token_method =  ->() { Rails.cache.fetch("learnworlds_access_token") }
 
-  config.persist_access_token_method =  ->(access_token) { Rails.cache.write('learnworlds_access_token', access_token) } }
+  config.persist_access_token_method =  ->(access_token, expires_in) { Rails.cache.write('learnworlds_access_token', access_token) } }
 end
 ```
 
@@ -84,6 +84,14 @@ client.user.find(user_id: 'user_id')
 client.user.enroll(user_id: 'user_id', product_id: 'course_id', product_type: 'course', price: 0)
 ```
 
+### SSO Resource
+
+```ruby
+
+client.sso.redirect(email: 'test@test.com', redirect_to 'xyz.learnworlds.com/courses')
+
+```
+
 
 ## Development
 

data/lib/learn_worlds/client.rb

@@ -9,8 +9,8 @@ module LearnWorlds
     attr_accessor :access_token, :expires_in
 
     def initialize(client_id: nil, client_secret: nil, base_url: nil, access_token: nil)
-      @client_id = client_id || ENV.fetch('"LEARN_WORLDS_CLIENT_ID"')
-      @client_secret = client_secret || ENV.fetch('LEARN_WORLDS_CLIENT_SECRET')
+      @client_id = client_id || ENV.fetch('LEARN_WORLDS_CLIENT_ID')
+      @client_secret = client_secret || ENV.fetch('LEARN_WORLDS_CLIENT_SECRET', nil)
       @base_url = base_url || ENV.fetch('LEARN_WORLDS_BASE_URL')
       @access_token = access_token
     end
@@ -23,6 +23,10 @@ module LearnWorlds
       AuthenticationResource.new(self)
     end
 
+    def sso
+      SingleSignOnResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(base_url) do |conn|
         conn.request :json

data/lib/learn_worlds/objects/{user.rb → user_object.rb}

@@ -1,4 +1,4 @@
 module LearnWorlds
-  class User < Object
+  class UserObject < Object
   end
 end

data/lib/learn_worlds/resources/single_sign_on_resource.rb

@@ -0,0 +1,9 @@
+module LearnWorlds
+  class SingleSignOnResource < Resource
+    SSO_ENDPOINT = "/admin/api/sso".freeze
+
+    def redirect(email:, redirect_to:)
+      post_request(SSO_ENDPOINT, { email: email, redirectUrl: redirect_to }).body['url']
+    end
+  end
+end

data/lib/learn_worlds/resources/user_resource.rb

@@ -4,15 +4,15 @@ module LearnWorlds
 
     def list(**params)
       response = get_request(ENDPOINT, params)
-      Collection.from_response(response, key: "data", type: User)
+      Collection.from_response(response, key: "data", type: UserObject)
     end
 
     def create(**attributes)
-      User.new(post_request(ENDPOINT, attributes).body)
+      UserObject.new(post_request(ENDPOINT, attributes).body)
     end
 
     def find(user_id:)
-      User.new(get_request("#{ENDPOINT}/#{user_id}").body)
+      UserObject.new(get_request("#{ENDPOINT}/#{user_id}").body)
     end
 
     def update(user_id:, **params)

data/lib/learn_worlds/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LearnWorlds
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/learn_worlds.rb

@@ -9,11 +9,12 @@ module LearnWorlds
   autoload :Collection, "learn_worlds/collection"
   autoload :Configuration, "learn_worlds/configuration"
 
-  autoload :User, "learn_worlds/objects/user"
+  autoload :UserObject, "learn_worlds/objects/user_object"
 
   autoload :Resource, "learn_worlds/resource"
-  autoload :UserResource, "learn_worlds/resources/user_resource"
   autoload :AuthenticationResource, "learn_worlds/resources/authentication_resource"
+  autoload :SingleSignOnResource, "learn_worlds/resources/single_sign_on_resource"
+  autoload :UserResource, "learn_worlds/resources/user_resource"
 
   class << self
     # Instantiate the Configuration singleton

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learnworlds
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nuno Correia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,9 +46,10 @@ files:
 - lib/learn_worlds/configuration.rb
 - lib/learn_worlds/learn_worlds_error.rb
 - lib/learn_worlds/object.rb
-- lib/learn_worlds/objects/user.rb
+- lib/learn_worlds/objects/user_object.rb
 - lib/learn_worlds/resource.rb
 - lib/learn_worlds/resources/authentication_resource.rb
+- lib/learn_worlds/resources/single_sign_on_resource.rb
 - lib/learn_worlds/resources/user_resource.rb
 - lib/learn_worlds/version.rb
 - sig/learnworlds.rbs