openapply 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ea03a8e3bcfc34624d8c592e83d579600f62e323f00b5fbd563b3ef1b22616b
-  data.tar.gz: 915c89ae39776eb48b0d0533f6ba63b496cad6efb83ffa83d6f9f62ddfad983b
+  metadata.gz: d4ffbf0a9625607d27742d3d8eab1ab57802ce0f27dbfbb2ef2c5b52ec5da8d3
+  data.tar.gz: 457741241de4a8bf32e53feb790772a96393382934d1d7808d6c7b0cb10866aa
 SHA512:
-  metadata.gz: 860ecaf7e6d4ad6255edd1785f30c8e51b1dfee12de0747efa78c264d71e2f39983ae46ef31938785455ed0822ef23fc5f946ebf2d0eb950f1cb03e803466afc
-  data.tar.gz: 926f34f47b262ac63786edafbdbd62af3dc7ba3b786d36a26d9180c3404d2f907f74e7ec18247a2a150897eb3bc6e2d97f3fd108faaf0aea1b72ab18aba98723
+  metadata.gz: 60cd8ca6032a0f1e265eaf55e620432b8854d4e72e685235c7acaf5041a452d8506937db2da40ca038f23334a1a3b7491e0617d3df2f9bd998334c8bcbd03962
+  data.tar.gz: 9bcf4a9a22033330c1a4f4a168b9a33afcb1dbbff07ae29c616f0bb12cca68ee8c5f2aab2558d4c5aa620b799490341b26fb5e444be255301f4ce5da8f983471

data/README.md

@@ -5,19 +5,24 @@ This gem allows ruby access to the OpenApply API v1 - and supports the GET featu
 
 ### Still TODO
 
-* write PUTS methods
-* write a recursive custom query
-* speed response when returning large number of records
-* allow flattening and reject to work at any depth (recursion?)
+* allow csv and xlsx reports with default summary info only?
+* write PUTS methods - *currently api only allows status update*
+* allow flattening and reject to work at any depth (with recursion?)
+* write a recursive custom query - when results are more than one page
+* speed up response when returning large number of records? - **looks like API is slow not sure if this can be sped up**
 
 
 ### CHANGE LOG
 
-* **v0.2.2** - update compatible with 0.2.x - 2017-11-21
+* **v0.2.3** - compatible with 0.2.x - 2017-11-23
+  - allow detailed queries *(_by_id & _by_status)* to skip payment information
+  - allow array, csv & xlsx transformations to skip payment queries (when no payment_info requested)
+
+* **v0.2.2** - compatible with 0.2.x - 2017-11-21
   - refactor and test url timeouts
   - refactor openapply client
 
-* **v0.2.1** - update compatible with 0.2.x - 2017-11-20
+* **v0.2.1** - compatible with 0.2.x - 2017-11-20
   - convert api data into an array, csv or xlsx
   - allow data flattening prep for post processing
   - allow queries to lookup students with multiple statuses
@@ -115,6 +120,9 @@ Associates the above settings with HTTParty
 # ATTRIBUTES: id, [:keys_to_un-nest], [:keys_to_exclude]
 @oa.student_details_by_id(95)
 @oa.student_details_by_id(95, [:custom_fields], [:parent_guardian])
+# skip payment info -- (payments: [])
+@oa.student_details_by_id(95, [], [], false)
+@oa.student_details_by_id(95, [:custom_fields], [:parent_guardian], false)
 #
 # student summaries of a given status (recursively if more than on page)
 @oa.students_by_status('applied')
@@ -122,13 +130,20 @@ Associates the above settings with HTTParty
 # student details of a given status (recursively if more than on page)
 @oa.students_details_by_status('applied')
 @oa.students_details_by_status('applied', [:custom_fields])
-@oa.students_details_by_status('applied', nil, [:parent_guardian])
+@oa.students_details_by_status('applied', [], [:parent_guardian])
 @oa.students_details_by_status('applied', [:custom_fields], [:parent_guardian])
+# skip payment info (payments: [])
+@oa.students_details_by_status('applied', [], [], false)
+@oa.students_details_by_status('applied', [:custom_fields], [:parent_guardian], false)
 #
 # student details with multiple status (recursively if more than on page)
 @oa.students_details_by_statuses(['applied','enrolled'], [:custom_fields])
 @oa.students_details_by_statuses(['applied','enrolled'], nil, [:parent_guardian])
 @oa.students_details_by_statuses(['applied','enrolled'], [:custom_fields], [:parent_guardian])
+# speed up and skip payment info - returns [] in payment area
+@oa.students_details_by_statuses(['applied','enrolled'], [], [], false)
+# speed up and skip payment info - returns [] in payment area
+@oa.students_details_by_statuses(['applied','enrolled'], [:custom_fields], [:parent_guardian], false)
 #
 # create an array
 @oa.students_as_array_by_status('applied', [:custom_fields], [:parent_guardian], [:id, :name], {count: 1, keys: [:id, :name, :address]}, {count: 2, order: :newest, keys: [:date, :amount]} )

data/examples/demo/README.md

@@ -1,7 +1,9 @@
 ## Usage
-Start irb
+
+In the terminal:
+
 ```bash
-bundle install
+gem install openapply
 
 # irb
 # or

data/lib/openapply/convert.rb

@@ -29,10 +29,14 @@ module Convert
                                   guardian_info={}, payment_info={})
     #
     check = check_details_keys_validity(flatten_keys, reject_keys)
-    return check     unless check.nil? # or check[:error].nil?
+    return check           unless check.nil? # or check[:error].nil?
     #
+    # by default get payment info (unless no payment info is requested)
+    get_payments    = true
+    get_payments    = false    if payment_info.nil? or payment_info.empty?
+    # go get student details from api
     students_hash   = students_details_by_status( status,
-                                  flatten_keys, reject_keys)
+                                  flatten_keys, reject_keys, get_payments )
     #
     students_array  = students_hash_to_array( students_hash,
                                   student_keys, guardian_info, payment_info)
@@ -65,7 +69,7 @@ module Convert
                                   guardian_info={}, payment_info={})
     #
     check = check_details_keys_validity(flatten_keys, reject_keys)
-    return check     unless check.nil? # or check[:error].nil?
+    return check           unless check.nil? # or check[:error].nil?
     # check = check_header_keys_validity(student_keys, guardian_info, payment_info)
     # return check    unless check.nil?
     #
@@ -73,7 +77,7 @@ module Convert
                                   flatten_keys, reject_keys,
                                   student_keys, guardian_info, payment_info )
     #
-    return students_array     if students_array.is_a? Hash
+    return students_array      if students_array.is_a? Hash
     #
     student_csv_txt = students_array_to_csv( students_array )
   end
@@ -121,7 +125,7 @@ module Convert
                                   guardian_info={}, payment_info={})
     #
     check = check_details_keys_validity(flatten_keys, reject_keys)
-    return check     unless check.nil? # or check[:error].nil?
+    return check           unless check.nil? # or check[:error].nil?
     # check = check_header_keys_validity(student_keys, guardian_info, payment_info)
     # return check    unless check.nil?
     #
@@ -129,7 +133,7 @@ module Convert
                                   flatten_keys, reject_keys,
                                   student_keys, guardian_info, payment_info )
     #
-    return students_array     if students_array.is_a? Hash
+    return students_array      if students_array.is_a? Hash
     #
     students_xlsx    = students_array_to_xlsx( students_array )
 

data/lib/openapply/get_student.rb

@@ -51,6 +51,13 @@ module Get
   # * +flatten_keys+ - an array of keys to bring to the top level
   # (with this key prepened) -- default (blank does nothing)
   # * +reject_keys+ - an array of keys to remove from the data -- default (blank does nothing)
+  # * +get_payments+ - default is true (but needs double lookup) - faster when false!
+  #
+  # === Usage
+  #  students_details_by_id(95)
+  #  students_details_by_id(95, [], [], false)
+  #  students_details_by_id(95, [:custom_fields], [:parent_guardian])
+  #  students_details_by_id(95, [:custom_fields], [:parent_guardian], false)
   #
   # === Returned Data
   # returns the data structured as:
@@ -61,7 +68,7 @@ module Get
   #       payments: [ {} ]   # all payments made via openapply
   #     }
   #   }
-  def student_details_by_id(id, flatten_keys=[], reject_keys=[])
+  def student_details_by_id(id, flatten_keys=[], reject_keys=[], get_payments=true)
 
     check = check_details_keys_validity(flatten_keys, reject_keys)
     return check     unless check.nil? # or check[:error].nil?
@@ -69,7 +76,7 @@ module Get
     # get full student record and guardian information
     student_info = student_by_id( "#{id}" )
     # get student payment records
-    payment_info = payments_by_id( "#{id}" )
+    payment_info = payments_by_id( "#{id}" )     if get_payments.eql? true
 
     # be sure there is student data to process -- if not return an empty record
     return {student: {id: id, empty: []}}        if student_info.nil? or

data/lib/openapply/get_students.rb

@@ -10,16 +10,20 @@ module Get
   #
   # === Attributes
   #
-  # **flatten_keys** - brings these keys to the top level - prepending the group name to the key name -- we usually use:
+  # +flatten_keys+ - brings these keys to the top level - prepending the group name to the key name -- we usually use:
   #  flatten_keys = [:custom_fields]
-  # **reject keys** -- removes the data matching these keys -- we usually use:
+  # +reject keys+ -- removes the data matching these keys -- we usually use:
   #  reject_keys = [:parent_guardian] (since this is duplicated)
+  # * +get_payments+ - default is true (but needs double lookup) - faster when false!
   #
   # === Usage
   #  students_details_by_status('applied')
+  #  students_details_by_status('applied', [], [],false)
   #  students_details_by_status('applied', [:custom_fields], [:parent_guardian])
+  #  students_details_by_status('applied', [:custom_fields], [:parent_guardian], false)
   #  students_details_by_statuses(['applied','enrolled'])
   #  students_details_by_statuses(['applied','enrolled'], [:custom_fields], [:parent_guardian])
+  #  students_details_by_statuses(['applied','enrolled'], [:custom_fields], [:parent_guardian], false)
   #
   # === Returned Data
   # returns the data structured as:
@@ -38,7 +42,7 @@ module Get
   #       }
   #     ]
   #   }
-  def students_details_by_status( status, flatten_keys=[], reject_keys=[] )
+  def students_details_by_status( status, flatten_keys=[], reject_keys=[], get_payments=true )
 
     check = check_details_keys_validity(flatten_keys, reject_keys)
     return check     unless check.nil? # or check[:error].nil?
@@ -52,7 +56,7 @@ module Get
     error_ids       = []
     student_records = []
     ids[:student_ids].each do |id|
-      student = student_details_by_id( "#{id}", flatten_keys, reject_keys )
+      student = student_details_by_id( "#{id}", flatten_keys, reject_keys, get_payments )
 
       error_ids << id                          if student.nil? or
                                                   student[:student].nil? or

data/lib/openapply/version.rb

@@ -1,3 +1,3 @@
 module Openapply
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapply
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Bill Tihen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2017-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty