lti_core 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d7b5e0bfe0abe041af70b805722445bd4a2b6696dd273cd8f5d056e46ac8217
-  data.tar.gz: 41e0272f8627bf63e600e34081c5150f785af31e08b72b4a0cd6bb714af70841
+  metadata.gz: fb26452e3534969b461e4fe328535e0bfb4cc52b2e87732b5b029811714a451c
+  data.tar.gz: 54ab80b33778e77fd6896706be90d0850aabfb79cd73647a55905fb7ce4e3e6c
 SHA512:
-  metadata.gz: f6f176376a1a3855a843206b9ff8c3d4e4362894e4ca8afa8e6b12b900555c04efdfa7e80700808580eafd3dc12f539573cd504c0411a2ed34e488d6dcf35de2
-  data.tar.gz: 13b753467b51927f412089f685e76374390fc17dd0de399759cea3b064539e5894d493293dd96f04c97efac6abc6d25700e21ff495dfb9c9e2e2a5976dc1c340
+  metadata.gz: b213acaed305a03517b1c623d4306512b897fef2870b7faa26927128645fdb219ce2f7ab69e7746b59694c6210ab88b8e3b8bf88a672536c5f9879cdd1778d85
+  data.tar.gz: 4512a863dc517abea0c769f2da3e58a781e20a473c2f0f470ecac27c3221098ec3e61689b7278bcff05293e1cf3e9a472ce1ccd89910e6b09aebd742360a49fb

data/.rubocop.yml

@@ -9,6 +9,15 @@ AllCops:
 Gemspec/DevelopmentDependencies:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/lib/lti_core/context.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module LtiCore
+  class Context < Shale::Mapper
+    attribute :id, Shale::Type::String
+    attribute :label, Shale::Type::String
+    attribute :title, Shale::Type::String
+    attribute :type, Shale::Type::String, collection: true
+
+    json do
+      map "id", to: :id, schema: { required: true }
+      map "label", to: :label
+      map "title", to: :title
+      map "type", to: :type
+    end
+  end
+end

data/lib/lti_core/custom.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "shale"
+module LtiCore
+  class Custom < Shale::Mapper
+    # This class can have any attributes you want to extract from the custom field
+    # in the LTI launch request. The attributes should be defined as Shale::Type::String
+    # I need to write code to dynamically extract the custom attributes from the custom field
+  end
+end

data/lib/lti_core/launch_presentation.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module LtiCore
+  class LaunchPresentation < Shale::Mapper
+    attribute :document_target, Shale::Type::String
+    attribute :height, Shale::Type::Integer
+    attribute :width, Shale::Type::Integer
+    attribute :return_url, Shale::Type::String
+
+    json do
+      map "document_target", to: :document_target
+      map "height", to: :height
+      map "width", to: :width
+      map "return_url", to: :return_url
+    end
+  end
+end

data/lib/lti_core/lis.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "shale"
+module LtiCore
+  class Lis < Shale::Mapper
+    attribute :person_sourcedid, Shale::Type::String
+    attribute :course_offering_sourcedid, Shale::Type::String
+    attribute :course_section_sourcedid, Shale::Type::String
+
+    json do
+      map "person_sourcedid", to: :person_sourcedid
+      map "course_offering_sourcedid", to: :course_offering_sourcedid
+      map "course_section_sourcedid", to: :course_section_sourcedid
+    end
+  end
+end

data/lib/lti_core/lti_resource_link_request.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "shale"
+
+require_relative "context"
+require_relative "custom"
+require_relative "launch_presentation"
+require_relative "lis"
+require_relative "resource_link"
+require_relative "tool_platform"
+
+module LtiCore
+  class LtiResourceLinkRequest < Shale::Mapper
+    # The link request can also have vendor specific claims. They must have a key
+    # that is a fully resolved URL. The value can be any JSON value.
+    # I need to write code to dynamically extract the vendor specific claims
+
+    attribute :iss, Shale::Type::String
+    attribute :sub, Shale::Type::String
+    attribute :aud, Shale::Type::String, collection: true
+    attribute :exp, Shale::Type::Integer
+    attribute :iat, Shale::Type::Integer
+    attribute :azp, Shale::Type::String
+    attribute :nonce, Shale::Type::String
+    attribute :name, Shale::Type::String
+    attribute :given_name, Shale::Type::String
+    attribute :family_name, Shale::Type::String
+    attribute :middle_name, Shale::Type::String
+    attribute :picture, Shale::Type::String
+    attribute :email, Shale::Type::String
+    attribute :locale, Shale::Type::String
+    attribute :deployment_id, Shale::Type::String
+    attribute :message_type, Shale::Type::String
+    attribute :version, Shale::Type::String
+    attribute :roles, Shale::Type::String, collection: true
+    attribute :role_scope_mentor, Shale::Type::String, collection: true
+    attribute :context, LtiCore::Context
+    attribute :resource_link, LtiCore::ResourceLink
+    attribute :tool_platform, LtiCore::ToolPlatform
+    attribute :target_link_uri, Shale::Type::String
+    attribute :launch_presentation, LtiCore::LaunchPresentation
+    attribute :custom, LtiCore::Custom
+    attribute :lis, LtiCore::Lis
+
+    json do
+      map "iss", to: :iss
+      map "sub", to: :sub
+      map "aud", to: :aud
+      map "exp", to: :exp
+      map "iat", to: :iat
+      map "azp", to: :azp
+      map "nonce", to: :nonce
+      map "name", to: :name
+      map "given_name", to: :given_name
+      map "family_name", to: :family_name
+      map "middle_name", to: :middle_name
+      map "picture", to: :picture
+      map "email", to: :email
+      map "locale", to: :locale
+      map "https://purl.imsglobal.org/spec/lti/claim/deployment_id", to: :deployment_id, schema: { required: true }
+      map "https://purl.imsglobal.org/spec/lti/claim/message_type", to: :message_type, schema: { required: true }
+      map "https://purl.imsglobal.org/spec/lti/claim/version", to: :version, schema: { required: true }
+      map "https://purl.imsglobal.org/spec/lti/claim/roles", to: :roles, schema: { required: true }
+      map "https://purl.imsglobal.org/spec/lti/claim/role_scope_mentor", to: :role_scope_mentor
+      map "https://purl.imsglobal.org/spec/lti/claim/context", to: :context
+      map "https://purl.imsglobal.org/spec/lti/claim/resource_link", to: :resource_link, schema: { required: true }
+      map "https://purl.imsglobal.org/spec/lti/claim/tool_platform", to: :tool_platform
+      map "https://purl.imsglobal.org/spec/lti/claim/target_link_uri", to: :target_link_uri, schema: { required: true }
+      map "https://purl.imsglobal.org/spec/lti/claim/launch_presentation", to: :launch_presentation
+      map "https://purl.imsglobal.org/spec/lti/claim/custom", to: :custom
+      map "https://purl.imsglobal.org/spec/lti/claim/lis", to: :lis
+    end
+  end
+end

data/lib/lti_core/resource_link.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module LtiCore
+  class ResourceLink < Shale::Mapper
+    attribute :id, Shale::Type::String
+    attribute :description, Shale::Type::String
+    attribute :title, Shale::Type::String
+
+    json do
+      map "id", to: :id, schema: { required: true }
+      map "description", to: :description
+      map "title", to: :title
+    end
+  end
+end

data/lib/lti_core/tool_platform.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module LtiCore
+  class ToolPlatform < Shale::Mapper
+    attribute :guid, Shale::Type::String
+    attribute :contact_email, Shale::Type::String
+    attribute :description, Shale::Type::String
+    attribute :name, Shale::Type::String
+    attribute :url, Shale::Type::String
+    attribute :product_family_code, Shale::Type::String
+    attribute :version, Shale::Type::String
+
+    json do
+      map "guid", to: :guid, schema: { required: true }
+      map "contact_email", to: :contact_email
+      map "description", to: :description
+      map "name", to: :name
+      map "url", to: :url
+      map "product_family_code", to: :product_family_code
+      map "version", to: :version
+    end
+  end
+end

data/lib/lti_core/version.rb

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

data/lib/lti_core.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "lti_core/version"
-
+require_relative "lti_core/lti_resource_link_request"
 module LtiCore
   class Error < StandardError; end
   # Your code goes here...

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lti_core
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors:
 - Aaron F Stanton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-24 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: shale
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundle-audit
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +221,13 @@ files:
 - README.md
 - Rakefile
 - lib/lti_core.rb
+- lib/lti_core/context.rb
+- lib/lti_core/custom.rb
+- lib/lti_core/launch_presentation.rb
+- lib/lti_core/lis.rb
+- lib/lti_core/lti_resource_link_request.rb
+- lib/lti_core/resource_link.rb
+- lib/lti_core/tool_platform.rb
 - lib/lti_core/version.rb
 - sig/lti_core.rbs
 homepage: https://github.com/afstanton/lti_core
@@ -211,14 +246,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: Implmentation of the LTI Core standard for Ruby.