openapply 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f5f9e9dffcc5d31464293631392d8cfca4c89c462f588e9271b9d9975fc585d
-  data.tar.gz: 50b2a66cc01a5d017246799febb2cde80b905db8f18f33c223cf2531b30f07f9
+  metadata.gz: 9a8737224f666de68e77a77cd2b7b5c0a640635bcf6d1ecef71314859aa8b061
+  data.tar.gz: fc001a7b77f3d66dbbb8b3c6cf56cf09457b1c3d4fbb86b219995b88ef92dd61
 SHA512:
-  metadata.gz: 8aeab600b2b9fb214bdc75b927f83a4ea0d8a64b070cec1193ced7bfdaf7d70538e146259c48239f40994d623a024f55042b5dec87eb586fdbb3df70afb3a1a8
-  data.tar.gz: c45b4d9b269d2d39ea785236f82bf2df7c964bd2c23959bcbf8061a381806238011009a496b8361bd59729569cb390c9a908d79e4758a367fbe290c0f368c997
+  metadata.gz: a99d27d4feed780a81d7d6f1f3699394aab6e4cccc87057b9166021b43baf4ac41470de484f918c978d5a97882ff169a33754cc5324005d6e6ce61cef4b6ae9d
+  data.tar.gz: 483cad9cc3d138b92a995fcd5af9a21c766b7abadceab9298fdff380eae3c9e26f363c0d1c291227e7b007da385bac1e6eec1ba38d82d05bc31b336ce44e64c1

data/CHANGE_LOG.md

@@ -1,5 +1,8 @@
 ### Openapply CHANGE LOG
 
+* **v0.4.0** - compatible with 0.3.x - 2018-06-08
+  - add put ability for student id and status
+
 * **v0.3.3** - compatible with 0.3.x - 2018-04-20
   - add more exceptions to catch misconfigs and alert coder
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapply (0.3.3)
+    openapply (0.4.0)
       httparty (~> 0.15)
       json (~> 2.1)
 
@@ -16,7 +16,7 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    docile (1.3.0)
+    docile (1.3.1)
     hashdiff (0.3.7)
     httparty (0.16.2)
       multi_xml (>= 0.5.2)
@@ -47,7 +47,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    webmock (3.3.0)
+    webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff

data/examples/demo.rb

@@ -29,3 +29,6 @@ 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 )
+
+# Update Student ID
+update_id = @oa.update_student_id(533497, 533497)

data/lib/openapply/client.rb

@@ -53,10 +53,11 @@ module Openapply
       ENV['OA_RECORD_COUNT'] || '50'
     end
 
-    # @note Does the actual api call to OpenApply & handles API timeouts gracefully
+    # @note Does the actual api call(get) 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={})
+
+    def get(url, options={})
       # add exception if ENV are not set
       max_retries = 3
       times_retried = 0
@@ -71,17 +72,51 @@ module Openapply
         end
       end
     end
+    alias_method :oa_api_call, :get
+
+    # @note Does the actual api call(put) 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 put(url, value, options={})
+      # add exception if ENV are not set
+      # Per emai from Mackenzine on API call formatting, vs what is found on API site
+     #  curl -X "PUT" "https://las.openapply.com/api/v1/students/OAID" \
+     # -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \
+     # --data-urlencode "student_id=YOURID" \
+     # --data-urlencode "auth_token=YOURTOKEN"
+      max_retries = 3
+      times_retried = 0
+      begin
+        query = {auth_token: api_key}.merge(value)
+        header = { 'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8' }
+        self.class.put(url,
+                        query: query,
+                        headers: header )
+      rescue Net::ReadTimeout, Net::OpenTimeout
+        if times_retried < max_retries
+          times_retried += 1
+          retry
+        else
+          { error: "no response (timeout) from URL: #{url}"  }
+        end
+      end
+    end
+
 
     # @note checks the info for validity & unpacks the json retubed to a JS formatt
+    # @note by passing in a value such as student_id or status this will automatically trigger the change form get to put
     # @param url [String] - this is the url to do the call
+    # @param value [Hash] - This is used to update the student_id or status
     # @param options - see httparty options [http://www.rubydoc.info/github/jnunemaker/httparty]
-    def oa_answer(url, options={})
+    def oa_answer(url, value={}, options={})
       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 = oa_api_call(url, options)
+      api_answer = send(:get, url, options)            if value.empty?
+      api_answer = send(:put, url, value, options) unless value.empty?
 
       return api_answer               unless api_answer.respond_to? "response"
       return { error: 'no response' }     if api_answer.response.nil?

data/lib/openapply/put.rb

@@ -1,5 +1,32 @@
+require 'json'
+
 module Openapply
+  # OpenApply API Page
+  # https://dev.faria.co/oa/#resources-reference
   module Put
 
+    # @note Update one student's Student ID (Field in OpenApply must be currently Blank)
+    # @param oa_id - (Integer) - id of student to update
+    # @param student_id - (Integer) - id to put in student_id field
+    # PUT https://<school_subdomain>.openapply.com/api/v1/students/1/student_id
+    # PUT Data student_id=123456
+    def update_student_id(oa_id, student_id)
+      # url = "#{api_path}#{id}?auth_token=#{api_key}"
+      url = "#{api_path}#{oa_id}"
+      return oa_answer( url, {student_id: student_id})
+    end
+
+    # @note Update one student's status
+    # @param oa_id - (Integer) - id of student to update
+    # @param status - (string) - status to update for student
+    # PUT https://<school_subdomain>.openapply.com/api/v1/students/1/status
+    # PUT Data status=Applied
+    def update_student_status(oa_id, status)
+      # url = "#{api_path}#{id}/status?auth_token=#{api_key}"
+      url = "#{api_path}#{oa_id}/status"
+      return oa_answer( url, {status: status})
+    end
+
+
   end
 end

data/lib/openapply/version.rb

@@ -1,5 +1,5 @@
 module Openapply
   module Version
-    VERSION = "0.3.3"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapply
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Bill Tihen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty