lti_roles 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2821dc26a4f22b649bdad2024e96dbed97e400d
+  data.tar.gz: fbfd73741ee21fd1260dfd2f87fcb367b8979fad
+SHA512:
+  metadata.gz: 69e908450169f316b86866fc8f4dee1ca9de4470f78cec56d2caaee143b05fcf41bd135add7c1d26186b8283098cdce8f95aa57ab395a479814aec87ddd94cd9
+  data.tar.gz: cd678f24ecac3024dd1543a84a0a0b3b093c81dccae8c940a276a8ded11278cf7e5e9856dd92066b54426390ffc7700aeb881d91332a5849ef3e899c95bf7425

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lti_roles.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cody Tanner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# LTIRoles
+
+This is a small gem that maps the LTI standard roles into a ruby symbol. I created this for use with cancancan.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lti_roles'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lti_roles
+
+## Usage
+
+LTIRoles has a RoleManager class that simply you initialize by passing your launch params roles string. RoleManager expects your roles to include the full URN. See [this page](https://www.imsglobal.org/specs/ltiv1p0/implementation-guide#toc-16) for a list of possible roles.
+
+Example:
+```ruby
+  roles = LTIRoles::RoleManager.new('urn:lti:instrole:ims/lis/Instructor,urn:lti:instrole:ims/lis/Student,urn:lti:role:ims/lis/Instructor,urn:lti:sysrole:ims/lis/User')
+
+  roles.institution_roles
+  => [:instructor, :student]
+```
+
+## Usage with CanCanCan
+
+Inside your launch controller you might save off the launch roles.
+
+```ruby
+  current_user.roles = LTIRoles::RoleManager.new('urn:lti:instrole:ims/lis/Instructor,urn:lti:instrole:ims/lis/Student,urn:lti:role:ims/lis/Instructor,urn:lti:sysrole:ims/lis/User')
+
+```
+
+Then you can check abilities like so.
+
+```ruby
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= User.new # guest user (not logged in)
+    user.roles ||= LTIRoles::RoleManager.new
+
+    if user.roles.institution_roles.include?(:administrator)
+      can :manage, :all
+    end
+
+    if user.roles.institution_roles.include?(:instructor)
+      can :read, :all
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CerebralStorm/lti_roles.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lti_roles"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lti_roles.rb

@@ -0,0 +1,38 @@
+require "lti_roles/version"
+require 'active_support/inflector'
+
+module LTIRoles
+  ContextTypeURN = 'urn:lti:context-type:ims/lis/'.freeze
+  SystemRoleURN = 'urn:lti:sysrole:ims/lis/'.freeze
+  InstitutionRoleURN = 'urn:lti:instrole:ims/lis/'.freeze
+  ContextRoleURN = 'urn:lti:role:ims/lis/'.freeze
+
+  class RoleManager
+    attr_accessor :roles, :context_types, :system_roles, :institution_roles, :context_roles
+
+    def initialize(roles = '')
+      @roles = roles
+      @context_types = map_roles(ContextTypeURN)
+      @system_roles = map_roles(SystemRoleURN)
+      @institution_roles = map_roles(InstitutionRoleURN)
+      @context_roles = map_roles(ContextRoleURN)
+    end
+
+    def map_roles(urn_prefix)
+      roles.split(',').map do |role|
+        next unless role.include?(urn_prefix)
+        role.gsub(urn_prefix, '').gsub('/', '').underscore.to_sym
+      end.compact
+    end
+
+    def to_h
+      {
+        context_type: context_types,
+        system_roles: system_roles,
+        institution_roles: institution_roles,
+        context_roles: context_roles
+      }
+    end
+
+  end
+end

data/lib/lti_roles/version.rb

@@ -0,0 +1,3 @@
+module LTIRoles
+  VERSION = "0.0.1"
+end

data/lti_roles.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lti_roles/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lti_roles"
+  spec.version       = LTIRoles::VERSION
+  spec.authors       = ["Cody Tanner"]
+  spec.email         = ["ctanner@instructure.com"]
+
+  spec.summary       = %q{Maps LTI roles to ruby}
+  spec.description   = %q{LTI standard launches will include roles, this gem maps those roles into an easily useable format for ruby}
+  spec.homepage      = "https://github.com/CerebralStorm/lti_roles"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: lti_roles
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cody Tanner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: LTI standard launches will include roles, this gem maps those roles into
+  an easily useable format for ruby
+email:
+- ctanner@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lti_roles.rb
+- lib/lti_roles/version.rb
+- lti_roles.gemspec
+homepage: https://github.com/CerebralStorm/lti_roles
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Maps LTI roles to ruby
+test_files: []