action_tracker 0.1.0.2 → 0.1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72dd8f061e2e9046dcfa85adf496a6fb9fa3ef4e
-  data.tar.gz: 1118f22f593b0bdb407928461bbce024abd0688f
+  metadata.gz: bfb149079d10597d07994207f8a82c235004c638
+  data.tar.gz: f3983a018a57ed372ba89f083d4b9c2b767155db
 SHA512:
-  metadata.gz: 2cdc35193949dafa62cabd3a86bfec736d258cc3085313585089af41b8cb70b1e86cc898409fa456069ee9b2b2ea59a072459f15668588c6b633b61962335cd1
-  data.tar.gz: 75e3663943e72d353c7c3cc872fd595908b908e1173abb9dba523b1c81f0eca17bbb221f7121813467e207f594aa62c06d591c4e9fa7a36c91f60d9ecd24b83e
+  metadata.gz: 56bf58bae35cad88d44b2908f5c35e80c59540d8c31ddee84c2956c3889f1acf4ea96c24e9fdce512bc1f0a233f3a5baac52e326c274e2a212d1c37a993a2ad5
+  data.tar.gz: 3efbe77d676c092a0393aa11daae5f20b3efa5b3a125d859b5e786cdee212ae4f2ecd67f28f3995124ccd570cb2d0b2e3d3eaea0f89a84f60b9c803891c2f0dc

data/Changelog.md

@@ -0,0 +1,16 @@
+# action_tracker changelog
+
+## 0.1.0.3 (2016-04-18)
+
+### Implemented enhancements
+
+- Auto loading ActionTracker::Concerns::Tracker in ActionController::Base
+- Refactoring Tracker class
+
+### Fixed bugs
+
+None
+
+### Merged pull requests
+
+None

data/README.md

@@ -1,8 +1,8 @@
-# ActionTracker
+<a href="https://codeclimate.com/github/appprova/action_tracker"><img src="https://codeclimate.com/github/appprova/action_tracker/badges/gpa.svg" /></a>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/action_tracker`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Action Tracker
 
-TODO: Delete this and the text above, and describe your gem
+Action and event trackers made easy. With this gem you can track your user actions without adding unnecessary code in your controllers.
 
 ## Installation
 
@@ -20,9 +20,64 @@ Or install it yourself as:
 
     $ gem install action_tracker
 
-## Usage
+<!-- ## Usage
 
-TODO: Write usage instructions here
+To use Action Tracker is easy, is needed to create a Tracker to any Controller to track. The structure of the files is simple.
+
+To specify the tracker tool you want to use, you need to create a initializer and set the wanted tools.
+
+```ruby
+# config/initializers/action_tracker.rb
+ActionTracker::Settings.configuration do |config|
+  config.use_tool :mix_panel
+  config.use_tool :dito
+  config.use_tool :custom_tool
+end
+``` -->
+
+The Tracker file structure must follow the controllers names and actions
+
+### Simple usage
+
+Simple add the wanted actions to track, with same name as the controller.
+
+```ruby
+# app/trackers/users_tracker.rb
+class UsersTracker < ActionTracker::Base
+  # This file tracks UsersController
+
+  def index; end
+  def show; end
+  def create; end
+end
+```
+
+### Advanced usage
+
+The parameters that will be send to Tracker tools can be easily customized. As the example above, is necessary to create the action, same as controllers and the return will be send to tracker tool.
+
+```ruby
+# app/trackers/posts_tracker.rb
+class PostsTracker < ActionTracker::Base
+  # This file tracks PostsController
+
+  def show
+    {
+      name: 'post-was-viewed',
+      data: {
+        post_id: @post.id,
+        tags: @post.tags
+      }
+    }
+  end
+end
+```
+
+#### Options
+
+| Name | Description | Default |
+|--|--|--|--|
+|*name*| The name of the tracked event.  | The controller action name. Eg.: 'users#index'|
 
 ## Development
 
@@ -32,10 +87,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/action_tracker.
+Bug reports and pull requests are welcome on GitHub at https://github.com/appprova/action_tracker.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/action_tracker.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["andre.taiar@appprova.com.br", "joaogabriel@appprova.com.br"]
 
   spec.summary       = %q{Easy way to track actions in your application.}
-  spec.description   = %q{Easy way to track actions in your application without adding unnecessary code to your application.}
+  spec.description   = %q{Easy way to track actions in your application without adding unnecessary code to your controllers.}
   spec.homepage      = "http://coders.appprova.com.br/"
   spec.license       = "MIT"
 
@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rails3_before_render', '0.2.0'
   spec.add_dependency 'activesupport', '~> 3.2'
-  spec.add_dependency 'actionpack', '~> 3.2'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/action_tracker.rb

@@ -7,5 +7,6 @@ require 'action_tracker/base'
 module ActionTracker
   if defined?(Rails)
     require 'action_tracker/engine'
+    ActiveSupport.on_load(:action_controller) { include ActionTracker::Concerns::Tracker }
   end
 end

data/lib/action_tracker/concerns/tracker.rb

@@ -12,25 +12,27 @@ module ActionTracker
       end
 
       def track_event
-        user = current_user || current_teacher
-        begin
-          obj = Object.const_get("#{namespace}#{controller_name.camelize}Tracker", false).new
-          obj.user, obj.params = user, params
-          @tracker_params = obj.method(action_name).call if obj.respond_to? action_name
-        rescue NameError => e
-          # Significa que não tem tracker definido para esta action
-        end
+        tracker_user = current_user || current_teacher
+        tracker_class = "#{namespace}#{controller_name.camelize}Tracker"
+        @tracker_params = tracker_params(tracker_class, tracker_user)
       end
 
       private
 
-      def namespace
-        if self.class.name.deconstantize.empty?
-          ""
-        else
-          #self.class.name.deconstantize.try(:+, '::')
-          self.class.name.deconstantize << "::"
+      def tracker_params(tracker_class, tracker_user)
+        begin
+          tracker = Object.const_get(tracker_class, false).new
+          tracker.user = tracker_user
+          tracker.params = params
+          output = tracker.method(action_name).call if tracker.respond_to? action_name
+        rescue NameError
+          output = ''
         end
+        output
+      end
+
+      def namespace
+        self.class.name.deconstantize.try(:+, '::')
       end
     end
   end

data/lib/action_tracker/version.rb

@@ -1,3 +1,3 @@
 module ActionTracker
-  VERSION = "0.1.0.2"
+  VERSION = "0.1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0.2
+  version: 0.1.0.3
 platform: ruby
 authors:
 - André Taiar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails3_before_render
@@ -39,20 +39,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Easy way to track actions in your application without adding unnecessary
-  code to your application.
+  code to your controllers.
 email:
 - andre.taiar@appprova.com.br
 - joaogabriel@appprova.com.br
@@ -107,6 +93,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Changelog.md
 - Gemfile
 - LICENSE.txt
 - README.md