learnworlds 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e7ca973754e0870e699b5e871fc215b1a8c3a2c14151740ac7d4487c6f2979d
-  data.tar.gz: f916575b2f0d23fdae3ae7bb8bac79a78d4841dafc89595dd36c44e91f580417
+  metadata.gz: ad2a1e8a2ffd31771eaa98ad090a0c5fbc8e05dd25e0b991914f6a04234ca3d5
+  data.tar.gz: d0170a1aebada2099df0c45b26eb5cb4fc85c41bc8238bc98c552f3980762337
 SHA512:
-  metadata.gz: 70163dadb335f7bb27438f3c2c9c96e66903bf0082944196cfd1b5be4479596dc14e0c250495f1bf05b658a5dc03ea7c7b57dffce98140093fb7bfb4f418ab28
-  data.tar.gz: cdef31edef774d50c4e8198bd8140ca25d92008150b9fec0c7e79739bc617d511ff1e72ade575cd4933455c02e956fedd8d5fde44304aaf9be0a9527ec0cc3c6
+  metadata.gz: 3c13c5a27d196dfea26d5fcd7755ebae1a3bee336da05661315a6e757c02e62130aaed7cdc44cb84b4e5dc8e42e7156468d8f9fb858e58a98cbe861eb30f56da
+  data.tar.gz: ca6b5c91854da6342ec693430251a575ea5e806b4af851a23f55f5d7e96d0287dc0acf8c84a7f424c3aef7565f1c3fab8cd4902eb6125bde4b7e38e139635aad

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.2.1] - 2022-08-09
+
+- Add attach and detach methods to the user resource
+
+## [0.2.0] - 2022-07-11
+
+- Adds single sign on functionality
+- 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

data/Gemfile.lock

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

data/README.md

@@ -82,6 +82,21 @@ client.user.find(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)
+
+# attaches tags to an user
+client.user.attach_tags(user_id: 'user_id', tags: ['tag1', 'tag2'])
+
+# detaches tags from an user
+client.user.detach_tags(user_id: 'user_id', tags: ['tag1', 'tag2'])
+
+```
+
+### SSO Resource
+
+```ruby
+
+client.sso.redirect(email: 'test@test.com', redirect_to 'xyz.learnworlds.com/courses')
+
 ```
 
 

data/lib/learn_worlds/client.rb

@@ -10,7 +10,7 @@ module LearnWorlds
 
     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_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)
@@ -24,5 +24,15 @@ module LearnWorlds
       post_request("#{ENDPOINT}/#{user_id}/enrollment", attributes)
       true
     end
+
+    def attach_tags(user_id:, tags:)
+      put_request("#{ENDPOINT}/#{user_id}/tags", tags: tags, action: 'attach')
+      true
+    end
+
+    def detach_tags(user_id:, tags:)
+      put_request("#{ENDPOINT}/#{user_id}/tags", tags: tags, action: 'detach')
+      true
+    end
   end
 end

data/lib/learn_worlds/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LearnWorlds
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 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.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Nuno Correia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-08-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