litmos-api-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecdf099ae1e471f13510b157b2a7e38c2fd0138e
+  data.tar.gz: eeaa1ee2fa0c714d02627c5533740e3d70d01c39
+SHA512:
+  metadata.gz: ddd84109cb3688698653140fd22589f1e37e57023289e8aa18da368fa029b48f026062ed208934fc7b2ad980793c55b49d302defde6ea1427c7c416c89b3ae98
+  data.tar.gz: 4fadad3e458519f2da0280e73725c1af89ef12ff92e013e2caf1c3163ab150d4a775fbd632efe5d8107f4284546da98771167bfaf96152bf1eebb1e10679fa63

data/lib/litmos-api-client.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/litmos_api_client'

data/lib/litmos_api_client.rb

@@ -0,0 +1,234 @@
+require 'rest_client'
+require 'json'
+
+require File.dirname(__FILE__) + '/litmos_api_client/users'
+require File.dirname(__FILE__) + '/litmos_api_client/teams'
+require File.dirname(__FILE__) + '/litmos_api_client/courses'
+
+module LitmosApiClient
+  class NotFound < Exception; end
+  class ApiError < Exception; end
+  class ArgumentError < Exception; end
+  
+  class API
+    include LitmosApiClient::Users
+    include LitmosApiClient::Teams
+    include LitmosApiClient::Courses
+
+    # Litmos Developer API Documentation: http://help.litmos.com/developer-api/
+    API_VERSION = "1"
+    def initialize(api_key, source, config = {})
+      raise ArgumentError.new('Your need to specify your api key') unless api_key
+      raise ArgumentError.new('You need to specify a source website') unless source
+
+      defaults = {
+        :api_version        => API_VERSION
+      }
+
+      @config = defaults.merge(config).freeze
+      @api_key = api_key
+      @source = source
+      @litmosURL = "https://api.litmos.com/v#{@config[:api_version]}.svc"
+    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
+          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)
+
+        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 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?
+
+      dont_parse_response = params.delete(:dont_parse_response)
+      
+      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
+
+          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)
+
+        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 put(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?
+
+      dont_parse_response = params.delete(:dont_parse_response)
+      
+      options = {
+        :content_type => :json, 
+        :accept => :json, 
+      }
+
+      RestClient.put("#{@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
+
+          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)
+
+        else
+          puts response.code
+          # 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={})
+      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
+
+          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)
+
+        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
+
+  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
+
+    # for de-camelCasing the result keys
+    # from: http://stackoverflow.com/questions/8706930/converting-nested-hash-keys-from-camelcase-to-snake-case-in-ruby
+
+    def underscore(string)
+      string.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+
+    def underscore_key(k)
+      underscore(k.to_s).to_sym
+    end
+
+    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) }
+          # or `value.map(&method(:convert_hash_keys))`
+        when Hash
+          Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+        else
+          value
+       end
+    end
+  end
+end

data/lib/litmos_api_client/courses.rb

@@ -0,0 +1,25 @@
+module LitmosApiClient
+  module Courses
+    def courses(params={})
+      get :courses, params
+    end
+
+    def find_course_by_id(id)
+      get("courses/#{id}")
+    rescue NotFound
+      nil
+    end
+
+    def reset_user_course(options={})
+      raise ArgumentError.new(":user_id is required") if options[:user_id].blank?
+      raise ArgumentError.new(":course_id is required") if options[:course_id].blank?
+
+      put("/users/#{options[:user_id]}/courses/#{options[:course_id]}/reset")
+    end
+    def find_courses_by_user_id(id)
+      get("users/#{id}/courses")
+    rescue NotFound
+      nil
+    end
+  end
+end

data/lib/litmos_api_client/teams.rb

@@ -0,0 +1,37 @@
+module LitmosApiClient
+  module Teams
+    def teams(options={})
+      get :teams, options
+    end
+
+    def find_team_by_id(id)
+      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_api_client/users.rb

@@ -0,0 +1,40 @@
+module LitmosApiClient
+  module Users
+    def users(params={})
+      get(:users, params)
+    end
+
+    def find_user_by_id(id)
+      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
+
+    def delete_user(id)
+      delete "users/#{id}"
+    end
+
+    def update_user(id, options={})
+      put "users/#{id}", options
+    end
+  end
+end

data/litmos-api-client.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = 'litmos-api-client'
+  s.version     = '0.0.2'
+  s.date        = '2014-05-09'
+  s.summary     = "Simple lib to consume litmos api"
+  s.description = "Simple lib to consume litmos api from litmos platform"
+  s.authors     = ["Fabien Garcia"]
+  s.email       = 'fab0670312047@gmail.com'
+  s.files       = ["lib/litmos-api-client.rb"]
+  s.files = [
+    "lib/litmos-api-client.rb",
+    "lib/litmos_api_client.rb",
+    "lib/litmos_api_client/courses.rb",
+    "lib/litmos_api_client/teams.rb",
+    "lib/litmos_api_client/users.rb",
+    "litmos-api-client.gemspec"
+  ]
+  s.homepage    =
+    'http://rubygems.org/gems/hola'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency 'rest-client', '>= 0'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: litmos-api-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Fabien Garcia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+description: Simple lib to consume litmos api from litmos platform
+email: fab0670312047@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/litmos-api-client.rb
+- lib/litmos_api_client.rb
+- lib/litmos_api_client/courses.rb
+- lib/litmos_api_client/teams.rb
+- lib/litmos_api_client/users.rb
+- litmos-api-client.gemspec
+homepage: http://rubygems.org/gems/hola
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple lib to consume litmos api
+test_files: []