RubyGems - dce_lti - Versions diffs - 0.2.0 - Mend

dce_lti 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +154 -0
data/Rakefile +19 -0
data/app/assets/javascripts/dce_lti/application.js +13 -0
data/app/assets/stylesheets/dce_lti/application.css +15 -0
data/app/concerns/dce_lti/session_helpers.rb +55 -0
data/app/controllers/dce_lti/application_controller.rb +5 -0
data/app/controllers/dce_lti/configs_controller.rb +26 -0
data/app/controllers/dce_lti/sessions_controller.rb +20 -0
data/app/helpers/dce_lti/application_helper.rb +4 -0
data/app/models/dce_lti/nonce.rb +17 -0
data/app/models/dce_lti/user.rb +16 -0
data/app/services/dce_lti/timestamp_validator.rb +7 -0
data/app/services/dce_lti/user_initializer.rb +22 -0
data/app/views/dce_lti/sessions/invalid.html.erb +4 -0
data/app/views/layouts/dce_lti/application.html.erb +14 -0
data/config/routes.rb +9 -0
data/db/migrate/20141003180140_create_dce_lti_users.rb +16 -0
data/db/migrate/20141008172001_create_dce_lti_nonces.rb +10 -0
data/lib/dce_lti/controller_methods.rb +18 -0
data/lib/dce_lti/engine.rb +30 -0
data/lib/dce_lti/version.rb +3 -0
data/lib/dce_lti.rb +5 -0
data/lib/tasks/dce_lti_tasks.rake +34 -0
data/spec/controllers/dce_lti/configs_controller_spec.rb +71 -0
data/spec/controllers/dce_lti/sessions_controller_spec.rb +201 -0
data/spec/controllers/embedding_headers_are_correct_spec.rb +8 -0
data/spec/controllers/posts_controller_spec.rb +22 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/controllers/posts_controller.rb +6 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config/application.rb +29 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +19 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +82 -0
data/spec/dummy/config/environments/test.rb +39 -0
data/spec/dummy/config/initializers/assets.rb +8 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/dce_lti_config.rb +40 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/initializers/x_frame_options.rb +9 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +7 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/schema.rb +40 -0
data/spec/dummy/log/development.log +2875 -0
data/spec/dummy/log/test.log +108620 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/factories.rb +7 -0
data/spec/models/dce_lti/nonce_spec.rb +42 -0
data/spec/models/dce_lti/user_spec.rb +71 -0
data/spec/services/dce_lti/timestamp_validator_spec.rb +15 -0
data/spec/services/dce_lti/user_initializer_spec.rb +58 -0
data/spec/spec_helper.rb +25 -0
data/spec/support/database_cleaner.rb +21 -0
data/spec/support/dce_lti/configuration_helpers.rb +36 -0
data/spec/support/factory_girl.rb +3 -0
metadata +327 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/factories.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module DceLti
+  FactoryGirl.define do
+    factory :user, class: User do
+      sequence(:lti_user_id) { |n| "user_id-#{n}" }
+    end
+  end
+end

data/spec/models/dce_lti/nonce_spec.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module DceLti
+  describe Nonce do
+    it { should have_db_index(:nonce).unique(:true) }
+    context '.valid?' do
+      it 'returns true when a value is unique' do
+        expect(described_class.valid?('100')).to be true
+      end
+      it 'returns false when a value already exists' do
+        described_class.create!(nonce: '100')
+        expect(described_class.valid?('100')).to be false
+      end
+    end
+    context 'logging' do
+      it 'logs about it when a nonce is invalid' do
+        allow(Rails.logger).to receive(:warn)
+        allow(described_class).to receive(:create!).and_raise
+        described_class.valid?('100')
+        expect(Rails.logger).to have_received(:warn).with(/Creating nonce failed: "100"/)
+      end
+    end
+    context '.clean' do
+      it 'deletes based on the time limit in seconds set in config' do
+        Time.freeze do
+          allow(described_class).to receive(:delete_all)
+          described_class.clean
+          expect(described_class).to have_received(:delete_all).with(
+            ['created_at < ?', Time.now - 6.hours]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/models/dce_lti/user_spec.rb ADDED Viewed

@@ -0,0 +1,71 @@
+module DceLti
+  describe User do
+    context '#lti_user_id' do
+      it { should validate_presence_of(:lti_user_id) }
+      it { should validate_uniqueness_of(:lti_user_id) }
+      it { should ensure_length_of(:lti_user_id).is_at_most(255) }
+    end
+    context '#roles' do
+      it 'keeps an array of roles' do
+        roles = %w|foo bar|
+        user = build(:user, roles: roles)
+        user.save && user.reload
+        expect(user.roles).to match_array(roles)
+      end
+      it 'are case downcased before storing' do
+        roles = %w|foo bar BAZ|
+        user = build(:user, roles: roles)
+        user.save && user.reload
+        expect(user.roles).to match_array(['foo','bar', 'baz'])
+      end
+    end
+    context 'has_role?' do
+      it 'handles nil elegantly' do
+        user = described_class.new
+        expect(user).not_to have_role(nil)
+      end
+      it 'can be queried via predicate methods' do
+        user = create(:user, roles: ['foo', 'blee'])
+        expect(user).to have_role(:foo)
+      end
+      it 'downcases a role before querying' do
+        user = create(:user, roles: ['foo', 'BLEE'])
+        expect(user).to have_role('blee')
+      end
+      it 'does not care if a role is a string or a symbol' do
+        user = create(:user, roles: ['foo', 'BLEE'])
+        expect(user).to have_role('blee')
+        expect(user).to have_role(:blee)
+      end
+    end
+    it 'stores additional attributes from the consumer' do
+      user = described_class.new
+      %i|
+    lis_person_contact_email_primary
+    lis_person_name_family
+    lis_person_name_full
+    lis_person_name_given
+    lis_person_sourcedid
+    user_image
+      |.each do |attribute|
+        expect(user).to respond_to(attribute)
+      end
+    end
+  end
+end

data/spec/services/dce_lti/timestamp_validator_spec.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module DceLti
+  describe TimestampValidator do
+    it 'returns true for a timestamp that is in range' do
+      timestamp = (Time.now - 1.hour).to_i
+      expect(described_class.valid?(timestamp)).to be true
+    end
+    it 'returns false for a timestamp that is not in range' do
+      timestamp = (Time.now - 6.hours).to_i
+      expect(described_class.valid?(timestamp)).to be false
+    end
+  end
+end

data/spec/services/dce_lti/user_initializer_spec.rb ADDED Viewed

@@ -0,0 +1,58 @@
+module DceLti
+  describe UserInitializer do
+    it 'finds or creates a user based on the tool provider user_id' do
+      user_double = double('user').as_null_object
+      fake_oauth_id = 'an_oauth_id'
+      allow(tool_provider_double).to receive(:user_id).
+        and_return(fake_oauth_id)
+      allow(User).to receive(:find_or_create_by).and_return(user_double)
+      described_class.find_from(tool_provider_double)
+      expect(User).to have_received(:find_or_create_by).
+        with(lti_user_id: fake_oauth_id)
+      expect(tool_provider_double).to have_received(:user_id)
+    end
+    it 'adds additional attributes to a user from the tool_provider' do
+      user = User.new
+      allow(user).to receive_messages(tool_provider_methods)
+      allow(User).to receive(:find_or_create_by).and_return(user)
+      described_class.find_from(tool_provider_double)
+      tool_provider_methods.each do |tool_provider_attribute|
+        send_to_tool_provider = tool_provider_attribute.to_s.gsub(/=\Z/,'').to_sym
+        expect(user).to have_received(tool_provider_attribute).with(
+          tool_provider_attributes[send_to_tool_provider]
+        )
+      end
+    end
+    def tool_provider_methods
+      tool_provider_attributes.keys.reject do |att|
+        att == :user_id
+      end.map{|att| "#{att}=".to_sym}
+    end
+    def  tool_provider_attributes
+      {
+        user_id: 'an_oauth_id',
+        roles: [ 'instructor' ],
+        lis_person_contact_email_primary: 'instructor@example.com',
+        lis_person_name_family: 'Last Name',
+        lis_person_name_full: 'Last Name, First Name',
+        lis_person_name_given: 'First Name',
+        lis_person_sourcedid: 'sourcedid',
+        user_image: 'http://example.com/image.png'
+      }
+    end
+    def tool_provider_double
+      @tool_provider_double ||= double(
+        'Tool Provider',
+        tool_provider_attributes
+      )
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,25 @@
+ENV['RAILS_ENV'] = 'test'
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+require 'rspec/rails'
+require 'shoulda/matchers'
+require 'factory_girl_rails'
+require 'pry-byebug'
+require 'database_cleaner'
+Rails.backtrace_cleaner.remove_silencers!
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  # config.include Features, type: :feature
+  config.infer_base_class_for_anonymous_controllers = false
+  config.infer_spec_type_from_file_location!
+  config.order = 'random'
+  config.use_transactional_fixtures = false
+end

data/spec/support/database_cleaner.rb ADDED Viewed

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:deletion)
+  end
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :deletion
+  end
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/dce_lti/configuration_helpers.rb ADDED Viewed

@@ -0,0 +1,36 @@
+module DceLti
+  module ConfigurationHelpers
+    def with_overridden_lti_config_of(new_config)
+      original_config = get_original_config(new_config)
+      begin
+        new_config.keys.each do |config_att|
+          DceLti::Engine.config.send("#{config_att}=", new_config[config_att])
+        end
+        yield DceLti::Engine.config
+      ensure
+        new_config.keys.each do |config_att|
+          DceLti::Engine.config.send("#{config_att}=", original_config[config_att])
+        end
+      end
+    end
+    def get_original_config(new_config)
+      original_config = {}
+      new_config.keys.each do |config_att|
+        if ! DceLti::Engine.config.respond_to?(config_att)
+          DceLti::Engine.config.send("#{config_att}=", nil)
+        end
+        original_config[config_att] = DceLti::Engine.config.send(config_att.to_sym)
+      end
+      original_config
+    end
+    def lti_config
+      {
+        provider_title: 'An awesome title',
+        provider_description: 'A cool description',
+      }
+    end
+  end
+end

data/spec/support/factory_girl.rb ADDED Viewed

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end