ps_utilities 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d12612f8c4d8b6ce0ee6a52c4d30748c5ca12b1f8414478d0f2164f8aa79295e
-  data.tar.gz: 5e0cbd4742dd42f98679cdea0356f1714e0ae23b878adba319cc1e33c7c901f4
+  metadata.gz: daddd46f3c769ec3b61c29558b7cc82d70ea60372eadf8b5b01bba22f1a37068
+  data.tar.gz: 31cdcb88c3c8e66a5fd1c5005cf00e62eb1a1d8cb8000db52ef63c1ef0437e51
 SHA512:
-  metadata.gz: eb7bca650ace01f55b015bd52db6385c0b5d9fc1bdd99eac873bc6f9f4aebde2b05d51eb65226f9eab43f379d280daf8e423d03d461660810d7ecead03ed1322
-  data.tar.gz: 44d0548cea631ab20b45d21667c96611321eac42f7f5ef11c21239abde10984ec1f25d013ada635a2c66fede989c11e20927b0be3ed3516dc59bc8a2344ae8e7
+  metadata.gz: 1aea5bd941ef10d5373fb9409aa04fece491cf148c1acce8d9a5000309e4c079818e41b954a7f91bfb11ac582c0fb1ac5f97bb16b9d631f149c4a83ec7d12839
+  data.tar.gz: 577b9af25d14b005a8e57126c00ace8e98021062dc4ef03e752067dea68ea206523d91564cc299c74643b5bf79408399c2b8e799daf7f6411089b3dcb86fa563

data/lib/ps_utilities/connection.rb

@@ -24,18 +24,19 @@ module PsUtilities
   # @note You should use environment variables to initialize your server.
   class Connection
 
-    attr_reader :credentials, :headers, :base_uri, :auth_path, :version
+    attr_reader :credentials, :headers, :base_uri, :auth_path, :auth_token
+    attr_reader :version
 
     include PsUtilities::PreBuiltGet
     include PsUtilities::PreBuiltPut
     include PsUtilities::PreBuiltPost
 
     def initialize(attributes: {}, headers: {})
+      @version     = "v#{PsUtilities::Version::VERSION}"
       @credentials = attr_defaults.merge(attributes)
-      @headers     = header_defaults.merge(headers)
       @base_uri    = credentials[:base_uri]
       @auth_path   = credentials[:auth_endpoint]
-      @version     = "v#{PsUtilities::Version::VERSION}"
+      @headers     = header_defaults.merge(headers)
 
       raise ArgumentError, "missing client_secret" if credentials[:client_secret].nil?  or
                                                       credentials[:client_secret].empty?
@@ -45,24 +46,14 @@ module PsUtilities
                                                       credentials[:base_uri].empty?
     end
 
-    # with no command it just authenticates
-    def run(command: nil, params: {}, api_path: "", options: {})
+    # with no command it just checks authenticates if needed
+    def run(command: nil, api_path: "", options: {}, params: {})
       authenticate   unless token_valid?
+      @headers[:headers].merge!('Authorization' => 'Bearer ' + authorized_token)
       case command
       when nil, :authenticate
-        # authenticate            unless token_valid?
-      # when :get
-      #   api(:get, api_path, options)        unless api_path.empty?
-      # when :put
-      #   send(:api, :put, api_path, options) unless api_path.empty?
-      # when :post
-      #   api(, api_path, options)            unless api_path.empty?
-      when :get, :put, :post
+      when :delete, :get, :patch, :post, :put
         api(command, api_path, options)         unless api_path.empty?
-      # when :get, :put, :post
-      #   send(command, api_path, options)        unless api_path.empty?
-      # when :get, :put, :post
-      #   send(:api, command, api_path, options)  unless api_path.empty?
       else
         send(command, params)
       end
@@ -70,71 +61,22 @@ module PsUtilities
 
     private
 
-    # options = {query: {}}
-    def api(verb, api_path, options={})
-      count   = 0
-      retries = 3
-      ps_url  = base_uri + api_path
-      options = options.merge(headers)
-      begin
-        HTTParty.send(verb, ps_url, options)
-      rescue Net::ReadTimeout, Net::OpenTimeout
-        if count < retries
-          count += 1
-          retry
-        else
-          { error: "no response (timeout) from URL: #{url}"  }
-        end
-      end
+    def authorized_token
+      "#{credentials[:access_token]}"
     end
 
-    # options = {query: {}}
-    def get(api_path, options={})
-      count   = 0
-      retries = 3
-      ps_url  = base_uri + api_path
-      options = options.merge(headers)
-      begin
-        HTTParty.get(ps_url, options)
-        # self.class.get(url, query: options[:query], headers: options[:headers])
-      rescue Net::ReadTimeout, Net::OpenTimeout
-        if count < retries
-          count += 1
-          retry
-        else
-          { error: "no response (timeout) from URL: #{url}"  }
-        end
-      end
-    end
-
-    # options = {body: {}}
-    def put(api_path, options={})
-      count   = 0
-      retries = 3
-      ps_url  = base_uri + api_path
-      options = options.merge(headers)
-      begin
-        HTTParty.get(ps_url, options)
-        # self.class.get(url, query: options[:query], headers: options[:headers])
-      rescue Net::ReadTimeout, Net::OpenTimeout
-        if count < retries
-          count += 1
-          retry
-        else
-          { error: "no response (timeout) from URL: #{url}"  }
-        end
-      end
-    end
-
-    # options = {body: {}}
-    def post(api_path, options={})
+    # verb = :delete, :get, :patch, :post, :put
+    # options = {query: {}, body: {}}
+    # get usually needs a query info
+    # put usually needs a body with data
+    def api(verb, api_path, options={})
       count   = 0
       retries = 3
       ps_url  = base_uri + api_path
       options = options.merge(headers)
+      pp options
       begin
-        HTTParty.get(ps_url, options)
-        # self.class.get(url, query: options[:query], headers: options[:headers])
+        HTTParty.send(verb, ps_url, options)
       rescue Net::ReadTimeout, Net::OpenTimeout
         if count < retries
           count += 1
@@ -147,15 +89,13 @@ module PsUtilities
 
     # In PowerSchool go to System>System Settings>Plugin Management Configuration>your plugin>Data Provider Configuration to manually check plugin expiration date
     def authenticate
-      @headers[:headers] ||= {}
       ps_url   = base_uri + auth_path
-      # ps_url = credentials[:base_uri] + credentials[:auth_endpoint]
       response = HTTParty.post(ps_url, {headers: auth_headers,
                                         body: 'grant_type=client_credentials'})
 
       @credentials[:token_expires] = Time.now + response.parsed_response['expires_in'].to_i
       @credentials[:access_token]  = response.parsed_response['access_token'].to_s
-      @headers[:headers].merge!('Authorization' => 'Bearer ' + credentials[:access_token])
+      # @headers[:headers].merge!('Authorization' => 'Bearer ' + credentials[:access_token])
 
       # throw error if no token returned -- nothing else will work
       raise AuthError.new("No Auth Token Returned",
@@ -190,8 +130,6 @@ module PsUtilities
         auth_endpoint:  ENV['PS_AUTH_ENDPOINT'] || '/oauth/access_token',
         client_id:      ENV['PS_CLIENT_ID'],
         client_secret:  ENV['PS_CLIENT_SECRET'],
-        # not recommended here - it changes (ok as a parameter though)
-        # access_token:   ENV['PS_ACCESS_TOKEN'] || nil,
       }
     end
 

data/lib/ps_utilities/pre_built_get.rb

@@ -2,31 +2,151 @@ module PsUtilities
 
   module PreBuiltGet
 
-    def get_active_students_count(params={})
-      # api_path = "/ws/v1/district/student/count?q=school_enrollment.enroll_status_code==0"
-      api_path = "/ws/v1/district/student/count"
-      options  = { query: {"q" => "school_enrollment.enroll_status_code==0"} }
-      get(api_path, options)
+    def get_all_active_students(params={})
+      params[:status_code] = 0
+      get_all_matching_students(params)
     end
 
-    def get_active_students_info(params={})
-      # api_path = "/ws/v1/district/student?q=school_enrollment.enroll_status==a&pagesize=500"
-      api_path     = "/ws/v1/district/student"
-      options = { query:
-                  {"q"        => "school_enrollment.enroll_status_code==0",
-                   "pagesize" => "500"} }
-      get(api_path, options)
+    # params = {username: "xxxxxxx"} or {local_id: "12345"}
+    # or       {enroll_status: "x"} or {status_code: "0"}
+    # or       {first_name: "John"} or {last_name: "Brown"}
+    # api_path = "/ws/v1/district/student?expansions=school_enrollment,contact&q=enroll_status==A;name.last_name==J*"
+    def get_all_matching_students(params)
+      params[:page_size] ||= 100
+      count    = get_matching_students_count(params)
+      pages    = calc_pages(count, params[:page_size])
+      answer   = {}
+      students = []
+      (1..pages).each do |page|
+        params[:page_number] = page
+        answer    = get_matching_students_page(params)
+        students << (answer.dig("students","student") || [])
+      end
+      # answer["students"]["student"] = students.flatten
+      # return answer
+      { students: students.flatten }
     end
+    # {students: [
+    #     {"id"=>4916, "local_id"=>112406, "student_username"=>"cccc406", "name"=>{"first_name"=>"Ssssss", "last_name"=>"CCCCC"}},
+    #     {"id"=>4932, "local_id"=>112520, "student_username"=>"jjjj520", "name"=>{"first_name"=>"Ppppppp", "last_name"=>"JJJJJJJJ"}},
+    #     {"id"=>4969, "local_id"=>112766, "student_username"=>"aaaa766", "name"=>{"first_name"=>"Sssss", "middle_name"=>"Aaaaaaaa", "last_name"=>"Aaaaaaaaaa"}}
+    #   ]
+    # }
 
-    # params = {username: "xxxxxxx"}
-    def get_one_student_record(params)
+    # params = {username: "xxxxxxx"} or {local_id: "12345"}
+    def get_one_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"}}
+      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(";")
+      return {"errorMessage"=>{"message"=>"A valid parameter must be entered."}} if query.empty?
+
+      answer = api(:get, api_path, options)
+      { student: (answer.dig("students","student") || []) }
+    end
+    # {student:
+    #   {"id"=>5023,
+    #    "local_id"=>112193,
+    #    "student_username"=>"xxxxxxx193",
+    #    "name"=>{"first_name"=>"Aaaaaaaaa", "last_name"=>"EEEEEEEEE"},
+    #    "school_enrollment"=>
+    #      {"enroll_status"=>"A",
+    #       "enroll_status_description"=>"Active",
+    #       "enroll_status_code"=>0,
+    #       "grade_level"=>12,
+    #       "entry_date"=>"2017-08-25",
+    #       "exit_date"=>"2018-06-09",
+    #       "school_number"=>33,
+    #       "school_id"=>6,
+    #       "entry_comment"=>"Promote Same School",
+    #       "full_time_equivalency"=>{"fteid"=>1070, "name"=>"FTE Value: 1"}
+    #      },
+    #    "contact"=>
+    #       {"guardian_email"=>"parent1@example.fr,parent2@example.ch", "mother"=>"EEEEEEE, Vvvvv", "father"=>"EEEEEEEE, Sssssss"},
+    #    "contact_info"=>{"email"=>"xxxxxxx193@xxxx.de"}
+    #   }
+    # }
+
+    private
+    # given page_size = 100
+    # 430 kids = 5 pages
+    # 400 kids = 4 pages
+    def calc_pages(count, page_size)
+      max_page  = ( (count.to_i-1) / page_size.to_i ).to_i + 1
+    end
+    # 5
+
+    # api_path = "/ws/v1/district/student/count?q=school_enrollment.enroll_status_code==0"
+    # returns: {"resource"=>{"count"=>423}}
+    def get_matching_students_count(params={})
+      api_path = "/ws/v1/district/student/count"
+
+      query  = []
+      query << "student_username==#{params[:username]}"  if params.has_key?(:username)
+      query << "local_id==#{params[:local_id]}"          if params.has_key?(:local_id)
+      query << "name.last_name==#{params[:last_name]}"   if params.has_key?(:last_name)
+      query << "name.first_name==#{params[:first_name]}" if params.has_key?(:first_name)
+      query << "school_enrollment.enroll_status==#{params[:enroll_status]}"    if params.has_key?(:enroll_status)
+      query << "school_enrollment.enroll_status_code==#{params[:status_code]}" if params.has_key?(:status_code)
+
+      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)  # {"resource"=>{"count"=>423}}
+      answer.dig("resource", "count").to_i
+    end
+    # 423
+
+    # params = {username: "xxxxxxx"} or {local_id: "12345"}
+    # or       {enroll_status: "x"} or {status_code: "0"}
+    # or       {first_name: "John"} or {last_name: "Brown"}
+    # api_path = "/ws/v1/district/student?expansions=school_enrollment,contact&q=student_username==xxxxxx237"
+    def get_matching_students_page(params)
       api_path = "/ws/v1/district/student"
-      options  = { query:
-                  { "q"          => "student_username==#{params[:username]}",
-                    "expansions" => "school_enrollment,contact,contact_info"} }
-      get(api_path, options)
+      params[:page_size]   ||= 100
+      params[:page_number] ||= 1
+      pp params
+      options = { query:
+                  { "pagesize"    => "#{params[:page_size]}",
+                    "page"        => "#{params[:page_number]}"} }
+      query  = []
+      query << "student_username==#{params[:username]}"  if params.has_key?(:username)
+      query << "local_id==#{params[:local_id]}"          if params.has_key?(:local_id)
+      query << "name.last_name==#{params[:last_name]}"   if params.has_key?(:last_name)
+      query << "name.first_name==#{params[:first_name]}" if params.has_key?(:first_name)
+      query << "school_enrollment.enroll_status==#{params[:enroll_status]}"    if params.has_key?(:enroll_status)
+      query << "school_enrollment.enroll_status_code==#{params[:status_code]}" if params.has_key?(:status_code)
+
+      options[:query]["q"] = query.join(";")
+      return {"errorMessage"=>{"message"=>"A valid parameter must be entered."}} if query.empty?
+      pp options
+      api(:get, api_path, options)
     end
+    # {"students"=>
+    #   {"@expansions"=>
+    #     "demographics, addresses, alerts, phones, school_enrollment, ethnicity_race, contact, contact_info, initial_enrollment, schedule_setup, fees, lunch",
+    #    "@extensions"=>
+    #     "s_stu_crdc_x,activities,c_studentlocator,u_students_extension,u_studentsuserfields,s_stu_ncea_x,s_stu_edfi_x,studentcorefields",
+    #    "student"=>
+    #     [{"id"=>4916, "local_id"=>112406, "student_username"=>"cccc406", "name"=>{"first_name"=>"Ssssss", "last_name"=>"CCCCC"}},
+    #      {"id"=>4932,
+    #       "local_id"=>112520,
+    #       "student_username"=>"jjjjjjjj520",
+    #       "name"=>{"first_name"=>"Ppppppp", "last_name"=>"JJJJJJJJ"}},
+    #      {"id"=>4969,
+    #       "local_id"=>112766,
+    #       "student_username"=>"aaaaaaaa766",
+    #       "name"=>{"first_name"=>"Sssss", "middle_name"=>"Aaaaaaaa", "last_name"=>"Aaaaaaaaaa"}}
+    #     ]
+    #   }
+    # }
+
 
   end
 

data/lib/ps_utilities/version.rb

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

metadata

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