repository-manager 0.0.9 → 0.0.10

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjA2ODVjZTZlZTI0ZWM2N2UwOGJhM2Q2NTc1ZTk5Y2IyZDBhOWQ0MQ==
+  data.tar.gz: !binary |-
+    N2RlYjllMzAzMTFkNmEzODY4MDU3NGZlODRlY2Q3ZDU3ODk5MWJkYw==
+SHA512:
+  metadata.gz: !binary |-
+    MzM1N2JlOGIxYzMyMDdkMDI3MGMwNjZjMTJlNGNjNDhiY2VmYjg4YjZkZjNk
+    YWVlNmZkYzkzMWQwZjY5ZjBiMzI5NDEyNmZmM2Y1MDg3MTAzODU0ZTBmYmZm
+    YzFkZDNhZjQ2NTExMGQyMGFiYjc2YWIyZmYyZGUzNTI4MWNiNTY=
+  data.tar.gz: !binary |-
+    Y2YyYTFjNTQ2NmFkYTYxOGE5NWJhMzlmMzFiOGNmNTFkYjVhMGU2YjYwNDRh
+    MjRkYjA5Y2FkMWYyNDBjZGRkYjA2ZmQ5NDBlN2IwZmRiMjFhY2VmNGNjZGM1
+    MGJiYTFiM2RiZjZkMDAzY2Y0MmVhYTU4NGVlNjQyYzc1MTdhMGI=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    repository-manager (0.0.8)
+    repository-manager (0.0.10)
       ancestry
       carrierwave
       rails (> 3.0.0)

data/README.md

@@ -55,10 +55,14 @@ RepositoryManager.setup do |config|
 
   # Default permissions that an object has when he is added in a sharing.
   config.default_sharing_permissions = { can_add: false, can_remove: false }
+  
+  # Default path for generating the zip file when a user want to download a folder
+  # Default is : "download/#{member.class.to_s.underscore}/#{member.id}/#{self.class.to_s.underscore}/#{self.id}/"
+  #config.default_zip_path = true
 end
 ```
 
-For instance, if you want that a default sharing is totaly free, just put all default parameters to `true` :
+For instance, if you want that a default sharing is totaly free (for edit, delete, etc), just put all default parameters to `true` :
 ```ruby
 RepositoryManager.setup do |config|
   config.default_repo_item_permissions = { can_read: true, can_create: true, can_update: true, can_delete: true, can_share: true }
@@ -107,6 +111,12 @@ A `repo_item` is an item in a repository, it can be:
 
 A folder can contains files and folders. Like in a real tree files and folders.
 
+A few methods are written in those two ways :
+- method(arg, options)
+- method!(arg, options) (note the "!")
+
+The two methods do the same, but the one with the "!" returns an Exeption error if it is a problem (AuthorisationException for instance) and the method without "!" return false if it has a problem.
+
 ### How can I create/delete/move a repo_item (file or folder)
 
 You just have to call the `has_repository` methods `create_file`, `create_folder`, or `delete_repo_item`.
@@ -186,6 +196,7 @@ user1.delete_repo_item(file2)
 
 Now, user1 want to share his folder 'The new folder' with a Group object `group1` et another User object `user2`. You can use the `has_repository` method `share(repo_item, member, options = nil)`.
 
+
 ```ruby
 # user1 wants to share the_new_folder with group1 and user2
 
@@ -208,6 +219,33 @@ sharing = user1.share(the_new_folder, members, options)
 
 See the chapter [Authorisations](#authorisations) for more details.
 
+### Repository Manager and the nested sharing
+
+Repository Manager actualy don't accept nested sharing.
+
+```ruby
+
+parent = @user1.create_folder('Parent')
+nested = @user1.create_folder('Nested', parent)
+children = @user1.create_folder('Children', nested)
+
+# @user1 own repository :
+#   |-- 'Parent'
+#   |  |-- 'Nested'
+#   |  |  |-- 'Children'
+
+@user1.share(nested, @user2)
+
+nested.has_nested_sharing? # Returns false (because `nested` is shared but there is no nested sharing)
+parent.has_nested_sharing? # Returns true (because there is a sharing on one of his descendants)
+children.has_nested_sharing? # Returns true (because there is a sharing on one of his ancestors)
+
+# Here we can't share 'Parent' or 'Children' because it already exist a nested sharing.
+@user1.share(parent, @user2) # Returns false
+@user1.share!(parent, @user2) # Raise a NestedSharingException (note the "!")
+@user1.share!(children, @user2) # Raise a NestedSharingException  (note the "!")
+```
+
 ### How can I see my repo_items
 
 You can have two kind of repo_items: 
@@ -239,9 +277,9 @@ Recall: a repo_item can be:
 ```ruby
 # We want to know if the object repo_item is a file or a folder:
 if repo_item.type == 'RepoFolder'
-  repo_item.name #=> Returns the name of the folder ('New folder').
+  repo_item.name #=> Returns the name of the folder (for instance : 'New folder').
 elsif repo_item.type == 'RepoFile'
-  repo_item.name #=> Returns the name of the file ('file.png').
+  repo_item.name #=> Returns the name of the file (for instance : 'file.png').
   # Here is the file
   repo_item.file.url # => '/url/to/file.png'
   repo_item.file.current_path # => 'path/to/file.png'

data/app/models/repo_folder.rb

@@ -98,7 +98,7 @@ class RepoFolder < RepoItem
       # If this is a file, we just add this file to the zip
       if child.type == 'RepoFile'
         # Add the file in the zip if the object is authorised to read it.
-        zf.add("#{prefix}#{child.name}", child.file.current_path) if object == nil || object.can_read?(child)
+        zf.add("#{prefix}#{child.name}", child.file.current_path) if object == nil || !RepositoryManager.accept_nested_sharing || object.can_read?(child)
       elsif child.type == 'RepoFolder'
         # If this folder has children, we do it again with it children
         if child.has_children?
@@ -106,7 +106,7 @@ class RepoFolder < RepoItem
           add_repo_item_to_zip(RepoItem.find(child.child_ids), zf, object, "#{prefix}#{child.name}/")
         else
           # We just create the folder if it is empty
-          zf.mkdir(child.name) if object == nil || object.can_read?(child)
+          zf.mkdir(child.name) if object == nil || !RepositoryManager.accept_nested_sharing || object.can_read?(child)
         end
       end
     end

data/app/models/repo_item.rb

@@ -45,7 +45,21 @@ class RepoItem < ActiveRecord::Base
     rescue RepositoryManager::RepositoryManagerException
       false
     end
-
   end
 
+  # Returns true if it exist a sharing in the ancestors of descendant_ids of the repo_item (without itself)
+  def has_nested_sharing?
+    # An array with the ids of all ancestors and descendants
+    ancestor_and_descendant_ids = []
+    ancestor_and_descendant_ids << self.descendant_ids if !self.descendant_ids.empty?
+    ancestor_and_descendant_ids << self.ancestor_ids if !self.ancestor_ids.empty?
+
+    # If it is a sharing, it returns true
+    if Sharing.where(repo_item_id: ancestor_and_descendant_ids).count > 0
+      true
+    else
+      false
+    end
   end
+
+end

data/lib/repository-manager.rb

@@ -11,6 +11,9 @@ module RepositoryManager
   mattr_accessor :default_zip_path
   @@default_zip_path = true
 
+  mattr_accessor :accept_nested_sharing
+  @@accept_nested_share = false
+
   class << self
     def setup
       yield self

data/lib/repository_manager/exceptions.rb

@@ -4,4 +4,7 @@ module RepositoryManager
 
   class AuthorisationException < RepositoryManagerException
   end
+
+  class NestedSharingException < RepositoryManagerException
+  end
 end

data/lib/repository_manager/has_repository.rb

@@ -36,6 +36,15 @@ module RepositoryManager
       #   <tt>:can_add</tt> - Specify if the member can add objects to the sharing
       #   <tt>:can_remove</tt> - Specify if the member can remove object to the sharing
       def share!(repo_item, members, options = {})
+
+        # Nested sharing are not accepted
+        if !RepositoryManager.accept_nested_sharing
+          # Check if no other sharing exist in the path
+          if repo_item.has_nested_sharing?
+            raise RepositoryManager::NestedSharingException.new("sharing failed. Another sharing already exist on the subtree or an ancestor '#{repo_item.name}'")
+          end
+        end
+
         authorisations = get_authorisations(repo_item)
 
         # Here we look if the instance has the authorisation for making a sharing
@@ -49,6 +58,7 @@ module RepositoryManager
           repo_item_permissions = options[:repo_item_permissions] if options[:repo_item_permissions]
           sharing_permissions = options[:sharing_permissions] if options[:sharing_permissions]
 
+          # Correct the item permission with accepted permissions
           repo_item_permissions = make_repo_item_permissions(repo_item_permissions, authorisations)
 
           sharing = Sharing.new(repo_item_permissions)
@@ -68,14 +78,16 @@ module RepositoryManager
       def share(repo_item, members, options = {})
         begin
           share!(repo_item, members, options)
-        rescue RepositoryManager::AuthorisationException
+        rescue RepositoryManager::AuthorisationException, RepositoryManager::NestedSharingException
           false
         end
       end
 
       # Create a folder with the name (name) in the directory (source_folder)
       # Returns the object of the folder created if it is ok
-      # Returns false if the folder is not created (no authorisation)
+      # Returns an Exception if the folder is not created
+      #     RepositoryManagerException if the name already exist
+      #     AuthorisationException if the object don't have the permission
       def create_folder!(name = 'New folder', source_folder = nil)
         # If he want to create a folder in a directory, we have to check if he have the authorisation
         if can_create?(source_folder)
@@ -90,7 +102,7 @@ module RepositoryManager
           else
             # The add didn't works, we delete the folder
             folder.destroy
-            raise RepositoryManager::RepositoryManagerException.new("create_folder failed. The folder '#{name}' already exist in folder '#{source_folder.name}'")
+            raise RepositoryManager::RepositoryManagerException.new("create_folder failed. The folder name '#{name}' already exist in folder '#{source_folder.name}'")
           end
         else
           raise RepositoryManager::AuthorisationException.new("create_folder failed. You don't have the permission to create a folder in '#{source_folder.name}'")
@@ -263,20 +275,31 @@ module RepositoryManager
         can_do?('create', repo_item, authorisations)
       end
 
-      # Return true if you can edit the repo, false else
+      # Returns true if you can edit the repo, false else
       def can_update?(repo_item, authorisations = nil)
         can_do?('update', repo_item, authorisations)
       end
 
-      # Return true if you can delete the repo, false else
+      # Returns true if you can delete the repo, false else
       def can_delete?(repo_item, authorisations = nil)
         can_do?('delete', repo_item, authorisations)
       end
 
-      # Return true it has a sharing in the repo_item
-      def has_sharing?(repo_item)
-
-      end
+      ## Returns true if  it exist a sharing in the ancestors of descendant_ids of the repo_item (without itself)
+      #def has_sharing?(repo_item)
+      #  # An array with the ids of all ancestors and descendants
+      #  ancestor_and_descendant_ids = []
+      #  ancestor_and_descendant_ids << repo_item.descendant_ids if !repo_item.descendant_ids.empty?
+      #  ancestor_and_descendant_ids << repo_item.ancestor_ids if !repo_item.ancestor_ids.empty?
+      #
+      #  # If it is a sharing, it returns true
+      #  if self.sharings.where(repo_item_id: ancestor_and_descendant_ids).count > 0
+      #    true
+      #  else
+      #    false
+      #  end
+      #
+      #end
 
       # Return true if you can add a member in this sharing, false else
       def can_add_to?(sharing)
@@ -348,7 +371,7 @@ module RepositoryManager
 
       # Return if you can do or not this action (what)
       def can_do?(what, repo_item, authorisations = nil)
-        #If we pass no authorisations we have to get it
+        # If we pass no authorisations we have to get it
         if authorisations == nil
           authorisations = get_authorisations(repo_item)
         end
@@ -357,13 +380,25 @@ module RepositoryManager
           when 'read'
             authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_read] == true)
           when 'delete'
-            authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_delete] == true)
+            if RepositoryManager.accept_nested_sharing
+              # TODO implement to look if he can delete all the folder
+            else
+              authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_delete] == true)
+            end
           when 'update'
             authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_update] == true)
           when 'share'
-            authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_share] == true)
+            if RepositoryManager.accept_nested_sharing
+              # TODO implement to look if he can delete all the folder
+            else
+              authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_share] == true)
+            end
           when 'create'
-            authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_create] == true)
+            if RepositoryManager.accept_nested_sharing
+              # TODO implement to look if he can delete all the folder
+            else
+              authorisations == true || (authorisations.kind_of?(Hash) && authorisations[:can_create] == true)
+            end
           else
             false
         end

data/lib/repository_manager/version.rb

@@ -1,3 +1,3 @@
 module RepositoryManager
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 end

data/repository-manager.gemspec

@@ -20,12 +20,12 @@ Each instance (users, groups, etc..) can have it own repositories (with files an
   #s.test_files = Dir["spec/**/*"]
   s.license = 'MIT'
 
-  s.add_runtime_dependency 'rails', '> 3.0.0'
+  s.add_runtime_dependency 'rails', '~> 3.0', '>= 3.0.0'
 
-  s.add_development_dependency 'factory_girl_rails'
-  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'factory_girl_rails', '~> 0'
+  s.add_development_dependency 'sqlite3', '~> 0'
   s.add_development_dependency 'rspec-rails', '~> 2.0'
-  s.add_runtime_dependency 'ancestry'
-  s.add_runtime_dependency 'carrierwave'
-  s.add_runtime_dependency 'rubyzip'#, '< 1.0.0'#, :require => 'zip/zip'
+  s.add_runtime_dependency 'ancestry', '~> 0'
+  s.add_runtime_dependency 'carrierwave', '~> 0'
+  s.add_runtime_dependency 'rubyzip', '~> 0'#, '< 1.0.0'#, :require => 'zip/zip'
 end

data/spec/has_repository_spec.rb

@@ -166,6 +166,7 @@ describe 'HasRepository' do
 
     sharing_of_user_1 = @user1.sharings.last
 
+    # TODO correct this, sharing is nil
     expect(sharing_of_user_1.can_read?).to eq(true)
     expect(sharing_of_user_1.can_update?).to eq(false)
     expect(sharing_of_user_1.can_share?).to eq(true)
@@ -194,7 +195,52 @@ describe 'HasRepository' do
     #expect(@user2.sharings_owners.count).to eq(1)
   end
 
-  it 'can share a repo_item with ancestor sharing permissions' do
+  # Todo implement with accepting nested set to true
+  #it 'can share a repo_item with ancestor sharing permissions' do
+  #  parent = FactoryGirl.create(:repo_folder)
+  #  parent.owner = @user3
+  #  middle = @user3.create_folder('Middle', parent)
+  #  children = @user3.create_folder('Children', middle)
+  #
+  #  file = FactoryGirl.build(:repo_file)
+  #  file.owner = @user3
+  #  file.save
+  #
+  #  children.add(file)
+  #
+  #  options = {repo_item_permissions: {can_read: true, can_update: true, can_share: false}}
+  #  @user3.share(parent, @user1, options)
+  #
+  #  options = {repo_item_permissions: {can_read: true, can_update: true, can_share: true}}
+  #  @user3.share(children, @user1, options)
+  #
+  #  @user1.share(middle, @user2)
+  #  expect(@user2.sharings.count).to eq(0)
+  #  @user1.share(file, @user2)
+  #  expect(@user2.sharings.count).to eq(1)
+  #end
+
+  it 'can\'t share a nested sharing' do
+    parent = @user1.create_folder('Parent')
+    nested = @user1.create_folder('Nested', parent)
+    children = @user1.create_folder('Children', nested)
+
+    # @user1 own repository :
+    #   |-- 'Parent'
+    #   |  |-- 'Nested'
+    #   |  |  |-- 'Children'
+
+    @user1.share(nested, @user2)
+
+    expect(nested.has_nested_sharing?).to eq(false) # Returns false (because `nested` is shared but there is no nested sharing)
+    expect(parent.has_nested_sharing?).to eq(true) # Returns true (because there is a sharing on one of his descendants)
+    expect(parent.has_nested_sharing?).to eq(true) # Returns true (because there is a sharing on one of his ancestors)
+
+    # Here we can't share 'Parent' or 'Children' because it already exist a nested sharing.
+    expect(@user1.share(parent, @user2)).to eq(false) # Returns false
+  end
+
+  it 'can\'t share a repo_item with ancestor sharing permissions' do
     parent = FactoryGirl.create(:repo_folder)
     parent.owner = @user3
     middle = @user3.create_folder('Middle', parent)
@@ -206,7 +252,7 @@ describe 'HasRepository' do
 
     children.add(file)
 
-    options = {repo_item_permissions: {can_read: true, can_update: true, can_share: false}}
+    options = {repo_item_permissions: {can_read: true, can_update: true, can_share: true}}
     @user3.share(parent, @user1, options)
 
     options = {repo_item_permissions: {can_read: true, can_update: true, can_share: true}}
@@ -215,7 +261,7 @@ describe 'HasRepository' do
     @user1.share(middle, @user2)
     expect(@user2.sharings.count).to eq(0)
     @user1.share(file, @user2)
-    expect(@user2.sharings.count).to eq(1)
+    expect(@user2.sharings.count).to eq(0)
   end
 
   it "can create a folder" do

metadata

@@ -1,68 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: repository-manager
 version: !ruby/object:Gem::Version
-  version: 0.0.9
-  prerelease: 
+  version: 0.0.10
 platform: ruby
 authors:
 - Yves Baumann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +68,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,49 +75,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ancestry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: carrierwave
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 description: ! 'This project is based on the need for a repository manager system
@@ -213,27 +204,26 @@ files:
 homepage: https://github.com/Texicitys/repository-manager
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby on Rails plugin (gem) for managing repositories (files/folders/permissions/sharings).
 test_files:
 - spec/dummy/Gemfile