repository-manager 0.0.6 → 0.0.7

data/README.md

@@ -1,4 +1,4 @@
-WORK ON PROGRESS, but it works.
+WORK IN PROGRESS, but it already works !
 
 Ruby on Rails plugin (gem) for managing repositories (files/folders/permissions). 
 
@@ -74,7 +74,7 @@ end
 
 ### How can I create/delete a repository (file or folder)
 
-You just have to call the method `create_file`, `create_folder`, or `delete_repository`.
+You just have to call the `has_repository` methods `create_file`, `create_folder`, or `delete_repository`.
 
 ```ruby
 # user1 wants to create a folder in his repository
@@ -87,7 +87,7 @@ source_folder = user1.create_folder('Root folder')
 
 # sourceFolder is the directory in wich user1 wants to create the folder 'The new folder'
 name = 'The new folder'
-the_folder = user1.create_folder(name, sourceFolder)
+the_folder = user1.create_folder(name, source_folder)
 
 # user1 own repository :
 #   'Root folder'
@@ -97,7 +97,7 @@ the_folder = user1.create_folder(name, sourceFolder)
 # Note : user1 needs the ':can_create => true' permission in the folder : the_folder.
 user1.create_file(params[:file], the_folder)
 # OR
-#user1.create_file(File.open('somewhere'), the_folder)
+user1.create_file(File.open('somewhere'), the_folder)
 
 # user1 own repository :
 #   'Root folder'
@@ -129,7 +129,7 @@ user1.delete_repository(file2)
 
 ### How can I share a repository (file/folder)
 
-Now, user1 want to share his folder 'The new folder' with a Group object et another User object.
+Now, user1 want to share his folder 'The new folder' with a Group object et another User object. You can use the `has_repository` method `share(repository, to, options = nil)`.
 
 ```ruby
 # user1 wants to share the_folder with group1 and user2
@@ -139,17 +139,24 @@ items = []
 item << group1
 items << user2
 
+share = user1.share(the_folder, items)
+
+
+# If you want to customize your share options, you can do it like this:
+
 # Default shares permisions are : {can_add: false, can_remove: false} 
 share_permissions = {can_add: true, can_remove: true}
-# Default reposiroty permissions are: {can_read: false, can_create: false, can_update:false, can_delete:false, can_share: false}
-repo_permissions = {can_read: true, can_create: true, can_update:true, can_delete:true, can_share: true}
+# Default reposiroty permissions are: {can_read: true, can_create: false, can_update: false, can_delete: false, can_share: false}
+repo_permissions = {can_read: true, can_create: true, can_update: true, can_delete: true, can_share: true}
+
+options = {share_permissions: share_permissions, repo_permissions: repo_permissions}
 
-share = user1.share(the_folder, items, repo_permissions, share_permissions)
+share = user1.share(the_folder, items, options)
 ```
 
 `share_permissions` specifies if the item who receive the share can add or remove items in this share.
 
-`repo_permissions` specifies what kind of permission do you give at this share. If all the params are false (as_default), the share is useless, because the items have no more permissions in the repository selectionned. 
+`repo_permissions` specifies what kind of permission do you give at this share. If all the params are false, the share is useless, because the items have no more permissions in the repository selectionned. 
 
 See the chapter Authorisations for more details.
 
@@ -194,13 +201,13 @@ If it has the authorisation, an object can add items to a share.
 # user1 want to add items to his share (the actions are done only if user1 has the ':can_add' permission)
 user1.can_add_to?(share) # => true
 
-share_permissions = {can_add: true, can_remove: false}
+options = {can_add: true, can_remove: false}
 # Add items
 items = []
 items << user3
 items << group2
 ...
-@user1.add_items_to(share, items, share_permissions)
+user1.add_items_to(share, items, options)
 
 # Here user3 and group2 can add items in this share, but they can't remove an item.
 group2.can_add_to?(share) # => true
@@ -260,7 +267,7 @@ end
 
 You can manage the permissions of an instance in a share. The owner of the share has all the permissions. The permissions are:
 - can_add_to?(share) : The item can add a new instance in this share.
-- can_remove_from(share) : Can remove an instance from this share.
+- can_remove_from?(share) : Can remove an instance from this share.
 
 To check if the object can add or remove an instance in the share, just write : `group1.can_add_to?(share)` or `group1.can_remove_from?(share)` (it returns `true` or `false`).
 

data/lib/generators/repository_manager/install_generator.rb

@@ -13,6 +13,10 @@ module RepositoryManager #:nodoc:
       @prev_migration_nr.to_s
     end
 
+    def create_initializer_file
+      template 'initializer.rb', 'config/initializers/repository_manager.rb'
+    end
+
     # all public methods in here will be run in order
     #def copy_initializer_file
     #  copy_file "initializer.rb", "config/initializers/repository_manager_initializer.rb"
@@ -20,7 +24,8 @@ module RepositoryManager #:nodoc:
 
     def copy_migrations
       migrations = [["20131018214212_create_repository_manager.rb","create_repository_manager.rb"],
-                    ["20131025085844_add_file_to_repositories.rb","add_file_to_repositories.rb"]
+                    ["20131025085844_add_file_to_repositories.rb","add_file_to_repositories.rb"],
+                    ["20131025085845_add_file_to_files", "add_file_to_files.rb"]
                     ]
       migrations.each do |migration|
         migration_template "../../../../db/migrate/" + migration[0], "db/migrate/" + migration[1]

data/lib/generators/repository_manager/templates/initializer.rb

@@ -1,4 +1,13 @@
-Rails.application.configure do
-  # Uncomment this to turn on verbose mode
-  # config.my_gem.verbose = true
-end
+RepositoryManager.setup do |config|
+
+  # Default repository permissions that an object has on the repository after a share.
+  config.default_repo_permissions = { can_read: true, can_create: false, can_update:false, can_delete:false, can_share: false }
+
+  # Default share permissions thant an object has when he is added in a share.
+  config.default_share_permissions = { can_add: false, can_remove: false }
+end
+
+#Rails.application.configure do
+#  # Uncomment this to turn on verbose mode
+#  # config.my_gem.verbose = true
+#end

data/lib/repository-manager.rb

@@ -2,6 +2,12 @@ require 'repository_manager/has_repository'
 
 module RepositoryManager
 
+  mattr_accessor :default_repo_permissions
+  @@default_repo_permissions = { can_read: true, can_create: false, can_update:false, can_delete:false, can_share: false }
+
+  mattr_accessor :default_share_permissions
+  @@default_share_permissions = { can_add: false, can_remove: false }
+
   class << self
     def setup
       yield self

data/lib/repository_manager/has_repository.rb

@@ -28,22 +28,32 @@ module RepositoryManager
 
     module LocalInstanceMethods
 
-      # Share the repository with the items, with the repo_permissions
-      # repo_permissions contains :
+      # Share the repository with the items, with the options
+      # options[:repo_permissions] contains :
       #   <tt>:can_read</tt> - Item can download the repository
       #   <tt>:can_create</tt> - Item can create a new repository on it
       #   <tt>:can_edit</tt> - Item can edit the repository
       #   <tt>:can_delete</tt> - Item can delete the repository
       #   <tt>:can_share</tt> - Item can share the repository
-      # share_permissions contains :
+      # options[:share_permissions] contains :
       #   <tt>:can_add</tt> - Specify if the item can add objects to the share
       #   <tt>:can_remove</tt> - Specify if the item can remove object to the share
-      def share(repository, items, repo_permissions = nil, share_permissions = nil)
+      def share(repository, items, options = nil)
         authorisations = get_authorisations(repository)
 
         # Here we look if the instance has the authorisation for making a share
         if can_share?(nil, authorisations)
 
+          # We put the default options
+          repo_permissions = RepositoryManager.default_repo_permissions
+          share_permissions = RepositoryManager.default_share_permissions
+
+          # If there is options, we have to take it
+          if options
+            repo_permissions = options[:repo_permissions] if options[:repo_permissions]
+            share_permissions = options[:share_permissions] if options[:share_permissions]
+          end
+
           repo_permissions = make_repo_permissions(repo_permissions, authorisations)
 
           share = Share.new(repo_permissions)
@@ -52,7 +62,7 @@ module RepositoryManager
           share.add_items(items, share_permissions)
 
           repository.shares << share
-          repository.save!
+          repository.save
           share
         else
           # No permission => No share
@@ -127,7 +137,7 @@ module RepositoryManager
       # Return true if the entity can share this rep with all the authorisations
       # Return an Array if the entity can share but with restriction
       # Return true if the repository is nil (he as all authorisations on his own rep)
-      def get_authorisations(repository=nil)
+      def get_authorisations(repository = nil)
         # If repository is nil, he can do what he want
         return true if repository == nil
 
@@ -213,10 +223,10 @@ module RepositoryManager
 
       # You can here add new items in the share
       # Param item could be an object or an array of object
-      def add_items_to(share, items, share_permissions = nil)
+      def add_items_to(share, items, options = nil)
         authorisations = get_share_authorisations(share)
         if can_add_to?(share)
-          share_permissions = make_share_permissions(share_permissions, authorisations)
+          share_permissions = make_share_permissions(options, authorisations)
           share.add_items(items, share_permissions)
         else
           return false

data/lib/repository_manager/version.rb

@@ -1,3 +1,3 @@
 module RepositoryManager
-  VERSION = '0.0.6'
-end
+  VERSION = '0.0.7'
+end

data/spec/has_repository_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "HasRepository" do
+describe 'HasRepository' do
 
   before do
     @user1 = FactoryGirl.create(:user)
@@ -99,10 +99,10 @@ describe "HasRepository" do
     items << @user2
 
     #Here user3 let user2 share this repo too
-    repo_permissions = {can_share: true}
+    options = {repo_permissions: {can_share: true}}
 
     # here user3 can share because he is the owner
-    @user3.share(rep, items, repo_permissions)
+    @user3.share(rep, items, options)
     # here user2 should can share because he has the authorisation
     items = []
     items << @user1
@@ -121,10 +121,10 @@ describe "HasRepository" do
     items << @user2
 
     #Here user3 let user2 share this repo too
-    repo_permissions = {can_read: true, can_share: true}
+    options = {repo_permissions: {can_read: true, can_share: true}}
 
     # here user3 can share because he is the owner
-    @user3.share(rep, items, repo_permissions)
+    @user3.share(rep, items, options)
     # here user2 should can share because he has the authorisation
     # But he has only the authorisation of read (can_read = true), He can't share with more permissions
     items = []
@@ -134,9 +134,9 @@ describe "HasRepository" do
 
     share_of_user_1 = @user1.shares.last
 
-    expect(share_of_user_1.can_read).to eq(false)
-    expect(share_of_user_1.can_update).to eq(false)
-    expect(share_of_user_1.can_share).to eq(false)
+    expect(share_of_user_1.can_read?).to eq(false)
+    expect(share_of_user_1.can_update?).to eq(false)
+    expect(share_of_user_1.can_share?).to eq(false)
     #expect(@user1.shares.count).to eq(1)
     #expect(@user2.shares_owners.count).to eq(1)
   end
@@ -150,25 +150,25 @@ describe "HasRepository" do
     items << @user2
 
     #Here user3 let user2 share this repo too
-    repo_permissions = {can_read: true, can_share: true}
+    options = {repo_permissions: {can_read: true, can_share: true}}
 
     # here user3 can share because he is the owner
-    @user3.share(rep, items, repo_permissions)
+    @user3.share(rep, items, options)
     # here user2 should can share because he has the authorisation
     # But he has only the authorisation of read (can_read = true), He can't share with more permissions
     items = []
     items << @user1
 
-    repo_permissions = {can_read: true, can_update: true, can_share: true}
+    options = {repo_permissions: {can_read: true, can_update: true, can_share: true}}
 
     #Here the permissions should be : :can_read => true, :can_share => true and all others false
-    @user2.share(rep, items, repo_permissions)
+    @user2.share(rep, items, options)
 
     share_of_user_1 = @user1.shares.last
 
-    expect(share_of_user_1.can_read).to eq(true)
-    expect(share_of_user_1.can_update).to eq(false)
-    expect(share_of_user_1.can_share).to eq(true)
+    expect(share_of_user_1.can_read?).to eq(true)
+    expect(share_of_user_1.can_update?).to eq(false)
+    expect(share_of_user_1.can_share?).to eq(true)
     #expect(@user1.shares.count).to eq(1)
     #expect(@user2.shares_owners.count).to eq(1)
   end
@@ -181,15 +181,15 @@ describe "HasRepository" do
     items = []
     items << @user2
 
-    share_permissions = {can_add: true, can_remove: false}
+    options = {share_permissions: {can_add: true, can_remove: false}}
 
     # here user3 can share because he is the owner
-    @user3.share(rep, items, nil, share_permissions)
+    @user3.share(rep, items, options)
 
     share_item_of_user_2 = @user2.shares_items.last
 
-    expect(share_item_of_user_2.can_add).to eq(true)
-    expect(share_item_of_user_2.can_remove).to eq(false)
+    expect(share_item_of_user_2.can_add?).to eq(true)
+    expect(share_item_of_user_2.can_remove?).to eq(false)
     #expect(@user1.shares.count).to eq(1)
     #expect(@user2.shares_owners.count).to eq(1)
   end
@@ -206,11 +206,11 @@ describe "HasRepository" do
 
     children.add_repository(file)
 
-    repo_permissions = {can_read: true, can_update: true, can_share: false}
-    @user3.share(parent, @user1, repo_permissions)
+    options = {repo_permissions: {can_read: true, can_update: true, can_share: false}}
+    @user3.share(parent, @user1, options)
 
-    repo_permissions = {can_read: true, can_update: true, can_share: true}
-    @user3.share(children, @user1, repo_permissions)
+    options = {repo_permissions: {can_read: true, can_update: true, can_share: true}}
+    @user3.share(children, @user1, options)
 
     @user1.share(middle, @user2)
     expect(@user2.shares.count).to eq(0)

data/spec/models/share_spec.rb

@@ -12,45 +12,45 @@ describe 'Share' do
   end
 
   it 'can add a item in his own share' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: false, can_remove: false})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: false, can_remove: false}})
     @user1.add_items_to(share, @user3)
     expect(@user3.shared_repositories.count).to eq(1)
   end
 
   it 'can\'t add an item in a share without permission' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: false, can_remove: false})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: false, can_remove: false}})
     @user2.add_items_to(share, @user3)
     expect(@user3.shared_repositories.count).to eq(0)
   end
 
   it 'can add an item in a share with permission' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: true, can_remove: false})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: true, can_remove: false}})
     @user2.add_items_to(share, @user3)
     expect(@user3.shared_repositories.count).to eq(1)
   end
 
   it 'can remove an item in his own share' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: false, can_remove: false})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: false, can_remove: false}})
     @user1.remove_items_from(share, @user2)
     expect(@user2.shared_repositories.count).to eq(0)
   end
 
   it 'can remove an item in a share with permission' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: false, can_remove: true})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: false, can_remove: true}})
     @user1.add_items_to(share, @user3)
     @user2.remove_items_from(share, @user3)
     expect(@user3.shared_repositories.count).to eq(0)
   end
 
   it 'can\'t remove an item in a share without permission' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: false, can_remove: false})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: false, can_remove: false}})
     @user1.add_items_to(share, @user3)
     @user2.remove_items_from(share, @user3)
     expect(@user3.shared_repositories.count).to eq(1)
   end
 
   it 'can remove and add an array of items in a share with permission' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: true, can_remove: true})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: true, can_remove: true}})
     user4 = FactoryGirl.create(:user)
     @user2.add_items_to(share, [@user3, user4])
     expect(user4.shared_repositories.count).to eq(1)
@@ -59,7 +59,7 @@ describe 'Share' do
   end
 
   it 'can\'t add an items in a share with permission that he has not' do
-    share = @user1.share(@user1_file, @user2, nil, {can_add: true, can_remove: false})
+    share = @user1.share(@user1_file, @user2, {share_permissions:{can_add: true, can_remove: false}})
     @user2.add_items_to(share, @user3, {can_add:true, can_remove:true})
     @user3.remove_items_from(share, @user2)
     expect(@user2.shared_repositories.count).to eq(1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: repository-manager
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails