sharepoint_api 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e03f01804cbcdcbe4ab35aa6073790f1a57b1500438930c3b48107a4745416
-  data.tar.gz: 7e38e7750fc347cbf61f6fa51bd543cb7614151c718b81d2c48f4953a2f5dae2
+  metadata.gz: eac6402d99bf11213a9a8edc411745d2056ec8ffd3846f5579b91e3383709515
+  data.tar.gz: ef5281daee7e600d3a67a480c561e76779eff8fcb4e8bec8005894500dc43361
 SHA512:
-  metadata.gz: 8c2a532ddd27e3e66d6bc43631e8598a4c868b5dca7f0ff5a4041ebf8d742853da41dc100b1586e37c78d2d6313d48e993ee1a391cd063772d798703796b1398
-  data.tar.gz: dccd4a1f20f644860ecc8a23112987ceaba68474cfbbc7d389dea5a71631e9d4a06ae73a2ade777f1596d9744aa7e0e3931e3c007cd66f6f64245dba710f20aa
+  metadata.gz: 5f3a17b7be2e3a31b9d45f26d407750979d6d2d9946e5b5c46030eb9d49f06a3c02557bcfc926ddb6277828fe962920780d9cca5dc67465b6bea5267ec27c113
+  data.tar.gz: ce320268dcc75d3348bab171a58874e075590bbb2a2e2e49c86a05d6bcbaea1568b3f832732506fe9c17f35fefb7ffbf99705c509e63079070dbd6f6538f2c9c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [2.2.0] - 2021-07-06
+  * Use $select queries to vastly speed up FileInfo#version lookup.
+
 ## [2.1.0] - 2021-07-06
   * Drop feature of add_file creating a folder if one didn't exist as it introduced a security issue where a folder could be created that didn't have access restricted to routing participants.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sharepoint_api (2.1.0)
+    sharepoint_api (2.2.0)
       addressable (~> 2.7)
       proof-sharepoint-ruby (~> 2.0)
 

data/lib/sharepoint_api/file_info.rb

@@ -4,6 +4,30 @@ class SharepointApi
   class FileInfo
     class FileInfoError < SharepointError; end
 
+    ##
+    # Get all data required to build a FileInfo object without subsequent API calls.
+    FILE_SELECT_QUERY_WITH_VERSIONS = begin
+      sub_query = %w[
+        ModifiedBy/LoginName
+        ListItemAllFields/Id
+        Versions/Id
+        Versions/Created
+        Versions/IsCurrentVersion
+        Versions/CreatedBy/LoginName
+      ].join(',')
+      "$select=Name,UpdatedAt,MajorVersion,TimeLastModified,#{sub_query}&$expand=#{sub_query}"
+    end.freeze
+
+    ##
+    # Get just enough data to build a FileInfo object that suports to_h
+    FILE_SELECT_QUERY = begin
+      sub_query = %w[
+        ModifiedBy/LoginName
+        ListItemAllFields/Id
+      ].join(',')
+      "$select=Name,UpdatedAt,MajorVersion,TimeLastModified,Versions,#{sub_query}&$expand=#{sub_query}"
+    end.freeze
+
     extend Forwardable
     attr_reader :version, :version_id, :file, :updated_at
 
@@ -45,7 +69,7 @@ class SharepointApi
           file_version.id,
           created_at: Time.parse(file_version.created),
           current: file_version.is_current_version,
-          creator_login: file_version.creator&.login_name
+          creator_login: safe_created_by(file_version)&.login_name
         )
       end
 
@@ -75,5 +99,16 @@ class SharepointApi
 
       raise(FileInfoError, e.message)
     end
+
+    def safe_created_by(file_version)
+      return file_version.creator if file_version.data['CreatedBy']['__deferred']
+      return file_version.created_by if file_version.data['CreatedBy']['__metadata']
+
+      nil
+    rescue Sharepoint::SPException => e
+      return nil if e.message =~ /User cannot be found/
+
+      raise(FileInfoError, e.message)
+    end
   end
 end

data/lib/sharepoint_api/file_system.rb

@@ -13,7 +13,7 @@ class SharepointApi
         site.query(
           :post,
           "GetFolderByServerRelativeUrl('#{site_relative_path(folder_path)}')/Files" \
-          "/Add(overwrite=true,url='#{file_name}')",
+          "/Add(overwrite=true,url='#{file_name}')?#{FileInfo::FILE_SELECT_QUERY}",
           content
         )
       )
@@ -32,11 +32,18 @@ class SharepointApi
       false
     end
 
+    ##
+    # Querying a non-existent file will raise a 500 error so we check for existence first.
     def find_file(path)
+      return nil unless file_exists?(path)
+
       server_path = server_relative_path(path)
-      FileInfo.wrap(
-        site.query(:get, "GetFileByServerRelativeUrl('#{server_path}')")
-      )
+      result = site.query(:get, "GetFileByServerRelativeUrl('#{server_path}')?#{FileInfo::FILE_SELECT_QUERY_WITH_VERSIONS}", nil, true)
+      result = JSON.parse(result)
+      result['d']['Versions'] = Sharepoint::Site.make_object_from_response(site, { 'd' => result['d']['Versions'] })
+      file = Sharepoint::Site.make_object_from_response(site, result)
+
+      FileInfo.wrap(file)
     rescue Sharepoint::SPException => e
       log_as(__method__, e)
       nil
@@ -110,8 +117,14 @@ class SharepointApi
 
     def files_in_folder(path)
       server_path = server_relative_path(path)
-      site.query(:get, "GetFolderByServerRelativeUrl('#{server_path}')/Files").
-        map { |file| FileInfo.new(file) }
+      result = site.query(:get, "GetFolderByServerRelativeUrl('#{server_path}')/Files?#{FileInfo::FILE_SELECT_QUERY_WITH_VERSIONS}", nil, true)
+      result = JSON.parse(result)
+      result.dig('d', 'results')&.map do |file_result|
+        file_result['Versions'] = Sharepoint::Site.make_object_from_response(site, { 'd' => file_result['Versions'] })
+      end
+      files = Sharepoint::Site.make_object_from_response(site, result)
+
+      files.map { |file| FileInfo.new(file) }
     rescue Sharepoint::SPException => e
       log_as(__method__, e)
       nil

data/lib/sharepoint_api/version.rb

@@ -1,3 +1,3 @@
 class SharepointApi
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sharepoint_api
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Andrew Kalek