sharepoint_api 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5551919c5f64298b80dc13b11ce01ac83414add68d5dc396cb9eb63c92d0f442
-  data.tar.gz: 02f98ff2506480e49310ceeefb041b8f5ca6d8099de499776307d765c0777e1d
+  metadata.gz: 7a9fa238166ddb188042912a71988869b1b443fa55ebd214be69bc6a139f52b4
+  data.tar.gz: db2dd49b85094a1235363c6d0cc6960722d7c4b7400b82d02ce2e1a2f4b44b8b
 SHA512:
-  metadata.gz: 520c21578a7fa4bde6c3e44a063782a2fb6d453ff74d0ad593e1f7d5eac005427ce6734de67858b174c315d4337a370d93342dd8ca5b7196456c9201b8273a88
-  data.tar.gz: dca7e0ad99915314213295fc60a7d83c6bf70bccded29fefdd55e57aad3717e9561acbc4939a7678e4153e37ac1fdd13d682a36bf44fbc014160a9373ce2df24
+  metadata.gz: 697f6dd8982e69879bf30fc086596803ee8198ae52f129286949cbcb728ca2d14491e9ec2416c77a44e380adf86dfbe9175d4c21973be4c1d5790d2324bd5b1c
+  data.tar.gz: e904aae5d3086713aec14cd31a486a1195822fa12d4e76a40e8a598dbf5468aa8d0a904d9469602354e62d2e345366998396fca3157a26cf17fe71d18bf19f92

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## [2.0.0] - 2021-01-12
+## [2.3.1] - 2021-11-02
+  * Add ability to rename groups
+
+## [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.
+
+## [2.0.0] - 2021-06-28
   * Update proof-sharepoint-ruby to escape apostrophes.
   * Change usage of apostrophe escaping.
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    sharepoint_api (2.0.0)
+    sharepoint_api (2.3.1)
       addressable (~> 2.7)
       proof-sharepoint-ruby (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     byebug (11.1.3)
@@ -120,4 +120,4 @@ DEPENDENCIES
   sharepoint_api!
 
 BUNDLED WITH
-   2.2.4
+   2.2.29

data/lib/sharepoint_api/file_info.rb

@@ -4,6 +4,31 @@ 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
+        Versions/Url
+      ].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 +70,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 +100,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

@@ -9,26 +9,19 @@ class SharepointApi
     def add_file(path, content)
       folder_path = File.dirname(path)
       file_name = encode_path(File.basename(path))
-      begin
-        retries ||= 0
-        FileInfo.wrap(
-          site.query(
-            :post,
-            "GetFolderByServerRelativeUrl('#{site_relative_path(folder_path)}')/Files" \
-            "/Add(overwrite=true,url='#{file_name}')",
-            content
-          )
+      FileInfo.wrap(
+        site.query(
+          :post,
+          "GetFolderByServerRelativeUrl('#{site_relative_path(folder_path)}')/Files" \
+          "/Add(overwrite=true,url='#{file_name}')?#{FileInfo::FILE_SELECT_QUERY}",
+          content
         )
-      rescue Sharepoint::SPException => e
-        reraise_if_lock_error(e)
-
-        log_as(__method__, e)
-        log_as(__method__, "adding folder with path #{folder_path}")
-        add_folder(folder_path)
-        retry if (retries += 1) < 2
-        log_as(__method__, e, level: :warn)
-        nil
-      end
+      )
+    rescue Sharepoint::SPException => e
+      reraise_if_lock_error(e)
+
+      log_as(__method__, e)
+      nil
     end
 
     def file_exists?(path)
@@ -39,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
@@ -117,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/permissions.rb

@@ -45,6 +45,22 @@ class SharepointApi
       false
     end
 
+    # to rename a sp group when the acronym changes
+    def rename_group(old_group_name, new_group_name)
+      escaped_group_name = encode_path(old_group_name)
+      site.query(:post, "SiteGroups/GetByName('#{escaped_group_name}')", {
+        '__metadata' => { 'type': 'SP.Group' },
+        'Title' => new_group_name,
+        'Description' => "Access Group for #{new_group_name}"
+      }.to_json) do |curl|
+        curl.headers['X-HTTP-Method'] = 'MERGE'
+      end
+      true
+    rescue Sharepoint::SPException => e
+      log_as(__method__, e)
+      false
+    end
+
     ##
     # This also removes any role definitions the groups is using.
     def remove_group(group_name)

data/lib/sharepoint_api/version.rb

@@ -1,3 +1,3 @@
 class SharepointApi
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.3.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sharepoint_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Andrew Kalek
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable