rails-client-logger 0.0.2 → 1.0.0

data/README.md

@@ -4,18 +4,28 @@ Rails engine to log from Client side (Browser) javascript to server log file. To
 
 There are 5 levels of logging: debug, info, warn, error and fatal.
 
+Supports Rails 4 (permitted parameters) as well as a CoffeeScript implementation of the client-side code.
+
+For Rails 3.x use gem version `0.0.2`.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
+### For Rails 4.x
 ```ruby
 gem 'rails-client-logger'
 ```
-    
+
+### For Rails 3.x
+```ruby
+gem 'rails-client-logger', '0.0.2'
+```
+
 And then execute:
 
 ```bash
-$ bundle
+$ bundle install
 ```
 
 Then simply execute following generator command. It inserts the required routes and javascript files and you're ready to rock!
@@ -32,7 +42,7 @@ $ rails g rails_client_logger
 jsLogger.info("simple info message");
 jsLogger.warn("a warning");
 ```
-    
+
 ### Log Error
 
 ```ruby
@@ -43,7 +53,40 @@ catch (e) {
     jsLogger.fatal(e);
 }
 ```
-    
+
+Log all unhandled javascript errors:
+
+```javascript
+window.onerror = function (message, url, line_number) {
+  jsLogger.fatal("Uncaught errror in: " + url + ":" + line_number + "\nDetails: " + message);
+};
+```
+
+### View Logs
+
+The logged messages will appear in the normal rails log (i.e. development.log or staging.log or production.log).
+
+## Authorization
+
+The gem uses a controller to send messages to the server, in some cases you may need to authorize the controller actions for it to work correctly (otherwise you will get an authorization error). Below is a how-to guide for CanCan, but the same principles can be applied to other authorization gems.
+
+### CanCan
+
+1. Create a new controller `logger_controller.rb` that inherits from `RailsClientLoggersController` like this:
+
+    ```ruby
+    class LoggerController < RailsClientLogger::RailsClientLoggersController
+      skip_authorization_check
+    end
+    ```
+
+2. Add a new route in `routes.rb`
+
+    ```ruby
+    match 'logger/rails_client_logger/log' => 'logger#log'
+    mount RailsClientLogger::Engine, :at => "logger"
+    ```
+
 ## Contributing
 
 1. Fork it
@@ -58,6 +101,9 @@ catch (e) {
 
 [girishso](https://github.com/girishso) - for the implementation
 
+[elthariel](https://github.com/elthariel) - for Rails 4 support and CoffeeScript
+implementation
+
 ## License
 MIT License
 

data/app/controllers/rails_client_logger/rails_client_loggers_controller.rb

@@ -8,5 +8,9 @@ module RailsClientLogger
         head :bad_request
       end
     end
+
+    def log_params
+      params.permit(:level, :message)
+    end
   end
 end

data/lib/generators/rails_client_logger/rails_client_logger_generator.rb

@@ -1,19 +1,34 @@
 class RailsClientLoggerGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
-  
+
   desc "inserts required routes and requires the javascript files"
   def generate
     # add route
     route(%Q{mount RailsClientLogger::Engine, :at => "logger"})
-    
+
+    mode = :coffee
+    if File.exists? "app/assets/javascripts/application.js.coffee"
+      path = "app/assets/javascripts/application.js.coffee"
+    elsif File.exists? "app/assets/javascripts/application.coffee"
+      path = "app/assets/javascripts/application.coffee"
+    elsif File.exists? "app/assets/javascripts/application.js"
+      mode = :js
+      path = "app/assets/javascripts/application.js"
+    end
+
     # add to application.js manifest
-    original_js = File.binread("app/assets/javascripts/application.js")
-    if original_js.include?("require rails_client_logger")
-       say_status("skipped", "insert into app/assets/javascripts/application.js", :yellow)
+    original = File.binread(path)
+    if original.include?("require rails_client_logger")
+       say_status("skipped", "insert into #{path}", :yellow)
     else
-       insert_into_file "app/assets/javascripts/application.js", :after => %r{//= require ['"]?jquery['"]?\s*$} do
+      if mode == :coffee
+        insert_into_file path, :after => %r{#= require ['"]?jquery['"]?\s*$} do
+          "\n#= require rails_client_logger"
+      else
+        insert_into_file path, :after => %r{//= require ['"]?jquery['"]?\s*$} do
           "\n//= require rails_client_logger"
-       end
+        end
+      end
     end
   end
 end

data/lib/rails-client-logger/version.rb

@@ -1,3 +1,3 @@
 module RailsClientLogger
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/test/dummy/config/application.rb

@@ -54,6 +54,8 @@ module Dummy
 
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
+
+    config.secret_key_base = "ThisIsADummyAppSoLeaveMeAlone"
   end
 end
 

data/test/dummy/config/environments/test.rb

@@ -11,9 +11,6 @@ Dummy::Application.configure do
   config.serve_static_assets = true
   config.static_cache_control = "public, max-age=3600"
 
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
-
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -30,8 +27,11 @@ Dummy::Application.configure do
   config.action_mailer.delivery_method = :test
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  # Rails 4 new stuff
+  config.eager_load = false
 end

data/test/dummy/log/test.log

@@ -0,0 +1,10 @@
+   (0.3ms)  begin transaction
+------------------------------------------------------
+JsLogger::JsLoggersControllerTest: test_should_get_log
+------------------------------------------------------
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+------------------------
+JsLoggerTest: test_truth
+------------------------
+   (0.0ms)  rollback transaction

data/test/functional/js_logger/js_loggers_controller_test.rb

@@ -6,6 +6,6 @@ module JsLogger
       get :log
       assert_response :success
     end
-  
+
   end
 end

data/vendor/assets/javascripts/rails_client_logger.js.coffee

@@ -0,0 +1,15 @@
+window.jsLogger =
+  invoke: (level, message) ->
+    jQuery.ajax {
+      type: 'post'
+      beforeSend: (xhr) ->
+        xhr.setRequestHeader('X-CSRF-Token', jQuery('meta[name="csrf-token"]').attr('content'))
+      data: {level: level, message: message}
+      complete: (request) ->
+        # Nothing yet
+      url: "/logger/rails_client_logger/log"
+    }
+
+for level in ['debug', 'info', 'warn', 'error', 'fatal']
+  jsLogger[level] = (msg) ->
+    jsLogger.invoke(level, msg)

metadata

@@ -1,51 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rails-client-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
 - Girish Sonawane
+- Julien 'Lta' Ballet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
+  type: :runtime
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
+        version: '4.0'
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
+  prerelease: false
 - !ruby/object:Gem::Dependency
   name: sqlite3
+  type: :development
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   prerelease: false
+- !ruby/object:Gem::Dependency
+  name: protected_attributes
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
 description: Rails engine for logging from Browser Javascript to server
 email:
 - girish.sonawane@gmail.com
+- elthariel@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -59,7 +77,7 @@ files:
 - lib/rails-client-logger/version.rb
 - lib/rails-client-logger.rb
 - lib/tasks/js-logger_tasks.rake
-- vendor/assets/javascripts/rails_client_logger.js
+- vendor/assets/javascripts/rails_client_logger.js.coffee
 - MIT-LICENSE
 - Rakefile
 - README.md
@@ -84,6 +102,8 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/test.sqlite3
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -107,22 +127,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -169564952021000404
+      version: '0'
+      hash: 92147991256340174
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -169564952021000404
+      version: '0'
+      hash: 92147991256340174
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Rails engine for logging from Browser Javascript to server
@@ -148,6 +168,8 @@ test_files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/test.sqlite3
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html

data/vendor/assets/javascripts/rails_client_logger.js

@@ -1,34 +0,0 @@
-(function( jsLogger, $, undefined ) {
-    //Public Method
-    jsLogger.debug = function(message) {
-			invoke('debug', message);
-    };
-
-    jsLogger.info = function(message) {
-			invoke('info', message);
-    };
-
-    jsLogger.warn = function(message) {
-			invoke('warn', message);
-    };
-
-    jsLogger.error = function(message) {
-			invoke('error', message);
-    };
-
-    jsLogger.fatal = function(message) {
-			invoke('fatal', message);
-    };
-
-     
-    //Private Method
-    function invoke(level, message) {
-			$.ajax({
-			  type: 'post',
-				beforeSend: function(xhr) {xhr.setRequestHeader('X-CSRF-Token', $('meta[name="csrf-token"]').attr('content'))},
-			  data: {level: level, message: message},
-			  complete: function(request){},
-			  url: "/logger/rails_client_logger/log"
-			})
-    }   
-}( window.jsLogger = window.jsLogger || {}, jQuery ));