openapply 0.4.0 → 1.0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8737224f666de68e77a77cd2b7b5c0a640635bcf6d1ecef71314859aa8b061
-  data.tar.gz: fc001a7b77f3d66dbbb8b3c6cf56cf09457b1c3d4fbb86b219995b88ef92dd61
+  metadata.gz: dbf10a50cefd81755cc8f3bcdb2098315d82cf5c72b1b7b0678aa2cb6e0177b0
+  data.tar.gz: 5ae83cc1a9e57bfcd82d7a77d0024da024f7fb18c70b88acf21ed3e0da290e55
 SHA512:
-  metadata.gz: a99d27d4feed780a81d7d6f1f3699394aab6e4cccc87057b9166021b43baf4ac41470de484f918c978d5a97882ff169a33754cc5324005d6e6ce61cef4b6ae9d
-  data.tar.gz: 483cad9cc3d138b92a995fcd5af9a21c766b7abadceab9298fdff380eae3c9e26f363c0d1c291227e7b007da385bac1e6eec1ba38d82d05bc31b336ce44e64c1
+  metadata.gz: 2a96d8a7ff2f7d443a515da7d8441d4c06b7a798bf91392549fd422a9d34a3117c7d9d365a689ae07e42a2bbbad47ef2856647b780b3136bb47a12afa5fff618
+  data.tar.gz: 55a62490b29f061976b84c59d81b5cd7ba18d96fff46b0e1eea058c31bd8a68d6c867c02f70468512a1ec72cb3ae9b17f644e9f9d7c46814b0baf1b512cc9ad1

data/CHANGE_LOG.md

@@ -1,5 +1,22 @@
 ### Openapply CHANGE LOG
 
+* **v1.0.2** - compatible with 1.0.x - 2020-05-18
+  - improve auth token generation
+
+* **v1.0.1** - compatible with 1.0.x - 2020-05-18
+  - update dependencies
+
+* **v1.0.0** - compatible with 1.0.x - 2020-05-14
+  - update path to use OpenApply API v3
+  - oauth authentification
+  - add arguments in addition to environment variables
+
+* **v0.4.2** - compatible with 0.4.x - 2020-03-03
+  - update dependencies
+
+* **v0.4.1** - compatible with 0.4.x - 2018-06-19
+  - force all openapply interactions to use https
+
 * **v0.4.0** - compatible with 0.3.x - 2018-06-08
   - add put ability for student id and status
 

data/Gemfile.lock

@@ -1,68 +1,84 @@
 PATH
   remote: .
   specs:
-    openapply (0.4.0)
-      httparty (~> 0.15)
-      json (~> 2.1)
+    openapply (1.0.3.2)
+      httparty (~> 0.18)
+      json (~> 2.3)
+      oauth2 (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    codacy-coverage (1.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    codacy-coverage (2.2.1)
       simplecov
-    coderay (1.1.2)
+    coderay (1.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    hashdiff (0.3.7)
-    httparty (0.16.2)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    json (2.1.0)
-    method_source (0.9.0)
+    json (2.3.1)
+    jwt (2.2.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.0.2)
-    rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.4)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    safe_yaml (1.0.4)
-    simplecov (0.16.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    simplecov (0.19.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    webmock (3.4.2)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    webmock (3.9.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.15)
-  codacy-coverage (~> 1.1)
+  bundler (~> 2.1)
+  codacy-coverage (~> 2.1)
   openapply!
-  pry (~> 0.11)
-  rake (~> 12.3)
-  rspec (~> 3.7)
-  webmock (~> 3.2)
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  webmock (~> 3.9)
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/README.md

@@ -1,125 +1,17 @@
-[![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/)  
+[![Codeship Status for LAS-IT/openapply](https://app.codeship.com/projects/b3b1a8b0-3f90-0138-630c-02a65faac0e6/status?branch=master)](https://app.codeship.com/projects/387673)  [![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 API wrapper
 
-
-# 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
-
-
-### CHANGE LOG
+## CHANGE LOG
 
 [Change Log](https://github.com/btihen/openapply/blob/master/CHANGE_LOG.md)
 
+## Openapply v3
 
-### Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'openapply'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install openapply
-
-
-### 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
-# this gem uses 50 as the default
-OA_RELPY_RECORDS=50
-
-# 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
-# from https://demo.openapply.com/admin/dashboard (it will reset every hour)
-# navigate to Settings > Integrations, and enable the API, and generate a token
-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
-```
-
-###  USAGE
-
-#### USAGE SUMMARY
-
-```ruby
-require 'openapply'
-# instantiate
-@oa = Openapply::Client.new
-
-# see settings
-@oa.api_url
-@oa.api_key
-@oa.api_path
-@oa.api_timeout
-@oa.api_records
-
-# 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
+[OpenApply V3 README](README_v3.md)
 
-* **valid status includes:**
-  - Status
-  - Pending
-  - Applied
-  - Admitted
-  - Wait-listed
-  - Declined
-  - Enrolled
-  - Graduated
-  - Withdrawn
+## Openapply v1
 
+[OpenApply V1 README](README_v1.md)
 
 ## Development
 

data/README_v1.md

@@ -0,0 +1,109 @@
+# Openapply v1
+
+This gem allows ruby access to the OpenApply API v1 - and supports the GET features described at: https://(your openapply domain)/help/api_v1
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapply', "~> 0.4"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openapply  -v "~> 0.4"
+
+## 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
+# this gem uses 50 as the default
+OA_RELPY_RECORDS=50
+
+# 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
+# from https://demo.openapply.com/admin/dashboard (it will reset every hour)
+# navigate to Settings > Integrations, and enable the API, and generate a token
+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
+```
+
+##  USAGE
+
+### USAGE SUMMARY
+
+```ruby
+require 'openapply'
+# instantiate
+@oa = Openapply::Client.new
+
+# see settings
+@oa.api_url
+@oa.api_key
+@oa.api_path
+@oa.api_timeout
+@oa.api_records
+
+# 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:**
+  - Status
+  - Pending
+  - Applied
+  - Admitted
+  - Wait-listed
+  - Declined
+  - Enrolled
+  - Graduated
+  - Withdrawn

data/README_v3.md

@@ -0,0 +1,130 @@
+# Openapply v3
+
+This gem allows ruby access to the OpenApply API v3 - and supports the GET features described at: https://(your openapply domain)/help/api_v3
+
+## TODO
+- [x] implement OAuth 2.0
+- [x] update students GET wrapper
+- [x] update students payement info GET wrapper
+- [] implement students advanced search
+- [] implement parents GET wrapper
+- [] implement parents advanced search
+- [] implement students and parent PUT wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapply', "~> 1.0"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openapply -v "~> 1.0"
+
+## Docs
+
+* http://www.rubydoc.info/gems/openapply
+
+
+## Configuration
+
+Note: (these are example value uses your own **.rbenv-vars**):
+
+* Setup / Config the following ENV-VARS
+
+```bash
+# Please set this before instantiation
+# timeout in seconds (before retry - 3 times)
+OA_TIMEOUT=5
+```
+
+* Setup your defaults
+
+```bash
+# 100 records is the advertised default
+OA_RELPY_RECORDS=100
+
+# 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
+# from https://demo.openapply.com/admin/dashboard (it will reset every two hours)
+# navigate to Settings > Integrations, and enable the API, and generate a client id and client secret
+OA_CLIENT_ID=demo_site_client_id
+OA_CLIENT_SECRET=demo_site_client_secret
+```
+
+## Instantiation
+You can also associate your own configuration value on the fly using instantiation arguments, if an arguments is missing it will fallback to ENV variables for this specific arguments.
+
+```ruby
+@oa = Openapply::Client.new(url: "", client_id: "", client_secret: "", token: "")
+```
+
+## USAGE
+
+### Authentication
+If `:token` is not present, a new token will be generated, tokens are valid for ~30 days. For performance optimization we encourage you to cache your token, and regenerate one when it expires. You can find a rails example on the wiki.  
+
+### USAGE SUMMARY
+
+```ruby
+require 'openapply'
+# instantiate
+@oa = Openapply::Client.new
+
+# see settings
+@oa.api_url
+@oa.api_key
+# => auth_token
+@oa.api_path
+@oa.api_timeout
+@oa.api_records
+@oa.api_client_id
+@oa.api_client_secret
+
+# get auth token
+@oa.authentificate
+# => OAuth2::AccessToken
+
+# 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:**
+  - Status
+  - Pending
+  - Applied
+  - Admitted
+  - Wait-listed
+  - Declined
+  - Enrolled
+  - Graduated
+  - Withdrawn

data/examples/demo.rb

@@ -21,6 +21,10 @@ require 'openapply'
 params = {status: 'applied'}
 summaries = @oa.many_students_summaries( params )
 
+# get information details on one student
+oa_id = 123456
+one_details = @oa.one_student_details_by_id(oa_id)
+
 # 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 )

data/lib/openapply/client.rb

@@ -1,3 +1,4 @@
+require 'oauth2'
 require "openapply/get_many_students"
 require "openapply/get_one_student"
 require "openapply/put"
@@ -11,46 +12,55 @@ module Openapply
     include Openapply::GetOneStudent    # GET api calls
     include Openapply::GetManyStudents  # GET api calls
 
-    API_URL        = ENV['OA_BASE_URI']
-    API_TIMEOUT    = ENV['OA_TIMEOUT'].to_i || 5
-
-    base_uri API_URL
+    API_TIMEOUT = ENV['OA_TIMEOUT'].to_i == 0 ? 5 : ENV['OA_TIMEOUT'].to_i
     default_timeout API_TIMEOUT
 
-    # attr_reader :api_url, :api_key
-
-    def initialize
-      api_url     = ENV['OA_BASE_URI']
-      api_key     = ENV['OA_AUTH_TOKEN']
+    # @param [String] url Base uri
+    # @param [String] client_id
+    # @param [String] client_secret
+    # @param [String] token if present will not generate an auth token
+    def initialize(url: nil, client_id: nil, client_secret: nil, token: nil)
+      @api_url     = format_api_url(url || ENV['OA_BASE_URI'])
+      @api_client_id     = client_id || ENV['OA_CLIENT_ID']
+      @api_client_secret     = client_secret || ENV['OA_CLIENT_SECRET']
+      @api_key             = token
 
-      raise ArgumentError, 'OA_TIMEOUT is missing'    if api_timeout.nil? or
-                                                          not api_timeout.is_a? Integer
-      raise ArgumentError, 'OA_API_PATH is missing'   if api_path.nil? or
-                                                          api_path.empty?
       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?
+      raise ArgumentError, 'OA_CLIENT_ID is missing' if api_client_id.nil? or
+                                                          api_client_id.empty?
+      raise ArgumentError, 'OA_CLIENT_SECRET is missing' if api_client_secret.nil? or
+                                                          api_client_secret.empty?
+
+      self.class.base_uri api_url
     end
 
     def api_url
-      ENV['OA_BASE_URI']
+      @api_url
     end
 
     def api_timeout
-      ENV['OA_TIMEOUT'].to_i
+      API_TIMEOUT
+    end
+
+    def api_client_id
+      @api_client_id
+    end
+
+    def api_client_secret
+      @api_client_secret
     end
 
     def api_key
-      ENV['OA_AUTH_TOKEN']
+      @api_key || authentificate.token
     end
 
     def api_path
-      ENV['OA_API_PATH']     || "/api/v1/students/"
+      "/api/v3"
     end
 
     def api_records
-      ENV['OA_RECORD_COUNT'] || '50'
+      ENV['OA_RECORD_COUNT'] || '100'
     end
 
     # @note Does the actual api call(get) to OpenApply & handles API timeouts gracefully
@@ -58,10 +68,10 @@ module Openapply
     # @param options - see httparty options [http://www.rubydoc.info/github/jnunemaker/httparty]
 
     def get(url, options={})
-      # add exception if ENV are not set
       max_retries = 3
       times_retried = 0
       begin
+        options[:headers] = { 'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8', "Authorization" => auth_token}
         self.class.get(url, options)
       rescue Net::ReadTimeout, Net::OpenTimeout
         if times_retried < max_retries
@@ -79,7 +89,6 @@ module Openapply
     # @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' \
@@ -88,11 +97,9 @@ module Openapply
       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 )
+        options[:headers] = { 'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8', "Authorization" => auth_token}
+        options[:body] = value
+        self.class.put(url, options)
       rescue Net::ReadTimeout, Net::OpenTimeout
         if times_retried < max_retries
           times_retried += 1
@@ -104,7 +111,7 @@ module Openapply
     end
 
 
-    # @note checks the info for validity & unpacks the json retubed to a JS formatt
+    # @note checks the info for validity & unpacks the json retubed to a JS format
     # @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
@@ -113,10 +120,11 @@ module Openapply
       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 = send(:get, url, options)            if value.empty?
-      api_answer = send(:put, url, value, options) unless value.empty?
+      if value.empty?
+        api_answer = send(:get, url, options) if value.empty?
+      else
+        api_answer = send(:put, url, value, options) unless value.empty?
+      end
 
       return api_answer               unless api_answer.respond_to? "response"
       return { error: 'no response' }     if api_answer.response.nil?
@@ -124,6 +132,34 @@ module Openapply
       return JSON.parse(api_answer.response.body, symbolize_names: true)
     end
 
+    # @note authentificate using oauth2
+    # @return [OAuth2::AccessToken]
+    def authentificate
+      client = OAuth2::Client.new(api_client_id, api_client_secret, site: api_url)
+      return client.client_credentials.get_token
+    end
+
+    private
+
+    # @note Force url to https://
+    def format_api_url(url)
+      return case
+        when url.nil?
+          raise ArgumentError, 'OA_BASE_URI is missing'
+        when url.start_with?('https://')
+          url
+        when url.start_with?('http://')
+          url.gsub("http", "https")
+        else
+          "https://#{url}"
+        end
+    end
+
+    # @note format auth token
+    def auth_token
+      "Bearer " + api_key
+    end
+
   end
 
 end

data/lib/openapply/get_many_students.rb

@@ -109,9 +109,8 @@ module Openapply
       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('&')}"
+      return "#{api_path}/students/?#{url_options.join('&')}"
     end
 
   end

data/lib/openapply/get_one_student.rb

@@ -38,7 +38,7 @@ module Openapply
     # @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}"
+      url = "#{api_path}/students/#{id}"
       return oa_answer( url, options )
     end
 
@@ -46,7 +46,7 @@ module Openapply
     # @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}"
+      url = "#{api_path}/students/#{id}/payments"
       return oa_answer( url, options )
     end
 

data/lib/openapply/put.rb

@@ -11,22 +11,21 @@ module Openapply
     # 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})
+      # url = "#{api_path}#{oa_id}"
+      url = "#{api_path}/students/#{oa_id}"
+      return oa_answer( url, {student: {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}#{oa_id}/status"
+    #   url = "#{api_path}/students/#{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.4.0"
+    VERSION = "1.0.3.2"
   end
 end

data/openapply.gemspec

@@ -6,10 +6,10 @@ require "openapply/version"
 Gem::Specification.new do |spec|
   spec.name          = "openapply"
   spec.version       = Openapply::Version::VERSION
-  spec.authors       = ["Bill Tihen"]
-  spec.email         = ["btihen@gmail.com","btihen@las.ch"]
+  spec.authors       = ["Bill Tihen", "Elliott Hébert"]
+  spec.email         = ["btihen@gmail.com","btihen@las.ch","ell.heb@container4.ch","ehebert@las.ch"]
 
-  spec.summary       = %q{Access OpenApply's v1 API with Ruby}
+  spec.summary       = %q{Access OpenApply's APIs with Ruby}
   spec.homepage      = "https://github.com/las-it/openapply"
   spec.license       = "MIT"
 
@@ -20,14 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.15"
-  spec.add_dependency "json" , "~> 2.1"
-
-  spec.add_development_dependency 'codacy-coverage', '~> 1.1'
-  spec.add_development_dependency "webmock", "~> 3.2"
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.7"
-  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_dependency "httparty", "~> 0.18"
+  spec.add_dependency "json" , "~> 2.3"
+  spec.add_dependency "oauth2", "~> 1.4"
 
+  spec.add_development_dependency 'codacy-coverage', '~> 2.1'
+  spec.add_development_dependency "webmock", "~> 3.9"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "pry", "~> 0.13"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openapply
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.3.2
 platform: ruby
 authors:
 - Bill Tihen
+- Elliott Hébert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,133 +17,147 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: codacy-coverage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
 description: 
 email:
 - btihen@gmail.com
 - btihen@las.ch
+- ell.heb@container4.ch
+- ehebert@las.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".bettercodehub.yml"
-- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
-- ".travis.yml.bak"
 - CHANGE_LOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- MM
 - README.md
+- README_v1.md
+- README_v3.md
 - Rakefile
 - bin/console
 - bin/setup
@@ -173,9 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Access OpenApply's v1 API with Ruby
+summary: Access OpenApply's APIs with Ruby
 test_files: []

data/.circleci/config.yml

@@ -1,70 +0,0 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-dependencies:
-  pre:
-    - gem install bundler -v 1.16.0
-    # - rvm install rubygems 2.4.8 --force
-
-version: 2
-jobs:
-  build:
-    test:
-      override:
-        - bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
-
-    docker:
-      # specify the version you desire here
-       - image: circleci/ruby:2.4.1-node-browsers
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
-
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      # # Database setup
-      # - run: bundle exec rake db:create
-      # - run: bundle exec rake db:schema:load
-
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
-
-            bundle exec rspec --format progress \
-                            --format RspecJunitFormatter \
-                            --out /tmp/test-results/rspec.xml \
-                            --format progress \
-                            "${TEST_FILES}"
-
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results

data/.travis.yml

@@ -1,14 +0,0 @@
-sudo: false
-language: ruby
-branches:
-  only:
-  - master
-  - staging
-rvm:
-- 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

@@ -1,18 +0,0 @@
-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