inboxes 0.2.0 → 0.2.1

data/.gitignore

@@ -2,4 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
-.DS_Store
+.DS_Store
+.rvmrc
+log/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -5,6 +5,7 @@ Inboxes is a young messaging system for Rails app. It:
 - provides 3 models for developers: Discussion, Message and Speaker
 - read/unread discussions counter
 - any user can be invited to discussion by the member of this discussion, so you can chat with unlimited number of users
+- have configurable behavior via CanCan Ability
 
 ##Upgrading from 0.1 to current version (0.2)
 
@@ -13,7 +14,6 @@ Inboxes is a young messaging system for Rails app. It:
 ##Requirements and recommendations
 
 Inboxes requires Rails 3.x and [Devise](https://github.com/plataformatec/devise) for user identification (surely, messaging system is not possible without users). Now the gem is tested only with Ruby 1.8.7 and REE.
-
 We recommend to use Inboxes with [Faye](https://github.com/jcoglan/faye), because it's really sexy with it.
 
 Remember that unfortunately, Inboxes reserve 3 resources names: Discussion, Message and Speaker.
@@ -22,12 +22,21 @@ Since version 0.2.0, it is possible to add `has_inboxes` option to any model. Fo
 
 ##Installation
 
-*Make sure that Devise is already installed and configured in your app!*
+*Make sure that [Devise](https://github.com/plataformatec/devise) and [CanCan](https://github.com/ryanb/cancan) are already installed and configured in your app!*
 
-1. Add `gem "inboxes", "~> 0.1.2"` to the `Gemfile` and run `bundle install`
+1. Add `gem "inboxes", "~> 0.2.0"` to the `Gemfile` and run `bundle install`
 2. Execute `rails generate inboxes:install`. This command will generate migration for messaging system. Don't forget to run migrations: `rake db:migrate`
 3. Add `has_inboxes` to your User model like [here](https://gist.github.com/1330080).
-4. Now Inboxes are ready to use. Open `http://yoursite.dev/discussions` to see the list of discussions. You can start new one.
+4. Add CanCan abilities to manage Inboxes models:
+
+```ruby
+can [:index, :create], Discussion
+can :read, Discussion do |discussion|
+  discussion.can_participate?(user)
+end
+```
+
+5. Now Inboxes are ready to use. Open `http://yoursite.dev/discussions` to see the list of discussions. You can start new one.
 
 Default Inboxes views are ugly, so you can copy into your app and make anything with them: `rails generate inboxes:views`
 If you have problems with installation, you can check [code of demo app](https://github.com/kirs/inboxes-app)
@@ -55,8 +64,8 @@ config.inboxes.faye_port = 9292 # 9292 by default
 
 5. Faye installation is finished. If you have any troubles, check the [example app](https://github.com/kirs/inboxes-app/)
 
-*While testing Inboxes with Faye, don't forget to run it: `rackup faye.ru -s thin -E production`*
-You can read more about Faye on it's [official page](http://faye.jcoglan.com/).
+*While running Inboxes with Faye, don't forget to run Faye worker it: `rackup faye.ru -s thin -E production`*
+You can read more about that on it's [official page](http://faye.jcoglan.com/).
 
 ### Hints
 
@@ -64,8 +73,7 @@ You can read more about Faye on it's [official page](http://faye.jcoglan.com/).
 
 ##Todo
 
-- Add RSpec tests
-- Add ability to inherit Inboxes controllers
+- Finalize RSpec tests (are located in [rspec branch](https://github.com/evrone/inboxes/tree/rspec))
 - Add Pusher capability
 - Email notifications and the ability to answer received emails like in Github issues (#7)
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/app/controllers/inboxes/base_controller.rb

@@ -4,10 +4,4 @@ class Inboxes::BaseController < ApplicationController
   def init_discussion
     @discussion = Discussion.find(params[:discussion_id])
   end
-
-  # Needs to be overriden so that we use Spree's Ability rather than anyone else's.
-  def current_ability
-    # raise "Loading Ability"
-    @current_ability ||= Inboxes::Ability.new(current_user)
-  end
 end

data/app/controllers/inboxes/discussions_controller.rb

@@ -1,31 +1,20 @@
 class Inboxes::DiscussionsController < Inboxes::BaseController
   load_and_authorize_resource
-  # before_filter :authenticate_user!
-  # before_filter :init_and_check_permissions, :only => :show
   before_filter :load_and_check_discussion_recipient, :only => [:create, :new]
 
   def index
     @discussions = current_user.discussions
   end
-
-  # GET /discussions/1
-  # GET /discussions/1.json
+  
   def show
-    # @discussion = Discussion.includes(:messages, :speakers).find(params[:id])
     @discussion.mark_as_read_for(current_user)
   end
-
-  # GET /discussions/new
-  # GET /discussions/new.json
+  
   def new
-    # @discussion = Discussion.new
     @discussion.messages.build
   end
 
-  # POST /discussions
-  # POST /discussions.json
   def create
-    # @discussion = Discussion.new(params[:discussion])
     @discussion.add_recipient_token current_user.id
 
     @discussion.messages.each do |m|
@@ -41,16 +30,10 @@ class Inboxes::DiscussionsController < Inboxes::BaseController
   end
 
   private
-
-  # def init_and_check_permissions
-  #   @discussion = Discussion.includes(:messages, :speakers).find(params[:id])
-  #   redirect_to discussions_url, :notice => t("inboxes.discussions.can_not_participate") unless @discussion.can_participate?(current_user)
-  # end
-
+  
   def load_and_check_discussion_recipient
     # initializing model for new and create actions
     @discussion = Discussion.new(params[:discussion].presence || {})
-    # @discussion.recipient_tokens = params[:recipients] if params[:recipients] # pre-population
 
     # checking if discussion with this user already exists
     if @discussion.recipient_ids && @discussion.recipient_ids.size == 1
@@ -61,8 +44,8 @@ class Inboxes::DiscussionsController < Inboxes::BaseController
         @discussion.messages.each do |message|
           Message.create(:discussion => discussion, :user => current_user, :body => message.body) if message.body
         end
-        # перекидываем на нее
-        redirect_to discussion_url(discussion), :notice => t("inboxes.discussions.exists", :user => user[Inboxes::config.user_name])
+        # redirecting to that existing object
+        redirect_to discussion_url(discussion), :notice => t("inboxes.discussions.already_exists", :user => user[Inboxes::config.user_name])
       end
     end
   end

data/app/controllers/inboxes/messages_controller.rb

@@ -1,6 +1,4 @@
 class Inboxes::MessagesController < Inboxes::BaseController
-  # before_filter :init_discussion
-  # load_and_authorize_resource
   load_and_authorize_resource :discussion
   load_resource :message, :through => :discussion, :shallow => true
 
@@ -14,11 +12,4 @@ class Inboxes::MessagesController < Inboxes::BaseController
       format.js
     end
   end
-
-  # private
-  #
-  # def init_and_check_permissions
-  #   @discussion = Discussion.find(params[:discussion_id])
-  #   redirect_to discussions_url, :notice => t("inboxes.discussions.can_not_participate") unless @discussion.can_participate?(current_user)
-  # end
 end

data/app/controllers/inboxes/speakers_controller.rb

@@ -1,8 +1,6 @@
 class Inboxes::SpeakersController < Inboxes::BaseController
-  # before_filter :init_discussion
   load_and_authorize_resource :discussion
   load_resource :speaker, :through => :discussion, :shallow => true
-  # load_and_authorize_resource
 
   def create
     raise ActiveRecord::RecordNotFound unless params[:speaker] && params[:speaker][:user_id]

data/app/helpers/inboxes_helper.rb

@@ -3,7 +3,6 @@ module InboxesHelper
   def inboxes_faye_broadcast(channel, &block)
     message = {:channel => channel, :data => capture(&block), :ext => {:auth_token => defined?(FAYE_TOKEN) ? FAYE_TOKEN : ""}}
     uri = URI.parse("http://#{Inboxes::config.faye_host}:#{Inboxes::config.faye_port}/faye")
-    # Rails.logger.info "Faye URL: #{uri}"
-    res = Net::HTTP.post_form(uri, :message => message.to_json)
+    resource = Net::HTTP.post_form(uri, :message => message.to_json)
   end
 end

data/app/models/discussion.rb

@@ -2,8 +2,6 @@ class Discussion < ActiveRecord::Base
   attr_accessor :recipient_tokens, :recipient_ids
   attr_reader :recipient_ids
 
-  # paginates_per 10
-
   # creater
   has_many :messages, :dependent => :destroy
 

data/config/locales/en.yml

@@ -10,6 +10,6 @@ en:
     discussions:
       started: "Discussion started"
       leaved: "You leave the discussion"
-      exists: "Discussion between you and %{user} already exists"
+      already_exists: "Discussion between you and %{user} already exists"
       can_not_participate: "You are not listed in this discussion"
       choose_at_least_one_recipient: "You should choose at least one recipient of discussion"

data/config/locales/ru.yml

@@ -9,7 +9,7 @@ ru:
     discussions:
       started: "Чат начат"
       leaved: "Вы покинули дискуссию"
-      exists: "Дискуссия между вами и %{user} уже существует"
+      already_exists: "Дискуссия между вами и %{user} уже существует"
       can_not_participate: "Вы не состоите в этой дискуссии"
       choose_at_least_one_recipient: "Укажите хотя бы одного получателя"
     speakers:

data/inboxes.gemspec

@@ -21,12 +21,14 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "ruby-debug"
   s.add_runtime_dependency "haml-rails"
-  s.add_runtime_dependency "cancan", ['>= 0']
-  # s.add_runtime_dependency "inherited_resources"
+  s.add_runtime_dependency "devise"
+  s.add_runtime_dependency "rails"
+  s.add_runtime_dependency "cancan"
   
-  # s.add_development_dependency 'dm-sqlite-adapter', ['>= 1.1.0']
-  # s.add_development_dependency 'rspec', ['>= 0']
-  # s.add_development_dependency 'rspec-rails', ['>= 0']
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency 'rspec', ['>= 0']
+  s.add_development_dependency 'factory_girl', ['~> 1.2']
+  s.add_development_dependency 'rspec-rails', ['>= 0']
   # s.add_development_dependency 'rr', ['>= 0']
   # s.add_development_dependency 'steak', ['>= 0']
   # s.add_development_dependency 'capybara', ['>= 0']

data/lib/inboxes.rb

@@ -1,12 +1,11 @@
+require "cancan"
 require "inboxes/version"
 require "inboxes/railtie"
-require "inboxes/ability"
 require "inboxes/engine"
 require "inboxes/active_record_extension"
-
+require "cancan"
 
 module Inboxes
-
   def self.configure(&block)
     yield @config ||= Inboxes::Configuration.new
   end
@@ -31,5 +30,4 @@ module Inboxes
 
   # adding method inboxes for models
   ActiveRecord::Base.extend(Inboxes::ActiveRecordExtension)
-
 end

data/lib/inboxes/engine.rb

@@ -1,11 +1,4 @@
-require "inboxes/ability"
-
 module Inboxes
   class Engine < ::Rails::Engine
-    def self.activate
-      Ability.register_ability(InboxesAbility)
-    end
-
-    config.to_prepare &method(:activate).to_proc
   end
 end

data/lib/inboxes/railtie.rb

@@ -1,5 +1,4 @@
 require 'rails'
-require "inboxes/ability"
 
 module Inboxes
   class Railtie < ::Rails::Railtie

data/lib/inboxes/version.rb

@@ -1,3 +1,3 @@
 module Inboxes
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/devise_config.rb

@@ -0,0 +1,210 @@
+# Use this hook to configure devise mailer, warden hooks and so forth. The first
+# four configuration values can also be set straight in your models.
+Devise.setup do |config|
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class with default "from" parameter.
+  config.mailer_sender = "please-change-me-at-config-initializers-devise@example.com"
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = "Devise::Mailer"
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [ :email ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :email ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :email ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Basic Auth is enabled. False by default.
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. "Application" by default.
+  # config.http_authentication_realm = "Application"
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = "9a86f39fcb72573a367c4fcde09b1ae3fe81c3c2c5858c6024033360b39a0f46ab72c8aade6453e96dfae546262c0336372c19518600367fc8b94e9bb4d5db15"
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming his account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming his account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming his account.
+  # config.confirm_within = 2.days
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, a valid remember token can be re-used between multiple browsers.
+  # config.remember_across_browsers = true
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # If true, uses the password salt as remember token. This should be turned
+  # to false if you are not using database authenticatable.
+  config.use_salt_as_remember_token = true
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.cookie_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 6..128.
+  # config.password_length = 6..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # an one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 2.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper)
+  # config.encryptor = :sha512
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # If true, authentication through token does not store user in session and needs
+  # to be supplied on each request. Useful if you are using the token as API token.
+  # config.stateless_token = false
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Configure sign_out behavior.
+  # Sign_out action can be scoped (i.e. /users/sign_out affects only :user scope).
+  # The default is true, which means any logout action will sign out all active scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The :"*/*" and "*/*" formats below is required to match Internet
+  # Explorer requests.
+  # config.navigational_formats = [:"*/*", "*/*", :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.failure_app   = AnotherApp
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+end