ps_utilities 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daddd46f3c769ec3b61c29558b7cc82d70ea60372eadf8b5b01bba22f1a37068
-  data.tar.gz: 31cdcb88c3c8e66a5fd1c5005cf00e62eb1a1d8cb8000db52ef63c1ef0437e51
+  metadata.gz: c62242e43417fc95e14b36ba194604f4dfa79aac9e45887793ab982abedeb814
+  data.tar.gz: e0cf20edad5ba754ff741a99629e4554b38a831973dbb66ca51f61cdf74afc08
 SHA512:
-  metadata.gz: 1aea5bd941ef10d5373fb9409aa04fece491cf148c1acce8d9a5000309e4c079818e41b954a7f91bfb11ac582c0fb1ac5f97bb16b9d631f149c4a83ec7d12839
-  data.tar.gz: 577b9af25d14b005a8e57126c00ace8e98021062dc4ef03e752067dea68ea206523d91564cc299c74643b5bf79408399c2b8e799daf7f6411089b3dcb86fa563
+  metadata.gz: 8603dbf338731a62a39f386b6458579e4f49a3eca1eb41b2320beedafa352792f2a539cae7abc9f043934c17ccaec84085b7d1a692ba8d66b90a0116a07f70c4
+  data.tar.gz: 2a300ec71565e9e48e081740b402b87f450ca83e1effcfaf3705a0090d46938923353204a217c53538521758ba0d35c32ae5e0d8748459158385d84a4ff6b2f7

data/lib/ps_utilities/connection.rb

@@ -66,14 +66,13 @@ module PsUtilities
     end
 
     # verb = :delete, :get, :patch, :post, :put
-    # options = {query: {}, body: {}}
-    # get usually needs a query info
-    # put usually needs a body with data
+    # options = {query: {}, body: {}} - get uses :query, put and post use :body
     def api(verb, api_path, options={})
       count   = 0
       retries = 3
       ps_url  = base_uri + api_path
       options = options.merge(headers)
+      pp ps_url
       pp options
       begin
         HTTParty.send(verb, ps_url, options)
@@ -87,6 +86,14 @@ module PsUtilities
       end
     end
 
+    def header_defaults
+      { headers:
+        { 'User-Agent' => "PsUtilities - #{version}",
+          'Accept' => 'application/json',
+          'Content-Type' => 'application/json'}
+      }
+    end
+
     # In PowerSchool go to System>System Settings>Plugin Management Configuration>your plugin>Data Provider Configuration to manually check plugin expiration date
     def authenticate
       ps_url   = base_uri + auth_path
@@ -133,13 +140,5 @@ module PsUtilities
       }
     end
 
-    def header_defaults
-      { headers:
-        { 'User-Agent' => "PsUtilitiesGem - v#{PsUtilities::Version::VERSION}",
-          'Accept' => 'application/json',
-          'Content-Type' => 'application/json'}
-      }
-    end
-
   end
 end

data/lib/ps_utilities/pre_built_get.rb

@@ -33,22 +33,41 @@ module PsUtilities
     #   ]
     # }
 
+    # params = {dcid: "xxxxxxx"} or {id: "12345"}
+    def get_student(params)
+      # api_path = "/ws/v1/district/student/{dcid}?expansions=school_enrollment,contact&q=student_username==xxxxxx237"
+      ps_dcid    = params[:dcid] || params[:dc_id] || params[:id]
+      api_path   = "/ws/v1/student/#{ps_dcid.to_i}"
+      options    = { query:
+                      { "extensions" => "s_stu_crdc_x,activities,c_studentlocator,u_students_extension,u_studentsuserfields,s_stu_ncea_x,s_stu_edfi_x,studentcorefields",
+                        "expansions" => "demographics,addresses,alerts,phones,school_enrollment,ethnicity_race,contact,contact_info,initial_enrollment,schedule_setup,fees,lunch"
+                      }
+                    }
+      return {"errorMessage"=>{"message"=>"A valid dcid must be entered."}} if "#{ps_dcid.to_i}".eql? "0"
+
+      answer = api(:get, api_path, options)
+      { student: (answer["student"] || []) }
+    end
+
     # params = {username: "xxxxxxx"} or {local_id: "12345"}
-    def get_one_student(params)
+    def find_student(params)
       # api_path = "/ws/v1/district/student?expansions=school_enrollment,contact&q=student_username==xxxxxx237"
       api_path   = "/ws/v1/district/student"
-      options    = {query:
-                    {"expansions" => "school_enrollment,contact,contact_info"}}
+      options    = { query:
+                    {"expansions" => "contact,contact_info,phones"}}
       query  = []
       query << "student_username==#{params[:username]}"  if params.has_key?(:username)
       query << "local_id==#{params[:local_id]}"          if params.has_key?(:local_id)
 
       options[:query]["q"] = query.join(";")
+      pp options
       return {"errorMessage"=>{"message"=>"A valid parameter must be entered."}} if query.empty?
 
       answer = api(:get, api_path, options)
       { student: (answer.dig("students","student") || []) }
     end
+    alias_method :find_student_by_local_id, :find_student
+    alias_method :find_student_by_username, :find_student
     # {student:
     #   {"id"=>5023,
     #    "local_id"=>112193,

data/lib/ps_utilities/pre_built_post.rb

@@ -2,6 +2,267 @@ module PsUtilities
 
   module PreBuiltPost
 
+    # params[:students] (Array of Hashes) - kids with their attributes
+    # params = {dcid: 7531, student_id: 23456}
+    # or
+    # params = { [ {dcid: 7531, student_id: 23456},
+    #               {dcid: 9753, student_id: 65432} ] }
+    def create_students(params)
+      action   = "INSERT"
+      kids_api_array = build_kids_api_array(action, params)
+      options  = { body: { students: { student: kids_api_array } }.to_json }
+      answer = api(:post, "/ws/v1/student", options)
+    end
+    alias_method :create_student, :create_students
+    # { "results": {
+    #     "update_count": 2
+    #     "result": [
+    #       {  "client_uid": 124,
+    #          "status": "SUCCESS",
+    #          "action": "INSERT",
+    #          "success_message" :{
+    #            "id": 442,
+    #            "ref": "https://server/ws/v1/student/442" }
+    #        },
+    #        { ... }
+    #     ]
+    #   }
+    # }
+
+    # params[:students] (Array of Hashes) - kids with their attributes
+    def update_students(params)
+      action = "UPDATE"
+      kids_api_array = build_kids_api_array(action, params)
+      options  = { body: { students: { student: kids_api_array } }.to_json }
+      answer = api(:post, "/ws/v1/student", options)
+    end
+    alias_method :update_student, :update_students
+    # { "results": {
+    #     "update_count": 2
+    #     "result": [
+    #       {  "client_uid": 124,
+    #          "status": "SUCCESS",
+    #          "action": "INSERT",
+    #          "success_message" :{
+    #            "id": 442,
+    #            "ref": "https://server/ws/v1/student/442" }
+    #        },
+    #        { ... }
+    #     ]
+    #   }
+    # }
+
+    def build_kids_api_array(action, params)
+      unless params[:students].is_a? Array
+        return {"errorMessage"=>{"message"=>"Student Data (in Hash format) must be in an Array."}}
+      end
+      kids_api_array  = []
+      params[:students].each do |kid|
+        kid[:las_extensions] = true if params[:las_extensions]
+        kids_api_array << build_kid_attributes(action, kid)
+      end
+      return kids_api_array
+    end
+
+    def build_kid_attributes(action, kid)
+      # ALWAYS NEEDED INFO
+      attribs                        = {action: action}
+      attribs[:id]                   = kid[:id] || kid[:dcid]
+      attribs[:client_uid]           = kid[:student_id].to_s
+      attribs[:student_username]     = kid[:username]
+
+      # REQUIRED ON ENROLLMENT (optional later)
+      attribs[:name]                 = {}
+      case action
+      when 'INSERT'
+        # must be set on creation
+        attribs[:local_id]  = kid[:oa_id].to_i
+        # to create an account both first and last name must be present
+        attribs[:name][:last_name]   = kid[:last_name]   if kid[:last_name] or kid[:first_name]
+        attribs[:name][:first_name]  = kid[:first_name]  if kid[:last_name] or kid[:first_name]
+        attribs[:name][:middle_name] = kid[:middle_name] if kid[:middle_name]
+        # school_enrollment can only be SET on INSERT!
+        attribs[:school_enrollment]  = {}
+        if kid[:enroll_status_code]
+          attribs[:school_enrollment][:enroll_status_code] = kid[:enroll_status_code]
+        elsif kid[:status_code]
+          attribs[:school_enrollment][:status_code]  = kid[:status_code]
+        end
+        attribs[:school_enrollment][:grade_level]    = kid[:grade_level]   if kid[:grade_level]
+        attribs[:school_enrollment][:entry_date]     = kid[:entry_date]    if kid[:entry_date]
+        attribs[:school_enrollment][:exit_date]      = kid[:exit_date]     if kid[:exit_date]
+        attribs[:school_enrollment][:school_number]  = kid[:school_number] if kid[:school_number]
+        attribs[:school_enrollment][:school_id]      = kid[:school_id]     if kid[:school_id]
+      when 'UPDATE'
+        # don't allow nil / blank name updates
+        attribs[:name][:last_name]   = kid[:last_name]   if kid[:last_name]
+        attribs[:name][:first_name]  = kid[:first_name]  if kid[:first_name]
+        attribs[:name][:middle_name] = kid[:middle_name] if kid[:middle_name]
+      end
+
+      # OPTIONAL
+      attribs[:contact] = {}
+      if kid[:emergency_phone1] && kid[:emergency_contact_name1]
+        attribs[:contact][:emergency_phone1]        = kid[:emergency_phone1]
+        attribs[:contact][:emergency_contact_name1] = kid[:emergency_contact_name1]
+      end
+      if kid[:emergency_phone2] && kid[:emergency_contact_name2]
+        attribs[:contact][:emergency_phone2]        = kid[:emergency_phone2]
+        attribs[:contact][:emergency_contact_name2] = kid[:emergency_contact_name2]
+      end
+      if kid[:doctor_phone] && kid[:doctor_name]
+        attribs[:contact][:doctor_phone]  = kid[:doctor_phone]
+        attribs[:contact][:doctor_name]   = kid[:doctor_name]
+      end
+      attribs[:contact][:guardian_email]  = kid[:guardian_email]   if kid[:guardian_email]
+      attribs[:contact][:guardian_fax]    = kid[:guardian_fax]     if kid[:guardian_fax]
+      attribs[:contact][:mother]          = kid[:mother]           if kid[:mother]
+      attribs[:contact][:father]          = kid[:father]           if kid[:father]
+      attribs[:contact] = nil            if attribs[:contact].empty?
+      #
+      attribs[:demographics] = {}
+      attribs[:demographics][:gender]     = kid[:gender]           if kid[:gender]
+      attribs[:demographics][:birth_date] = kid[:birth_date]       if kid[:birth_date]
+      attribs[:demographics][:projected_graduation_year] = kid[:projected_graduation_year] if kid[:projected_graduation_year]
+      attribs[:demographics][:ssn]        = kid[:ssn]              if kid[:ssn]
+      #
+      attribs[:schedule_setup] = {}
+      attribs[:schedule_setup][:home_room]   = kid[:home_room]     if kid[:home_room]
+      attribs[:schedule_setup][:next_school] = kid[:next_school]   if kid[:next_school]
+      attribs[:schedule_setup][:sched_next_year_grade] = kid[:sched_next_year_grade] if kid[:sched_next_year_grade]
+      #
+      attribs[:school_enrollment] = {}
+      if kid[:enroll_status_code]
+        attribs[:school_enrollment][:enroll_status_code]  = kid[:enroll_status_code]
+      elsif kid[:status_code]
+        attribs[:school_enrollment][:status_code]         = kid[:status_code]
+      end
+      attribs[:school_enrollment][:grade_level]    = kid[:grade_level]   if kid[:grade_level]
+      attribs[:school_enrollment][:entry_date]     = kid[:entry_date]    if kid[:entry_date]
+      attribs[:school_enrollment][:exit_date]      = kid[:exit_date]     if kid[:exit_date]
+      attribs[:school_enrollment][:school_number]  = kid[:school_number] if kid[:school_number]
+      #
+      attribs[:contact_info]     = {email: kid[:email]}           if kid[:email]
+      attribs[:phone]            = {main: {number: kid[:mobile]}} if kid[:mobile]
+
+      # Update LAS Database Extensions as needed
+      attribs["_extension_data"] = calc_las_extensions(kid)      if kid[:las_extensions].to_s.eql?("true")
+
+      # return attributes - first remove, nils, empty strings and empty hashes
+      answer = attribs.reject { |k,v| v.nil? || v.to_s.empty? || v.to_s.eql?("{}")}
+      pp answer
+      return answer
+    end
+    # Data structure to send to API
+    # options = {body: {
+    #      "students":{
+    #         "student":[
+    #            {
+    #               "client_uid":"124",
+    #               "action":"UPDATE",
+    #               "id":"442",
+    #               "name":{
+    #                  "first_name":"Aaronia",
+    #                  "last_name":"Stephaniia"
+    #               },
+    #            },
+    #            { ... }
+    #         ]
+    #      }
+    #   }
+    # }
+
+    def calc_las_extensions(kid)
+      # attribs = {}
+      # attribs["_table_extension"] = []
+      attribs = { "_table_extension" => [] }
+      if kid[:email] or kid[:preferred_name]
+        db_extensions =
+          { "recordFound"=>false,
+            "name"=>"u_students_extension",
+            "_field"=> [ ]
+          }
+        if kid[:email]
+          db_extensions["_field"] << {"name"=>"student_email", "type"=>"String", "value"=>"#{kid[:email]}"}
+        end
+        if kid[:preferredname]
+          db_extensions["_field"] << {"name"=>"preferredname", "type"=>"String", "value"=>"#{kid[:preferredname]}"}
+        end
+        if kid[:preferred_name]
+          db_extensions["_field"] << {"name"=>"preferredname", "type"=>"String", "value"=>"#{kid[:preferred_name]}"}
+        end
+        attribs["_table_extension"] << db_extensions
+        # { "recordFound"=>false,
+        #   "name"=>"u_students_extension",
+        #   "_field"=> [
+        #     {"name"=>"preferredname", "type"=>"String", "value"=>"Niko"},
+        #     {"name"=>"student_email", "type"=>"String", "value"=>"#{kid[:email]}"}
+        #   ]
+        # }
+      end
+      if kid[:transcriptaddrline1] or kid[:transcriptaddrline2] or
+          kid[:transcriptaddrcity] or kid[:transcriptaddrstate] or
+          kid[:transcriptaddrzip]  or kid[:transcriptaddrcountry]
+        db_extensions =
+          { "recordFound"=>false,
+            "name"=>"u_studentsuserfields",
+            "_field"=> [ ]
+          }
+        if kid[:transcriptaddrline1]
+          db_extensions["_field"] << {"name"=>"transcriptaddrline1", "type"=>"String", "value"=>"#{kid[:transcriptaddrline1]}"}
+        end
+        if kid[:transcriptaddrline2]
+          db_extensions["_field"] << {"name"=>"transcriptaddrline2", "type"=>"String", "value"=>"#{kid[:transcriptaddrline2]}"}
+        end
+        if kid[:transcriptaddrcity]
+          db_extensions["_field"] << {"name"=>"transcriptaddrcity", "type"=>"String", "value"=>"#{kid[:transcriptaddrcity]}"}
+        end
+        if kid[:transcriptaddrzip]
+          db_extensions["_field"] << {"name"=>"transcriptaddrzip", "type"=>"String", "value"=>"#{kid[:transcriptaddrzip]}"}
+        end
+        if kid[:transcriptaddrstate]
+          db_extensions["_field"] << {"name"=>"transcriptaddrstate", "type"=>"String", "value"=>"#{kid[:transcriptaddrstate]}"}
+        end
+        if kid[:transcriptaddrcountry]
+          db_extensions["_field"] << {"name"=>"transcriptaddrcountry", "type"=>"String", "value"=>"#{kid[:transcriptaddrcountry]}"}
+        end
+        attribs["_table_extension"] << db_extensions
+        # { "recordFound"=>false,
+        #   "name"=>"u_studentsuserfields",
+        #   "_field"=> [
+        #     {"name"=>"transcriptaddrzip", "type"=>"String", "value"=>75230},
+        #     {"name"=>"transcriptaddrcountry", "type"=>"String", "value"=>"United States"},
+        #     {"name"=>"transcriptaddrcity", "type"=>"String", "value"=>"dallas"},
+        #     {"name"=>"transcriptaddrstate", "type"=>"String", "value"=>"Texas"},
+        #     {"name"=>"transcriptaddrline1", "type"=>"String", "value"=>"6138 meadow rd"}
+        #   ]
+        # }
+      end
+      pp attribs
+      attribs
+    end
+    # to inject into _extension_data
+    # { "_table_extension"=> [
+    #     { "recordFound"=>false,
+    #       "name"=>"u_students_extension",
+    #       "_field"=> [
+    #         {"name"=>"preferredname", "type"=>"String", "value"=>"Jimmy"},
+    #         {"name"=>"student_email", "type"=>"String", "value"=>"bbaaccdd@las.ch"}
+    #       ]
+    #     },
+    #     { "recordFound"=>false,
+    #       "name"=>"u_studentsuserfields",
+    #       "_field"=> [
+    #         {"name"=>"transcriptaddrzip", "type"=>"String", "value"=>8154},
+    #         {"name"=>"transcriptaddrcountry", "type"=>"String", "value"=>"Switzerland"},
+    #         {"name"=>"transcriptaddrcity", "type"=>"String", "value"=>"Leysin"},
+    #         {"name"=>"transcriptaddrstate", "type"=>"String", "value"=>"Vaud"},
+    #         {"name"=>"transcriptaddrline1", "type"=>"String", "value"=>"6789 linden st"}
+    #       ]
+    #     }
+    #   ]
+    # }
+
   end
 
 end

data/lib/ps_utilities/version.rb

@@ -1,5 +1,5 @@
 module PsUtilities
   module Version
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ps_utilities
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Lee Weisbecker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty