litmos-client 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    litmos-client (0.0.4)
+    litmos-client (0.0.5)
       json
       litmos-client
       rest-client

data/README.rdoc

@@ -44,8 +44,7 @@ For methods that aren't yet implemented in the gem, you can simply use the *get*
 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
-* Support for creating objects and other http verbs (PUT, POST)
+* Figure out how to write a test suite for a live API!
 
 == Contributing to litmos-client
  

data/Rakefile

@@ -15,7 +15,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "litmos-client"
   gem.homepage = "http://github.com/kennon/litmos-client"
   gem.license = "MIT"
-  gem.version = "0.0.4"
+  gem.version = "0.0.5"
   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"

data/lib/litmos_client/teams.rb

@@ -17,8 +17,8 @@ module LitmosClient
     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?
+      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]
@@ -28,8 +28,8 @@ module LitmosClient
     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?
+      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

data/lib/litmos_client.rb

@@ -34,18 +34,28 @@ module LitmosClient
     end
 
     def get(path, params={})
+      dont_parse_response = params.delete(:dont_parse_response)
+
       options = {
         :content_type => :json, 
         :accept => :json, 
         :params => params.merge(:apikey => @api_key, :source => @source)
       }
+
       RestClient.get("#{@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))
-
+          if response.blank?
+            true
+          else
+            if dont_parse_response
+              response
+            else
+              parse_response(response)
+            end
+          end
         when 404 # 404 Not Found. The User/Course etc that you requested does not exist
           raise NotFound.new(response)
 
@@ -63,6 +73,8 @@ module LitmosClient
       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?
+
+      dont_parse_response = params.delete(:dont_parse_response)
       
       options = {
         :content_type => :json, 
@@ -74,7 +86,16 @@ module LitmosClient
         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))
+
+          if response.blank?
+            true
+          else
+            if dont_parse_response
+              response
+            else
+              parse_response(response)
+            end
+          end
 
         when 404 # 404 Not Found. The User/Course etc that you requested does not exist
           raise NotFound.new(response)
@@ -90,17 +111,29 @@ module LitmosClient
     end
 
     def delete(path, params={})
+      dont_parse_response = params.delete(:dont_parse_response)
+
       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))
+
+          if response.blank?
+            true
+          else
+            if dont_parse_response
+              response
+            else
+              parse_response(response)
+            end
+          end
 
         when 404 # 404 Not Found. The User/Course etc that you requested does not exist
           raise NotFound.new(response)
@@ -113,15 +146,20 @@ module LitmosClient
 
         end        
       end
-    end    
+    end
+
+  protected
+
+    ASP_DATE_REGEXP=/\/Date\(([0-9]+)\+[0-9]+\)\//
+
+    def parse_asp_date(asp_date)
+      DateTime.strptime(asp_date.gsub(ASP_DATE_REGEXP, '\1'), '%Q')
+    end
 
-  end
-  
-  module StringHelpers
     # for de-camelCasing the result keys
     # from: http://stackoverflow.com/questions/8706930/converting-nested-hash-keys-from-camelcase-to-snake-case-in-ruby
 
-    def self.underscore(string)
+    def underscore(string)
       string.gsub(/::/, '/').
       gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
       gsub(/([a-z\d])([A-Z])/,'\1_\2').
@@ -129,11 +167,19 @@ module LitmosClient
       downcase
     end
 
-    def self.underscore_key(k)
+    def underscore_key(k)
       underscore(k.to_s).to_sym
     end
 
-    def self.convert_hash_keys(value)
+    def parse_response(response)
+      convert_hash_keys(JSON.parse(response))
+    end
+
+    def convert_hash_keys(value)
+      if value.is_a?(String) and value =~ ASP_DATE_REGEXP
+        return parse_asp_date(value)
+      end
+
       case value
         when Array
           value.map { |v| convert_hash_keys(v) }
@@ -144,6 +190,7 @@ module LitmosClient
           value
        end
     end
+
   end
 
 end

data/litmos-client.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "litmos-client"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kennon Ballou"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: litmos-client
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Kennon Ballou