sharepoint_api 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8c46ee759a2cb1b84211e88137406512de21a48a4a759d109097c54273259f
-  data.tar.gz: 444dbfaee8eff930e0a030ad5cb5450cedc71268eb0ff05ab346af8297c032c9
+  metadata.gz: a6e03f01804cbcdcbe4ab35aa6073790f1a57b1500438930c3b48107a4745416
+  data.tar.gz: 7e38e7750fc347cbf61f6fa51bd543cb7614151c718b81d2c48f4953a2f5dae2
 SHA512:
-  metadata.gz: e1f6ff11efc7b37027928325908e1b05cb5318d1ff4f84fb0a0a10b2253544e54606c7c7043ea1d40257469443412dddebb268629a9cd118331fa4453702b5cb
-  data.tar.gz: 9f7b3f87f4eaeaf4271a4266ae5f4a054805a5967c471bffde71ca10649e099ce917db9c1aede8e3d8e8dd099ce091f510149ef110a0df3276cf1189bb505b55
+  metadata.gz: 8c2a532ddd27e3e66d6bc43631e8598a4c868b5dca7f0ff5a4041ebf8d742853da41dc100b1586e37c78d2d6313d48e993ee1a391cd063772d798703796b1398
+  data.tar.gz: dccd4a1f20f644860ecc8a23112987ceaba68474cfbbc7d389dea5a71631e9d4a06ae73a2ade777f1596d9744aa7e0e3931e3c007cd66f6f64245dba710f20aa

data/.pryrc

@@ -0,0 +1,46 @@
+#!/usr/env/bin ruby
+
+# user = `echo "$USER"`.strip
+class ProgrammerError < StandardError; end
+
+if defined?(Pry)
+  Pry.config.editor = 'vim'
+
+  # Hit enter to repeat the last command.
+  Pry::Commands.command(/^$/, 'Repeat last command.') do
+    pry_instance.run_command Pry.history.to_a.last
+  end
+
+  Pry::Commands.command('args', 'Display local variables.') do
+    pry_instance.run_command 'ls -l'
+  end
+
+  Pry.commands.alias_command 'ss', 'show-source'
+  Pry.commands.alias_command 'q', 'quit'
+  Pry.commands.alias_command 'w', 'whereami'
+  Pry.commands.alias_command 'r', 'reload-code'
+  Pry.commands.alias_command 'ed', 'edit'
+  Pry.commands.alias_command 'ec', 'edit -c' # open current file in editor
+end
+
+if defined?(PryByebug)
+  Pry.commands.alias_command 'b', 'backtrace'
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 's', 'step'
+end
+
+class String
+  def gitize
+    gsub(/\W+$/, ''). # kill trailing whitespace
+      gsub(/\W+/, '-'). # replace whitespace with -
+      gsub(/([A-Z])/, '-\1'). # prepend dash to capitals
+      gsub(/^-/, ''). # strip leading dash
+      gsub(/-+/, '-'). # compress multiple dashes to a single dash
+      downcase
+  end
+
+  def prize
+    gsub(/\W+$/, '').gsub(/\W+/, ' ').gsub(/\b(?<!['’`])[a-z]/, &:capitalize)
+  end
+end

data/CHANGELOG.md

@@ -1,2 +1,18 @@
+## [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.
+
+## [1.0.3] - 2021-01-12
+  * Handle edge case where FileInfo file#modified_by refers to a user that no longer exists.
+
+## [1.0.2] - 2021-01-04
+  * Handle edge case where FileInfo file/file version refers to a user that no longer exists.
+
+## [1.0.1] - 2020-12-14
+  * Added new method called fetch_role_assignments => allows a user to get all the current role assignments on a SharePoint folder
+
 ## [1.0.0] - 2020-12-07
   * Initial Release

data/Gemfile

@@ -5,9 +5,14 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in sharepoint_api.gemspec
 gemspec
 
-gem 'faker'
+gem 'faker', '~> 2.15'
+gem 'guard', '~> 2.16'
+gem 'guard-rspec', '~> 4.7'
+gem 'pry', '~> 0.13.1'
+gem 'pry-byebug', '~> 3.9'
+gem 'pry-rescue', '~> 1.5'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.6'
-gem 'rspec-collection_matchers'
+gem 'rspec-collection_matchers', '~> 1.2'
 gem 'rubocop', '~> 1.5'
 gem 'rubocop-rspec', '~> 2.0'

data/Gemfile.lock

@@ -1,31 +1,71 @@
 PATH
   remote: .
   specs:
-    SharepointApi (0.1.0)
+    sharepoint_api (2.1.0)
       addressable (~> 2.7)
-      proof-sharepoint-ruby (~> 1.0)
+      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)
+    coderay (1.1.3)
     concurrent-ruby (1.1.7)
     curb (0.9.10)
     diff-lcs (1.4.4)
     faker (2.15.1)
       i18n (>= 1.6, < 2)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    interception (0.5)
+    listen (3.4.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
-    proof-sharepoint-ruby (1.0.0)
+    proof-sharepoint-ruby (2.0.0)
       curb (~> 0.8, <= 0.9.10)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    pry-rescue (1.5.2)
+      interception (>= 0.5)
+      pry (>= 0.12.0)
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.0.0)
     rexml (3.2.4)
     rspec (3.10.0)
@@ -58,19 +98,26 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
     unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  SharepointApi!
-  faker
+  faker (~> 2.15)
+  guard (~> 2.16)
+  guard-rspec (~> 4.7)
+  pry (~> 0.13.1)
+  pry-byebug (~> 3.9)
+  pry-rescue (~> 1.5)
   rake (~> 13.0)
   rspec (~> 3.6)
-  rspec-collection_matchers
+  rspec-collection_matchers (~> 1.2)
   rubocop (~> 1.5)
   rubocop-rspec (~> 2.0)
+  sharepoint_api!
 
 BUNDLED WITH
-   1.17.2
+   2.2.4

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'echo -e "\033c"; bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -22,7 +22,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+With the appropriate environmental variables set run this in a ruby console.
+Run `bin/console` (after running `bundle install`) to get a pre-loaded ruby console.
+
+```ruby
+load 'lib/sharepoint_api.rb'
+
+api = SharepointApi.new(
+  host: ENV['SHAREPOINT_HOST'],
+  site_name: ENV['SHAREPOINT_SITE'],
+  library_name: ENV['SHAREPOINT_LIBRARY_NAME'],
+  username: ENV['SHAREPOINT_USERNAME'],
+  password: ENV['SHAREPOINT_PASSWORD'],
+  ntlm: true # for SharePoint 2013, false otherwise
+)
+
+api.fetch_content_types # or whatever method you want to test.
+```
 
 ## Development
 
@@ -30,11 +46,20 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+> NOTE: run `bundle install` and commit the changes to the Gemfile.lock before deploying a new version.
+
+## Testing
+
+Start the test suite watcher:
+`bundle exec guard`
+
+Run the tests for just one file just enter the filename in the Guard console.
+`spec/sharepoint_api/items_spec.rb`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/anlek/sharepoint_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/anlek/sharepoint_api/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -7,8 +7,8 @@ require "sharepoint_api"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/docs/pull_request_template.md

@@ -0,0 +1,38 @@
+[XXXXX](https://proof-tech.atlassian.net/browse/XXXXX)
+
+### Overview
+
+Please include a summary of the changes in this pull request.
+List any dependencies that are required before this change is applied.
+
+### Solution
+
+How did you solve the problem?
+Call out any particular implementation choices or design decisions you made
+
+### Screenshots
+
+[insert screenshots here]
+
+### Testing Instructions
+
+Describe, for your colleagues, how they can test your code locally on their system
+
+### Pre-Merge Checklist
+
+- [ ] I have updated the version and changelog in a different PR than bug fixes and features.
+- [ ] The work here reflects the user stories in the JIRA ticket(s) listed at the top of this pull request
+- [ ] This pull request has been referenced via URL in the JIRA ticket(s) listed
+- [ ] I have performed a self-review of the code I have written here
+- [ ] I have done end-to-end QA testing of sections of the code I have altered
+- [ ] My changes generate no new warnings / errors in the console
+- [ ] I have written/updated Ruby tests for the areas of the code base that I have modified
+- [ ] I am prepared for this code to go to production today (or there is a WIP label on the pull request)
+- [ ] I am prepared to write hotfixes or rollback my code if something goes wrong
+
+### Gem Deployment Instructions
+
+1. `bundle exec rake install`
+2. `bundle exec rake release`
+
+Reminder that deploy instructions are in the [here](https://github.com/proofgov/sharepoint_api#development).

data/lib/sharepoint_api.rb

@@ -62,11 +62,11 @@ class SharepointApi
     @site = build_connection
   end
 
-  def site_relative_path(path, preview: false)
+  def site_relative_path(path, safe_quote: true)
     file_path = [
       library_name, path
-    ].reject{ |p| p.nil? || p == '' }.join('/')
-    encode_path(file_path, preview: preview)
+    ].reject { |p| p.nil? || p == '' }.join('/')
+    encode_path(file_path, safe_quote: safe_quote)
   end
 
   def server_relative_path(path)
@@ -81,9 +81,9 @@ class SharepointApi
     "#{protocol}://#{host}/#{site_path}"
   end
 
-  def encode_path(path, preview: false)
+  def encode_path(path, safe_quote: true)
     path = Addressable::URI.encode(path)
-    path.gsub!(/'/, '%27%27') unless preview
+    path.gsub!(/'/, '%27%27') if safe_quote
     path.gsub!('+', '%2B')
     path
   end

data/lib/sharepoint_api/file_info.rb

@@ -1,5 +1,9 @@
+require_relative 'sharepoint_error'
+
 class SharepointApi
   class FileInfo
+    class FileInfoError < SharepointError; end
+
     extend Forwardable
     attr_reader :version, :version_id, :file, :updated_at
 
@@ -31,7 +35,7 @@ class SharepointApi
         version_id,
         created_at: updated_at,
         current: true,
-        creator_login: file.modified_by.login_name
+        creator_login: safe_modified_by(file)&.login_name
       )
 
       return @all_versions unless version > 1
@@ -41,7 +45,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: file_version.creator&.login_name
         )
       end
 
@@ -63,5 +67,13 @@ class SharepointApi
         **attrs
       )
     end
+
+    def safe_modified_by(file)
+      file.modified_by
+    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}')",
+          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)

data/lib/sharepoint_api/items.rb

@@ -29,8 +29,8 @@ class SharepointApi
         "Lists/GetByTitle('#{encoded_name}')/ContentTypes?" \
         '$select=Name,StringId'
       )
-      response.map { |type| type.data.except('__metadata') }
-    rescue Sharepoint::SPException => e
+      response.map { |content_type| reject_metadata(content_type.data) }
+    rescue Sharepoint::SharepointError => e
       log_as(__method__, e)
 
       nil
@@ -67,5 +67,9 @@ class SharepointApi
       log_as(__method__, error, level: :warn)
       raise(LockError, error.message)
     end
+
+    def reject_metadata(data)
+      data.reject { |key| key == '__metadata' }
+    end
   end
 end

data/lib/sharepoint_api/permissions.rb

@@ -97,6 +97,36 @@ class SharepointApi
       false
     end
 
+    def fetch_role_assignments(path, principal_id: nil)
+      server_path = server_relative_path(path)
+      list_item_path = "GetFolderByServerRelativeUrl('#{server_path}')/ListItemAllFields"
+      query = '$expand=Member,RoleDefinitionBindings&$select=RoleDefinitionBindings/Name&$select=RoleDefinitionBindings/Id,PrincipalId,Member/LoginName'
+
+      unless principal_id.nil?
+        principal_filter = encode_path("PrincipalId eq #{principal_id}")
+        query += "&$filter=#{principal_filter}"
+      end
+
+      response = site.query(:get, "#{list_item_path}/RoleAssignments?#{query}")
+
+      formatted = response.map do |assignment|
+        data = assignment.data
+
+        current_roles = data['RoleDefinitionBindings']['results'].map { |rdb| { role_id: rdb['Id'], role_name: rdb['Name'] } }
+
+        {
+          login_name: data['Member']['LoginName'],
+          principal_id: data['PrincipalId'],
+          roles: current_roles
+        }
+      end
+
+      principal_id.nil? ? formatted : formatted.first
+    rescue Sharepoint::SPException => e
+      log_as(__method__, e)
+      false
+    end
+
     ##
     # Alternate version would be:
     # def add_role_assignment(library_guid:, list_item_id:, principal_id:, role_id:)

data/lib/sharepoint_api/version.rb

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

data/sharepoint_api.gemspec

@@ -3,8 +3,8 @@ require_relative 'lib/sharepoint_api/version'
 Gem::Specification.new do |spec|
   spec.name          = 'sharepoint_api'
   spec.version       = SharepointApi::VERSION
-  spec.authors       = ['Andrew Kalek', 'Marlen Brunner']
-  spec.email         = ['akalek@proofgov.com', 'mbrunner@proofgov.com']
+  spec.authors       = ['Andrew Kalek', 'Marlen Brunner', 'Danella Olsen']
+  spec.email         = ['akalek@proofgov.com', 'mbrunner@proofgov.com', 'dolsen@proofgov.com']
 
   spec.summary       = 'SharepointApi allows you to interact with sharepoint in a simpler DSL.'
   spec.description   = 'A tool to make it easier to talk to sharepoint (via the proof-sharepoint-ruby gem)'
@@ -16,16 +16,16 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/proofgov/sharepoint_api'
   spec.metadata['changelog_uri'] = 'https://github.com/proofgov/sharepoint_api/blob/master/CHANGELOG.md'
 
-  spec.add_runtime_dependency('proof-sharepoint-ruby', '~> 1.0')
   spec.add_runtime_dependency('addressable', '~> 2.7')
+  spec.add_runtime_dependency('proof-sharepoint-ruby', '~> 2.0')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 
   spec.require_paths = ['lib']
 end

metadata

@@ -1,65 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: sharepoint_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrew Kalek
 - Marlen Brunner
+- Danella Olsen
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: proof-sharepoint-ruby
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: proof-sharepoint-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.0'
 description: A tool to make it easier to talk to sharepoint (via the proof-sharepoint-ruby
   gem)
 email:
 - akalek@proofgov.com
 - mbrunner@proofgov.com
-executables: []
+- dolsen@proofgov.com
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".pryrc"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docs/pull_request_template.md
 - lib/sharepoint_api.rb
 - lib/sharepoint_api/file_info.rb
 - lib/sharepoint_api/file_system.rb
@@ -93,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: SharepointApi allows you to interact with sharepoint in a simpler DSL.