absorb_api 0.1.0

data/lib/absorb_api.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+require 'typhoeus/adapters/faraday'
+require 'json'
+require 'faraday_middleware'
+require 'active_support/all'
+require 'active_model'
+
+require "absorb_api/orm"
+require "absorb_api/relations"
+require "absorb_api/collection"
+
+require "absorb_api/version"
+require "absorb_api/configuration"
+require "absorb_api/base"
+require "absorb_api/user"
+require "absorb_api/course"
+require "absorb_api/course_enrollment"
+require "absorb_api/lesson_enrollment"
+require "absorb_api/category"
+require "absorb_api/certificate"
+require "absorb_api/chapter"
+require "absorb_api/curriculum"
+require "absorb_api/department"
+
+module AbsorbApi
+end

data/lib/absorb_api/base.rb

@@ -0,0 +1,31 @@
+module AbsorbApi
+  class Base
+    def initialize(attributes, &block)
+      attributes.each do |k,v|
+        instance_variable_set("@#{k.to_s.underscore}", v) unless v.nil?
+      end
+      yield self if block_given?
+    end
+
+    def self.authorize
+      @authorize ||= Faraday.new(:url => AbsorbApi.configuration.url) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :logger
+        faraday.adapter :typhoeus
+      end.post do |req|
+        req.url 'Authenticate', { username: AbsorbApi.configuration.absorbuser, password: AbsorbApi.configuration.absorbpass, privateKey: AbsorbApi.configuration.absorbkey }
+        req.headers['Content-Type'] = 'application/json'
+        req.headers["accept"] = "json"
+      end.body.delete('\\"')
+    end
+
+    def self.api
+      @api ||= Faraday.new(:url => AbsorbApi.configuration.url, :parallel_manager => Typhoeus::Hydra.new(:max_concurrency => 200)) do |faraday|
+        faraday.request :json
+        faraday.response :json, :content_type => /\bjson$/
+        faraday.adapter :typhoeus
+        faraday.headers = {"Authorization" => authorize }
+      end
+    end
+  end
+end

data/lib/absorb_api/category.rb

@@ -0,0 +1,7 @@
+module AbsorbApi
+  class Category < Base
+    include Orm
+    
+    attr_accessor :id, :parent_id, :name, :description
+  end
+end

data/lib/absorb_api/certificate.rb

@@ -0,0 +1,7 @@
+module AbsorbApi
+  class Certificate < Base
+    include Orm
+
+    attr_accessor :id, :enrollment_id, :full_name, :course_name, :acquired_date, :expiry_date, :notes
+  end
+end

data/lib/absorb_api/chapter.rb

@@ -0,0 +1,7 @@
+module AbsorbApi
+  class Chapter < Base
+    include Orm
+    
+    attr_accessor :id, :name, :lesson_ids
+  end
+end

data/lib/absorb_api/collection.rb

@@ -0,0 +1,19 @@
+module AbsorbApi
+  class Collection < ::Array
+    attr_reader :metadata
+
+    def initialize(elements, metadata = {})
+      super(elements)
+      @metadata = metadata
+    end
+
+    private
+      def method_missing(name, *args, &block)
+        # if klass.respond_to?(name)
+          # scoping { klass.send(name, *args) }
+        # else
+          super
+        # end
+      end
+  end
+end

data/lib/absorb_api/configuration.rb

@@ -0,0 +1,21 @@
+module AbsorbApi
+  class Configuration
+    attr_accessor :url, :absorbuser, :absorbpass, :absorbkey, :ignored_lesson_types, :ignored_course_ids
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/absorb_api/course.rb

@@ -0,0 +1,24 @@
+module AbsorbApi
+  class Course < Base
+    include Orm
+    include Relations
+
+    attr_accessor :id, :name, :description, :notes, :external_id, :access_date, :expire_type, :expire_duration, :expiry_date, :active_status, :tag_ids, :resource_ids, :editor_ids, :prices, :competency_definition_ids, :prerequisite_course_ids, :post_enrollment_course_ids, :allow_course_evaluation, :category_id, :certificate_url, :audience, :goals, :vendor, :company_cost, :learner_cost, :company_time, :learner_time
+
+    has_many :certificates
+    has_many :chapters
+    has_many :enrollments, :course_enrollment
+    
+    # gets all associated enrollments given a collection of courses
+    # all calls are called in parallel
+    def self.enrollments_from_collection(courses)
+      enrollments = []
+      api.in_parallel do
+        courses.reject { |course| AbsorbApi.configuration.ignored_course_ids.include? course.id }.each do |course|
+          enrollments << api.get("courses/#{course.id}/enrollments")
+        end
+      end
+      enrollments.map { |response| response.body.map { |attrs| CourseEnrollment.new(attrs) } }.flatten
+    end
+  end
+end

data/lib/absorb_api/course_enrollment.rb

@@ -0,0 +1,33 @@
+module AbsorbApi
+  class CourseEnrollment < Base
+    include Relations
+
+    attr_accessor :id, :course_id, :course_name, :course_version_id, :user_id, :full_name, :status, :progress, :score, :accepted_terms_and_conditions, :time_spent, :date_started, :date_completed, :enrollment_key_id, :certificate_id, :credits
+
+    # has_many :lessons, klass: :lesson_enrollment
+
+    def lessons
+      api.get("users/#{self.user_id}/enrollments/#{self.course_id}/lessons", { "modifiedSince" => "2016-01-01"}).body.map! do |lesson_attributes|
+        LessonEnrollment.new(lesson_attributes)
+      end
+    end
+
+    # gets all associated lessons given a collection of enrollments
+    # all calls are called in parallel
+    # enrollments are chunked in groups of 105 to keep typhoeus from getting bogged down
+    # modifiedSince must be a DateTime object
+    def self.lessons_from_collection(course_enrollments, modifiedSince)
+      if modifiedSince.is_a? DateTime
+        lessons = []
+        course_enrollments.each_slice(105) do |enrollment_slice|
+          api.in_parallel do
+            enrollment_slice.each do |enrollment|
+              lessons << api.get("users/#{enrollment.user_id}/enrollments/#{enrollment.course_id}/lessons", { "modifiedSince" => modifiedSince.to_s})
+            end
+          end
+        end
+        lessons.map { |response| response.body.map { |body| LessonEnrollment.new(body) } }.flatten.reject { |lesson| AbsorbApi.configuration.ignored_lesson_types.include? lesson.type }
+      end
+    end
+  end
+end

data/lib/absorb_api/curriculum.rb

@@ -0,0 +1,7 @@
+module AbsorbApi
+  class Curriculum < Base
+    include Orm
+
+    attr_accessor :is_pacing_enabled, :curriculum_group_ids, :id, :name, :description, :notes, :external_id, :access_date, :expire_type, :expire_duration, :expiry_date, :active_status, :tag_ids, :resource_ids, :editor_ids, :prices, :competency_definition_ids, :prerequisite_course_ids, :post_enrollment_course_ids, :allow_course_evaluation, :category_id, :certificate_url, :audience, :goals, :vendor, :company_cost, :learner_cost, :company_time, :learner_time
+  end
+end

data/lib/absorb_api/department.rb

@@ -0,0 +1,10 @@
+module AbsorbApi
+  class Department < Base
+    include Orm
+    include Relations
+
+    attr_accessor :id, :name, :use_department_contact_details, :company_name, :phone_number, :email_address, :external_id, :parent_id, :currency_id
+
+    has_one :parent, :department
+  end
+end

data/lib/absorb_api/lesson_enrollment.rb

@@ -0,0 +1,5 @@
+module AbsorbApi
+  class LessonEnrollment < Base
+    attr_accessor :lesson_id, :chapter_enrollment_id, :type, :attempts, :failures, :last_attempt, :id, :course_enrollment_id, :chapter_id, :session_id, :name, :user_id, :full_name, :status, :progress, :score, :time_spent, :date_enrolled, :date_started, :date_completed
+  end
+end

data/lib/absorb_api/orm.rb

@@ -0,0 +1,28 @@
+module AbsorbApi
+  class ResourceNotFound < StandardError; end
+  class RouteNotFound < StandardError; end
+  class ValidationError < StandardError; end
+
+  module Orm
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def find(id)
+        raise ResourceNotFound if id.blank?
+        response = Base.api.get("#{to_s.demodulize.pluralize}/#{id}")
+        response.status == 404 ? raise(ResourceNotFound) : new(response.body)
+      end
+
+      def all
+        response = Base.api.get("#{to_s.demodulize.pluralize}")
+        if response.status == 404
+          raise RouteNotFound
+        else
+          Collection.new( response.body.map! do |attributes|
+            new(attributes)
+          end, {klass: to_s.demodulize } )
+        end
+      end
+    end
+  end
+end

data/lib/absorb_api/relations.rb

@@ -0,0 +1,62 @@
+module AbsorbApi
+  module Relations
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_many(rel_name, klass = nil)
+        klass ||= rel_name
+
+        define_method "#{rel_name.to_s}" do |**conditions|
+          Base.api.get("#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name.to_s}", conditions).body.map! do |attributes|
+            "AbsorbApi::#{klass.to_s.classify}".constantize.new(attributes)
+          end
+        end
+
+        define_method "find_#{rel_name.to_s.singularize}" do |child_id|
+          response = Base.api.get("#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name.to_s}/#{child_id}")
+          if response.status == 400
+            raise ResourceNotFound
+          else
+            "AbsorbApi::#{klass.to_s.classify}".constantize.new(response.body)
+          end
+        end
+
+        define_method "#{rel_name.to_s.singularize}_ids" do
+          Base.api.get("#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name.to_s}").body.map! do |attributes|
+            "AbsorbApi::#{klass.to_s.classify}".constantize.new(attributes)
+          end.map(&:id)
+        end
+      end
+
+      def has_one(rel_name, klass = nil)
+        klass ||= rel_name
+
+        define_method "#{rel_name.to_s}" do
+          "AbsorbApi::#{klass.to_s.classify}".constantize.new(Base.api.get("#{klass.to_s.pluralize}/"+ send(rel_name.to_s + "_id")).body)
+        end
+      end
+
+      def where(**conditions)
+        Collection.new( Base.api.get("#{to_s.demodulize.pluralize}", conditions).body.map! do |attributes|
+          new(attributes)
+        end, {klass: to_s.demodulize } )
+      end
+
+      def create(attributes = [], &block)
+        object = to_s.classify.constantize.new(attributes)
+        yield object if block_given?
+        attrs = JSON.parse(object.to_json)
+        attrs.keys.each { |k| attrs[ k.camelize ] = attrs.delete(k) }
+        response = Base.api.post("#{to_s.demodulize.pluralize}", attrs)
+        if response.status == 500
+          raise ValidationError
+        elsif response.status == 405
+          raise RouteNotFound
+        else
+          object.id = response.body["Id"]
+          object
+        end
+      end
+    end
+  end
+end

data/lib/absorb_api/user.rb

@@ -0,0 +1,27 @@
+module AbsorbApi
+  class User < Base
+    include Orm
+    include Relations
+
+    attr_accessor :id, :department_id, :first_name, :middle_name, :last_name, :username, :password, :email_address, :cc_email_addresses, :language_id, :gender, :address, :address2, :city, :province_id, :country_id, :postal_code, :phone, :employee_number, :location, :job_title, :reference_number, :date_hired, :date_terminated, :notes, :custom_fields, :role_ids, :active_status, :is_learner, :is_admin, :is_instructor, :external_id, :supervisor_id
+
+    has_many :courses
+    has_many :enrollments, klass: :course_enrollment
+    has_many :certificates
+
+    # gets all associated courses given a collection of users
+    # all calls are called in parallel
+    # users are chunked in groups of 105 to keep typhoeus from getting bogged down
+    def self.courses_from_collection(users)
+      courses = []
+      users.each_slice(105) do |user_slice|
+        api.in_parallel do
+          user_slice.each do |user|
+            courses << api.get("users/#{user.id}/courses")
+          end
+        end
+      end
+      courses.map { |response| response.body.map { |body| Course.new(body) } }.flatten
+    end
+  end
+end

data/lib/absorb_api/version.rb

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

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: absorb_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- npezza93
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+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.
+    "
+email:
+- npezza93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- absorb_api.gemspec
+- bin/console
+- bin/setup
+- doc/AbsorbApi.html
+- doc/AbsorbApi/Base.html
+- doc/AbsorbApi/Category.html
+- doc/AbsorbApi/Certificate.html
+- doc/AbsorbApi/Chapter.html
+- doc/AbsorbApi/Collection.html
+- doc/AbsorbApi/Configuration.html
+- doc/AbsorbApi/Course.html
+- doc/AbsorbApi/CourseEnrollment.html
+- doc/AbsorbApi/Curriculum.html
+- doc/AbsorbApi/Department.html
+- doc/AbsorbApi/LessonEnrollment.html
+- doc/AbsorbApi/Orm.html
+- doc/AbsorbApi/Relations.html
+- doc/AbsorbApi/ResourceNotFound.html
+- doc/AbsorbApi/RouteNotFound.html
+- doc/AbsorbApi/User.html
+- doc/AbsorbApi/ValidationError.html
+- doc/Gemfile.html
+- doc/Gemfile_lock.html
+- doc/LICENSE_txt.html
+- doc/README_md.html
+- doc/Rakefile.html
+- doc/absorb_api_gemspec.html
+- doc/bin/setup.html
+- doc/created.rid
+- doc/css/fonts.css
+- doc/css/rdoc.css
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/navigation.js.gz
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/search_index.js.gz
+- doc/js/searcher.js
+- doc/js/searcher.js.gz
+- doc/table_of_contents.html
+- lib/absorb_api.rb
+- lib/absorb_api/base.rb
+- lib/absorb_api/category.rb
+- lib/absorb_api/certificate.rb
+- lib/absorb_api/chapter.rb
+- lib/absorb_api/collection.rb
+- lib/absorb_api/configuration.rb
+- lib/absorb_api/course.rb
+- lib/absorb_api/course_enrollment.rb
+- lib/absorb_api/curriculum.rb
+- lib/absorb_api/department.rb
+- lib/absorb_api/lesson_enrollment.rb
+- lib/absorb_api/orm.rb
+- lib/absorb_api/relations.rb
+- lib/absorb_api/user.rb
+- lib/absorb_api/version.rb
+homepage: https://github.com/npezza93/absorb_api
+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.4.8
+signing_key: 
+specification_version: 4
+summary: API wrapper for Absorb LMS
+test_files: []