learnworlds 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad2a1e8a2ffd31771eaa98ad090a0c5fbc8e05dd25e0b991914f6a04234ca3d5
-  data.tar.gz: d0170a1aebada2099df0c45b26eb5cb4fc85c41bc8238bc98c552f3980762337
+  metadata.gz: c23afd4a12db0a2206b6c516528aef1af8aa0c5d58d04b9a827016a1830148ca
+  data.tar.gz: aa74366632f4ed85f0f3b82bcbacd1012ab2a979df3cab27f6a94933dba2f3a0
 SHA512:
-  metadata.gz: 3c13c5a27d196dfea26d5fcd7755ebae1a3bee336da05661315a6e757c02e62130aaed7cdc44cb84b4e5dc8e42e7156468d8f9fb858e58a98cbe861eb30f56da
-  data.tar.gz: ca6b5c91854da6342ec693430251a575ea5e806b4af851a23f55f5d7e96d0287dc0acf8c84a7f424c3aef7565f1c3fab8cd4902eb6125bde4b7e38e139635aad
+  metadata.gz: cb7fb5be2fe32e95ba31aeaa5557a05599b609f87c269387ad8c94c4a7d1ebe800481f408ac7c9663472c419cf943eaa35d502ef6ef81bf8f7a81885b3a918e4
+  data.tar.gz: b65f875304f0d2d2ff5616e4e3e22855fd88be69a91eda6be4e0ad7e3cdcd754d3f106643b186a72464477108943b382d67fd5fc46e680170db222245d5d22c6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.3] - 2022-08-09
+
+- Add enrollments to user
+
+## [0.2.2] - 2022-08-09
+
+- Add possibility to sso with user id instead of email
+
 ## [0.2.1] - 2022-08-09
 
 - Add attach and detach methods to the user resource
@@ -27,4 +35,3 @@
 - Initial release
   - Adds a basic structure to aid future developments
   - Adds methods to interact with the user resource ( list, create, update, find and enroll )
-  

data/Gemfile.lock

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

data/README.md

@@ -18,7 +18,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ### Authentication with Client Credentials grant
 
-To authenticate with client credentials grant you need to 
+To authenticate with client credentials grant you need to
 
 ```ruby
 client = LearnWorlds::Client.new(
@@ -42,13 +42,13 @@ client = LearnWorlds::Client.new(
 
 you can also save some lines of code if you set the folloing env vars `LEARN_WORLDS_CLIENT_ID`, `LEARN_WORLDS_CLIENT_SECRET`, `LEARN_WORLDS_BASE_URL`
 
-Once that is done, you can initialize the client with 
+Once that is done, you can initialize the client with
 
 ```ruby
 client = LearnWorlds::Client.new
 ```
 
-Everytime you call `authenticate('client_credentials')` a new request will be made to Learn Worlds. 
+Everytime you call `authenticate('client_credentials')` a new request will be made to Learn Worlds.
 If you want to avoid that you can define custom getters and setters for the access token via the configuration.
 
 You can use that to add logic to persist or get the access token on your side and you can also add some logic to verify if the access token is still valid.
@@ -57,7 +57,7 @@ For example:
 
 ```ruby
 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") }
 
@@ -80,6 +80,9 @@ client.user.update(user_id: 'user_id', username: 'updated_username')
 # finds a user
 client.user.find(user_id: 'user_id')
 
+# returns a list of enrollnments for a specific user
+client.user.enrollments(user_id: 'user_id')
+
 # enrolls a user on a course
 client.user.enroll(user_id: 'user_id', product_id: 'course_id', product_type: 'course', price: 0)
 
@@ -97,8 +100,9 @@ client.user.detach_tags(user_id: 'user_id', tags: ['tag1', 'tag2'])
 
 client.sso.redirect(email: 'test@test.com', redirect_to 'xyz.learnworlds.com/courses')
 
-```
+client.sso.redirect_with_id(user_id: 'learnworlds_user_id', redirect_to 'xyz.learnworlds.com/courses')
 
+```
 
 ## Development
 

data/lib/learn_worlds/objects/enrollment_object.rb

@@ -0,0 +1,4 @@
+module LearnWorlds
+  class EnrollmentObject < Object
+  end
+end

data/lib/learn_worlds/resources/single_sign_on_resource.rb

@@ -5,5 +5,9 @@ module LearnWorlds
     def redirect(email:, redirect_to:)
       post_request(SSO_ENDPOINT, { email: email, redirectUrl: redirect_to }).body['url']
     end
+
+    def redirect_with_id(user_id:, redirect_to:)
+      post_request(SSO_ENDPOINT, { user_id: user_id, redirectUrl: redirect_to }).body['url']
+    end
   end
 end

data/lib/learn_worlds/resources/user_resource.rb

@@ -15,6 +15,11 @@ module LearnWorlds
       UserObject.new(get_request("#{ENDPOINT}/#{user_id}").body)
     end
 
+    def enrollments(user_id:)
+      response = get_request("#{ENDPOINT}/#{user_id}/courses")
+      Collection.from_response(response, key: "data", type: EnrollmentObject)
+    end
+
     def update(user_id:, **params)
       put_request("#{ENDPOINT}/#{user_id}", params)
       true

data/lib/learn_worlds/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learnworlds
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Nuno Correia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,6 +46,7 @@ files:
 - lib/learn_worlds/configuration.rb
 - lib/learn_worlds/learn_worlds_error.rb
 - lib/learn_worlds/object.rb
+- lib/learn_worlds/objects/enrollment_object.rb
 - lib/learn_worlds/objects/user_object.rb
 - lib/learn_worlds/resource.rb
 - lib/learn_worlds/resources/authentication_resource.rb