lessonly-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 685801473282dac177c5b10f4c1a8ed916f7def482c892cb29191f6cf5678941
-  data.tar.gz: 6f0804275927087399b2ad01d93415204ec3c79fd4afc77d7d4cf846f7d047ff
+  metadata.gz: aad22b010e14c05c92e87774f6dc586f57c6de0a2e7caaf7381222f9d1bca7cb
+  data.tar.gz: dd8b9aa2986a1a049894a033c39693016c75edfb066afafc9bd5153c816ab3c5
 SHA512:
-  metadata.gz: aed4cacf823900924aa286c555e531df1c7f18e2666f118fce379964a19bcf2b7f78eb7de520cdb4f42544e3857aba8b85990c03c64ca4cd6768ff4e96690a00
-  data.tar.gz: 6f90abf488d237699dbcf2c687ca1956388f85416e2cc8b8c8c89bbe9a93652cb485a60dd1dc11db23af3592c73c77804b6d0698de72e83ceb6e9a67f11d7d72
+  metadata.gz: 3e6bb09474483a91ead312583078b7af92635944542253008f4f5b6a02093f7b03f229791ed43bc616b1dfb6f0be103ab6a8a74fac6f7a1887f293081753a220
+  data.tar.gz: 0c0499b7b5363f6772498c28ccbd80fd411f68c7061caa8919908d93bf3a78c00918385014bc3b3dea6a7237457bbe4cdf4b7e4b3fb2f7f2b900b31c404d49bb

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/lessonly-api.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec\/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'gem_config'
   spec.add_runtime_dependency 'activemodel', '>= 3.2'
   spec.add_runtime_dependency 'faraday', '>= 0.8'
+  spec.add_runtime_dependency 'gem_config'
   spec.add_runtime_dependency 'httpclient', '~> 2.8'
 
   spec.add_development_dependency 'bundler', '>= 2.1.2'
@@ -32,4 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.7'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.8'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'yard'
 end

data/lib/lessonly_api.rb

@@ -11,7 +11,7 @@ module LessonlyApi
 
     has :root_url,
         classes: String,
-        default: ENV['LESSONLY_ROOT_URL'] || 'https://api.lesson.ly/api/v1.1'
+        default: ENV['LESSONLY_ROOT_URL'] || 'https://api.lessonly.com/api/v1.1'
 
     has :domain,
         classes: String,
@@ -35,11 +35,28 @@ require 'lessonly_api/resource_type/base'
 require 'lessonly_api/request'
 
 require 'lessonly_api/users'
+require 'lessonly_api/groups'
+require 'lessonly_api/lessons'
+require 'lessonly_api/paths'
+require 'lessonly_api/assignments'
+require 'lessonly_api/tags'
 
 require 'lessonly_api/resource_type/users'
 require 'lessonly_api/resource_type/user'
+require 'lessonly_api/resource_type/groups'
+require 'lessonly_api/resource_type/group'
 require 'lessonly_api/resource_type/webhook'
+require 'lessonly_api/resource_type/lessons'
 require 'lessonly_api/resource_type/lesson'
+require 'lessonly_api/resource_type/lesson_assignments_completed'
+require 'lessonly_api/resource_type/links'
+require 'lessonly_api/resource_type/paths'
+require 'lessonly_api/resource_type/path'
+require 'lessonly_api/resource_type/tags'
+require 'lessonly_api/resource_type/tag'
+require 'lessonly_api/resource_type/assignments'
+require 'lessonly_api/resource_type/assignment'
+require 'lessonly_api/resource_type/group_assignment'
 require 'lessonly_api/resource_type/user_group'
 require 'lessonly_api/resource_type/user_assignments'
 require 'lessonly_api/resource_type/assignment'

data/lib/lessonly_api/assignments.rb

@@ -0,0 +1,10 @@
+module LessonlyApi
+  class Assignments < Request
+    class << self
+      def list(page: 1, per_page: 50)
+        raw_result = send_get('/assignments', page: page, per_page: per_page)
+        LessonlyApi::ResourceType::Assignments.new(raw_result)
+      end
+    end
+  end
+end

data/lib/lessonly_api/errors.rb

@@ -11,7 +11,7 @@ module LessonlyApi::Errors
     end
 
     def message
-      "#{self.class.name}: #{body['error_info']}"
+      "#{self.class.name}: #{body}"
     end
   end
 

data/lib/lessonly_api/groups.rb

@@ -1,59 +1,84 @@
 module LessonlyApi
   class Groups < Request
     class << self
+      # Retrieve all groups
+      # https://docs.lessonly.com/#list-groups
+      #
+      # @return [ResourceType::Groups] the response converted to a resource object
       def list
-        raw_result = get('/groups')
-        raw_result['groups'].map { |raw_group| ResourceType::Group.new(raw_group) }
+        raw_result = send_get('/groups')
+        LessonlyApi::ResourceType::Groups.new(raw_result)
       end
 
+      # Retrieve a listing of a groups members and managers.
+      # https://docs.lessonly.com/#show-group-details
+      #
+      # @param id [Integer] ID of the group
+      # @return [ResourceType::Group] the response converted to a resource object
       def show(id)
-        raw_result = get("/groups/#{id}")
+        raw_result = send_get("/groups/#{id}")
         LessonlyApi::ResourceType::Group.new(raw_result)
       end
 
+      # Create a group
+      # https://docs.lessonly.com/#create-group
+      #
+      # @param attributes [Hash] hash with group's attributes
+      # @return [ResourceType::Group] the response converted to a resource object
       def create(attributes = {})
-        raw_result = post("/users", attributes)
-        ResourceType::User.new(raw_result)
+        raw_result = send_post('/groups', attributes)
+        ResourceType::Group.new(raw_result)
       end
 
+      # Update a group
+      # https://docs.lessonly.com/#update-group
+      #
+      # @param id [Integer] ID of a group to update
+      # @param attributes [Hash] hash with group's attributes to update
+      # @return [ResourceType::Group] the response converted to a resource object
       def update(id, attributes = {})
-        raw_result = put("/users/#{id}", attributes)
-        ResourceType::User.new(raw_result)
+        raw_result = send_put("/groups/#{id}", attributes)
+        ResourceType::Group.new(raw_result)
       end
 
+      # Archive a group
+      # https://docs.lessonly.com/#archive-group
+      #
+      # @param id [Integer] ID of a group to archive
+      # @return [ResourceType::Group] the response converted to a resource object
       def archive(id)
-        raw_result = put("/users/#{id}/archive")
-        ResourceType::User.new(raw_result)
+        raw_result = send_put("/groups/#{id}/archive")
+        ResourceType::Group.new(raw_result)
       end
 
+      # Restore an archived group
+      # https://docs.lessonly.com/#restore-group
+      #
+      # @param id [Integer] ID of a group to restore
+      # @return [ResourceType::Group] the response converted to a resource object
       def restore(id)
-        raw_result = put("/users/#{id}/restore")
-        ResourceType::User.new(raw_result)
+        raw_result = send_put("/groups/#{id}/restore")
+        ResourceType::Group.new(raw_result)
       end
 
+      # Delete a group
+      # https://docs.lessonly.com/#delete-group
+      #
+      # @param id [Integer] ID of a group to delete
+      # @return [ResourceType::Group] the response converted to a resource object
       def delete(id)
-        raw_result = delete("/users/#{id}")
-        ResourceType::User.new(raw_result)
+        raw_result = send_delete("/groups/#{id}")
+        ResourceType::Group.new(raw_result)
       end
 
-      def user_groups(id)
-        raw_result = get("/users/#{id}/groups")
-        # ResourceType::User.new(raw_result)
-      end
-
-      def update_user_groups(id)
-        raw_result = get("/users/#{id}/groups")
-        # ResourceType::User.new(raw_result)
-      end
-
-      def user_assignments(id)
-        raw_result = get("/users/#{id}/assignments")
-        #
-      end
-
-      def create_user_assignments(id)
-        raw_result = get("/users/#{id}/assignments")
-        #
+      # Return a list of assignments for a given group
+      # https://docs.lessonly.com/#group-assignments
+      #
+      # @param id [Integer] ID of a group
+      # @return [ResourceType::GroupAssignments] the response converted to a resource object
+      def group_assignments(id)
+        raw_result = send_get("/groups/#{id}/assignments")
+        raw_result.map { |el| ResourceType::GroupAssignment.new(el) }
       end
     end
   end

data/lib/lessonly_api/lessons.rb

@@ -0,0 +1,88 @@
+module LessonlyApi
+  class Lessons < Request
+    class << self
+      # Retrieve all lessons
+      # https://docs.lessonly.com/#list-lessons
+      #
+      # @return [ResourceType::Lessons] the response converted to a resource object
+      def list
+        raw_result = send_get('/lessons')
+        ResourceType::Lessons.new(raw_result)
+      end
+
+      # Retrieve the lesson's information
+      # https://docs.lessonly.com/#show-lesson-details
+      #
+      # @param id [Integer] ID of the group
+      # @return [ResourceType::Lesson] the response converted to a resource object
+      def show(id)
+        raw_result = send_get("/lessons/#{id}")
+        ResourceType::Lesson.new(raw_result)
+      end
+
+      # Update a lesson
+      # https://docs.lessonly.com/#update-lesson
+      #
+      # @param id [Integer] ID of a lesson to update
+      # @param attributes [Hash] hash with lesson's attributes to update
+      # @return [ResourceType::Lesson] the response converted to a resource object
+      def update(id, attributes = {})
+        raw_result = send_put("/lessons/#{id}", attributes)
+        ResourceType::Lesson.new(raw_result)
+      end
+
+      # Archive a lesson
+      # https://docs.lessonly.com/#archive-lesson
+      #
+      # @param id [Integer] ID of a lesson to archive
+      # @return [ResourceType::Lesson] the response converted to a resource object
+      def archive(id)
+        raw_result = send_put("/lessons/#{id}/archive")
+        ResourceType::Lesson.new(raw_result)
+      end
+
+      # Restore an archived lesson
+      # https://docs.lessonly.com/#restore-lesson
+      #
+      # @param id [Integer] ID of a lesson to restore
+      # @return [ResourceType::Lesson] the response converted to a resource object
+      def restore(id)
+        raw_result = send_put("/lessons/#{id}/restore")
+        ResourceType::Lesson.new(raw_result)
+      end
+
+      # Retrieve all the assignments for a particular lesson
+      # https://docs.lessonly.com/#lesson-assignments
+      #
+      # @param id [Integer] ID of a lesson
+      # @param page [Integer] the number of the page
+      # @param per_page [Integer] the numer of records per page
+      # @return [ResourceType::LessonAssignment] the response converted to a resource object
+      def lesson_assignments(id, page: 1, per_page: 50)
+        raw_result = send_get("/lessons/#{id}/assignments", page: page, per_page: per_page)
+        ResourceType::Assignments.new(raw_result)
+      end
+
+      # Retrieves the number of completed assignments for a given lesson
+      # https://docs.lessonly.com/#lesson-completed-assignments-v1-1
+      #
+      # @param id [Integer] ID of a lesson
+      # @return [ResourceType::LessonAssignmentsCompleted] the response converted to a resource object
+      def lesson_completed_assignments(id)
+        raw_result = send_get("/lessons/#{id}/assignments/completed")
+        ResourceType::LessonAssignmentsCompleted.new(raw_result)
+      end
+
+      # Allow to make assignments to a particular lesson in the API
+      # https://docs.lessonly.com/#assign-lesson
+      #
+      # @param id [Integer] ID of a lesson
+      # @param assignments [Array] array with assignments' attributes to create
+      # @return [ResourceType::Assignments] the response converted to a resource object
+      def assign_lesson(id, assignments = [])
+        raw_result = send_post("/lessons/#{id}/assignments", assignments: assignments)
+        ResourceType::Assignments.new(raw_result)
+      end
+    end
+  end
+end

data/lib/lessonly_api/paths.rb

@@ -0,0 +1,10 @@
+module LessonlyApi
+  class Paths < Request
+    class << self
+      def list
+        raw_result = send_get('/paths')
+        LessonlyApi::ResourceType::Paths.new(raw_result)
+      end
+    end
+  end
+end

data/lib/lessonly_api/request.rb

@@ -2,7 +2,7 @@ class LessonlyApi::Request < LessonlyApi::ResourceType::Base
   delegate :get, :post, :client, to: :class
 
   class << self
-    delegate :get, :post, :put, :delete, to: :client
+    delegate :send_get, :send_post, :send_put, :send_delete, to: :client
 
     def client
       LessonlyApi::Utils::Client.instance

data/lib/lessonly_api/resource_type/assignment.rb

@@ -13,6 +13,7 @@ module LessonlyApi
         :updated_at,
         :status,
         :score
+        # TODO: i.kamenko how to handle `contents` for assigned Paths?
       )
     end
   end

data/lib/lessonly_api/resource_type/assignments.rb

@@ -0,0 +1,14 @@
+module LessonlyApi
+  module ResourceType
+    class Assignments < LessonlyApi::ResourceType::Base
+      fields(
+        :type,
+        :total_assignments,
+        :page,
+        :per_page,
+        :total_pages,
+        assignments: [:assignment]
+      )
+    end
+  end
+end

data/lib/lessonly_api/resource_type/base.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 require 'active_model'
+require 'active_support/core_ext/hash'
 require 'json'
 
 module LessonlyApi
   module ResourceType
     class Base
       include ActiveModel::Model
-      include ActiveModel::Dirty
-      include ActiveModel::Serializers::JSON
 
       class_attribute :fields_names
       self.fields_names = []

data/lib/lessonly_api/resource_type/group.rb

@@ -1,7 +1,16 @@
 module LessonlyApi
   module ResourceType
-    class Group < LessonlyApi::Resource
-      fields(:id, :name, :archived_at, :archived_by_user_id)
+    class Group < LessonlyApi::ResourceType::Base
+      fields(
+        :id,
+        :type,
+        :resource_type,
+        :name,
+        {members: [:user]},
+        {managers: [:user]},
+        {archived_at: :date_time},
+        :archived_by_user_id
+      )
     end
   end
 end

data/lib/lessonly_api/resource_type/group_assignment.rb

@@ -0,0 +1,12 @@
+module LessonlyApi
+  module ResourceType
+    class GroupAssignment < LessonlyApi::ResourceType::Base
+      fields(
+        :id,
+        :assignable_id,
+        :assignable_type,
+        :group_id
+      )
+    end
+  end
+end

data/lib/lessonly_api/resource_type/groups.rb

@@ -1,7 +1,7 @@
 module LessonlyApi
   module ResourceType
-    class Groups < LessonlyApi::Resource
-      fields(:id, :name, :archived_at, :archived_by_user_id)
+    class Groups < LessonlyApi::ResourceType::Base
+      fields(:type, groups: [:group])
     end
   end
 end

data/lib/lessonly_api/resource_type/lesson.rb

@@ -1,7 +1,21 @@
 module LessonlyApi
   module ResourceType
     class Lesson < LessonlyApi::ResourceType::Base
-      fields(:id, :title, :archived_at, :archived_by_user_id)
+      fields(
+        :id,
+        :type,
+        :description,
+        :resource_type,
+        :title,
+        {archived_at: :date_time},
+        :archived_by_user_id,
+        :retake_score,
+        :public,
+        {created_at: :date_time},
+        {last_updated_at: :date_time},
+        {links: :links},
+        tags: [:tag],
+      )
     end
   end
 end

data/lib/lessonly_api/resource_type/lesson_assignments_completed.rb

@@ -0,0 +1,10 @@
+module LessonlyApi
+  module ResourceType
+    class LessonAssignmentsCompleted < LessonlyApi::ResourceType::Base
+      fields(
+        :type,
+        :completed_count
+      )
+    end
+  end
+end

data/lib/lessonly_api/resource_type/lessons.rb

@@ -0,0 +1,7 @@
+module LessonlyApi
+  module ResourceType
+    class Lessons < LessonlyApi::ResourceType::Base
+      fields(:type, lessons: [:lesson])
+    end
+  end
+end

data/lib/lessonly_api/resource_type/links.rb

@@ -0,0 +1,10 @@
+module LessonlyApi
+  module ResourceType
+    class Links < LessonlyApi::ResourceType::Base
+      fields(
+        :overview,
+        :shareable
+      )
+    end
+  end
+end

data/lib/lessonly_api/resource_type/path.rb

@@ -0,0 +1,21 @@
+module LessonlyApi
+  module ResourceType
+    class Path < LessonlyApi::ResourceType::Base
+      fields(
+        :resource_type,
+        :type,
+        :id,
+        :title,
+        :archived_at,
+        :archived_by_user_id,
+        :public,
+        :created_at,
+        :last_updated_at,
+        :published_at,
+        :publisher_id,
+        {tags: [:tag]},
+        {links: :links}
+      )
+    end
+  end
+end

data/lib/lessonly_api/resource_type/paths.rb

@@ -0,0 +1,7 @@
+module LessonlyApi
+  module ResourceType
+    class Paths < LessonlyApi::ResourceType::Base
+      fields(:type, paths: [:path])
+    end
+  end
+end

data/lib/lessonly_api/resource_type/tag.rb

@@ -0,0 +1,12 @@
+module LessonlyApi
+  module ResourceType
+    class Tag < LessonlyApi::ResourceType::Base
+      fields(
+        :id,
+        :type,
+        :resource_type,
+        :name
+      )
+    end
+  end
+end

data/lib/lessonly_api/resource_type/tags.rb

@@ -0,0 +1,7 @@
+module LessonlyApi
+  module ResourceType
+    class Tags < LessonlyApi::ResourceType::Base
+      fields(:type, tags: [:tag])
+    end
+  end
+end

data/lib/lessonly_api/resource_type/user.rb

@@ -1,6 +1,67 @@
 module LessonlyApi
   module ResourceType
+    # Class represents API response as a Ruby object.
     class User < LessonlyApi::ResourceType::Base
+      # @!method id
+      # @return [Integer] ID of the user
+
+      # @!method resource_type
+      # @return [String] type of the resource
+
+      # @!method type
+      # @return [String] type of the resource
+
+      # @!method ext_uid
+      # @return [String] external ID of the user
+
+      # @!method email
+      # @return [String] an email of the user
+
+      # @!method name
+      # @return [String] a name of the user
+
+      # @!method role
+      # @return [String] a role of the user
+
+      # @!method role_id
+      # @return [Integer] ID of a user's role
+
+      # @!method archived_at
+      # @return [DateTime] timestamp of the user's archiving
+
+      # @!method archived_by_user_id
+      # @return [Inteher] ID of a user who archived the given user
+
+      # @!method job_title
+      # @return [String] title of the user's job
+
+      # @!method business_unit
+      # @return [String] business unit the user
+
+      # @!method department
+      # @return [String] name of the user's department
+
+      # @!method location
+      # @return [String] location of the user
+
+      # @!method locale
+      # @return [String] locale of the user
+
+      # @!method hire_date
+      # @return [Date] date of the user's hire
+
+      # @!method manager_name
+      # @return [String] name of the user's manager
+
+      # @!method mobile_phone_number
+      # @return [String] phone number of the user
+
+      # @!method custom_user_field_data
+      # @return [Array] array of hashes with custom fields
+
+      # @!method groups
+      # @return [ResourceType::UserGroup] the list of a user’s group memberships and groups the user is  managing
+
       fields(
         :id,
         :resource_type,
@@ -10,23 +71,19 @@ module LessonlyApi
         :name,
         :role,
         :role_id,
-        :archived_at,
+        {archived_at: :date_time},
         :archived_by_user_id,
         :job_title,
         :business_unit,
         :department,
         :location,
         :locale,
-        :hire_date,
+        {hire_date: :date},
         :manager_name,
         :mobile_phone_number,
         :custom_user_field_data,
         {groups: :user_group}
       )
-
-      def user_assignments
-        LessonlyApi::Users.user_assignments(self.id)
-      end
     end
   end
 end

data/lib/lessonly_api/tags.rb

@@ -0,0 +1,24 @@
+module LessonlyApi
+  class Tags < Request
+    class << self
+      # Retrieve all tags
+      # https://docs.lessonly.com/#list-tags
+      #
+      # @return [ResourceType::Tags] the response converted to a resource object
+      def list
+        raw_result = send_get('/tags')
+        LessonlyApi::ResourceType::Tags.new(raw_result)
+      end
+
+      # Retrieve the tag's information
+      # https://docs.lessonly.com/#show-tag-details
+      #
+      # @param id [Integer] ID of the tag
+      # @return [ResourceType::Tag] the response converted to a resource object
+      def show(id)
+        raw_result = send_get("/tags/#{id}")
+        ResourceType::Tag.new(raw_result)
+      end
+    end
+  end
+end

data/lib/lessonly_api/users.rb

@@ -1,59 +1,122 @@
 module LessonlyApi
+  # The collection of methods to fetch users' data.
   class Users < Request
     class << self
+      # Retrieve all users
+      # https://docs.lessonly.com/#list-users
+      #
+      # @param page [Integer] the number of the page
+      # @param per_page [Integer] the numer of records per page
+      # @param filters [Hash] additional filters
+      # @return [ResourceType::Users] the response converted to a resource object
       def list(page: 1, per_page: 50, **filters)
-        raw_result = get('/users', page: page, per_page: per_page, filter: filters)
+        raw_result = send_get('/users', page: page, per_page: per_page, filter: filters)
         ResourceType::Users.new(raw_result)
       end
 
+      # Retrieve all the user's details including their custom field data
+      # https://docs.lessonly.com/#show-user-details
+      #
+      # @param id [Integer] ID of the user
+      # @return [ResourceType::User] the response converted to a resource object
       def show(id)
-        raw_result = get("/users/#{id}")
+        raw_result = send_get("/users/#{id}")
         LessonlyApi::ResourceType::User.new(raw_result)
       end
 
+      # Create a user
+      # https://docs.lessonly.com/#create-user
+      #
+      # @param attributes [Hash] hash with user's attributes
+      # @return [ResourceType::User] the response converted to a resource object
       def create(attributes = {})
-        raw_result = post("/users", attributes)
+        raw_result = send_post('/users', attributes)
         ResourceType::User.new(raw_result)
       end
 
+      # Update a user
+      # https://docs.lessonly.com/#update-user
+      #
+      # @param id [Integer] ID of a user to update
+      # @param attributes [Hash] hash with user's attributes to update
+      # @return [ResourceType::User] the response converted to a resource object
       def update(id, attributes = {})
-        raw_result = put("/users/#{id}", attributes)
+        raw_result = send_put("/users/#{id}", attributes)
         ResourceType::User.new(raw_result)
       end
 
+      # Archive a user
+      # https://docs.lessonly.com/#archive-user
+      #
+      # @param id [Integer] ID of a user to archive
+      # @return [ResourceType::User] the response converted to a resource object
       def archive(id)
-        raw_result = put("/users/#{id}/archive")
+        raw_result = send_put("/users/#{id}/archive")
         ResourceType::User.new(raw_result)
       end
 
+      # Restore an archived user
+      # https://docs.lessonly.com/#restore-user
+      #
+      # @param id [Integer] ID of a user to restore
+      # @return [ResourceType::User] the response converted to a resource object
       def restore(id)
-        raw_result = put("/users/#{id}/restore")
+        raw_result = send_put("/users/#{id}/restore")
         ResourceType::User.new(raw_result)
       end
 
-      # TODO: i.kamenko method name should be `delete` probably
-      def destroy(id)
-        raw_result = delete("/users/#{id}")
+      # Delete a user
+      # https://docs.lessonly.com/#delete-user
+      #
+      # @param id [Integer] ID of a user to delete
+      # @return [ResourceType::User] the response converted to a resource object
+      def delete(id)
+        raw_result = send_delete("/users/#{id}")
+        # TODO: there should be other type, possibly
         ResourceType::User.new(raw_result)
       end
 
+      # Return the list of a user’s group memberships and groups they are managing
+      # https://docs.lessonly.com/#user-groups
+      #
+      # @param id [Integer] ID of a user
+      # @return [ResourceType::UserGroup] the response converted to a resource object
       def user_groups(id)
-        raw_result = get("/users/#{id}/groups")
+        raw_result = send_get("/users/#{id}/groups")
+        # TODO: there should be other type, possibly
         ResourceType::UserGroup.new(raw_result)
       end
 
+      # Update a user’s involvement in various groups
+      # https://docs.lessonly.com/#update-user-groups
+      # 
+      # @param id [Integer] ID of a user
+      # @param attributes [Hash] hash with user's groups attributes to update
+      # @return [ResourceType::UserGroup] the response converted to a resource object
       def update_user_groups(id, attributes = {})
-        raw_result = put("/users/#{id}/groups", attributes)
+        raw_result = send_put("/users/#{id}/groups", attributes)
+        # TODO: there should be other type, possibly
         ResourceType::UserGroup.new(raw_result)
       end
 
+      # Return a list of assignments for a given user
+      # https://docs.lessonly.com/#user-assignments
+      #
+      # @param id [Integer] ID of a user
+      # @return [ResourceType::UserAssignments] the response converted to a resource object
       def user_assignments(id)
-        raw_result = get("/users/#{id}/assignments")
+        raw_result = send_get("/users/#{id}/assignments")
         ResourceType::UserAssignments.new(raw_result)
       end
 
+      # Create assignments for a user
+      # https://docs.lessonly.com/#create-user-assignments
+      #
+      # @param id [Integer] ID of a user
+      # @param assignments [Array] array with assignments' attributes to create
+      # @return [ResourceType::UserAssignments] the response converted to a resource object 
       def create_user_assignments(id, assignments = [])
-        raw_result = put("/users/#{id}/assignments", assignments: assignments)
+        raw_result = send_post("/users/#{id}/assignments", assignments: assignments)
         ResourceType::UserAssignments.new(raw_result)
       end
     end

data/lib/lessonly_api/utils/client.rb

@@ -34,19 +34,19 @@ module LessonlyApi
         @instance ||= new(LessonlyApi.configuration)
       end
 
-      def get(endpoint, params = {})
+      def send_get(endpoint, params = {})
         send_request(:get, endpoint, params)
       end
 
-      def post(endpoint, params = {})
+      def send_post(endpoint, params = {})
         send_request(:post, endpoint, params)
       end
 
-      def put(endpoint, params = {})
+      def send_put(endpoint, params = {})
         send_request(:put, endpoint, params)
       end
 
-      def delete(endpoint, params = {})
+      def send_delete(endpoint, params = {})
         send_request(:delete, endpoint, params)
       end
 

data/lib/lessonly_api/utils/custom_field_converter.rb

@@ -7,7 +7,8 @@ module LessonlyApi
     class CustomFieldConverter
       CONVERSIONS = {
         big_decimal: ->(val) { val.is_a?(BigDecimal) ? val : val && BigDecimal(val.to_s) },
-        date: ->(val) { val.is_a?(Date) ? val : val && Date.parse(val) }
+        date: ->(val) { val.is_a?(Date) ? val : val && Date.parse(val) },
+        date_time: ->(val) { val.is_a?(DateTime) ? val : val && DateTime.parse(val) }
       }.freeze
 
       def initialize(data_type)

data/lib/lessonly_api/version.rb

@@ -1,3 +1,3 @@
 module LessonlyApi
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: lessonly-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ilya Kamenko
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: gem_config
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: gem_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: yard
+  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: Ruby client for Lesson.ly API
 email:
 - ilya.kamenko@gmail.com
@@ -152,19 +194,32 @@ files:
 - bin/setup
 - lessonly-api.gemspec
 - lib/lessonly_api.rb
+- lib/lessonly_api/assignments.rb
 - lib/lessonly_api/errors.rb
 - lib/lessonly_api/groups.rb
+- lib/lessonly_api/lessons.rb
+- lib/lessonly_api/paths.rb
 - lib/lessonly_api/request.rb
 - lib/lessonly_api/resource_type/assignment.rb
+- lib/lessonly_api/resource_type/assignments.rb
 - lib/lessonly_api/resource_type/base.rb
 - lib/lessonly_api/resource_type/group.rb
+- lib/lessonly_api/resource_type/group_assignment.rb
 - lib/lessonly_api/resource_type/groups.rb
 - lib/lessonly_api/resource_type/lesson.rb
+- lib/lessonly_api/resource_type/lesson_assignments_completed.rb
+- lib/lessonly_api/resource_type/lessons.rb
+- lib/lessonly_api/resource_type/links.rb
+- lib/lessonly_api/resource_type/path.rb
+- lib/lessonly_api/resource_type/paths.rb
+- lib/lessonly_api/resource_type/tag.rb
+- lib/lessonly_api/resource_type/tags.rb
 - lib/lessonly_api/resource_type/user.rb
 - lib/lessonly_api/resource_type/user_assignments.rb
 - lib/lessonly_api/resource_type/user_group.rb
 - lib/lessonly_api/resource_type/users.rb
 - lib/lessonly_api/resource_type/webhook.rb
+- lib/lessonly_api/tags.rb
 - lib/lessonly_api/users.rb
 - lib/lessonly_api/utils/client.rb
 - lib/lessonly_api/utils/custom_field_converter.rb
@@ -174,7 +229,7 @@ homepage: https://github.com/toptal/lessonly-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby client for Lesson.ly API
 test_files: []