openapply 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d215ce3e5704b8f304e92d62662e7c2cb43caa5de24c4048e08c40d69021be1
-  data.tar.gz: 8fc1fffd0992271dbbf8830135d7bfb21d16c37bf716560555b262e51d82496c
+  metadata.gz: 5478208e639f6d809fc7d16db8d4484d06e28c92350a0d744af4f2f377813369
+  data.tar.gz: 03c9e34ee1fda5e164d845bc9331fc1e466ae2618f03e5aceb6e962a1ddf4e23
 SHA512:
-  metadata.gz: 3d83905b01dd0f99615be384bc96dc463cfb7c73043bc3f4435ebdbeee56005b391744e2127cd9b18158bd0738c45e719c8471703c8ea7312249f4762be642b4
-  data.tar.gz: 655011c0694be255269277ec02bc3aff80828eedf48bb637545240671a763a70cd8721aa2f55cc516e013a2d159f0d21ff3c59968131e9fbd234a8dc863cd3e7
+  metadata.gz: 65c27f0485036ab3cc2e944fc1d5ccd321b29b54939b96d78cab82d911bc069697990f0bbb6ffe327821166cf492ba859e171aecd09e239025ea021df7e7cefa
+  data.tar.gz: d901982b841b137fdf5a8dfe252440f94b6c1083e83da092b82c4879e650057d56182c033ece970e5af93b9bae39a99d7914d3c7004c9765c47d2cfce1746d93

data/.bettercodehub.yml

@@ -0,0 +1,3 @@
+component_depth: 2
+languages:
+- ruby

data/.gitignore

@@ -8,9 +8,6 @@
 /spec/reports/
 /tmp/
 
-/examples/demo/*.csv
-/examples/demo/*.xlsx
-
 # rspec failure tracking
 .rspec_status
 .coveralls.yml

data/CHANGE_LOG.md

@@ -1,5 +1,10 @@
 ### Openapply CHANGE LOG
 
+* **v0.3.1** - compatible with 0.3.x - 2018-02-XX
+  - add error / exception when ENV doesn't load properly
+  - remove unused gems (scp and ssh)
+  - add example / demo usage code
+
 * **v0.3.0** - compatible with 0.3.x - 2018-01-31
   - NOT compatible with 0.2.x
   - migrate to new documentation style

data/Gemfile

@@ -2,15 +2,5 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# # https://github.com/straydogstudio/axlsx_rails/issues/77
-# gem 'axlsx',  git: 'https://github.com/randym/axlsx.git',
-#               ref: '776037c0fc799bb09da8c9ea47980bd3bf296874'
-
-# https://github.com/randym/axlsx/issues/501
-# https://github.com/straydogstudio/axlsx_rails/issues/77
-# gem 'axlsx', "2.1.0.pre", git: 'https://github.com/randym/axlsx', branch: 'master'
-# gem 'axlsx', git: 'https://github.com/randym/axlsx', branch: 'master'
-# gem 'axlsx', git: 'https://github.com/randym/axlsx.git', ref: '776037c0fc799bb09da8c9ea47980bd3bf296874'
-
 # Specify your gem's dependencies in openapply.gemspec
 gemspec

data/Gemfile.lock

@@ -1,11 +1,9 @@
 PATH
   remote: .
   specs:
-    openapply (0.3.0)
+    openapply (0.3.1)
       httparty (~> 0.15)
       json (~> 2.1)
-      net-scp (~> 1.2)
-      net-ssh (~> 4.2)
 
 GEM
   remote: https://rubygems.org/
@@ -25,9 +23,6 @@ GEM
     json (2.1.0)
     method_source (0.9.0)
     multi_xml (0.6.0)
-    net-scp (1.2.1)
-      net-ssh (>= 2.6.5)
-    net-ssh (4.2.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)

data/README.md

@@ -1,6 +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)    [![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)
-
-
+[![Build Status](https://travis-ci.org/btihen/openapply.svg?branch=master)](https://travis-ci.org/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/)  
 
 
 # Openapply
@@ -38,11 +36,6 @@ Or install it yourself as:
 * http://www.rubydoc.info/gems/openapply
 
 
-#### Examples Code
-
-see /examples in repo -- https://github.com/btihen/openapply/tree/master/examples/demo
-
-
 ### Configuration
 
 * Setup / Config the following ENV-VARS (example code uses **.rbenv-vars**):
@@ -80,13 +73,14 @@ Associates the above settings with HTTParty
 #### USAGE SUMMARY
 
 ```ruby
+require 'openapply'
 # instantiate
-@oa = OpenApply::Client.new
+@oa = Openapply::Client.new
 
 # see settings
 @oa.api_url
 @oa.api_key
-@oa.base_path
+@oa.api_path
 @oa.api_timeout
 @oa.api_records
 

data/examples/demo.rb

@@ -0,0 +1,31 @@
+require 'openapply'
+
+# SET ENV VARIABLES - NEEDED VARIABLES:
+# OA_TIMEOUT=5
+# OA_RECORD_COUNT=50
+# OA_API_PATH=/api/v1/students/
+# OA_BASE_URI=demo.openapply.com
+# OA_AUTH_TOKEN=(this only works for an hour after setup)
+
+# instantiate openapply connection
+@oa = Openapply::Client.new
+
+# see settings
+@oa.api_url
+@oa.api_key
+@oa.api_path
+@oa.api_timeout
+@oa.api_records
+
+# get summary info of applied kids
+params = {status: 'applied'}
+summaries = @oa.many_students_summaries( params )
+
+# get details of of many kids - after kid 95 (only get 50 records at a time)
+params = {since_id: 95, count: 50}
+kid_ids   = @oa.many_students_ids( params )
+details   = @oa.many_students_details_by_ids( kid_ids )
+
+# get all student records that have been updated in the last week
+params = {since_date: "#{Date.today-7}"}
+updates   = @oa.many_ids_updated_time( params )

data/lib/openapply/client.rb

@@ -4,50 +4,45 @@ require "openapply/put"
 require 'httparty'
 
 module Openapply
-
-  # OpenApply CLIENT is a service to manage admissions -
-  # this gem allows access to OpenApply API calls via HTTParty
-  #
   class Client
 
-    # PUT api calls
-    include Put
-    # GET api calls
-    include Get
-    # Library for API calls to OpenApply
-    include HTTParty
-
-    # Defines OpenApply domain name from ENV-VARS
-    API_URL        = (ENV['OA_BASE_URI'] || 'demo.openapply.com')
+    include HTTParty                    # Library for API calls
+    include Openapply::Put              # PUT api calls
+    include Openapply::GetOneStudent    # GET api calls
+    include Openapply::GetManyStudents  # GET api calls
 
-    # Defines the OpenApply path from ENV-VARS - default is 5 seconds
-    API_TIMEOUT    = (ENV['OA_TIMEOUT'].to_i || 5)
+    API_URL        = ENV['OA_BASE_URI']
+    API_TIMEOUT    = ENV['OA_TIMEOUT'].to_i || 5
 
     base_uri API_URL
     default_timeout API_TIMEOUT
 
-    # Makes OpenApply domain name visible:
+    # attr_reader :api_url, :api_key
+
+    def initialize
+      api_url     = ENV['OA_BASE_URI']
+      api_key     = ENV['OA_AUTH_TOKEN']
+
+      raise ArgumentError, 'OA_BASE_URI is missing'   if api_url.nil? or api_url.empty?
+      raise ArgumentError, 'OA_AUTH_TOKEN is missing' if api_key.nil? or api_key.empty?
+    end
+
     def api_url
-      API_URL
+      ENV['OA_BASE_URI']
     end
 
-    # make OpenApply timeout visible
     def api_timeout
-      API_TIMEOUT
+      ENV['OA_TIMEOUT'].to_i
     end
 
-    # Defines & makes visible OpenApply secret access key with ENV-VARS
     def api_key
-      ENV['OA_AUTH_TOKEN'] || 'demo_site_api_key'
+      ENV['OA_AUTH_TOKEN']
     end
 
-    # Defines and makes visib le the OpenApply path with ENV-VARS
     def api_path
-      ENV['OA_API_PATH'] || "/api/v1/students/"
+      ENV['OA_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['OA_RECORD_COUNT'] || '50'
     end
@@ -56,19 +51,16 @@ module Openapply
     # @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
+      # add exception if ENV are not set
       max_retries = 3
       times_retried = 0
       begin
         self.class.get(url, options)
-      # 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}"
           retry
         else
-          # puts "TIME-OUT URI FAILED: #{url.inspect}"
           { error: "no response (timeout) from URL: #{url}"  }
         end
       end
@@ -78,23 +70,19 @@ module Openapply
     # @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 }"
       return { error: 'no url given' }        if url.nil? or url.to_s.eql? ""
       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 = oa_api_call(url, options)
 
-      return api_answer               unless api_answer.respond_to? "response" # and not api_answer[:error].nil?
-      # return { error: 'no response' } unless api_answer.respond_to? "response"
+      return api_answer               unless api_answer.respond_to? "response"
       return { error: 'no response' }     if api_answer.response.nil?
       return { error: 'no response' }     if api_answer.response.to_s.eql? ""
       return JSON.parse(api_answer.response.body, symbolize_names: true)
     end
 
-  end 
+  end
 
 end

data/lib/openapply/get_many_students.rb

@@ -1,125 +1,118 @@
-module Get
+module Openapply
+  module GetManyStudents
 
-  # @note Get all student details matching the criteria in params
-  # @param params[:status] - (String or Array of Strings) - list the status wanted
-  # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
-  # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
-  # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
-  # @param options[:get_payments] (Boolean) - get student payments
-  def many_students_details( params, options={} )
-    ids = many_students_ids( params )
-    return {error: "need an array of ids"}          unless ids[:ids]
-    return many_students_details_by_ids( ids[:ids], options )
-  end
+    # @note Get all student details matching the criteria in params
+    # @param params[:status] - (String or Array of Strings) - list the status wanted
+    # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
+    # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
+    # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
+    # @param options[:get_payments] (Boolean) - get student payments
+    def many_students_details( params, options={} )
+      ids = many_students_ids( params )
+      return {error: "need an array of ids"}          unless ids[:ids]
+      return many_students_details_by_ids( ids[:ids], options )
+    end
 
-  # @note Get all student details matching the criteria in params
-  # @param ids - (Array of Integers) - list ids wanted to lookup
-  # @param options[:get_payments] (Boolean) - get student payments
-  def many_students_details_by_ids( ids, options={} )
-    return {error: 'no ids provided'} if ids.nil? or ids.empty?
-    students  = []
-    guardians = []
-    ids       = [ids]     unless ids.is_a? Array
-    ids.each do |id|
-      response = one_student_details_by_id( id, options )
-      # pp response
-      students  << response[:student]
-      guardians << response[:guardians]
+    # @note Get all student details matching the criteria in params
+    # @param ids - (Array of Integers) - list ids wanted to lookup
+    # @param options[:get_payments] (Boolean) - get student payments
+    def many_students_details_by_ids( ids, options={} )
+      return {error: 'no ids provided'} if ids.nil? or ids.empty?
+      students  = []
+      guardians = []
+      ids       = [ids]     unless ids.is_a? Array
+      ids.each do |id|
+        response = one_student_details_by_id( id, options )
+        # pp response
+        students  << response[:student]
+        guardians << response[:guardians]
+      end
+      return  { students: students,
+                guardians: guardians,
+              }
     end
-    return  {
-              students: students,
-              guardians: guardians,
-            }
-  end
 
-  # @note Get all student ids matching the criteria in params
-  # @param params[:status] - (String or Array of Strings) - list the status wanted
-  # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
-  # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
-  # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
-  def many_students_ids( params )
-    response = many_students_summaries( params )
-    ids = response[:students].map{ |kid| kid[:id] }
-    { ids: ids }
-  end
+    # @note Get all student ids matching the criteria in params
+    # @param params[:status] - (String or Array of Strings) - list the status wanted
+    # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
+    # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
+    # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
+    def many_students_ids( params )
+      response = many_students_summaries( params )
+      ids = response[:students].map{ |kid| kid[:id] }
+      { ids: ids }
+    end
 
-  # @note Get all student ids & guardian ids with associated last updated timestamp (matching the criteria in params)
-  # @param params[:status] - (String or Array of Strings) - list the status wanted
-  # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
-  # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
-  # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
-  def many_ids_updated_time( params )
-    response = many_students_summaries( params )
-    kids  = response[:students].map{ |kid| {kid[:id] => kid[:updated_at]} }
-    rents = response[:guardians].map{ |rent| {rent[:id] => rent[:updated_at]} }
-    { ids_updated_at:
-      {
-        students: kids,
-        guardians: rents,
+    # @note Get all student ids & guardian ids with associated last updated timestamp (matching the criteria in params)
+    # @param params[:status] - (String or Array of Strings) - list the status wanted
+    # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
+    # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
+    # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
+    def many_ids_updated_time( params )
+      response = many_students_summaries( params )
+      kids  = response[:students].map{ |kid| {kid[:id] => kid[:updated_at]} }
+      rents = response[:guardians].map{ |rent| {rent[:id] => rent[:updated_at]} }
+      { ids_updated_at:
+        { students: kids,
+          guardians: rents,
+        }
       }
-    }
-  end
-
-  # @note Get all student summaries matching the criteria in params
-  # @param params[:status] - (String or Array of Strings) - list the status wanted
-  # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
-  # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
-  # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
-  def many_students_summaries( params={} )
-    # status=nil,since_id=nil,since_date=nil,count=api_records)
-    return {error: 'no query provided'} if params.empty?
-
-    students      = []
-    guardians     = []
-
-    count         = params[:count]
-    count       ||= api_records()
-    since_date    = params[:since_date]
-    statuses      = params[:status]
-    statuses      = [statuses]          if not statuses.nil? and
-                                                statuses.is_a? String
-    statuses.each do |status|
-
-      # these values need to be reset for each status loop
-      page_number   = nil
-      since_id      = params[:since_id]
-
-      # loop until all pages recieved
-      while  page_number.nil? or page_number > 1
-        url = url_for_many_students_summaries(status, since_id, since_date, count)
-        answer        = oa_answer( url )
-        break        if answer.nil? or answer[:students].empty?
+    end
 
-        students     += answer[:students]
-        guardians    += answer[:linked][:parents]
+    # @note Get all student summaries matching the criteria in params
+    # @param params[:status] - (String or Array of Strings) - list the status wanted
+    # @param params[:since_id] - (Integer) - get all ids matching the criteria LARGER than the given number
+    # @param params[:since_date] - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
+    # @param params[:count] - (Integer) - The number of customers to return - large numbers need a large timeout
+    def many_students_summaries( params={} )
+      # status=nil,since_id=nil,since_date=nil,count=api_records)
+      return {error: 'no query provided'} if params.empty?
+      students      = []
+      guardians     = []
+      count         = params[:count]
+      count       ||= api_records()
+      since_date    = params[:since_date]
+      statuses      = params[:status]
+      statuses      = [statuses]          if not statuses.nil? and
+                                                  statuses.is_a? String
+      statuses.each do |status|
+        page_number   = nil
+        since_id      = params[:since_id]
 
-        last_student  = answer[:students].last
-        since_id      = last_student[:id]
-        # since_id      = (answer[:students].last)[:id]
-        page_number   = answer[:meta][:pages]
+        # loop until all pages recieved
+        while  page_number.nil? or page_number > 1
+          url = url_for_many_students_summaries(status, since_id, since_date, count)
+          answer        = oa_answer( url )
+          break        if answer.nil? or answer[:students].empty?
+          students     += answer[:students]
+          guardians    += answer[:linked][:parents]
+          last_student  = answer[:students].last
+          since_id      = last_student[:id]
+          page_number   = 0                              if answer[:meta].nil?
+          page_number   = answer[:meta][:pages].to_i unless answer[:meta].nil?
+        end
       end
+      return  { students: students,
+                guardians: guardians,
+              }
     end
-    return  {
-              students: students,
-              guardians: guardians,
-            }
-  end
 
-  # @note Get url to query for student summaries matching the criteria in params
-  # @param status - (String or Array of Strings) - list the status wanted
-  # @param since_id - (Integer) - get all ids matching the criteria LARGER than the given number
-  # @param since_date - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
-  # @param count - (Integer) - The number of customers to return - large numbers need a large timeout
-  def url_for_many_students_summaries(status=nil, since_id=nil,
-                                      since_date=nil, count=api_records)
-    url_options = []
-    url_options << "status=#{status}"         unless status.to_s.eql? ""
-    url_options << "since_id=#{since_id}"     unless since_id.to_s.eql? ""
-    url_options << "since_date=#{since_date}" unless since_date.to_s.eql? ""
-    url_options << "count=#{count}"
-    url_options << "auth_token=#{api_key}"
+    # @note Get url to query for student summaries matching the criteria in params
+    # @param status - (String or Array of Strings) - list the status wanted
+    # @param since_id - (Integer) - get all ids matching the criteria LARGER than the given number
+    # @param since_date - (String) - all records updated after the given date (YYYY-MM-DD) or Date and Time (YYYY-MM-DD HH:MM:SS) - 24 hour clock (not sure about timeszone)
+    # @param count - (Integer) - The number of customers to return - large numbers need a large timeout
+    def url_for_many_students_summaries(status=nil, since_id=nil,
+                                        since_date=nil, count=api_records)
+      url_options = []
+      url_options << "status=#{status}"         unless status.to_s.eql? ""
+      url_options << "since_id=#{since_id}"     unless since_id.to_s.eql? ""
+      url_options << "since_date=#{since_date}" unless since_date.to_s.eql? ""
+      url_options << "count=#{count}"
+      url_options << "auth_token=#{api_key}"
 
-    return "#{api_path}?#{url_options.join('&')}"
-  end
+      return "#{api_path}?#{url_options.join('&')}"
+    end
 
+  end
 end

data/lib/openapply/get_one_student.rb

@@ -1,65 +1,54 @@
 # SINGLE STUDENT API GET CALLS
 ##############################
+module Openapply
+  module GetOneStudent
+
+    # @note Get all student details matching the associated id
+    # @param ids - (Integer) - ids of student to lookup
+    # @param options[:get_payments] (Boolean) - get student payments (or not)
+    def one_student_details_by_id( id, options={} )
+      get_payments = options[:get_payments]  unless options.nil? or options.empty?
+      get_payments ||= true  if get_payments.nil?
+      student_info = one_student_record_by_id( "#{id}" )
+
+      return {student: {id: id, empty: []}}      if student_info.nil? or
+                                                    student_info[:student].nil?
+                                                    student_info[:student].empty?
+      student = []
+      student = student_info[:student]       unless student_info[:student].nil?
+      guardians = []
+      guardians = student_info[:linked][:parents].dup unless
+                                                    student_info[:linked].nil? or
+                                                    student_info[:linked].empty? or
+                                                    student_info[:linked][:parents].nil?
+      payments = []
+      payment_info = one_student_payments_by_id("#{id}") if get_payments.eql? true
+      payments = payment_info[:payments].dup unless payment_info.nil? or
+                                                    payment_info[:payments].nil?
+      return  { student: {  id: id,
+                            record: student,
+                            payments: payments,
+                            guardians: guardians,
+                          },
+                guardians: guardians,
+              }
+    end
+
+    # @note Get one student's primary record matching the associated id
+    # @param ids - (Integer) - ids of student to lookup
+    # @param options - http options
+    def one_student_record_by_id(id, options ={})
+      url = "#{api_path}#{id}?auth_token=#{api_key}"
+      return oa_answer( url, options )
+    end
+
+    # @note Get one student's details matching the associated id
+    # @param ids - (Integer) - ids of student to lookup
+    # @param options - http options
+    def one_student_payments_by_id(id, options={})
+      url = "#{api_path}#{id}/payments?auth_token=#{api_key}"
+      return oa_answer( url, options )
+    end
 
-module Get
-
-  # @note Get all student details matching the associated id
-  # @param ids - (Integer) - ids of student to lookup
-  # @param options[:get_payments] (Boolean) - get student payments (or not)
-  def one_student_details_by_id( id, options={} )
-
-    get_payments = options[:get_payments]  unless options.nil? or options.empty?
-    get_payments ||= true  if get_payments.nil?
-
-    # get full student record and guardian information
-    student_info = one_student_record_by_id( "#{id}" )
-
-    # be sure there is student data to process -- if not return an empty record
-    return {student: {id: id, empty: []}}      if student_info.nil? or
-                                                  student_info[:student].nil?
-                                                  student_info[:student].empty?
-    student = []
-    # extract the student info
-    student = student_info[:student]       unless student_info[:student].nil?
-
-    guardians = []
-    # extract guardian information
-    guardians = student_info[:linked][:parents].dup unless
-                                                  student_info[:linked].nil? or
-                                                  student_info[:linked].empty? or
-                                                  student_info[:linked][:parents].nil?
-    payments = []
-    # get student payment records
-    payment_info = one_student_payments_by_id("#{id}") if get_payments.eql? true
-    # extract payment information
-    payments = payment_info[:payments].dup unless payment_info.nil? or
-                                                  payment_info[:payments].nil?
-    # organize the student details
-    return  {
-              student:
-                { id: id,
-                  record: student,
-                  payments: payments,
-                  guardians: guardians,
-                },
-              guardians: guardians,
-            }
   end
-
-  # @note Get one student's primary record matching the associated id
-  # @param ids - (Integer) - ids of student to lookup
-  # @param options - http options
-  def one_student_record_by_id(id, options ={})
-    url = "#{api_path}#{id}?auth_token=#{api_key}"
-    return oa_answer( url, options )
-  end
-
-  # @note Get one student's details matching the associated id
-  # @param ids - (Integer) - ids of student to lookup
-  # @param options - http options
-  def one_student_payments_by_id(id, options={})
-    url = "#{api_path}#{id}/payments?auth_token=#{api_key}"
-    return oa_answer( url, options )
-  end
-
 end

data/lib/openapply/put.rb

@@ -1,3 +1,5 @@
-module Put
+module Openapply
+  module Put
 
+  end
 end

data/lib/openapply/version.rb

@@ -1,3 +1,5 @@
 module Openapply
-  VERSION = "0.3.0"
+  module Version
+    VERSION = "0.3.1"
+  end
 end

data/openapply.gemspec

@@ -5,15 +5,11 @@ require "openapply/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "openapply"
-  spec.version       = Openapply::VERSION
+  spec.version       = Openapply::Version::VERSION
   spec.authors       = ["Bill Tihen"]
-  spec.email         = ["btihen@las.ch"]
+  spec.email         = ["btihen@gmail.com","btihen@las.ch"]
 
-  spec.summary       = %q{Access OpenApply's API with Ruby}
-  spec.description   = %q{Access to OpenApply's API and extra utilities that
-                          accomplish common needs -- such as recursively query
-                          for all students of a given status or change-date
-                          until all needed records are recieved.}
+  spec.summary       = %q{Access OpenApply's v1 API with Ruby}
   spec.homepage      = "https://github.com/las-it/openapply"
   spec.license       = "MIT"
 
@@ -26,10 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "httparty", "~> 0.15"
   spec.add_dependency "json" , "~> 2.1"
-  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 'codacy-coverage', '~> 1.1'
   spec.add_development_dependency "webmock", "~> 3.2"
   spec.add_development_dependency "bundler", "~> 1.15"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapply
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bill Tihen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,34 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: net-ssh
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: net-scp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: codacy-coverage
   requirement: !ruby/object:Gem::Requirement
@@ -150,17 +122,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-description: |-
-  Access to OpenApply's API and extra utilities that
-                            accomplish common needs -- such as recursively query
-                            for all students of a given status or change-date
-                            until all needed records are recieved.
+description: 
 email:
+- btihen@gmail.com
 - btihen@las.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bettercodehub.yml"
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
@@ -176,6 +146,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/demo.rb
 - lib/openapply.rb
 - lib/openapply/client.rb
 - lib/openapply/get_many_students.rb
@@ -203,8 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Access OpenApply's API with Ruby
+summary: Access OpenApply's v1 API with Ruby
 test_files: []