microslop_one_drive 5.1.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1260d248788e7480366222b43716bdcfd51694eb2da87d192c533bcdc064401f
-  data.tar.gz: 8bfab49dad19e8a720856977873f1f4ccf7aef70716dfe5e104dc0e7038837b3
+  metadata.gz: c3391a616afb68c1cfef2bd83d8d9533bbe78ac392992af9778ad206e121c1be
+  data.tar.gz: 448e9e6f528d0754a5f13086a29e0020608b6be9da316a14bd12273a5503fd4b
 SHA512:
-  metadata.gz: 75d5f9f86a4a9d31ce34720517e2cb72d735cdcb4ab5c04751c48229549b4f7e1e495006135b38823c104b95353a79a1b156ab618de176f6a25fc0b1ffd0736b
-  data.tar.gz: ec1b7ccfa3bd4fca6212fab4f79ea190b975930f41475457f3b8e35c1154dd06467db57fbc5e9224c059aff20466336ae129adf31f305d840e5aa34e9fe7eaf5
+  metadata.gz: 2f09383070ce2c2fdcb4115d7adc2999b656045838beb697f48cad8a2781924a371ac5180027fc16fb86f1d48f1d08631e1d5fdee5765d42e0cb2026760a1f12
+  data.tar.gz: 888939a36e1c8896088192bbd3032062cb4543c5e052f8b5f92354a59fb704b22ec2c83042957fd312263b5366e616eaffc03b90ef95bf58fc5a665e4ab2ed8d

data/README.md

@@ -176,6 +176,49 @@ permissions.each do |p|
 end
 ```
 
+### Deleting a Permission from a Drive Item
+
+Use `delete_permission` to remove a permission from a drive item. It returns `true` both when the permission was just
+deleted and when it's already gone (idempotent behavior). It raises an error if the drive or item does not exist.
+
+```rb
+permission = permissions.first
+
+# Delete from the default drive
+client.delete_permission(item_id: example_item.id, permission_id: permission.id) # => true
+
+# Or from a specific drive
+client.delete_permission(
+  drive_id: drive.id,
+  item_id: example_item.id,
+  permission_id: permission.id
+) # => true
+```
+
+### Revoking Grants on a Permission (beta API)
+
+Use `revoke_grants` to revoke specific grantees from an existing permission. This uses the Microsoft Graph **beta**
+endpoint under the hood:
+
+<https://learn.microsoft.com/en-us/graph/api/permission-revokegrants?view=graph-rest-beta>
+
+Each grantee is a hash with **exactly one** of the following keys: `:email`, `:alias`, or `:objectId`.
+
+```rb
+permission = permissions.find { |p| p.is_a?(MicroslopOneDrive::Permissions::SharingLink) }
+
+grantees = [
+  {email: "person@example.com"},
+  {objectId: "00000000-0000-0000-0000-000000000000"}
+]
+
+client.revoke_grants(
+  item_id: example_item.id,
+  permission_id: permission.id,
+  grantees: grantees
+) # => true
+```
+
 ### Checking if the user's accounts supports SharePoint Sites
 
 ```rb

data/lib/microslop_one_drive/batch/batch.rb

@@ -0,0 +1,2 @@
+require_relative "batch_response"
+require_relative "response"

data/lib/microslop_one_drive/deserializers/application_deserializer.rb

@@ -0,0 +1,17 @@
+module MicroslopOneDrive
+  module Deserializers
+    class ApplicationDeserializer
+      def self.create_from_hash(application_hash)
+        return nil if application_hash.nil?
+        return nil if application_hash.empty?
+
+        application_hash = Utils.deep_symbolize_keys(application_hash)
+
+        MicroslopOneDrive::IdentitySets::Application.new(
+          id: application_hash.fetch(:id, nil),
+          display_name: application_hash.fetch(:displayName, nil)
+        )
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/deserializers/base_identity_set_deserializer.rb

@@ -0,0 +1,12 @@
+module MicroslopOneDrive
+  module Deserializers
+    class BaseIdentitySetDeserializer
+      def self.create_from_hash(identity_set_hash)
+        MicroslopOneDrive::IdentitySets::BaseIdentitySet.new(
+          id: identity_set_hash.fetch(:id, nil),
+          display_name: identity_set_hash.fetch(:displayName, nil)
+        )
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/deserializers/deserializers.rb

@@ -0,0 +1,13 @@
+require_relative "application_deserializer"
+require_relative "device_deserializer"
+require_relative "drive_deserializer"
+require_relative "drive_item_deserializer"
+require_relative "group_deserializer"
+require_relative "link_deserializer"
+require_relative "parent_reference_deserializer"
+require_relative "permission_deserializer"
+require_relative "quota_deserializer"
+require_relative "shared_with_me_item_deserializer"
+require_relative "user_deserializer"
+require_relative "base_identity_set_deserializer"
+require_relative "identity_set_deserializer"

data/lib/microslop_one_drive/deserializers/device_deserializer.rb

@@ -0,0 +1,17 @@
+module MicroslopOneDrive
+  module Deserializers
+    class DeviceDeserializer
+      def self.create_from_hash(device_hash)
+        return nil if device_hash.nil?
+        return nil if device_hash.empty?
+
+        device_hash = Utils.deep_symbolize_keys(device_hash)
+
+        MicroslopOneDrive::IdentitySets::Device.new(
+          id: device_hash.fetch(:id, nil),
+          display_name: device_hash.fetch(:displayName, nil)
+        )
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/deserializers/group_deserializer.rb

@@ -0,0 +1,17 @@
+module MicroslopOneDrive
+  module Deserializers
+    class GroupDeserializer
+      def self.create_from_hash(group_hash)
+        return nil if group_hash.nil?
+        return nil if group_hash.empty?
+
+        group_hash = Utils.deep_symbolize_keys(group_hash)
+
+        MicroslopOneDrive::IdentitySets::Group.new(
+          id: group_hash.fetch(:id, nil),
+          display_name: group_hash.fetch(:displayName, nil)
+        )
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/deserializers/identity_set_deserializer.rb

@@ -0,0 +1,27 @@
+module MicroslopOneDrive
+  module Deserializers
+    class IdentitySetDeserializer
+      TYPE_MAPPING = {
+        siteUser: UserDeserializer,
+        user: UserDeserializer,
+        application: ApplicationDeserializer,
+        group: GroupDeserializer,
+        siteGroup: GroupDeserializer,
+        device: DeviceDeserializer
+      }.freeze
+
+      def self.create_from_hash(identity_set_hash)
+        return nil if identity_set_hash.nil?
+        return nil if identity_set_hash.empty?
+
+        identity_set_hash = Utils.deep_symbolize_keys(identity_set_hash)
+
+        key, deserializer_class = TYPE_MAPPING.find { identity_set_hash.keys.include?(it.first) }
+
+        return BaseIdentitySetDeserializer.create_from_hash(identity_set_hash.values.first) if deserializer_class.nil?
+
+        deserializer_class.create_from_hash(identity_set_hash[key])
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/deserializers/permission_deserializer.rb

@@ -47,7 +47,7 @@ module MicroslopOneDrive
         common_parameters = build_common_parameters(permission_hash)
 
         granted_to_hash_list = permission_hash.fetch(:grantedToIdentitiesV2, [])
-        granted_to_list = granted_to_hash_list.map { GrantedToDeserializer.create_from_hash(it) }.compact
+        granted_to_list = granted_to_hash_list.map { IdentitySetDeserializer.create_from_hash(it) }.compact
 
         has_password = permission_hash.fetch(:hasPassword, false)
 
@@ -67,7 +67,7 @@ module MicroslopOneDrive
         common_parameters = build_common_parameters(permission_hash)
 
         granted_to_hash = permission_hash.fetch(:grantedToV2, nil)
-        granted_to = GrantedToDeserializer.create_from_hash(granted_to_hash)
+        granted_to = IdentitySetDeserializer.create_from_hash(granted_to_hash)
 
         MicroslopOneDrive::Permissions::DirectPermission.new(**common_parameters, granted_to: granted_to)
       end

data/lib/microslop_one_drive/deserializers/user_deserializer.rb

@@ -3,14 +3,14 @@ require "microslop_one_drive/utils"
 module MicroslopOneDrive
   module Deserializers
     class UserDeserializer
-      # Creates a new User object from a hash.
+      # Creates a new User identity (IdentitySet user) object from a hash.
       #
       # @param user_hash [Hash] The hash to create the User object from.
-      # @return [MicroslopOneDrive::User] The created User object.
+      # @return [MicroslopOneDrive::IdentitySets::User] The created User object.
       def self.create_from_hash(user_hash)
         user_hash = Utils.deep_symbolize_keys(user_hash)
 
-        User.new(
+        MicroslopOneDrive::IdentitySets::User.new(
           id: user_hash.fetch(:id, nil),
           principal_name: user_hash.fetch(:userPrincipalName, nil),
           display_name: user_hash.fetch(:displayName, nil),

data/lib/microslop_one_drive/endpoints/endpoints.rb

@@ -0,0 +1,13 @@
+require_relative "me"
+require_relative "drive"
+require_relative "all_drives"
+require_relative "drive_exists"
+require_relative "drive_item"
+require_relative "drive_item_exists"
+require_relative "delta"
+require_relative "permissions"
+require_relative "batch"
+require_relative "batch_permissions"
+require_relative "delete_permission"
+require_relative "supports_sites"
+require_relative "revoke_grants"

data/lib/microslop_one_drive/endpoints/me.rb

@@ -3,7 +3,7 @@ module MicroslopOneDrive
     module Me
       # Gets the current user
       #
-      # @return [MicroslopOneDrive::User]
+      # @return [MicroslopOneDrive::IdentitySets::User]
       def me
         response = get(path: "me", query: {})
         handle_error(response) unless response.success?

data/lib/microslop_one_drive/errors/errors.rb

@@ -0,0 +1 @@
+require_relative "client_error"

data/lib/microslop_one_drive/identity_sets/application.rb

@@ -0,0 +1,5 @@
+module MicroslopOneDrive
+  module IdentitySets
+    class Application < BaseIdentitySet; end
+  end
+end

data/lib/microslop_one_drive/identity_sets/base_identity_set.rb

@@ -0,0 +1,12 @@
+module MicroslopOneDrive
+  module IdentitySets
+    class BaseIdentitySet
+      attr_reader :id, :display_name
+
+      def initialize(id:, display_name:)
+        @id = id
+        @display_name = display_name
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/identity_sets/device.rb

@@ -0,0 +1,5 @@
+module MicroslopOneDrive
+  module IdentitySets
+    class Device < BaseIdentitySet; end
+  end
+end

data/lib/microslop_one_drive/identity_sets/group.rb

@@ -0,0 +1,5 @@
+module MicroslopOneDrive
+  module IdentitySets
+    class Group < BaseIdentitySet; end
+  end
+end

data/lib/microslop_one_drive/identity_sets/identity_sets.rb

@@ -0,0 +1,5 @@
+require_relative "base_identity_set"
+require_relative "user"
+require_relative "application"
+require_relative "group"
+require_relative "device"

data/lib/microslop_one_drive/identity_sets/user.rb

@@ -0,0 +1,47 @@
+module MicroslopOneDrive
+  module IdentitySets
+    class User < BaseIdentitySet
+      attr_reader :principal_name, :surname, :given_name, :preferred_language, :mail, :mobile_phone,
+                  :job_title, :office_location, :business_phones, :login_name
+
+      def initialize(
+        principal_name: nil,
+        id: nil,
+        display_name: nil,
+        surname: nil,
+        given_name: nil,
+        preferred_language: nil,
+        mail: nil,
+        mobile_phone: nil,
+        job_title: nil,
+        office_location: nil,
+        business_phones: [],
+        login_name: nil
+      )
+        super(id: id, display_name: display_name)
+        @principal_name = principal_name
+        @surname = surname
+        @given_name = given_name
+        @preferred_language = preferred_language
+        @mail = mail
+        @mobile_phone = mobile_phone
+        @job_title = job_title
+        @office_location = office_location
+        @business_phones = business_phones
+        @login_name = login_name
+      end
+
+      def email
+        @mail
+      end
+
+      def email_address
+        @mail
+      end
+
+      def last_name
+        @surname
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/list_responses/list_responses.rb

@@ -0,0 +1,5 @@
+require_relative "list_response"
+require_relative "drive_list"
+require_relative "drive_item_list"
+require_relative "permission_list"
+require_relative "shared_with_me_list"

data/lib/microslop_one_drive/permissions/permissions.rb

@@ -0,0 +1,5 @@
+require_relative "base_permission"
+require_relative "direct_permission"
+require_relative "link"
+require_relative "sharing_invitation"
+require_relative "sharing_link"

data/lib/microslop_one_drive/version.rb

@@ -1,3 +1,3 @@
 module MicroslopOneDrive
-  VERSION = "5.1.2".freeze
+  VERSION = "6.0.0".freeze
 end

data/lib/microslop_one_drive.rb

@@ -1,64 +1,26 @@
 require "httparty"
 require "json"
 
+# Utilities
 require_relative "microslop_one_drive/version"
 require_relative "microslop_one_drive/utils"
+require_relative "microslop_one_drive/deserializers/deserializers"
 
-# Deserializers
-require_relative "microslop_one_drive/deserializers/user_deserializer"
-require_relative "microslop_one_drive/deserializers/drive_deserializer"
-require_relative "microslop_one_drive/deserializers/quota_deserializer"
-require_relative "microslop_one_drive/deserializers/drive_item_deserializer"
-require_relative "microslop_one_drive/deserializers/parent_reference_deserializer"
-require_relative "microslop_one_drive/deserializers/shared_with_me_item_deserializer"
-require_relative "microslop_one_drive/deserializers/permission_deserializer"
-require_relative "microslop_one_drive/deserializers/link_deserializer"
-require_relative "microslop_one_drive/deserializers/granted_to_deserializer"
-
-# Drive items
+# Models
 require_relative "microslop_one_drive/file"
 require_relative "microslop_one_drive/folder"
 require_relative "microslop_one_drive/root_folder"
 require_relative "microslop_one_drive/drive_item"
-
-# List Responses
-require_relative "microslop_one_drive/list_responses/list_response"
-require_relative "microslop_one_drive/list_responses/drive_list"
-require_relative "microslop_one_drive/list_responses/drive_item_list"
-require_relative "microslop_one_drive/list_responses/permission_list"
-require_relative "microslop_one_drive/list_responses/shared_with_me_list"
-
-# Batch
-require_relative "microslop_one_drive/batch/batch_response"
-require_relative "microslop_one_drive/batch/response"
-
-# Other models
-require_relative "microslop_one_drive/user"
+require_relative "microslop_one_drive/list_responses/list_responses"
+require_relative "microslop_one_drive/batch/batch"
+require_relative "microslop_one_drive/identity_sets/identity_sets"
 require_relative "microslop_one_drive/parent_reference"
 require_relative "microslop_one_drive/drive"
 require_relative "microslop_one_drive/quota"
 require_relative "microslop_one_drive/shared_with_me_item"
-require_relative "microslop_one_drive/permissions/base_permission"
-require_relative "microslop_one_drive/permissions/direct_permission"
-require_relative "microslop_one_drive/permissions/sharing_link"
-require_relative "microslop_one_drive/permissions/sharing_invitation"
-require_relative "microslop_one_drive/permissions/link"
-
-# Endpoints
-require_relative "microslop_one_drive/endpoints/me"
-require_relative "microslop_one_drive/endpoints/drive"
-require_relative "microslop_one_drive/endpoints/all_drives"
-require_relative "microslop_one_drive/endpoints/drive_exists"
-require_relative "microslop_one_drive/endpoints/drive_item"
-require_relative "microslop_one_drive/endpoints/drive_item_exists"
-require_relative "microslop_one_drive/endpoints/delta"
-require_relative "microslop_one_drive/endpoints/permissions"
-require_relative "microslop_one_drive/endpoints/batch"
-require_relative "microslop_one_drive/endpoints/batch_permissions"
-require_relative "microslop_one_drive/endpoints/delete_permission"
-require_relative "microslop_one_drive/endpoints/supports_sites"
-require_relative "microslop_one_drive/endpoints/revoke_grants"
+require_relative "microslop_one_drive/permissions/permissions"
 
 # Client
-require_relative "microslop_one_drive/errors/client_error"
+require_relative "microslop_one_drive/endpoints/endpoints"
+require_relative "microslop_one_drive/errors/errors"
 require_relative "microslop_one_drive/client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microslop_one_drive
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 6.0.0
 platform: ruby
 authors:
 - Bradley Marques
@@ -33,12 +33,18 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/microslop_one_drive.rb
+- lib/microslop_one_drive/batch/batch.rb
 - lib/microslop_one_drive/batch/batch_response.rb
 - lib/microslop_one_drive/batch/response.rb
 - lib/microslop_one_drive/client.rb
+- lib/microslop_one_drive/deserializers/application_deserializer.rb
+- lib/microslop_one_drive/deserializers/base_identity_set_deserializer.rb
+- lib/microslop_one_drive/deserializers/deserializers.rb
+- lib/microslop_one_drive/deserializers/device_deserializer.rb
 - lib/microslop_one_drive/deserializers/drive_deserializer.rb
 - lib/microslop_one_drive/deserializers/drive_item_deserializer.rb
-- lib/microslop_one_drive/deserializers/granted_to_deserializer.rb
+- lib/microslop_one_drive/deserializers/group_deserializer.rb
+- lib/microslop_one_drive/deserializers/identity_set_deserializer.rb
 - lib/microslop_one_drive/deserializers/link_deserializer.rb
 - lib/microslop_one_drive/deserializers/parent_reference_deserializer.rb
 - lib/microslop_one_drive/deserializers/permission_deserializer.rb
@@ -56,28 +62,37 @@ files:
 - lib/microslop_one_drive/endpoints/drive_exists.rb
 - lib/microslop_one_drive/endpoints/drive_item.rb
 - lib/microslop_one_drive/endpoints/drive_item_exists.rb
+- lib/microslop_one_drive/endpoints/endpoints.rb
 - lib/microslop_one_drive/endpoints/me.rb
 - lib/microslop_one_drive/endpoints/permissions.rb
 - lib/microslop_one_drive/endpoints/revoke_grants.rb
 - lib/microslop_one_drive/endpoints/supports_sites.rb
 - lib/microslop_one_drive/errors/client_error.rb
+- lib/microslop_one_drive/errors/errors.rb
 - lib/microslop_one_drive/file.rb
 - lib/microslop_one_drive/folder.rb
+- lib/microslop_one_drive/identity_sets/application.rb
+- lib/microslop_one_drive/identity_sets/base_identity_set.rb
+- lib/microslop_one_drive/identity_sets/device.rb
+- lib/microslop_one_drive/identity_sets/group.rb
+- lib/microslop_one_drive/identity_sets/identity_sets.rb
+- lib/microslop_one_drive/identity_sets/user.rb
 - lib/microslop_one_drive/list_responses/drive_item_list.rb
 - lib/microslop_one_drive/list_responses/drive_list.rb
 - lib/microslop_one_drive/list_responses/list_response.rb
+- lib/microslop_one_drive/list_responses/list_responses.rb
 - lib/microslop_one_drive/list_responses/permission_list.rb
 - lib/microslop_one_drive/list_responses/shared_with_me_list.rb
 - lib/microslop_one_drive/parent_reference.rb
 - lib/microslop_one_drive/permissions/base_permission.rb
 - lib/microslop_one_drive/permissions/direct_permission.rb
 - lib/microslop_one_drive/permissions/link.rb
+- lib/microslop_one_drive/permissions/permissions.rb
 - lib/microslop_one_drive/permissions/sharing_invitation.rb
 - lib/microslop_one_drive/permissions/sharing_link.rb
 - lib/microslop_one_drive/quota.rb
 - lib/microslop_one_drive/root_folder.rb
 - lib/microslop_one_drive/shared_with_me_item.rb
-- lib/microslop_one_drive/user.rb
 - lib/microslop_one_drive/utils.rb
 - lib/microslop_one_drive/version.rb
 homepage: https://github.com/bradleymarques/microslop_one_drive

data/lib/microslop_one_drive/deserializers/granted_to_deserializer.rb

@@ -1,20 +0,0 @@
-module MicroslopOneDrive
-  module Deserializers
-    class GrantedToDeserializer
-      def self.create_from_hash(granted_to_hash)
-        return nil if granted_to_hash.nil?
-        return nil if granted_to_hash.empty?
-
-        granted_to_hash = Utils.deep_symbolize_keys(granted_to_hash)
-
-        if granted_to_hash.key?(:siteUser)
-          UserDeserializer.create_from_hash(granted_to_hash[:siteUser])
-        elsif granted_to_hash.key?(:group)
-          raise NotImplementedError, "Group permissions are not supported yet"
-        else
-          raise NotImplementedError, "Unknown granted to type for hash: #{granted_to_hash.inspect}"
-        end
-      end
-    end
-  end
-end

data/lib/microslop_one_drive/user.rb

@@ -1,46 +0,0 @@
-module MicroslopOneDrive
-  class User
-    attr_reader :principal_name, :id, :display_name, :surname, :given_name, :preferred_language, :mail, :mobile_phone,
-                :job_title, :office_location, :business_phones, :login_name
-
-    def initialize(
-      principal_name: nil,
-      id: nil,
-      display_name: nil,
-      surname: nil,
-      given_name: nil,
-      preferred_language: nil,
-      mail: nil,
-      mobile_phone: nil,
-      job_title: nil,
-      office_location: nil,
-      business_phones: [],
-      login_name: nil
-    )
-      @principal_name = principal_name
-      @id = id
-      @display_name = display_name
-      @surname = surname
-      @given_name = given_name
-      @preferred_language = preferred_language
-      @mail = mail
-      @mobile_phone = mobile_phone
-      @job_title = job_title
-      @office_location = office_location
-      @business_phones = business_phones
-      @login_name = login_name
-    end
-
-    def email
-      @mail
-    end
-
-    def email_address
-      @mail
-    end
-
-    def last_name
-      @surname
-    end
-  end
-end