docebo 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3910173bab38f394f3b9c1ba38f0689e8dcdd45
-  data.tar.gz: 85a4d55cbe28082752a7909071134c735c859d0a
+  metadata.gz: 3883b022f7625a9ce41ece2c0044138f888d7aec
+  data.tar.gz: 5330293da3c9cc42e58cdf810f542f6b46749872
 SHA512:
-  metadata.gz: 47a1e14a70edbf3c882a33fa5c95f879e0ec459f553224c5dac4fcf07ee8726ee8fc3f7dca174283a43c7ed0d7ee0f2f7c57660b9b7da34e5052d6945936475c
-  data.tar.gz: b75459dab6ffb06766b854b6d3c2ab6131ec21ee1de154d0c7ce5c0b43bdf770bc47aadf993a12581312505480863453c471dd23d6fc1547cde08bf01882574d
+  metadata.gz: 947b68778e5bf9a314ae081937d9ffe716beee49117058394fa27771554c7da84601c5f5e7d663100961d0c494123de004b7ee44cdde9ca75f15947cfb90d86f
+  data.tar.gz: 2ef3f22a19fb31964ec0559e2a1919e1cdf50a826b8b751703915cc66895fa560bf607a45a5783bfa464bd46261109f98c90a50534c6a985f0ab51e6ba0e047e

data/README.md

@@ -0,0 +1,58 @@
+DoceboRuby - Ruby wrapper for Decobo LMS API
+============================
+
+### Installation
+
+```sh
+gem install docebo
+```
+
+or add it to Gemfile
+
+```
+gem 'docebo', '~> 0.0.1'
+```
+
+### Usage
+
+```ruby
+api = Docebo::API.new(
+  key: 'key', 
+  secret: 'secret',
+  url: 'your_saas_platform/api'
+)
+
+results = api.make_request(
+  'user', 
+  'authenticate',
+  username: 'hello', 
+  password: 'hell'
+)
+
+# Course
+DoceboRuby::Course.all
+
+# User
+DoceboRuby::User.authenticate('john', 'Pa$$W0rd')
+DoceboRuby::User.check_username('john')
+DoceboRuby::User.sso_url('john')
+
+# OrgChart
+DoceboRuby::Orgchart.create_node(attributes)
+```
+
+### TODO
+
+Create User, Courses, etc. API classes.
+
+### Contributions
+
+1. Fork this repository.
+2. Create your own feature and spec.
+3. Create a pull request.
+
+To run test
+
+```sh
+rspec
+```

data/lib/docebo_ruby.rb

@@ -1,9 +1,18 @@
+require 'docebo_ruby/configuration'
+require 'docebo_ruby/api'
+require 'docebo_ruby/parameters'
+require 'docebo_ruby/resource'
+require 'docebo_ruby/course'
+require 'docebo_ruby/orgchart'
+require 'docebo_ruby/user'
+
 module DoceboRuby
+  if defined?(Rails)
+    require 'docebo_ruby/engine'
+  end
   class ArgumentError < Exception; end
   class NotFound < Exception; end
   class RequestError < Exception; end
 end
 
-require 'docebo_ruby/api'
-require 'docebo_ruby/parameters'
 

data/lib/docebo_ruby/api.rb

@@ -0,0 +1,64 @@
+require 'rest_client'
+require 'json'
+require 'digest/sha1'
+require 'base64'
+
+module DoceboRuby
+  class API
+    def initialize
+      @url = DoceboRuby.config.api_url
+      @key = DoceboRuby.config.api_key
+      @secret = DoceboRuby.config.api_secret
+    end
+
+    def send_request(api, method, params, &block)
+      raise ArgumentError.new('Please specify parameters') if params.nil?
+      parameters = Parameters.new params
+      options = request_options parameters
+      url = rest_url api, method
+
+      RestClient.post(url, params, options) do |raw_response|
+        case raw_response.code
+        when 200
+          response = parse_response raw_response
+          if block_given?
+            yield response 
+          else
+            return response
+          end
+        when 404
+          raise NotFound.new(response)
+        else
+          raise RequestError.new(response)
+        end        
+      end
+    end
+
+    protected
+
+    def parse_response(raw_response)
+      JSON.parse(raw_response)
+    end
+
+    def rest_url(api, method)
+      if api == '' || method == ''
+        raise ArgumentError.new('You need to specify a module / method') 
+      end
+      "#{@url}/#{api}/#{method}"
+    end
+
+    def code(parameters)
+      codice = Digest::SHA1.hexdigest "#{parameters.to_s},#{@secret}"
+      code = Base64.strict_encode64 "#{@key}:#{codice}"
+      "Docebo #{code}"
+    end
+
+    def request_options(parameters)
+      {
+        content_type: :json, 
+        accept: :json, 
+        'X-Authorization' => code(parameters)
+      }
+    end
+  end
+end

data/lib/docebo_ruby/configuration.rb

@@ -0,0 +1,43 @@
+# Copied from Kaminari::Config
+require 'active_support/configurable'
+
+module DoceboRuby
+  # Configures global settings for Docebo
+  #   DoceboRuby.configure do |config|
+  #     config.url = 'example.com'
+  #   end
+  def self.configure(&block)
+    yield @config ||= DoceboRuby::Configuration.new
+  end
+
+  # Global settings for DoceboRuby
+  def self.config
+    @config
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :saas_url
+    config_accessor :api_url
+    config_accessor :api_key
+    config_accessor :api_secret
+    config_accessor :sso_token
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+
+    # define param_name writer
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  configure do |config|
+    config.saas_url = 'example.com'
+    config.api_url = 'example.com'
+    config.api_key = 'TEST_KEY'
+    config.api_secret = 'TEST_SECRET'
+    config.sso_token = 'TEST_SSO'
+  end
+end

data/lib/docebo_ruby/course.rb

@@ -0,0 +1,14 @@
+module DoceboRuby
+  class Course < Resource
+    self.api = 'course'
+
+    class << self
+      def all
+        courses = fetch_data('listCourses') do |data|
+          data.delete_if { |key, value| key == 'success' }
+        end
+        courses.map { |key, value| Course.new value['course_info']  }
+      end
+    end
+  end
+end

data/lib/docebo_ruby/engine.rb

@@ -0,0 +1,3 @@
+module DoceboRuby
+  class Engine < ::Rails::Engine; end
+end

data/lib/docebo_ruby/orgchart.rb

@@ -0,0 +1,10 @@
+module DoceboRuby
+  class Orgchart < Resource
+    self.api = 'orgchart'
+    class << self
+      def create_node(attributes = {})
+        fetch_data('createNode', attributes)
+      end
+    end
+  end
+end

data/lib/docebo_ruby/parameters.rb

@@ -0,0 +1,11 @@
+module DoceboRuby
+  class Parameters
+    def initialize(hash)
+      @hash = hash.to_h
+    end
+
+    def to_s
+      @hash.values.join(',')
+    end
+  end
+end

data/lib/docebo_ruby/resource.rb

@@ -0,0 +1,19 @@
+module DoceboRuby
+  class Resource < OpenStruct
+    def self.api=(api)
+      @api = api
+    end
+
+    def self.api
+      @api
+    end
+
+    def self.fetch_data(method, params = {}, &block)
+      @fetcher = API.new
+      @fetcher.send_request(@api, method, params) do |result|
+        return result unless block_given?
+        yield result
+      end
+    end
+  end
+end

data/lib/docebo_ruby/user.rb

@@ -0,0 +1,27 @@
+module DoceboRuby
+  class User < Resource
+    self.api = 'user'
+
+    class << self
+      def create(attributes = {})
+        fetch_data('create', attributes)
+      end
+
+      def check_username(username)
+        fetch_data('checkUsername', {userid: username})['success']
+      end
+
+      def authenticate(username, password)
+        fetch_data('authenticate', {password: password, username: username}) do |response|
+          response['id_user'] || false
+        end
+      end
+
+      def sso_url(username)
+        timestamp = Time.now.to_i
+        token = Digest::MD5.hexdigest([username, timestamp, DoceboRuby.config.sso_token].join(','))
+        "http://#{DoceboRuby.config.saas_url}/doceboLms/index.php?auth_regen=1&modname=login&op=confirm&login_user=#{username}&time=#{timestamp}&token=#{token}"
+      end
+    end
+  end
+end

data/lib/docebo_ruby/version.rb

@@ -0,0 +1,3 @@
+module DoceboRuby
+  VERSION = '0.0.4'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docebo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Jack A. Huang
@@ -14,14 +14,14 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.3
 - !ruby/object:Gem::Dependency
@@ -38,14 +38,52 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Docebo is an online LMS.
 email: huynhquancam@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/docebo_ruby.rb
-homepage: http://rubygems.org/gems/hola
+- lib/docebo_ruby/api.rb
+- lib/docebo_ruby/configuration.rb
+- lib/docebo_ruby/course.rb
+- lib/docebo_ruby/engine.rb
+- lib/docebo_ruby/orgchart.rb
+- lib/docebo_ruby/parameters.rb
+- lib/docebo_ruby/resource.rb
+- lib/docebo_ruby/user.rb
+- lib/docebo_ruby/version.rb
+homepage: https://github.com/huynhquancam/docebo_ruby
 licenses:
 - MIT
 metadata: {}
@@ -65,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Docebo LMS.