openapply 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b681f4a386b3ab614a6eb7c4f8b244119a687a275eb0457dc54ff0b49901204
-  data.tar.gz: b6f98f8ca674289a607606c5c79b6e1160e45c53cf88aa038cad2aeaff32c52a
+  metadata.gz: 5ea03a8e3bcfc34624d8c592e83d579600f62e323f00b5fbd563b3ef1b22616b
+  data.tar.gz: 915c89ae39776eb48b0d0533f6ba63b496cad6efb83ffa83d6f9f62ddfad983b
 SHA512:
-  metadata.gz: 656f153e570d7afaede6b73765637868ded3079eadac0763f17fbd1a052ec3f47c787adbefd20b634dbb8f2b8e87afebf8758bae467a9b50e02c3f850dbb4e50
-  data.tar.gz: b4c33173f2bd17b2ab0476231bbcc4ea2cd1a49ec362c24821c34c075cdb231f8620966a2f0f214b529d9a571e61006c116d51001115bfb74880c9865ca45742
+  metadata.gz: 860ecaf7e6d4ad6255edd1785f30c8e51b1dfee12de0747efa78c264d71e2f39983ae46ef31938785455ed0822ef23fc5f946ebf2d0eb950f1cb03e803466afc
+  data.tar.gz: 926f34f47b262ac63786edafbdbd62af3dc7ba3b786d36a26d9180c3404d2f907f74e7ec18247a2a150897eb3bc6e2d97f3fd108faaf0aea1b72ab18aba98723

data/README.md

@@ -5,29 +5,30 @@ This gem allows ruby access to the OpenApply API v1 - and supports the GET featu
 
 ### Still TODO
 
-* xlsx export?
-* test timeouts
 * write PUTS methods
-* write a recursive query to pull students by since date
-* add protection for bad keys - when not an array or not symbol
-* investigate slow response when returning large number of records
-* write a recursive query to pull students by since id (sort of already done)
+* write a recursive custom query
+* speed response when returning large number of records
+* allow flattening and reject to work at any depth (recursion?)
 
 
 ### CHANGE LOG
 
-* **v0.1.0** - test release -- 2017-11-01
-
-* **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.2.2** - update compatible with 0.2.x - 2017-11-21
+  - refactor and test url timeouts
+  - refactor openapply client
 
-* **v0.2.1** - update compatible with 0.2.0 - 2017-11-20
+* **v0.2.1** - update 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
+
 ### Installation
 
 Add this line to your application's Gemfile:

data/lib/openapply.rb

@@ -1,129 +1,6 @@
-require "openapply/get_students"
-require "openapply/get_student"
-require "openapply/convert"
+require "openapply/client"
 require "openapply/version"
-require "openapply/put"
-require 'httparty'
 
 module Openapply
 
-  # OpenApply 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
-
-    # Convert student data to various formats
-    include Convert
-
-    # Library for API calls to OpenApply
-    include HTTParty
-
-    # Defines OpenApply domain name from ENV-VARS
-    API_URL        = (ENV['OA_BASE_URI'] || 'demo.openapply.com')
-
-    # Defines the OpenApply path from ENV-VARS - default is 5 seconds
-    API_TIMEOUT    = (ENV['OA_TIMEOUT'].to_i || 5)
-
-    base_uri API_URL
-    default_timeout API_TIMEOUT
-
-    # Defines OpenApply domain name from ENV-VARS - for example:
-    #  demo.openapply.com
-    def api_url
-      API_URL
-    end
-
-    # Defines http timeout from ENV-VARS - 5 sec is the default
-    def api_reply_count
-      API_TIMEOUT
-    end
-    alias_method :api_timeout, :api_reply_count
-
-    # Defines OpenApply secret access key with ENV-VARS
-    def api_key
-      ENV['OA_AUTH_TOKEN'] || 'demo_site_api_key'
-    end
-
-    # Defines the OpenApply path with ENV-VARS - default is for api_v1
-    #  /api/v1/students/
-    def api_path
-      ENV['OA_API_PATH'] || "/api/v1/students/"
-    end
-
-    # Defines the maximum records OpenApply should return with each api call
-    # with ENV-VARS - (code default is 50 - OA default is 10 - doc says 100)
-    def api_records
-      ENV['OA_REPLY_RECORDS'] || '50'
-    end
-
-    # Handles httparty timeout errors - tries 3x before quitting
-    # https://stackoverflow.com/questions/26251422/handling-netreadtimeout-error-in-httparty
-    # TODO: figure out how to test time outs
-    def handle_timeouts
-      max_retries = 3
-      times_retried = 0
-      begin
-        yield
-      rescue Net::ReadTimeout => error
-        if times_retried < max_retries
-          times_retried += 1
-          # puts "TIMEOUT RETRY: #{times_retried} of #{max_retries} - USING: #{yield.inspect}"
-          retry
-        else
-          # puts "TIME-OUT URI FAILED: #{yield.inspect}"
-          { error: "SITE TIMEOUT - 3 FAILURES USING: #{yield.inspect}" }
-        end
-      end
-    end
-
-    # Does the actual api call to OpenApply
-    #
-    # ==== 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]
-    def oa_api_call(url, options={})
-      self.class.get(url, options)
-    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]
-    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
-
-      handle_timeouts do
-        api_answer = oa_api_call(url, options)
-      end
-
-      # puts "API ANSWER: #{api_answer}"
-      # puts "API ANSWER: #{api_answer.inspect}"
-      return { error: 'no response' } 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
-    # alias_method :openapply_answer, :oa_answer
-
-  end  # Client
-
-end    # Openapply
+end

data/lib/openapply/client.rb

@@ -0,0 +1,118 @@
+require "openapply/get_students"
+require "openapply/get_student"
+require "openapply/convert"
+require "openapply/client"
+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
+
+    # Convert student data to various formats
+    include Convert
+
+    # Library for API calls to OpenApply
+    include HTTParty
+
+    # Defines OpenApply domain name from ENV-VARS
+    API_URL        = (ENV['OA_BASE_URI'] || 'demo.openapply.com')
+
+    # Defines the OpenApply path from ENV-VARS - default is 5 seconds
+    API_TIMEOUT    = (ENV['OA_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_reply_count
+      API_TIMEOUT
+    end
+    alias_method :api_timeout, :api_reply_count
+
+    # Defines & makes visible OpenApply secret access key with ENV-VARS
+    def api_key
+      ENV['OA_AUTH_TOKEN'] || 'demo_site_api_key'
+    end
+
+    # Defines and makes visib le the OpenApply path with ENV-VARS
+    def api_path
+      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_REPLY_RECORDS'] || '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]
+    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
+        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
+    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]
+    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 { 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
+    # alias_method :openapply_answer, :oa_answer
+
+  end  # Client
+
+end    # Openapply

data/lib/openapply/convert.rb

@@ -3,6 +3,9 @@ require 'axlsx'
 require 'net/scp'
 require 'net/ssh'
 
+# CODE THAT TRANSFORMS STUDENT DATA
+###################################
+
 module Convert
 
   # Queries by status to get a list of students details of a given status

data/lib/openapply/get_student.rb

@@ -1,8 +1,7 @@
-module Get
-
-  # SINGLE STUDENT CODE
-  #####################
+# SINGLE STUDENT API GET CALLS
+##############################
 
+module Get
 
   # STUDENT FULL RECORD
   #####################

data/lib/openapply/get_students.rb

@@ -1,3 +1,6 @@
+# MULTIPLE STUDENTS API GET CALLS
+#################################
+
 module Get
 
   # MULTIPLE STUDENTS DETAILS (full records) - found by status (or statuses)

data/lib/openapply/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapply
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Bill Tihen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -186,6 +186,7 @@ files:
 - examples/demo/README.md
 - examples/demo/demo_site.rb
 - lib/openapply.rb
+- lib/openapply/client.rb
 - lib/openapply/convert.rb
 - lib/openapply/get_student.rb
 - lib/openapply/get_students.rb