agilix 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13bbcf27a8daa395a4e36a627dc9deb051ca2eb6d59d8b7461e75d2f5e002001
-  data.tar.gz: 4868b13937a95a056514a5b084a6da3b3bdec86f0032de5af76f6e7d47984ff6
+  metadata.gz: 81a67f3ba0539b370407f94da49a5fbdea63c2ac45c5fffb3a69c4cb9208ca0e
+  data.tar.gz: 4d64c6cccca91106f9cbaa00bca53a1f84aefef256da03d2c14fc2f0fb3c2040
 SHA512:
-  metadata.gz: 28650a6f11ff0d3bb4aa4d0f4e4597679d889392cee1436c2827459d0fdfc6c30f707c7fb9797ea07db75873da0bd81bcb5a6b23042d2677c9b8d6641d18ca63
-  data.tar.gz: 6edb84ced7f75aad3c80be7018e866d1be80689e19fe5fcf8ba2dc61ca43a61899ffe29ed149b1bc55f50c57aab42be3c57a086a48f93675846f272ad6848545
+  metadata.gz: aca52f340f374f9c5a44fb8cefcc578079262046dc3c7ae9e770640a3cbec1ffd20c881bbe42d7a1c9a52f90779f3843239ccff27254e06ad699d73e6f3fc88e
+  data.tar.gz: 10ab8c6c4b7bc330d27191f9c425bdac78af13ff52da05d4a91bc21382cb9f4ada27b537933fc3a4b8643898aff884d38296181e0e03cfc3b0902dbd2a895eed

data/README.md

@@ -63,43 +63,53 @@ Below are instructions for basic invocation of the api methods. For additional i
 ```
 api.create_domains [{name: "BuzzTest1", userspace: 'buzz-test-fc-1', parentid: '57025'}]
 ```
+
 #### [DeleteDomain](https://api.agilixbuzz.com/docs/#!/Command/DeleteDomain)
 ```
 api.delete_domain domainid: '57027'
 ```
+
 #### [GetDomain2](https://api.agilixbuzz.com/docs/#!/Command/GetDomain2)
 This is aliased to `get_domain`
 ```
 api.get_domain domainid: '57025'
 ```
+
 #### [GetDomainContent](https://api.agilixbuzz.com/docs/#!/Command/GetDomainContent)
 ```
 api.get_domain_content domainid: '57025'
 ```
+
 #### [GetDomainEnrollmentMetrics](https://api.agilixbuzz.com/docs/#!/Command/GetDomainEnrollmentMetrics)
 ```
 api.get_domain_enrollment_metrics domainid: '57025'
 ```
+
 #### [GetDomainParentList](https://api.agilixbuzz.com/docs/#!/Command/GetDomainParentList)
 ```
 api.get_domain_parent_list domainid: '57025'
 ```
+
 #### [GetDomainSettings](https://api.agilixbuzz.com/docs/#!/Command/GetDomainSettings)
 ```
 api.get_domain_settings domainid: '57025', path: "AgilixBuzzSettings.xml"
 ```
+
 #### [GetDomainStats](https://api.agilixbuzz.com/docs/#!/Command/GetDomainStats)
 ```
 api.get_domain_stats domainid: '57025', options: "users|courses"
 ```
+
 #### [ListDomains](https://api.agilixbuzz.com/docs/#!/Command/ListDomains)
 ```
 api.list_domains domainid: '57025'
 ```
+
 #### [RestoreDomain](https://api.agilixbuzz.com/docs/#!/Command/RestoreDomain)
 ```
 api.restore_domain domainid: '57027'
 ```
+
 #### [UpdateDomains](https://api.agilixbuzz.com/docs/#!/Command/UpdateDomains)
 ```
 api.update_domains [{ domainid: "57027", name: "BuzzTestUpdated1", userspace: 'buzz-test-fc-1', parentid: '57025'}]
@@ -113,14 +123,17 @@ api.update_domains [{ domainid: "57027", name: "BuzzTestUpdated1", userspace: 'b
 ```
 api.get_report_info reportid: 127
 ```
+
 #### [GetReportList](https://api.agilixbuzz.com/docs/#!/Command/GetReportList)
 ```
 api.get_report_list domainid: 1
 ```
+
 #### [GetRunnableReportList](https://api.agilixbuzz.com/docs/#!/Command/GetRunnableReportList)
 ```
 api.get_runnable_report_list domainid: 57025
 ```
+
 #### [RunReport](https://api.agilixbuzz.com/docs/#!/Command/RunReport)
 ```
 api.run_report reportid: 127, entityid: 57025, format: 'json'
@@ -284,6 +297,7 @@ proxy_api.unproxy userid: 57181
 ```
 api.reset_lockout userid: 57181
 ```
+
 #### [ResetPassword](https://api.agilixbuzz.com/docs/#!/Command/ResetPassword)
 ```
 api.reset_password username:'auto-tests/BuzzUserUp1'
@@ -498,26 +512,172 @@ This is one of the more confusing APIs, it allows you to send emails to people i
 api.send_mail subject: "Test email", body: "Did you get this?", enrollmentid: 60997, enrollment_ids: ["all"]
 ```
 
+## Resources
+
+
+#### [CopyResources](https://api.agilixbuzz.com/docs/#!/Command/CopyResources)
+
+```
+api.copy_resources [ {sourceentityid: 57025, destinationentityid: 57031, sourcepath: "banner.css" }]
+```
+
+#### [DeleteResources](https://api.agilixbuzz.com/docs/#!/Command/DeleteResources)
+
+```
+api.delete_resources [{entityid: 57031, path: 'banner.css'}]
+```
+
+#### [GetEntityResourceId](https://api.agilixbuzz.com/docs/#!/Command/GetEntityResourceId)
+
+```
+api.get_entity_resource_id entityid: 57025
+```
+
+#### [GetResource](https://api.agilixbuzz.com/docs/#!/Command/GetResource)
+
+```
+api.get_resource entityid: 57031, path: "banner.css"
+```
+
+#### [GetResourceInfo2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceInfo2)
+
+ISSUE: This is a get request with a POST verb. The documentation only suggests getting a single resoure, so I'm not sure why it would be a bulk post syntax. it does seem to respond to multiple resources though,so we'll adapt
+
+```
+api.get_resource_info  [{entityid: 57031, path: "banner.css"}]
+```
+
+#### [GetResourceList2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceList2)
+
+```
+api.get_resource_list entityid: 57025
+```
+
+#### [ListRestorableResources](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableResources)
+
+```
+api.list_restorable_resources entityid: 57025
+```
+
+#### [PutResource](https://api.agilixbuzz.com/docs/#!/Command/PutResource)
+
+```
+file_name = "my-file.pdf"
+file = File.open file_name
+api.put_resource file, {entityid: 57025, path: file_name}
+```
+
+#### [PutResourceFolders](https://api.agilixbuzz.com/docs/#!/Command/PutResourceFolders)
+
+```
+api.put_resource_folders [{entityid: 57031, path: 'test/folder-1'}]
+```
+
+#### [RestoreResources](https://api.agilixbuzz.com/docs/#!/Command/RestoreResources)
+
+```
+api.restore_resources [{entityid: 57031, path: 'banner.css'}]
+```
+
+
 ## Rights
 
-- [ ] [CreateRole](https://api.agilixbuzz.com/docs/#!/Command/CreateRole)
-- [ ] [DeleteRole](https://api.agilixbuzz.com/docs/#!/Command/DeleteRole)
-- [ ] [DeleteSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/DeleteSubscriptions)
-- [ ] [GetActorRights](https://api.agilixbuzz.com/docs/#!/Command/GetActorRights)
-- [ ] [GetEffectiveRights](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveRights)
-- [ ] [GetEffectiveSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveSubscriptionList)
-- [ ] [GetEntityRights](https://api.agilixbuzz.com/docs/#!/Command/GetEntityRights)
-- [ ] [GetEntitySubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEntitySubscriptionList)
-- [ ] [GetPersonas](https://api.agilixbuzz.com/docs/#!/Command/GetPersonas)
-- [ ] [GetRights](https://api.agilixbuzz.com/docs/#!/Command/GetRights)
-- [ ] [GetRightsList](https://api.agilixbuzz.com/docs/#!/Command/GetRightsList)
-- [ ] [GetRole](https://api.agilixbuzz.com/docs/#!/Command/GetRole)
-- [ ] [GetSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetSubscriptionList)
-- [ ] [ListRoles](https://api.agilixbuzz.com/docs/#!/Command/ListRoles)
-- [ ] [RestoreRole](https://api.agilixbuzz.com/docs/#!/Command/RestoreRole)
-- [ ] [UpdateRights](https://api.agilixbuzz.com/docs/#!/Command/UpdateRights)
-- [ ] [UpdateRole](https://api.agilixbuzz.com/docs/#!/Command/UpdateRole)
-- [ ] [UpdateSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/UpdateSubscriptions)
+#### [CreateRole](https://api.agilixbuzz.com/docs/#!/Command/CreateRole)
+ISSUE: Why is this create singular, not multiple?
+```
+api.create_role domainid: 57025, name: "Test Role", privileges: api.right_flags[:create_domain]
+```
+
+#### [DeleteRole](https://api.agilixbuzz.com/docs/#!/Command/DeleteRole)
+```
+api.delete_role roleid: 61316
+```
+
+#### [DeleteSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/DeleteSubscriptions)
+ISSUE: Why is this create singular, not multiple?
+```
+api.delete_subscriptions subscriberid: 57181, entityid: 57025
+```
+
+#### [GetActorRights](https://api.agilixbuzz.com/docs/#!/Command/GetActorRights)
+ISSUE: Why is this create singular, not multiple?
+```
+api.create_role domainid: 57025, name: "Test Role", privileges: api.right_flags[:create_domain]
+```
+
+#### [GetEffectiveRights](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveRights)
+```
+api.get_effective_rights entityid: 57025
+```
+
+#### [GetEffectiveSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveSubscriptionList)
+```
+api.get_effective_subscription_list
+```
+
+#### [GetEntityRights](https://api.agilixbuzz.com/docs/#!/Command/GetEntityRights)
+```
+api.get_entity_rights entityid: 57025
+```
+
+#### [GetEntitySubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEntitySubscriptionList)
+```
+api.get_entity_subscription_list entityid: 57025
+```
+
+#### [GetPersonas](https://api.agilixbuzz.com/docs/#!/Command/GetPersonas)
+```
+api.get_personas userid: 57026
+```
+
+#### [GetRights](https://api.agilixbuzz.com/docs/#!/Command/GetRights)
+```
+api.get_rights actorid: 57026, entityid: 57025
+```
+
+#### [GetRightsList](https://api.agilixbuzz.com/docs/#!/Command/GetRightsList)
+```
+api.get_rights_list domainid: 57025
+```
+
+#### [GetRole](https://api.agilixbuzz.com/docs/#!/Command/GetRole)
+```
+api.get_role roleid: 61316
+```
+
+#### [GetSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetSubscriptionList)
+```
+# Get for a domain
+api.get_subscription_list subscriberid: 57025
+# Get for a user
+api.get_subscription_list subscriberid: 57026
+```
+
+#### [ListRoles](https://api.agilixbuzz.com/docs/#!/Command/ListRoles)
+```
+api.list_roles domainid: 57025
+```
+
+#### [RestoreRole](https://api.agilixbuzz.com/docs/#!/Command/RestoreRole)
+```
+api.restore_role roleid: 61316
+```
+
+#### [UpdateRights](https://api.agilixbuzz.com/docs/#!/Command/UpdateRights)
+```
+api.update_rights [ {actorid: 57026, entityid: 57025, roleid: 61316}]
+```
+
+#### [UpdateRole](https://api.agilixbuzz.com/docs/#!/Command/UpdateRole)
+```
+api.update_role roleid: 61316, name: "Test Role Updates", privileges: api.right_flags[:update_domain]
+```
+
+#### [UpdateSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/UpdateSubscriptions)
+ISSUE: Why is this root node singular?
+```
+api.update_subscriptions subscriberid: 57181, entityid: 60982, startdate: "2019-03-15", enddate: "2019-03-15"
+```
 
 ---
 
@@ -575,22 +735,11 @@ api.send_mail subject: "Test email", body: "Did you get this?", enrollmentid: 60
 
 ## Resources
 
-- [ ] [CopyResources](https://api.agilixbuzz.com/docs/#!/Command/CopyResources)
 - [ ] [DeleteDocuments](https://api.agilixbuzz.com/docs/#!/Command/DeleteDocuments)
-- [ ] [DeleteResources](https://api.agilixbuzz.com/docs/#!/Command/DeleteResources)
 - [ ] [GetDocument](https://api.agilixbuzz.com/docs/#!/Command/GetDocument)
 - [ ] [GetDocumentInfo](https://api.agilixbuzz.com/docs/#!/Command/GetDocumentInfo)
-- [ ] [GetEntityResourceId](https://api.agilixbuzz.com/docs/#!/Command/GetEntityResourceId)
-- [ ] [GetResource](https://api.agilixbuzz.com/docs/#!/Command/GetResource)
-- [ ] [GetResourceInfo2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceInfo2)
-- [ ] [GetResourceList2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceList2)
 - [ ] [ListRestorableDocuments](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableDocuments)
-- [ ] [ListRestorableResources](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableResources)
-- [ ] [PutResource](https://api.agilixbuzz.com/docs/#!/Command/PutResource)
-- [ ] [PutResourceFolders](https://api.agilixbuzz.com/docs/#!/Command/PutResourceFolders)
 - [ ] [RestoreDocuments](https://api.agilixbuzz.com/docs/#!/Command/RestoreDocuments)
-- [ ] [RestoreResources](https://api.agilixbuzz.com/docs/#!/Command/RestoreResources)
-
 ---
 
 # Not Prioritized
@@ -804,6 +953,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Agilix::Buzz project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/agilix/blob/master/CODE_OF_CONDUCT.md).
-
-
-

data/lib/agilix.rb

@@ -9,6 +9,8 @@ require "agilix/buzz/commands/domain"
 require "agilix/buzz/commands/enrollment"
 require "agilix/buzz/commands/general"
 require "agilix/buzz/commands/report"
+require "agilix/buzz/commands/resource"
+require "agilix/buzz/commands/right"
 require "agilix/buzz/commands/user"
 
 require "agilix/buzz/api"
@@ -23,6 +25,6 @@ module Agilix
         super
       end
     end
-    # Your code goes here...
+
   end
 end

data/lib/agilix/buzz/api.rb

@@ -11,6 +11,8 @@ module Agilix
       include Agilix::Buzz::Commands::Enrollment
       include Agilix::Buzz::Commands::General
       include Agilix::Buzz::Commands::Report
+      include Agilix::Buzz::Commands::Resource
+      include Agilix::Buzz::Commands::Right
       include Agilix::Buzz::Commands::User
 
       attr_accessor :username, :password, :domain, :token, :token_expiration
@@ -51,14 +53,38 @@ module Agilix
         response = self.class.post(URL_BASE, body: modify_body(query), timeout: 60, headers: headers)
       end
 
-      # For when the api is super unconventional & you need to modify both query params & body params in a custom fashion
+      # Not sure if I want to use this yet
+      # api.response_parser response: response, path_to_parse: ['response', 'users', 'user'], collection_name: 'users'
+      def response_parser(path_to_parse: nil, collection_name: nil, response: )
+        if path_to_parse
+          result = response.dig(*path_to_parse)
+          ostruct = JSON::parse({collection_name => result}.to_json, object_class: OpenStruct)
+          ostruct.result_count = result.size
+          ostruct.collection_name = collection_name
+        else
+          ostruct = JSON::parse(response.body, object_class: OpenStruct)
+        end
+        ostruct.code = response['code']
+        ostruct.response = response
+        ostruct.request = request
+        ostruct
+      end
+
+      # For when the api is super unconventional & you need to modify both query params & body params in a custom fashion, and upload a file even!
       def query_post(query = {})
         url = URL_BASE
         query_params = query.delete(:query_params)
         if query_params
           url += "?&_token=#{token}" + query_params.map {|k,v| "&#{k}=#{v}" }.join("")
         end
-        response = self.class.post(url, body: query.to_json, timeout: 60, headers: headers)
+        file = query.delete(:file)
+        if file
+          new_headers = headers
+          new_headers["Content-Type"] = "multipart/form-data"
+          response = self.class.post(url, multipart: true, body: {file: file}, timeout: 60, headers: new_headers)
+        else
+          response = self.class.post(url, body: query.to_json, timeout: 60, headers: headers)
+        end
       end
 
       def bulk_post(query = {})
@@ -118,7 +144,7 @@ module Agilix
       end
 
       def headers
-        {
+        @headers = {
           "Accept" => "application/json",
           "Content-Type" => "application/json",
         }

data/lib/agilix/buzz/commands/authentication.rb

@@ -23,7 +23,7 @@ module Agilix
         def extend_session
           response = authenticated_post cmd: "extendsession", bypass_authentication_check: true
           @token_expiration = set_token_expiration(response.dig("response", "session", "authenticationexpirationminutes"))
-          authenticate! if response['code'] == 'NoAuthentication'
+          authenticate! if response.dig("response", "code") == "NoAuthentication"
           response
         end
 

data/lib/agilix/buzz/commands/resource.rb

@@ -0,0 +1,124 @@
+  module Agilix
+  module Buzz
+    module Commands
+      module Resource
+
+        # api.copy_resources [ {sourceentityid: 57025, destinationentityid: 57031, sourcepath: "banner.css" }]
+        def copy_resources(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( sourceentityid destinationentityid ), optional_params: %i( sourcepath destinationpath ), options: item )
+          end
+          authenticated_bulk_post cmd: "copyresources", root_node: "resource", body: options
+        end
+
+        # api.delete_resources [{entityid: 57031, path: 'banner.css'}]
+        def delete_resources(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( entityid path ), optional_params: %i( class ), options: item )
+          end
+          authenticated_bulk_post cmd: "deleteresources", root_node: "resource", body: options
+        end
+
+        # api.get_entity_resource_id entityid: 57025
+        def get_entity_resource_id(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "getentityresourceid", **options
+        end
+
+        # api.get_resource entityid: 57031, path: "banner.css"
+        def get_resource(options = {})
+          options = argument_cleaner(required_params: %i( entityid path ), optional_params: %i( version packagetype attachment class ), options: options )
+          authenticated_get cmd: "getresource", **options
+        end
+
+        # ISSUE: This is a get request with a POST verb. The documentation only suggests getting a single resoure, so I'm not sure why it would be a bulk post syntax. it does seem to respond to multiple resources though,so we'll adapt
+        # api.get_resource_info  [{entityid: 57031, path: "banner.css"}]
+        def get_resource_info2(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( entityid path ), optional_params: %i( class ), options: item )
+          end
+          authenticated_bulk_post cmd: "getresourceinfo2", root_node: "resource", body: options
+        end
+        alias_method :get_resource_info, :get_resource_info2
+
+        # api.get_resource_list2 entityid: 57025
+        def get_resource_list2(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( path recurse query allversions entries class ), options: options )
+          authenticated_get cmd: "getresourcelist2", **options
+        end
+        alias_method :get_resource_list, :get_resource_list2
+
+        # api.list_restorable_resources entityid: 57025
+        def list_restorable_resources(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "listrestorableresources", **options
+        end
+
+        # file_name = "my-file.pdf"
+        # file = File.open file_name
+        # api.put_resource file, {entityid: 57025, path: file_name}
+        def put_resource(file, options = {})
+          options = argument_cleaner(required_params: %i( entityid path ), optional_params: %i( status class drophistory contenttype ), options: options )
+          # authenticated_query_post cmd: "putresource", **options
+          authenticated_query_post query_params: {cmd: "putresource", **options }, file: file
+        end
+
+        # api.put_resource_folders [{entityid: 57031, path: 'test/folder-1'}]
+        def put_resource_folders(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( entityid path ), optional_params: %i( ), options: item )
+          end
+          authenticated_bulk_post cmd: "putresourcefolders", root_node: "folder", body: options
+        end
+
+        # api.restore_resources [{entityid: 57031, path: 'banner.css'}]
+        def restore_resources(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( entityid path ), optional_params: %i( class ), options: item )
+          end
+          authenticated_bulk_post cmd: "restoreresources", root_node: "resource", body: options
+        end
+
+        # api.delete_documents
+        def delete_documents(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( enrollmentid itemid path ), optional_params: %i( ), options: item )
+          end
+          authenticated_bulk_post cmd: "deletedocuments", root_node: "document", body: options
+        end
+
+        # api.get_document enrollmentid: 60997
+        def get_document(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid itemid path ), optional_params: %i( version ), options: options )
+          authenticated_get cmd: "getdocument", **options
+        end
+
+        # ISSUE: Why is get command a bulk POST request
+        # api.get_document_info
+        def get_document_info(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( enrollmentid itemid path ), optional_params: %i( ), options: item )
+          end
+          authenticated_bulk_post cmd: "getdocumentinfo", root_node: "document", body: options
+          authenticated_get cmd: "", **options
+        end
+
+        # api.list_restorable_documents enrollmentid: 64001
+        def list_restorable_documents(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid itemid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "listrestorabledocuments", **options
+        end
+
+
+        # api.restore_documents
+        def restore_documents(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i(  enrollmentid itemid path), optional_params: %i( version ), options: item )
+          end
+          authenticated_bulk_post cmd: "restoredocuments", root_node: "document", body: options
+        end
+
+      end
+    end
+  end
+end

data/lib/agilix/buzz/commands/right.rb

@@ -0,0 +1,234 @@
+module Agilix
+  module Buzz
+    module Commands
+      module Right
+
+        # ISSUE: Why is this create singular, not multiple?
+        # api.create_role domainid: 57025, name: "Test Role", privileges: api.right_flags[:create_domain]
+        def create_role(options = {})
+          options = argument_cleaner(required_params: %i( domainid name privileges ), optional_params: %i( reference entitytype ), options: options )
+          raise ArgumentError.new("Not a valid entitytype. Should be D,C, or empty") unless [nil, "", "D", "C"].include?(options[:entitytype])
+          authenticated_post cmd: "createrole", **options
+        end
+
+        # api.delete_role roleid: 61316
+        def delete_role(options = {})
+          options = argument_cleaner(required_params: %i( roleid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "deleterole", **options
+        end
+
+        # api.delete_subscriptions subscriberid: 57181, entityid: 57025
+        def delete_subscriptions(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( subscriberid entityid ), optional_params: %i( flags ), options: item )
+          end
+          authenticated_bulk_post cmd: "deletesubscriptions", root_node: 'subscription', body: options
+        end
+
+        # api.get_actor_rights actorid: 5000, entitytypes: "U|S|D"
+        def get_actor_rights(options = {})
+          options = argument_cleaner(required_params: %i( actorid ), optional_params: %i( entitytypes ), options: options )
+          authenticated_get cmd: "getactorrights", **options
+        end
+
+        # api.get_effective_rights entityid: 57025
+        def get_effective_rights(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "geteffectiverights", **options
+        end
+
+        # api.get_effective_subscription_list
+        def get_effective_subscription_list(options = {})
+          options = argument_cleaner(required_params: %i( ), optional_params: %i( select ), options: options )
+          authenticated_get cmd: "geteffectivesubscriptionlist", **options
+        end
+
+        # api.get_entity_rights entityid: 57025
+        def get_entity_rights(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "getentityrights", **options
+        end
+
+        # api.get_entity_subscription_list entityid: 57025
+        def get_entity_subscription_list(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( subscriberid), options: options )
+          authenticated_get cmd: "getentitysubscriptionlist", **options
+        end
+
+        # api.get_personas userid: 57026
+        def get_personas(options = {})
+          options = argument_cleaner(required_params: %i( ), optional_params: %i( userid domainid ), options: options )
+          authenticated_get cmd: "getpersonas", **options
+        end
+
+        # api.get_rights actorid: 57026, entityid: 57025
+        def get_rights(options = {})
+          options = argument_cleaner(required_params: %i( actorid entityid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "getrights", **options
+        end
+
+        # api.get_rights_list domainid: 57025
+        def get_rights_list(options = {})
+          options = argument_cleaner(required_params: %i(  ), optional_params: %i( domainid restrictdomain ), options: options )
+          authenticated_get cmd: "getrightslist", **options
+        end
+
+        # api.get_role roleid: 61316
+        def get_role(options = {})
+          options = argument_cleaner(required_params: %i( roleid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "getrole", **options
+        end
+
+        # Get for a domain
+        # api.get_subscription_list subscriberid: 57025
+        # Get for a user
+        # api.get_subscription_list subscriberid: 57026
+        def get_subscription_list(options = {})
+          options = argument_cleaner(required_params: %i( subscriberid ), optional_params: %i( entityid ), options: options )
+          authenticated_get cmd: "getsubscriptionlist", **options
+        end
+
+        # api.list_roles domainid: 57025
+        def list_roles(options = {})
+          options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "listroles", **options
+        end
+
+        # api.restore_role roleid: 61316
+        def restore_role(options = {})
+          options = argument_cleaner(required_params: %i( roleid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "restorerole", **options
+        end
+
+        # api.update_rights [ {actorid: 57026, entityid: 57025, roleid: 61316}]
+        def update_rights(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( actorid entityid ), optional_params: %i( roleid flags schema ), options: item )
+          end
+          authenticated_bulk_post cmd: "updaterights", root_node: 'rights', body: options
+        end
+
+        # api.update_role roleid: 61316, name: "Test Role Updates", privileges: api.right_flags[:update_domain]
+        def update_role(options = {})
+          options = argument_cleaner(required_params: %i( roleid  ), optional_params: %i( name privileges reference entitytype ), options: options )
+          raise ArgumentError.new("Not a valid entitytype. Should be D,C, or empty") unless [nil, "", "D", "C"].include?(options[:entitytype])
+
+          authenticated_post cmd: "updaterole", **options
+        end
+
+        # ISSUE: Why is this root node singular?
+        # api.update_subscriptions subscriberid: 57181, entityid: 60982, startdate: "2019-03-15", enddate: "2019-03-15"
+        def update_subscriptions(items = [])
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( subscriberid entityid startdate enddate ), optional_params: %i( subscriptionflags ), options: item )
+          end
+          authenticated_bulk_post cmd: "updatesubscriptions", root_node: 'subscription', body: options
+        end
+
+        def right_flags
+          {
+            admin: -1,
+            none: 0,
+            participate: 1,
+            create_domain: 16,
+            read_domain: 32,
+            update_domain: 64,
+            delete_domain: 128,
+            create_user: 256,
+            read_user: 512,
+            update_user: 1024,
+            delete_user: 2048,
+            create_course: 65536,
+            read_course: 131072,
+            update_course: 262144,
+            delete_course: 524288,
+            create_section: 1048576,
+            read_section: 2097152,
+            update_section: 4194304,
+            delete_section: 8388608,
+            grade_assignment: 16777216,
+            grade_forum: 33554432,
+            grade_exam: 67108864,
+            setup_gradebook: 134217728,
+            control_domain: 268435456,
+            control_course: 536870912,
+            control_section: 1073741824,
+            read_gradebook: 2147483648,
+            report_domain: 4294967296,
+            report_course: 8589934592,
+            report_section: 17179869184,
+            post_domain_announcements: 34359738368,
+            proxy: 68719476736,
+            report_user: 274877906944,
+            submit_final_grade: 549755813888,
+            control_enrollment: 1099511627776,
+            read_enrollment: 2199023255552,
+            read_course_full: 4398046511104,
+            control_user: 8796093022208,
+            read_objective: 17592186044416,
+            update_objective: 35184372088832
+          }
+        end
+
+        def right_flags_hex
+          {
+            admin: "-0x01",
+            none: "0x00",
+            participate: "0x01",
+            create_domain: "0x10",
+            read_domain: "0x20",
+            update_domain: "0x40",
+            delete_domain: "0x80",
+            create_user: "0x100",
+            read_user: "0x200",
+            update_user: "0x400",
+            delete_user: "0x800",
+            create_course: "0x10000",
+            read_course: "0x20000",
+            update_course: "0x40000",
+            delete_course: "0x80000",
+            create_section: "0x100000",
+            read_section: "0x200000",
+            update_section: "0x400000",
+            delete_section: "0x800000",
+            grade_assignment: "0x1000000",
+            grade_forum: "0x2000000",
+            grade_exam: "0x4000000",
+            setup_gradebook: "0x8000000",
+            control_domain: "0x10000000",
+            control_course: "0x20000000",
+            control_section: "0x40000000",
+            read_gradebook: "0x80000000",
+            report_domain: "0x100000000",
+            report_course: "0x200000000",
+            report_section: "0x400000000",
+            post_domain_announcements: "0x800000000",
+            proxy: "0x1000000000",
+            report_user: "0x4000000000",
+            submit_final_grade: "0x8000000000",
+            control_enrollment: "0x10000000000",
+            read_enrollment: "0x20000000000",
+            read_course_full: "0x40000000000",
+            control_user: "0x80000000000",
+            read_objective: "0x100000000000",
+            update_objective: "0x200000000000"
+          }
+        end
+
+
+        def right_flags_lookup_value(val)
+          val = val.to_s
+          if val.include?("x")
+            raise ArgumentError.new("Not a valid right flag") unless right_flags_hex.values.include?(val)
+            right_flags_hex.find {|k,v| v == val}.first
+          else
+            val = val.to_i
+            raise ArgumentError.new("Not a valid right flag") unless right_flags.values.include?(val)
+            right_flags.find {|k,v| v == val}.first
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/agilix/version.rb

@@ -1,3 +1,3 @@
 module Agilix
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agilix
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Eggett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -191,6 +191,8 @@ files:
 - lib/agilix/buzz/commands/enrollment.rb
 - lib/agilix/buzz/commands/general.rb
 - lib/agilix/buzz/commands/report.rb
+- lib/agilix/buzz/commands/resource.rb
+- lib/agilix/buzz/commands/right.rb
 - lib/agilix/buzz/commands/user.rb
 - lib/agilix/version.rb
 - stats.html