absorb_api 0.2.0 → 0.9.1

data/lib/absorb_api/relations.rb

@@ -1,60 +1,62 @@
+# frozen_string_literal: true
+
 module AbsorbApi
   module Relations
     extend ActiveSupport::Concern
 
-    class_methods do
-      def has_many(rel_name, klass = nil)
+    module ClassMethods
+      def with_many(rel_name, klass = nil)
         klass ||= rel_name
+        klass = klass.to_s
 
-        define_method "#{rel_name.to_s}" do |**conditions|
-          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_has_many_method(rel_name, klass)
+        define_has_many_finder_method(rel_name, klass)
+        define_has_many_ids_method(rel_name)
+      end
 
-        define_method "find_#{rel_name.to_s.singularize}" do |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
-            "AbsorbApi::#{klass.to_s.classify}".constantize.new(response.body)
-          end
-        end
+      def with_one(rel_name, klass = nil)
+        klass ||= rel_name
+        klass = klass.to_s
 
-        define_method "#{rel_name.to_s.singularize}_ids" do
-          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)
+        define_method rel_name.to_s do
+          path = "#{klass.pluralize}/" + send(rel_name.to_s + "_id")
+
+          response = get(path, ignore_resource_not_found: true)
+          return if response.blank?
+
+          "AbsorbApi::#{klass.classify}".constantize.new(response)
         end
       end
 
-      def has_one(rel_name, klass = nil)
-        klass ||= rel_name
+      private
 
-        define_method "#{rel_name.to_s}" do
-          "AbsorbApi::#{klass.to_s.classify}".constantize.new(AbsorbApi::Api.new.connection.get("#{klass.to_s.pluralize}/"+ send(rel_name.to_s + "_id")).body)
+      def define_has_many_method(rel_name, klass)
+        define_method rel_name.to_s do |**conditions|
+          get(
+            "#{self.class.to_s.demodulize.pluralize}/#{id}/#{rel_name}",
+            conditions.merge(ignore_resource_not_found: true)
+          ).map do |attrs|
+            "AbsorbApi::#{klass.classify}".constantize.new(attrs)
+          end.compact
         end
       end
 
-      def where(**conditions)
-        Collection.new( AbsorbApi::Api.new.connection.get("#{to_s.demodulize.pluralize}", conditions).body.map! do |attributes|
-          new(attributes)
-        end, {klass: to_s.demodulize } )
+      def define_has_many_finder_method(rel_name, klass)
+        define_method "find_#{rel_name.to_s.singularize}" do |child_id|
+          response = get(
+            "#{self.class.to_s.demodulize.pluralize}/#{id}/"\
+            "#{rel_name}/#{child_id}"
+          )
+
+          return if response.blank?
+
+          "AbsorbApi::#{klass.classify}".constantize.new(response)
+        end
       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 = AbsorbApi::Api.new.connection.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
+      def define_has_many_ids_method(rel_name)
+        define_method "#{rel_name.to_s.singularize}_ids" do
+          send(rel_name.to_s).map(&:id)
         end
       end
     end

data/lib/absorb_api/resource.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module AbsorbApi
-  class Resource < Base
+  class Resource < Record
     attr_accessor :id, :name, :file, :module_id
   end
 end

data/lib/absorb_api/role.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module AbsorbApi
-  class Role < Base
+  class Role < Record
     attr_accessor :id, :name, :description
   end
 end

data/lib/absorb_api/session_schedule.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module AbsorbApi
-  class SessionSchedule < Base
-    attr_accessor :id, :session_id, :venue_id, :venue_type, :venue_name, :date_start, :date_end, :time_zone_id, :meeting_id, :meeting_username, :meeting_password
+  class SessionSchedule < Record
+    attr_accessor :id, :session_id, :venue_id, :venue_type, :venue_name,
+                  :date_start, :date_end, :time_zone_id, :meeting_id,
+                  :meeting_username, :meeting_password
   end
 end

data/lib/absorb_api/tag.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module AbsorbApi
-  class Tag < Base
-    include Relations
-    
+  class Tag < Record
+    with_relationships
+    can_create
+
     attr_accessor :id, :name
   end
 end

data/lib/absorb_api/user.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module AbsorbApi
-  class User < Base
-    include Relations
+  class User < Record
+    with_relationships
+    can_create
+    can_search
 
     attr_accessor :id, :department_id, :first_name, :middle_name, :last_name,
                   :username, :password, :email_address, :cc_email_addresses,
@@ -12,38 +16,18 @@ module AbsorbApi
                   :is_instructor, :external_id, :supervisor_id, :decimal2,
                   :string1, :decimal1, :string2, :decimal3, :job_title
 
-    has_many :courses
-    has_many :enrollments, klass: :course_enrollment
-    has_many :certificates
-    has_many :resources
+    with_many :courses
+    with_many :enrollments, :course_enrollment
+    with_many :certificates
+    with_many :resources
 
     def update(attrs)
-      attrs.keys.each { |k| attrs[k.to_s.camelize] = attrs.delete(k) }
-      attrs['Username'] = username
+      attrs = attrs.with_indifferent_access.transform_keys(&:camelize)
+      attrs["Username"] = username
 
-      response = AbsorbApi::Api.new.connection.put("users/#{id}", attrs)
-      raise ValidationError if response.status == 500
-      raise RouteNotFound if response.status == 405
+      put("users/#{id}", attrs)
 
       self
     end
-
-    # 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 bogging down
-    def self.courses_from_collection(users)
-      courses = []
-      connection = AbsorbApi::Api.new.connection
-      users.each_slice(105) do |user_slice|
-        connection.in_parallel do
-          user_slice.each do |user|
-            courses << connection.get("users/#{user.id}/courses")
-          end
-        end
-      end
-      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,5 @@
+# frozen_string_literal: true
+
 module AbsorbApi
-  VERSION = "0.2.0"
+  VERSION = "0.9.1"
 end

data/lib/absorb_api/where.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module AbsorbApi
+  module Where
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def where(**conditions)
+        objs = api.get(to_s.demodulize.pluralize, conditions).map do |attrs|
+          new(attrs)
+        end
+
+        Collection.new(objs, klass: to_s.demodulize)
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: absorb_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.9.1
 platform: ruby
 authors:
 - npezza
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2017-07-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,8 +136,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: This gem provides a ruby wrapper for Absorb's Learning Management System
-  API. \n\n
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a ruby wrapper for Absorb's LearningManagement System
+  API.
 email:
 - npezza93@gmail.com
 executables: []
@@ -47,6 +159,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,6 +170,8 @@ files:
 - bin/console
 - bin/setup
 - doc/AbsorbApi.html
+- doc/AbsorbApi/Api.html
+- doc/AbsorbApi/Authorize.html
 - doc/AbsorbApi/Base.html
 - doc/AbsorbApi/Category.html
 - doc/AbsorbApi/Certificate.html
@@ -63,13 +180,16 @@ files:
 - doc/AbsorbApi/Configuration.html
 - doc/AbsorbApi/Course.html
 - doc/AbsorbApi/CourseEnrollment.html
+- doc/AbsorbApi/Create.html
 - doc/AbsorbApi/Curriculum.html
 - doc/AbsorbApi/Department.html
 - doc/AbsorbApi/Lesson.html
 - doc/AbsorbApi/LessonEnrollment.html
 - doc/AbsorbApi/Orm.html
 - doc/AbsorbApi/Prerequisite.html
+- doc/AbsorbApi/Record.html
 - doc/AbsorbApi/Relations.html
+- doc/AbsorbApi/Relations/ClassMethods.html
 - doc/AbsorbApi/Resource.html
 - doc/AbsorbApi/ResourceNotFound.html
 - doc/AbsorbApi/Role.html
@@ -78,9 +198,13 @@ files:
 - doc/AbsorbApi/Tag.html
 - doc/AbsorbApi/User.html
 - doc/AbsorbApi/ValidationError.html
+- doc/AbsorbApi/Where.html
+- doc/CODE_OF_CONDUCT_md.html
 - doc/Gemfile.html
 - doc/Gemfile_lock.html
+- "doc/Icon\r.html"
 - doc/LICENSE_txt.html
+- doc/Object.html
 - doc/README_md.html
 - doc/Rakefile.html
 - doc/absorb_api_gemspec.html
@@ -133,7 +257,6 @@ files:
 - 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
 - lib/absorb_api/chapter.rb
@@ -141,12 +264,13 @@ files:
 - lib/absorb_api/configuration.rb
 - lib/absorb_api/course.rb
 - lib/absorb_api/course_enrollment.rb
+- lib/absorb_api/create.rb
 - lib/absorb_api/curriculum.rb
 - lib/absorb_api/department.rb
 - lib/absorb_api/lesson.rb
 - lib/absorb_api/lesson_enrollment.rb
-- lib/absorb_api/orm.rb
 - lib/absorb_api/prerequisite.rb
+- lib/absorb_api/record.rb
 - lib/absorb_api/relations.rb
 - lib/absorb_api/resource.rb
 - lib/absorb_api/role.rb
@@ -154,6 +278,7 @@ files:
 - lib/absorb_api/tag.rb
 - lib/absorb_api/user.rb
 - lib/absorb_api/version.rb
+- lib/absorb_api/where.rb
 homepage: https://github.com/npezza93/absorb_api
 licenses:
 - MIT
@@ -174,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: API wrapper for Absorb LMS