openapply 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89fcc25f4b251ea7bed8c94a12e05f69bd379c6c87d097576ed9bd589365af3c
+  data.tar.gz: c806bc3f83c5b8e4879b739f98cbb384c78e7b2d2091161ca115faf50ed5d6b8
+SHA512:
+  metadata.gz: 8ef763e465b040b37bf910483266a85a84960948a05b62f081475a5943262e5e42bccb0f9dc1c42a447224a973469ab89443950b1ca931490560023c0b9c2cd7
+  data.tar.gz: b7cfa50c180eaefefba50bb44f04cfae1eb1c3d7f766950228a58cdb9815403f9974aa8f333bab411b572f4027a4cda42509ca4c3689470faecc809ce06394e1

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+
+# rspec failure tracking
+.rspec_status
+
+# !examples/demo/.rbenv-vars
+examples/demo/.rbenv-vars
+/.rbenv-vars
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at btihen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in openapply.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bill Tihen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,506 @@
+# Openapply
+
+This gem allows ruby access to the OpenApply API v1 - and supports the GET features described at: https://dev.faria.co/oa
+
+### Still TODO
+
+* test timeouts
+* write PUTS methods
+* fix rdocs - not mapping to methods
+* write method to flatten data structures
+* write a recursive query to pull students by since date (with any status or change date)
+* write a recursive query to pull students by since id (with any status or change date)
+* investigate faster response when returning large number of records
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapply'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openapply
+
+## Usage
+
+### Full Docs
+
+* http://www.rubydoc.info/gems/openapply
+
+### Configuration
+
+* Setup / Config the following ENV-VARS (example code uses **.rbenv-vars**):
+
+```bash
+# timeout in seconds (before retry - 3 times)
+OA_TIMEOUT=5
+
+# 100 records is the advertised default record count, but in reality it is 10
+OA_RELPY_RECORDS=100
+
+# currently this is the only API path available
+OA_API_PATH=/api/v1/students/
+
+# point to your own site (this is the demo site)
+OA_BASE_URI=demo.openapply.com
+
+# this is the demo site key - you will need your own key for your own site
+OA_AUTH_TOKEN=demo_site_api_key
+```
+
+### Instantiation
+Associates the above settings with HTTParty
+(so that you can access the OpenApply api)
+
+```ruby
+@oa = OpenApply::Client.new
+```
+
+#### Example Usage
+
+```ruby
+# instantiate
+@oa = OpenApply::Client.new
+
+# see settings
+@oa.api_url
+@oa.api_key
+@oa.base_path
+@oa.api_timeout
+@oa.record_count
+# replace record_count with reply count
+# oa.reply_count
+```
+
+#### Method list
+
+* individual student details
+
+```ruby
+# all student info & parents info
+def student_by_id(student_id, options ={})
+# all payments associated with a student
+def payments_by_id(student_id, options={})
+# this is all student details (combines studnet, parent and payments)
+def student_details_by_id(id, flatten = false)
+```
+
+* group of students (summary data) -- **(recursive - collects all pages of records if return_count < total_records)**
+
+```ruby
+# summary info of students with a given status
+def students_by_status(status)
+# only student ids of students with a given status
+def student_ids_by_status(status)
+#
+# returns all student details for all students of a given status **returned as a hash)**
+def students_details_by_status(status)
+#
+# TODO: add in v0.2.1
+# # returns all student details for all students of a given status **(returned as a csv string - only returns data matching the keys given)**
+# def students_details_by_status_as_csv(status,keys)
+# # returns all student details for all students of a given status **(returned as an array - only returns data matching the keys given)**
+# def students_details_by_status_as_array(status,keys)
+```
+
+* custom grouping
+```ruby
+def custom_students_query(status=nil, since_id=nil, since_date=nil, count=api_records)
+def custom_students_url(status=nil, since_id=nil, since_date=nil, count=api_records)
+```
+
+#### Get Individual student information
+
+* Get a complete student record using student id -- includes: *(demographic, custom_fields, parent info & sibling ids)*
+
+```ruby
+# def one_student_record_by_id(student_id, options ={})
+
+@oa = OpenApply::Client.new
+@answer = @oa.student_by_id(95)
+
+# answer formats include:
+# { student:
+#   { id: value1,
+#     name: kid_name,
+#     custom_fields: {
+#       key3: value3,
+#       key4: value4
+#     }
+#   },
+#   linked: {
+#     parents: [
+#       id: value5,
+#       name: parent_name,
+#       custom_fields: {
+#         key6: value6,
+#         ...
+#       }
+#     ]
+#   }
+# }
+```
+
+* Get a student's payment records
+
+```ruby
+@oa = OpenApply::Client.new
+@answer = @oa.payments_by_id(95)
+
+# answer format is:
+# {
+#    payments: [
+#       {key1: value1, key2: value2},
+#       {key1: value3, key2: value3}
+#    ],
+# }
+```
+
+* Get all student data about one individual - includes: *(demographic, gardians, sibling ids, & payment records)*
+
+```ruby
+@oa = OpenApply::Client.new
+@answer = @oa.student_details_by_id(95)
+
+# answer format is:
+# { student:
+#   {
+#     id: id,
+#     record:
+#       { id: id,
+#         name: kid_name,
+#         ... ,
+#         custom_fields: {
+#           key2: value2,
+#           ...
+#         }
+#       },
+#     payments: [
+#       {payment1},
+#       {payment2}
+#     ],
+#     guardians: [
+#       { id: id,
+#         name: guardian1,
+#         ... ,
+#         custom_fields: {
+#           key2: value2,
+#           ...
+#         }
+#       },
+#       { id: id,
+#         name: guardian2,
+#         ... ,
+#         custom_fields: {
+#           key2: value2,
+#           ...
+#         }
+#       }
+#     ]
+#   }
+# }
+```
+
+#### Group queries (by status)
+
+* **valid status includes:**
+  - Status
+  - Pending
+  - Applied
+  - Admitted
+  - Wait-listed
+  - Declined
+  - Enrolled
+  - Graduated
+  - Withdrawn
+
+
+* Get student summary info of all students of a given status **(all pages - uses recursion)**
+
+```ruby
+# def all_student_summaries_by_status(status)
+
+@oa = OpenApply::Client.new
+@answer = @oa.students_by_status('applied')
+
+# answer format is:
+# { students: [
+#      { id: id1,
+#        name: kid1,
+#        ...,
+#      { id: id2,
+#        name: kid_name_2,
+#        ...,
+#      }
+#   ],
+#   linked: {
+#     parents: [
+#       id: value5,
+#       name: parent_name,
+#       custom_fields: {
+#         key6: value6,
+#         ...
+#       }
+#     ]
+#   }
+# }
+```
+
+* Get a list of student ids of all students of a given status **(all pages - uses recursion)**
+
+```ruby
+# def all_student_ids_by_status(status)
+
+@oa = OpenApply::Client.new
+@answer = @oa.student_ids_by_status('applied')
+
+# answer format is:
+# { student_ids: [95, 160, 240] }
+```
+
+* Get all student data of all students of a given status **(all pages - uses recursion)**
+
+```ruby
+# def all_students_all_data_by_status(status)
+
+@oa = OpenApply::Client.new
+@answer = @oa.students_details_by_status('enrolled')
+
+# TODO: add correct info
+# answer formats include:
+# { students:
+#   [
+#     { id: value1,
+#       key2: value2,
+#       custom_fields: {
+#         key3: value3,
+#         key4: value4
+#       }
+#     },
+#     { id: valueX,
+#       key2: valueY,
+#       custom_fields: {
+#         key3: valueZ,
+#         key4: valueA
+#       }
+#     }
+#   ],
+#   guardians: [
+#     {
+#       id: value5,
+#       custom_fields: {
+#         key6: value6,
+#         ...
+#      },
+#     {
+#       id: value6,
+#       custom_fields: {
+#         key6: value7,
+#         ...
+#      },
+#   ]
+# }
+```
+
+
+* Get all student data of all students of a given status **(all pages - uses recursion)**
+
+```ruby
+# FLATTEN RECORDS
+# def all_students_all_data_by_status(status,true)
+
+@oa = OpenApply::Client.new
+@answer = @oa.students_details_by_status('enrolled',true)
+
+# answer formats include:
+# { students:
+#   [
+#     { id: value1,
+#       name: kid_1,
+#       key3: value3,
+#       key4: value4
+#     },
+#     { id: valueX,
+#       name: kid_2,
+#       key3: valueZ,
+#       key4: valueA
+#     }
+#   ],
+#   guardians: [
+#     { id: value5,
+#       name: guardian_1
+#       key6: value6,
+#       ...
+#     },
+#     { id: value6,
+#       name: guardian_2
+#       key6: value7,
+#       ...
+#     },
+#   ]
+# }
+```
+
+#### Custom URL (GET) API calls
+
+* Get student summary info of students with a custom query - supporting the description here: https://dev.faria.co/oa/#responses **(one page - no recursion)**
+
+```ruby
+# def custom_student_summaries(status=nil, since_id=nil, since_date=nil, count=self.record_count)
+
+@oa = OpenApply::Client.new
+# status -- return records matching this status
+# since_id -- return records with ids after this id
+# since_date (format: 'YYYY-MM-DD') -- return records updated after this date
+# count (>= 1) -- is the number of records to return
+@answer = @oa.students_custom('applied',240,nil,3)
+@answer = @oa.students_custom('applied',nil,'2015-09-12',3)
+
+# answer formats include:
+# { students:
+#   [
+#     { id: value1,
+#       name: kid_1,
+#       ...,
+#       custom_fields: {
+#         key3: value3,
+#         key4: value4
+#       }
+#     },
+#     { id: valueX,
+#       name: kid_2,
+#       ...,
+#       custom_fields: {
+#         key3: valueZ,
+#         key4: valueA
+#       }
+#     }
+#   ],
+#   linked: {}
+#     parents: [
+#       {
+#         id: value5,
+#         name: parent_1,
+#         ...,
+#         custom_fields: {
+#           key6: value6,
+#           ...
+#       },
+#       {
+#         id: value6,
+#         name: parent_2,
+#         ...,
+#         custom_fields: {
+#           key6: value7,
+#           ...
+#       },
+#     ]
+#   }
+#   meta: {
+#     page: 3,
+#     per_page": "2"
+#   }
+# }
+```
+
+* Get a response to a custom url query - this is the lowest level access
+
+```ruby
+# def oa_answer( url, options={} )
+
+url = "api/v1/students?since_id=269&auth_token=demo_site_api_key"
+
+@oa = OpenApply::Client.new
+@oa_answer = @oa.oa_answer( url )
+
+# answer format like:
+#<HTTParty::Response:0x7f851fa20408 parsed_response="{\"payments\":[]}", @response=#<Net::HTTPOK 200  readbody=true>, @headers={}>
+#
+# access data using something like:
+return { error: "no answer" } unless @oa_answer.responds_to? 'response'
+return { error: "no answer" } unless (@oa_answer.response).responds_to? 'body'
+return JSON.parse( @api_answer.response.body, symbolize_names: true )
+
+# answer formats include:
+# { student:
+#   { id: value1,
+#     key2: value2,
+#     custom_fields: {
+#       key3: value3,
+#       key4: value4
+#     }
+#   },
+#   linked: {
+#     parents: [
+#       id: value5,
+#       custom_fields: {
+#         key6: value6,
+#         ...
+#       }
+#     ]
+#   }
+# }
+#   or
+# {
+#    payments: [
+#       {key1: value1, key2: value2},
+#       {key1: value3, key2: value3}
+#    ],
+# }
+#   or
+# {
+#   students: [
+#     {id: value1, key2: value2, custom_fields: {key3: value3, key4: value4} },
+#     {id: value3, key2: value3, custom_fields: {key3: value3, key5: value5} }
+#   ],
+#   linked: {
+#     parents: [
+#       id: value5,
+#       custom_fields: {
+#         key6: value6,
+#         ...
+#       }
+#     ]
+#   }
+#   meta: {
+#     page: 3,
+#     per_page": "10"
+#   }
+# }
+```
+
+#### Group queries with recursion (by since_date)
+not done (just code stubs)- not yet needed
+
+#### Group queries with recursion (by since_id)
+not done (just code stubs)- not yet needed
+
+#### See Examples Folder
+
+for an actual complete code examples
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openapply"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/demo/.rbenv-vars

@@ -0,0 +1,5 @@
+OA_TIMEOUT=5
+OA_RELPY_RECORDS=50
+OA_BASE_PATH=/api/v1/students/
+OA_BASE_URI=demo.openapply.com
+OA_AUTH_TOKEN=319d9a3fbd50c8272a2b508e138a1ada

data/examples/demo/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "openapply", "~> 0.2"