arux_app 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e67102cdef4d9e36a67d02867cf51bcce88d71135e629b08a3a8aa10e45700b
-  data.tar.gz: 591f4ab4d415cf18ef2354bdc36e957e819c6acc276f2d7d52956b539b315695
+  metadata.gz: 5bf41c439a9083aa3207a8c937735b80a714a4b9d5173f39599fd43f9030ccaf
+  data.tar.gz: 57783b60dc6033a82aca59bd85ebfe0a90b1c9b2a87db090ff4439843b11ebf6
 SHA512:
-  metadata.gz: b8cf881c14802a6056d42e11cce44b6090bbb8b47f335c0a56fa6499425bad61f8441d174c0f47a4a4e2a565ef71dd363bc292455cb13c3587a8416e9d11f265
-  data.tar.gz: 770187f083bb7bcf481c61ce89af477bdde85bf7720adba6e87820a3e6c52dec52ddb600b03d4c519ff3785a370e7d4bb780d2029b40b79542bd381fb3ccf877
+  metadata.gz: a2b78de0e3f129364fe0efc2231eb52a632e7481fd4f17ecc13d3bd07528df6dcafdaa59a59acc756f0537ef58146b0b98c69be8b9f84ef81af40f48d557b2d9
+  data.tar.gz: 32bcb01ccb1dfca6e395021ecfa6f8f1ac050c8d8b21a37c06a634d1ba35bda2fc0a6ab6d43160d32798f208a51bacaeb3f89067632ca87bd519f38ab9be05ef

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        = "2.0.0"
+  spec.version        = "3.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

@@ -1,10 +1,6 @@
 module AruxApp
   module API
     class Account
-      def self.server_uri
-        AruxApp::API.server_uri
-      end
-
       attr_accessor :auth, :access_token, :api_version
 
       def initialize(options = {})
@@ -17,6 +13,22 @@ module AruxApp
         raise API::InitializerError.new(:access_token, "must be of class type AruxApp::API::Auth::AccessToken") if self.access_token and !self.access_token.is_a?(AruxApp::API::Auth::AccessToken)
       end
 
+      def self.public_uri
+        AruxApp::API.uri(subdomain: "account")
+      end
+
+      def public_uri
+        self.class.public_uri
+      end
+
+      def self.api_uri
+        AruxApp::API.uri(subdomain: "account.api")
+      end
+
+      def api_uri
+        self.class.api_uri
+      end
+
       def list(params = {})
         request = HTTPI::Request.new
         request.url = "#{api_route}/users"
@@ -135,62 +147,6 @@ module AruxApp
         end
       end
 
-      def list_user_locks(user_uuid)
-        uuid = AruxApp::API.uri_escape(user_uuid.to_s)
-
-        request = HTTPI::Request.new
-        request.url = "#{api_route}/users/#{user_uuid}/locks"
-        request.headers = self.generate_headers
-
-        response = HTTPI.get(request)
-
-        if !response.error?
-          JSON.parse(response.body)
-        else
-          raise(API::Error.new(response.code, response.body))
-        end
-      end
-
-      def add_user_lock(user_uuid, scope, reason = "")
-        uuid = AruxApp::API.uri_escape(user_uuid.to_s)
-
-        request = HTTPI::Request.new
-        request.url = "#{api_route}/users/#{uuid}/locks"
-        request.body = {
-          user_lock: {
-            scope: scope,
-            reason: reason
-          }
-        }.to_json
-        request.headers = self.generate_headers
-
-        response = HTTPI.post(request)
-
-        if response.code == 201
-          true
-        elsif !response.error?
-          JSON.parse(response.body)
-        else
-          raise(API::Error.new(response.code, response.body))
-        end
-      end
-
-      def delete_user_lock(user_uuid, lock_id)
-        uuid = AruxApp::API.uri_escape(user_uuid.to_s)
-
-        request = HTTPI::Request.new
-        request.url = "#{api_route}/users/#{uuid}/locks/#{lock_id}"
-        request.headers = self.generate_headers
-
-        response = HTTPI.delete(request)
-
-        if !response.error?
-          JSON.parse(response.body)
-        else
-          raise(API::Error.new(response.code, response.body))
-        end
-      end
-
       # TODO:: create mapping for relationships api endpoints
       def list_relationships
       end
@@ -207,7 +163,7 @@ module AruxApp
       protected
 
       def api_route
-        "#{self.class.server_uri}/api/v#{api_version}"
+        "#{api_uri}/api/v#{api_version}"
       end
 
       def generate_headers

data/lib/arux_app/api/auth.rb

@@ -26,10 +26,6 @@ module AruxApp
         end
       end
 
-      def self.server_uri
-        AruxApp::API.server_uri
-      end
-
       attr_accessor :client_id, :client_secret, :redirect_uri, :js_callback, :district_subdomain, :current_user_uuid, :login_mechanism, :element
 
       def initialize(options = {})
@@ -47,8 +43,24 @@ module AruxApp
         raise API::InitializerError.new(:redirect_uri, "can't be blank") if self.redirect_uri.to_s.empty?
       end
 
+      def self.public_uri
+        AruxApp::API.uri(subdomain: "account")
+      end
+
+      def public_uri
+        self.class.public_uri
+      end
+
+      def self.api_uri
+        AruxApp::API.uri(subdomain: "account.api")
+      end
+
+      def api_uri
+        self.class.api_uri
+      end
+
       def authorization_url(scope: "public")
-        base_uri = URI.parse("#{self.class.server_uri}/oauth/authorize")
+        base_uri = URI.parse("#{public_uri}/oauth/authorize")
         params = {
           scope: scope,
           response_type: "code",
@@ -69,7 +81,7 @@ module AruxApp
         }
 
         request = HTTPI::Request.new.tap do |req|
-          req.url = "#{self.class.server_uri}/oauth/token"
+          req.url = "#{public_uri}/oauth/token"
           req.body = params
           req.headers = { 'User-Agent' => USER_AGENT }
           req.auth.basic(username, password)
@@ -86,7 +98,7 @@ module AruxApp
       end
 
       def registration_url
-        %(#{self.class.server_uri}/users/registrations?client_id=#{self.client_id}&redirect_uri=#{self.redirect_uri}&district=#{self.district_subdomain})
+        %(#{public_uri}/users/registrations?client_id=#{self.client_id}&redirect_uri=#{self.redirect_uri}&district=#{self.district_subdomain})
       end
 
       def access_token(code)
@@ -99,7 +111,7 @@ module AruxApp
         }
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}/oauth/token"
+        request.url = "#{api_uri}/oauth/token"
         request.body = data
         request.headers = {'User-Agent' => USER_AGENT}
 
@@ -135,7 +147,7 @@ module AruxApp
         }
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}/oauth/token"
+        request.url = "#{api_uri}/oauth/token"
         request.body = data
         request.headers = {'User-Agent' => USER_AGENT}
 

data/lib/arux_app/api/bank_info.rb

@@ -1,15 +1,27 @@
 module AruxApp
   module API
     class BankInfo
-      def self.server_uri
-        "https://banks.api.arux.app"
+      def self.public_uri
+        AruxApp::API.uri(subdomain: "banks")
+      end
+
+      def public_uri
+        self.class.public_uri
+      end
+
+      def self.api_uri
+        AruxApp::API.uri(subdomain: "banks.api")
+      end
+
+      def api_uri
+        self.class.api_uri
       end
 
       def get(routing_number)
         routing_number = AruxApp::API.uri_escape(routing_number.to_s)
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}/#{routing_number}"
+        request.url = "#{api_uri}/#{routing_number}"
         request.headers = {'User-Agent' => USER_AGENT}
 
         response = HTTPI.get(request)

data/lib/arux_app/api/cart.rb

@@ -1,16 +1,6 @@
 module AruxApp
   module API
     class Cart
-      def self.server_uri
-        if AruxApp::API.standardmode?
-          "https://cart.arux.app"
-        elsif AruxApp::API.testmode?
-          "https://cart.arux.blue"
-        elsif AruxApp::API.devmode?
-          "https://cart.#{HOSTNAME}"
-        end
-      end
-
       attr_accessor :auth, :access_token
 
       def initialize(options = {})
@@ -21,6 +11,22 @@ module AruxApp
         raise API::InitializerError.new(:access_token, "must be of class type AruxApp::API::Auth::AccessToken") if !self.access_token.is_a?(AruxApp::API::Auth::AccessToken)
       end
 
+      def self.public_uri
+        AruxApp::API.uri(subdomain: "cart")
+      end
+
+      def public_uri
+        self.class.public_uri
+      end
+
+      def self.api_uri
+        AruxApp::API.uri(subdomain: "cart.api")
+      end
+
+      def api_uri
+        self.class.api_uri
+      end
+
       def get(uuid = nil)
         if uuid
           path = %(/api/#{AruxApp::API.uri_escape(uuid)})
@@ -29,7 +35,7 @@ module AruxApp
         end
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         request.headers = self.generate_headers
 
         response = HTTPI.get(request)
@@ -45,7 +51,7 @@ module AruxApp
         path = %(/api/#{self.generate_cart_path}/status)
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         request.headers = self.generate_headers
 
         response = HTTPI.get(request)
@@ -61,7 +67,7 @@ module AruxApp
         path = %(/api/#{self.generate_cart_path}/items)
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         request.headers = self.generate_headers
 
         response = HTTPI.get(request)
@@ -77,7 +83,7 @@ module AruxApp
         path = %(/api/#{self.generate_cart_path}/items/#{item_identifier})
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         request.headers = self.generate_headers
 
         response = HTTPI.get(request)
@@ -93,7 +99,7 @@ module AruxApp
         path = %(/api/#{self.generate_cart_path}/items)
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         if params.keys.first.to_s != 'item'
           params = {:item => params}
         end
@@ -113,7 +119,7 @@ module AruxApp
         path = %(/api/#{self.generate_cart_path}/items/#{AruxApp::API.uri_escape(item_identifier)})
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         if params.keys.first.to_s != 'item'
           params = {:item => params}
         end
@@ -133,7 +139,7 @@ module AruxApp
         path = %(/api/#{self.generate_cart_path}/items/#{AruxApp::API.uri_escape(item_identifier)})
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         request.headers = self.generate_headers
 
         response = HTTPI.delete(request)
@@ -148,7 +154,7 @@ module AruxApp
       def destroy(uuid)
         path = "/api/#{self.generate_cart_path}/carts/#{uuid}"
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         request.headers = self.generate_headers
 
         response = HTTPI.delete(request)
@@ -163,7 +169,7 @@ module AruxApp
       def create(params)
         path = "/api/#{self.generate_cart_path}/carts"
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}#{path}"
+        request.url = "#{api_uri}#{path}"
         request.headers = self.generate_headers
         request.body = params.to_json
 

data/lib/arux_app/api/checkout.rb

@@ -0,0 +1,38 @@
+module AruxApp
+  module API
+    class Checkout
+      API_VERSION = 1
+
+      def self.public_uri
+        AruxApp::API.uri(subdomain: "pay")
+      end
+
+      def public_uri
+        self.class.public_uri
+      end
+
+      def self.api_uri
+        AruxApp::API.uri(subdomain: "pay.api")
+      end
+
+      def api_uri
+        self.class.api_uri
+      end
+
+      def self.api_route
+        "#{api_uri}/api/v#{API_VERSION}/"
+      end
+
+      def self.iframe_url
+        case AruxApp::API.mode
+        when :production
+          "https://htp.tokenex.com/Iframe/Iframe-v3.min.js"
+        when :staging, :development, :test
+          "https://test-htp.tokenex.com/Iframe/Iframe-v3.min.js"
+        else
+          raise "AruxApp::API environment not supported"
+        end
+      end
+    end
+  end
+end

data/lib/arux_app/api/config.rb

@@ -1,16 +1,6 @@
 module AruxApp
   module API
     class Config
-      def self.server_uri
-        if AruxApp::API.standardmode?
-          "https://config.arux.app"
-        elsif AruxApp::API.testmode?
-          "https://config.arux.blue"
-        elsif AruxApp::API.devmode?
-          "http://config.#{HOSTNAME}"
-        end
-      end
-
       attr_accessor :auth
 
       def initialize(options = {})
@@ -20,11 +10,27 @@ module AruxApp
         raise API::InitializerError.new(:auth, "must be of class type AruxApp::API::Auth") if !self.auth.is_a?(AruxApp::API::Auth)
       end
 
+      def self.public_uri
+        AruxApp::API.uri(subdomain: "config")
+      end
+
+      def public_uri
+        self.class.public_uri
+      end
+
+      def self.api_uri
+        AruxApp::API.uri(subdomain: "config.api")
+      end
+
+      def api_uri
+        self.class.api_uri
+      end
+
       def get(subdomain_or_sn)
         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}"
+        request.url = "#{api_uri}/v1/customers/#{subdomain_or_sn}"
         request.headers = self.generate_headers
 
         response = HTTPI.get(request)
@@ -41,7 +47,7 @@ module AruxApp
         value = AruxApp::API.uri_escape(value.to_s)
 
         request = HTTPI::Request.new
-        request.url = "#{self.class.server_uri}/v1/customers/by/#{key}/#{value}"
+        request.url = "#{api_uri}/v1/customers/by/#{key}/#{value}"
         request.headers = self.generate_headers
 
         response = HTTPI.get(request)

data/lib/arux_app/api.rb

@@ -1,29 +1,27 @@
 module AruxApp
   module API
-    class << self
-      @@mode = :standard
-      [:test, :dev, :standard].each do |m|
-        define_method("#{m}mode?") do
-          @@mode == m
-        end
+    DOMAINS = {
+      production: "arux.app",
+      staging: "arux.blue",
+      development: HOSTNAME,
+      test: "arux.test"
+    }
 
-        define_method("#{m}mode") do
-          @@mode == m
-        end
+    class << self
+      def mode
+        raise "Environment is not set, i.e. ARUX_APP_GEM_MODE = :development" unless const_defined?(:ARUX_APP_GEM_MODE)
+        ARUX_APP_GEM_MODE
+      end
 
-        define_method("#{m}mode=") do |b|
-          @@mode = b ? m : :standard
-        end
+      def uri(subdomain:)
+        URI::HTTPS.build(
+          host: [subdomain, domain].join('.'),
+        )
       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
+      def domain
+        raise "#{mode} is not a supported environment" unless DOMAINS.has_key?(mode)
+        DOMAINS[mode]
       end
 
       def uri_escape(str)

data/lib/arux_app.rb

@@ -1,34 +1,23 @@
-require 'rubygems'
-require 'httpi'
-require 'json'
+HOSTNAME = if ENV.has_key?("DEV_HOST")
+             ENV.fetch("DEV_HOST")
+           elsif RUBY_PLATFORM =~ /darwin/
+             "#{`scutil --get LocalHostName`.downcase.strip}.local"
+           else
+             `hostname`.downcase.strip
+           end
 
+require "rubygems"
+require "httpi"
+require "json"
 require "arux_app/api"
-
+require "arux_app/api/checkout"
 require "arux_app/api/bank_info"
 require "arux_app/api/config"
 require "arux_app/api/auth"
-require "arux_app/api/nav"
 require "arux_app/api/account"
-require "arux_app/api/student"
 require "arux_app/api/cart"
 
 module AruxApp
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
   USER_AGENT = "Arux.app GEM #{VERSION}"
 end
-
-if ENV['ARUX_APP_GEM_TEST_MODE'].to_s == "true"
-  AruxApp::API.testmode = true
-end
-
-if ENV['ARUX_APP_GEM_DEV_MODE'].to_s == "true"
-  AruxApp::API.devmode = true
-end
-
-if ENV.has_key?("DEV_HOST")
-  HOSTNAME = ENV.fetch("DEV_HOST")
-elsif RUBY_PLATFORM =~ /darwin/
-  HOSTNAME = "#{`scutil --get LocalHostName`.downcase.strip}.local"
-else
-  HOSTNAME = `hostname`.downcase.strip
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arux_app
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Arux Software
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -80,16 +80,15 @@ 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
 - lib/arux_app/api/auth.rb
 - lib/arux_app/api/bank_info.rb
 - lib/arux_app/api/cart.rb
+- lib/arux_app/api/checkout.rb
 - lib/arux_app/api/config.rb
-- lib/arux_app/api/nav.rb
-- lib/arux_app/api/student.rb
 homepage: https://arux.software
 licenses:
 - MIT

data/lib/arux_app/api/nav.rb

@@ -1,29 +0,0 @@
-module AruxApp
-  module API
-    class Nav
-
-      attr_accessor :auth
-
-      def initialize(options = {})
-        self.auth = options[:auth]
-
-        raise API::InitializerError.new(:auth, "can't be blank") if self.auth.nil?
-        raise API::InitializerError.new(:auth, "must be of class type AruxApp::API::Auth") if !self.auth.is_a?(AruxApp::API::Auth)
-      end
-
-      def javascript
-        options = {
-          district: self.auth.district_subdomain,
-          login: {
-            current_uuid: self.auth.current_user_uuid,
-            client_id: self.auth.client_id,
-            redirect_uri: self.auth.redirect_uri,
-            callback: self.auth.js_callback
-          }
-        }
-        return %(new SwitchBoardIONav(#{options.to_json});)
-      end
-
-    end
-  end
-end

data/lib/arux_app/api/student.rb

@@ -1,43 +0,0 @@
-module AruxApp
-  module API
-    class Student < Account
-
-      def lookup_district_student_id(params)
-        # accepted lookup attributes
-        # firstname & lastname & birthdate
-        # state_student_id
-        request = HTTPI::Request.new
-        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
-
-        response = HTTPI.get(request)
-
-        if !response.error?
-          JSON.parse(response.body)
-        else
-          raise(API::Error.new(response.code, response.body))
-        end
-      end
-
-      def lookup_state_student_id(params)
-        # accepted lookup attributes
-        # firstname & lastname & birthdate
-        # district_student_id
-        request = HTTPI::Request.new
-        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
-
-        response = HTTPI.get(request)
-
-        if !response.error?
-          JSON.parse(response.body)
-        else
-          raise(API::Error.new(response.code, response.body))
-        end
-      end
-
-    end
-  end
-end