openapply 0.2.0

data/examples/demo/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    openapply (0.1.0)
+      httparty (~> 0.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  openapply (~> 0.1)
+
+BUNDLED WITH
+   1.15.4

data/examples/demo/README.md

@@ -0,0 +1,56 @@
+## Usage
+Start irb
+```bash
+bundle install
+
+# irb
+# or
+pry
+```
+
+and run this code (or play )
+```ruby
+require 'pp'
+require 'openapply'
+require_relative './demo_site'
+
+
+# BASIC USAGE (see readme)
+# use the .rbenv-vars for a simple setup
+@oa    = Openapply::Client.new()
+@oa.one_student_record_by_id(95)
+
+# see settings
+@oa.api_url
+@oa.api_key
+@oa.base_path
+@oa.api_timeout
+@oa.api_reply_count
+# replace record_count with reply count
+# @oa.reply_count
+```
+
+* or More advanced - multiple OA sites
+```ruby
+
+require 'pp'
+require 'openapply'
+require_relative './demo_site'
+
+# use a class override in order to interact with multiple oa sites
+@demo  = DemoSite.new()
+
+# get 5 summary records
+hash  = @demo.custom_student_summaries('applied', nil, nil, 5)
+
+# get all students
+hash  = students_by_status('applied')
+array = @demo.students_hash_to_students_array(hash)
+csv_1 = @demo.students_array_into_csv_string(array)
+# @demo.send_csv_to_server(csv_1, 'host.example.io', 'user', '/home/user/file1.csv')
+
+# SLOW takes minutes
+csv_2 = @demo.student_ids_names_by_status_to_csv('applied')
+# @demo.send_csv_to_server(csv_2, 'host.example.io', 'user', '/home/user/file2.csv')
+
+```

data/examples/demo/demo_site.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require 'csv'
+require 'net/scp'
+require 'stringio'
+require 'httparty'
+
+class DemoSite < Openapply::Client
+  include HTTParty
+
+  # these next two are needed in a subclass to interact with multiple OA sites
+  localized_url = ENV['OA_BASE_URI']
+  base_uri localized_url
+
+  def api_key
+    ENV['OA_AUTH_TOKEN']
+  end
+
+  # Business logic: create a csv file of a given status & transfer it
+
+  def student_ids_names_by_status_to_csv(status)
+    # best is to check if status is in the list of valid statuses
+    return { error: "no status"}  if status.to_s.eql? ""
+
+    # # this next step is slow (for 100 kids) - investigate
+    # student_hash  = all_students_all_data_by_status(status)
+    student_hash  = students_by_status(status)
+
+
+    student_array = students_hash_to_students_array(student_hash)
+    student_csv   = students_array_into_csv_string(student_array)
+  end
+
+  def students_hash_to_students_array(hash)
+    array   = []
+    csv_keys = [:id, :first_name, :last_name]
+
+    headers  = csv_keys.map{|k| k.to_s}
+    # headers  = ['id','first_name','last_name']
+    puts headers
+
+    array  << headers
+
+    # don't loop if hash is empty
+    return headers      if hash.empty?
+
+    hash[:students].each do |record|
+      row = []
+      # skip record if empty
+      # puts "#{record[:record]}\n"
+      next              if record.nil?
+      next              if record.nil?
+      next              if record.empty?
+
+      # find the desired fields and add them to the csv
+      csv_keys.each{ |key| row << record[key] }
+
+      # add row to the master arrary
+      array << row
+    end
+    return array
+  end
+
+  def students_array_into_csv_string(array)
+    return ""              if array.nil?
+    return ""              if array.empty?
+    # https://stackoverflow.com/questions/4822422/output-array-to-csv-in-ruby
+    csv_string = CSV.generate do |csv|
+      array.each do |row|
+        csv << row
+      end
+    end
+    return csv_string
+  end
+
+  def send_csv_to_server(csv_string, host_name, user_name, remote_path_n_file)
+    # https://www.safaribooksonline.com/library/view/ruby-cookbook/0596523696/ch06s15.html
+    xfer_csv = StringIO.new( csv_string )
+
+    # setup using an SSH KEY instead of password
+    # http://www.rubydoc.info/github/delano/net-scp/Net/SCP
+    Net::SCP.start(host_name, user_name) do |scp|
+      # asynchronous upload; call returns immediately
+      channel = scp.upload( xfer_csv, remote_path_n_file )
+      channel.wait
+    end
+    # ensure file has proper permissions
+    Net::SSH.start(host_name, user_name) do |ssh|
+      # Capture all stderr and stdout output from a remote process
+      output = ssh.exec!("chmod 0775 #{remote_path_n_file}")
+    end
+  end
+
+end

data/lib/openapply/get_student.rb

@@ -0,0 +1,277 @@
+module Get
+
+  # Record details for ONE student - this API return has the parent info 2x!
+  #
+  # @param
+  # ==== Attributes
+  # * +student_id+ - openapply student_id
+  # * +options+ - see httparty options
+  #
+  # ==== Example code
+  #  @demo = Openapply.new
+  #  @demo.student_by_id(96)
+  #
+  # ==== Result
+  # {:student=>
+  #   {:id=>96,
+  #    :serial_number=>86,
+  #    :custom_id=>"86",
+  #    :applicant_id=>"00000086",
+  #    :email=>"Jerry.Patel@eduvo.com",
+  #    :first_name=>"Jerry",
+  #    :last_name=>"Patel",
+  #    ...,
+  #    :profile_photo=>
+  #     "https://openapply-sandbox-devel-01.s3.amazonaws.com/uploads/student/avatar/000/000/096/m_9.jpg?v=1499755604",
+  #    :profile_photo_updated_at=>"2017-07-11T14:46:44.000+08:00",
+  #    :custom_fields=>
+  #     {:language=>"Hindi",
+  #      :nationality=>"Indian (India)",
+  #      :referral_source=>"Friends",
+  #      :middle_name_s=>"Danesh",
+  #      :mobile_phone=>"852 4545 1195",
+  #      ...,
+  #      :school_file=>
+  #       {:id=>73,
+  #        :filename=>"Robert_Patel_Report.pdf",
+  #        :url=>"https://demo.openapply.com/api/v1/secure_download/files/73"},
+  #      :has_your_child_attended_school_regularly=>"Yes",
+  #      ...,
+  #      :parent_guardian=>
+  #       [{:id=>268,
+  #         :serial_number=>257,
+  #         :custom_id=>"257",
+  #         :name=>"James Patel",
+  #         :first_name=>"James",
+  #         :last_name=>"Patel",
+  #         ...,
+  #         :custom_fields=>
+  #          {:title=>"CFO",
+  #           :treat_parent_as_emergency_contact=>"Yes",
+  #           :home_telephone=>"",
+  #           ...,
+  #           :parent_residency=>"Citizen"}},
+  #        {:id=>267,
+  #         :serial_number=>256,
+  #         :custom_id=>"256",
+  #         ...,
+  #         :profile_photo=>
+  #          "https://openapply-sandbox-devel-01.s3.amazonaws.com/uploads/parent/avatar/000/000/267/patel_mom.jpg?v=1499755607",
+  #         :profile_photo_updated_at=>"2017-07-11T14:46:47.000+08:00",
+  #         :parent_id=>"256",
+  #         :custom_fields=>
+  #          {:title=>"",
+  #           :treat_parent_as_emergency_contact=>"Yes",
+  #           ...,
+  #           :parent_prior_countries_list=>nil,
+  #           :parent_residency=>"Citizen"}}],
+  #      :siblings_information=>
+  #       [{:first_name=>"Deidre",
+  #         :last_name=>"Patel",
+  #         :gender=>"Female",
+  #         :birth_date=>"2008-06-06"}],
+  #      :emergency_contact=>[],
+  #      :prior_school_list=>
+  #       [{:school_name=>"Michael Varner Elementary",
+  #         :school_country=>"United States",
+  #         :school_contact_name=>"Ann Farris",
+  #         :school_contact_phone=>"(415) 777-0876"},
+  #        {:school_name=>"ISS International School",
+  #         :school_contact_name=>"Taylor Michaels",
+  #         :school_contact_phone=>"65 6235 5844",
+  #         :school_country=>"Singapore"}],
+  #      :immunization_record=>[],
+  #      :health_information=>[]},
+  #    :parent_ids=>[268, 267]},
+  #  :linked=>
+  #     {:parents=>
+  #       [{:id=>268,
+  #         :serial_number=>257,
+  #         :custom_id=>"257",
+  #         :name=>"James Patel",
+  #         :first_name=>"James",
+  #         :last_name=>"Patel",
+  #         ...,
+  #         :address=>"1641 26th Avenue",
+  #         :address_ii=>"",
+  #         :city=>"San Francisco",
+  #         :state=>"California",
+  #         :postal_code=>"94122",
+  #         :country=>"United States",
+  #         ...,
+  #         :custom_fields=>
+  #          {:title=>"CFO",
+  #           :treat_parent_as_emergency_contact=>"Yes",
+  #           :home_telephone=>"",
+  #           ...,
+  #           :parent_residency=>"Citizen"}},
+  #        {:id=>267,
+  #         :serial_number=>256,
+  #         :custom_id=>"256",
+  #         :name=>"Jane Patel",
+  #         :first_name=>"Jane",
+  #         ...,
+  #         :profile_photo=>
+  #          "https://openapply-sandbox-devel-01.s3.amazonaws.com/uploads/parent/avatar/000/000/267/patel_mom.jpg?v=1499755607",
+  #         :profile_photo_updated_at=>"2017-07-11T14:46:47.000+08:00",
+  #         :parent_id=>"256",
+  #         :custom_fields=>
+  #          {:title=>"",
+  #           :treat_parent_as_emergency_contact=>"Yes",
+  #           ...,
+  #           :parent_residency=>"Citizen"}}]}}
+  def student_by_id(student_id, options ={})
+    url = "#{api_path}#{student_id}?auth_token=#{api_key}"
+    return oa_answer( url, options )
+  end
+  alias_method :student, :student_by_id
+
+
+  # Payment details for ONE student
+  #
+  # ==== Attributes
+  # * +student_id+ - openapply student_id
+  # * +options+ - see httparty options
+  #
+  # ==== Example code
+  #  @demo = Openapply.new
+  #  @demo.payments_by_id(96)
+  #
+  # ==== Result
+  # {:payments=>
+  #   [{:invoice_status=>"Paid",
+  #     :type=>"Application",
+  #     :invoice_number=>1047,
+  #     :amount=>"90.0",
+  #     :issue_date=>"2016-03-11",
+  #     :due_date=>"2016-03-31",
+  #     :payment_method=>"check",
+  #     :payment_date=>"2013-03-07"}]}
+  def payments_by_id(student_id, options={})
+    url = "#{api_path}#{student_id}/payments?auth_token=#{api_key}"
+    return oa_answer( url, options )
+  end
+  alias_method :payments, :payments_by_id
+
+
+  # Combines the student_by_id & payments_by_id into one call with all the data
+  #
+  # ==== Attributes
+  # * +student_id+ - openapply student_id
+  #
+  # ==== Example code
+  #  @demo = Openapply.new
+  #  @demo.student_details_by_id(96)
+  #
+  # ==== Results
+  # NOTE: gaurdian info is moved to the top level - along with ID
+  #  {student: {
+  #       id=95,
+  #       record: {},
+  #       guardians: [],
+  #       payments: []
+  #    }
+  #  }
+  #
+  # for example:
+  #
+  # {:student=>
+  #   {:id=>96,
+  #    :record=>
+  #     {:id=>96,
+  #      :serial_number=>86,
+  #      :custom_id=>"86",
+  #      :applicant_id=>"00000086",
+  #      :email=>"Jerry.Patel@eduvo.com",
+  #      :first_name=>"Jerry",
+  #      :last_name=>"Patel",
+  #      ...,
+  #      :profile_photo=>
+  #       "https://openapply-sandbox-devel-01.s3.amazonaws.com/uploads/student/avatar/000/000/096/m_9.jpg?v=1499755604",
+  #      :profile_photo_updated_at=>"2017-07-11T14:46:44.000+08:00",
+  #      :custom_fields=>
+  #       {:language=>"Hindi",
+  #        :nationality=>"Indian (India)",
+  #        :referral_source=>"Friends",
+  #        ...,
+  #        :siblings_information=>
+  #         [{:first_name=>"Deidre",
+  #           :last_name=>"Patel",
+  #           :gender=>"Female",
+  #           :birth_date=>"2008-06-06"}],
+  #        :emergency_contact=>[],
+  #        :immunization_record=>[],
+  #        :health_information=>[]},
+  #      :parent_ids=>[268, 267]},
+  #    :payments=>
+  #     [{:invoice_status=>"Paid",
+  #       :type=>"Application",
+  #       :invoice_number=>1047,
+  #       :amount=>"90.0",
+  #       :issue_date=>"2016-03-11",
+  #       :due_date=>"2016-03-31",
+  #       :payment_method=>"check",
+  #       :payment_date=>"2013-03-07"}],
+  #    :guardians=>
+  #     [{:id=>268,
+  #       :serial_number=>257,
+  #       :custom_id=>"257",
+  #       :name=>"James Patel",
+  #       :first_name=>"James",
+  #       :last_name=>"Patel",
+  #       ...,
+  #       :custom_fields=>
+  #        {:title=>"CFO",
+  #         :treat_parent_as_emergency_contact=>"Yes",
+  #         :home_telephone=>"",
+  #         ...,
+  #         :parent_residency=>"Citizen"}},
+  #      {:id=>267,
+  #       :serial_number=>256,
+  #       :custom_id=>"256",
+  #       :name=>"Jane Patel",
+  #       :first_name=>"Jane",
+  #       :last_name=>"Patel",
+  #       ...,
+  #       :profile_photo=>
+  #        "https://openapply-sandbox-devel-01.s3.amazonaws.com/uploads/parent/avatar/000/000/267/patel_mom.jpg?v=1499755607",
+  #       :profile_photo_updated_at=>"2017-07-11T14:46:47.000+08:00",
+  #       :parent_id=>"256",
+  #       :custom_fields=>
+  #        {:title=>"",
+  #         :treat_parent_as_emergency_contact=>"Yes",
+  #         :home_telephone=>"",
+  #         ...,
+  #         :parent_residency=>"Citizen"}}]}}
+  def student_details_by_id(id, flatten = false)
+    student_info = student_by_id( "#{id}" )
+    payment_info = payments_by_id( "#{id}" )
+
+    # be sure there is data to process
+    return {student: {id: id, empty: []}}    if student_info.nil? or
+                                                student_info[:student].nil?
+                                                student_info[:student].empty?
+    guardians = []
+    guardians = student_info[:linked][:parents].dup unless
+                                                student_info[:linked].nil? or
+                                                student_info[:linked].empty? or
+                                                student_info[:linked][:parents].nil?
+    payments = []
+    payments = payment_info[:payments].dup   unless payment_info.nil? or
+                                                payment_info[:payments].nil?
+    # process meaningful data
+    record = student_info[:student].dup
+    # remove duplicated parental data fields
+    record[:custom_fields][:parent_guardian] = nil
+
+    return { student:
+              { id: id,
+                record: record,
+                payments: payments,
+                guardians: guardians,
+              }
+            }
+  end
+  alias_method :student_details, :student_details_by_id
+
+end