openapply 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db17dca4047fa3c54362d33e4a1ce0691c1d9e3b8625755917e3b690d262bc6
-  data.tar.gz: 7ed84e202dc03228432c3f14fb91cf8f51211ad2a8c99e869a7d4341a9b84e82
+  metadata.gz: 2d215ce3e5704b8f304e92d62662e7c2cb43caa5de24c4048e08c40d69021be1
+  data.tar.gz: 8fc1fffd0992271dbbf8830135d7bfb21d16c37bf716560555b262e51d82496c
 SHA512:
-  metadata.gz: 6656549f87187da3bcfe96b2c7cab0f49a77b624189f19b288778c6330b1c2d05d7e2aa8d141282682ab9910552b41c1307589d8a29d3d049f2f27e4522bd8c8
-  data.tar.gz: 29563f4ed5d34edb691e368724e8d17db74cb022e24b93077d2cf479fa8ce04d349b3f7c31ae81c2f086bcc9df5db8b00061e08f5cc30189f13136c57e64cc87
+  metadata.gz: 3d83905b01dd0f99615be384bc96dc463cfb7c73043bc3f4435ebdbeee56005b391744e2127cd9b18158bd0738c45e719c8471703c8ea7312249f4762be642b4
+  data.tar.gz: 655011c0694be255269277ec02bc3aff80828eedf48bb637545240671a763a70cd8721aa2f55cc516e013a2d159f0d21ff3c59968131e9fbd234a8dc863cd3e7

data/.gitignore

@@ -13,6 +13,7 @@
 
 # rspec failure tracking
 .rspec_status
+.coveralls.yml
 
 # !examples/demo/.rbenv-vars
 examples/demo/.rbenv-vars

data/.travis.yml

@@ -1,14 +1,14 @@
 sudo: false
-
 language: ruby
-
 branches:
   only:
   - master
   - staging
-
 rvm:
-  - 2.4.2
-
-before_install: gem install bundler -v 1.16.0
-# before_install: gem install bundler -v 1.15.4
+- 2.5.0
+before_install:
+- gem update --system
+- gem install bundler -v 1.16.0
+env:
+  global:
+    secure: IVOwOQStCtCmZBLQszuNwWyYUapjAc3eNOH4trC/hNoYrrtse+WT2c4fRbvL3dFt+Iu/hFxVmtS9Gefmidfp0vCRLm/tPiL2Qsq97brZgb1oekcYx0QlelwXEk76QekIc9RXRle/UZArH+XLcsYzgW2mCVqe6IHElqQAilleu7B5yxtyor/Z+zMfi2d6qYJDMYockISlcmBG1ydshRqrh6sYXCeQutXdPKz1OBuSzwTiz2YcZfVV6SIqkavn6KfQCIQJNBCEU93i54i9f8IV1qrtYLMUfEV4Fah/MT5VGOGH4kNG5OTGna++oqrA9wXRZxPuEX/5e4kELxzg775Wvn9Jfq/NAZVVC63Uk84cags9yp98x0p1Le+JWunQNV1FMb4iuK7wnI07iT1VCtweiPZ6zobW50IyjOS3teyElikBF+j46x63vLNMmzlUU7VkYXTorfr/EOX6v4Pwkgde+b4SIvCemq0pYEahxumY+z6QFbHkvJ7xXiV5n5TLtI1WaLiB/X95X+gF3DUALf3CBgj5rx6cIIgTb5nON8OGYKVo6Oym2VvoSXiCRo2eFjQxtt5fT0AGvDPDg8AlsA+sMR9ISOk2xEkKEM9YG8XIwlQPctZdNHXLlq/rgRuQVvCjlDpbGL202Nw6LGav+dIrnnuGfCIyASC8pAALvmz5ZWw=

data/.travis.yml.bak

@@ -0,0 +1,18 @@
+sudo: false
+
+language: ruby
+
+branches:
+  only:
+  - master
+  - staging
+
+rvm:
+  - 2.5.0
+
+before_install:
+  # needed for ruby 2.5.0
+  # https://github.com/travis-ci/travis-ci/issues/8978
+  - gem update --system
+  - gem install bundler -v 1.16.0
+  # before_install: gem install bundler -v 1.15.4

data/CHANGE_LOG.md

@@ -0,0 +1,50 @@
+### Openapply CHANGE LOG
+
+* **v0.3.0** - compatible with 0.3.x - 2018-01-31
+  - NOT compatible with 0.2.x
+  - migrate to new documentation style
+  - refactor to use options - simplify and improve usage
+  - refactor to be more modular (usage will change)
+
+* **v0.2.10** - compatible with 0.2.x - 2018-01-04
+  - updated rake and webmock gems in deve
+  - removed roo - not needed
+
+* **v0.2.9** - compatible with 0.2.x - 2017-12-13 *(https://github.com/straydogstudio/axlsx_rails/issues/77)*
+    - separated convert (& its dependencies) into separate modules that can be loaded on need in the next version (0.3.x)
+    - hash to array now handles both student_details and student_summaries (this also allows conversion then to csv)
+
+* **v0.2.8** - compatible with 0.2.x - 2017-12-11 *(https://github.com/randym/axlsx/issues/234)*
+  - axlsx - passes tests - but won't properly install inside another project (even using gem install ./openapply-0.2.7) - will look for a solution
+
+* **v0.2.7** - compatible with 0.2.x - 2017-12-10
+  - safely re-enabled axlsx by using the master branch and upgradeing rubyzip
+
+* **v0.2.6** - compatible with 0.2.x - 2017-12-08
+  - allow ssh/scp options to be passed
+
+* **v0.2.5** - compatible with 0.2.x - 2017-11-30
+  - removed a reference to AXLSX in scp transfers *(haven't figured out how to test that yet!)*
+
+* **v0.2.4** - compatible with 0.2.x - 2017-11-30
+  - 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.  **BIG THANKS TO GitHub for the notification!**
+
+* **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** - 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
+  - allow scp string object to file export (no automated tests)
+
+* **v0.2.0** - first release -- **NOT** compatible with 0.1.0 -- 2017-11-07
+  - get student details of a give status (and pure api calls)
+  - recursive query until all receipt of all records received
+
+* **v0.1.0** - test release -- 2017-11-01

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapply (0.2.10)
+    openapply (0.3.0)
       httparty (~> 0.15)
       json (~> 2.1)
       net-scp (~> 1.2)
@@ -12,6 +12,8 @@ GEM
   specs:
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
+    codacy-coverage (1.1.8)
+      simplecov
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
@@ -43,14 +45,14 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+    rspec-support (3.7.1)
     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.2.1)
+    webmock (3.3.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -60,11 +62,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.15)
+  codacy-coverage (~> 1.1)
   openapply!
   pry (~> 0.11)
   rake (~> 12.3)
   rspec (~> 3.7)
-  simplecov (~> 0.15)
   webmock (~> 3.2)
 
 BUNDLED WITH

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/btihen/openapply.svg?branch=master)](https://travis-ci.org/btihen/openapply) | [![Dependency Status](https://beta.gemnasium.com/badges/github.com/btihen/openapply.svg)](https://beta.gemnasium.com/projects/github.com/btihen/openapply) | [![Known Vulnerabilities](https://snyk.io/test/github/btihen/openapply/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/btihen/openapply?targetFile=Gemfile.lock)
+[![Build Status](https://travis-ci.org/btihen/openapply.svg?branch=master)](https://travis-ci.org/btihen/openapply)  [![Dependency Status](https://beta.gemnasium.com/badges/github.com/btihen/openapply.svg)](https://beta.gemnasium.com/projects/github.com/btihen/openapply)  [![Known Vulnerabilities](https://snyk.io/test/github/btihen/openapply/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/btihen/openapply?targetFile=Gemfile.lock)    [![Codacy Badge](https://api.codacy.com/project/badge/Grade/7b2062680fd14704bd321baef8dbddce)](https://www.codacy.com/app/btihen/openapply?utm_source=github.com&utm_medium=referral&utm_content=btihen/openapply&utm_campaign=Badge_Grade)  [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/7b2062680fd14704bd321baef8dbddce)](https://www.codacy.com/app/btihen/openapply?utm_source=github.com&utm_medium=referral&utm_content=btihen/openapply&utm_campaign=Badge_Coverage)   [![Code Quality](https://bettercodehub.com/edge/badge/btihen/shop?branch=master)](https://bettercodehub.com/)  [![Coverage Status](https://coveralls.io/repos/github/btihen/openapply/badge.svg?branch=master)](https://coveralls.io/github/btihen/openapply?branch=master)
 
 
 
@@ -10,55 +10,11 @@ This gem allows ruby access to the OpenApply API v1 - and supports the GET featu
 
 ### Still TODO
 
-* allow flattening to work with arrays?
-* allow flattening and reject to work at 2 levels of depth?
-* make tests for scp / ssh (at least data type conversions)?
-* write PUTS methods - *currently api only allows status update*
-* write a recursive custom query - when results are more than one page
-* allow flattening and reject to work at any depth (with recursion)?
-* speed up response when returning large number of records? - **looks like API**
-
 
 ### CHANGE LOG
 
-* **v0.2.9** - compatible with 0.2.x - 2017-12-13 *(https://github.com/straydogstudio/axlsx_rails/issues/77)*
-  - separated convert (& its dependencies) into separate modules that can be loaded on need in the next version (0.3.x)
-  - hash to array now handles both student_details and student_summaries (this also allows conversion then to csv)
-
-* **v0.2.8** - compatible with 0.2.x - 2017-12-11 *(https://github.com/randym/axlsx/issues/234)*
-  - axlsx - passes tests - but won't properly install inside another project (even using gem install ./openapply-0.2.7) - will look for a solution
-
-* **v0.2.7** - compatible with 0.2.x - 2017-12-10
-  - safely re-enabled axlsx by using the master branch and upgradeing rubyzip
-
-* **v0.2.6** - compatible with 0.2.x - 2017-12-08
-  - allow ssh/scp options to be passed
-
-* **v0.2.5** - compatible with 0.2.x - 2017-11-30
-  - removed a reference to AXLSX in scp transfers *(haven't figured out how to test that yet!)*
-
-* **v0.2.4** - compatible with 0.2.x - 2017-11-30
-  - 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.  **BIG THANKS TO GitHub for the notification!**
-
-* **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** - 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
-  - allow scp string object to file export (no automated tests)
+[Change Log](https://github.com/btihen/openapply/blob/master/CHANGE_LOG.md)
 
-* **v0.2.0** - first release -- **NOT** compatible with 0.1.0 -- 2017-11-07
-  - get student details of a give status (and pure api calls)
-  - recursive query until all receipt of all records received
-
-* **v0.1.0** - test release -- 2017-11-01
 
 ### Installation
 
@@ -116,7 +72,7 @@ Associates the above settings with HTTParty
 (so that you can access the OpenApply api)
 
 ```ruby
-@oa = OpenApply::Client.new
+@oa = Openapply::Client.new
 ```
 
 ###  USAGE
@@ -133,160 +89,30 @@ Associates the above settings with HTTParty
 @oa.base_path
 @oa.api_timeout
 @oa.api_records
-#
-# directly call against the OA API
-@oa.oa_api_call('/api/v1/students/?status=accepted&count=5&auth_token=add_api_key')
-#
-
-# Individual students records (separated)
-@oa.student_by_id(95)
-@oa.payments_by_id(95)
-#
-# individual student records combined & possible pre-processing
-@oa.student_details_by_id(95)
-
-# ATTRIBUTES: id, [:keys_to_un-nest], [:keys_to_exclude]
-@oa.student_details_by_id(95, [:custom_fields], [:parent_guardian])
-
-# skip payment info -- (payments: [])
-@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')
-#
-# 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], [:parent_guardian])
-# skip payment info (payments: [])
-@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])
-#
-# 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]} )
-# multiple statuses into an array
-@oa.students_as_array_by_statuses(['applied','enrolled'], [:custom_fields], [:parent_guardian], [:id, :name], {count: 1, keys: [:id, :name, :address]}, {count: 2, order: :newest, keys: [:date, :amount]} )
-#
-# Create a csv string
-# multiple status into
-csv_string=@oa.students_as_csv_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 CSV to a remote server as a file - using ssh-keys
-@oa.send_data_to_remote_server(csv_string, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
-#
-# send CSV to a remote server as a file - using ssh-keys - don't check host_key of remote server
-@oa.send_data_to_remote_server( csv_string, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750', {verify_host_key: false} )
-
-# 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_obj, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.xlsx', '0750')
-```
-
-#### INDIVIDUAL STUDENT QUERIES
-
-```ruby
-# all student info & parents info -- returns the data straight from OpenApply
-student_record = @oa.student_by_id(95)
-
-# all payments associated with a student -- returns the data straight from OpenApply
-student_payments = @oa.payments_by_id(95)
-
-# Returns all student details (combines studnet, parent and payments)
-# **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 = [:parent_guardian] (since this is duplicated)
-# returns the data structured as:
-#   { student: {
-#       id: xxx,
-#       record: {xxx}      # complete student record
-#       guardians: [ {} ]  # all guardian information
-#       payments: [ {} ]   # all payments made via openapply
-#     }
-#   }
-@oa.student_details_by_id(95)
-# or
-@oa.student_details_by_id(95, [:custom_fields], [:parent_guardian])
-```
 
-#### DATA OF GROUPS OF STUDENTS
-
-searched recursively - collects all pages of records
-
-```ruby
-# SUMMARY INFO of students with a given status - ONLY ONE STATUS string!
-@oa.students_by_status('applied')
-
-# STUDENT IDs of students with a given status or array of statuses
-ids = @oa.student_ids_by_status('applied')
-ids = @oa.student_ids_by_statuses(['applied','enrolled'])
-# [1, 2, 60]
-#
-# FULL STUDENT DETAILS for all students of a given status or statuses
-# **returned as a hash)** -- attributes are (status, flatten_keys, reject_keys)
-# example usage:
-@oa.students_details_by_status('applied')
-@oa.students_details_by_status('applied',[:custom_fields])
-@oa.students_details_by_status('applied', [:custom_fields], [:parent_guardian])
-@oa.students_details_by_status(['applied','enrolled'])
-@oa.students_details_by_status(['applied','enrolled'], nil, [:parent_guardian])
-```
-
-
-#### STUDENT DATA TRANFORMATIONS
-
-```ruby
-# student details - in an array format (instead of hash)
-# ATTRIBUTES - status, flatten_keys, reject_keys, student_keys(into array), guardian_info(into array), payment_info(into array)
-# guardian and payment info options:
-# count - how many records to return
-# keys - which keys to return to array/csv
-# order: :newest/:oldest (for payments) - return newest or oldest payments first
-@oa.students_as_array_by_status('applied', nil, nil, [:id, :name], nil, {count: 2, order: :newest, keys: [:date, :amount]} )
-# all options
-@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]} )
-#
-# Create a csv string
-@oa.students_as_csv_by_status('applied', nil, nil, [:id, :name], nil, {count: 2, order: :newest, keys: [:date, :amount]} )
-# all options
-csv=@oa.students_as_csv_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(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_obj=@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_obj, 'hostname.domain.name', 'myusername', '/home/myusername/xfer/myexport.csv', '0750')
-```
-
-#### CUSTOM GROUP QUERIES - summary data
-
-```ruby
-# status = 'applied'        # all records matching a valid openapply status
-# since_id = 95             # all records with ids after 95
-# since_date = '2017-11-12' # all records modified after 2017-11-12 (& time)
-# count = 20                # records per page
-
-# build a custom url query to send to OA api
-# returns a url that can be passed to api
-@oa.students_query_url('applied', 106, '2017-11-12', 25)
-
-# executes a custom query and returns a group of student summaries matching criteria
-@oa.students_query('applied', 106, '2017-11-12', 25)
+# Individual student record
+# (note: parent info is duplicated)
+@oa.student_by_id( id )
+@oa.payments_by_id( id )
+
+# Student Details by IDs:
+# id - student's record number
+# options = {get_payments: false}
+@oa.one_student_details_by_id( id, options={} )
+# ids - in array format
+@oa.many_students_details_by_ids( ids, options={} )
+
+# Query many students by params:
+# params = {status: 'applied', since_id: 95, since_date: '2018-01-20', count: 50}
+@oa.many_students_ids( params )
+@oa.many_ids_updated_time( params )
+@oa.many_students_summaries( params )
+@oa.many_students_details( params, options )
+
+# directly call the OA API - with custom URL
+@oa.oa_api_call('/api/v1/students/?status=accepted&count=5&auth_token=add_api_key')
 ```
 
-
 #### OpenApply's allowed statuses
 
 * **valid status includes:**
@@ -309,7 +135,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openapply. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/btihen/btihen/openapply. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -317,4 +143,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Openapply project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/openapply/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Openapply project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/btihen/openapply/blob/master/CODE_OF_CONDUCT.md).

data/lib/openapply/client.rb

@@ -1,12 +1,5 @@
-
-require "openapply/convert_to_array"
-# require "openapply/convert_to_xlsx"
-require "openapply/convert_to_csv"
-require "openapply/send_to_remote"
-require "openapply/get_students"
-require "openapply/get_student"
-# require "openapply/convert"
-# require "openapply/client"
+require "openapply/get_many_students"
+require "openapply/get_one_student"
 require "openapply/put"
 require 'httparty'
 
@@ -21,15 +14,6 @@ module Openapply
     include Put
     # GET api calls
     include Get
-    # Convert student data to various formats
-    include ConvertToArray
-    # AXLSX files
-    include ConvertToCsv
-    # AXLSX files
-    # include ConvertToXlsx
-    # Send To Remote ssh
-    include SendToRemote
-
     # Library for API calls to OpenApply
     include HTTParty
 
@@ -68,21 +52,17 @@ module Openapply
       ENV['OA_RECORD_COUNT'] || '50'
     end
 
-    # Does the actual api call to OpenApply & handles API timeouts gracefully
-    #
-    # ==== Attributes
-    # * +url+ - this is the url to do the call
-    #  /api/v1/students/95?auth_token=demo_site_api_key
-    # is the url passed when wanting to do the following cli api call
-    #  curl http://demo.openapply.com/api/v1/students/95?auth_token=demo_site_api_key
-    # * +options+ - see httparty options [http://www.rubydoc.info/github/jnunemaker/httparty]
+    # @note Does the actual api call to OpenApply & handles API timeouts gracefully
+    # @param url [String] - this is the url to do the call
+    # @param options - see httparty options [http://www.rubydoc.info/github/jnunemaker/httparty]
     def oa_api_call(url, options={})
       # https://stackoverflow.com/questions/26251422/handling-netreadtimeout-error-in-httparty
       max_retries = 3
       times_retried = 0
       begin
         self.class.get(url, options)
-      rescue Net::ReadTimeout, Net::OpenTimeout => error
+      # rescue Net::ReadTimeout, Net::OpenTimeout => error
+      rescue Net::ReadTimeout, Net::OpenTimeout
         if times_retried < max_retries
           times_retried += 1
           # puts "TIMEOUT RETRY: #{times_retried} of #{max_retries} - USING: #{url.inspect}"
@@ -94,14 +74,9 @@ module Openapply
       end
     end
 
-    # Does checks the info for validity & unpacks the json retubed to a JS formatt
-    #
-    # ==== Attributes
-    # * +url+ - this is the url to do the call
-    #  /api/v1/students/95?auth_token=demo_site_api_key
-    # is the url passed when wanting to do the following cli api call
-    #  curl http://demo.openapply.com/api/v1/students/95?auth_token=demo_site_api_key
-    # * +options+ - see httparty options [http://www.rubydoc.info/github/jnunemaker/httparty]
+    # @note checks the info for validity & unpacks the json retubed to a JS formatt
+    # @param url [String] - this is the url to do the call
+    # @param options - see httparty options [http://www.rubydoc.info/github/jnunemaker/httparty]
     def oa_answer(url, options={})
       # puts
       # puts "GIVEN URL: #{ url.inspect }"
@@ -109,8 +84,8 @@ module Openapply
       return { error: 'bad url - has space' } if url.include? " "
       return { error: 'bad api_path' }    unless url.include? "#{api_path}"
       return { error: 'bad auth_token' }  unless url.include? "auth_token=#{api_key}"
-      api_answer = nil
 
+      # api_answer = nil
       api_answer = oa_api_call(url, options)
 
       return api_answer               unless api_answer.respond_to? "response" # and not api_answer[:error].nil?
@@ -119,8 +94,7 @@ module Openapply
       return { error: 'no response' }     if api_answer.response.to_s.eql? ""
       return JSON.parse(api_answer.response.body, symbolize_names: true)
     end
-    # alias_method :openapply_answer, :oa_answer
 
-  end  # Client
+  end 
 
-end    # Openapply
+end