strongmind-platform-sdk 3.1.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a8ff326fbdb603f695f73f4afc25d3e47dcc29d8d2079914252e402fcd93fe9
-  data.tar.gz: 9f1df694615285f266cccf00c3262e1cb83d1b155a9496a94bbee4526633ff4b
+  metadata.gz: 4d3e7692a1585b6660f3127296b51489fe91abe306d673149a089562d05e9637
+  data.tar.gz: 7922d450c254e2dc3dece30d5440f8a56232039327400740198e4fb4d032e645
 SHA512:
-  metadata.gz: a265734af8c965df1bf25051d7bbc9902f0e46d9e395ac6c7a476959aef003bbdb6a2271ad53e8be44de9d675c6488976d884abe2600fda938373c32e33173bb
-  data.tar.gz: 88e4d2fdbddcbdc46e6b49fa6b2195cace72021fff945ef8151eb33ce1c335ca0ce0ddf33d8079c5944ee16d8d914efcf5dbe62304259a15610b9a486bdc1f24
+  metadata.gz: ea6585723a59c9f2731141f41bff045fc43ea18a61a7767e74cb75f3f317e4d800e4088669ebe43d4da7f7707234b8543f7764883187415a1bc59a27ff4db124
+  data.tar.gz: ebabea43dba9197fa0ef7cfec80fa894a004458f25a10b2a41de6ae7234511ec6cc321cb3a67daa42f85286bf9614ff80580abd7a189732ea2af7260287b452e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strongmind-platform-sdk (3.1.5)
+    strongmind-platform-sdk (3.2.0)
       aws-sdk-secretsmanager (~> 1.66)
       devise
       faraday (~> 2.5, >= 2.5.2)
@@ -40,16 +40,16 @@ GEM
     ast (2.4.2)
     attr_required (1.0.1)
     aws-eventstream (1.2.0)
-    aws-partitions (1.834.0)
+    aws-partitions (1.843.0)
     aws-sdk-core (3.185.1)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.651.0)
       aws-sigv4 (~> 1.5)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-secretsmanager (1.83.0)
+    aws-sdk-secretsmanager (1.84.0)
       aws-sdk-core (~> 3, >= 3.184.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.6.0)
+    aws-sigv4 (1.6.1)
       aws-eventstream (~> 1, >= 1.0.2)
     bcrypt (3.1.19)
     bindata (2.4.15)
@@ -57,7 +57,7 @@ GEM
     concurrent-ruby (1.2.2)
     crass (1.0.6)
     date (3.3.3)
-    devise (4.9.2)
+    devise (4.9.3)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
       railties (>= 4.1.0)
@@ -102,9 +102,9 @@ GEM
       net-smtp
     method_source (1.0.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.4)
+    mini_portile2 (2.8.5)
     minitest (5.18.0)
-    net-imap (0.4.1)
+    net-imap (0.4.2)
       date
       net-protocol
     net-pop (0.1.2)
@@ -178,7 +178,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.0)
-    responders (3.1.0)
+    responders (3.1.1)
       actionpack (>= 5.2)
       railties (>= 5.2)
     rexml (3.2.5)
@@ -217,7 +217,7 @@ GEM
       attr_required (>= 0.0.5)
       faraday (~> 2.0)
       faraday-follow_redirects
-    thor (1.2.2)
+    thor (1.3.0)
     timeout (0.4.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)

data/README.md

@@ -11,7 +11,7 @@ First [configure your GitHub credentials](#configure-github-credentials)
 Install the gem and add to the application's Gemfile by executing:
 
 ```
-gem "strongmind-platform-sdk", "~> 3.1.4"
+gem "strongmind-platform-sdk", "~> 3.2.0"
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
@@ -110,3 +110,6 @@ Create PowerSchool Client:
 
 Create IdMapper Client:
 `id_mapper_client = PlatformSdk::IdMapper::Client.new(domain: 'ID_MAPPER_DOMAIN', token: 'SECRET_TOKEN')`
+
+Create Pencil Spaces Client:
+`pencil_spaces_client = PlatformSdk::PencilSpaces::Client.new('BASE_URL', 'BEARER_TOKEN')`

data/lib/platform_sdk/pencil_spaces/client.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module PencilSpaces
+    # OneRoster Client which wraps the swagger generated OneRoster Management APIs
+    class Client
+      attr_reader :access_token, :base_url, :conn
+
+      # The API only supports these roles for API managed users
+      VALID_API_USER_ROLES = %i[Teacher Student].freeze
+      # The API only supports these roles for users in a space
+      VALID_SPACE_ROLES = %i[host participant].freeze
+      DEFAULT_VISIBILITY = "private"
+
+      def initialize(base_url, access_token, conn: nil)
+        @access_token = access_token
+        @base_url = base_url
+        @conn = conn || build_connection
+      end
+
+      # Get a list of Spaces accessible by the account associated with your API key
+      # @param [Hash] opts the optional parameters
+      # @option opts [Integer] :page_number **(Optional)** - The page number of the items to return. The number of items in a page is controlled by the `pageSize` parameter.
+      # @option opts [Integer] :page_size **(Optional)** - The max number of items to return. Setting a larger `pageSize` may result in a longer querying times
+      # @option opts [String] :filters **(Optional)** - A base64 encoded string of the filters you wish to apply to the query. See `spacesFilterSchema` for details on all the filters applicable to your query
+      # @return [JSON]
+      def spaces(opts = {})
+        # query parameters
+        query_params = opts[:query_params] || {}
+        query_params[:pageNumber] = opts[:page_number] unless opts[:page_number].nil?
+        query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
+        query_params[:filters] = opts[:filters] unless opts[:filters].nil?
+
+        response = get("/spaces", query_params)
+        response.body
+      end
+
+      # Get details for a particular Space
+      # @param [String] space_id
+      # @return [JSON] The space object for the requested space_id
+      def space(space_id)
+        resource_path = "/spaces/#{space_id}"
+        response = get(resource_path)
+        response.body
+      end
+
+      # Create a new Space
+      # @param [String] title
+      # @param [Array<PlatformSdk::PencilSpaces::Models::UserWithRole>] hosts **(Optional)** Role is not required
+      # @param [Array<PlatformSdk::PencilSpaces::Models::UserWithRole>] participants **(Optional)** Role is not required
+      # @param [String] visibility **(Optional)** Default is "private"
+      # @return [JSON] The newly created space
+      def create_space(title, hosts: [], participants: [], visibility: DEFAULT_VISIBILITY)
+        body = {
+          title:,
+          visibility:,
+          hosts: hosts.map(&:as_json),
+          participants: participants.map(&:as_json),
+          notifyInvitees: false
+        }
+        response = post("/spaces/create", body.to_json)
+        response.body
+      end
+
+      # Get a list of Users accessible by the account associated with your API key
+      # @param [Hash] opts the optional parameters
+      # @option opts [Integer] :page_number **(Optional)** - The page number of the items to return. The number of items in a page is controlled by the &#x60;pageSize&#x60; parameter.
+      # @option opts [Integer] :page_size **(Optional)** - The max number of items to return. Setting a larger &#x60;pageSize&#x60; may result in a longer querying times
+      # @option opts [String] :filters **(Optional)** - A base64 encoded string of the filters you wish to apply to the query. See &#x60;spacesFilterSchema&#x60; for details on all the filters applicable to your query
+      # @return [JSON] A list of Pencil Spaces users
+      def users(opts = {})
+        # query parameters
+        query_params = opts[:query_params] || {}
+        query_params[:pageNumber] = opts[:page_number] unless opts[:page_number].nil?
+        query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
+        query_params[:filters] = opts[:filters] unless opts[:filters].nil?
+
+        response = get("/users", query_params)
+        response.body
+      end
+
+      # Get details for a particular User
+      # @param [String] user_id
+      # @return [JSON] The user object for the requested user_id
+      def user(user_id)
+        response = get("/users/#{user_id}")
+        response.body
+      end
+
+      # Create a login link for a user
+      # @param [String] user_id
+      # @param [String] redirect_url **(Optional)** The URL to redirect the user to after they login
+      # @return [JSON] JSON with a login link for the user, i.e. { "url" => "https://pencilspaces.com/login?token=123" }
+      def authorize_user(user_id, redirect_url: nil)
+        raise ArgumentError, "user_id must have a value" if user_id.nil?
+
+        query_params = {}
+        query_params[:redirectUrl] = redirect_url unless redirect_url.nil?
+        response = get("/users/#{user_id}/authorize", query_params)
+        response.body
+      end
+
+      def create_api_user(name, role)
+        validate_api_user_role!(role)
+        body = { name:, userRole: role }
+        response = @conn.post("/users/createAPIUser", body.to_json)
+        response.body
+      end
+
+      # Update users in a space
+      # @param [String] space_id
+      # @param [Array<PlatformSdk::PencilSpaces::Models::UserWithRole>] users_to_add **(Optional)** Role is required
+      # @param [Array<PlatformSdk::PencilSpaces::Models::UserWithRole>] users_to_modify **(Optional)** Role is required
+      # @param [Array<PlatformSdk::PencilSpaces::Models::UserWithRole>] users_to_remove **(Optional)**
+      # @return [JSON] The updated space
+      def update_users_in_space(space_id, users_to_add: [], users_to_modify: [], users_to_remove: [])
+        validate_update_users_in_space_args!(space_id, users_to_add, users_to_modify, users_to_remove)
+
+        body = {
+          notifyInvitees: false,
+          addUsers: users_to_add.map(&:as_json),
+          modifyUsers: users_to_modify.map(&:as_json),
+          removeUsers: users_to_remove.map(&:as_json)
+        }
+
+        response = patch("/spaces/#{space_id}/updateUsers", body.to_json)
+        response.body
+      end
+
+      private
+
+      def build_connection
+        Faraday.new(@base_url) do |faraday|
+          faraday.headers = default_headers
+          faraday.adapter Faraday.default_adapter
+          faraday.response :json, content_type: /\bjson$/, parser_options: { symbolize_names: true }
+          faraday.response :raise_error
+        end
+      end
+
+      def default_headers
+        {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{access_token}"
+        }
+      end
+
+      def get(path, params = {})
+        @conn.get(path, params)
+      end
+
+      def post(path, body)
+        @conn.post(path, body)
+      end
+
+      def patch(path, body)
+        @conn.patch(path, body)
+      end
+
+      def validate_update_users_in_space_args!(space_id, users_to_add, users_to_modify, users_to_remove)
+        raise ArgumentError, "space_id must have a value" if space_id.nil?
+
+        if [users_to_add, users_to_modify, users_to_remove].all?(&:empty?)
+          raise ArgumentError, "Must provide at least one of users_to_add, users_to_modify, users_to_remove"
+        end
+
+        needs_role = users_to_add + users_to_modify
+        needs_role.each do |user|
+          if user.class != PlatformSdk::PencilSpaces::Models::UserWithRole
+            raise ArgumentError, "users_to_add/users_to_modify must be an array of UserWithRole objects"
+          end
+
+          raise ArgumentError, "users_to_add and users_to_modify objects must have a role" if user.role.nil?
+        end
+
+        users_to_remove.each do |user|
+          if user.class != PlatformSdk::PencilSpaces::Models::UserWithRole
+            raise ArgumentError, "users_to_remove must be an array of UserWithRole objects (role not required)"
+          end
+        end
+      end
+
+      def validate_api_user_role!(role)
+        return if VALID_API_USER_ROLES.include?(role)
+
+        raise ArgumentError, "Invalid role: #{role}, must be one of #{VALID_API_USER_ROLES}"
+      end
+    end
+  end
+end

data/lib/platform_sdk/pencil_spaces/constants.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module PencilSpaces
+    module Constants
+      TEACHER_ROLE = :Teacher
+      STUDENT_ROLE = :Student
+      ADMIN_ROLE = :InstitutionAdmin
+      SPACE_HOST_ROLE = :host
+      SPACE_PARTICIPANT_ROLE = :participant
+    end
+  end
+end

data/lib/platform_sdk/pencil_spaces/models/user_with_role.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module PencilSpaces
+    module Models
+      class UserWithRole
+        attr_accessor :role, :user_id
+
+        VALID_ROLES = %i[host participant].freeze
+
+        def initialize(user_id, user_role_in_space = nil)
+          @user_id = user_id
+          return unless user_role_in_space
+
+          validate_role!(user_role_in_space)
+          @role = user_role_in_space
+        end
+
+        def as_json
+          json = {}
+          instance_variables.each do |var|
+            key = var.to_s.delete("@")
+            key = "userId" if key == "user_id"
+            json[key] = instance_variable_get(var).to_s if instance_variable_get(var)
+          end
+          json
+        end
+
+        private
+
+        def validate_role!(role)
+          return if VALID_ROLES.include?(role)
+
+          raise ArgumentError, "Invalid role: #{role}, must be one of #{VALID_ROLES}"
+        end
+      end
+    end
+  end
+end

data/lib/platform_sdk/pencil_spaces/models.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "platform_sdk/pencil_spaces/models/user_with_role"
+
+module PlatformSdk
+  module PencilSpaces
+    module Models
+    end
+  end
+end

data/lib/platform_sdk/pencil_spaces.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "platform_sdk/pencil_spaces/client"
+require "platform_sdk/pencil_spaces/constants"
+require "platform_sdk/pencil_spaces/models"
+
+
+module PlatformSdk
+  module PencilSpaces
+    class Error < StandardError; end
+  end
+end

data/lib/platform_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlatformSdk
-  VERSION = "3.1.5"
+  VERSION = "3.2.0"
 end

data/lib/platform_sdk.rb

@@ -8,6 +8,7 @@ require "platform_sdk/aws"
 require "platform_sdk/id_mapper"
 require "platform_sdk/edkey"
 require "platform_sdk/data_pipeline"
+require "platform_sdk/pencil_spaces"
 
 module PlatformSdk
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-platform-sdk
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.0
 platform: ruby
 authors:
 - Platform Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -199,6 +199,11 @@ files:
 - lib/platform_sdk/identity/clients.rb
 - lib/platform_sdk/one_roster.rb
 - lib/platform_sdk/one_roster/client.rb
+- lib/platform_sdk/pencil_spaces.rb
+- lib/platform_sdk/pencil_spaces/client.rb
+- lib/platform_sdk/pencil_spaces/constants.rb
+- lib/platform_sdk/pencil_spaces/models.rb
+- lib/platform_sdk/pencil_spaces/models/user_with_role.rb
 - lib/platform_sdk/power_school.rb
 - lib/platform_sdk/power_school/client.rb
 - lib/platform_sdk/power_school/special_program.rb