learndot_api 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fddcda6752cdbc9181405d9e0c38975994d3dfad
+  data.tar.gz: 4d53953a494753a0e15ed0a48561f85037afcfb7
+SHA512:
+  metadata.gz: 866abb02763938394d832541e2bb9e9d6d01a42f4d74e78d3152f2604607f00f38ff453e2b5bcb54c6891b4bb9ba3afd2d3936b3c3fdbe81abe730d0a76881c5
+  data.tar.gz: 121d4f7976a0f002237a82204c2af4bb789ffa35d202dffe5d6f37939cade91df231605c46b68b468456dd6a48a9f59da0e50b68bcc4804b1f69c81485688280

data/CHANGELOG

@@ -0,0 +1,19 @@
+v0.2.5
+ * Add support for connecting to staging environment
+
+v0.2.4
+ * Change endpoint used so that we can record private classes too
+
+v0.2.3
+ * Support for "courses" object in learndot
+
+v0.2.2
+ * search public and private events
+
+v0.2.1
+ * Added ability to retrieve session URLs
+ * Update session notes
+
+v0.2.0
+
+Refactored into a library. Please see example usage in the `examples directory.

data/README.md

@@ -0,0 +1,26 @@
+Learndot API wrapper
+===============
+
+This is a simple wrapper for the Learndot API. It's not very complete since it
+was built primary to support our own specific needs. If you need an API added,
+please file an issue, or contact us and let us know. 
+
+Configuration
+===========
+
+The API requires a token. This should be saved in one of two places:
+
+1. `~/.learndot_token`
+1. An environment variable of `$LEARNDOT_TOKEN`.
+
+You can get your token at https://{learndot-url}/admin/api/token
+
+Usage 
+==========
+
+See the `examples` directory for usage samples.
+
+Contact 
+==========
+
+eduteam@puppet.com

data/examples/test.rb

@@ -0,0 +1,31 @@
+#! /usr/bin/env ruby
+require 'learndot'
+require 'learndot/events'
+
+class String
+  def trim(size)
+    if self.size > size
+      "#{self[0...(size - 1)]}…"
+    else
+      self
+    end
+  end
+end
+
+conditions = {
+  'startTime' => [Learndot.timestamp(), Learndot.timestamp(1*7*24*60*60)],
+  'status'    => ['CONFIRMED', 'TENTATIVE'],
+}
+
+ld     = Learndot.new(true)
+events = ld.events.retrieve(conditions)
+
+puts '   Date    |         Course                 |      Location               |  #'
+puts '------------------------------------------------------------------------------'
+events.each do |delivery|
+  printf("%10s | %-30s | %-27s | %2s\n",
+      delivery[:start_time],
+      delivery[:course_name].trim(30),
+      delivery[:city],
+      delivery[:enrollment_count])
+end

data/lib/learndot/api.rb

@@ -0,0 +1,133 @@
+require 'httparty'
+require 'json'
+require 'logger'
+
+class Learndot::API
+  attr_writer :logger
+
+  def initialize(token = nil, debug = false, staging = false)
+    @logger           = Logger.new(STDOUT)
+    @logger.level     = debug ? Logger::DEBUG : Logger::WARN
+    @logger.formatter = proc { |level, date, name, msg|
+      "#{level}: #{msg}\n"
+    }
+
+    token ||= get_token
+
+    # Set the base_url to the staging or production endpoint
+    @base_url = staging ? "https://puppetlabs-staging.trainingrocket.com/api/rest/v2" : "https://learn.puppet.com/api/rest/v2"
+
+    @headers  = {
+      "TrainingRocket-Authorization"      => token,
+      "Learndot Enterprise-Authorization" => token,
+      "Content-Type" => "application/json",
+      "Accept"       => "application/json; charset=utf-8"
+    }
+  end
+
+  def search(entity, conditions = {}, query = {})
+    endpoint       = "/manage/#{entity}/search"
+    query[:asc]  ||= false
+    query[:or]   ||= false
+
+    if query.include? 'page'
+      api_post(endpoint, conditions, query)
+    else
+      page do |count|
+        query[:page] = count
+        api_post(endpoint, conditions, query)
+      end
+    end
+  end
+
+  def count(entity, conditions = {})
+    endpoint = "/manage/#{entity}/search"
+
+    num_records = api_post(endpoint, conditions)['size']
+    num_records.is_a?(Integer) ? num_records : 0
+  end
+
+  # keep seperate from create to avoid accidental record creation
+  def update(entity, conditions, id)
+    endpoint = "/manage/#{entity}/#{id}"
+    api_post(endpoint, conditions)
+  end
+
+  def create(entity, conditions)
+    endpoint = "/manage/#{entity}"
+    api_post(endpoint, conditions)
+  end
+
+  ############### Private methods ###############
+  def get_token
+    path = File.expand_path('~/.learndot_token')
+
+    File.exists?(path) ? File.read(path).strip : ENV['LEARNDOT_TOKEN']
+  end
+
+  def api_post(endpoint, conditions = {}, query = {})
+    url = @base_url + endpoint
+    @logger.debug "POST: #{url}"
+    @logger.debug "  * Query params: #{query.inspect}"
+    @logger.debug "  * Conditions: #{conditions.inspect}"
+
+
+    response = HTTParty.post(url, {
+      headers: @headers,
+      query: query,
+      body: conditions.to_json,
+    })
+    @logger.debug "#{response.code}: #{response.message}"
+    raise response.message unless response.code == 200
+
+    sleep 1 # dear god learndot
+    response
+  end
+
+  def api_get(endpoint, query = {})
+    url = @base_url + endpoint
+    @logger.debug "GET: #{url}"
+    @logger.debug "  * Query params: #{query.inspect}"
+    @logger.debug "  * Conditions: #{conditions.inspect}"
+
+    response = HTTParty.get(url, { headers: @headers, query: query })
+    @logger.debug "#{response.code}: #{response.message}"
+    raise response.message unless response.code == 200
+
+    sleep 1 # dear god learndot
+    response
+  end
+
+  def hash_response(response)
+    result_hash = {}
+    if response['size'].is_a?(Integer)
+      response['results'].each do | result |
+        result_hash[result['id']] = result
+      end
+    end
+    return result_hash
+  end
+
+  # Call a method provided as a block until there's no more data to get back
+  def page
+    raise 'page() requires a block' unless block_given?
+
+    response    = yield(1)
+    num_records = response['size']
+
+    if num_records.is_a?(Integer) && num_records > 25
+      pages = (num_records / 25) + 1
+      # start at 2 since first call returned first page
+      for counter in 2..pages
+        @logger.debug "Retrieving page #{counter} of #{pages}"
+        results = yield(counter)['results']
+        response['results'].concat(results) if results
+      end
+    end
+
+    hash_response(response)
+  end
+  private :api_post, :api_get, :hash_response, :get_token, :page
+  ############### End private methods ###############
+
+end

data/lib/learndot/courses.rb

@@ -0,0 +1,63 @@
+class Learndot::Courses
+  def initialize(api)
+    @api = api
+  end
+
+  def retrieve(conditions, options = {orderBy: 'Name', asc: true})
+    courses = @api.search(:learning_component, conditions, options)
+
+    if !courses.empty?
+      course_ids    = courses.collect { | k, c | c['id']    }.uniq
+
+      courses    = @api.search(:learning_component,   { 'id' => course_ids    })
+
+      courses.collect do | course_id, course |
+        course[:id]           = course['id']
+        course[:name]         = course['name']
+        course[:components]   = course['components']
+
+        course
+      end
+    end
+  end
+
+  def enrollment_count(course_id)
+    enrollments = @api.search(:enrolment, { 'componentId' => [course_id] })
+
+    if ! enrollments.empty?
+      enrollment_ids         = enrollments.collect { | k, cs | cs['id'] }
+      enrollment_conditions = {
+        'id'     => enrollment_ids,
+      }
+      count = @api.count('enrolment', enrollment_conditions)
+    end
+
+    return count || 0
+  end
+
+  def enrolled(course_id)
+    enrollments = @api.search(:enrolment, { 'componentId' => [course_id] })
+    return [] if enrollments.empty?
+
+    conditions = {
+      'id'     => enrollments.collect { | k, cs | cs['id'] },
+    }
+    enrollments = @api.search(:enrolment, conditions)
+    return [] if enrollments.empty?
+
+    conditions = {
+      'id'     => enrollments.collect { | k, cs | cs['contactId'] },
+    }
+    contacts = @api.search(:contact, conditions)
+
+    contacts.collect do | k, cs |
+      { :id => cs['id'], :name => cs['_displayName_'], :email => cs['email'] }
+    end
+  end
+end
+
+class Learndot
+  def courses
+    Learndot::Courses.new(self.api)
+  end
+end

data/lib/learndot/events.rb

@@ -0,0 +1,83 @@
+class Learndot::Events
+  def initialize(api)
+    @api = api
+  end
+
+  def retrieve(conditions, options = {orderBy: 'startTime', asc: true})
+    classes = @api.search(:course_event, conditions, options)
+
+    if !classes.empty?
+      course_ids    = classes.collect { | k, c | c['courseId']    }.uniq
+      location_ids  = classes.collect { | k, c | c['locationId']  }.uniq
+      organizer_ids = classes.collect { | k, c | c['organizerId'] }.uniq
+
+      courses    = @api.search(:course,   { 'id' => course_ids    })
+      locations  = @api.search(:location, { 'id' => location_ids  })
+      organizers = @api.search(:contact,  { 'id' => organizer_ids })
+
+      classes.collect do | class_id, klass |
+        location = locations[klass['locationId']]
+
+        klass[:learndot_id]      = klass['id'] # for consistency
+        klass[:city]             = location['online'] ? location['name'] : location['address']['city']
+        klass[:course_name]      = courses[klass['courseId']]['name']
+        klass[:organizer]        = organizers[klass['organizerId']] ? organizers[klass['organizerId']]['_displayName_'] : ''
+        klass[:enrollment_count] = enrollment_count(class_id)
+        klass[:start_time]       = Date.parse(klass['startTime'])
+        klass[:end_time]         = Date.parse(klass['finalEndTime'])
+        klass[:notes]            = klass['notes']
+        klass[:session_url]      = klass['sessionUrl']
+
+        klass
+      end
+    end
+  end
+
+  def enrollment_count(class_id)
+    sessions = @api.search(:course_session, { 'eventId' => [class_id] })
+
+    if ! sessions.empty?
+      enrolment_ids         = sessions.collect { | k, cs | cs['enrolmentId'] }
+      enrollment_conditions = {
+        'id'     => enrolment_ids,
+        'status' => ['TENTATIVE', 'APPROVED', 'CONFIRMED']
+      }
+      count = @api.count('enrolment', enrollment_conditions)
+    end
+
+    return count || 0
+  end
+
+  def enrolled(class_id)
+    sessions = @api.search(:course_session, { 'eventId' => [class_id] })
+    return [] if sessions.empty?
+
+    conditions = {
+      'id'     => sessions.collect { | k, cs | cs['enrolmentId'] },
+      'status' => ['TENTATIVE', 'APPROVED', 'CONFIRMED']
+    }
+    enrollments = @api.search(:enrolment, conditions)
+    return [] if enrollments.empty?
+
+    conditions = {
+      'id'     => enrollments.collect { | k, cs | cs['contactId'] },
+    }
+    contacts = @api.search(:contact, conditions)
+
+    contacts.collect do | k, cs |
+      { :id => cs['id'], :name => cs['_displayName_'], :email => cs['email'] }
+    end
+  end
+
+  def update_notes(class_id, notes)
+    conditions = { 'notes' => notes }
+    @api.update(:course_event, conditions, class_id)
+  end
+
+end
+
+class Learndot
+  def events
+    Learndot::Events.new(self.api)
+  end
+end

data/lib/learndot/training_credits.rb

@@ -0,0 +1,31 @@
+class Learndot::TrainingCredits
+  def initialize(api)
+    @api = api
+  end
+
+  def find_accounts(email)
+    api_get('/credit', {email: email})
+  end
+
+  def create_account(conditions)
+    api_post('/credit', conditions)
+  end
+
+  def adjust(tc_account_id, conditions)
+    api_post("credit/#{tc_account_id}/adjust", conditions)
+  end
+
+  def history(tc_account_id)
+    endpoint = "/credit/#{tc_account_id}/transactions"
+
+    page do |count|
+      api_get(endpoint, {page: count})
+    end
+  end
+end
+
+class Learndot
+  def training_credits
+    Learndot::TrainingCredits.new(self.api)
+  end
+end

data/lib/learndot.rb

@@ -0,0 +1,33 @@
+# This class serves as a "wrapper" for subclasses. Each time a subclass is
+# called, it will monkeypatch itself into this one. Then you'll have a
+# factory method to return a properly scoped subclass.
+#
+# For example:
+#
+# require 'learndot'
+# require 'learndot/events'
+#
+# conditions = {
+#     'startTime' => [Learndot.timestamp(), Learndot.timestamp(3*7*24*60*60)],
+#     'status'    => ['CONFIRMED', 'TENTATIVE'],
+# }
+#
+# ld = Learndot.new
+# ld.events.retrieve(conditions)
+#
+class Learndot
+  require 'learndot/api'
+  attr_reader :api
+
+  def initialize(debug = false, staging = false)
+    @api = Learndot::API.new(nil, debug, staging)
+  end
+
+  def self.timestamp(time = nil)
+    time ||= Time.new
+    time   = Time.new + time if time.is_a? Numeric
+    raise "timestamp() expects a Time object or number of seconds from now as an integer." unless time.class == Time
+
+    time.strftime('%Y-%m-%d %H:%M:%S')
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: learndot_api
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+platform: ruby
+authors:
+- Michael Marrero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: Methods to retrieve records from Learndot Enterprise API
+email: michael.marrero@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- README.md
+- examples/test.rb
+- lib/learndot.rb
+- lib/learndot/api.rb
+- lib/learndot/courses.rb
+- lib/learndot/events.rb
+- lib/learndot/training_credits.rb
+homepage: http://learn.puppet.com
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Learndot API
+test_files: []