absorb_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3691bed9934f3ceb0bc5e98a4e67fd957d68d6a9
+  data.tar.gz: 33fee37c847cd32e1fa1bd4adcfadc279f8b62d2
+SHA512:
+  metadata.gz: 172856c56726089fc4136ed9640432bd8a056d2630178faeb4fb970113b50522691ae341cf4781a70e09e1f45e75a49f9b7da1e00a942503873db35abbfc5f35
+  data.tar.gz: 7cf9613318f8782f67a5d59afb9a7ff743eb075981238e41994fe3dd9e00f80f6fee9934e8af7081a6aa11c7ab2a9e35ac7993b4ac5fc96629f4f6e015591407

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in absorb_api.gemspec
+gemspec
+
+gem 'faraday'
+gem 'typhoeus'
+gem 'json'
+gem 'faraday_middleware'
+gem 'activesupport'
+gem 'activemodel'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 npezza93
+
+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,203 @@
+# Absorb LMS API Wrapper
+
+"Absorb LMS is a powerful, flexible, and visually stunning software platform teamed with expert implementation and support to help you build the training programs your business needs. Whether your old LMS is slowing you down or you’ve outgrown your current training model, Absorb can help.
+"
+
+All the available REST routes can be found [here](https://myabsorb.com/api/rest/v1/Help).
+
+Full documentation can be found at [http://npezza93.github.io/absorb_api/](http://npezza93.github.io/absorb_api/)
+## Table of Contents
+1. [Installation](#installation)
+2. [Configuration](#configuration)
+3. [Models](#models)
+  * [User](#user)
+  * [Course](#course)
+  * [Category](#category)
+  * [Certificate](#certificate)
+  * [Chapter](#chapter)
+  * [Curriculum](#curriculum)
+  * [Department](#department)
+4. [Development](#development)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'absorb_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install absorb_api
+
+## Configuration
+```ruby
+AbsorbApi.configure do |c|
+  c.absorbuser = absorb_username
+  c.absorbpass = absorb_password
+  c.absorbkey = absorb_privatekey
+  c.url = absorb_url
+  c.ignored_course_ids = [course_ids_to_ignore]
+  c.ignored_lesson_types = [lesson_types_to_ignore]
+end
+```
+
+## Models
+
+### User
+```ruby
+# To return a collection of all available users
+AbsorbApi::User.all
+
+# To find a single user by id:
+AbsorbApi::User.find(id)
+
+# To return a collection of users matching conditions
+AbsorbApi::User.where(conditions)
+# available conditions include email, username, modifiedSince, and externalId
+AbsorbApi::User.where(email: "email@gmail.com")
+
+# To return a collection of enrollments for a specific user:
+user.enrollments
+# Available filters for enrollments include status and modifiedSince
+user.enrollments(status: 0, modifiedSince: DateTime.new(2016, 1, 1).to_s)
+
+# To return a collection of all certificates awarded to a user
+user.certificates
+# To return a single certificate for a specific user
+user.find_certificate(id)
+
+# To return a collection of all courses available for enrollment for a user
+user.courses
+
+# To create a new user
+AbsorbApi::User.create(department_id: "department_id", first_name: "first_name", last_name: "last_name", user_name: "user_name", email_address: "email_address", password: "password")
+# or
+AbsorbApi::User.create do |user|
+  user.department_id  = "department_id"
+  user.first_name     = "first_name"
+  user.last_name      = "last_name"
+  user.user_name      = "user_name"
+  user.email_address  = "email_address"
+  user.password       = "password"
+end
+```
+
+  To return a collection of courses available per user given a collection of users:
+  ```ruby
+  users = AbsorbApi::User.all
+  courses = AbsorbApi::User.courses_from_collection(users)
+  ```
+
+### Course
+```ruby
+# To return a collection of all available courses
+AbsorbApi::Course.all
+
+# To find a single course by id
+AbsorbApi::Course.find(id)
+
+# To return a collection of courses matching conditions
+AbsorbApi::Course.where(conditions)
+# available conditions include modifiedSince and externalId
+AbsorbApi::Course.where(modifiedSince: DateTime.new(2016,1,1).to_s)
+
+# To return a collection of enrollments for a specific course:
+course.enrollments
+# Available filters for enrollments include status and modifiedSince
+course.enrollments(status: 0, modifiedSince: DateTime.new(2016, 1, 1).to_s)
+
+# To return a collection of all certificates awarded to a user
+course.certificates
+# Available filters for certificates include includeExpired, acquiredDate, and expiryDate
+course.certificates(includeExpired: true)
+# To return a single certificate for a specific course
+course.find_certificate(id)
+
+# To return a collection of chapters for a specific course
+course.chapters
+# To return a single chapters for a specific course
+course.find_chapter(id)
+```
+
+  To return a collection of associated enrollments given a collection of courses
+  ```ruby
+  AbsorbApi::Course.enrollments_from_collection(AbsorbApi::Course.all)
+  ```
+
+### Category
+```ruby
+# To return a collection of all available categories
+AbsorbApi::Category.all
+
+# To find a single category by id:
+AbsorbApi::Category.find(id)
+```
+
+### Certificate
+```ruby
+# To find a single certificate by id
+AbsorbApi::Certificate.find(id)
+```
+
+### Chapter
+```ruby
+# To return a collection of all available chapters
+AbsorbApi::Chapter.all
+
+# To find a single chapter by id
+AbsorbApi::Chapter.find(id)
+```
+
+### Curriculum
+```ruby
+# To return a collection of all available curriculums
+AbsorbApi::Curriculum.all
+
+# To find a single curriculum by id
+AbsorbApi::Curriculum.find(id)
+```
+
+### Department
+```ruby
+# To return a collection of all available departments
+AbsorbApi::Department.all
+
+# To find a single department by id
+AbsorbApi::Department.find(id)
+
+# To return a collection of departments matching conditions
+AbsorbApi::Department.where(conditions)
+# available conditions include departmentName, and externalId
+AbsorbApi::Department.where(departmentName: "Technology")
+
+# To return the parent department
+department.parent
+
+# To create a new department
+AbsorbApi::Department.create(name: "Test Department", parent_id: 1)
+# or
+AbsorbApi::Department.create do |department|
+  department.name = "Test Department"
+  department.parent_id = 1
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/npezza93/absorb_api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/absorb_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'absorb_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "absorb_api"
+  spec.version       = AbsorbApi::VERSION
+  spec.authors       = ["npezza93"]
+  spec.email         = ["npezza93@gmail.com"]
+
+  spec.summary       = "API wrapper for Absorb LMS"
+  spec.description   = "\"Absorb LMS is a powerful, flexible, and visually stunning software platform teamed with expert implementation and support to help you build the training programs your business needs. Whether your old LMS is slowing you down or you’ve outgrown your current training model, Absorb can help.
+  \""
+  spec.homepage      = "https://github.com/npezza93/absorb_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

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

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/doc/AbsorbApi.html

@@ -0,0 +1,216 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module AbsorbApi - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+    
+    
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    
+    <li ><a href="#method-c-configure">::configure</a>
+    
+    <li ><a href="#method-c-reset">::reset</a>
+    
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="module-AbsorbApi">
+  <h1 id="module-AbsorbApi" class="module">
+    module AbsorbApi
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+    <section class="constants-list">
+      <header>
+        <h3>Constants</h3>
+      </header>
+      <dl>
+      
+        <dt id="VERSION">VERSION
+        
+        <dd>
+        
+      
+      </dl>
+    </section>
+    
+
+    
+    <section class="attribute-method-details" class="method-section">
+      <header>
+        <h3>Attributes</h3>
+      </header>
+
+      
+      <div id="attribute-c-configuration" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">configuration</span><span
+            class="attribute-access-type">[RW]</span>
+        </div>
+
+        <div class="method-description">
+        
+        
+        
+        </div>
+      </div>
+      
+    </section>
+    
+
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+    
+      <div id="method-c-configure" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">configure</span><span
+            class="method-args">() { |configuration| ... }</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="configure-source">
+            <pre><span class="ruby-comment"># File lib/absorb_api/configuration.rb, line 18</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">configure</span>
+  <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">configuration</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-c-reset" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">reset</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="reset-source">
+            <pre><span class="ruby-comment"># File lib/absorb_api/configuration.rb, line 14</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reset</span>
+  <span class="ruby-ivar">@configuration</span> = <span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">new</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+