arux_app 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3619d786915abb5811eca23385011342f49b7c5e7cf7be99c41a50d77972f53e
-  data.tar.gz: 145c55897cdd5fd3fcc9de07dcb837dd092c99f28c936908b0630e02df007d0c
+  metadata.gz: 8e67102cdef4d9e36a67d02867cf51bcce88d71135e629b08a3a8aa10e45700b
+  data.tar.gz: 591f4ab4d415cf18ef2354bdc36e957e819c6acc276f2d7d52956b539b315695
 SHA512:
-  metadata.gz: fb3f7d2756410f4b1a94d71124b0179fd93bd5df33b545e4d4cdc2d97bef1dbf2687d9f82cb8ac21e02ad1ac8db0547a589b38870e630d2af4aebdddaa1feda3
-  data.tar.gz: e66d5f0b8cae74e1397cc657c01d4b19d6ebd65586fc28a7144ad10cac85fbfb6ca378a4a0f93a414904c5394c7306c8a228a0e5c0f4b5a8cffe667b29f93a8c
+  metadata.gz: b8cf881c14802a6056d42e11cce44b6090bbb8b47f335c0a56fa6499425bad61f8441d174c0f47a4a4e2a565ef71dd363bc292455cb13c3587a8416e9d11f265
+  data.tar.gz: 770187f083bb7bcf481c61ce89af477bdde85bf7720adba6e87820a3e6c52dec52ddb600b03d4c519ff3785a370e7d4bb780d2029b40b79542bd381fb3ccf877

data/{arux_app.gemspec → arux.app.gemspec}

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name           = "arux_app"
-  spec.version        = "1.0.0"
+  spec.version        = "2.0.0"
   spec.authors        = ["Arux Software"]
   spec.email          = ["sheuer@aruxsoftware.com"]
   spec.summary        = "Ruby gem for interacting with the Arux.app Switchboard APIs."

data/lib/arux_app/api/account.rb

@@ -2,13 +2,7 @@ module AruxApp
   module API
     class Account
       def self.server_uri
-        if AruxApp::API.standardmode?
-          "https://acc.arux.app"
-        elsif AruxApp::API.testmode?
-          "https://acc.arux.blue"
-        elsif AruxApp::API.devmode?
-          "https://acc.#{HOSTNAME}"
-        end
+        AruxApp::API.server_uri
       end
 
       attr_accessor :auth, :access_token, :api_version
@@ -16,7 +10,7 @@ module AruxApp
       def initialize(options = {})
         self.auth         = options[:auth]
         self.access_token = options[:access_token]
-        self.api_version  = options[:api_version] || 1.2
+        self.api_version  = options[:api_version] || 1.3
 
         raise API::InitializerError.new(:auth_or_access_token, "can't be blank") if self.auth.nil? and self.access_token.nil?
         raise API::InitializerError.new(:auth, "must be of class type AruxApp::API::Auth") if self.auth and !self.auth.is_a?(AruxApp::API::Auth)
@@ -39,7 +33,7 @@ module AruxApp
       end
 
       def get(uuid, params = {})
-        uuid = URI.escape(uuid.to_s)
+        uuid = AruxApp::API.uri_escape(uuid.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{api_route}/users/#{uuid}"
@@ -73,7 +67,7 @@ module AruxApp
       end
 
       def update(uuid, params)
-        uuid = URI.escape(uuid.to_s)
+        uuid = AruxApp::API.uri_escape(uuid.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{api_route}/users/#{uuid}"
@@ -92,8 +86,8 @@ module AruxApp
       end
 
       def merge(uuid1, uuid2)
-        uuid1 = URI.escape(uuid1)
-        uuid2 = URI.escape(uuid2)
+        uuid1 = AruxApp::API.uri_escape(uuid1)
+        uuid2 = AruxApp::API.uri_escape(uuid2)
 
         request = HTTPI::Request.new
         request.url = "#{api_route}/users/merge/#{uuid1}/#{uuid2}"
@@ -109,7 +103,7 @@ module AruxApp
       end
 
       def delete(uuid)
-        uuid = URI.escape(uuid.to_s)
+        uuid = AruxApp::API.uri_escape(uuid.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{api_route}/users/#{uuid}"
@@ -142,7 +136,7 @@ module AruxApp
       end
 
       def list_user_locks(user_uuid)
-        uuid = URI.escape(user_uuid.to_s)
+        uuid = AruxApp::API.uri_escape(user_uuid.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{api_route}/users/#{user_uuid}/locks"
@@ -158,7 +152,7 @@ module AruxApp
       end
 
       def add_user_lock(user_uuid, scope, reason = "")
-        uuid = URI.escape(user_uuid.to_s)
+        uuid = AruxApp::API.uri_escape(user_uuid.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{api_route}/users/#{uuid}/locks"
@@ -182,7 +176,7 @@ module AruxApp
       end
 
       def delete_user_lock(user_uuid, lock_id)
-        uuid = URI.escape(user_uuid.to_s)
+        uuid = AruxApp::API.uri_escape(user_uuid.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{api_route}/users/#{uuid}/locks/#{lock_id}"

data/lib/arux_app/api/auth.rb

@@ -5,11 +5,12 @@ module AruxApp
       class InvalidClientError < API::Error; end
 
       class AccessToken
-        attr_accessor :token, :auth
+        attr_accessor :token, :auth, :scope
 
         def initialize(options = {})
           self.token = options[:token]
           self.auth = options[:auth]
+          self.scope = options[:scope]
 
           raise API::InitializerError.new(:token, "can't be blank") if self.token.to_s.empty?
           raise API::InitializerError.new(:auth, "can't be blank") if self.auth.nil?
@@ -26,13 +27,7 @@ module AruxApp
       end
 
       def self.server_uri
-        if AruxApp::API.standardmode?
-          "https://sso.arux.app"
-        elsif AruxApp::API.testmode?
-          "https://sso.arux.blue"
-        elsif AruxApp::API.devmode?
-          "https://sso.#{HOSTNAME}"
-        end
+        AruxApp::API.server_uri
       end
 
       attr_accessor :client_id, :client_secret, :redirect_uri, :js_callback, :district_subdomain, :current_user_uuid, :login_mechanism, :element
@@ -52,12 +47,46 @@ module AruxApp
         raise API::InitializerError.new(:redirect_uri, "can't be blank") if self.redirect_uri.to_s.empty?
       end
 
-      def authorization_url
-        %(#{self.class.server_uri}/authorize?client_id=#{self.client_id}&redirect_uri=#{self.redirect_uri}&district=#{self.district_subdomain})
+      def authorization_url(scope: "public")
+        base_uri = URI.parse("#{self.class.server_uri}/oauth/authorize")
+        params = {
+          scope: scope,
+          response_type: "code",
+          client_id: client_id,
+          redirect_uri: redirect_uri,
+          district: district_subdomain
+        }
+        base_uri.query = URI.encode_www_form(params)
+        base_uri.to_s
+      end
+
+      def basic_authentication(username, password, scope = "public")
+        params = {
+          scope: scope,
+          grant_type: "password",
+          client_id: client_id,
+          client_secret: client_secret
+        }
+
+        request = HTTPI::Request.new.tap do |req|
+          req.url = "#{self.class.server_uri}/oauth/token"
+          req.body = params
+          req.headers = { 'User-Agent' => USER_AGENT }
+          req.auth.basic(username, password)
+        end
+
+        response = HTTPI.post(request)
+        raise(API::Error.new(response.code, response.body)) if response.error?
+
+        AccessToken.new(
+          token: JSON.parse(response.body)['access_token'],
+          scope: JSON.parse(response.body)['scope'],
+          auth: self
+        )
       end
 
       def registration_url
-        %(#{self.class.server_uri}/register?client_id=#{self.client_id}&redirect_uri=#{self.redirect_uri}&district=#{self.district_subdomain})
+        %(#{self.class.server_uri}/users/registrations?client_id=#{self.client_id}&redirect_uri=#{self.redirect_uri}&district=#{self.district_subdomain})
       end
 
       def access_token(code)
@@ -70,14 +99,18 @@ module AruxApp
         }
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}/access_token"
+        request.url = "#{self.class.server_uri}/oauth/token"
         request.body = data
         request.headers = {'User-Agent' => USER_AGENT}
 
         response = HTTPI.post(request)
 
         if !response.error?
-          return AccessToken.new(:token => JSON.parse(response.body)['access_token'], :auth => self)
+          AccessToken.new(
+            token: JSON.parse(response.body)['access_token'],
+            scope: JSON.parse(response.body)['scope'],
+            auth: self
+          )
         else
           begin
             resp_data = JSON.parse(response.body)
@@ -93,6 +126,27 @@ module AruxApp
         end
       end
 
+      def client_credentials_token
+        data = {
+          scope: "public",
+          grant_type: "client_credentials",
+          client_id: client_id,
+          client_secret: client_secret
+        }
+
+        request = HTTPI::Request.new
+        request.url = "#{self.class.server_uri}/oauth/token"
+        request.body = data
+        request.headers = {'User-Agent' => USER_AGENT}
+
+        response = HTTPI.post(request)
+        if !response.error?
+          AccessToken.new(:token => JSON.parse(response.body)['access_token'], auth: self)
+        else
+          raise(API::Error.new(response.code, response.body))
+        end
+      end
+
       def javascript
         options = {
           district: self.district_subdomain,

data/lib/arux_app/api/bank_info.rb

@@ -6,14 +6,14 @@ module AruxApp
       end
 
       def get(routing_number)
-        routing_number = URI.escape(routing_number.to_s)
+        routing_number = AruxApp::API.uri_escape(routing_number.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{self.class.server_uri}/#{routing_number}"
         request.headers = {'User-Agent' => USER_AGENT}
 
         response = HTTPI.get(request)
-        
+
         if !response.error?
           JSON.parse(response.body)
         else

data/lib/arux_app/api/cart.rb

@@ -23,7 +23,7 @@ module AruxApp
 
       def get(uuid = nil)
         if uuid
-          path = %(/api/#{URI.escape(uuid)})
+          path = %(/api/#{AruxApp::API.uri_escape(uuid)})
         else
           path = %(/api/#{self.generate_cart_path})
         end
@@ -110,7 +110,7 @@ module AruxApp
       end
 
       def update_item(item_identifier, params)
-        path = %(/api/#{self.generate_cart_path}/items/#{URI.escape(item_identifier)})
+        path = %(/api/#{self.generate_cart_path}/items/#{AruxApp::API.uri_escape(item_identifier)})
 
         request = HTTPI::Request.new
         request.url = "#{self.class.server_uri}#{path}"
@@ -130,7 +130,7 @@ module AruxApp
       end
 
       def delete_item(item_identifier)
-        path = %(/api/#{self.generate_cart_path}/items/#{URI.escape(item_identifier)})
+        path = %(/api/#{self.generate_cart_path}/items/#{AruxApp::API.uri_escape(item_identifier)})
 
         request = HTTPI::Request.new
         request.url = "#{self.class.server_uri}#{path}"
@@ -179,7 +179,7 @@ module AruxApp
       protected
 
       def generate_cart_path
-        %(#{URI.escape(self.auth.district_subdomain)}/#{URI.escape(self.access_token.token)})
+        %(#{AruxApp::API.uri_escape(self.auth.district_subdomain)}/#{AruxApp::API.uri_escape(self.access_token.token)})
       end
 
       def generate_headers

data/lib/arux_app/api/config.rb

@@ -21,7 +21,7 @@ module AruxApp
       end
 
       def get(subdomain_or_sn)
-        subdomain_or_sn = URI.escape(subdomain_or_sn.to_s)
+        subdomain_or_sn = AruxApp::API.uri_escape(subdomain_or_sn.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{self.class.server_uri}/v1/customers/#{subdomain_or_sn}"
@@ -37,8 +37,8 @@ module AruxApp
       end
 
       def get_by(key, value)
-        key = URI.escape(key.to_s)
-        value = URI.escape(value.to_s)
+        key = AruxApp::API.uri_escape(key.to_s)
+        value = AruxApp::API.uri_escape(value.to_s)
 
         request = HTTPI::Request.new
         request.url = "#{self.class.server_uri}/v1/customers/by/#{key}/#{value}"

data/lib/arux_app/api/student.rb

@@ -7,7 +7,7 @@ module AruxApp
         # firstname & lastname & birthdate
         # state_student_id
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}/api/v1/students/lookup/district_student_id/#{URI.escape(self.auth.district_subdomain)}"
+        request.url = "#{self.class.server_uri}/api/v1/students/lookup/district_student_id/#{AruxApp::API.uri_escape(self.auth.district_subdomain)}"
         request.query = params
         request.headers = self.generate_headers
 
@@ -25,7 +25,7 @@ module AruxApp
         # firstname & lastname & birthdate
         # district_student_id
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}/api/v1/students/lookup/state_student_id/#{URI.escape(self.auth.district_subdomain)}"
+        request.url = "#{self.class.server_uri}/api/v1/students/lookup/state_student_id/#{AruxApp::API.uri_escape(self.auth.district_subdomain)}"
         request.query = params
         request.headers = self.generate_headers
 

data/lib/arux_app/api.rb

@@ -6,17 +6,42 @@ module AruxApp
         define_method("#{m}mode?") do
           @@mode == m
         end
-        
+
         define_method("#{m}mode") do
           @@mode == m
         end
-        
+
         define_method("#{m}mode=") do |b|
           @@mode = b ? m : :standard
         end
       end
+
+      def server_uri
+        if AruxApp::API.standardmode?
+          "https://account.arux.app"
+        elsif AruxApp::API.testmode?
+          "https://account.arux.blue"
+        elsif AruxApp::API.devmode?
+          "https://account.#{HOSTNAME}"
+        end
+      end
+
+      def uri_escape(str)
+        # URI.escape was deprecated and removed in ruby
+        # https://bugs.ruby-lang.org/issues/17309
+        # The alternatives suggested were using URI::DEFAULT_PARSER
+        # and CGI. This will use URI::DEFAULT_PARSER if it is defined and CGI
+        # if not.
+        if URI.respond_to?(:escape)
+          URI.escape(str)
+        elsif defined? URI::DEFAULT_PARSER
+          URI::DEFAULT_PARSER.escape(str)
+        else
+          CGI.escape(str)
+        end
+      end
     end
-    
+
     class Error < StandardError
       attr_accessor :http_status_code
       def initialize(code, message)
@@ -25,22 +50,22 @@ module AruxApp
           self.json = JSON.parse(message)
         rescue
         end
-        
+
         super "(#{code}) #{message}"
       end
     end
-    
+
     class InitializerError < StandardError
-      def initialize(method, message)        
+      def initialize(method, message)
         super "#{method} #{message}"
       end
     end
 
     class RequirementError < StandardError
-      def initialize(method, message)        
+      def initialize(method, message)
         super "#{method} #{message}"
       end
     end
 
   end
-end
+end

data/lib/arux_app.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "httpi"
-require "json"
+require 'rubygems'
+require 'httpi'
+require 'json'
 
 require "arux_app/api"
 
@@ -13,7 +13,7 @@ require "arux_app/api/student"
 require "arux_app/api/cart"
 
 module AruxApp
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
   USER_AGENT = "Arux.app GEM #{VERSION}"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arux_app
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Arux Software
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -80,7 +80,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- arux_app.gemspec
+- arux.app.gemspec
 - lib/arux_app.rb
 - lib/arux_app/api.rb
 - lib/arux_app/api/account.rb