kgrift 1.3.108

data/KGrift/knewton_grifts/analytics_grifts.rb

@@ -0,0 +1,103 @@
+ANALYTICS_VALID_OPTION_KEYS = [:goal_id, 'goal_id', :start_date, 'start_date', :end_date, 'end_date', :taxon_id, 'taxon_id']
+
+
+def get_registration_metric_row reg_id, metric, overrides={}
+    spewy.post "/v0/registrations/#{reg_id}/metrics/#{metric}/rows", {
+    }.merge(overrides)
+end
+
+def get_registration_expected_score reg_id, overrides={}
+    get_registration_metric_row reg_id, 'expected-score', overrides
+end
+
+def get_registration_proficiency reg_id, overrides={}
+    get_registration_metric_row reg_id, 'proficiency', overrides
+end
+
+def get_registration_active_time reg_id, overrides={}
+    get_registration_metric_row reg_id, 'active-time', overrides
+end
+
+def get_registration_readiness_forecast reg_id, overrides={}
+    get_registration_metric_row reg_id, 'readiness-forecast', overrides
+end
+
+def get_li_metric_row li_id, metric, overrides={}
+    spewy.post "/v0/learning-instances/#{li_id}/metrics/#{metric}/rows", {
+    }.merge(overrides)
+end
+
+def get_li_expected_score li_id, overrides={}
+    get_li_metric_row li_id, 'expected-score', overrides
+end
+
+def get_li_proficiency li_id, overrides={}
+    get_li_metric_row li_id, 'proficiency', overrides
+end
+
+def get_li_active_time li_id, overrides={}
+    get_li_metric_row li_id, 'active-time', overrides
+end
+
+def get_li_readiness_forecast li_id, overrides={}
+    get_li_metric_row li_id, 'readiness-forecast', overrides
+end
+
+def get_expected_score_for_reg_and_goal reg_id, goal_id
+  spewy_get "/v0/registrations/#{reg_id}/metrics/expected-score?goal_id=#{goal_id}"
+end
+
+
+def get_expected_score_point_estimates_for_reg_and_goal reg_id, goal_id
+  #return a trimmed down payload for easier inspection
+  # HASH:  module_id -> point_estimate
+  full_response = get_expected_score_for_reg_and_goal reg_id, goal_id
+  trimmed = {}
+  full_response['goals'][0]['target_modules'].each do |tm_data|
+    trimmed[tm_data['module_id']] = tm_data['expected_scores'][0]['point_estimate']
+  end
+  trimmed
+end
+
+
+def get_expected_score reg_or_LI_label, reg_or_LI, options={}
+  Log.info "Getting expected-score for #{reg_or_LI_label} #{reg_or_LI} with options: #{options}"
+  #select valid options
+  valid_options = options.values_at(*ANALYTICS_VALID_OPTION_KEYS)
+  append_http_path = valid_options.zip(ANALYTICS_VALID_OPTION_KEYS).select{|v,k| v}.map{ |v,k| k.to_s + '=' + v}
+  #select http path by label
+  spewy.get "/v0/#{reg_or_LI_label.to_s+'s'}/#{reg_or_LI}/metrics/expected-score?" + append_http_path.join('&')
+end
+
+def get_active_time reg_or_LI_label, reg_or_LI, options={}
+  Log.info "Getting active-time for #{reg_or_LI_label} #{reg_or_LI} with options: #{options}"
+  #select valid options
+  valid_options = options.values_at(*ANALYTICS_VALID_OPTION_KEYS)
+  append_http_path = valid_options.zip(ANALYTICS_VALID_OPTION_KEYS).select{|v,k| v}.map{ |v,k| k.to_s + '=' + v}
+  #select http path by label
+  spewy.get "/v0/#{reg_or_LI_label.to_s+'s'}/#{reg_or_LI}/metrics/active-time?" + append_http_path.join('&')
+end
+
+def get_readiness_forecast reg_or_LI_label, reg_or_LI, options={}
+  Log.info "Getting readiness-forecast for #{reg_or_LI_label} #{reg_or_LI} with options: #{options}"
+  #select valid options
+  valid_options = options.values_at(*ANALYTICS_VALID_OPTION_KEYS)
+  append_http_path = valid_options.zip(ANALYTICS_VALID_OPTION_KEYS).select{|v,k| v}.map{ |v,k| k.to_s + '=' + v}
+  #select http path by label
+  spewy.get "/v0/#{reg_or_LI_label.to_s+'s'}/#{reg_or_LI}/metrics/readiness-forecast?" + append_http_path.join('&')
+end
+
+def get_proficiency reg_or_LI_label, reg_or_LI, options={}
+  Log.info "Getting proficiency for #{reg_or_LI_label} #{reg_or_LI} with options: #{options}"
+  #select valid options
+  valid_options = options.values_at(*ANALYTICS_VALID_OPTION_KEYS)
+  append_http_path = valid_options.zip(ANALYTICS_VALID_OPTION_KEYS).select{|v,k| v}.map{ |v,k| k.to_s + '=' + v}
+  #select http path by label
+  spewy.get "/v0/#{reg_or_LI_label.to_s+'s'}/#{reg_or_LI}/metrics/proficiency?" + append_http_path.join('&')
+end
+
+# spewy_get is handy for making adhoc calls right off the cmd line:
+# kgrift -e QA -v spewy_get "/v0/someurl?someparam=abc"
+def spewy_get full_url, options={}
+  spewy.get full_url, options
+end

data/KGrift/knewton_grifts/async_helper_grifts.rb

@@ -0,0 +1,63 @@
+require 'rspec/expectations'
+
+def eventually options={}, &blk
+  timeout = options[:timeout] || 10
+  interval = options[:interval] || 1
+  time_limit = Time.now + timeout
+  loop do
+    begin
+      yield blk
+    rescue Grifter::RequestException => error
+      raise error if error.code >= 500
+    rescue RSpec::Expectations::ExpectationNotMetError, ExpectationError => error
+      #nothing to check here... just keep waiting
+    end
+    return if error.nil?
+    if Time.now >= time_limit
+      Log.debug "eventually condition timed out:  #{error}"
+      raise error
+    end
+    Log.debug "eventually condition not yet met, will keep trying for #{(time_limit - Time.now).to_i.to_s} seconds:  #{error}"
+    sleep interval
+  end
+end
+
+
+#this helper is useful for waiting until a POST'd object acutally creates
+def wait_for_code expected_response_code=200, polling_options={}, &blk
+  #these options, if set, will cause us to check the response that comes back.
+  #to ensure we are getting the kind of asyc error we expect.
+  #If another error happens, we will stop immediately
+  error_code_must_be = polling_options[:error_code_must_be]
+  error_message_must_match = polling_options[:error_message_must_match]
+
+  eventually polling_options do
+    begin
+      yield blk
+    rescue Grifter::RequestException => e
+      #a 5xx should never happen, raise it if it does
+      if e.code.to_i >= 500
+        raise e
+      end
+      if error_code_must_be
+        raise e unless e.code.to_i == error_code_must_be.to_i
+      end
+      if error_message_must_match
+        raise e unless JSON.parse(e.body)['message'] =~ error_message_must_match
+      end
+    end
+    raise e unless kapi.last_response.status.to_i == expected_response_code.to_i
+  end
+end
+
+def time_it options={}, &blk
+  start_time = Time.now
+  yield blk
+  end_time = Time.now
+  block_took = (end_time - start_time)
+  Log.info "TIMING LOG: It took #{block_took} to execute the block: #{options.fetch(:name, 'No block name given')}"
+  return block_took
+end
+
+#Define new exception class for asynchronous expectation errors
+class ::ExpectationError < RuntimeError; end

data/KGrift/knewton_grifts/authenticator_grifts.rb

@@ -0,0 +1,46 @@
+# used for testing all kinds of authentication cases
+
+# create a partner with test users
+#
+def create_test_partner options={}
+  options = {
+    'client_id' => random_string(23) + '-' + random_string(8),
+    'client_secret' => random_string(48),
+    'num_system_accounts' => 2,
+
+  }.merge(options)
+
+  partner = {
+    'client_id' => options['client_id'],
+    'client_secret' => options['client_secret'],
+  }
+
+  partner_credentials = {
+    'client_id' => partner['client_id'],
+    'client_secret' => partner['client_secret'],
+  }
+
+  external_id_prefix = random_string(16) + '-'
+
+  as_account :knerd do
+
+    #make the partner
+    partner['partner_id'] = create_partner({'name' => partner['client_id'], 'password' => partner['client_secret']})['id']
+
+    #make system accounts
+    partner['system_accounts'] = {}
+    options['num_system_accounts'].times do |i|
+      sys_acct = create_system_user partner['partner_id']
+      sys_acct['type'] = 'system account'
+      sys_acct['account_id'] = sys_acct['id']
+      partner['system_accounts'][sys_acct['id']] = sys_acct
+    end
+  end
+
+  #return everything
+  return_data = {
+    'partner' => partner,
+  }
+  Log.debug JSON.pretty_generate(return_data)
+  return_data
+end

data/KGrift/knewton_grifts/basic_grifts.rb

@@ -0,0 +1,29 @@
+
+
+def wait_for_api_to_respond timeout_secs=60, poll_interval=1
+  Log.info "Waiting up to #{timeout_secs} for the platform to respond"
+  #when this call returns a non-error response, we are up
+  kapi.get '/v0/healthcheck',  {:additional_headers => {"accept" => "*/*", "content-type" => "text/plain"}}
+  Log.info "The system has awoken, proceeding"
+  true
+rescue Exception => e
+  timeout_secs -= poll_interval
+  Log.debug "Try failed, #{timeout_secs} secs left."
+  if timeout_secs < 1
+    raise TimeoutError.new 'The system never came up'
+  end
+  sleep poll_interval
+  wait_for_api_to_respond timeout_secs
+end
+
+# kapi_get is handy for making adhoc calls right off the cmd line:
+# kgrift -e QA -v kapi_get "/v0/someurl?someparam=abc"
+def kapi_get full_url, options={}
+  kapi.get full_url, options
+end
+alias :bivins_get :kapi_get
+
+
+def urlencode path_component
+  URI.encode_www_form_component(path_component.force_encoding("UTF-8"))
+end

data/KGrift/knewton_grifts/batch_grifts.rb

@@ -0,0 +1,14 @@
+def create_single_request relative_url, http_method, body
+  {"relative_url" => relative_url,
+   "method" => http_method,
+   "body" => body }
+end
+
+def create_batch_request requests
+  {"requests"=>requests}
+end
+
+def create_account_payload
+   external_user_id = "external-user-id" + random_string
+   {"external_user_id" => external_user_id}
+end

data/KGrift/knewton_grifts/content_collection_grifts.rb

@@ -0,0 +1,204 @@
+
+## COCO endpoints ##
+
+# return a list of all inventories
+def get_inventories
+  Log.info "getting all inventories"
+  coco.get "/v0/cc/admin/inventories"
+end
+
+# return a list of all inventories
+def get_inventories_for_partner partner_id
+  Log.info "getting all inventories for partner_id: #{partner_id}"
+  coco.get "/v0/cc/admin/#{partner_id}/inventories"
+end
+
+# get an inventory and all modules in it
+def get_inventory inventory_id
+  Log.info "Getting inventory - inventory_id: #{inventory_id}"
+  coco.get "/v0/cc/inventory/#{inventory_id}"
+end
+
+# get an inventory and all modules in it
+def get_inventory_admin partner_id, inventory_id, query_params={}
+  Log.info "Admin getting inventory - partner_id: #{partner_id} - inventory_id: #{inventory_id}"
+  coco.get "/v0/cc/admin/#{partner_id}/#{inventory_id}?#{URI.encode_www_form query_params}"
+end
+
+# get a inventory module
+def get_inventory_module inventory_id, module_id
+  Log.info "Getting module - inventory_id: #{inventory_id} - module_id: #{module_id}"
+  coco.get "/v0/cc/inventory/#{URI.encode inventory_id}/module/#{URI.encode module_id}"
+end
+
+# get a single inventory module
+def get_inventory_module_admin partner_id, inventory_id, module_id
+  Log.info "Admin getting module - partner_id: #{partner_id} - inventory_id: #{inventory_id} - module_id: #{module_id}"
+  coco.get "/v0/cc/admin/#{partner_id}/#{URI.encode inventory_id}/module/#{URI.encode module_id}"
+end
+
+# get the transaction log of an inventory,
+def get_inventory_log partner_id, inventory_id, params={}
+  params = {
+    'start' => days_from_now(-7),
+    'coalesce' => false,
+  }.merge(params)
+  # format the timestamp if we need to
+  if params['start'].respond_to? :utc
+    params['start'] = params['start'].utc.iso8601(3)
+  end
+  Log.info "Getting inventory log '#{inventory_id}:#{partner_id}'"
+  coco.post "/v0/cc/admin/#{partner_id}/#{inventory_id}/log", params
+end
+
+# Make a new inventory
+def create_inventory_admin partner_id, new_inventory_id=nil
+  new_inventory_id = "KGriftTestInventory_#{random_string(16)}" if new_inventory_id.nil?
+  Log.info "Admin creating an inventory - partner_id: #{partner_id}"
+  # response = create_modules_admin partner_id, new_inventory_id
+  response = coco.post "/v0/cc/admin/#{partner_id}/#{URI.encode new_inventory_id}/inventory", ''
+
+  {
+    'id' => new_inventory_id,
+    'inventory_id' => new_inventory_id,
+    'partner_id' => partner_id,
+    'inventory' => response,
+  }
+end
+
+def ensure_inventory_exists partner_id, inventory_id
+  create_inventory_admin partner_id, inventory_id
+rescue Grifter::RequestException => e
+  # CoCo returns a 422 if the inventory already exists
+  # any other response code is not allowed, but we'll catch 422
+  raise e unless e.code.to_i == 422
+end
+
+# delete an inventory
+def delete_inventory_admin partner_id, inventory_id
+  Log.info "Admin deleting an inventory - partner_id: #{partner_id}"
+  coco.delete "/v0/cc/admin/#{partner_id}/#{inventory_id}/inventory"
+end
+
+def ensure_inventory_does_not_exist partner_id, inventory_id
+  delete_inventory_admin partner_id, inventory_id
+rescue Grifter::RequestException => e
+  # if the inventory does not an exist a 404 is returned.  For our purposes, that is fine
+  # so we'll allow the request to fail if 404 comes back
+  raise e unless e.code.to_i == 404
+end
+
+def delete_all_inventories_for_partner partner_id
+  invs = get_inventories_for_partner partner_id
+  inv_ids = invs['partner_inventories'].map{|i| i['inventory_id']}
+  inv_ids.each do |inv_id|
+    delete_inventory_admin partner_id, inv_id
+  end
+end
+
+# build out a basic module object, ready to be created directly
+# or you can merge in customizations
+def test_module_object params={}
+  params = {
+    "module_id" => 'KGrift test module ' + random_uuid,
+    "module_name" => random_string,
+    "module_version" => random_string,
+    "module_type" => ['instruction', 'assessment', 'both'].sample,
+    "module_url" => "http://kgriftlms.com/#{random_string}",
+    'taxons' => [],
+    'module_metadata' => [],
+    'containers' => [],
+    'notification_url' => nil,
+    'content_summary' => "TESTING: #{random_string}",
+  }.merge(params)
+end
+
+# create a batch of modules against some inventory
+def create_modules inventory_id, modules=[]
+  modules << test_module_object if modules.empty?
+  Log.info "Creating '#{modules.length}' modules for inventory_id: #{inventory_id}"
+  coco.post "/v0/cc/inventory/#{inventory_id}/modules", modules
+end
+
+# create a batch of modules against some inventory
+def create_modules_admin partner_id, inventory_id, modules=[]
+  modules << test_module_object if modules.empty?
+  Log.info "Admin creating '#{modules.length}' modules for inventory - partner_id: #{partner_id} - inventory_id: #{inventory_id}"
+  coco.post "/v0/cc/admin/#{partner_id}/#{inventory_id}/modules", modules
+end
+
+# delete a module
+def delete_module inventory_id, module_id
+  Log.info "Deleting inventory module - inventory_id: #{inventory_id} - module_id: #{module_id}"
+  #grifter doesn't actually let you put a body on a delete if you use coco.delete
+  #but we can get around that like so:
+  # coco.do_request :delete, "/v0/cc/inventory/#{inventory_id}/module", { 'module_id' => module_id }
+  coco.delete "/v0/cc/inventory/#{inventory_id}/module/#{URI.encode module_id}"
+end
+
+# delete a module as a knerd
+def delete_module_admin partner_id, inventory_id, module_id
+  Log.info "Admin deleting inventory module - partner_id: #{partner_id} - inventory_id: #{inventory_id} - module_id: #{module_id}"
+  #grifter doesn't actually let you put a body on a delete if you use coco.delete
+  #but we can get around that like so:
+  # coco.do_request :delete, "/v0/cc/admin/#{partner_id}/#{inventory_id}/module", { 'module_id' => module_id }
+  # coco.delete "/v0/cc/admin/#{partner_id}/#{inventory_id}/module/#{URI.encode module_id}"
+  coco.do_request :delete, "/v0/cc/admin/#{partner_id}/#{inventory_id}/module/#{URI.encode module_id}", {}
+end
+
+def update_modules inventory_id, modules
+  Log.info "Updating '#{modules.length}' modules for inventory - inventory_id: #{inventory_id}"
+  coco.put "/v0/cc/inventory/#{inventory_id}/modules", modules
+end
+
+def update_module inventory_id, mod
+  update_modules inventory_id, [mod]
+end
+
+def update_modules_admin partner_id, inventory_id, modules
+  Log.info "Updating '#{modules.length}' modules for inventory - partner_id: #{partner_id} - inventory_id: #{inventory_id}"
+  coco.put "/v0/cc/admin/#{partner_id}/#{inventory_id}/modules", modules
+end
+
+def mark_module_mapped partner_id, inventory_id, module_id, module_version
+  Log.info "Marking module mapped for inventory - partner_id: #{partner_id} - inventory_id: #{inventory_id} - module_id: #{module_id} - module_version: #{module_version}"
+  coco.put "/v0/cc/admin/#{partner_id}/#{inventory_id}/map", {
+    'module_id' => module_id,
+    'module_version' => module_version,
+  }
+end
+
+
+
+# CoCo stats endpoints
+#
+
+def get_partner_stats partner_id
+  Log.info "getting coco partner stats - partner_id: #{partner_id}"
+  coco.get "/v0/cc/stats/#{partner_id}"
+end
+
+def get_partner_stats_sum partner_id
+  Log.info "getting coco partner stats sum - partner_id: #{partner_id}"
+  coco.get "/v0/cc/stats/#{partner_id}/sum"
+end
+
+def get_inventory_stats partner_id, inventory_id
+  Log.info "getting inventory stats - partner_id: #{partner_id} - inventory_id: #{inventory_id}"
+  # coco.post "/v0/cc/stats/#{partner_id}/#{inventory_id}", {}
+  coco.get "/v0/cc/stats/#{partner_id}/#{inventory_id}"
+end
+
+
+def get_inventory_last_updated partner_id, inventory_id
+  Log.info "Admin getting inventory last updated - partner_id: #{partner_id} - inventory_id: #{inventory_id}"
+  stats = get_inventory_stats partner_id, inventory_id
+  stats['last_updated']
+end
+
+def get_inventory_total_modules partner_id, inventory_id
+  Log.info "Admin getting inventory total modules - partner_id: #{partner_id} - inventory_id: #{inventory_id}"
+  stats = get_inventory_stats partner_id, inventory_id
+  stats['num_modules']
+end
+