scidea-cv-sco_completion 0.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.0.1
+  - initial release

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Scitent, Inc.
+
+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,61 @@
+# Scidea (CardioVillage) Sco Completion
+
+This gem adds an alternative method for CardioVillage to signal exercise completion to Scidea.
+
+It responds to `POST scos/sco_records/update`. 
+
+## Usage
+
+1. Add `scidea-cv-sco_completion` to your Scidea Gemfile: 
+
+    ```
+    # Gemfile
+    gem 'requirejs-rails'
+    ```
+
+2. Add the following key to your config.yml file; it's a secret key allowing the backdoor to sidestep regular authentication:
+
+    ```
+    sco_record_completion_key: YOUR_SECRET_KEY_HERE
+    ```
+
+## Development Environment and Testing
+
+The gem is configured to use rspec tests. Because there are so many dependencies upon the Scidea core, rspec has been configured to launch an instance of the core application with the plugin's resources tied in. The features and specs of the plugin, however, are the only ones executed when you run rspec.
+
+To set up your environment for testing, perform the following:
+
+1. In your local Scidea core instance, add the following line to the Gemfile:
+
+    ```
+    # Gemfile
+    gem 'scidea-cv-sco_completion', :path => 'LOCAL_PATH_TO_THIS_GEM'
+    ```
+
+2. Copy the contents of the Scidea core Gemfile *after* ``gemspec``, and paste it to the end of the Gemfile in the scidea-cv-sco_completion code. When you run rspec, it requires this Gemfile, thus you need all of the gems that Scidea core requires as well.
+
+    ```
+    source 'http://rubygems.org'
+
+    gemspec
+
+    gem 'scidea', :path => 'LOCAL_PATH_TO_SCIDEA-CORE'
+
+    #from scidea core Gemfile:
+    gem 'rails', '= 3.1.3'
+
+    # db
+    gem 'mysql2', '>= 0.3'
+
+    # authentication and authorization
+    gem 'devise', '< 2.0'
+    gem 'cancan'
+    
+    ... and so on
+    ```
+
+From scidea-schools, you can run ``rspec``. Note that FactoryGirl factories from the Scidea core are included in the testing runtime and added to whatever you include in ``spec/factories``. The database configuration from the Scidea core will also be used. You must run all rake operations for that database in the context of the Scidea core folder. They will not work in the scidea-cv-sco_completion folder.
+
+----
+
+Copyright 2012 Scitent, Inc. See the file MIT-LICENSE for terms.

data/Rakefile

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'rake'

data/app/controllers/client/sco_records_controller.rb

@@ -0,0 +1,32 @@
+require 'active_resource/exceptions'
+
+module Client
+  class ScoRecordsController < ApplicationController
+
+    ssl_required :complete
+    skip_filter :authenticate_user!, :only => :complete
+    protect_from_forgery :except => :complete
+
+    def complete
+      begin
+        throw ActiveResource::UnauthorizedAccess.new('Invalid key') unless params.has_key?(:key) && params[:key] == APP_CONFIG['sco_record_completion_key']
+
+        sco = Sco.find_by_identifier_ref(params[:identifier_ref])
+        user = User.find_by_id(params[:user_id])
+
+        @sco_record = ScoRecord.by_sco(sco).for_user(user).first || ScoRecord.new(:sco => sco, :user => user)
+
+        @sco_record.status = "completed"
+
+        if @sco_record.save
+          head :ok
+        else
+          throw ActiveResource::ResourceNotFound.new('Exercise record validation error')
+        end
+      rescue
+        head :bad_request
+      end
+    end
+
+  end
+end

data/config/environment.rb

@@ -0,0 +1,18 @@
+# Load local Gemfile and get the path to the local core application
+# (from standard rails config/boot.rb)
+gemfile = File.expand_path('../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)
+
+# get only the paths constants; let scidea core load all gems
+require 'scidea/paths.rb'
+
+# Load and initialize the Scidea core application
+require File.expand_path('../config/environment', Scidea::APP_PATH)

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  post 'scos/sco_records/complete', :to => 'client/sco_records#complete'
+end

data/features/support/seed_user_roles.rb

@@ -0,0 +1,16 @@
+module SeedUserRoles
+  def self.seed
+    Role.public || Factory( :role_public )
+    Role.learner || Factory( :role_learner )
+    Role.user_admin || Factory(:role_user_admin)
+    Role.course_admin || Factory(:role_course_admin)
+    Role.product_admin || Factory(:role_product_admin)
+    Role.tech_support || Factory(:role_tech_support)
+    Role.scitent_admin || Factory(:role_scitent_admin)
+  end
+
+  def self.clean
+    Role.destroy_all
+  end
+end
+

data/features/support/test_utilities.rb

@@ -0,0 +1,16 @@
+module TestUtilities
+    class AssetDirectory
+        def self.create_test_asset_directory
+            FileUtils.mkdir_p APP_CONFIG['system_path']
+        end
+
+        def self.clear_test_asset_directory
+            delete_test_asset_directory
+            create_test_asset_directory
+        end
+
+        def self.delete_test_asset_directory
+            FileUtils.remove_dir APP_CONFIG['test_system_path_root'], force = true
+        end
+    end
+end

data/lib/scidea-cv-sco_completion.rb

@@ -0,0 +1 @@
+require 'scidea/cv.rb'

data/lib/scidea/cv.rb

@@ -0,0 +1 @@
+require 'scidea/cv/sco_completion'

data/lib/scidea/cv/sco_completion.rb

@@ -0,0 +1,7 @@
+module Scidea
+  module CV
+    module ScoCompletion
+      require 'scidea/cv/sco_completion/engine' if defined?(::Rails)
+    end
+  end
+end

data/lib/scidea/cv/sco_completion/engine.rb

@@ -0,0 +1,13 @@
+require_relative 'models/ability'
+
+module Scidea
+  module CV
+    module ScoCompletion
+      class Engine < ::Rails::Engine
+        config.to_prepare do
+          Ability.class_eval { include Scidea::CV::ScoCompletion::Models::Ability }
+        end
+      end # class Engine
+    end # module Redirects
+  end
+end

data/lib/scidea/cv/sco_completion/models/ability.rb

@@ -0,0 +1,21 @@
+module Scidea
+  module CV
+    module ScoCompletion
+      module Models
+        module Ability
+          extend ActiveSupport::Concern
+
+          module InstanceMethods
+            def initialize_namespace_none(user)
+              super
+
+              # required for registration form              
+              can(:update, ScoRecord)
+            end
+          end      
+
+        end # ability
+      end # models
+    end
+  end
+end

data/lib/scidea/cv/sco_completion/version.rb

@@ -0,0 +1,7 @@
+module Scidea
+  module CV
+    module ScoCompletion
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/controllers/client/sco_records_controller_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'active_resource/exceptions'
+
+describe Client::ScoRecordsController do
+  describe "update" do
+    before do
+      APP_CONFIG['sco_record_completion_key'] = "some-key-value"
+    end
+
+    context "the proper key is not submitted" do
+      it "should reject the post" do
+        post :complete, :key => "something else"
+        response.should_not be_success
+      end
+    end
+
+    context "the proper key is submitted" do
+      let(:sco) { Factory.build :sco, :id => 64 }
+      let(:user) { Factory.build :user_learner, :id => 42 }
+
+      before do
+        @params = { :key => APP_CONFIG['sco_record_completion_key'] }
+      end
+
+      context "the identifier_ref is bad" do
+        before do
+          Sco.stub(:find_by_sco_id).and_raise(ActiveResource::ResourceNotFound)
+        end
+
+        it "should reject the post" do
+          post :complete, @params
+          response.should_not be_success
+        end
+      end
+
+      context "the user id is incorrect" do
+        before do
+          Sco.stub(:find_by_identifier_ref).and_return(sco)
+          User.stub(:find_by_id).and_raise(ActiveResource::ResourceNotFound)
+        end
+
+        it "should reject the post" do
+          post :complete, @params
+          response.should_not be_success
+        end
+      end
+
+      context "the user id and identifier ref are correct" do
+        let(:sco_record) { Factory.build :sco_record }
+
+        before do
+          Sco.stub(:find_by_identifier_ref).with(sco.identifier_ref).and_return(sco)
+          User.stub(:find_by_id).with(user.id.to_s).and_return(user)
+          @params[:user_id] = user.id.to_s
+          @params[:identifier_ref] = sco.identifier_ref
+        end
+
+        context "the sco_record exists" do
+          before do
+            ScoRecord.stub_chain(:by_sco, :for_user, :first).and_return(sco_record)
+            sco_record.stub(:save).and_return(true)
+          end
+
+          it "should update the sco_record" do
+            sco_record.should_receive(:status=).with('completed')
+            post :complete, @params
+          end
+
+          it "should return a success" do 
+            post :complete, @params
+            response.should be_success
+          end
+        end
+
+        context "the sco_record does not exist" do
+          let(:sco_record) { mock_model(ScoRecord) }
+
+          before do
+            ScoRecord.stub_chain(:by_sco, :for_user, :first).and_return(nil)
+            ScoRecord.stub(:new).and_return(sco_record)
+            sco_record.stub(:save).and_return(true)
+            sco_record.stub(:status=)
+          end
+
+          it "should create a new sco_record" do
+            ScoRecord.should_receive(:new).with({:user => user, :sco => sco}).and_return(sco_record)
+            post :complete, @params
+          end
+
+          it "should update the sco_record" do
+            sco_record.should_receive(:status=).with('completed')
+            post :complete, @params
+          end
+
+          it "should save the record" do
+            sco_record.should_receive(:save).and_return(true)
+            post :complete, @params
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/spec/models/ability_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Ability do
+
+  describe "as an unregistered user" do
+    subject { Ability.new(User.new) }
+    
+    it { should be_able_to(:update, ScoRecord) }
+  end
+
+end

data/spec/routing/sco_records_routing_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper.rb'
+
+describe Client::ScoRecordsController do
+  describe "routing" do
+    it "should recognize #complete" do
+      { :post => "scos/sco_records/complete" }.should route_to(:controller => 'client/sco_records', :action => "complete")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("../../config/environment", __FILE__)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'scidea-cv-sco_completion'
+
+require 'rspec/rails'
+require 'rspec_tag_matchers'
+require 'cancan/matchers'
+require 'paperclip/matchers'
+require File.expand_path("../../features/support/test_utilities.rb", __FILE__)
+require File.expand_path("../../features/support/seed_user_roles.rb", __FILE__)
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+    TestUtilities::AssetDirectory.create_test_asset_directory
+    ::SeedUserRoles.seed
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+    TestUtilities::AssetDirectory.clear_test_asset_directory
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  config.after(:suite) do
+    ::SeedUserRoles.clean
+    TestUtilities::AssetDirectory.delete_test_asset_directory
+  end
+
+  config.include Devise::TestHelpers, :type => :controller
+  config.include Devise::TestHelpers, :type => :view
+  config.extend ControllerMacros, :type => :controller
+end
+
+# load local factories which will be added to the factories from scidea.
+Rails.configuration.after_initialize do
+  FactoryGirl.definition_file_paths = [File.expand_path('../factories', __FILE__)]
+  FactoryGirl.find_definitions
+end

data/spec/support/controller_macros.rb

@@ -0,0 +1,15 @@
+module ControllerMacros
+  def login_scitent_admin
+    before(:each) do
+      @request.env["devise.mapping"] = Devise.mappings[:users]
+      sign_in Factory(:user_scitent_admin)
+    end
+  end
+
+  def login_learner
+    before(:each) do
+      @request.env["devise.mapping"] = Devise.mappings[:users]
+      sign_in Factory(:user_learner)
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: scidea-cv-sco_completion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Phoenix Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-29 00:00:00.000000000Z
+dependencies: []
+description: Custom exercise completion mechanism for CardioVillage. This is not a
+  reusable Gem
+email:
+- phoenix@scitent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/client/sco_records_controller.rb
+- lib/scidea-cv-sco_completion.rb
+- lib/scidea/cv.rb
+- lib/scidea/cv/sco_completion.rb
+- lib/scidea/cv/sco_completion/engine.rb
+- lib/scidea/cv/sco_completion/models/ability.rb
+- lib/scidea/cv/sco_completion/version.rb
+- config/routes.rb
+- config/environment.rb
+- features/support/seed_user_roles.rb
+- features/support/test_utilities.rb
+- spec/controllers/client/sco_records_controller_spec.rb
+- spec/routing/sco_records_routing_spec.rb
+- spec/support/controller_macros.rb
+- spec/models/ability_spec.rb
+- spec/spec_helper.rb
+- MIT-LICENSE
+- README.md
+- Rakefile
+- CHANGELOG
+homepage: https://github.com/phoenix-scitent/scidea-cv-sco_completion
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Custom exercise completion mechanism for CardioVillage
+test_files: []