openapply 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ffbf0a9625607d27742d3d8eab1ab57802ce0f27dbfbb2ef2c5b52ec5da8d3
-  data.tar.gz: 457741241de4a8bf32e53feb790772a96393382934d1d7808d6c7b0cb10866aa
+  metadata.gz: 64954bcbf3fc679a31c6bf6bd1ca661f03d592cb070ec3950c29c161f0af35da
+  data.tar.gz: 9d18998d1f43f23d4b95ac06f2728c740379497762c99fbb36adb33c2511ba47
 SHA512:
-  metadata.gz: 60cd8ca6032a0f1e265eaf55e620432b8854d4e72e685235c7acaf5041a452d8506937db2da40ca038f23334a1a3b7491e0617d3df2f9bd998334c8bcbd03962
-  data.tar.gz: 9bcf4a9a22033330c1a4f4a168b9a33afcb1dbbff07ae29c616f0bb12cca68ee8c5f2aab2558d4c5aa620b799490341b26fb5e444be255301f4ce5da8f983471
+  metadata.gz: e47ea0252dd955498ee453746404b76c15d35d950cd4cb01c25ebfe03275d6a331fd853fb7705c733ea64e3accb637f6d1a2f4150f292aabe4181ec91ce16119
+  data.tar.gz: 3326b12158e1c250e9c2598cf98de6634fefacd113c4f7d8185b8e02c60cb54da19b877c002d5a673d966b0eb37f488551e9b20d72e92c9db160b71c02b48dd7

data/.gitignore

@@ -1,6 +1,6 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
+# /Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    openapply (0.2.4)
+      httparty (~> 0.15)
+      json (~> 2.1)
+      net-scp (~> 1.2)
+      net-ssh (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    hashdiff (0.3.7)
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    json (2.1.0)
+    multi_xml (0.6.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (4.2.0)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  openapply!
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  simplecov (~> 0.15)
+  webmock (~> 3.1)
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -14,6 +14,9 @@ This gem allows ruby access to the OpenApply API v1 - and supports the GET featu
 
 ### CHANGE LOG
 
+* **v0.2.4** - compatible with 0.2.x - 2017-11-23
+  - rubyzip 1.1.7 - has a serious security flaw - Axlsx and Roo cannot use rubyzip 1.2.1 -- YET (which doesn't have the flaw) - so xlsx features are disabled until rubyzip 1.2.1 can be used by both roo and axlsx.  **CSV** conversions are still usable
+
 * **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)
@@ -159,12 +162,13 @@ csv_string=@oa.students_as_csv_by_statuses(['applied','enrolled'],[:custom_field
 @oa.send_data_to_remote_server(csv_string, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
 
 # Create XLSX file
-@oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
-# multiple status into
-xlsx_obj=@oa.students_as_xlsx_by_statuses(['applied','enrolled'],[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
-#
-# send XLSX to a remote server as a file - using ssh-keys
-@oa.send_data_to_remote_server(xlsx, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.xlsx', '0750')
+# XLSX features DISABLED UNTIL AXLSX can work with RubyZip 1.2.1
+# @oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
+# # multiple status into
+# xlsx_obj=@oa.students_as_xlsx_by_statuses(['applied','enrolled'],[:custom_fields], [:parent_guardian], [:id, :name], {type: :guardians, count: 1, keys: [:id, :name, :address]}, {type: :payments, count: 2, order: :newest, keys: [:date, :amount]} )
+# #
+# # send XLSX to a remote server as a file - using ssh-keys
+# @oa.send_data_to_remote_server(xlsx, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.xlsx', '0750')
 ```
 
 #### INDIVIDUAL STUDENT QUERIES
@@ -240,14 +244,16 @@ csv=@oa.students_as_csv_by_status('applied',[:custom_fields], [:parent_guardian]
 # attributes: csv_string, srv_hostname, srv_username, srv_path_file, file_permissions(0750 - default if not specified)
 @oa.send_data_to_remote_server(csv, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
 #
-# Create a XLSX package
-@oa.students_as_xlsx_by_status('applied', nil, nil, [:id, :name], nil, {count: 2, order: :newest, keys: [:date, :amount]} )
-# all options
-xlsx=@oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {count: 1, keys: [:id, :name, :address]}, {count: 2, order: :newest, keys: [:date, :amount]} )
+# # Create a XLSX package
+# disabled until axlsx works with rubyzip 1.2.1
 #
-# send CSV to a remote server as a file - using ssh-keys
-# attributes: csv_string, srv_hostname, srv_username, srv_path_file, file_permissions(0750 - default if not specified)
-@oa.send_data_to_remote_server(xlsx, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
+# @oa.students_as_xlsx_by_status('applied', nil, nil, [:id, :name], nil, {count: 2, order: :newest, keys: [:date, :amount]} )
+# # all options
+# xlsx=@oa.students_as_xlsx_by_status('applied',[:custom_fields], [:parent_guardian], [:id, :name], {count: 1, keys: [:id, :name, :address]}, {count: 2, order: :newest, keys: [:date, :amount]} )
+# #
+# # send CSV to a remote server as a file - using ssh-keys
+# # attributes: csv_string, srv_hostname, srv_username, srv_path_file, file_permissions(0750 - default if not specified)
+# @oa.send_data_to_remote_server(xlsx, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
 ```
 
 #### CUSTOM GROUP QUERIES - summary data

data/examples/demo/Gemfile.lock

@@ -3,15 +3,22 @@ GEM
   specs:
     httparty (0.15.6)
       multi_xml (>= 0.5.2)
+    json (2.1.0)
     multi_xml (0.6.0)
-    openapply (0.1.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (4.2.0)
+    openapply (0.2.4)
       httparty (~> 0.15)
+      json (~> 2.1)
+      net-scp (~> 1.2)
+      net-ssh (~> 4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  openapply (~> 0.1)
+  openapply (~> 0.2)
 
 BUNDLED WITH
-   1.15.4
+   1.16.0

data/examples/demo/README.md

@@ -4,13 +4,59 @@ In the terminal:
 
 ```bash
 gem install openapply
+# or better still
+bundle install
 
-# irb
-# or
+irb
+# or better still
 pry
 ```
+Once in the REPL - follow the below instructions
 
-and run this code (or play )
+### Standard Usage - multiple classes accomodates multiple OpenApply Sites
+```ruby
+
+require 'pp'
+require 'date'
+require_relative './demo_site'
+
+# use a class override in order to interact with multiple oa sites
+# or extend functionality
+@my  = MySite.new()
+
+
+# get students with applied and enrolled status, flatten no fields,
+# remove the parent_guardian (duplicate) info,
+# move into the xlsx file the following data: studnet id and student name
+# parent address (line 1) and country, and no payment info
+@my.records_as_csv_to_file('applied', nil, [:parent_guardian],
+                              [:id, :name],
+                              {keys: [:address, :country]}, nil , "test-#{Date.today}.csv" )
+
+@my.records_as_csv_to_server( 'applied', nil, [:parent_guardian],
+                              [:id, :name],
+                              {keys: [:address, :country]}, nil )
+
+# DISABLED UNTIL AXLSX works with RubyZip 1.2.1
+# # get students with applied and enrolled status, flatten the custom_fields,
+# # remove the parent_guardian (duplicate) info,
+# # move into the xlsx file the following data: studnet id and student name
+# # parent address (line 1) and country, and the oldest three payment amounts & dates
+# @my.records_as_xlsx_to_file(  ['applied','enrolled'], [:custom_fields],
+#                               [:parent_guardian], [:id, :name],
+#                               {count: 2, keys: [:address, :country]},
+#                               {count: 3, order: :oldest, keys: [:amount, :date]}, "test-#{Date.today}.xlsx")
+#
+# @my.records_as_xlsx_to_server(['applied','enrolled'], [:custom_fields],
+#                               [:parent_guardian], [:id, :name],
+#                               {count: 2, keys: [:address, :country]},
+#                               {count: 3, order: :newest, keys: [:amount, :date]})
+
+# use cron or other similar tools to automate these processes
+```
+
+
+### Basic Usage using the gem directly - can only access one site
 ```ruby
 require 'openapply'
 
@@ -58,57 +104,20 @@ csv = @oa.students_as_csv_by_status( 'applied', nil, [:parent_guardian],
 # save csv string as a file locally
 open('test_file.csv', 'w') { |f| f.puts csv }
 
-# get students with applied and enrolled status, flatten the custom_fields,
-# remove the parent_guardian (duplicate) info,
-# move into the xlsx file the following data: studnet id and student name
-# parent address (line 1) and country, and the oldest three payment amounts & dates
-xlsx = @oa.students_as_xlsx_by_status(['applied','accepted'], [:custom_fields],
-                                      [:parent_guardian], [:id, :name],
-                                      {count: 2, keys: [:address, :country]},
-                                      {count: , order: :oldest, keys: [:amount, :date]})
+# DISABLED UNTIL AXLSX works with RubyZip 1.2.1
 #
-@oa.send_data_to_remote_server( xlsx, ENV['REMOTE_HOSTNAME'],    
-                                      ENV['REMOTE_USERNAME'], "#{ENV['REMOTE_PATH_FILE']}.xlsx", ENV['REMOTE_PERMISSIONS'])
-# save as a xlsx file locally
-xlsx.serialize('test_file.xlsx')
-
-```
-
-* or More advanced - multiple OA sites
-```ruby
-
-# require 'pp'
-require 'openapply'
-require_relative './demo_site'
+# # get students with applied and enrolled status, flatten the custom_fields,
+# # remove the parent_guardian (duplicate) info,
+# # move into the xlsx file the following data: studnet id and student name
+# # parent address (line 1) and country, and the oldest three payment amounts & dates
+# xlsx = @oa.students_as_xlsx_by_status(['applied','accepted'], [:custom_fields],
+#                                       [:parent_guardian], [:id, :name],
+#                                       {count: 2, keys: [:address, :country]},
+#                                       {count: , order: :oldest, keys: [:amount, :date]})
+# #
+# @oa.send_data_to_remote_server( xlsx, ENV['REMOTE_HOSTNAME'],    
+#                                       ENV['REMOTE_USERNAME'], "#{ENV['REMOTE_PATH_FILE']}.xlsx", ENV['REMOTE_PERMISSIONS'])
+# # save as a xlsx file locally
+# xlsx.serialize('test_file.xlsx')
 
-# use a class override in order to interact with multiple oa sites
-# or extend functionality
-@mine  = MySite.new()
-
-
-# get students with applied and enrolled status, flatten no fields,
-# remove the parent_guardian (duplicate) info,
-# move into the xlsx file the following data: studnet id and student name
-# parent address (line 1) and country, and no payment info
-@mine.records_as_csv_to_file(   'applied', nil, [:parent_guardian], [:id, :name],
-                                {keys: [:address, :country]}, nil , 'test.csv' )
-
-@mine.records_as_csv_to_server( 'applied', nil, [:parent_guardian], [:id, :name],
-                                {keys: [:address, :country]}, nil )
-
-# get students with applied and enrolled status, flatten the custom_fields,
-# remove the parent_guardian (duplicate) info,
-# move into the xlsx file the following data: studnet id and student name
-# parent address (line 1) and country, and the oldest three payment amounts & dates
-@mine.records_as_xlsx_to_file(  ['applied','enrolled'], [:custom_fields],
-                                [:parent_guardian], [:id, :name],
-                                {count: 2, keys: [:address, :country]},
-                                {count: 3, order: :oldest, keys: [:amount, :date]}, 'test.xlsx')
-
-@mine.records_as_xlsx_to_server(['applied','enrolled'], [:custom_fields],
-                                [:parent_guardian], [:id, :name],
-                                {count: 2, keys: [:address, :country]},
-                                {count: 3, order: :newest, keys: [:amount, :date]})
-
-# use cron or other similar tools to automate these processes
 ```

data/examples/demo/demo_site.rb

@@ -1,18 +1,49 @@
 #!/usr/bin/env ruby
 
 require 'httparty'
+require 'openapply'
 
 class MySite < Openapply::Client
   include HTTParty
 
-  # add customized site info
-  # (say you need to use both: demo.openapply.com and my.openapply.com) --
-  # this class defines my.openapply.com and its special needs
-  localized_url = ENV['MY_BASE_URI']
-  base_uri localized_url
+  # Defines OpenApply domain name from ENV-VARS
+  API_URL        = ENV['MY_API_BASE_URI']
 
+  # Defines the OpenApply path from ENV-VARS - default is 5 seconds
+  API_TIMEOUT    = (ENV['MY_API_TIMEOUT'].to_i || 5)
+
+  base_uri API_URL
+  default_timeout API_TIMEOUT
+
+  # Makes OpenApply domain name visible:
+  def api_url
+    API_URL
+  end
+
+  # make OpenApply timeout visible
+  def api_timeout
+    API_TIMEOUT
+  end
+
+  # Defines & makes visible OpenApply secret access key with ENV-VARS
   def api_key
-    ENV['MY_AUTH_TOKEN']
+    ENV['MY_API_AUTH_TOKEN']
+  end
+
+  # Defines and makes visib le the OpenApply path with ENV-VARS
+  def api_path
+    ENV['MY_API_PATH'] || "/api/v1/students/"
+  end
+
+  # Defines and makes visible the maximum records OpenApply should return
+  # (code default is 50 - OA default is 10 - doc says 100)
+  def api_records
+    ENV['MY_API_RECORDS'] || '50'
+  end
+
+  def initialize
+    @my_flatten_keys = [:custom_fields]
+    @my_reject_keys  = [:parent_guardian]
   end
 
   # defines remote host to recieve openapply data
@@ -40,21 +71,22 @@ class MySite < Openapply::Client
                                 "#{REMOTE_PATH_FILE}.csv", REMOTE_PERMISSIONS)
   end
 
-  def records_as_xlsx_to_file( status, flatten_keys=[],
-                                reject_keys=[], student_keys=[],
-                                guardian_info={}, payment_info={}, file )
-    data = students_as_xlsx_by_status( status, flatten_keys, reject_keys,
-                                student_keys, guardian_info, payment_info)
-    data.serialize(file)
-  end
-
-  def records_as_xlsx_to_server( status, flatten_keys=[],
-                                reject_keys=[], student_keys=[],
-                                guardian_info={}, payment_info={})
-    data = students_as_xlsx_by_status( status, flatten_keys, reject_keys,
-                                student_keys, guardian_info, payment_info)
-    send_data_to_remote_server( data, REMOTE_HOSTNAME, REMOTE_USERNAME,
-                                "#{REMOTE_PATH_FILE}.xlsx", REMOTE_PERMISSIONS)
-  end
+  # DISABLED UNTIL AXLSX works with rubyzip 1.2.1 or later
+  # def records_as_xlsx_to_file( status, flatten_keys=[],
+  #                               reject_keys=[], student_keys=[],
+  #                               guardian_info={}, payment_info={}, file )
+  #   data = students_as_xlsx_by_status( status, flatten_keys, reject_keys,
+  #                               student_keys, guardian_info, payment_info)
+  #   data.serialize(file)
+  # end
+  #
+  # def records_as_xlsx_to_server( status, flatten_keys=[],
+  #                               reject_keys=[], student_keys=[],
+  #                               guardian_info={}, payment_info={})
+  #   data = students_as_xlsx_by_status( status, flatten_keys, reject_keys,
+  #                               student_keys, guardian_info, payment_info)
+  #   send_data_to_remote_server( data, REMOTE_HOSTNAME, REMOTE_USERNAME,
+  #                               "#{REMOTE_PATH_FILE}.xlsx", REMOTE_PERMISSIONS)
+  # end
 
 end

data/lib/openapply/client.rb

@@ -39,10 +39,9 @@ module Openapply
     end
 
     # make OpenApply timeout visible
-    def api_reply_count
+    def api_timeout
       API_TIMEOUT
     end
-    alias_method :api_timeout, :api_reply_count
 
     # Defines & makes visible OpenApply secret access key with ENV-VARS
     def api_key

data/lib/openapply/convert.rb

@@ -1,5 +1,5 @@
 require 'csv'
-require 'axlsx'
+# require 'axlsx'
 require 'net/scp'
 require 'net/ssh'
 
@@ -99,66 +99,66 @@ module Convert
   end
 
 
-  # XLSX CODE
-  ###########
-
-
-  # Queries by status to get a list of students details of a given status
-  # and converts the result to a XLSX Object (Axlsx::Package) with headers
-  # (based on keys sent)
+  # # XLSX CODE
+  # ###########
   #
-  # ==== Attributes
-  # * +status+ - hash to convert to an array
-  # * +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)
-  # * +student_keys+ - [:id, :name] - include student record keys
-  # * +guardian_info+ - include guardian record info {count: 2, keys: [:id, :name]}
-  # * +payment_info+ - include payment info {count: 2, order: :newest, keys: [:date, :amount]}
-  # * guardian & payment info options:
-  #  count: 2 -- how many parent or payment records to return)
-  #  keys: [:id, :date] -- an array of keys of data to return
-  #  order: :newest -- the order to return payments :newest (most recent first - default) or :oldest
-  def students_as_xlsx_by_status( status,
-                                  flatten_keys=[], reject_keys=[],
-                                  student_keys=[],
-                                  guardian_info={}, payment_info={})
-    #
-    check = check_details_keys_validity(flatten_keys, reject_keys)
-    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?
-    #
-    students_array  = students_as_array_by_status(  status,
-                                  flatten_keys, reject_keys,
-                                  student_keys, guardian_info, payment_info )
-    #
-    return students_array      if students_array.is_a? Hash
-    #
-    students_xlsx    = students_array_to_xlsx( students_array )
-
-    # example how to save the xlsx object as a file
-    # students_xlsx.serialize("spec/data/xlsx/students_from_oa.xlsx")
-
-    return students_xlsx
-  end
-  alias_method :students_as_xlsx_by_statuses, :students_as_xlsx_by_status
-
-
-  # Given an array convert to XLSX Object (Axlsx::Package)
   #
-  # ==== Attributes
-  # +array+ - expects a hash of students_details (should be flattened to use custom fields)
-  def students_array_to_xlsx(student_array)
-    xlsx_obj = Axlsx::Package.new do |p|
-      p.workbook.add_worksheet(:name => "Students from OpenApply") do |sheet|
-        student_array.each{ |r| sheet.add_row r }
-      end
-      # to save the xlsx object as a file
-      # p.serialize("spec/data/xlsx/students_from_oa.xlsx")
-    end
-    return xlsx_obj
-  end
+  # # Queries by status to get a list of students details of a given status
+  # # and converts the result to a XLSX Object (Axlsx::Package) with headers
+  # # (based on keys sent)
+  # #
+  # # ==== Attributes
+  # # * +status+ - hash to convert to an array
+  # # * +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)
+  # # * +student_keys+ - [:id, :name] - include student record keys
+  # # * +guardian_info+ - include guardian record info {count: 2, keys: [:id, :name]}
+  # # * +payment_info+ - include payment info {count: 2, order: :newest, keys: [:date, :amount]}
+  # # * guardian & payment info options:
+  # #  count: 2 -- how many parent or payment records to return)
+  # #  keys: [:id, :date] -- an array of keys of data to return
+  # #  order: :newest -- the order to return payments :newest (most recent first - default) or :oldest
+  # def students_as_xlsx_by_status( status,
+  #                                 flatten_keys=[], reject_keys=[],
+  #                                 student_keys=[],
+  #                                 guardian_info={}, payment_info={})
+  #   #
+  #   check = check_details_keys_validity(flatten_keys, reject_keys)
+  #   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?
+  #   #
+  #   students_array  = students_as_array_by_status(  status,
+  #                                 flatten_keys, reject_keys,
+  #                                 student_keys, guardian_info, payment_info )
+  #   #
+  #   return students_array      if students_array.is_a? Hash
+  #   #
+  #   students_xlsx    = students_array_to_xlsx( students_array )
+  #
+  #   # example how to save the xlsx object as a file
+  #   # students_xlsx.serialize("spec/data/xlsx/students_from_oa.xlsx")
+  #
+  #   return students_xlsx
+  # end
+  # alias_method :students_as_xlsx_by_statuses, :students_as_xlsx_by_status
+  #
+  #
+  # # Given an array convert to XLSX Object (Axlsx::Package)
+  # #
+  # # ==== Attributes
+  # # +array+ - expects a hash of students_details (should be flattened to use custom fields)
+  # def students_array_to_xlsx(student_array)
+  #   xlsx_obj = Axlsx::Package.new do |p|
+  #     p.workbook.add_worksheet(:name => "Students from OpenApply") do |sheet|
+  #       student_array.each{ |r| sheet.add_row r }
+  #     end
+  #     # to save the xlsx object as a file
+  #     # p.serialize("spec/data/xlsx/students_from_oa.xlsx")
+  #   end
+  #   return xlsx_obj
+  # end
 
 
   # ARRAY CODE

data/lib/openapply/get_student.rb

@@ -147,22 +147,56 @@ module Get
       # skip loop if this key matches a value to remove
       next                               if reject_keys.include? key
 
-      # put data back into hash if not to be flattened
-      answer[key] = clean_data(val)  unless flatten_keys.include? key
-
-      # if current key matches a flatten value & HAS nested data values
-      # then bring nested data to top level
-      val.each do |k,v|
-        # remove any nested values if they match a reject_key
-        next if reject_keys.include? k
-
-        # (prepend flatten_key_to_current_key to prevent conflicts)
-        new_key = "#{key.to_s}_#{k.to_s}".to_sym
-        # clean the data and add back to to top level with a new key
-        answer[new_key] = clean_data(v)
-      end                                if flatten_keys.include?(key) and
-                                            not val.empty?
+      if flatten_keys.include? key
+        answer.merge!( flatten_key_vals(key, val, flatten_keys, reject_keys) )
+      else
+        # put data back into hash if not to be flattened
+        answer[key] = clean_data(val)  unless flatten_keys.include? key
+      end
     end
+
+    return answer
+  end
+
+
+
+  def flatten_key_vals(key, val, flatten_keys, reject_keys)
+    if val.is_a? Array
+      return flatten_array_vals(key, val, flatten_keys, reject_keys)
+
+    elsif val.is_a? Hash
+      return flatten_hash_vals(key, val, flatten_keys, reject_keys)
+
+    else
+      return {}
+    end
+
+  end
+
+
+
+  def flatten_array_vals(key, val, flatten_keys, reject_keys)
+    return {} if val.empty?
+
+    return {}
+  end
+
+
+
+  def flatten_hash_vals(key, val, flatten_keys, reject_keys)
+    return {} if val.empty?
+
+    answer = {}
+    # un-nest a hash a to top level keys
+    val.each do |k,v|
+      # remove any nested values if they match a reject_key
+      next if reject_keys.include? k
+
+      # (prepend flatten_key_to_current_key to prevent conflicts)
+      new_key = "#{key.to_s}_#{k.to_s}".to_sym
+      # clean the data and add back to to top level with a new key
+      answer[new_key] = clean_data(v)
+    end                                if val.is_a? Hash
     return answer
   end
 

data/lib/openapply/version.rb

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

data/openapply.gemspec

@@ -32,22 +32,18 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "httparty", "~> 0.15"
   spec.add_dependency "json" , "~> 2.1"
-  # need this version of axlsx to match roo's rubyzip needs
-  spec.add_dependency "axlsx" , "2.1.0.pre"
-  spec.add_dependency "net-ssh" , "~> 4.2"
-  spec.add_dependency "net-scp" , "~> 1.2"
+  # # need this version of axlsx to match roo's rubyzip needs
+  # # axlsx 2.1.0.pre uses rubyzip 1.1.7 - which has a security flaw
+  # # using the newest version of rubyzip 1.2.1 or larger
+  # spec.add_dependency "axlsx", "2.1.0.pre"
+  # spec.add_dependency "rubyzip", "~> 1.2"
+  spec.add_dependency "net-ssh", "~> 4.2"
+  spec.add_dependency "net-scp", "~> 1.2"
 
+  spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "webmock" , "~> 3.1"
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7"
-  spec.add_development_dependency "roo", "~> 2.7"
-  # spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov", "~> 0.15"
-  # spec.add_development_dependency "rspec-nc", "~> 3.0"
-  # spec.add_development_dependency "guard", "~> 2.14"
-  # spec.add_development_dependency "guard-rspec", "~> 4.7"
-  # spec.add_development_dependency "pry", "~> 0.11"
-  # spec.add_development_dependency "pry-remote", "~> 0.1"
-  # spec.add_development_dependency "pry-nav", "~> 0.2"
+  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapply
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Bill Tihen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-23 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: axlsx
+  name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0.pre
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0.pre
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: net-ssh
+  name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: net-scp
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
+        version: '0.15'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -136,34 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: roo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
 description: 
 email:
 - btihen@gmail.com
@@ -176,6 +148,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -213,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Access OpenApply's API with Ruby