microslop_one_drive 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6fe465bafb81fd55f7e6115d3c25684f8de6d4dd7f7a10a2c21cca5d194e7e
-  data.tar.gz: 0a8109c8bb15d7660f9b6cdaa84f920dce01280d346971297da3456059d2d67b
+  metadata.gz: c456959cfd4fbe8f15976c434467f540fce7a38187f26d4142227516fa71826e
+  data.tar.gz: e75f721e545a657b399840247c4a04721c8b407148edfb8ffc9feeeaf95c5408
 SHA512:
-  metadata.gz: e85320b160e96a4b218856b9b5701d863e5d5960b6e4f67b8b72485a4205a672a19413f7a6b2e86ed11649a6925841dae3b52b869f2cabf8c14bc1ef0ae7dc84
-  data.tar.gz: a6a89eb7938ec464bd5a63293f3627706d472295eff66428d1ccd14d3341dd5b6202706d9651d7a8a494d64a373811c7d6127e5b6aaa043c0ef06a4364b58700
+  metadata.gz: bc8051606e48ce9e91b09108965645a87acb0c90d61a8eef0255858d060efd08b02dff8507ab6b91f8140fa20896ad445039d0b33c1848ca307175dbb2b87353
+  data.tar.gz: 557535418c4488950a39ef2b063010531b59888357aa0fae89bbf42c6c73f07667bb716588ace852a95d65bf245079d8e48616d8d82bcd6f932d200a5a88a0e9

data/README.md

@@ -131,18 +131,30 @@ shared_items = drive_item_list.items.select(&:shared?)
 example_item = shared_items.first
 
 permission_list = client.permissions(item_id: example_item.id)
-permission = permission_list.first
-
-permission.role # => "write"
-permission.audience.type # => "user"
-permission.audience.id # => "person@example.com"
-permission.audience.display_name # => "Example Person"
-permission.audience.email_address # => "person@example.com"
+# Or with a specific drive: client.permissions(item_id: example_item.id, drive_id: drive.id)
+
+permissions = permission_list.permissions
+# Each permission is a DirectPermission, SharingLink, or SharingInvitation.
+
+# Example: direct permission (e.g. owner) — use granted_to (a User)
+direct = permissions.find { |p| p.is_a?(MicroslopOneDrive::Permissions::DirectPermission) }
+direct.roles                    # => ["owner"]
+direct.granted_to.display_name  # => "Example Person"
+direct.granted_to.email_address # => "person@example.com"
+direct.granted_to.id            # => "4"
+
+# Example: sharing link — use granted_to_list and link
+link_perm = permissions.find { |p| p.is_a?(MicroslopOneDrive::Permissions::SharingLink) }
+link_perm.roles           # => ["write"]
+link_perm.granted_to_list # => array of Users
+link_perm.link.web_url    # => "https://1drv.ms/f/c/..."
+link_perm.edit_link?      # => true
+link_perm.anonymous_link? # => true
 ```
 
 ### Get Permissions for multiple Drive Items
 
-Instead of calling `client.permissions(...)` for each item -- which would make N API calls for N items -- we use
+Instead of calling `client.permissions(...)` for each item — which would make N API calls for N items — use
 Microsoft Graph API [batch](https://learn.microsoft.com/en-us/graph/json-batching?tabs=http) feature.
 
 ```rb
@@ -150,8 +162,18 @@ drive_item_list = client.delta(drive_id: drive.id)
 shared_items = drive_item_list.items.select(&:shared?)
 
 permissions = client.batch_permissions(item_ids: shared_items.map(&:id))
-# Returns a flat array of MicroslopOneDrive::Permission (batches of 20 are made under the hood).
-permissions.each { |p| puts "#{p.audience.display_name}: #{p.role}" }
+# Or with a specific drive: client.batch_permissions(item_ids: shared_items.map(&:id), drive_id: drive.id)
+# Returns a flat array of permission objects (DirectPermission, SharingLink, SharingInvitation).
+# Batches of 20 are made under the hood.
+
+permissions.each do |p|
+  case p
+  when MicroslopOneDrive::Permissions::DirectPermission
+    puts "#{p.granted_to.display_name}: #{p.roles.join(', ')}"
+  when MicroslopOneDrive::Permissions::SharingLink
+    puts "Link (#{p.link.type}): #{p.roles.join(', ')}"
+  end
+end
 ```
 
 ### Checking if the user's accounts supports SharePoint Sites

data/lib/microslop_one_drive/deserializers/granted_to_deserializer.rb

@@ -0,0 +1,17 @@
+module MicroslopOneDrive
+  module Deserializers
+    class GrantedToDeserializer
+      def self.create_from_hash(granted_to_hash)
+        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/deserializers/link_deserializer.rb

@@ -0,0 +1,16 @@
+module MicroslopOneDrive
+  module Deserializers
+    class LinkDeserializer
+      def self.create_from_hash(link_hash)
+        link_hash = Utils.deep_symbolize_keys(link_hash)
+
+        MicroslopOneDrive::Permissions::Link.new(
+          web_url: link_hash.fetch(:webUrl, nil),
+          scope: link_hash.fetch(:scope, nil),
+          type: link_hash.fetch(:type, nil),
+          prevents_download: link_hash.fetch(:preventsDownload, false)
+        )
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/deserializers/permission_deserializer.rb

@@ -0,0 +1,76 @@
+module MicroslopOneDrive
+  module Deserializers
+    class PermissionDeserializer
+      # Deserializes a hash into a Permission object. Permissions can be SharingLinks or SharingInvitations.
+      def self.create_from_hash(permission_hash)
+        permission_hash = Utils.deep_symbolize_keys(permission_hash)
+
+        if sharing_link?(permission_hash)
+          build_sharing_link(permission_hash)
+        elsif sharing_invitation?(permission_hash)
+          build_sharing_invitation(permission_hash)
+        elsif direct_permission?(permission_hash)
+          build_direct_permission(permission_hash)
+        else
+          raise NotImplementedError, "Unknown permission type for hash: #{permission_hash.inspect}"
+        end
+      end
+
+      def self.build_common_parameters(permission_hash)
+        link_hash = permission_hash.fetch(:link, nil)
+        link = LinkDeserializer.create_from_hash(link_hash) if link_hash
+
+        {
+          id: permission_hash.fetch(:id, nil),
+          roles: permission_hash.fetch(:roles, []),
+          share_id: permission_hash.fetch(:shareId, nil),
+          link: link
+        }
+      end
+
+      def self.sharing_link?(permission_hash)
+        link = permission_hash.fetch(:link, nil)
+        return false if link.nil?
+
+        link.key?(:scope) && link.key?(:type)
+      end
+
+      def self.sharing_invitation?(permission_hash)
+        permission_hash.key?(:invitation)
+      end
+
+      def self.direct_permission?(permission_hash)
+        permission_hash.key?(:grantedToV2)
+      end
+
+      def self.build_sharing_link(permission_hash)
+        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) }
+
+        has_password = permission_hash.fetch(:hasPassword, false)
+
+        MicroslopOneDrive::Permissions::SharingLink.new(
+          **common_parameters,
+          granted_to_list: granted_to_list,
+          has_password: has_password
+        )
+      end
+
+      def self.build_sharing_invitation(permission_hash)
+        common_parameters = build_common_parameters(permission_hash)
+        MicroslopOneDrive::Permissions::SharingInvitation.new(**common_parameters)
+      end
+
+      def self.build_direct_permission(permission_hash)
+        common_parameters = build_common_parameters(permission_hash)
+
+        granted_to_hash = permission_hash.fetch(:grantedToV2, nil)
+        granted_to = GrantedToDeserializer.create_from_hash(granted_to_hash)
+
+        MicroslopOneDrive::Permissions::DirectPermission.new(**common_parameters, granted_to: granted_to)
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/deserializers/user_deserializer.rb

@@ -21,7 +21,8 @@ module MicroslopOneDrive
           mobile_phone: user_hash.fetch(:mobilePhone, nil),
           job_title: user_hash.fetch(:jobTitle, nil),
           office_location: user_hash.fetch(:officeLocation, nil),
-          business_phones: user_hash.fetch(:businessPhones, [])
+          business_phones: user_hash.fetch(:businessPhones, []),
+          login_name: user_hash.fetch(:loginName, nil)
         )
       end
     end

data/lib/microslop_one_drive/endpoints/permissions.rb

@@ -17,7 +17,7 @@ module MicroslopOneDrive
 
         response = get(path: url, query: {})
 
-        if response.code == 404
+        if response.not_found?
           return MicroslopOneDrive::ListResponses::PermissionList.new(
             drive_item_id: item_id,
             parsed_response: {"value" => []}

data/lib/microslop_one_drive/list_responses/permission_list.rb

@@ -12,15 +12,15 @@ module MicroslopOneDrive
       private
 
       def build_permissions(drive_item_id, parsed_response)
-        permission_sets = parsed_response.fetch("value", []).map do
-          MicroslopOneDrive::PermissionSet.new(drive_item_id: drive_item_id, parsed_response: it)
+        permissions = parsed_response.fetch("value", []).map do
+          MicroslopOneDrive::Deserializers::PermissionDeserializer.create_from_hash(it)
         end
 
-        # At this stage, the permissions could contain multiple Audiences for the same Permission.
-        # This is because OneDrive can return multiple permissions for the same thing.
-        # For example, a file shared with one person and a public link will return in a single permission object.
-        # We therefore need to "explode" the permission sets into multiple permissions, one for each Audience.
-        permission_sets.flat_map(&:to_permissions)
+        permissions.each do
+          it.drive_item_id = drive_item_id
+        end
+
+        permissions
       end
     end
   end

data/lib/microslop_one_drive/permissions/base_permission.rb

@@ -0,0 +1,16 @@
+module MicroslopOneDrive
+  module Permissions
+    class BasePermission
+      attr_accessor :drive_item_id
+      attr_reader :id, :roles, :share_id, :link
+
+      def initialize(id:, roles:, share_id:, link:, drive_item_id: nil)
+        @id = id
+        @roles = roles
+        @share_id = share_id
+        @link = link
+        @drive_item_id = drive_item_id
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/permissions/direct_permission.rb

@@ -0,0 +1,13 @@
+module MicroslopOneDrive
+  module Permissions
+    class DirectPermission < MicroslopOneDrive::Permissions::BasePermission
+      # A direct permission is a permission that is granted to a specific user or group.
+      attr_reader :granted_to
+
+      def initialize(id:, roles:, share_id:, link:, granted_to:)
+        super(id: id, roles: roles, share_id: share_id, link: link)
+        @granted_to = granted_to
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/permissions/link.rb

@@ -0,0 +1,30 @@
+module MicroslopOneDrive
+  module Permissions
+    class Link
+      attr_reader :web_url, :scope, :type, :prevents_download
+
+      def initialize(web_url:, scope:, type:, prevents_download:)
+        @web_url = web_url
+        @scope = scope
+        @type = type
+        @prevents_download = prevents_download
+      end
+
+      def view_link?
+        type == "view"
+      end
+
+      def edit_link?
+        type == "edit"
+      end
+
+      def specific_people_link?
+        scope == "users"
+      end
+
+      def anonymous_link?
+        scope == "anonymous"
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/permissions/sharing_invitation.rb

@@ -0,0 +1,12 @@
+module MicroslopOneDrive
+  module Permissions
+    class SharingInvitation < MicroslopOneDrive::Permissions::BasePermission
+      # From https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online#sharing-invitations:
+      #
+      # > Permissions sent by the invite API may have additional information in the invitation facet. If an invitation
+      # > was sent to an email address that doesn't match a known account, the grantedTo property may not be set until
+      # > the invitation is redeemed, which occurs the first time the user clicks the link and signs in.
+      #
+    end
+  end
+end

data/lib/microslop_one_drive/permissions/sharing_link.rb

@@ -0,0 +1,43 @@
+module MicroslopOneDrive
+  module Permissions
+    class SharingLink < MicroslopOneDrive::Permissions::BasePermission
+      # From https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online#sharing-links:
+      #
+      # > Permissions with a link facet represent sharing links created on the item. These are the most common kinds of
+      # > permissions. Sharing links provide a unique URL that can be used to access a file or folder. They can be set
+      # > up to grant access in a variety of ways. For example, you can use the createLink API to create a link that
+      # > works for anyone signed into your organization, or you can create a link that works for anyone, without
+      # > needing to sign in. You can use the invite API to create a link that only works for specific people, whether
+      # > they're in your company or not.
+      #
+      # Concrete examples:
+      #   1. https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online#view-link
+      #   2. https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online#edit-link
+      #   3. https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online#specific-people-link
+      #
+      attr_reader :has_password, :granted_to_list
+
+      def initialize(id:, roles:, share_id:, link:, has_password:, granted_to_list:)
+        super(id: id, roles: roles, share_id: share_id, link: link)
+        @has_password = has_password
+        @granted_to_list = granted_to_list
+      end
+
+      def view_link?
+        link.view_link?
+      end
+
+      def edit_link?
+        link.edit_link?
+      end
+
+      def specific_people_link?
+        link.specific_people_link?
+      end
+
+      def anonymous_link?
+        link.anonymous_link?
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/user.rb

@@ -1,7 +1,7 @@
 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
+                :job_title, :office_location, :business_phones, :login_name
 
     def initialize(
       principal_name: nil,
@@ -14,7 +14,8 @@ module MicroslopOneDrive
       mobile_phone: nil,
       job_title: nil,
       office_location: nil,
-      business_phones: []
+      business_phones: [],
+      login_name: nil
     )
       @principal_name = principal_name
       @id = id
@@ -27,14 +28,19 @@ module MicroslopOneDrive
       @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
+      @mail
     end
 
     def last_name
-      surname
+      @surname
     end
   end
 end

data/lib/microslop_one_drive/version.rb

@@ -1,3 +1,3 @@
 module MicroslopOneDrive
-  VERSION = "4.1.0".freeze
+  VERSION = "5.0.0".freeze
 end

data/lib/microslop_one_drive.rb

@@ -11,6 +11,9 @@ 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
 require_relative "microslop_one_drive/file"
@@ -33,11 +36,13 @@ require_relative "microslop_one_drive/batch/response"
 require_relative "microslop_one_drive/user"
 require_relative "microslop_one_drive/parent_reference"
 require_relative "microslop_one_drive/drive"
-require_relative "microslop_one_drive/permission_set"
-require_relative "microslop_one_drive/permission"
-require_relative "microslop_one_drive/audience"
 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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microslop_one_drive
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Bradley Marques
@@ -33,13 +33,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/microslop_one_drive.rb
-- lib/microslop_one_drive/audience.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/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/link_deserializer.rb
 - lib/microslop_one_drive/deserializers/parent_reference_deserializer.rb
+- lib/microslop_one_drive/deserializers/permission_deserializer.rb
 - lib/microslop_one_drive/deserializers/quota_deserializer.rb
 - lib/microslop_one_drive/deserializers/shared_with_me_item_deserializer.rb
 - lib/microslop_one_drive/deserializers/user_deserializer.rb
@@ -66,8 +68,11 @@ files:
 - 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/permission.rb
-- lib/microslop_one_drive/permission_set.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/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

data/lib/microslop_one_drive/audience.rb

@@ -1,32 +0,0 @@
-module MicroslopOneDrive
-  class Audience
-    attr_reader :type, :id, :display_name, :email_address
-
-    def initialize(type:, id:, display_name:, email_address: nil)
-      @type = type
-      @id = id
-      @display_name = display_name
-      @email_address = email_address
-    end
-
-    # Converts a "siteUser" object into an OneDriveAudience object.
-    #
-    # A siteUser object looks like this:
-    #
-    # {
-    #   "displayName" => "Bob Bentley",
-    #   "email" => "bob@haikucode.dev",
-    #   "id" => "12",
-    #   "loginName" => "i:0#.f|membership|bob@haikucode.dev"
-    # }
-    #
-    def self.from_site_user(site_user)
-      new(
-        type: "user",
-        id: site_user.fetch("email"),
-        display_name: site_user.fetch("displayName"),
-        email_address: site_user.fetch("email")
-      )
-    end
-  end
-end

data/lib/microslop_one_drive/permission.rb

@@ -1,12 +0,0 @@
-module MicroslopOneDrive
-  class Permission
-    attr_reader :id, :drive_item_id, :role, :audience
-
-    def initialize(id:, drive_item_id:, role:, audience:)
-      @id = id
-      @drive_item_id = drive_item_id
-      @role = role
-      @audience = audience
-    end
-  end
-end

data/lib/microslop_one_drive/permission_set.rb

@@ -1,59 +0,0 @@
-module MicroslopOneDrive
-  class PermissionSet
-    attr_reader :id, :role, :audiences
-
-    def initialize(drive_item_id:, parsed_response:)
-      @drive_item_id = drive_item_id
-      @id = parsed_response.fetch("id", nil)
-      @role = build_role(parsed_response)
-      @audiences = build_audiences(parsed_response)
-    end
-
-    def to_permissions
-      @audiences.map { Permission.new(id: @id, drive_item_id: @drive_item_id, role: @role, audience: it) }
-    end
-
-    private
-
-    def build_role(parsed_response)
-      roles = parsed_response.fetch("roles", [])
-      roles.is_a?(Array) ? roles.first : roles
-    end
-
-    def build_audiences(parsed_response)
-      audiences = []
-
-      audiences += audiences_from_site_users(parsed_response)
-      audiences += audiences_from_anonymous_links(parsed_response)
-
-      audiences.compact
-    end
-
-    def audiences_from_site_users(parsed_response)
-      site_users = []
-      site_users += parsed_response.fetch("grantedToIdentitiesV2", []).flat_map { it.fetch("siteUser", nil) }
-      site_users << parsed_response.dig("grantedToV2", "siteUser")
-      site_users.compact!
-
-      site_users.map { Audience.from_site_user(it) }
-    end
-
-    def audiences_from_anonymous_links(parsed_response)
-      link = parsed_response.fetch("link", nil)
-      return [] if link.nil? || (link.respond_to?(:empty?) && link.empty?)
-
-      link_scope = link.fetch("scope", nil)
-
-      return [] unless link_scope == "anonymous" # I.e. an "anyone with the link" audience
-
-      [
-        Audience.new(
-          type: "anyone",
-          id: "anyone_with_the_link",
-          display_name: "Anyone with the link",
-          email_address: nil
-        )
-      ]
-    end
-  end
-end