inkwell 1.1.1 → 1.1.7

data/db/migrate/20130212130878_change_community_table_for_adding_types_and_user_access.rb

@@ -0,0 +1,14 @@
+class ChangeCommunityTableForAddingTypesAndUserAccess < ActiveRecord::Migration
+  def change
+    if ::Inkwell::Engine::config.respond_to?('community_table')
+      add_column ::Inkwell::Engine::config.community_table, :default_user_access, :string, :default => 'w'
+      add_column ::Inkwell::Engine::config.community_table, :writers_ids, :text, :default => '[]'
+      add_column ::Inkwell::Engine::config.community_table, :banned_ids, :text, :default => '[]'
+      add_column ::Inkwell::Engine::config.community_table, :muted_ids, :text, :default => '[]'
+      add_column ::Inkwell::Engine::config.community_table, :invitations_uids, :text, :default => '[]'
+      add_column ::Inkwell::Engine::config.community_table, :public, :boolean, :default => true
+      rename_column ::Inkwell::Engine::config.user_table, :communities_ids, :communities_info
+      remove_column ::Inkwell::Engine::config.user_table, :admin_of
+    end
+  end
+end

data/lib/acts_as_inkwell_community/base.rb

@@ -27,16 +27,22 @@ module Inkwell
       def add_user(options = {})
         options.symbolize_keys!
         user = options[:user]
-        return if self.include_user? user
+        raise "this user is already in this community" if self.include_user? user
+        raise "this user is banned" if self.include_banned_user? user
 
         users_ids = ActiveSupport::JSON.decode self.users_ids
         users_ids << user.id
         self.users_ids = ActiveSupport::JSON.encode users_ids
+        if (self.default_user_access == CommunityAccessLevels::WRITE) && !(self.include_muted_user? user)
+          writers_ids = ActiveSupport::JSON.decode self.writers_ids
+          writers_ids << user.id
+          self.writers_ids = ActiveSupport::JSON.encode writers_ids
+        end
         self.save
 
-        communities_ids = ActiveSupport::JSON.decode user.communities_ids
-        communities_ids << self.id
-        user.communities_ids = ActiveSupport::JSON.encode communities_ids
+        communities_info = ActiveSupport::JSON.decode user.communities_info
+        communities_info << Hash[HashParams::COMMUNITY_ID => self.id, HashParams::ACCESS_LEVEL => self.default_user_access]
+        user.communities_info = ActiveSupport::JSON.encode communities_info
         user.save
 
         post_class = Object.const_get ::Inkwell::Engine::config.post_table.to_s.singularize.capitalize
@@ -73,11 +79,20 @@ module Inkwell
         users_ids = ActiveSupport::JSON.decode self.users_ids
         users_ids.delete user.id
         self.users_ids = ActiveSupport::JSON.encode users_ids
+
+        writers_ids = ActiveSupport::JSON.decode self.writers_ids
+        writers_ids.delete user.id
+        self.writers_ids = ActiveSupport::JSON.encode writers_ids
+
+        admins_info = ActiveSupport::JSON.decode self.admins_info
+        admins_info.delete_if{|item| item['admin_id'] == user.id}
+        self.admins_info = ActiveSupport::JSON.encode admins_info
+
         self.save
 
-        communities_ids = ActiveSupport::JSON.decode user.communities_ids
-        communities_ids.delete self.id
-        user.communities_ids = ActiveSupport::JSON.encode communities_ids
+        communities_info = ActiveSupport::JSON.decode user.communities_info
+        communities_info.delete_if {|item| item[HashParams::COMMUNITY_ID] == self.id}
+        user.communities_info = ActiveSupport::JSON.encode communities_info
         user.save
 
         timeline_items = ::Inkwell::TimelineItem.where(:owner_id => user.id, :owner_type => OwnerTypes::USER).where "from_source like '%{\"community_id\":#{self.id}%'"
@@ -91,27 +106,135 @@ module Inkwell
         end
       end
 
+      def include_writer?(user)
+        check_user user
+        writers_ids = ActiveSupport::JSON.decode self.writers_ids
+        writers_ids.include? user.id
+      end
+
       def include_user?(user)
         check_user user
-        communities_ids = ActiveSupport::JSON.decode user.communities_ids
-        communities_ids.include? self.id
+        communities_info = ActiveSupport::JSON.decode user.communities_info
+        (communities_info.index{|item| item[HashParams::COMMUNITY_ID] == self.id}) ? true : false
+      end
+
+      def mute_user(options = {})
+        options.symbolize_keys!
+        user = options[:user]
+        admin = options[:admin]
+        raise "user should be passed in params" unless user
+        raise "admin should be passed in params" unless admin
+        check_user user
+        check_user admin
+        raise "admin is not admin" unless self.include_admin? admin
+        raise "user should be a member of this community" unless self.include_user? user
+        raise "this user is already muted" if self.include_muted_user? user
+        raise "it is impossible to mute yourself" if user == admin
+        raise "admin has no permissions to mute this user" if (self.include_admin? user) && (admin_level_of(admin) >= admin_level_of(user))
+
+
+        muted_ids = ActiveSupport::JSON.decode self.muted_ids
+        muted_ids << user.id
+        self.muted_ids = ActiveSupport::JSON.encode muted_ids
+        self.save
+      end
+
+      def unmute_user(options = {})
+        options.symbolize_keys!
+        user = options[:user]
+        admin = options[:admin]
+        raise "user should be passed in params" unless user
+        raise "admin should be passed in params" unless admin
+        check_user user
+        check_user admin
+        raise "admin is not admin" unless self.include_admin? admin
+        raise "user should be a member of this community" unless self.include_user? user
+        raise "this user is not muted" unless self.include_muted_user? user
+        raise "admin has no permissions to unmute this user" if (self.include_admin? user) && (admin_level_of(admin) >= admin_level_of(user))
+
+        muted_ids = ActiveSupport::JSON.decode self.muted_ids
+        muted_ids.delete user.id
+        self.muted_ids = ActiveSupport::JSON.encode muted_ids
+        self.save
+      end
+
+      def include_muted_user?(user)
+        check_user user
+        muted_ids = ActiveSupport::JSON.decode self.muted_ids
+        muted_ids.include? user.id
+      end
+
+      def ban_user(options = {})
+        options.symbolize_keys!
+        user = options[:user]
+        admin = options[:admin]
+        raise "user should be passed in params" unless user
+        raise "admin should be passed in params" unless admin
+        check_user user
+        check_user admin
+        raise "admin is not admin" unless self.include_admin? admin
+        if self.public
+          raise "user should be a member of public community" unless self.include_user?(user)
+        else
+          raise "user should be a member of private community or send invitation request to it" unless self.include_user?(user) || self.include_invitation_request?(user)
+        end
+        raise "this user is already banned" if self.include_banned_user? user
+        raise "admin has no permissions to ban this user" if (self.include_admin? user) && (admin_level_of(admin) >= admin_level_of(user))
+
+        banned_ids = ActiveSupport::JSON.decode self.banned_ids
+        banned_ids << user.id
+        self.banned_ids = ActiveSupport::JSON.encode banned_ids
+        self.save
+        unless self.public
+          self.reject_invitation_request :admin => admin, :user => user if self.include_invitation_request? user
+        end
+        self.remove_user :admin => admin, :user => user
+      end
+
+      def unban_user(options = {})
+        options.symbolize_keys!
+        user = options[:user]
+        admin = options[:admin]
+        raise "user should be passed in params" unless user
+        raise "admin should be passed in params" unless admin
+        check_user user
+        check_user admin
+        raise "admin is not admin" unless self.include_admin? admin
+        raise "this user is not banned" unless self.include_banned_user? user
+
+        banned_ids = ActiveSupport::JSON.decode self.banned_ids
+        banned_ids.delete user.id
+        self.banned_ids = ActiveSupport::JSON.encode banned_ids
+        self.save
+      end
+
+      def include_banned_user?(user)
+        check_user user
+        banned_ids = ActiveSupport::JSON.decode self.banned_ids
+        banned_ids.include? user.id
       end
 
       def add_admin(options = {})
         options.symbolize_keys!
         user = options[:user]
         admin = options[:admin]
+        raise "user should be passed in params" unless user
         raise "admin should be passed in params" unless admin
-        raise "user is already admin" if self.include_admin?(user)
-        raise "admin is not admin" unless self.include_admin?(admin)
-        raise "user should be a member of this community" unless self.include_user?(user)
+        check_user user
+        check_user admin
+        raise "user is already admin" if self.include_admin? user
+        raise "admin is not admin" unless self.include_admin? admin
+        raise "user should be a member of this community" unless self.include_user? user
 
-        admin_level_granted_for_user = admin_level_of(admin) + 1
+        self.unmute_user :user => user, :admin => admin if self.include_muted_user? user
 
-        admin_positions = ActiveSupport::JSON.decode user.admin_of
-        admin_positions << Hash['community_id' => self.id, 'admin_level' => admin_level_granted_for_user]
-        user.admin_of = ActiveSupport::JSON.encode admin_positions
-        user.save
+        unless self.include_writer? user
+          writers_ids = ActiveSupport::JSON.decode self.writers_ids
+          writers_ids << user.id
+          self.writers_ids = ActiveSupport::JSON.encode writers_ids
+        end
+
+        admin_level_granted_for_user = admin_level_of(admin) + 1
 
         admins_info = ActiveSupport::JSON.decode self.admins_info
         admins_info << Hash['admin_id' => user.id, 'admin_level' => admin_level_granted_for_user]
@@ -130,11 +253,6 @@ module Inkwell
         raise "admin has no permissions to delete this user from admins" if (admin_level_of(admin) >= admin_level_of(user)) && (user != admin)
         raise "community owner can not be removed from admins" if admin_level_of(user) == 0
 
-        admin_positions = ActiveSupport::JSON.decode user.admin_of
-        admin_positions.delete_if{|rec| rec['community_id'] == self.id}
-        user.admin_of = ActiveSupport::JSON.encode admin_positions
-        user.save
-
         admins_info = ActiveSupport::JSON.decode self.admins_info
         admins_info.delete_if{|rec| rec['admin_id'] == user.id}
         self.admins_info = ActiveSupport::JSON.encode admins_info
@@ -142,16 +260,17 @@ module Inkwell
       end
 
       def admin_level_of(admin)
-        admin_positions = ActiveSupport::JSON.decode admin.admin_of
-        index = admin_positions.index{|item| item['community_id'] == self.id}
+        admin_positions = ActiveSupport::JSON.decode self.admins_info
+        index = admin_positions.index{|item| item['admin_id'] == admin.id}
         raise "admin is not admin" unless index
         admin_positions[index]['admin_level']
       end
 
       def include_admin?(user)
         check_user user
-        admin_positions = ActiveSupport::JSON.decode user.admin_of
-        (admin_positions.index{|item| item['community_id'] == self.id} == nil) ? false : true
+
+        admin_positions = ActiveSupport::JSON.decode self.admins_info
+        (admin_positions.index{|item| item['admin_id'] == user.id}) ? true : false
       end
 
       def add_post(options = {})
@@ -159,7 +278,8 @@ module Inkwell
         user = options[:user]
         post = options[:post]
         raise "user should be passed in params" unless user
-        raise "user should be a member of community" unless self.include_user?(user)
+        raise "user should be a member of community" unless self.include_user? user
+        raise "user is muted" if self.include_muted_user? user
         raise "post should be passed in params" unless post
         check_post post
         user_id_attr = "#{::Inkwell::Engine::config.user_table.to_s.singularize}_id"
@@ -263,22 +383,74 @@ module Inkwell
         ActiveSupport::JSON.decode self.users_ids
       end
 
+      def create_invitation_request(user)
+        raise "invitation request was already created" if self.include_invitation_request? user
+        raise "it is impossible to create request. user is banned in this community" if self.include_banned_user? user
+        raise "it is impossible to create request for public community" if self.public
+
+        invitations_uids = ActiveSupport::JSON.decode self.invitations_uids
+        invitations_uids << user.id
+        self.invitations_uids = ActiveSupport::JSON.encode invitations_uids
+        self.save
+      end
+
+      def accept_invitation_request(options = {})
+        options.symbolize_keys!
+        user = options[:user]
+        admin = options[:admin]
+        check_user user
+        check_user admin
+        raise "admin is not admin in this community" unless self.include_admin? admin
+        raise "this user is already in this community" if self.include_user? user
+        raise "there is no invitation request for this user" unless self.include_invitation_request? user
+
+        self.add_user :user => user
+
+        remove_invitation_request user
+      end
+
+      def reject_invitation_request(options = {})
+        options.symbolize_keys!
+        user = options[:user]
+        admin = options[:admin]
+        check_user user
+        check_user admin
+        raise "there is no invitation request for this user" unless self.include_invitation_request? user
+        raise "admin is not admin in this community" unless self.include_admin? admin
+
+        remove_invitation_request user
+      end
+
+      def include_invitation_request?(user)
+        raise "invitations work only for private community. this community is public." if self.public
+        invitations_uids = ActiveSupport::JSON.decode self.invitations_uids
+        (invitations_uids.index{|uid| uid == user.id}) ? true : false
+      end
+
+
+
       private
+
+      def remove_invitation_request(user)
+        invitations_uids = ActiveSupport::JSON.decode self.invitations_uids
+        invitations_uids.delete user.id
+        self.invitations_uids = ActiveSupport::JSON.encode invitations_uids
+        self.save
+      end
+
       def processing_a_community
         user_class = Object.const_get ::Inkwell::Engine::config.user_table.to_s.singularize.capitalize
-        user = user_class.find self.owner_id
+        owner = user_class.find self.owner_id
 
-        admin_positions = ActiveSupport::JSON.decode user.admin_of
-        admin_positions << Hash['community_id' => self.id, 'admin_level' => 0]
-        user.admin_of = ActiveSupport::JSON.encode admin_positions
-        communities_ids = ActiveSupport::JSON.decode user.communities_ids
-        communities_ids << self.id
-        user.communities_ids = ActiveSupport::JSON.encode communities_ids
-        user.save
+        communities_info = ActiveSupport::JSON.decode owner.communities_info
+        communities_info << Hash[HashParams::COMMUNITY_ID => self.id, HashParams::ACCESS_LEVEL => self.default_user_access]
+        owner.communities_info = ActiveSupport::JSON.encode communities_info
+        owner.save
 
-        admins_info = [Hash['admin_id' => user.id, 'admin_level' => 0]]
+        admins_info = [Hash['admin_id' => owner.id, 'admin_level' => 0]]
         self.admins_info = ActiveSupport::JSON.encode admins_info
-        self.users_ids = ActiveSupport::JSON.encode [user.id]
+        self.users_ids = ActiveSupport::JSON.encode [owner.id]
+        self.writers_ids = ActiveSupport::JSON.encode [owner.id]
         self.save
       end
 
@@ -287,12 +459,9 @@ module Inkwell
         users_ids = ActiveSupport::JSON.decode self.users_ids
         users_ids.each do |user_id|
           user = user_class.find user_id
-          admin_positions = ActiveSupport::JSON.decode user.admin_of
-          admin_positions.delete_if{|rec| rec['community_id'] == self.id}
-          user.admin_of = ActiveSupport::JSON.encode admin_positions
-          communities_ids = ActiveSupport::JSON.decode user.communities_ids
-          communities_ids.delete self.id
-          user.communities_ids = ActiveSupport::JSON.encode communities_ids
+          communities_info = ActiveSupport::JSON.decode user.communities_info
+          communities_info.delete_if {|item| item[HashParams::COMMUNITY_ID] == self.id}
+          user.communities_info = ActiveSupport::JSON.encode communities_info
           user.save
         end
 

data/lib/acts_as_inkwell_user/base.rb

@@ -54,7 +54,7 @@ module Inkwell
         result
       end
 
-      def create_comment(options={})
+      def create_comment(options = {})
         options.symbolize_keys!
         raise "for_object should be passed" unless options[:for_object]
         raise "comment body should be passed" unless options[:body]
@@ -66,7 +66,12 @@ module Inkwell
       end
 
       def communities_row
-        ActiveSupport::JSON.decode self.communities_ids
+        communities_info = ActiveSupport::JSON.decode self.communities_info
+        result = []
+        communities_info.each do |item|
+          result << item[HashParams::COMMUNITY_ID]
+        end
+        result
       end
 
       def favorite(obj)
@@ -306,6 +311,7 @@ module Inkwell
       #wrappers for community methods
 
       def join(open_community)
+        raise "it is impossible to join private community. use invitation request to do it." unless open_community.public
         open_community.add_user :user => self
       end
 
@@ -320,10 +326,46 @@ module Inkwell
         from_community.remove_user :user => user, :admin => self
       end
 
+      def ban(options = {})
+        options.symbolize_keys!
+        in_community = options[:in_community]
+        user = options[:user]
+        in_community.ban_user :user => user, :admin => self
+      end
+
+      def unban(options = {})
+        options.symbolize_keys!
+        in_community = options[:in_community]
+        user = options[:user]
+        in_community.unban_user :user => user, :admin => self
+      end
+
+      def mute(options = {})
+        options.symbolize_keys!
+        in_community = options[:in_community]
+        user = options[:user]
+        in_community.mute_user :user => user, :admin => self
+      end
+
+      def unmute(options = {})
+        options.symbolize_keys!
+        in_community = options[:in_community]
+        user = options[:user]
+        in_community.unmute_user :user => user, :admin => self
+      end
+
+      def can_send_post_to_community?(community)
+        return false unless community.include_user? self
+        return false if community.include_muted_user? self
+        return false unless community.include_writer? self
+        true
+      end
+
       def send_post_to_community(options = {})
         options.symbolize_keys!
         to_community = options[:to_community]
         post = options[:post]
+        raise "this user have no permissions to send post to this community" unless self.can_send_post_to_community? to_community
         to_community.add_post :post => post, :user => self
       end
 

data/lib/common/base.rb

@@ -46,5 +46,16 @@ module Inkwell
       USER = 'u'
       COMMUNITY = 'c'
     end
+
+    module HashParams
+      COMMUNITY_ID = 'c_id'
+      USER_ID = 'u_id'
+      ACCESS_LEVEL = 'a'
+    end
+
+    module CommunityAccessLevels
+      WRITE = 'w'
+      READ = 'r'
+    end
   end
 end

data/lib/inkwell/version.rb

@@ -1,3 +1,3 @@
 module Inkwell
-  VERSION = "1.1.1"
+  VERSION = "1.1.7"
 end