growthtribe_xapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b6d643a742050f1112095743443f4862b73578c88191ac1112a78fc416df1d4
+  data.tar.gz: 0f8164d18c901ac7831af7b731ff669a29e41fc916b06629ddd5d86b7c38a706
+SHA512:
+  metadata.gz: d5eb2b588c4ee802db633f115b17279c2000e832d2b5d6844253ea8509882aed0bd4dcbb7b6bc9b9fa42db5b087553b135afc674f0c6e7ee9f1145682af26f00
+  data.tar.gz: d017dd430beec18a9ddb4218a65b69a1c7ab64499d147ca222a440ac86c1104a50ff177352b30b1f0a31336895229fa553eb80dd653ca0319a94db1fce0be07e

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: ['*']
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: ruby-3.0
+            os: ubuntu-20.04
+          - ruby: ruby-2.7
+            os: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - run: test -e Gemfile.lock
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bin/rspec

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+* Initial public release

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Contributing
+
+1. Fork it ( https://github.com/growthtribeacademy/Xapi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    growthtribe_xapi (0.0.1)
+      activesupport (>= 5.1)
+      addressable (~> 2.3)
+      faraday (~> 1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    hashdiff (1.0.1)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    multipart-post (2.1.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  growthtribe_xapi!
+  pry
+  rake
+  rspec
+  webmock (~> 3.0.0)
+
+BUNDLED WITH
+   2.2.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Deakin Prime
+
+MIT License
+
+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,299 @@
+# xAPI
+
+A Ruby library for implementing xAPIs Statements, Profiles and Querying Statements for LRS in simple way.
+
+For more information about the Tin Can API visit:
+
+http://Xapi.com/
+
+For more information about the xAPI Statements Specficiations and Components visit:
+
+https://github.com/adlnet/xAPI-Spec
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'growthtribe_xapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install growthtribe_xapi
+
+This gem provided classes in `Xapi` namespace as in original `Xapi`gem,
+from which it has been forked from.
+
+## Usage
+
+Create a remote LRS using Account credentials
+```ruby
+remote_lrs = Xapi.create_remote_lrs( end_point: ''https://some.lrsdomain.com'', user_name: 'username', password: 'password' )
+```
+
+Connect to the 'about' endpoint to get version information
+
+```ruby
+# use the remote LRS from above
+response = remote_lrs.about
+# check if it is successful
+if response.success
+    # access the Xapi::About instance
+    response.content
+end
+```
+
+#Creating the Properties of a Statement
+
+For more information about the Properties of a xAPI Statement visit:
+
+https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md
+
+Create a Agent for a Statement
+
+```ruby
+# Parameters can be passed for create_agent are:
+# agent_type which is either Agent or Group
+# Passing email, name - if agent_type is Agent
+# Passing members Array with hashes having name and email as keys - if agent_type is Group
+
+agent = Xapi.create_agent(agent_type: 'Agent', email: 'email', name: 'name')
+
+agent = Xapi.create_agent(agent_type: 'Group', members: [ {email: 'email1', name: 'name1'},{email: 'email2', name: 'name2'}] )
+```
+
+Create a Team for Context of a Statement
+
+```ruby
+# Parameters can be passed for create_team are: object_type, statement_id
+
+team = Xapi.create_team(home_page: "http://some.learnactivity.com/", name: 'team_name')
+```
+
+Create a Verb for a Statement
+
+```ruby
+# Parameters can be passed for create_verb are: id, name
+
+verb = Xapi.create_verb(id: 'http://adlnet.gov/expapi/verbs/launched', name: 'launched')
+```
+
+Create a Object for a Statement which is either Activity, Agent, or another Statement that is the Object of the Statement.
+
+```ruby
+# Parameters can be passed for create_activity are: id, name, description, extensions
+
+object = Xapi.create_activity(id: "http://some.learnactivity.com/conversation",
+                              name: 'Learning conversation', type: 'http://adlnet.gov/expapi/activities/assessment',
+                              description: 'Conversational Learning tool',
+                              extensions: { "http://id.tincanapi.com/extension/planned-duration" => 'PT50M' }
+                                   )
+```
+
+Create a Context Activities for Given Context of a Statement
+
+```ruby
+# Parameters can be passed for create_context_activities are: grouping, category, parent, other which are Array of Objects/Activitites realted to Context of a Statement
+
+grouping_array = []
+grouping_array << Xapi.create_activity( id: "http://some.learnactivity.com/topics/1",
+                                        name: 'topic title', type: "http://activitystrea.ms/schema/1.0/task"
+                                      )
+context_activities = Xapi.create_context_activities(grouping: grouping_array)
+```
+
+Create a Context for a Statement
+
+```ruby
+# Parameters can be passed for create_context are: registration, extensions, team, instructor, statement, context_activities
+
+context = Xapi.create_context(registration: 'registration_id',
+                              extensions: { "http://some.learnactivity.com/extension/tags" => ["domain1", "domain2"],
+                              team: team, instructor: instructor_agent,
+                              context_activities: context_activities
+                            )
+```
+
+Create a Result for a Statement
+
+```ruby
+# Parameters can be passed for create_result are: scaled_score or score_details, duration, response, success, completion, extensions
+
+result = Xapi.create_result(response: 'response details', score_details: {min: 1, raw: 7, max: 10}, success: true, extensions: {""http://some.learnactivity.com/extension/questions" => ['question1', 'question2']})
+```
+
+Create a Statement
+
+```ruby
+# Parameters can be passed for create_remote_lrs are: actor, verb, object, context, result
+
+statement = Xapi.create_statement(actor: agent, verb: verb, object: object, context: context, result: result)
+```
+
+Post a statement to LRS
+
+```ruby
+# Parameters can be passed for create_remote_lrs are: remote_lrs, statement
+
+response = Xapi.post_statement(remote_lrs: remote_lrs, statement: statement)
+
+if response.success
+  # access the statement
+  response.content
+end
+
+```
+
+## Querying Statements required from LRS
+
+Get Statement based on statement ID
+
+```ruby
+# Parameters can be passed for get_statements_by_query are: remote_lrs, statement_query
+
+Xapi.get_statements_by_id(remote_lrs: remote_lrs, statement_id: '2a8785a0-8ee8-41ad-9172-e194a82e30a4')
+```
+
+Get Statements based on Queries
+
+```ruby
+# Parameters can be passed for create_statement_query are: registration_id, verb_id, activity_id
+# Eithe agent details: agent_email, agent_name
+# or Team details: team_home_page, team_name
+# Searching related statements by passing boolean values to these: search_related_agents, search_related_activities
+
+#Based on Team
+statement_query = Xapi.create_statement_query(verb_id: 'http://id.tincanapi.com/verb rated', activity_id: 'http://some.learnactivity.com/conversation', team_home_page: 'http://some.learnactivity.com', team_name: 'team_name')
+
+#Based on Agent
+statement_query = Xapi.create_statement_query(verb_id: 'http://id.tincanapi.com/verb rated', activity_id: 'http://some.learnactivity.com/conversation', agent_email: 'email', agent_name: 'name')
+
+result_statements_response = Xapi.get_statements_by_query(remote_lrs: remote_lrs, statement_query: statement_query)
+
+#Knowing result statements count
+result_statements_response[:statements_count]
+
+#Knowing the result statements
+JSON.parse(result_statements_response[:statements].to_json) if result_statements_response[:statements_count] > 0
+```
+
+## Creating or updating the Profiles in LRS
+
+Create/Update Activity Profile
+
+```ruby
+# Parameters can be passed for create_activity_profile are: remote_lrs, profile_id, activity_object, profile_content
+
+activity_object = Xapi.create_activity(id: 'http://some.leranactivity.com/topics/1', name: 'title', type: 'http://activitystrea.ms/schema/1.0/task' )
+
+profile_content = { "name"=> "title", "description" => "description", "relevance" => "relevance", "type" => "http://some.leranactivity.com/evidences/document"
+                           }
+Xapi.create_activity_profile(remote_lrs: remote_lrs, profile_id: 'topic profile', activity_object: activity_object, profile_content: profile_activity_content)
+
+Xapi.update_activity_profile(remote_lrs: remote_lrs, profile_id: 'topic profile', activity_object: activity_object, profile_content: profile_activity_content)
+
+```
+
+Create/Update Agent Profile
+
+```ruby
+# Parameters can be passed for create_agent_profile are: remote_lrs, profile_id, agent_object, profile_content
+
+agent_details = Xapi.create_agent(agent_type: "Agent", email: 'email', name: 'name')
+
+profile_content = { "objectType" => "Agent", "name" =>  "name", "avatar" => "avatar image url", "age" => "age", "roles" => ["role1", "rol2"], "teams" => ["team name"] }
+
+Xapi.create_agent_profile(remote_lrs: remote_lrs, profile_id: "user profile", agent_object: agent_details, profile_content: profile_content)
+
+Xapi.update _agent_profile(remote_lrs: remote_lrs, profile_id: "user profile", agent_object: agent_details, profile_content: profile_content)
+
+```
+
+## Get the Profiles from LRS
+
+Get Activity Profile
+
+```ruby
+# Parameters can be passed for get_activity_profile are: remote_lrs, profile_id, activity_object
+
+activity_object = Xapi.create_activity(id: 'http://some.leranactivity.com/topics/1', name: 'title', type: 'http://activitystrea.ms/schema/1.0/task' )
+
+Xapi.get_activity_profile(remote_lrs: remote_lrs, profile_id: "topic profile", activity_object: activity_object)
+```
+
+Get Multiple Activity Profiles for given Activity
+
+```ruby
+# Parameters can be passed for get_activity_profile are: remote_lrs, profile_id, activity_object
+
+activity_object = Xapi.create_activity(id: 'http://some.leranactivity.com/topics/1', name: 'title', type: 'http://activitystrea.ms/schema/1.0/task' )
+
+Xapi.get_activity_profile(remote_lrs: remote_lrs, profile_id: ["profile1", "profile2"], activity_object: activity_object)
+```
+
+Get Agent Profile
+
+```ruby
+# Parameters can be passed for get_agent_profile are: remote_lrs, profile_id, agent_object
+
+agent_details = Xapi.create_agent(agent_type: "Agent", email: 'email', name: 'name')
+
+Xapi.get_agent_profile(remote_lrs: remote_lrs, profile_id: "agent profile", agent_object: agent_details)
+
+```
+
+Get Multiple Agent Profiles for given agent
+
+```ruby
+# Parameters can be passed for get_agent_profile are: remote_lrs, profile_id, agent_object
+
+agent_details = Xapi.create_agent(agent_type: "Agent", email: 'email', name: 'name')
+
+Xapi.get_agent_profile(remote_lrs: remote_lrs, profile_id: ["profile1", "profile2"], agent_object: agent_details)
+
+```
+
+## Analytics related to Team and its Team members related to Assessment
+
+Get Team and its members Average scores
+
+```ruby
+# Parameters can be passed for it: verb_id, activity_id, activity_type, team_name
+
+team_analytics_query = Xapi.create_team_analytics_query(verb_id: "http://id.tincanapi.com/verb/rated", activity_type: "http://activitystrea.ms/schema/1.0/task", team_name: "Digital Learning" )
+
+analytics_response = Xapi.get_analytics_by_query(remote_lrs: remote_lrs, team_analytics_query: team_analytics_query)
+
+```
+
+Get Team and its members Average scores, Activity frequency For given activity
+
+```ruby
+# Parameters can be passed for it: verb_id, activity_id, activity_type, team_name
+
+team_analytics_query = Xapi.create_team_analytics_query(verb_id: "http://id.tincanapi.com/verb/rated", activity_type: "http://activitystrea.ms/schema/1.0/task", team_name: "Digital Learning", activity_id: "http://some.leranactivity.com/activities/1" )
+
+analytics_response = Xapi.get_analytics_by_query(remote_lrs: remote_lrs, team_analytics_query: team_analytics_query)
+
+```
+
+Get Agent or Team member related all activities along with agent and its team average scores
+
+```ruby
+# Parameters can be passed for it: verb_id, agent_email, activity_type, team_name
+
+team_analytics_query = Xapi.create_team_analytics_query(verb_id: "http://id.tincanapi.com/verb/rated", activity_type: "http://activitystrea.ms/schema/1.0/task", team_name: "Digital Learning", agent_email: "123@test.com" )
+
+analytics_response = Xapi.get_analytics_by_query(remote_lrs: remote_lrs, team_analytics_query: team_analytics_query)
+
+```
+
+For more API calls check out the Xapi Module Class methods
+
+For more API calls check out the Xapi::RemoteLRS class
+