litmos-client 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    litmos-client (0.0.3)
-      hashugar
+    litmos-client (0.0.4)
       json
       litmos-client
       rest-client
@@ -14,13 +13,12 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     git (1.2.5)
-    hashugar (0.0.6)
     i18n (0.6.0)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    json (1.7.4)
+    json (1.7.5)
     metaclass (0.0.1)
     mime-types (1.19)
     mocha (0.12.3)

data/README.rdoc

@@ -41,7 +41,7 @@ For methods that aren't yet implemented in the gem, you can simply use the *get*
 
 == Dependencies
 
-Litmos-client depends on the Rest-client[https://github.com/archiloque/rest-client], JSON, and Hashugar[https://github.com/jsuchal/hashugar] gems (should be automatically loaded via the gemspec).
+Litmos-client depends on the Rest-client[https://github.com/archiloque/rest-client], and JSON gems (should be automatically loaded via the gemspec).
 
 == TODO
 * Support for retrieving Teams and Courses

data/Rakefile

@@ -15,14 +15,13 @@ Jeweler::Tasks.new do |gem|
   gem.name = "litmos-client"
   gem.homepage = "http://github.com/kennon/litmos-client"
   gem.license = "MIT"
-  gem.version = "0.0.3"
+  gem.version = "0.0.4"
   gem.summary = %Q{Litmos-client is a Ruby wrapper for the Litmos API}
   gem.description = %Q{Litmos-Client is a Ruby gem that provides a wrapper for interacting with the Litmos Learning Management System API.}
   gem.email = "kennon@angryturnip.com"
   gem.authors = ["Kennon Ballou"]
   gem.add_dependency "rest-client"
   gem.add_dependency "json"
-  gem.add_dependency "hashugar"
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/lib/litmos_client.rb

@@ -1,6 +1,5 @@
 require 'rest_client'
 require 'json'
-require 'hashugar'
 
 require File.dirname(__FILE__) + '/litmos_client/users'
 require File.dirname(__FILE__) + '/litmos_client/teams'
@@ -9,6 +8,7 @@ require File.dirname(__FILE__) + '/litmos_client/courses'
 module LitmosClient
   class NotFound < Exception; end
   class ApiError < Exception; end
+  class ArgumentError < Exception; end
 
   class API
     include LitmosClient::Users
@@ -44,7 +44,7 @@ module LitmosClient
         when 200, 201 
           # 200 Success. User/Course etc updated, deleted or retrieved
           # 201 Success. User/Course etc created
-          return StringHelpers.convert_hash_keys(JSON.parse(response))
+          return response.blank? ? true : StringHelpers.convert_hash_keys(JSON.parse(response))
 
         when 404 # 404 Not Found. The User/Course etc that you requested does not exist
           raise NotFound.new(response)
@@ -58,6 +58,63 @@ module LitmosClient
         end        
       end
     end
+
+    def post(path, params={}, query_params={})
+      query_params = query_params.merge(:apikey => @api_key, :source => @source)
+      query_string = query_params.collect { |k,v| "#{k}=#{CGI::escape(v)}" }.join('&')
+      query_string = "?#{query_string}" unless query_string.blank?
+      
+      options = {
+        :content_type => :json, 
+        :accept => :json, 
+      }
+
+      RestClient.post("#{@litmosURL}/#{path}#{query_string}", params.to_json, options) do |response, request, result|
+        case response.code
+        when 200, 201 
+          # 200 Success. User/Course etc updated, deleted or retrieved
+          # 201 Success. User/Course etc created
+          return response.blank? ? true : StringHelpers.convert_hash_keys(JSON.parse(response))
+
+        when 404 # 404 Not Found. The User/Course etc that you requested does not exist
+          raise NotFound.new(response)
+
+        else
+          # 400 Bad Request. Check that your Uri and request body is well formed
+          # 403 Forbidden. Check your API key, HTTPS setting, Source parameter etc
+          # 409 Conflict. Often occurs when trying to create an item that already exists
+          raise ApiError.new(response)
+
+        end        
+      end
+    end
+
+    def delete(path, params={})
+      options = {
+        :content_type => :json, 
+        :accept => :json, 
+        :params => params.merge(:apikey => @api_key, :source => @source)
+      }
+      RestClient.delete("#{@litmosURL}/#{path}", options) do |response, request, result|
+        case response.code
+        when 200, 201 
+          # 200 Success. User/Course etc updated, deleted or retrieved
+          # 201 Success. User/Course etc created
+          return response.blank? ? true : StringHelpers.convert_hash_keys(JSON.parse(response))
+
+        when 404 # 404 Not Found. The User/Course etc that you requested does not exist
+          raise NotFound.new(response)
+
+        else
+          # 400 Bad Request. Check that your Uri and request body is well formed
+          # 403 Forbidden. Check your API key, HTTPS setting, Source parameter etc
+          # 409 Conflict. Often occurs when trying to create an item that already exists
+          raise ApiError.new(response)
+
+        end        
+      end
+    end    
+
   end
   
   module StringHelpers

data/lib/litmos_client/courses.rb

@@ -5,7 +5,13 @@ module LitmosClient
     end
 
     def find_course_by_id(id)
-      get("courses/#{id}").to_hashugar
+      get("courses/#{id}")
+    rescue NotFound
+      nil
+    end
+
+    def find_courses_by_user_id(id)
+      get("users/#{id}/courses")
     rescue NotFound
       nil
     end

data/lib/litmos_client/teams.rb

@@ -1,13 +1,37 @@
 module LitmosClient
   module Teams
-    def teams(params={})
-      get :teams, params
+    def teams(options={})
+      get :teams, options
     end
 
     def find_team_by_id(id)
-      get("teams/#{id}").to_hashugar
+      get("teams/#{id}")
     rescue NotFound
       nil
     end
+
+    def find_users_by_team_id(id)
+      get("teams/#{id}/users")
+    rescue NotFound
+      nil
+    end
+
+    def add_user_to_team(options={})
+      raise ArgumentError.new("team_id is required") if options[:team_id].blank?
+      raise ArgumentError.new("user_id is required") if options[:user_id].blank?
+
+      params = {
+        'Id' => options[:user_id]
+      }
+
+      post("teams/#{options[:team_id]}/users", [params])
+    end
+
+    def remove_user_from_team(options={})
+      raise ArgumentError.new("team_id is required") if options[:team_id].blank?
+      raise ArgumentError.new("user_id is required") if options[:user_id].blank?
+
+      delete("teams/#{options[:team_id]}/users/#{options[:user_id]}")
+    end
   end
 end

data/lib/litmos_client/users.rb

@@ -1,13 +1,32 @@
 module LitmosClient
   module Users
     def users(params={})
-      get :users, params
+      get(:users, params)
     end
 
     def find_user_by_id(id)
-      get("users/#{id}").to_hashugar
+      get("users/#{id}")
     rescue NotFound
       nil
     end
+
+    def create_user(options={})
+      raise ArgumentError.new(":username is required") if options[:username].blank?
+      raise ArgumentError.new(":first_name is required") if options[:first_name].blank?
+      raise ArgumentError.new(":last_name is required") if options[:last_name].blank?
+      raise ArgumentError.new(":email is required") if options[:email].blank?
+
+      params = {
+        'UserName' => options[:username],
+        'FirstName' => options[:first_name],
+        'LastName' => options[:last_name],
+        'Email' => options[:email],
+        'DisableMessages' => true,
+        'IsCustomUsername' => true,
+        'SkipFirstLogin' => true
+      }
+
+      post("users", params)
+    end
   end
 end

data/litmos-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "litmos-client"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kennon Ballou"]
-  s.date = "2012-08-21"
+  s.date = "2012-09-13"
   s.description = "Litmos-Client is a Ruby gem that provides a wrapper for interacting with the Litmos Learning Management System API."
   s.email = "kennon@angryturnip.com"
   s.extra_rdoc_files = [
@@ -59,7 +59,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<shoulda>, [">= 2.11.3"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<hashugar>, [">= 0"])
     else
       s.add_dependency(%q<litmos-client>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -74,7 +73,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<shoulda>, [">= 2.11.3"])
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<hashugar>, [">= 0"])
     end
   else
     s.add_dependency(%q<litmos-client>, [">= 0"])
@@ -90,7 +88,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<shoulda>, [">= 2.11.3"])
     s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<hashugar>, [">= 0"])
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: litmos-client
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Kennon Ballou
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-21 00:00:00 Z
+date: 2012-09-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -219,20 +219,6 @@ dependencies:
         version: "0"
   version_requirements: *id013
   name: json
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  requirement: &id014 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id014
-  name: hashugar
 description: Litmos-Client is a Ruby gem that provides a wrapper for interacting with the Litmos Learning Management System API.
 email: kennon@angryturnip.com
 executables: []