repository-manager 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50b78ee29a456a6211cc629dbfc3f6b4615eb3e3
-  data.tar.gz: 59d453429c31b032a41ad838458a9abd6001fcc4
+  metadata.gz: 1f3a34384b57d18db3e94c0979860cf7723fa6e3
+  data.tar.gz: 3f434860b0ca8f9749a570639643f16bd33465e7
 SHA512:
-  metadata.gz: dc3b40e3c529e73ac7548609563dfbd6cf9b80b0d3dba434ca6d7e6eba966bc355d80a787248a111753e1822aa71097042d4c0121ac087802579afa658de48e3
-  data.tar.gz: ce8bd6910fc8349ed60512af898efc8e95f1a8107ad965a962ff5e2e97604d0c8a827abe3023bb6eb7351d493ad1e2a9e9b8bf3c95b27b76bcf758078834d79a
+  metadata.gz: c69a858299dd6c8a2a3cce3f1a05a9b86c0fdf25fff66fa124f48c7f83735051d828a3c2a8bfc53b978ba01cb3415973703732cdba97087af1748a3c885655fd
+  data.tar.gz: a4ffcdf75acd0333f868435d13cfebbbbc6fb9b8c84b1298f19c7028f70e34f7689e6a91c633b8217157a901299c4a27da1a9109c4293442a0e63a0e40667c53

data/README.md

@@ -2,7 +2,7 @@ WORK IN PROGRESS, but it already works !
 
 Ruby on Rails plugin (gem) for managing repositories (files/folders/permissions/sharing). 
 
-# RepositoryManager
+# RepositoryManager [![Gem Version](https://badge.fury.io/rb/repository-manager.png)](http://badge.fury.io/rb/repository-manager)
 
 This gem add functionalities to manage repositories. Each instance (users, groups, etc..) can have it own repository (with files and folders). It can manage them (edit, remove, add, etc) and share them with other objects.
 
@@ -63,6 +63,7 @@ end
 ```
 
 For instance, if you want that a default sharing is totally 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 }
@@ -142,6 +143,11 @@ the_new_folder = user1.create_folder('The new folder', source_folder: source_fol
 user1.create_file(params[:file], source_folder: the_new_folder)
 # OR
 user1.create_file(File.open('somewhere'), source_folder: the_new_folder)
+# OR
+repo_file = RepositoryManager::RepoFile.new
+repo_file.file = your_file
+user1.create_file(repo_file, source_folder: the_new_folder)
+
 
 # user1 own repository :
 #   |-- 'Root folder'
@@ -177,6 +183,16 @@ user1.move_repo_item(the_new_folder, source_folder: test_folder)
 #   |  |-- 'The new folder'
 #   |  |  |-- 'file.txt'
 
+# user1 want to rename 'The new folder' to 'The renamed folder'
+user1.rename_repo_item(the_new_folder, 'The renamed folder')
+
+# user1 own repository :
+#   |-- 'Root folder'
+#   |-- 'file2.jpg'
+#   |-- 'Test folder'
+#   |  |-- 'The renamed folder'
+#   |  |  |-- 'file.txt'
+
 # Delete a repo_item
 # Note : user1 needs the ':can_delete => true' permission in the folder : the_new_folder (else the method returns `false`).
 user1.delete_repo_item(test_folder)
@@ -192,14 +208,17 @@ user1.delete_repo_item(file2)
 
 ```
 
-If a user (sender of the file/folder) send a file or folder into a group (owner of the file/folder), you can specify the owner and the sender like this :
+If a user (sender of the item) send a file or folder into a group (owner of this item), you can specify the owner and the sender like this :
 
 ```ruby
 # user1 wants to create a folder and a file into group1
 folder = group1.create_folder('Folder created by user1', sender: user1)
 
+folder.owner # Returns group1
+folder.sender # Returns user1
+
 # Now he send the file into the folder
-file = group1.create_file(params[:file], source_folder: params[:file], sender: user1)
+file = group1.create_file(params[:file], source_folder: folder, sender: user1)
 
 file.owner # Returns group1
 file.sender # Returns user1
@@ -208,6 +227,8 @@ file.sender # Returns user1
 
 ```
 
+WARNING : There is no verification if the user has the authorisation to create a file or folder into this group. You have to check this in your controller ! The fact that user1 is the sender of this folder gives him NO AUTHORISATION on it !
+
 ### How can I share a repo_item (file/folder)
 
 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)`.
@@ -292,9 +313,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 == 'RepositoryManager::RepoFolder'
+if repo_item.is_folder
   repo_item.name #=> Returns the name of the folder (for instance : 'New folder').
-elsif repo_item.type == 'RepositoryManager::RepoFile'
+elsif repo_item.is_file?
   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'
@@ -423,10 +444,7 @@ the_folder.delete_zip
 
 ## TODO
 
-- Test the rename folder method
-- Test if the file already exist before creating or moving it
 - Do the rename file method
-- Write the documentation for the rename method
 - Write the methods : copy, share_link.
 - Snapshot the file if possible
 - Versioning
@@ -437,3 +455,5 @@ the_folder.delete_zip
 
 This project rocks and uses MIT-LICENSE.
 
+Created by Yves Baumann.
+

data/app/models/repository_manager/repo_file.rb

@@ -10,8 +10,12 @@ class RepositoryManager::RepoFile < RepositoryManager::RepoItem
     file.url.split('/').last
   end
 
-  # Downloading this file
   def download(options = {})
+    self.download!(options)
+  end
+
+  # Downloading this file
+  def download!(options = {})
     path = file.path
     #render status: :bad_request and return unless File.exist?(path)
     #send_file(path)

data/app/models/repository_manager/repo_folder.rb

@@ -122,7 +122,6 @@ class RepositoryManager::RepoFolder < RepositoryManager::RepoItem
   end
 
   private
-
   # Returns the default path of the zip file
   # object is the object that want to download this file
   def get_default_download_path(object = nil)
@@ -133,10 +132,10 @@ class RepositoryManager::RepoFolder < RepositoryManager::RepoItem
   def add_repo_item_to_zip(children, zf, object = nil, prefix = nil)
     children.each do |child|
       # If this is a file, we just add this file to the zip
-      if child.type == 'RepositoryManager::RepoFile'
+      if child.is_file?
         # 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 || !RepositoryManager.accept_nested_sharing || object.can_read?(child)
-      elsif child.type == 'RepositoryManager::RepoFolder'
+      elsif child.is_folder?
         # If this folder has children, we do it again with it children
         if child.has_children?
           # We go in this new directory and add it repo_items

data/app/models/repository_manager/repo_item.rb

@@ -40,11 +40,13 @@ class RepositoryManager::RepoItem < ActiveRecord::Base
 
   # Move itself into the target_folder
   def move!(target_folder)
-    if target_folder.type == 'RepositoryManager::RepoFolder'
-      self.update_attribute :parent, target_folder
-    else
-      raise RepositoryManager::RepositoryManagerException.new("move failed. target '#{name}' can't be a file")
+    unless target_folder.is_folder?
+      raise RepositoryManager::RepositoryManagerException.new("move failed. target '#{target_folder.name}' can't be a file")
+    end
+    if target_folder.name_exist_in_children?(self.name)
+      raise RepositoryManager::RepositoryManagerException.new("move failed. The repo_item '#{name}' already exist ine the folder '#{target_folder.name}'")
     end
+    self.update_attribute :parent, target_folder
   end
 
   def move(target_folder)
@@ -59,7 +61,7 @@ class RepositoryManager::RepoItem < ActiveRecord::Base
   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.type == 'RepositoryManager::RepoFolder' && !self.descendant_ids.empty?
+    ancestor_and_descendant_ids << self.descendant_ids if self.is_folder? && !self.descendant_ids.empty?
     ancestor_and_descendant_ids << self.ancestor_ids if !self.ancestor_ids.empty?
 
     # If it exist a sharing, it returns true
@@ -70,6 +72,16 @@ class RepositoryManager::RepoItem < ActiveRecord::Base
     end
   end
 
+  # Returns true if it is a folder
+  def is_folder?
+    self.type == 'RepositoryManager::RepoFolder'
+  end
+
+  # Returns true if it is a file
+  def is_file?
+    self.type == 'RepositoryManager::RepoFile'
+  end
+
   private
   def put_sender
     self.sender = owner unless sender

data/app/models/repository_manager/sharing.rb

@@ -21,7 +21,7 @@ class RepositoryManager::Sharing < ActiveRecord::Base
     # If the member is the owner, he can do what he want !
     if self.owner == member
       return true
-    elsif i = self.sharings_members.where(member_id: member.id, member_type: member.class.base_class.to_s).first
+    elsif i = self.sharings_members.where(member: member).first
       return {can_add: i.can_add, can_remove: i.can_remove}
     else
       return false
@@ -51,10 +51,10 @@ class RepositoryManager::Sharing < ActiveRecord::Base
     if members.kind_of?(Array)
       # Add each member to this sharing
       members.each do |member|
-        self.sharings_members.where(:member_id => member.id, :member_type => member.class.base_class.to_s).first.destroy
+        self.sharings_members.where(member: member).first.destroy
       end
     else
-      self.sharings_members.where(:member_id => members.id, :member_type => members.class.base_class.to_s).first.destroy
+      self.sharings_members.where(member: members).first.destroy
     end
   end
 

data/lib/repository_manager/has_repository.rb

@@ -94,6 +94,11 @@ module RepositoryManager
       #     AuthorisationException if the object don't have the permission
       def create_folder!(name = '', options = {})
         source_folder = options[:source_folder]
+        if source_folder
+          unless source_folder.is_folder?
+            raise RepositoryManager::RepositoryManagerException.new("create folder failed. The source folder must be a repo_folder.")
+          end
+        end
 
         # If he want to create a folder in a directory, we have to check if he have the authorisation
         if can_create?(source_folder)
@@ -163,13 +168,22 @@ module RepositoryManager
       #     AuthorisationException if the object don't have the permission
       def create_file!(file, options = {})
         source_folder = options[:source_folder]
+        if source_folder
+          unless source_folder.is_folder?
+            raise RepositoryManager::RepositoryManagerException.new("create file failed. The source folder must be a repo_folder.")
+          end
+        end
+
         # If he want to create a file in a directory, we have to check if he have the authorisation
         if can_create?(source_folder)
+
           if file.class.name == 'RepositoryManager::RepoFile'
             repo_file = file
-          else
-            repo_file = RepositoryManager::RepoFile.new
+          elsif file.class.name == 'File'
+            repo_file = RepositoryManager::RepoFile.new()
             repo_file.file = file
+          else # "ActionController::Parameters"
+            repo_file = RepositoryManager::RepoFile.new(file)
           end
 
           repo_file.owner = self
@@ -236,7 +250,7 @@ module RepositoryManager
         if can_download?(repo_item)
           path = options[:path] if options[:path]
 
-          repo_item.download({object: self, path: path})
+          repo_item.download!({object: self, path: path})
         else
           raise RepositoryManager::AuthorisationException.new("download failed. You don't have the permission to download the repo_item '#{repo_item.name}'")
         end
@@ -255,7 +269,7 @@ module RepositoryManager
         unless can_update?(repo_item)
           raise RepositoryManager::AuthorisationException.new("rename repo_item failed. You don't have the permission to update the repo_item '#{repo_item.name}'")
         end
-        repo_item.rename(new_name)
+        repo_item.rename!(new_name)
       end
 
       # Rename the repo_item with the new_name
@@ -276,13 +290,13 @@ module RepositoryManager
           raise RepositoryManager::AuthorisationException.new("move repo_item failed. You don't have the permission to create in the target_folder '#{target_folder.name}'")
         end
         # If it has the permission, we move the repo_item in the target_folder
-        repo_item.move(target_folder)
+        repo_item.move!(target_folder)
       end
 
       def move_repo_item(repo_item, target_folder)
         begin
           move_repo_item!(repo_item, target_folder)
-        rescue RepositoryManager::AuthorisationException
+        rescue RepositoryManager::RepositoryManagerException, RepositoryManager::AuthorisationException
           false
         end
       end
@@ -375,7 +389,7 @@ module RepositoryManager
         end
       end
 
-        # You can here add new members in the sharing
+        # You can here remove members in the sharing
       # Param member could be an object or an array of object
       def remove_members_from!(sharing, members)
         if can_remove_from?(sharing)
@@ -504,7 +518,7 @@ module RepositoryManager
       # Put a default name if none is given
       def default_folder_name(source_folder)
         i = ''
-        name = "#{I18n.t 'repository_manager.models.repo_folder.name'}#{i}"
+        name = "#{I18n.t 'repository_manager.models.repo_folder.name'}"
         # We check if another item has the same name
 
         if source_folder
@@ -515,7 +529,7 @@ module RepositoryManager
               i = 1
             end
             i += 1
-            name = "#{I18n.t 'repository_manager.models.repo_folder.name'}#{i}"
+            name = "#{I18n.t 'repository_manager.models.repo_folder.name'} #{i}"
           end
         else
           #TODO Optimiser, récupérer tout les instances contenants le nom, puis faire la boucle (pas boucle de requete)
@@ -525,7 +539,7 @@ module RepositoryManager
               i = 1
             end
             i += 1
-            name = "#{I18n.t 'repository_manager.models.repo_folder.name'}#{i}"
+            name = "#{I18n.t 'repository_manager.models.repo_folder.name'} #{i}"
           end
 
         end

data/lib/repository_manager/version.rb

@@ -1,3 +1,3 @@
 module RepositoryManager
-  VERSION = '0.1.1'
+  VERSION = '0.1.4'
 end

data/spec/has_repository_spec.rb

@@ -18,13 +18,6 @@ describe 'HasRepository' do
     expect(@user2.sharings.last).to eq(sharing)
   end
 
-  it "can add a file to repo_item" do
-    #TODO
-  end
-
-  it "can add a folder to repo_item" do
-    #TODO
-  end
 
   it 'can share his own repo_item with other users' do
     rep = FactoryGirl.build(:rm_repo_file)
@@ -278,4 +271,5 @@ describe 'HasRepository' do
     expect(@user1.repo_items.count).to eq(1)
     expect(@user1.repo_items.files.count).to eq(1)
   end
+
 end

data/spec/models/repository_spec.rb

@@ -15,11 +15,18 @@ describe 'RepoItem' do
   end
 
   it 'can create a folder in it own folder' do
-    folder = @user1.create_folder('Folder1', source_folder: @user1_folder)
+    @user1.create_folder('Folder1', source_folder: @user1_folder)
 
     expect(@user1_folder.has_children?).to eq(true)
   end
 
+  it 'can\'t create a folder in it a file' do
+    folder = @user1.create_folder('Folder1', source_folder: @user1_file)
+
+    expect(folder).to eq(false)
+  end
+
+
   it 'can\'t create a folder in another folder without permission' do
     folder = @user2.create_folder('Folder1', source_folder: @user1_folder)
 
@@ -133,19 +140,11 @@ describe 'RepoItem' do
     expect(test_folder.parent_id).to eq(@user1_folder.id)
   end
 
-  it 'can move a folder into another folder' do
-    folder = @user1.create_folder('Folder1', source_folder: @user1_folder)
-    expect(@user1.repo_items.count).to eq(3)
-    folder2 = @user1.create_folder('Folder1', source_folder: @user1_folder)
-    expect(folder2).to eq(false)
-    expect(@user1.repo_items.count).to eq(3)
-    folder3 = @user1.create_folder('Folder2', source_folder: @user1_folder)
-    expect(@user1.repo_items.count).to eq(4)
-    # TODO
-  end
-
   it 'can rename it own folder' do
-    # TODO
+    @user1.rename_repo_item(@user1_folder, 'test new name')
+
+    expect(@user1_folder.reload.name).to eq('test new name')
+
   end
 
   it 'can rename it own file' do
@@ -154,12 +153,11 @@ describe 'RepoItem' do
 
   it 'can rename item with share update permission' do
     # TODO
-
   end
 
   it 'can\'t rename item without share update permission' do
-    # TODO
-
+    @user2.rename_repo_item(@user1_folder, 'test new name')
+    expect(@user1_folder.reload.name).to eq('Folder')
   end
 
   it 'can create a new folder with different name' do
@@ -170,9 +168,9 @@ describe 'RepoItem' do
 
     # TODO add translate in gem
     expect(folder1.name).to eq('translation missing: en.repository_manager.models.repo_folder.name')
-    expect(folder2.name).to eq('translation missing: en.repository_manager.models.repo_folder.name2')
+    expect(folder2.name).to eq('translation missing: en.repository_manager.models.repo_folder.name 2')
     expect(folder3.name).to eq('translation missing: en.repository_manager.models.repo_folder.name')
-    expect(folder4.name).to eq('translation missing: en.repository_manager.models.repo_folder.name2')
+    expect(folder4.name).to eq('translation missing: en.repository_manager.models.repo_folder.name 2')
 
   end
 
@@ -220,4 +218,29 @@ describe 'RepoItem' do
     file = @user2.create_file(File.open("#{Rails.root}/../fixture/textfile.txt"), sender: @user1)
     expect(file.sender).to eq(@user1)
   end
+
+  it "can move a file to folder" do
+    file = @user2.create_file(File.open("#{Rails.root}/../fixture/textfile.txt"))
+    folder = @user2.create_folder('folder')
+
+    @user2.move_repo_item(file, folder)
+
+    expect(folder.children).to eq([file])
+  end
+
+  it "can move a folder to folder" do
+    folder = @user2.create_folder('folder')
+    folder2 = @user2.create_folder('folder2')
+    @user2.move_repo_item(folder, folder2)
+
+    expect(folder2.children).to eq([folder])
+  end
+
+  it "can't move a folder into a file" do
+    file = @user2.create_file(File.open("#{Rails.root}/../fixture/textfile.txt"))
+    folder = @user2.create_folder('folder')
+
+    expect(@user2.move_repo_item(folder,file)).to eq(false)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repository-manager
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Yves Baumann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails