microslop_one_drive 2.2.0 → 3.0.0

data/lib/microslop_one_drive/drive.rb

@@ -1,18 +1,48 @@
 module MicroslopOneDrive
   class Drive
-    attr_reader :id, :name, :description, :url, :drive_type, :created_at, :updated_at
+    attr_reader :id, :name, :description, :web_url, :drive_type, :created_date_time, :last_modified_date_time,
+                :created_by, :last_modified_by, :owner, :quota
 
-    def initialize(drive_hash)
-      @drive_hash = drive_hash
+    def initialize(
+      id:,
+      name:,
+      description:,
+      web_url:,
+      drive_type:,
+      created_date_time:,
+      last_modified_date_time:,
+      created_by:,
+      last_modified_by:,
+      owner:,
+      quota:
+    )
+      @id = id
+      @name = name
+      @description = description
+      @web_url = web_url
+      @drive_type = drive_type
+      @created_date_time = created_date_time
+      @last_modified_date_time = last_modified_date_time
+      @created_by = created_by
+      @last_modified_by = last_modified_by
+      @owner = owner
+      @quota = quota
+    end
+
+    def created_at
+      @created_date_time
+    end
 
-      @id = drive_hash.fetch("id", nil)
-      @name = drive_hash.fetch("name", nil)
-      @description = drive_hash.fetch("description", nil)
-      @url = drive_hash.fetch("webUrl", nil)
-      @drive_type = drive_hash.fetch("driveType", nil)
+    def updated_at
+      @last_modified_date_time
+    end
+
+    def url
+      @web_url
+    end
 
-      @created_at = Utils.safe_parse_time(drive_hash.fetch("createdDateTime", nil))
-      @updated_at = Utils.safe_parse_time(drive_hash.fetch("lastModifiedDateTime", nil))
+    def updated_by
+      @last_modified_by
     end
   end
 end

data/lib/microslop_one_drive/drive_item.rb

@@ -4,53 +4,70 @@ module MicroslopOneDrive
 
     attr_reader :id,
                 :name,
-                :created_at,
-                :updated_at,
-                :url,
+                :download_url,
+                :web_url,
                 :size,
+                :created_date_time,
+                :last_modified_date_time,
+                :e_tag,
+                :c_tag,
                 :file_or_folder,
-                :parent_id,
                 :mime_type,
-                :parent,
-                :children,
-                :path,
-                :full_path
-
-    def initialize(item_hash)
-      @item_hash = item_hash
-
-      @id = @item_hash.fetch("id", nil)
-      @name = @item_hash.fetch("name", nil)
-      @url = @item_hash.fetch("webUrl", nil)
-      @size = @item_hash.fetch("size", nil)
-
-      @created_at = Utils.safe_parse_time(@item_hash.fetch("createdDateTime", nil))
-      @updated_at = Utils.safe_parse_time(@item_hash.fetch("lastModifiedDateTime", nil))
-
-      if @item_hash.key?("file")
-        @file_or_folder = :file
-        @mime_type = @item_hash.dig("file", "mimeType")
-      elsif @item_hash.key?("folder")
-        @file_or_folder = :folder
-        @mime_type = DIRECTORY_MIME_TYPE
-      end
-
-      @parent_id = @item_hash.dig("parentReference", "id")
-
-      @deleted = @item_hash.dig("deleted", "state") == "deleted"
+                :parent_reference,
+                :is_deleted,
+                :is_shared,
+                :full_path,
+                :path
+
+    def initialize(
+      id:,
+      name:,
+      download_url:,
+      web_url:,
+      size:,
+      created_date_time:,
+      last_modified_date_time:,
+      e_tag:,
+      c_tag:,
+      file_or_folder:,
+      mime_type:,
+      parent_reference:,
+      is_deleted:,
+      is_shared:
+    )
+      @id = id
+      @name = name
+      @download_url = download_url
+      @web_url = web_url
+      @size = size
+      @created_date_time = created_date_time
+      @last_modified_date_time = last_modified_date_time
+      @e_tag = e_tag
+      @c_tag = c_tag
+      @file_or_folder = file_or_folder
+      @mime_type = mime_type
+      @parent_reference = parent_reference
+      @is_deleted = is_deleted
+      @is_shared = is_shared
+
+      @full_path = build_full_path
+      @path = build_path(@full_path)
+    end
 
-      @path = build_path
+    def created_at
+      @created_date_time
+    end
 
-      @parent = nil
-      @children = []
+    def updated_at
+      @last_modified_date_time
     end
 
     def deleted?
-      @deleted
+      @is_deleted
     end
 
     def shared?
-      @item_hash.key?("shared")
+      @is_shared
     end
 
     def file?
@@ -61,39 +78,20 @@ module MicroslopOneDrive
       @file_or_folder == :folder
     end
 
-    def set_parent(parent)
-      if @parent
-        @parent.remove_child(self)
-      end
-
-      @parent = parent
-      @parent.add_child(self)
-    end
-
-    def is_root?
-      @item_hash.key?("root")
+    def root?
+      false
     end
 
-    protected
+    def build_full_path
+      return nil if parent_reference&.path.nil? || name.nil?
 
-    def add_child(child)
-      @children << child
+      ::File.join(parent_reference.path, name)
     end
 
-    def remove_child(child)
-      @children.delete(child)
-    end
-
-    private
-
-    def build_path
-      return "root:" if is_root?
-
-      full_parent_path = @item_hash.dig("parentReference", "path")
-      return nil if full_parent_path.nil?
+    def build_path(full_path)
+      return "" if full_path.nil?
 
-      full_path_with_name = File.join(full_parent_path, @name)
-      full_path_with_name.sub(/\A.*root:\//, "root:/")
+      full_path.gsub(%r{\A/?drive/root:/?}, "").chomp("/")
     end
   end
 end

data/lib/microslop_one_drive/file.rb

@@ -0,0 +1,13 @@
+require "microslop_one_drive/drive_item"
+
+module MicroslopOneDrive
+  class File < DriveItem
+    def folder?
+      false
+    end
+
+    def file?
+      true
+    end
+  end
+end

data/lib/microslop_one_drive/folder.rb

@@ -0,0 +1,13 @@
+require "microslop_one_drive/drive_item"
+
+module MicroslopOneDrive
+  class Folder < DriveItem
+    def folder?
+      true
+    end
+
+    def file?
+      false
+    end
+  end
+end

data/lib/microslop_one_drive/list_responses/drive_item_list.rb

@@ -0,0 +1,21 @@
+module MicroslopOneDrive
+  module ListResponses
+    class DriveItemList < ListResponse
+      attr_reader :items
+
+      def initialize(parsed_response)
+        super
+
+        @items = build_items(parsed_response)
+      end
+
+      private
+
+      def build_items(parsed_response)
+        parsed_response.fetch("value", []).map do
+          MicroslopOneDrive::Deserializers::DriveItemDeserializer.create_from_hash(it)
+        end
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/list_responses/drive_list.rb

@@ -0,0 +1,15 @@
+module MicroslopOneDrive
+  module ListResponses
+    class DriveList < ListResponse
+      attr_reader :drives
+
+      def initialize(response_hash)
+        super
+
+        @drives = response_hash.fetch("value", []).map do
+          MicroslopOneDrive::Deserializers::DriveDeserializer.create_from_hash(it)
+        end
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/list_responses/list_response.rb

@@ -0,0 +1,21 @@
+module MicroslopOneDrive
+  module ListResponses
+    class ListResponse
+      attr_reader :next_link, :next_token, :delta_link, :delta_token, :context
+
+      def initialize(response_hash)
+        @context = response_hash.fetch("@odata.context", nil)
+
+        @next_link = response_hash.fetch("@odata.nextLink", nil)
+        @next_token = @next_link.split("?token=").last if @next_link && !@next_link.empty?
+
+        @delta_link = response_hash.fetch("@odata.deltaLink", nil)
+        @delta_token = @delta_link.split("?token=").last if @delta_link && !@delta_link.empty?
+      end
+
+      def next_page?
+        !next_link.nil?
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/list_responses/permission_list.rb

@@ -0,0 +1,27 @@
+module MicroslopOneDrive
+  module ListResponses
+    class PermissionList < ListResponse
+      attr_reader :permissions
+
+      def initialize(drive_item_id:, parsed_response:)
+        super(parsed_response)
+
+        @permissions = build_permissions(drive_item_id, parsed_response)
+      end
+
+      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)
+        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)
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/list_responses/shared_with_me_list.rb

@@ -0,0 +1,15 @@
+module MicroslopOneDrive
+  module ListResponses
+    class SharedWithMeList < ListResponse
+      attr_reader :shared_with_me_items
+
+      def initialize(response_hash)
+        super
+
+        @shared_with_me_items = response_hash.fetch("value", []).map do
+          MicroslopOneDrive::Deserializers::SharedWithMeItemDeserializer.create_from_hash(it)
+        end
+      end
+    end
+  end
+end

data/lib/microslop_one_drive/parent_reference.rb

@@ -0,0 +1,14 @@
+module MicroslopOneDrive
+  class ParentReference
+    attr_reader :drive_type, :drive_id, :id, :name, :path, :site_id
+
+    def initialize(drive_type:, drive_id:, id:, name:, path:, site_id:)
+      @drive_type = drive_type
+      @drive_id = drive_id
+      @id = id
+      @name = name
+      @path = path
+      @site_id = site_id
+    end
+  end
+end

data/lib/microslop_one_drive/permission_set.rb

@@ -3,12 +3,10 @@ module MicroslopOneDrive
     attr_reader :id, :role, :audiences
 
     def initialize(drive_item_id:, parsed_response:)
-      @parsed_response = parsed_response
-
       @drive_item_id = drive_item_id
-      @id = @parsed_response.fetch("id", nil)
-      @role = build_role
-      @audiences = build_audiences
+      @id = parsed_response.fetch("id", nil)
+      @role = build_role(parsed_response)
+      @audiences = build_audiences(parsed_response)
     end
 
     def to_permissions
@@ -17,31 +15,31 @@ module MicroslopOneDrive
 
     private
 
-    def build_role
-      roles = @parsed_response.fetch("roles", [])
+    def build_role(parsed_response)
+      roles = parsed_response.fetch("roles", [])
       roles.is_a?(Array) ? roles.first : roles
     end
 
-    def build_audiences
+    def build_audiences(parsed_response)
       audiences = []
 
-      audiences += audiences_from_site_users
-      audiences += audiences_from_anonymous_links
+      audiences += audiences_from_site_users(parsed_response)
+      audiences += audiences_from_anonymous_links(parsed_response)
 
       audiences.compact
     end
 
-    def audiences_from_site_users
+    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 += 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
-      link = @parsed_response.fetch("link", nil)
+    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)

data/lib/microslop_one_drive/quota.rb

@@ -0,0 +1,14 @@
+module MicroslopOneDrive
+  class Quota
+    attr_reader :deleted, :remaining, :state, :total, :used, :upgrade_available
+
+    def initialize(deleted:, remaining:, state:, total:, used:, upgrade_available:)
+      @deleted = deleted
+      @remaining = remaining
+      @state = state
+      @total = total
+      @used = used
+      @upgrade_available = upgrade_available
+    end
+  end
+end

data/lib/microslop_one_drive/root_folder.rb

@@ -0,0 +1,13 @@
+require "microslop_one_drive/folder"
+
+module MicroslopOneDrive
+  class RootFolder < Folder
+    def root?
+      true
+    end
+
+    def build_full_path
+      "/drive/root:"
+    end
+  end
+end

data/lib/microslop_one_drive/shared_with_me_item.rb

@@ -0,0 +1,44 @@
+module MicroslopOneDrive
+  class SharedWithMeItem
+    attr_reader :id, :name, :web_url, :size, :last_modified_date_time, :created_date_time, :created_by,
+                :last_modified_by, :remote_item
+
+    def initialize(
+      id:,
+      name:,
+      web_url:,
+      size:,
+      last_modified_date_time:,
+      created_date_time:,
+      created_by:,
+      last_modified_by:,
+      remote_item:
+    )
+      @id = id
+      @name = name
+      @web_url = web_url
+      @size = size
+      @last_modified_date_time = last_modified_date_time
+      @created_date_time = created_date_time
+      @created_by = created_by
+      @last_modified_by = last_modified_by
+      @remote_item = remote_item
+    end
+
+    def created_at
+      @created_date_time
+    end
+
+    def updated_at
+      @last_modified_date_time
+    end
+
+    def url
+      @web_url
+    end
+
+    def updated_by
+      @last_modified_by
+    end
+  end
+end

data/lib/microslop_one_drive/user.rb

@@ -1,12 +1,40 @@
 module MicroslopOneDrive
   class User
-    attr_reader :email_address, :display_name
+    attr_reader :principal_name, :id, :display_name, :surname, :given_name, :preferred_language, :mail, :mobile_phone,
+                :job_title, :office_location, :business_phones
 
-    def initialize(user_hash)
-      @user_hash = user_hash
+    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: []
+    )
+      @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
+    end
+
+    def email_address
+      mail
+    end
 
-      @email_address = @user_hash.fetch("mail", nil)
-      @display_name = @user_hash.fetch("displayName", nil)
+    def last_name
+      surname
     end
   end
 end

data/lib/microslop_one_drive/utils.rb

@@ -2,6 +2,16 @@ require "time"
 
 module MicroslopOneDrive
   module Utils
+    def self.deep_symbolize_keys(hash)
+      hash.transform_keys(&:to_sym).transform_values do
+        case it
+        when Hash then deep_symbolize_keys(it)
+        when Array then it.map { it.is_a?(Hash) ? deep_symbolize_keys(it) : it }
+        else it
+        end
+      end
+    end
+
     def self.safe_parse_time(value)
       return nil if value.nil? || value.to_s.strip.empty?
 

data/lib/microslop_one_drive/version.rb

@@ -1,3 +1,3 @@
 module MicroslopOneDrive
-  VERSION = "2.2.0"
+  VERSION = "3.0.0".freeze
 end

data/lib/microslop_one_drive.rb

@@ -3,17 +3,42 @@ require "json"
 
 require_relative "microslop_one_drive/version"
 require_relative "microslop_one_drive/utils"
-require_relative "microslop_one_drive/errors/client_error"
+
+# 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"
+
+# Drive items
+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_response"
-require_relative "microslop_one_drive/drive_list"
+require_relative "microslop_one_drive/parent_reference"
 require_relative "microslop_one_drive/drive"
-require_relative "microslop_one_drive/drive_item"
-require_relative "microslop_one_drive/drive_item_list"
-require_relative "microslop_one_drive/permission_list"
 require_relative "microslop_one_drive/permission_set"
 require_relative "microslop_one_drive/permission"
 require_relative "microslop_one_drive/audience"
-require_relative "microslop_one_drive/batch_response"
-require_relative "microslop_one_drive/response"
+require_relative "microslop_one_drive/quota"
+require_relative "microslop_one_drive/shared_with_me_item"
+
+# Client
+require_relative "microslop_one_drive/errors/client_error"
 require_relative "microslop_one_drive/client"