strongmind-platform-sdk 3.6.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a5924d25efa3fb9a024f928a2147f7daeab883b9b949dc53c7d6fcc2719bc84
-  data.tar.gz: 547168e174f5fbe3298de82ef484785cd78a54b357f5a33ad0edd331efd1b075
+  metadata.gz: bc46ddfccbb20bdc43565c3a8f01ba6ed556ba61d46e9b755e009337e23e8757
+  data.tar.gz: 31bd81a67bee5b00b5f03e8291247af9701ae81e77eef1413e99f848a4b33f01
 SHA512:
-  metadata.gz: 05df864319e1353e68574592db3c34cce5ac856e1e855babc402512a192fa1094eb8be962bc40f81adb760e215953280f99bed2ddbca436e95848c9e83727e84
-  data.tar.gz: 7bca6c93b9fcac1bc840c4ffe9199bbb39cc11267463893a1b53c57665be5fbdf058bb1b7efb82216dbfa7f08be3e4dae2bffbd76273173c6b8cb82c96df0e85
+  metadata.gz: 37c9aa69cf40748ba2fae0c270a1cbab5c4b14a37d63f7874b58f807b31ae8253d39991b9ff872bf0c10016a5d364437eb39d3a11895a772988e0f4817db1c7d
+  data.tar.gz: 340e835dba38cde94dba51aff3441cad9390f71487559c4848f5cc8a7a9db97b623ad928b1cd2cffd849556c872e5c21a869fa9f23f9dc80eb01f3674ff7e991

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strongmind-platform-sdk (3.6.1)
+    strongmind-platform-sdk (3.7.0)
       aws-sdk-secretsmanager (~> 1.66)
       devise
       faraday (~> 2.5, >= 2.5.2)
@@ -38,20 +38,21 @@ GEM
       tzinfo (~> 2.0)
     aes_key_wrap (1.1.0)
     ast (2.4.2)
-    attr_required (1.0.1)
-    aws-eventstream (1.2.0)
-    aws-partitions (1.847.0)
-    aws-sdk-core (3.186.0)
-      aws-eventstream (~> 1, >= 1.0.2)
+    attr_required (1.0.2)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.876.0)
+    aws-sdk-core (3.190.1)
+      aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.651.0)
-      aws-sigv4 (~> 1.5)
+      aws-sigv4 (~> 1.8)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-secretsmanager (1.84.0)
-      aws-sdk-core (~> 3, >= 3.184.0)
+    aws-sdk-secretsmanager (1.88.0)
+      aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.6.1)
+    aws-sigv4 (1.8.0)
       aws-eventstream (~> 1, >= 1.0.2)
-    bcrypt (3.1.19)
+    base64 (0.2.0)
+    bcrypt (3.1.20)
     bindata (2.4.15)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
@@ -64,6 +65,8 @@ GEM
       responders
       warden (~> 1.2.3)
     diff-lcs (1.5.0)
+    email_validator (2.2.4)
+      activemodel
     erubi (1.12.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
@@ -85,14 +88,15 @@ GEM
       concurrent-ruby (~> 1.0)
     jmespath (1.6.2)
     json (2.6.3)
-    json-jwt (1.16.3)
+    json-jwt (1.16.5)
       activesupport (>= 4.2)
       aes_key_wrap
+      base64
       bindata
       faraday (~> 2.0)
       faraday-follow_redirects
     jwt (1.5.6)
-    loofah (2.21.4)
+    loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.8.1)
@@ -104,7 +108,7 @@ GEM
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
     minitest (5.18.0)
-    net-imap (0.4.4)
+    net-imap (0.4.9)
       date
       net-protocol
     net-pop (0.1.2)
@@ -113,10 +117,14 @@ GEM
       timeout
     net-smtp (0.4.0)
       net-protocol
-    nokogiri (1.15.4)
+    nokogiri (1.16.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    omniauth (2.1.1)
+    nokogiri (1.16.0-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.0-x86_64-linux)
+      racc (~> 1.4)
+    omniauth (2.1.2)
       hashie (>= 3.4.6)
       rack (>= 2.2.3)
       rack-protection
@@ -126,34 +134,35 @@ GEM
     omniauth_openid_connect (0.7.1)
       omniauth (>= 1.9, < 3)
       openid_connect (~> 2.2)
-    openid_connect (2.2.0)
+    openid_connect (2.3.0)
       activemodel
       attr_required (>= 1.0.0)
+      email_validator
       faraday (~> 2.0)
       faraday-follow_redirects
       json-jwt (>= 1.16)
-      net-smtp
+      mail
       rack-oauth2 (~> 2.2)
       swd (~> 2.0)
       tzinfo
-      validate_email
       validate_url
       webfinger (~> 2.0)
     orm_adapter (0.5.0)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
-    public_suffix (5.0.3)
+    public_suffix (5.0.4)
     racc (1.7.3)
     rack (2.2.8)
-    rack-oauth2 (2.2.0)
+    rack-oauth2 (2.2.1)
       activesupport
       attr_required
       faraday (~> 2.0)
       faraday-follow_redirects
       json-jwt (>= 1.11.0)
       rack (>= 2.1.0)
-    rack-protection (3.1.0)
+    rack-protection (3.2.0)
+      base64 (>= 0.1.0)
       rack (~> 2.2, >= 2.2.4)
     rack-test (2.1.0)
       rack (>= 1.3)
@@ -208,7 +217,7 @@ GEM
     strongmind-oneroster-client (2.0.3)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
-    swd (2.0.2)
+    swd (2.0.3)
       activesupport (>= 3)
       attr_required (>= 0.0.5)
       faraday (~> 2.0)
@@ -221,15 +230,12 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
     uri (0.13.0)
-    validate_email (0.1.6)
-      activemodel (>= 3.0)
-      mail (>= 2.2.5)
     validate_url (1.0.15)
       activemodel (>= 3.0.0)
       public_suffix
     warden (1.2.9)
       rack (>= 2.0.9)
-    webfinger (2.1.2)
+    webfinger (2.1.3)
       activesupport
       faraday (~> 2.0)
       faraday-follow_redirects

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.2.0"
+gem "strongmind-platform-sdk", "~> 3.7.0"
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:

data/lib/platform_sdk/edfi/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module Edfi
+    # IdMapper::Client
+    class Client
+      attr_reader :token, :domain, :conn
+
+      def initialize(base_url, auth_client)
+        @base_url ||= base_url
+        @auth_client = auth_client
+
+        @conn = Faraday.new(@base_url) do |faraday|
+          faraday.headers = headers
+          faraday.adapter Faraday.default_adapter
+          faraday.response :json, content_type: /\bjson$/
+          faraday.response :raise_error
+        end
+      end
+
+      def get_student_programs(uid)
+        response = @conn.get("/ed-fi/v5.1.0/api/data/v3/ed-fi/studentProgramAssociations?studentUniqueId=#{uid}")
+        response.body
+      end
+
+      private
+
+      def headers
+        {
+          "Authorization" => "Bearer #{@auth_client.auth_token}",
+          "Content-Type" => "application/json",
+          "Accept" => "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/platform_sdk/edfi.rb

@@ -0,0 +1,13 @@
+require "faraday"
+require "faraday/net_http"
+require "faraday/retry"
+
+require "platform_sdk/edfi/client"
+
+module PlatformSdk
+  module Edfi
+    class Error < StandardError; end
+
+
+  end
+end

data/lib/platform_sdk/pencil_spaces/client.rb

@@ -141,13 +141,30 @@ module PlatformSdk
         response.body
       end
 
-      def analytics_sessions(session_id)
+      def analytics_session(session_id)
         raise ArgumentError, "session_id must have a value" if session_id.nil?
 
         response = get("/analytics/sessions/#{session_id}")
         response.body
       end
 
+      # Get a list of Session Analytics 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 `sessionsFilterSchema` for details on all the filters applicable to your query
+      # @return [JSON] A list of Pencil Spaces users
+      def analytics_sessions(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] = Base64.strict_encode64(opts[:filters].to_json) unless opts[:filters].nil?
+
+        response = get("/analytics/sessions", query_params)
+        response.body
+      end
+
       private
 
       def build_connection

data/lib/platform_sdk/version.rb

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

data/lib/platform_sdk.rb

@@ -9,6 +9,7 @@ require "platform_sdk/id_mapper"
 require "platform_sdk/edkey"
 require "platform_sdk/data_pipeline"
 require "platform_sdk/pencil_spaces"
+require "platform_sdk/edfi"
 
 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.6.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Platform Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -188,6 +188,8 @@ files:
 - lib/platform_sdk/aws/secrets_manager_client.rb
 - lib/platform_sdk/data_pipeline.rb
 - lib/platform_sdk/data_pipeline/data_pipeline_client.rb
+- lib/platform_sdk/edfi.rb
+- lib/platform_sdk/edfi/client.rb
 - lib/platform_sdk/edkey.rb
 - lib/platform_sdk/edkey/client.rb
 - lib/platform_sdk/id_mapper.rb