boxroom 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2880e8cbf77046ee1a85d7e8c90ef4d23ee8eb9
-  data.tar.gz: 1a16a26b69b0a3aeff0cd675fb4bc208ce8a0e7a
+  metadata.gz: 21e9f11bc948549ad833330da41139124099fa51
+  data.tar.gz: 6fcbc3e5f900ad2c032aa8562cb7ebd2d08a1465
 SHA512:
-  metadata.gz: 30667822ead5fb3c58dda87d3b7086a490efc9193baf25baf7cf43759e4249dd3432e96fc4eace5292003bbfe86ad42f3923ab4f27658d6795f544c797b60352
-  data.tar.gz: 3c003390bc80cacd838dd2b14872338e8151fb102fe4ac3e4d17eac04c088d2ccf3bf2722fac28683ec31b7eaeb4edb4ac309da49b940421c4c9f1b8e43c3e6b
+  metadata.gz: a4c1fd13840b7a5aed4e3c496188fad9e7d0a3302fd853728cc17e13d5292fe2fdf546db8c8b01596059a7d97986e7b0d032c334d395f5999103479fe353fd44
+  data.tar.gz: a1349db39a6ef79da9dce7e9ef0ea125065e8df19b54dea8f27fed7ff661829d5396a2652c139dcf588acfd402cf1ef8a1e8d73225b598ecc4cf92193058ca09

data/README.md

@@ -1,20 +1,33 @@
 # Boxroom
+[![Gem Version](https://badge.fury.io/rb/boxroom.svg)](https://badge.fury.io/rb/boxroom)
+
 This is a Rails engine built based on code of [Boxroom](https://github.com/mischa78/boxroom) project.
 
 # Features
 It aims to be a simple interface for managing and
-sharing files in a web browser. It lets users create folders and upload, download
-and share files. Admins can manage users, groups and permissions.
+sharing files in a web browser. It lets users 
+- create folders
+- upload files
+- download files
+- share files
+- search folders and files 
+
+Admins can:
+- manage users
+- manage groups
+- manage access permissions
+
+Integrates with existing User model amd authentication system.
 
 ![Boxroom](https://res.cloudinary.com/skoba/image/upload/v1518819948/Boxroom_vzqhre.png)
 
 ## Install
-- add to Gemfile `gem 'boxroom', github: 'sergey-koba-mobidev/boxroom-engine'`
+- add to Gemfile `gem 'boxroom'`
 - run `rails boxroom:install:migrations`
 - run `rails db:migrate`
 - mount engine in `config/routes.rb`
 ```ruby
-mount Boxroom::Engine => "/boxroom"
+mount Boxroom::Engine => '/boxroom'
 ```
 
 ## Config
@@ -29,9 +42,33 @@ Boxroom.configure do |config|
   config.show_groups = true
   config.show_settings = true
   config.show_shared_files = true
-  config.sign_out_path = nil # pass string to redirect to after sign out. '/dashboard' for example
+  config.show_search = true
+end
+```
+
+## Integrate with existing User model and authentication
+- Create `config/initializers/boxroom.rb`
+```ruby
+Boxroom.configure do |config|
+  config.current_user_method = 'current_user' # a method in your application, which returns authenticated User, Boxroom's authentication is disabled
+  config.sign_in_path = '/login' # pass string to redirect unauthenticated user to
+  config.sign_out_path = '/logout' # pass string to redirect to after sign out, '/dashboard' for example. Or it could be sign out page of you main app
 end
 ```
+- add `boxroom` to your User model.
+- Remember you can provide User model methods names instead of fields names too. For example
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  # :username and :email are attributes of User model
+  boxroom name: :username, email: :email, is_admin: :is_admin? # all params are required
+  
+  def is_admin?
+    email == 'admin@test.com' # Remember only 1 user can be a real admin
+  end
+end
+```
+- if you modify your users without callbacks in any place you should also take care of `boxroom_users` table yourself.
 
 ## Contributing
 Please feel free to leave an issue or PR.
@@ -44,7 +81,7 @@ Please feel free to leave an issue or PR.
 The engine is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 ## Roadmap:
-- tests for search
-- tag files
-- integrate with existing user model
 - support s3
+- batch actions
+- tag files
+- integrate with active_admin

data/app/concepts/boxroom/search/operations/files_and_folders.rb

@@ -12,7 +12,7 @@ module Boxroom::Search
 
     def search_folder(term, folder, options)
       options['folders'] << folder if folder.name.downcase.include? term.downcase
-      options['files'] += folder.user_files.where("lower(attachment_file_name) LIKE ?", "%#{term.downcase}%").all.to_a
+      options['files'] += folder.user_files.where('lower(attachment_file_name) LIKE ?', "%#{term.downcase}%").all.to_a
       folder.children.each do |f|
         search_folder(term, f, options)
       end

data/app/controllers/boxroom/application_controller.rb

@@ -1,5 +1,5 @@
 module Boxroom
-  class ApplicationController < ActionController::Base
+  class ApplicationController < "::#{Boxroom.configuration.parent_controller}".constantize
     protect_from_forgery
   end
 end

data/app/controllers/boxroom/clipboard_controller.rb

@@ -78,7 +78,7 @@ module Boxroom
     # current folder (identified by params[:folder_id]) if not.
     %w{read delete}.each do |method|
       define_method "require_#{method}_permission" do
-        unless current_user.send("can_#{method}", @folder)
+        unless boxroom_current_user.send("can_#{method}", @folder)
           redirect_to folder_url(params[:folder_id]), :alert => t(:no_permissions_for_this_type, :method => t(method), :type => t("this_#{params[:type]}"))
         end
       end

data/app/controllers/boxroom/files_controller.rb

@@ -28,6 +28,7 @@ module Boxroom
           folder_id: params[:target_folder_id]
       ).first
 
+      #TODO: refactor to support S3
       if existing_file # Resume upload
         existing_file.update_attribute(:attachment_file_size, existing_file.attachment_file_size + permitted_params.user_file["attachment"].size)
         File.open("#{Rails.root}/#{Boxroom.configuration.uploads_path}/#{Rails.env}/#{existing_file.id}/original/#{existing_file.id}", "ab") {|f| f.write(permitted_params.user_file["attachment"].read)}
@@ -60,7 +61,7 @@ module Boxroom
     def exists
       @folder = Folder.find(params[:folder])
 
-      if current_user.can_read(@folder) || current_user.can_write(@folder)
+      if boxroom_current_user.can_read(@folder) || boxroom_current_user.can_write(@folder)
         @file = @folder.user_files.build(:attachment_file_name => params[:name].gsub(Boxroom::RESTRICTED_CHARACTERS, '_'))
         render :json => !@file.valid?
       end

data/app/controllers/boxroom/folders_controller.rb

@@ -70,7 +70,7 @@ module Boxroom
 
     # Overrides require_delete_permission in ApplicationController
     def require_delete_permission
-      unless @folder.is_root? || current_user.can_delete(@folder)
+      unless @folder.is_root? || boxroom_current_user.can_delete(@folder)
         redirect_to @folder.parent, :alert => t(:no_permissions_for_this_type, :method => t(:delete), :type => t(:this_folder))
       else
         require_delete_permissions_for(@folder.children)
@@ -79,7 +79,7 @@ module Boxroom
 
     def require_delete_permissions_for(folders)
       folders.each do |folder|
-        unless current_user.can_delete(folder)
+        unless boxroom_current_user.can_delete(folder)
           redirect_to @folder.parent, :alert => t(:no_delete_permissions_for_subfolder)
         else
           # Recursive...

data/app/controllers/boxroom/sessions_controller.rb

@@ -16,7 +16,7 @@ module Boxroom
           cookies[:auth_token] = {:value => user.remember_token, :expires => 2.weeks.from_now}
         end
 
-        session[:user_id] = user.id
+        session[:boxroom_user_id] = user.id
         redirect_url = session.delete(:return_to) || folders_url
         redirect_to redirect_url, :only_path => true
       else
@@ -26,10 +26,10 @@ module Boxroom
     end
 
     def destroy
-      current_user.forget_me
+      boxroom_current_user.forget_me
       cookies.delete :auth_token
       reset_session
-      session[:user_id] = nil
+      session[:boxroom_user_id] = nil
       redirect_to Boxroom.configuration.sign_out_path ? Boxroom.configuration.sign_out_path : new_session_url
     end
 

data/app/controllers/boxroom/share_links_controller.rb

@@ -27,7 +27,7 @@ module Boxroom
     # Note: @file and @folder are set in require_existing_file
     def create
       @share_link = @file.share_links.build(permitted_params.share_link)
-      @share_link.user = current_user
+      @share_link.user = boxroom_current_user
 
       if @share_link.save
         UserMailer.share_link_email(@share_link).deliver_now

data/app/controllers/boxroom/users_controller.rb

@@ -55,12 +55,12 @@ module Boxroom
     private
 
     def require_existing_user
-      if current_user.member_of_admins? && params[:id] != current_user.id.to_s
+      if boxroom_current_user.member_of_admins? && params[:id] != boxroom_current_user.id.to_s
         @title = t(:edit_user)
         @user = User.find(params[:id])
       else
         @title = t(:account_settings)
-        @user = current_user
+        @user = boxroom_current_user
       end
     rescue ActiveRecord::RecordNotFound
       redirect_to users_url, :alert => t(:user_already_deleted)

data/app/controllers/concerns/boxroom/base_controller.rb

@@ -6,11 +6,11 @@ module Boxroom
       before_action :require_admin_in_system
       before_action :require_login
 
-      helper_method :clipboard, :current_user, :signed_in?, :permitted_params
+      helper_method :clipboard, :boxroom_current_user, :signed_in?, :permitted_params
 
       %w{read update delete}.each do |method|
         define_method "require_#{method}_permission" do
-          unless (method == 'read' && @folder.is_root?) || current_user.send("can_#{method}", @folder)
+          unless (method == 'read' && @folder.is_root?) || boxroom_current_user.send("can_#{method}", @folder)
             redirect_folder = @folder.parent.nil? ? Folder.root : @folder.parent
             redirect_to redirect_folder, :alert => t(:no_permissions_for_this_type, :method => t(:create), :type => t(:this_folder))
           end
@@ -36,16 +36,23 @@ module Boxroom
       cl
     end
 
-    def current_user
-      @current_user ||= User.find_by_id(session[:user_id])
+    def boxroom_current_user
+      # integrate with existing User model
+      if Boxroom.configuration.current_user_method && @current_user.nil?
+        original_user = send(Boxroom.configuration.current_user_method)
+        boxroom_user = User.find_by_original_id(original_user.id)
+        session[:boxroom_user_id] = boxroom_user.id if boxroom_user
+      end
+
+      @current_user ||= User.find_by_id(session[:boxroom_user_id])
     end
 
     def signed_in?
-      !!current_user
+      !!boxroom_current_user
     end
 
     def permitted_params
-      @permitted_params ||= PermittedParams.new(params, current_user)
+      @permitted_params ||= PermittedParams.new(params, boxroom_current_user)
     end
 
     def require_admin_in_system
@@ -53,21 +60,21 @@ module Boxroom
     end
 
     def require_admin
-      redirect_to :root unless current_user.member_of_admins?
+      redirect_to :root unless boxroom_current_user.member_of_admins?
     end
 
     def require_login
-      if current_user.nil?
+      if boxroom_current_user.nil?
         user = User.find_by_remember_token(cookies[:auth_token]) unless cookies[:auth_token].blank?
 
         if user.nil?
           reset_session
-          session[:user_id] = nil
+          session[:boxroom_user_id] = nil
           session[:return_to] = request.fullpath
-          redirect_to new_session_url
+          redirect_to Boxroom.configuration.sign_in_path ? Boxroom.configuration.sign_in_path : new_session_url
         else
           user.refresh_remember_token
-          session[:user_id] = user.id
+          session[:boxroom_user_id] = user.id
           cookies[:auth_token] = user.remember_token
         end
       end
@@ -78,7 +85,7 @@ module Boxroom
     end
 
     def require_create_permission
-      unless current_user.can_create(@target_folder)
+      unless boxroom_current_user.can_create(@target_folder)
         redirect_to @target_folder, :alert => t(:no_permissions_for_this_type, :method => t(:create), :type => t(:this_folder))
       end
     end

data/app/models/boxroom/user_file.rb

@@ -16,6 +16,7 @@ module Boxroom
       new_file.folder = target_folder
       new_file.save!
 
+      #TODO: refactor to support S3
       path = "#{Rails.root}/#{Boxroom.configuration.uploads_path}/#{Rails.env}/#{new_file.id}/original"
       FileUtils.mkdir_p path
       FileUtils.cp_r self.attachment.path, "#{path}/#{new_file.id}"

data/app/views/boxroom/clipboard/_show.html.erb

@@ -15,13 +15,13 @@
             <td><%= image_tag('boxroom/folder.png') %></td>
             <td class="clipboard_item"><%= item.name %></td>
             <td>
-              <% if current_user.can_create(@folder) -%>
+              <% if boxroom_current_user.can_create(@folder) -%>
                   <%= link_to image_tag('boxroom/copy.png', :alt => t(:copy)),
                               {:controller => :clipboard, :action => :copy, :id => item.id, :type => 'folder', :folder_id => @folder, :authenticity_token => form_authenticity_token},
                               :method => :post, :title => t(:copy_folder)
                   %>&nbsp;
               <% end -%>
-              <% if current_user.can_create(@folder) && current_user.can_delete(item) -%>
+              <% if boxroom_current_user.can_create(@folder) && boxroom_current_user.can_delete(item) -%>
                   <%= link_to image_tag('boxroom/move.png', :alt => t(:move)),
                               {:controller => :clipboard, :action => :move, :id => item.id, :type => 'folder', :folder_id => @folder, :authenticity_token => form_authenticity_token},
                               :method => :post, :title => t(:move_folder), :data => {:confirm => t(:are_you_sure)}
@@ -39,13 +39,13 @@
             <td><%= image_tag(file_icon(item.extension)) %></td>
             <td class="clipboard_item"><%= item.attachment_file_name %></td>
             <td>
-              <% if current_user.can_create(@folder) -%>
+              <% if boxroom_current_user.can_create(@folder) -%>
                   <%= link_to '<span class="icon is-small"><i class="fa fa-copy"></i></span>'.html_safe,
                               {:controller => :clipboard, :action => :copy, :id => item.id, :type => 'file', :folder_id => @folder, :authenticity_token => form_authenticity_token},
                               :method => :post, :title => t(:copy_file)
                   %>&nbsp;
               <% end -%>
-              <% if current_user.can_create(@folder) && current_user.can_delete(item.folder) -%>
+              <% if boxroom_current_user.can_create(@folder) && boxroom_current_user.can_delete(item.folder) -%>
                   <%= link_to '<span class="icon is-small"><i class="fa fa-cut"></i></span>'.html_safe,
                               {:controller => :clipboard, :action => :move, :id => item.id, :type => 'file', :folder_id => @folder, :authenticity_token => form_authenticity_token},
                               :method => :post, :title => t(:move_file), :data => {:confirm => t(:are_you_sure)}

data/app/views/boxroom/folders/show.html.erb

@@ -12,7 +12,7 @@
 
 <div class="tabs">
   <ul>
-    <% if current_user.can_create(@folder) -%>
+    <% if boxroom_current_user.can_create(@folder) -%>
         <li>
           <a href="<%= new_folder_folder_path(@folder) %>">
             <span class="icon is-small"><i class="fa fa-folder"></i></span>
@@ -26,7 +26,7 @@
           </a>
         </li>
     <% end -%>
-    <% if current_user.member_of_admins? -%>
+    <% if boxroom_current_user.member_of_admins? -%>
         <li>
           <a href="#" id="permissions_link" class="permissions_link">
             <span class="icon is-small"><i class="fa fa-lock"></i></span>
@@ -43,23 +43,25 @@
   </ul>
 </div>
 
-<%= form_tag(search_path, method: :get) do %>
-    <div class="field">
-      <div class="control">
-        <%= text_field_tag 'term', nil, placeholder: t(:search), size: 71, class: 'input' %>
-      </div>
-    </div>
-    <%= hidden_field_tag 'folder_id', @folder.id %>
+<% if Boxroom.configuration.show_search %>
+    <%= form_tag(search_path, method: :get) do %>
+        <div class="field">
+          <div class="control">
+            <%= text_field_tag 'term', nil, placeholder: t(:search), size: 71, class: 'input' %>
+          </div>
+        </div>
+        <%= hidden_field_tag 'folder_id', @folder.id %>
+    <% end %>
 <% end %>
 
 <div id="files_and_folders">
   <%= concept(Boxroom::Folder::Cell::Show, @folder,
               folders: @folder.children,
               files: @folder.user_files,
-              current_user: current_user) %>
+              current_user: boxroom_current_user) %>
 </div>
 
-<% if current_user.member_of_admins? -%>
+<% if boxroom_current_user.member_of_admins? -%>
     <div id="permissions" style="display:none;">
       <%= render 'boxroom/permissions/form' %>
     </div>

data/app/views/boxroom/search/show.html.erb

@@ -5,7 +5,7 @@
 <%= concept(Boxroom::Folder::Cell::Show, nil,
             folders: @folders,
             files: @files,
-            current_user: current_user
+            current_user: boxroom_current_user
     ) %>
 
 <div class="field">

data/app/views/boxroom/shared/_header.html.erb

@@ -13,7 +13,7 @@
     <div class="navbar-start">
       <% if signed_in? -%>
           <%= link_to t(:folders), folders_path, class: 'navbar-item' %>
-          <% if current_user.member_of_admins? -%>
+          <% if boxroom_current_user.member_of_admins? -%>
               <% if Boxroom.configuration.show_users %>
                   <%= link_to t(:users), users_path, class: 'navbar-item' %>
               <% end %>
@@ -30,10 +30,10 @@
     <div class="navbar-end">
       <% if signed_in? -%>
           <div class="navbar-item">
-            <%= t :hello %>, <b><%= current_user.name %></b>
+            <%= t :hello %>, <b><%= boxroom_current_user.name %></b>
           </div>
           <% if Boxroom.configuration.show_settings %>
-              <%= link_to t(:settings), edit_user_path(current_user), class: 'navbar-item' %>
+              <%= link_to t(:settings), edit_user_path(boxroom_current_user), class: 'navbar-item' %>
           <% end %>
           <div class="navbar-item">
             <%= link_to t(:sign_out), signout_path, method: :delete, class: 'button is-danger' %>

data/app/views/boxroom/users/_form.html.erb

@@ -32,7 +32,7 @@
           </div>
         </div>
     <% end -%>
-    <% if signed_in? && current_user.member_of_admins? -%>
+    <% if signed_in? && boxroom_current_user.member_of_admins? -%>
         <div class="field">
           <%= label_tag t(:member_of_these_groups), nil, class: 'label' %>
           <div class="control">
@@ -54,7 +54,7 @@
       <div class="control">
         <%= f.submit t(:save), class: 'button is-link' %>
       </div>
-      <% if @user != current_user -%>
+      <% if @user != boxroom_current_user -%>
           <div class="control">
             <%= link_to t(:back), users_url, class: 'button is-text' %>
           </div>

data/db/migrate/20180309104530_add_original_id_to_users.rb

@@ -0,0 +1,5 @@
+class AddOriginalIdToUsers < ActiveRecord::Migration[5.1]
+  def change
+    add_column :boxroom_users, :original_id, :integer
+  end
+end

data/lib/boxroom/active_record.rb

@@ -0,0 +1,4 @@
+ActiveSupport.on_load(:active_record) do
+  include Boxroom::Models::InstanceMethods
+  extend Boxroom::Models::ClassMethods
+end

data/lib/boxroom/configuration.rb

@@ -1,18 +1,36 @@
 module Boxroom
   class Configuration
-    attr_accessor :site_name, :logo, :show_footer, :show_users, :show_groups, :show_settings, :show_shared_files,
-                  :sign_out_path, :uploads_path
+    attr_accessor :site_name,
+                  :logo,
+                  :show_footer,
+                  :show_users,
+                  :show_groups,
+                  :show_settings,
+                  :show_shared_files,
+                  :show_search,
+                  :uploads_path,
+                  :current_user_method,
+                  :sign_in_path,
+                  :sign_out_path,
+                  :parent_controller
 
     def initialize
       @site_name         = 'Boxroom'
       @logo              = 'boxroom/logo.png'
-      @uploads_path      = 'uploads'
       @show_footer       = true
       @show_users        = true
       @show_groups       = true
       @show_settings     = true
       @show_shared_files = true
-      @sign_out_path     = nil
+      @show_search       = true
+      @uploads_path      = 'uploads'
+
+      # Integrate with existing user model
+      @current_user_method = nil
+      @sign_in_path        = nil
+      @sign_out_path       = nil
+
+      @parent_controller = 'ApplicationController'
     end
   end
 end

data/lib/boxroom/models.rb

@@ -0,0 +1,33 @@
+module Boxroom
+  module Models
+    module ClassMethods
+      def boxroom(params)
+        throw "Provide 'name:' param for 'boxroom' method in your user model" if params[:name].nil?
+        throw "Provide 'email:' param for 'boxroom' method in your user model" if params[:email].nil?
+        throw "Provide 'is_admin:' param for 'boxroom' method in your user model" if params[:is_admin].nil?
+
+        after_save -> { save_boxroom_user(params) }
+        before_destroy -> { destroy_boxroom_user(params) }
+      end
+    end
+
+    module InstanceMethods
+      def save_boxroom_user(params)
+        bu = Boxroom::User.find_by_original_id(id)
+        bu = Boxroom::User.new if bu.nil?
+        bu.original_id = id
+        bu.name = send(params[:name])
+        bu.email = send(params[:email])
+        bu.is_admin = send(params[:is_admin])
+        bu.save
+        throw "Failed to save Boxroom::User with email=#{bu.email}" unless bu.persisted?
+      end
+
+      def destroy_boxroom_user(params)
+        bu = Boxroom::User.find_by_original_id(id)
+        bu.destroy if bu
+        true
+      end
+    end
+  end
+end

data/lib/boxroom/version.rb

@@ -1,3 +1,3 @@
 module Boxroom
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/boxroom.rb

@@ -1,10 +1,13 @@
 require 'boxroom/engine'
+require 'boxroom/configuration'
+require 'boxroom/models'
+require 'boxroom/active_record'
+
 require 'dynamic_form'
 require 'jquery-rails'
 require 'jquery-fileupload-rails'
 require 'acts_as_tree'
 require 'paperclip'
-require 'boxroom/configuration'
 require 'paperclip/spoof_detector'
 require 'bulma-rails'
 require 'font-awesome-rails'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxroom
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Serge Koba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -448,9 +448,12 @@ files:
 - db/migrate/20120411081345_boxroom_add_column_signup_token_expires_at_to_users.rb
 - db/migrate/20130626210927_boxroom_add_columns_message_user_id_to_share_links.rb
 - db/migrate/20130628082245_boxroom_populate_user_id_in_share_links.rb
+- db/migrate/20180309104530_add_original_id_to_users.rb
 - lib/boxroom.rb
+- lib/boxroom/active_record.rb
 - lib/boxroom/configuration.rb
 - lib/boxroom/engine.rb
+- lib/boxroom/models.rb
 - lib/boxroom/version.rb
 - lib/paperclip/spoof_detector.rb
 - lib/tasks/boxroom_tasks.rake