learndot_api 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fddcda6752cdbc9181405d9e0c38975994d3dfad
-  data.tar.gz: 4d53953a494753a0e15ed0a48561f85037afcfb7
+SHA256:
+  metadata.gz: 06d51d926108dd5346c76fef1cadccbab0a5562148584c9cd0690d70ec3fa74f
+  data.tar.gz: f729273b840ecd2fa1203d62e70469ee587db14bc838b9fd3c38eed129ad5c68
 SHA512:
-  metadata.gz: 866abb02763938394d832541e2bb9e9d6d01a42f4d74e78d3152f2604607f00f38ff453e2b5bcb54c6891b4bb9ba3afd2d3936b3c3fdbe81abe730d0a76881c5
-  data.tar.gz: 121d4f7976a0f002237a82204c2af4bb789ffa35d202dffe5d6f37939cade91df231605c46b68b468456dd6a48a9f59da0e50b68bcc4804b1f69c81485688280
+  metadata.gz: 93cdc3c103461b105feb8a8a1888123bd8acae73766ef9b320a89076fe8e2f958ee86960c88a8dea6b367ec77251d5dbb30b6c82039facb95a83d4510f5088e4
+  data.tar.gz: 27d77286be638ae940333a831abbdaae44733a807a608d99d6ecbdf4e144efbc87f9f0054b773bbcb7c0bba6d71378d0403e55f1e6f92b629dbf44d33d04a7e0

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.3.0
+ * Added PoC code for supporting v3 API based on GraphQL
+ * Added some common schemas and v3 schema
+ * Support for content_component objects
+ * Changed token lookup order to use ENV
+
 v0.2.5
  * Add support for connecting to staging environment
 

data/examples/learning_component_desc.json

@@ -0,0 +1,187 @@
+{
+  "result": {
+    "UUID": {
+      "type": "string"
+    },
+    "_displayName_": {
+      "type": "string"
+    },
+    "_keyword_": {
+      "type": "string"
+    },
+    "banner": {
+      "type": "string"
+    },
+    "created": {
+      "type": "string"
+    },
+    "createdById": {
+      "type": "number"
+    },
+    "customField01": {
+      "type": "string"
+    },
+    "customField02": {
+      "type": "string"
+    },
+    "customField03": {
+      "type": "string"
+    },
+    "customField04": {
+      "type": "string"
+    },
+    "customField05": {
+      "type": "string"
+    },
+    "customField06": {
+      "type": "string"
+    },
+    "customField07": {
+      "type": "string"
+    },
+    "customField08": {
+      "type": "string"
+    },
+    "customField09": {
+      "type": "string"
+    },
+    "customField10": {
+      "type": "string"
+    },
+    "deprecatedBy": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "duration": {
+      "type": "object",
+      "properties": {
+        "days": {
+          "type": "integer"
+        },
+        "minutesPerDay": {
+          "type": "integer"
+        }
+      }
+    },
+    "expiryDays": {
+      "type": "integer"
+    },
+    "fields": {
+      "type": "array",
+      "items": {
+        "type": "any"
+      }
+    },
+    "generateCertificate": {
+      "type": "string",
+      "enum": [
+        "DEFAULT",
+        "YES",
+        "NO"
+      ]
+    },
+    "generateProofOfCompletion": {
+      "type": "string",
+      "enum": [
+        "DEFAULT",
+        "YES",
+        "NO"
+      ]
+    },
+    "id": {
+      "type": "number"
+    },
+    "language": {
+      "type": "string"
+    },
+    "logo": {
+      "type": "string"
+    },
+    "modified": {
+      "type": "string"
+    },
+    "modifiedById": {
+      "type": "number"
+    },
+    "name": {
+      "type": "string"
+    },
+    "orderNumber": {
+      "type": "integer"
+    },
+    "price": {
+      "type": "object",
+      "properties": {
+        "amount": {
+          "type": "number"
+        },
+        "currency": {
+          "type": "string"
+        }
+      }
+    },
+    "primaryCategoryId": {
+      "type": "number"
+    },
+    "providerId": {
+      "type": "number"
+    },
+    "rules": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "operations": {
+            "type": "array",
+            "items": {
+              "type": "any"
+            }
+          },
+          "restriction": {
+            "type": "object",
+            "properties": {}
+          }
+        }
+      }
+    },
+    "salesforceProductId": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "ENABLED",
+        "ACTIVE_COMPONENT",
+        "DISABLED"
+      ]
+    },
+    "summary": {
+      "type": "string"
+    },
+    "taxJurisdiction": {
+      "type": "string",
+      "enum": [
+        "EVENT",
+        "CUSTOMER",
+        "PAYMENT",
+        "SHIPPING"
+      ]
+    },
+    "urlName": {
+      "type": "string"
+    },
+    "visibility": {
+      "type": "string",
+      "enum": [
+        "PUBLIC",
+        "HIDDEN",
+        "MEMBER",
+        "DEPRECATED",
+        "CUSTOM"
+      ]
+    }
+  },
+  "url": "https://learn.puppet.com/api/rest/v2/manage/learning_component/describe"
+}

data/examples/v2_endpoints.json

@@ -0,0 +1,130 @@
+[
+  "training_credit_credit_transaction",
+  "survey_response",
+  "training_survey_response",
+  "scheduled_report",
+  "page",
+  "content_session",
+  "stream_post",
+  "template",
+  "certificate",
+  "subscription",
+  "elearning_survey_response",
+  "agreement",
+  "provider",
+  "questionnaire_response",
+  "tag",
+  "survey_response_metric",
+  "entity_notification",
+  "course_pathway",
+  "location_feature",
+  "shipping_info",
+  "purchase_order_payment",
+  "training_opportunity",
+  "training_credit_redemption_request",
+  "saml_connection",
+  "user_group",
+  "affiliate_customer_order_conversion",
+  "content_option_resource",
+  "e_learning_session",
+  "course_pathway_type",
+  "course",
+  "virtual_machine_content",
+  "knowledge_category_category",
+  "country_state",
+  "contact_file_attachment",
+  "forum_topic",
+  "payment",
+  "learning_component_resource",
+  "question",
+  "credit_card_payment",
+  "saml_config",
+  "skill",
+  "subscription_package",
+  "affiliate_visit",
+  "learning_pathway_requirement",
+  "training_credit_transaction",
+  "social_connection",
+  "watcher",
+  "multiple_choice_question_response",
+  "access_right",
+  "exam_session",
+  "opportunity",
+  "timesheet",
+  "comment",
+  "forum_post",
+  "forum_topic_subscription",
+  "content",
+  "learning_component",
+  "training_assessment_response",
+  "e_learning_component",
+  "course_category",
+  "enrolment_resource",
+  "public_course_event",
+  "course_event",
+  "talent_placement",
+  "multiple_choice_option",
+  "system_setting",
+  "staff_role",
+  "user_connection",
+  "content_option",
+  "learning_pathway_session",
+  "learning_resource",
+  "currency_exchange_rate",
+  "affiliate_conversion",
+  "discount_use",
+  "navigational_link",
+  "elearning_testimonial",
+  "location",
+  "training_credit_payment",
+  "forum_subscription",
+  "affiliate",
+  "link_content",
+  "text_question_response",
+  "affiliate_payment",
+  "agreement_template",
+  "questionnaire",
+  "learning_session",
+  "course_requirement",
+  "catalog_group",
+  "product_category",
+  "text_question",
+  "content_component",
+  "contact",
+  "order_discount",
+  "forum",
+  "course_event_resource",
+  "discount_rule",
+  "training_credit_usage",
+  "learning_plan",
+  "course_pathway_session",
+  "proof_of_completion",
+  "training_credit_debit_transaction",
+  "enrolment",
+  "true_ability_content",
+  "training_credit_account",
+  "badge",
+  "order",
+  "content_access",
+  "trigger",
+  "label",
+  "knowledge_category",
+  "file_attachment",
+  "question_response",
+  "affiliate_opportunity_conversion",
+  "digital_content",
+  "course_testimonial",
+  "blurb",
+  "stream_post_comment",
+  "private_course_event",
+  "exam_component",
+  "product",
+  "organization",
+  "learning_plan_item",
+  "course_session",
+  "order_item",
+  "testimonial_response",
+  "request_for_contact",
+  "multiple_choice_question",
+  "learning_pathway"
+]

data/lib/learndot/api.rb

@@ -60,9 +60,14 @@ class Learndot::API
 
   ############### Private methods ###############
   def get_token
+    return ENV['LEARNDOT_TOKEN'] if ENV.include? 'LEARNDOT_TOKEN'
     path = File.expand_path('~/.learndot_token')
-
-    File.exists?(path) ? File.read(path).strip : ENV['LEARNDOT_TOKEN']
+    
+    begin
+      return File.read(path).strip
+    rescue => e
+      raise "API token (in env variable or #{path}) not readable. Exiting."
+    end
   end
 
   def api_post(endpoint, conditions = {}, query = {})

data/lib/learndot/apiv3.rb

@@ -0,0 +1,58 @@
+require 'graphql/client'
+require 'graphql/client/http'
+require 'json'
+require 'logger'
+
+# Configure GraphQL endpoint using the basic HTTP network adapter.
+HTTP = GraphQL::Client::HTTP.new("https://api.learndot.io/graphql/") do
+  def headers(context)
+    {
+      "X-API-KEY" => ENV['LEARNDOT_TOKEN_V3']
+    }
+  end
+end
+
+# DO NOT regularly get the schema from the API
+# There is a bug on line 10211, part of the PriceInput object; you have to remove the amount's default value.
+# Otherwise, the schema will fail the graphql-client validation
+# GraphQL::Client.dump_schema(HTTP, "schema.json")
+
+SCHEMA = GraphQL::Client.load_schema('schema.json')
+
+Client = GraphQL::Client.new(
+  schema: SCHEMA,
+  execute: HTTP
+)
+
+# Query = Client.parse <<-'GRAPHQL'
+#   {
+#     contactByLdeId( ldeId: <int> ) {
+#       firstName
+#       lastName
+#     }
+#   }
+# GRAPHQL
+
+# Learning Component queries only return ELearning Component types
+# Query = Client.parse <<-'GRAPHQL'
+#   {
+#     learningComponentByLdeId( ldeId: <int> ) {
+#       displayName
+#       description
+#     }
+#   }
+# GRAPHQL
+
+Query = Client.parse <<-'GRAPHQL'
+  { 
+    allLearningComponents { 
+      learningComponents { 
+        __typename
+      } 
+    } 
+  }
+GRAPHQL
+
+response = Client.query(Query)
+
+puts response.data.to_h

data/lib/learndot/events.rb

@@ -5,31 +5,31 @@ class Learndot::Events
 
   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
+    
+    return [] 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
 

data/lib/learndot/learning_components.rb

@@ -0,0 +1,23 @@
+class Learndot::LearningComponents
+  def initialize(api)
+    @api = api
+  end
+
+  def retrieve_component(conditions, options = {orderBy: 'Name', asc: true})
+    learning_component = @api.search(:content_component, conditions, options)
+  end
+
+  def create_component(conditions)
+    @api.create(:content_component, conditions)
+  end
+
+  def update_component(component_id, conditions={})
+    @api.update(:content_component, conditions, component_id)
+  end
+end
+
+class Learndot
+  def learning_component
+    Learndot::LearningComponents.new(self.api)
+  end
+end