clonk 1.0.0alpha → 1.0.0alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae127e233c70507fde9f7a04c8aec698c74c3ad9d19712d80de703710e2af11
-  data.tar.gz: 5a864090ca4dfbeeb171d7a1efd88aa1db1312ccb2d4cbadeae764b3b512dc9a
+  metadata.gz: c0c722bf99f97acd973f4cf92eeaa6823b92abc6cdd99cf77f7e32cac22915e7
+  data.tar.gz: d0af13e57c50e1baca63d908dfee9d3c1a5dbec49b890899fdb7451262b3af36
 SHA512:
-  metadata.gz: eb6a3a1e48a07ed3207a4ac25b5a74d66b1b9249c2feb80c1c5a744b3910474a052c0597620137e6641be365cc0dceecaabb9c27efce3e37cfa72506146ce9f6
-  data.tar.gz: 570835b981709c60280f8014d4d34ff486366a46c43c494d7b10b4e437e186fedb98047d24dca9db8134ef7eecc8881b8daa4948d0fac0a26553fc4f1efad815
+  metadata.gz: 392a00ab4d0805bc945b4f0cc45901bc98f51dbf79e2a068812e711e106943496dddba917b7cc13b5f1f4ce211926c36969515c47e51deb2107a02ac28e48adb
+  data.tar.gz: edea7bd7824a35e0e7161a543cff8fb773288c7513c6152b2379c3ee2b17e1bdef181149d1007073b48ae9f131473e37488f7ac1ead6a9d8f8a75c7e1caab63b

data/lib/clonk.rb

@@ -13,6 +13,10 @@ REALM = ENV.fetch('SSO_REALM')
 
 module Clonk
   class << self
+
+    ##
+    # Defines a Faraday::Connection object linked to the SSO instance.
+
     def connection(token: nil, raise_error: true, json: true)
       Faraday.new(url: BASE_URL) do |faraday|
         faraday.request(json ? :json : :url_encoded)
@@ -22,10 +26,16 @@ module Clonk
       end
     end
 
+    ##
+    # Returns the admin API root for the realm.
+
     def realm_admin_root(realm = REALM)
       "#{BASE_URL}/auth/admin/realms/#{realm}"
     end
 
+    ##
+    # Retrieves a token for the admin user.
+
     def admin_token
       data = {
         username: USERNAME,
@@ -40,12 +50,28 @@ module Clonk
       )['access_token']
     end
 
+    ##
+    # Returns a Faraday::Response for an API call via the given method.
+    # Always uses an admin token.
+    #--
+    # FIXME: Rename protocol to method - more descriptive
+    #++
+
     def response(protocol: :get, path: '/', data: nil, token: admin_token)
       return unless %i[get post put delete].include?(protocol)
 
       conn = connection(token: token).public_send(protocol, path, data)
     end
 
+    ##
+    # Returns a parsed JSON response for an API call via the given method.
+    # Useful in instances where only the data is necessary, and not
+    # HTTP status confirmation that the desired effect was caused.
+    # Always uses an admin token.
+    #--
+    # FIXME: Rename protocol to method - more descriptive
+    #++
+
     def parsed_response(protocol: :get, path: '/', data: nil, token: admin_token)
       resp = response(protocol: protocol, path: path, data: data, token: token)
 
@@ -54,6 +80,12 @@ module Clonk
       resp.body
     end
 
+    ##
+    # Enables permissions for the given object.
+    #--
+    # TODO: Add this method to other models that need it, if any
+    #++
+
     def set_permissions(object: nil, type: nil, enabled: true, realm: REALM)
       parsed_response(
         protocol: :put,
@@ -63,6 +95,11 @@ module Clonk
       )
     end
 
+    ##
+    # Returns the data for the permission with the given ID.
+    #--
+    # TODO: Move this method into Permission
+    #++
 
     def get_permission(id: nil, realm: REALM)
       parsed_response(
@@ -70,10 +107,6 @@ module Clonk
         path: "#{client_url(client: @realm_management, realm: realm)}/authz/resource-server/permission/scope/#{id}"
       )
     end
-
-    # getPermissionScopes???
-    # getPermissionResources???
-
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clonk
 version: !ruby/object:Gem::Version
-  version: 1.0.0alpha
+  version: 1.0.0alpha3
 platform: ruby
 authors:
 - Simon Fish
@@ -48,7 +48,8 @@ files:
 - lib/clonk.rb
 homepage: 
 licenses: []
-metadata: {}
+metadata:
+  yard.run: yardoc
 post_install_message: 
 rdoc_options: []
 require_paths: