absorb_api 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3eb2f3a9b826a7ecace98a90ee361669a68c6a5
-  data.tar.gz: 40de4863fd8c9b706c802d778fbf6763b25b5748
+  metadata.gz: 2dfa1e14ebad755094867288a7c5002bc2eb4dbf
+  data.tar.gz: 6593c2baa36abb4193ce804015af31915e6a4527
 SHA512:
-  metadata.gz: 0200d4112113652248aa63b2b633bfac3860627afc44561c9715ac6c86ac355faa2cd4318f19071bae8b178ee78dc0c9f3a46943b9ac5619566951527962ac8d
-  data.tar.gz: 682411c891a5a79d2816a10c847fd0d300ca4dfb10a26af86b585d4abdc0921b8c70fda313bbbd747a4f8eb666b460481229ed0fe056345b2d44644624822816
+  metadata.gz: 9515b916444885ee7957287d45c24577da6a44a44dce19b43627f7a5b2f40003aacd2ce3c8716e7f626574bb1ee5180d72a28e5f139fc5fd54d73cf42e23e93d
+  data.tar.gz: 388b02e9defb0503e8fee389e15e093548ebced97331d8258d482619a1c0c280df05e600392c57c4228b367849cd1d40cc35c897831f7aff2d6c6c392eee1cbf

data/absorb_api.gemspec

@@ -4,21 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'absorb_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "absorb_api"
+  spec.name          = 'absorb_api'
   spec.version       = AbsorbApi::VERSION
-  spec.authors       = ["npezza"]
-  spec.email         = ["npezza93@gmail.com"]
+  spec.authors       = ['npezza']
+  spec.email         = ['npezza93@gmail.com']
 
-  spec.summary       = "API wrapper for Absorb LMS"
-  spec.description   = "This gem provides a ruby wrapper for Absorb's Learning Management System API. \n\n"
-  spec.homepage      = "https://github.com/npezza93/absorb_api"
-  spec.license       = "MIT"
+  spec.summary       = 'API wrapper for Absorb LMS'
+  spec.description   = 'This gem provides a ruby wrapper for Absorb\'s Learning Management System API. \n\n'
+  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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/absorb_api.rb

@@ -5,48 +5,30 @@ 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/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"
-require "absorb_api/tag"
-require "absorb_api/session_schedule"
-require "absorb_api/role"
-require "absorb_api/resource"
-require "absorb_api/prerequisite"
-require "absorb_api/lesson"
+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'
+require 'absorb_api/tag'
+require 'absorb_api/session_schedule'
+require 'absorb_api/role'
+require 'absorb_api/resource'
+require 'absorb_api/prerequisite'
+require 'absorb_api/lesson'
+require 'absorb_api/authorize'
+require 'absorb_api/api'
 
 module AbsorbApi
-  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

data/lib/absorb_api/api.rb

@@ -0,0 +1,16 @@
+module AbsorbApi
+  class Api
+    attr_reader :connection, :token
+
+    def initialize
+      @token = AbsorbApi::Authorize.new.token
+
+      @connection ||= 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' => @token }
+      end
+    end
+  end
+end

data/lib/absorb_api/authorize.rb

@@ -0,0 +1,17 @@
+module AbsorbApi
+  class Authorize
+    attr_reader :token
+
+    def initialize
+      @token ||= 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
+  end
+end

data/lib/absorb_api/course.rb

@@ -2,7 +2,13 @@ module AbsorbApi
   class Course < Base
     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
+    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
@@ -15,9 +21,14 @@ module AbsorbApi
     # all calls are called in parallel
     def self.enrollments_from_collection(courses, **conditions)
       enrollments = []
-      AbsorbApi.api.in_parallel do
-        courses.reject { |course| AbsorbApi.configuration.ignored_course_ids.include? course.id }.each do |course|
-          enrollments << AbsorbApi.api.get("courses/#{course.id}/enrollments", conditions)
+      connection = AbsorbApi::Api.new.connection
+      courses.reject! do |course|
+        AbsorbApi.configuration.ignored_course_ids.include? course.id
+      end
+
+      connection.in_parallel do
+        courses.each do |course|
+          enrollments << connection.get("courses/#{course.id}/enrollments", conditions)
         end
       end
       enrollments.map { |response| response.body.map { |attrs| CourseEnrollment.new(attrs) } }.flatten

data/lib/absorb_api/course_enrollment.rb

@@ -3,7 +3,7 @@ module AbsorbApi
     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
 
     def lessons(**conditions)
-      AbsorbApi.api.get("users/#{self.user_id}/enrollments/#{self.course_id}/lessons", conditions).body.map! do |lesson_attributes|
+      AbsorbApi::Api.new.connection.get("users/#{self.user_id}/enrollments/#{self.course_id}/lessons", conditions).body.map! do |lesson_attributes|
         LessonEnrollment.new(lesson_attributes)
       end
     end
@@ -14,14 +14,22 @@ module AbsorbApi
     # modifiedSince must be a DateTime object
     def self.lessons_from_collection(course_enrollments, **filters)
       lessons = []
+      connection = AbsorbApi::Api.new.connection
       course_enrollments.each_slice(105) do |enrollment_slice|
-        AbsorbApi.api.in_parallel do
+        connection.in_parallel do
           enrollment_slice.each do |enrollment|
-            lessons << AbsorbApi.api.get("users/#{enrollment.user_id}/enrollments/#{enrollment.course_id}/lessons", filters)
+            lessons << connection.get("users/#{enrollment.user_id}/enrollments/#{enrollment.course_id}/lessons", filters)
           end
         end
       end
-      lessons.map { |response| response.body.map { |body| LessonEnrollment.new(body) } }.flatten.reject { |lesson| AbsorbApi.configuration.ignored_lesson_types.include? lesson.type }
+      lessons.map! do |response|
+        response.body.map do |body|
+          LessonEnrollment.new(body)
+        end
+      end
+      lessons.flatten.reject do |lesson|
+        AbsorbApi.configuration.ignored_lesson_types.include? lesson.type
+      end
     end
   end
 end

data/lib/absorb_api/orm.rb

@@ -9,7 +9,7 @@ module AbsorbApi
     class_methods do
       def find(id)
         raise ResourceNotFound if id.blank?
-        response = AbsorbApi.api.get("#{to_s.demodulize.pluralize}/#{id}")
+        response = AbsorbApi::Api.new.connection.get("#{to_s.demodulize.pluralize}/#{id}")
         if response.status == 404
           raise(RouteNotFound)
         elsif response.status == 400
@@ -20,15 +20,15 @@ module AbsorbApi
       end
 
       def all
-        response = AbsorbApi.api.get("#{to_s.demodulize.pluralize}")
+        response = AbsorbApi::Api.new.connection.get(to_s.demodulize.pluralize)
         if response.status == 404
           raise RouteNotFound
         elsif response.status == 400
           raise ResourceNotFound
         else
-          Collection.new( response.body.map! do |attributes|
+          Collection.new(response.body.map! do |attributes|
             new(attributes)
-          end, {klass: to_s.demodulize } )
+          end, klass: to_s.demodulize)
         end
       end
     end

data/lib/absorb_api/relations.rb

@@ -7,13 +7,13 @@ module AbsorbApi
         klass ||= rel_name
 
         define_method "#{rel_name.to_s}" do |**conditions|
-          AbsorbApi.api.get("#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name.to_s}", conditions).body.map! do |attributes|
+          AbsorbApi::Api.new.connection.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 = AbsorbApi.api.get("#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name.to_s}/#{child_id}")
+          response = AbsorbApi::Api.new.connection.get("#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name.to_s}/#{child_id}")
           if response.status == 400
             raise ResourceNotFound
           else
@@ -22,7 +22,7 @@ module AbsorbApi
         end
 
         define_method "#{rel_name.to_s.singularize}_ids" do
-          AbsorbApi.api.get("#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name.to_s}").body.map! do |attributes|
+          AbsorbApi::Api.new.connection.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
@@ -32,12 +32,12 @@ module AbsorbApi
         klass ||= rel_name
 
         define_method "#{rel_name.to_s}" do
-          "AbsorbApi::#{klass.to_s.classify}".constantize.new(AbsorbApi.api.get("#{klass.to_s.pluralize}/"+ send(rel_name.to_s + "_id")).body)
+          "AbsorbApi::#{klass.to_s.classify}".constantize.new(AbsorbApi::Api.new.connection.get("#{klass.to_s.pluralize}/"+ send(rel_name.to_s + "_id")).body)
         end
       end
 
       def where(**conditions)
-        Collection.new( AbsorbApi.api.get("#{to_s.demodulize.pluralize}", conditions).body.map! do |attributes|
+        Collection.new( AbsorbApi::Api.new.connection.get("#{to_s.demodulize.pluralize}", conditions).body.map! do |attributes|
           new(attributes)
         end, {klass: to_s.demodulize } )
       end
@@ -47,7 +47,7 @@ module AbsorbApi
         yield object if block_given?
         attrs = JSON.parse(object.to_json)
         attrs.keys.each { |k| attrs[ k.camelize ] = attrs.delete(k) }
-        response = AbsorbApi.api.post("#{to_s.demodulize.pluralize}", attrs)
+        response = AbsorbApi::Api.new.connection.post("#{to_s.demodulize.pluralize}", attrs)
         if response.status == 500
           raise ValidationError
         elsif response.status == 405

data/lib/absorb_api/user.rb

@@ -21,7 +21,7 @@ module AbsorbApi
       attrs.keys.each { |k| attrs[k.to_s.camelize] = attrs.delete(k) }
       attrs['Username'] = username
 
-      response = AbsorbApi.api.put("users/#{id}", attrs)
+      response = AbsorbApi::Api.new.connection.put("users/#{id}", attrs)
       raise ValidationError if response.status == 500
       raise RouteNotFound if response.status == 405
 
@@ -33,14 +33,17 @@ module AbsorbApi
     # users are chunked in groups of 105 to keep typhoeus from bogging down
     def self.courses_from_collection(users)
       courses = []
+      connection = AbsorbApi::Api.new.connection
       users.each_slice(105) do |user_slice|
-        AbsorbApi.api.in_parallel do
+        connection.in_parallel do
           user_slice.each do |user|
-            courses << AbsorbApi.api.get("users/#{user.id}/courses")
+            courses << connection.get("users/#{user.id}/courses")
           end
         end
       end
-      courses.map { |response| response.body.map { |body| Course.new(body) } }.flatten
+      courses.map do |response|
+        response.body.map { |body| Course.new(body) }
+      end.flatten
     end
   end
 end

data/lib/absorb_api/version.rb

@@ -1,3 +1,3 @@
 module AbsorbApi
-  VERSION = "0.1.11"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: absorb_api
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - npezza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: "This gem provides a ruby wrapper for Absorb's Learning Management System
-  API. \n\n"
+description: This gem provides a ruby wrapper for Absorb's Learning Management System
+  API. \n\n
 email:
 - npezza93@gmail.com
 executables: []
@@ -131,6 +131,8 @@ files:
 - doc/js/searcher.js.gz
 - doc/table_of_contents.html
 - lib/absorb_api.rb
+- lib/absorb_api/api.rb
+- lib/absorb_api/authorize.rb
 - lib/absorb_api/base.rb
 - lib/absorb_api/category.rb
 - lib/absorb_api/certificate.rb
@@ -172,9 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: API wrapper for Absorb LMS
 test_files: []
-has_rdoc: