learnosity_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a94f32079d14ff4036af3f9c27d7c63a80b2b2d31a13ce4b89a472722f3994fb
+  data.tar.gz: 1f57385b2641a30206657d0af915a20824cc3aaa186785b28d4d07e03b7cdde8
+SHA512:
+  metadata.gz: 36191e1812ab8f9d1547d93b38b8703f48eee076c7cc5695c374f7b3b1059e96721d8994884f29bdaaef5f3211c9d5cc85e69979db8c525d0552042469d092eb
+  data.tar.gz: b31e201739963b019ae87273126fb1b908185b600b45462cd291addb7f5139b15f29a2ea1c9de1c6cb4d2e9dfbb167b85a4fc7875e4155aebed090b3eb66f62e

data/.gitignore

@@ -0,0 +1,37 @@
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+.idea/vcs.xml
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+.rspec_status
+.rspec
+
+# user provided
+config.yml
+
+# ignore for gems
+gemfile.lock
+*.gem
+.config
+.rvmrc
+rdoc
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build learnosity_utils-0.0.1.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install learnosity_utils-0.0.1.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install learnosity_utils-0.0.1.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.0.1 and build and push learnosity_utils-0.0.1.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup><RakeTask description="" fullCmd="test" taksId="test" /></RakeGroup></Settings>

data/.idea/encodings.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" addBOMForNewFiles="with NO BOM" />
+</project>

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

data/.idea/misc.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="NodePackageJsonFileManager">
+    <packageJsonPaths />
+  </component>
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="false" project-jdk-name="ruby-2.5.3-p105" project-jdk-type="RUBY_SDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/learnosity_utils.iml" filepath="$PROJECT_DIR$/learnosity_utils.iml" />
+    </modules>
+  </component>
+</project>

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in learnosity_utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chris Connell
+
+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,58 @@
+# LearnosityUtils
+
+LearnosityUtils wraps the ```learnosity-sdk``` gem, adding easy user configuration, and preset method generation for commonly used [Learnosity Data Api](https://reference.learnosity.com/data-api) **itembank** endpoints
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'learnosity_utils'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install learnosity_utils
+
+## Usage
+
+After installation you'll need configure the gem with your Learnosity provided credentials.
+
+```ruby
+LearnosityUtils.configure do |config|
+  config.consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+  config.security_packet = {
+    'consumer_key' => 'yis0TYCu7U9V4o7M',
+    'domain' => 'localhost'
+  }
+end
+``` 
+
+Note: _The example contains **demo** credentials exposed by Learnosity's [data-api demo site](https://demos.learnosity.com/analytics/data/index.php)_
+
+The itembank endpoints currently accessible as **getters** and **setters** are:
+* items
+* items_tags
+* questions
+* features
+* activities
+
+When performing a **get** request, the only parameter necessary is an array of reference IDs
+ 
+```ruby
+references = ['1234567890']
+
+LearnosityUtils::EndPoint::ItemBank.send(:get_items, references)
+```
+
+## Code of Conduct
+
+Everyone interacting in this codebase and issue tracker is expected to follow the [code of conduct](https://github.com/[USERNAME]/learnosity_utils/blob/master/CODE_OF_CONDUCT.md)
+
+## License
+
+The gem is available as open source under the terms of the [MIT license](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'learnosity_utils'
+
+# 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/learnosity_utils.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/learnosity_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'learnosity_utils'
+  spec.version       = LearnosityUtils::VERSION
+  spec.authors       = ['Chris Connell']
+  spec.email         = ['getinmypool@gmail.com']
+
+  spec.summary       = 'An easy interface to learnosity endpoints with configuration support'
+  spec.homepage      = 'https://github.com/LYNx785/learnosity_utils'
+  spec.license       = 'MIT'
+
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~>2.0', '>=2.0.1'
+  spec.add_development_dependency 'rake', '~>12.3', '>=12.3.2'
+  spec.add_development_dependency 'rspec', '~>3.8', '>=3.8.0'
+  spec.add_development_dependency 'webmock', '~>3.5', '>=3.5.1'
+
+  spec.add_runtime_dependency 'learnosity-sdk', '0.1.0'
+  spec.add_runtime_dependency 'rare', '~>0.1.1'
+end

data/learnosity_utils.iml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="ruby-2.5.3-p105" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="addressable (v2.6.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.0.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="crack (v0.4.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="hashdiff (v0.3.8, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="learnosity-sdk (v0.1.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="public_suffix (v3.0.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.2, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rare (v0.1.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.8.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.8.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.8.2, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.8.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.8.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="safe_yaml (v1.0.5, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="webmock (v3.5.1, ruby-2.5.3-p105) [gem]" level="application" />
+  </component>
+</module>

data/lib/learnosity_utils/configuration.rb

@@ -0,0 +1,16 @@
+module LearnosityUtils
+  class Configuration
+    attr_accessor :get_rate, :set_rate, :sort, :retry_delay,
+                  :consumer_secret, :security_packet, :version
+
+    def initialize
+      @get_rate = 6000
+      @set_rate = 300
+      @sort = 'asc'
+      @retry_delay = 5
+      @consumer_secret = nil
+      @security_packet = nil
+      @version = '2019.1.LTS'
+    end
+  end
+end

data/lib/learnosity_utils/end_point.rb

@@ -0,0 +1,7 @@
+require_relative 'endpoint/item_bank'
+
+module LearnosityUtils
+  module EndPoint
+
+  end
+end

data/lib/learnosity_utils/endpoint/base.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'learnosity/sdk/request/init'
+
+module LearnosityUtils
+  module EndPoint
+    module Base
+
+      def request(data_request = nil, endpoint = nil, action = 'get', service = 'data')
+        init = Learnosity::Sdk::Request::Init.new(
+            service,
+            LearnosityUtils.configuration.security_packet,
+            LearnosityUtils.configuration.consumer_secret,
+            data_request,
+            action
+        )
+
+        request = init.generate
+        remote = Net::HTTP.post_form URI("#{site}#{endpoint}"), request
+        body = JSON.parse remote.body, symbolize_names: true
+
+        if body[:meta][:code] == 42000
+          sleep LearnosityUtils.configuration.retry_delay
+          request(data_request, endpoint, action, service)
+        else
+          body
+        end
+      end
+
+      private
+
+      def site
+        "https://data.learnosity.com/v#{LearnosityUtils.configuration.version}/"
+      end
+
+    end
+  end
+end

data/lib/learnosity_utils/endpoint/item_bank.rb

@@ -0,0 +1,54 @@
+require 'rare'
+require_relative 'base'
+
+module LearnosityUtils
+  module EndPoint
+    module ItemBank
+      include Base
+
+      extend self
+
+      endpoints = [:items, :items_tags, :questions, :features, :activities]
+
+      instance_eval do
+        endpoints.each do |endpoint|
+          define_method "get_#{endpoint}" do |references = [], options = {}|
+            Rare.throttle rpm: LearnosityUtils.configuration.get_rate, key: 'get' do
+              request({references: references, sort: LearnosityUtils.configuration.sort}.merge(options), method("#{endpoint}_endpoint").call)
+            end
+          end
+
+          define_method "set_#{endpoint}" do |collection = [], options = {}|
+            Rare.throttle rpm: LearnosityUtils.configuration.set_rate, key: 'set' do
+              remote = request({items: collection}.merge(options), method("#{endpoint}_endpoint").call, 'set')
+              remote[:meta][:status]
+            end
+          end
+        end
+      end
+
+      private
+
+      def items_endpoint
+        'itembank/items'
+      end
+
+      def items_tags_endpoint
+        'itembank/items/tags'
+      end
+
+      def questions_endpoint
+        'itembank/questions'
+      end
+
+      def features_endpoint
+        'itembank/features'
+      end
+
+      def activities_endpoint
+        'itembank/activities'
+      end
+
+    end
+  end
+end

data/lib/learnosity_utils/version.rb

@@ -0,0 +1,3 @@
+module LearnosityUtils
+  VERSION = "0.1.0"
+end

data/lib/learnosity_utils.rb

@@ -0,0 +1,21 @@
+require_relative 'learnosity_utils/version'
+require_relative 'learnosity_utils/end_point'
+require_relative 'learnosity_utils/configuration'
+
+module LearnosityUtils
+  extend self
+
+  attr_writer :configuration
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def reset
+    @configuration = Configuration.new
+  end
+
+  def configure
+    yield configuration
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: learnosity_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Connell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: learnosity-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: 
+email:
+- getinmypool@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.rakeTasks"
+- ".idea/encodings.xml"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- learnosity_utils.gemspec
+- learnosity_utils.iml
+- lib/learnosity_utils.rb
+- lib/learnosity_utils/configuration.rb
+- lib/learnosity_utils/end_point.rb
+- lib/learnosity_utils/endpoint/base.rb
+- lib/learnosity_utils/endpoint/item_bank.rb
+- lib/learnosity_utils/version.rb
+homepage: https://github.com/LYNx785/learnosity_utils
+licenses:
+- MIT
+metadata: {}
+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.7.6
+signing_key: 
+specification_version: 4
+summary: An easy interface to learnosity endpoints with configuration support
+test_files: []