sharepoint_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8c46ee759a2cb1b84211e88137406512de21a48a4a759d109097c54273259f
-  data.tar.gz: 444dbfaee8eff930e0a030ad5cb5450cedc71268eb0ff05ab346af8297c032c9
+  metadata.gz: d375981d2a55b77a670835c5c1af3f72226c219c41fdf41ecc0acd97f130a625
+  data.tar.gz: fbc8130aed3705b7d69355de908cc97470303d7437233a635fe270c09d8086b1
 SHA512:
-  metadata.gz: e1f6ff11efc7b37027928325908e1b05cb5318d1ff4f84fb0a0a10b2253544e54606c7c7043ea1d40257469443412dddebb268629a9cd118331fa4453702b5cb
-  data.tar.gz: 9f7b3f87f4eaeaf4271a4266ae5f4a054805a5967c471bffde71ca10649e099ce917db9c1aede8e3d8e8dd099ce091f510149ef110a0df3276cf1189bb505b55
+  metadata.gz: 45750dcb71e8bcad6bdd11d670df8522205693fe7c08708090782e9ddb5e9c9a6f0d30b152728c9d02951619f47f8a99b296992cc64c6cd1110618c618a86b89
+  data.tar.gz: 1d3e0c1da95ecced3228a583552c2900a8f91ff8fb93f46b6363cbfa983fa1fa86ee527f44f14774c1b9db13c314e9b9b0f8ae7901668ed6a78129e89e1d97a9

data/CHANGELOG.md

@@ -1,2 +1,5 @@
 ## [1.0.0] - 2020-12-07
   * Initial Release
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    SharepointApi (0.1.0)
+    sharepoint_api (1.0.0)
       addressable (~> 2.7)
       proof-sharepoint-ruby (~> 1.0)
 
@@ -64,13 +64,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  SharepointApi!
   faker
   rake (~> 13.0)
   rspec (~> 3.6)
   rspec-collection_matchers
   rubocop (~> 1.5)
   rubocop-rspec (~> 2.0)
+  sharepoint_api!
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -22,14 +22,37 @@ 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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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).
 
+## Testing
+
+Run the test suite:
+`rspec`
+
+Run the tests for just one file:
+`rspec 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).

data/lib/sharepoint_api.rb

@@ -65,7 +65,7 @@ class SharepointApi
   def site_relative_path(path, preview: false)
     file_path = [
       library_name, path
-    ].reject{ |p| p.nil? || p == '' }.join('/')
+    ].reject { |p| p.nil? || p == '' }.join('/')
     encode_path(file_path, preview: preview)
   end
 

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,29 @@ class SharepointApi
       false
     end
 
+    def fetch_role_assignments(path)
+      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'
+
+      response = site.query(:get, "#{list_item_path}/RoleAssignments?#{query}")
+
+      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
+    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 = '1.0.1'.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)'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sharepoint_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Kalek
 - Marlen Brunner
+- Danella Olsen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: proof-sharepoint-ruby
@@ -44,6 +45,7 @@ description: A tool to make it easier to talk to sharepoint (via the proof-share
 email:
 - akalek@proofgov.com
 - mbrunner@proofgov.com
+- dolsen@proofgov.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: SharepointApi allows you to interact with sharepoint in a simpler DSL.