learnosity-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69ce4c83a0acd03be313fa8caa56a35d28442cf0
+  data.tar.gz: 18da69bf85b5879a3a0848202dadb1d00746b235
+SHA512:
+  metadata.gz: ce0bdb72d86c33ca14bea31e072e5765ac8129a0c029bd3639408123411045a362a0fc35ac75c83629281ae50cd16f3ad46158343f83edf9442adfa1aa0da8ed
+  data.tar.gz: a21edf6bae35274ad21645b1cb17caafa734657b4a047afd74471263d02bb33b72e1d97e37cbd898449c9b6a51593dba888718b8eba6ac3ea49179c5ed89225f

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.0.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,269 @@
+# Learnosity SDK - Ruby
+
+This gem allows to ease integration with the following Learnosity APIs,
+
+- Author API [author-api-doc]
+- Assess API [assess-api-doc]
+- Data API [data-api-doc]
+- Events API [events-api-doc]
+- Items API [items-api-doc]
+- Questions API [questions-api-doc]
+- Report API [report-api-doc]
+
+## Installation
+
+### Ruby Gem
+
+The SDK should be available from RubyGems [learnosity-sdk-rubygems]
+
+    gem install learnosity-sdk
+
+### git clone
+
+You can build and install the SDK directly from a Git clone, with
+
+    git clone https://github.com/Learnosity/learnosity-sdk-ruby/
+    cd learnosity-sdk-ruby/
+    bundle install
+    rake build
+    gem install --user-install pkg/learnosity-sdk-0.1.0.gem
+
+If `bundle` is missing, you can install it with
+
+    gem install --user-install bundler
+
+## Usage
+
+Some usage examples can be found in the `examples/` subdirectory.
+
+### Init
+
+This class generates and signs init options for all supported APIs. Its
+constructor takes four mandatory arguments, and one optional argument.
+
+- `service`: the name of the API to sign initialisation options for,
+- `security_packet`: a hash with at least the `consumer_key`, optionally the
+  `domain` and `timestamp`; `user_id` is also mandatory for Questions API,
+- `consumer_secret`
+- `request`: the request you want to get a signature for
+- `action` [Data API only]: the action of your request, either `get` or `post`
+
+The `Init#generate` method can then be used to generate the options. By default,
+it will generate a JSON string. It however takes one parameter, `encode` which,
+if false, will simply return a native Ruby Hash with the signed options.
+
+Given your consumer key and secret, and the request you want to run against,
+say, the `items` API, you just need to instantiate the
+`Learnosity::Sdk::Request::Init`, and call its `generate` method.
+
+```ruby
+require "learnosity/sdk/request/init"
+
+security_packet = {
+        'consumer_key'   => 'yis0TYCu7U9V4o7M',
+        'domain'         => 'localhost',
+}
+consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+items_request = { 'limit' => 50 }
+
+init = Learnosity::Sdk::Request::Init.new(
+        'items',
+        security_packet,
+        consumer_secret,
+        items_request
+)
+
+puts init.generate
+```
+
+This will return a string of signed options suitable for initialisation of
+the API.
+
+```html
+<html>
+    <head>
+    </head>
+
+    <body>
+	    <script src="//items.learnosity.com/"></script>
+
+	    <script>
+	    var itemsApp = LearnosityItems.init(INSERT OPTIONS HERE);
+	    </script>
+
+    </body>
+</html>
+```
+
+### Data API
+
+When the `service` parameter is `data`, the `action` parameter is mandatory.
+Moreover, `Init#generate`'s `encode` parameter is ignored, and a native Ruby Hash
+with the signed options is unconditionally returned, for use with your favourite
+HTTP library (note that, regardless of the `action` parameter, you should always
+send `POST` requests).
+
+```ruby
+require 'net/http'
+require "learnosity/sdk/request/init"
+
+
+security_packet = {
+        'consumer_key'   => 'yis0TYCu7U9V4o7M',
+        'domain'         => 'localhost',
+}
+consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+data_request = { 'limit' => 50 }
+
+init = Learnosity::Sdk::Request::Init.new(
+        'data',
+        security_packet,
+        consumer_secret,
+        data_request,
+	'get'
+)
+
+request = init.generate
+
+Net::HTTP.post_form URI('https://data.learnosity.com/v1/itembank/items'), request
+```
+
+### Recursive Queries
+
+tl;dr: not currently implemented
+
+Some requests are paginated to the `limit` passed in the request, or some
+server-side default. Responses to those requests contain a `next` parameter in
+their `meta` property, which can be placed in the next request to access another
+page of data.
+
+For the time being, you can iterate through pages by looping over the
+`Init#new`/`Init#generate`/`Net::HTTP#post_form`, updating the `next` attribute
+in the request.
+
+	data_request['next'] = JSON.parse(res.body)['meta']['next']
+
+This will `require 'json'` to be able to parse the response.
+
+See `examples/simple/init_data.rb` for an example.
+
+### Generating UUIDs
+
+You will likely have to generate UUIDs. You can use the Ruby `securerandom`
+module for this purpose.
+
+```ruby
+require 'securerandom'
+
+p SecureRandom.uuid
+```
+
+### Rails
+
+You can bootstrap a Ruby-on-Rails project using this SDK by doing the
+following.
+
+Note, this is a quick 0 to 100 in 10s examples of how to use this
+SDK with Rails. As such, it takes many unwise shortcuts in the architecture of
+the app; do not take this as the example of a good Rails app.
+
+First, generate a skeleton project
+
+    rails new lrn-sdk-rails
+    cd lrn-sdk-rails
+
+Add the `learnosity-sdk` as a dependency to this project
+
+    echo "gem 'learnosity-sdk' >> Gemfile
+    bundle install
+
+Create a default controller
+
+    rails generate controller Index index
+
+Add the `require` for the SDK at the top of the newly created controller,
+`app/controllers/index_controller.rb`, and insert the assessment configuration
+there (taken from [items-api-demo], and truncated for legibility).
+
+```ruby
+require 'learnosity/sdk/request/init'
+
+class IndexController < ApplicationController
+  @@security_packet = {
+    'consumer_key'   => 'yis0TYCu7U9V4o7M',
+    'domain'         => 'localhost'
+  }
+  # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
+  @@consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+  @@items_request = {
+	[...]
+  }
+
+  def index
+    init = Learnosity::Sdk::Request::Init.new(
+      'items',
+      @@security_packet,
+      @@consumer_secret,
+      @@items_request
+    )
+  end
+end
+```
+
+Add the HTML/Javascript boilerplate to the view, `app/views/index/index.html.erb`
+
+```
+<h1>Index#index</h1>
+
+<div id="learnosity_assess"></div>
+
+<script src="//items.learnosity.com"></script>
+<script>
+  var eventOptions = {
+    readyListener: init
+  },
+    itemsApp = LearnosityItems.init(<%= raw(@init.generate) %>);
+
+  function init () {
+    var assessApp = itemsApp.assessApp();
+
+
+    assessApp.on('item:load', function () {
+      console.log('Active item:', getActiveItem(this.getItems()));
+    });
+
+    assessApp.on('test:submit:success', function () {
+      toggleModalClass();
+    });
+  }
+</script>
+```
+
+Finally, you can serve the project with
+
+    rails serve
+
+
+It will become available at http://localhost:3000/index/index
+
+For reference you can find the result of these steps in
+`examples/lrn-sdk-rails`.
+
+## Testing
+
+Just run
+
+    rake spec
+
+to exercise the testsuite
+
+
+[author-api-doc]: https://docs.learnosity.com/authoring/author
+[assess-api-doc]: https://docs.learnosity.com/assessment/assess
+[data-api-doc]: https://docs.learnosity.com/analytics/data
+[events-api-doc]: https://docs.learnosity.com/analytics/events
+[items-api-doc]: https://docs.learnosity.com/assessment/items
+[questions-api-doc]: https://docs.learnosity.com/assessment/questions
+[report-api-doc]: https://docs.learnosity.com/analytics/report
+[learnosity-sdk-rubygems]: https://rubygems.org/gems/learnosity-sdk
+[items-api-demo]: http://demos.learnosity.com/assessment/items/itemsapi_assess.php