scrolls_rails 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Dominic Dagradi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# scrolls_rails
+
+scrolls_rails is an extension to the Scrolls logging library that makes it easy
+to log user interface/Javascript events the same way that you log actions in
+your models and controllers.
+
+For more information about Scrolls, visit its repository [here](https://github.com/asenchi/scrolls).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scrolls_rails'
+
+Add scrolls_rails to your javascript manifest, normally application.js:
+
+    //= require scrolls_rails
+
+And add scrolls_rails's routes to your routes file:
+
+    mount ScrollsRails::Engine => "/scrolls", :as => "scrolls_rails"
+
+## Usage
+
+scrolls_rails uses the syntax you're already familiar with, to log events from
+Javascript:
+
+```javascript
+Scrolls.log({fn: "items", at: "viewed_list"})
+```
+
+The output of which will be:
+
+    fn=items at=viewed_list
+
+In addition, since scrolls_rails works with your existing Rails app, any
+Scrolls contexts set for your application will be set for your Javascript
+logs as well.
+
+## License
+
+scrolls_rails is released under the {MIT License}[http://www.opensource.org/licenses/MIT].

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ScrollsRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/scrolls_rails.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into scrolls_rails.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/app/assets/javascripts/scrolls_rails/metrics.js.erb

@@ -0,0 +1,12 @@
+<% url = ScrollsRails::Engine.routes.url_helpers %>
+
+var Scrolls = {
+  log: function(measurement) {
+    $.ajax({
+      type: "POST",
+      url: "<%= url.log_path %> ",
+      data: {measurement: measurement},
+      dataType: "text"
+    })
+  }
+}

data/app/controllers/scrolls_rails/metrics_controller.rb

@@ -0,0 +1,8 @@
+module ScrollsRails
+  class MetricsController < ApplicationController
+    def log
+      Scrolls.log params[:measurement]
+      render text: "success"
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ScrollsRails::Engine.routes.draw do
+  match "log", controller: "metrics", action: "log", via: :post
+end

data/lib/scrolls_rails.rb

@@ -0,0 +1,4 @@
+require "scrolls_rails/engine"
+
+module ScrollsRails
+end

data/lib/scrolls_rails/engine.rb

@@ -0,0 +1,7 @@
+module ScrollsRails
+  class Engine < ::Rails::Engine
+    isolate_namespace ScrollsRails
+
+    require "scrolls"
+  end
+end

data/lib/scrolls_rails/version.rb

@@ -0,0 +1,3 @@
+module ScrollsRails
+  VERSION = "0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: scrolls_rails
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Dominic Dagradi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: scrolls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Rails helpers for logging Javascript and UI events with Scrolls
+email:
+- ddagradi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/scrolls_rails/metrics.js.erb
+- app/assets/javascripts/scrolls_rails.js
+- app/controllers/scrolls_rails/metrics_controller.rb
+- config/routes.rb
+- lib/scrolls_rails/engine.rb
+- lib/scrolls_rails/version.rb
+- lib/scrolls_rails.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/dominic/scrolls_rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple logging for Javascript
+test_files: []