ps_utilities 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b53435e5d2f6da0cd21f54f5780806986b87e7ff36b963702e4cd1009862e7d
-  data.tar.gz: 0f3133a755d4f2f67e8bde12bbb3769969afe60015f609b672166582b06d2898
+  metadata.gz: 637da17d1d419b00baea629e618529517c09fa7e16f71dd358a850b0978fc599
+  data.tar.gz: a1ec6ced4f33ac5ff849dd48c0f216133e7fe291b1224c8dc082d42c16a66876
 SHA512:
-  metadata.gz: 0b39f2d31153c8fc135d6fc39a415c55f8a347f4c97f0de18b91bec030f99d182e9baa655de000a29996d01997b2e44023f6d55d4f0b02e6187f254fd3f555b3
-  data.tar.gz: 87407650b7062b75f4ae4158bd48103a2acc302472923ad4d0456fbb900dc4a07191588df67621f028bcdf6e8d18aadf908dcfe8c666467335ecb872f68a6ea1
+  metadata.gz: 062a02dd9e855ad0533da5eb6c735021a0607ea6a4db59d33f063b223d0c3918e99071760bb456b9316f81b58e5daf1e06b977c92fbe02b0aa035a81d2841244
+  data.tar.gz: cca916c4339884397ebf5cc40fd6dcd1f8f0ff6d6a17b3cafdf61f30fccf0584ecab4f6bec7b58c7dc3d476b6168810155780dd3a61832861f9958519f2b3690

data/lib/ps_utilities/connection.rb

@@ -24,7 +24,7 @@ module PsUtilities
   # @note You should use environment variables to initialize your server.
   class Connection
 
-    attr_reader :credentials, :headers
+    attr_reader :credentials, :headers, :base_uri, :auth_path, :version
 
     include PsUtilities::PreBuiltGet
     include PsUtilities::PreBuiltPut
@@ -33,6 +33,9 @@ module PsUtilities
     def initialize(attributes: {}, headers: {})
       @credentials = attr_defaults.merge(attributes)
       @headers     = header_defaults.merge(headers)
+      @base_uri    = credentials[:base_uri]
+      @auth_path   = credentials[:auth_endpoint]
+      @version     = "v#{PsUtilities::Version::VERSION}"
 
       raise ArgumentError, "missing client_secret" if credentials[:client_secret].nil?  or
                                                       credentials[:client_secret].empty?
@@ -43,13 +46,13 @@ module PsUtilities
     end
 
     # with no command it just authenticates
-    def run(command: nil, params: {}, url: nil, options: {})
+    def run(command: nil, params: {}, api_path: "", options: {})
       authenticate   unless token_valid?
       case command
       when nil, :authenticate
         # authenticate            unless token_valid?
       when :get, :put, :post
-        send(command, url, options) unless url.empty?
+        send(command, api_path, options) unless api_path.empty?
       else
         send(command, params)
       end
@@ -58,17 +61,17 @@ module PsUtilities
     private
 
     # options = {query: {}}
-    def get(url, options={})
-      max_retries = 3
-      times_retried = 0
+    def get(api_path, options={})
+      count   = 0
+      retries = 3
+      ps_url  = base_uri + api_path
       options = options.merge(headers)
-      ps_url = credentials[:base_uri] + url
       begin
         HTTParty.get(ps_url, options)
         # self.class.get(url, query: options[:query], headers: options[:headers])
       rescue Net::ReadTimeout, Net::OpenTimeout
-        if times_retried < max_retries
-          times_retried += 1
+        if count < retries
+          count += 1
           retry
         else
           { error: "no response (timeout) from URL: #{url}"  }
@@ -77,17 +80,17 @@ module PsUtilities
     end
 
     # options = {body: {}}
-    def put(url, options={})
-      max_retries = 3
-      times_retried = 0
+    def put(api_path, options={})
+      count   = 0
+      retries = 3
+      ps_url  = base_uri + api_path
       options = options.merge(headers)
-      ps_url = credentials[:base_uri] + url
       begin
-        HTTParty.put(ps_url, options )
-        # self.class.get(url, body: options[:body], headers: options[:headers])
+        HTTParty.get(ps_url, options)
+        # self.class.get(url, query: options[:query], headers: options[:headers])
       rescue Net::ReadTimeout, Net::OpenTimeout
-        if times_retried < max_retries
-          times_retried += 1
+        if count < retries
+          count += 1
           retry
         else
           { error: "no response (timeout) from URL: #{url}"  }
@@ -96,17 +99,17 @@ module PsUtilities
     end
 
     # options = {body: {}}
-    def post(url, options={})
-      max_retries = 3
-      times_retried = 0
+    def post(api_path, options={})
+      count   = 0
+      retries = 3
+      ps_url  = base_uri + api_path
       options = options.merge(headers)
-      ps_url = credentials[:base_uri] + url
       begin
-        HTTParty.post(ps_url, options )
-        # self.class.get(url, body: options[:body], headers: options[:headers])
+        HTTParty.get(ps_url, options)
+        # self.class.get(url, query: options[:query], headers: options[:headers])
       rescue Net::ReadTimeout, Net::OpenTimeout
-        if times_retried < max_retries
-          times_retried += 1
+        if count < retries
+          count += 1
           retry
         else
           { error: "no response (timeout) from URL: #{url}"  }
@@ -117,7 +120,8 @@ module PsUtilities
     # In PowerSchool go to System>System Settings>Plugin Management Configuration>your plugin>Data Provider Configuration to manually check plugin expiration date
     def authenticate
       @headers[:headers] ||= {}
-      ps_url = credentials[:base_uri] + credentials[:auth_endpoint]
+      ps_url   = base_uri + auth_path
+      # ps_url = credentials[:base_uri] + credentials[:auth_endpoint]
       response = HTTParty.post(ps_url, {headers: auth_headers,
                                         body: 'grant_type=client_credentials'})
 
@@ -139,16 +143,16 @@ module PsUtilities
       return true
     end
 
-    def auth_headers
+    def auth_headers(creds64 = encode_credentials)
       { 'ContentType' => 'application/x-www-form-urlencoded;charset=UTF-8',
         'Accept' => 'application/json',
-        'Authorization' => 'Basic ' + encode_credentials
+        'Authorization' => 'Basic ' + creds64
       }
     end
 
-    def encode_credentials
-      ps_auth_text = [ credentials[:client_id],
-                       credentials[:client_secret]
+    def encode_credentials(creds = credentials)
+      ps_auth_text = [ creds[:client_id],
+                       creds[:client_secret]
                      ].join(':')
       Base64.encode64(ps_auth_text).gsub(/\n/, '')
     end

data/lib/ps_utilities/version.rb

@@ -1,5 +1,5 @@
 module PsUtilities
   module Version
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ps_utilities
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lee Weisbecker