traffic_mansion 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 266a7af2b5126a19ec321038591503a5ad4a54d0
-  data.tar.gz: afb4ca3a84ddae2cab9168cc3886c69263b0b470
+  metadata.gz: a717cc1264a412fe5239c68178c5cc461b56c86e
+  data.tar.gz: 766f0dd67e6906441f7d3db4d7dd1c78e2805fc5
 SHA512:
-  metadata.gz: a5fab358fe75bf7e6d8b1920d1a16be2cb1a8b0bbae50f3d13c60d40dd1168732e651ce38372702a77eb6b8a6c42eb4fdc027bec2824a09d3dee50899162321f
-  data.tar.gz: 03574396649425bf1c1dddd3864139971c9fabeb3250f03ba50ccdaa5a39a9cea3a31dfeea6c81e16b553466357a9970cd6e09af268d6630ac94311000cb41a9
+  metadata.gz: 278896cc86058caf655a332f5f6e9ceeeee8135d9986bbdc7daa227431991789e11287a0c17aaf81c501ad80cbd0ff59652589e141925315c467e54aff631ed1
+  data.tar.gz: ff1f7ce3e2f06e455790252ee4b758f3392fa726a0c0b010a23e162d439e42601956120b0f5d9dd08feb0aa41e7337bfa27fa559465c214f20a46edf16ab11f0

data/README.md

@@ -8,4 +8,60 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle
+
+## Environment
+
+The following environment variables can be set:
+
+````
+  TRAFFIC_MANSION_HTTP_HOST=mydomain.com # the domain where you track from
+  TRAFFIC_MANSION_ENDPOINT=http://www.trafficmansion.com # the API endpoint
+  TRAFFIC_MANSION_ROOT_CAMPAIGN_ID=666 # the default campaign id for the root traffic if there is one
+  TRAFFIC_MANSION_LOG_REQUESTS=1 # set this to debug the tracking request and response
+  TRAFFIC_MANSION_LOG_TO_FILE=1 # set this to debug it into a file instead of the main logger
+````
+
+## Tasks
+
+Run `traffic_mansion:create_indexes` after the instalation to set the Queue collection indexes.
+
+## Usage
+
+### Unique visits
+
+Track them directly from the controller:
+
+````ruby
+  def track_unique_visit
+    if !TrafficMansion::tracked_client?(cookies)
+      campaign_id = TrafficMansion::get_campaign_id params[:campaign_id]
+      if campaign_id
+        event = TrafficMansion::Queue::add_unique_visit campaign_id, request.remote_ip, request.referer
+        cookies[TrafficMansion::COOKIE_NAME] = { :value => event.id, :expires => 30.days.from_now, :domain => :all }
+      end
+    end
+  end
+````
+
+### Signups
+
+Track them directly from the controller:
+
+````ruby
+  def track_signup user
+    if TrafficMansion::tracked_client?(cookies)
+      TrafficMansion::Queue::add_signup cookies[TrafficMansion::COOKIE_NAME], user.id, request.remote_ip, request.referer
+    end
+  end
+````
+
+### Sales
+
+Track them from the post response controller:
+
+````ruby
+  def track_sale user, payment
+    TrafficMansion::Queue::add_sale user.id, payment.id, payment.amount, payment.product.name, request.remote_ip, request.referer
+  end
+````

data/lib/traffic_mansion/tracker.rb

@@ -2,9 +2,11 @@ require "rest_client"
 
 module TrafficMansion
   class Tracker
-    def initialize options = {}, endpoint = ENV["TRAFFIC_MANSION_ENDPOINT"], http_host = ENV["TRAFFIC_MANSION_HTTP_HOST"]
+    def initialize options = {}, endpoint = ENV["TRAFFIC_MANSION_ENDPOINT"], http_host = ENV["TRAFFIC_MANSION_HTTP_HOST"], log_requests = ENV["TRAFFIC_MANSION_LOG_REQUESTS"], log_to_file = ENV["TRAFFIC_MANSION_LOG_TO_FILE"]
       @endpoint = endpoint
       @http_host = http_host
+      @log_requests = log_requests
+      @log_to_file = log_to_file
       set_data options
     end
 
@@ -19,14 +21,14 @@ module TrafficMansion
     def visit options = {}
       url = "#{@endpoint}/xd_visit.php"
       params = {
-        :campaign_id => @campaign_id,
-        :keyword => nil,
-        :timestamp => Time.now.to_i,
-        :http_host => @http_host,
-        :remote_addr => @remote_addr,
-        :http_referer => nil,
-        :visit_id => @visit_id,
-        :affiliate_id => @affiliate_id
+        "campaign_id" => @campaign_id,
+        "keyword" => nil,
+        "timestamp" => Time.now.to_i,
+        "http_host" => @http_host,
+        "remote_addr" => @remote_addr,
+        "http_referer" => nil,
+        "visit_id" => @visit_id,
+        "affiliate_id" => @affiliate_id
       }.merge options
       get_response url, params
     end
@@ -53,11 +55,11 @@ module TrafficMansion
     def auth is_create, options
       url = "#{@endpoint}/xd_postsignup.php"
       params = {
-        :visit_id => @visit_id,
-        :active => is_create ? 0 : 1,
-        :timestamp => Time.now.to_i,
-        :remote_addr => @remote_addr,
-        :user_id => @user_id
+        "visit_id" => @visit_id,
+        "active" => is_create ? 0 : 1,
+        "timestamp" => Time.now.to_i,
+        "remote_addr" => @remote_addr,
+        "user_id" => @user_id
       }.merge options
       get_response url, params
     end
@@ -65,22 +67,40 @@ module TrafficMansion
     def payment command, options
       url = "#{@endpoint}/xd_postsale.php"
       params = {
-        :visit_id => @visit_id,
-        :timestamp => Time.now.to_i,
-        :amount => nil,
-        :product_code => nil,
-        :user_id => @user_id,
-        :username => @username,
-        :transaction => nil,
-        :remote_addr => @remote_addr,
-        :command => command
+        "visit_id" => @visit_id,
+        "timestamp" => Time.now.to_i,
+        "amount" => nil,
+        "product_code" => nil,
+        "user_id" => @user_id,
+        "username" => @username,
+        "transaction" => nil,
+        "remote_addr" => @remote_addr,
+        "command" => command
       }.merge options
       get_response url, params
     end
 
     def get_response url, params
+      log "Endpoint", url
+      log "Request", params
       response = RestClient.post url, params
+      log "Response", response
       TrafficMansion::Response.new response
     end
+
+    def log name, data
+      if @log_requests
+        begin
+          if @log_to_file
+            File.open("traffic_mansion.log", "a") do |f|
+              f.write "[#{Time.now}] #{name}: #{data}\r\n"
+            end
+          else
+            Rails.logger.info "[Traffic Mansion] #{name}: #{data}"
+          end
+        rescue
+        end
+      end
+    end
   end
 end

data/lib/traffic_mansion/version.rb

@@ -1,3 +1,3 @@
 module TrafficMansion
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traffic_mansion
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - AgileWings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler