try fix authentication for notifications api

Author: nflorentin

README.md

@@ -42,13 +42,7 @@ $ rake db:migrate
 
 Running the generator will do a few things:
 
-1. add the engine routes to your routes.rb:
-
-  ```ruby
-  # config/routes.rb
-  mount Wupee::Engine, at: "/wupee"
-  ```
-2. create <a name="initializer">wupee initializer</a>:
+1. create <a name="initializer">wupee initializer</a>:
 
   ```ruby
   # config/initializers/wupee.rb
@@ -67,7 +61,7 @@ Running the generator will do a few things:
   #   # logic goes here, returning a boolean
   # end
   ```
-3. create a mailer `NotificationsMailer` which inheritates from `Wupee::NotificationsMailer`
+2. create a mailer `NotificationsMailer` which inheritates from `Wupee::NotificationsMailer`
 
   ```ruby
   # app/mailers/notifications_mailer.rb
@@ -77,7 +71,7 @@ Running the generator will do a few things:
  end
   ```
 
-4. adds wupee to your locale yml file (for email subjects)
+3. adds wupee to your locale yml file (for email subjects)
   ```yml
   # config/locales/en.yml
   en:
@@ -168,14 +162,30 @@ You can also use the method `notify` this way:
 ## Wupee::Api::NotificationsController
 
 The controller have various actions all scoped for the current user:
- * `wupee/api/notifications#index` : fetch notifications, take an optional parameter `is_read` (false by default)
+ * `wupee/api/notifications#index` : fetch notifications, takes an optional parameter `scopes` (example: scopes=read,ordered)
  * `wupee/api/notifications#show` : fetch a notification
- * `wupee/api/notifications#mark_as_read` : mark as read a notification
- * `wupee/api/notifications#mark_all_as_read` : mark as read all notifications
+ * `wupee/api/notifications#mark_as_read` : mark a notification as read 
+ * `wupee/api/notifications#mark_all_as_read` : mark all notifications as read
 
 To use this controller, define a controller inheriting from `Wupee::Api::NotificationsController`, set the routes in your `config/routes.rb` 
 and define a method `current_user`  which returns the user signed in.
 
+Example:
+```ruby
+  # config/routes.rb
+  namespace :api, defaults: { format: :json } do
+    resources :notifications, only: [:index, :show] do
+      patch :mark_as_read, on: :member
+      patch :mark_all_as_read, on: :collection
+    end
+  end
+
+  # app/controllers/api/notifications_controller.rb
+  class Api::NotificationsController < Wupee::Api::NotificationsController 
+    before_action :authenticate_user! # if you are using devise
+  end
+```
+
 ## Why WUPEE ?
 
 **W**hat's **UP** Sl**EE**de

config/routes.rb

@@ -1,8 +1,2 @@
 Wupee::Engine.routes.draw do
-  namespace :api, defaults: { format: :json } do
-    resources :notifications, only: [:index, :show] do
-      patch :mark_as_read, on: :member
-      patch :mark_all_as_read, on: :collection
-    end
-  end
 end

spec/controllers/notifications_controller_spec.rb

@@ -1,18 +1,10 @@
 require 'rails_helper'
 
-RSpec.describe Wupee::Api::NotificationsController, type: :controller do
-  routes { Wupee::Engine.routes }
+RSpec.describe NotificationsController, type: :controller do
   let(:notification) { create :notification }
 
-  before :all do
-    Wupee::Api::NotificationsController.class_eval do
-      def current_user
-      end
-    end
-  end
-
   before :each do
-    allow_any_instance_of(Wupee::Api::NotificationsController).to receive(:current_user).and_return(notification.receiver)
+    allow_any_instance_of(NotificationsController).to receive(:current_user).and_return(notification.receiver)
   end
 
   it 'should get current user' do

spec/dummy/app/controllers/notifications_controller.rb

@@ -0,0 +1,4 @@
+class NotificationsController < Wupee::Api::NotificationsController
+  def current_user
+  end
+end

spec/dummy/config/routes.rb

@@ -1,3 +1,6 @@
 Rails.application.routes.draw do
-  mount Wupee::Engine, at: "/wupee"
+  resources :notifications, only: [:index, :show], defaults: { format: :json } do
+    patch :mark_as_read, on: :member
+    patch :mark_all_as_read, on: :collection
+  end
 end