google_directory 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be15ff583f69da807620a4b2aef6466b6a896e5d9fc50bdd36f5855fb63b4d50
-  data.tar.gz: b7ecff040096c31c35a8b29ff13859e763f9cb4fcb3d025247c255f32fb6e801
+  metadata.gz: cf3b16f0223835642133e6f6f2e7cbdc2012c0459923543f218d762a8e03e89d
+  data.tar.gz: 87258d6b5de32692cb0f5016619388ebf5257e0c8152f21569558ad67c797554
 SHA512:
-  metadata.gz: dc47b4ce9e1d17d53ff5ec0a109feec4b0cc82951917cdfe3b1392aa16688d594152710a321d7c7225654348962995ddef87c2b368d0250412a4992ac675d17a
-  data.tar.gz: 0f482a2d2cfc9ae100b0e5b0617c8892a5445821ac64da29fc9334c32aedd0bb616748b63751e500ca3a1e97dddffdc6863659b0bdd3ea1ff4d081af82a86cb6
+  metadata.gz: 7033882f9889578aba25ad3f41166258d8f682696c300ab1ad4fee899646d3a0d41672035a4e7518d5b32b7e273507900d64584b43d2faac7d7d25cb5b5ae6f0
+  data.tar.gz: dd31543c65ae56e3caf8aa5d17aa86f1d7c659f025eb7c5ee78fc1ee51e7002ec417d465e02ccb2f17ecfa20a7b2eea0e4981ea764152eb088bcd3878c7bcdc9

data/lib/google_directory/connection.rb

@@ -44,27 +44,27 @@ module GoogleDirectory
 
     # @note Run a command against Google Directory
     #
-    # @param action [Symbol] choose action to perform these include: :user_get, :user_exists? (t/f), :user_create, :user_delete, :user_update & convience commands :user_suspend, :user_reactivate, :user_change_password
-    # @param attributes [Hash] attributes needed to perform action
-    # @return [Hash] will hopefully return a hash with {success: {action: :action, attributes: {primary_email: "user@domain"}, response: "whatever google answered - usually a hash"} }
-    def run( action:, attributes: {} )
+    # @param command [Symbol] choose command to perform these include: :user_get, :user_exists? (t/f), :user_create, :user_delete, :user_update & convience commands :user_suspend, :user_reactivate, :user_change_password
+    # @param attributes [Hash] attributes needed to perform command
+    # @return [Hash] formatted as: `{success: {command: :command, attributes: {primary_email: "user@domain"}, response: GoogleAnswer} }`
+    def run( command:, attributes: {} )
       response  = { success: nil, error: nil }
       begin
-        response[:success] = send( action, attributes: attributes )
+        response[:success] = send( command, attributes: attributes )
       rescue Google::Apis::ClientError => error
-        response[:error]   = {action: action, attributes: attributes,
+        response[:error]   = {command: command, attributes: attributes,
                               error: error}
       end
       response
     end
     alias_method :execute, :run
 
-    # # answer = GoogleDirectory.(action: :user_get, attributes: {primary_email: "btihen@las.ch"})
+    # # answer = GoogleDirectory.(command: :user_get, attributes: {primary_email: "btihen@las.ch"})
     # def self.call(service: Google::Apis::AdminDirectoryV1::DirectoryService,
     #               app_name: nil,
-    #               action:, attributes: {} )
+    #               command:, attributes: {} )
     #   new(service: service, app_name: app_name).
-    #     run(action: action, attributes: attributes)
+    #     run(command: command, attributes: attributes)
     # end
 
     private

data/lib/google_directory/user_commands.rb

@@ -10,23 +10,23 @@ module GoogleDirectory
     # @note Get GoogleDirectory User Info
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com" }
-    # @return [Hash] formatted as {success: {action: :user_get, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
+    # @return [Hash] formatted as {success: {command: :user_get, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
     def user_get( attributes: )
       response = service.get_user( attributes[:primary_email] )
-      {action: :user_get, user: attributes[:primary_email], response: response}
+      {command: :user_get, user: attributes[:primary_email], response: response}
     end
 
     # @note Test if user exists in Google Directory
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com" }
-    # @return [Hash] formatted as {success: {action: :user_exists?, attributes: {primary_email: "user@domain"}, response: Boolean } }
+    # @return [Hash] formatted as {success: {command: :user_exists?, attributes: {primary_email: "user@domain"}, response: Boolean } }
     def user_exists?( attributes: )
       begin
         response = service.get_user( attributes[:primary_email] )
-        return {action: :user_exists?, user: attributes[:primary_email], response: true}
+        return {command: :user_exists?, user: attributes[:primary_email], response: true}
       rescue Google::Apis::ClientError => error
         if error.message.include? 'notFound'
-          return {action: :user_exists?, user: attributes[:primary_email], response: false}
+          return {command: :user_exists?, user: attributes[:primary_email], response: false}
         else
           raise error
         end
@@ -36,7 +36,7 @@ module GoogleDirectory
     # @note creates a new Google Directory User
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com", name: {given_name: "First Names", family_name: "LAST NAMES" } }
-    # @return [Hash] formatted as {success: {action: :user_create, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
+    # @return [Hash] formatted as {success: {command: :user_create, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
     def user_create( attributes: )
       # http://blog.liveedu.tv/ruby-generate-random-string/
       password = SecureRandom.base64
@@ -46,63 +46,63 @@ module GoogleDirectory
       user_object = Google::Apis::AdminDirectoryV1::User.new user_attr
       # create user in directory services
       response = service.insert_user( user_object )
-      {action: :user_create, user: attributes[:primary_email], response: response}
+      {command: :user_create, user: attributes[:primary_email], response: response}
     end
 
     # @note updates an exising Google Directory User
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com", attributes_to_change: "" } }
-    # @return [Hash] formatted as {success: {action: :user_update, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
+    # @return [Hash] formatted as {success: {command: :user_update, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
     def user_update( attributes: )
       # create a user object for google to update
       response = update_user( attributes )
-      {action: :user_update, user: attributes[:primary_email], response: response}
+      {command: :user_update, user: attributes[:primary_email], response: response}
     end
 
     # @note updates an exising Google Directory User password - convience method instead of using :user_update
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com", password: "secret" } - if no password is included a random password will be assigned
-    # @return [Hash] formatted as {success: {action: :user_change_password, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
+    # @return [Hash] formatted as {success: {command: :user_change_password, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
     def user_change_password( attributes: )
       password = SecureRandom.base64
       defaults  = { password: password, change_password_at_next_login: true }
       user_attr = defaults.merge( attributes )
 
       response = update_user( user_attr )
-      {action: :user_change_password, user: attributes[:primary_email], response: response}
+      {command: :user_change_password, user: attributes[:primary_email], response: response}
     end
 
     # @note activates an exising Google Directory User password - convience method instead of using :user_update
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com" }
-    # @return [Hash] formatted as {success: {action: :user_reactivate, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
+    # @return [Hash] formatted as {success: {command: :user_reactivate, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
     def user_reactivate( attributes: )
       defaults  = { :suspended => false }
       user_attr = defaults.merge( attributes )
 
       response = update_user( user_attr )
-      {action: :user_reactivate, user: attributes[:primary_email], response: response}
+      {command: :user_reactivate, user: attributes[:primary_email], response: response}
     end
 
     # @note suspends an exising Google Directory User password - convience method instead of using :user_update
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com" }
-    # @return [Hash] formatted as {success: {action: :user_suspend, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
+    # @return [Hash] formatted as {success: {command: :user_suspend, attributes: {primary_email: "user@domain"}, response: GoogleUserObject } }
     def user_suspend( attributes: )
       defaults  = { :suspended => true }
       user_attr = defaults.merge( attributes )
 
       response = update_user( user_attr )
-      {action: :user_suspend, user: attributes[:primary_email], response: response}
+      {command: :user_suspend, user: attributes[:primary_email], response: response}
     end
 
     # @note deletes an exising Google Directory User
     #
     # @param attributes [Hash] this attribute MUST include: { primary_email: "username@domain.com" }
-    # @return [Hash] formatted as {success: {action: :user_delete, attributes: {primary_email: "user@domain"}, response: "" } }
+    # @return [Hash] formatted as {success: {command: :user_delete, attributes: {primary_email: "user@domain"}, response: "" } }
     def user_delete( attributes: )
       response = service.delete_user( attributes[:primary_email] )
-      {action: :user_delete, user: attributes[:primary_email], response: response}
+      {command: :user_delete, user: attributes[:primary_email], response: response}
     end
 
     private

data/lib/google_directory/users_commands.rb

@@ -17,7 +17,7 @@ module GoogleDirectory
       defaults = { max_results: 10, order_by: 'email' }
       filters  = defaults.merge( attributes )
       response = service.list_users( filters )
-      {action: :users_list, filters: filters, response: response}
+      {command: :users_list, filters: filters, response: response}
     end
 
   end

data/lib/google_directory/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_directory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bill Tihen
@@ -117,5 +117,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Simple ruby wrapper to manage google accounts.
+summary: Simple ruby wrapper to manage google accounts - using oauth2.
 test_files: []