sql_metrics 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c80f7850002ed7ccbc1a0b7dd634677923de60ff
-  data.tar.gz: b97a97d13fb7579a889141b8737feb012b77a67f
+  metadata.gz: 95e9da225dbae5b2d9816beeb79056815ca21447
+  data.tar.gz: 3ad9ad3f140f648ef17e2179504134ef3a1efb60
 SHA512:
-  metadata.gz: f7b4d5aea72244dfa250e84d610d203b7e4e90f7cb6a3a273798b2107ed704ae40e2cd95e12f76a8baaa80503bef7793f1fc7e90aae496b1d53d02c21e97d98b
-  data.tar.gz: 469acb89e8ec0ee87f27ca182ed784e85f1c0f3f6f0083baa3b3e1ba14910a67c63f984a3fa1f27e42ffcdb8de35fa1c2c86d5547536f5bb13c7b049350378c5
+  metadata.gz: 08ea15e904fb3af8da2acf01383bf496273f6bad4929e86ec8552b1c6c681dbb4b9cd90a5c3fcbf431e5109d2db31784bd65806c7da2f5b243767d60e9801620
+  data.tar.gz: b9d88e8b958a0d701933c1a0e9ee77895bd566fc05e398e31cd3725b095a518ed0f6dec9602556d36b9b9364d6526620414b62c0f4602e8cbd4ec30ae31dece7

data/README.md

@@ -36,11 +36,7 @@ Or install it yourself as:
 
 ### Setup database and table
 
-You need to create the following table in your postgres or redshift database:
-
-    CREATE TABLE events (created_at timestamp, name varchar(200), properties json);
-
-Now you need to tell the gem how to connect to your db. So simply create a file called sql_metrics.rb into your config/libs folder with the config:
+Tell the gem how to connect to your db. So simply create a file called sql_metrics.rb into your config/libs folder with the config:
 
     SqlMetrics.configure do |config|
       config.host = '127.0.0.1'
@@ -49,6 +45,10 @@ Now you need to tell the gem how to connect to your db. So simply create a file
       config.password = 'my_password'
     end
 
+Then to create the required events table just run this rake task:
+
+    rake sql_metrics:create_events_table
+
 ### Track a event
 
 A simple event can look like this:

data/Rakefile

@@ -4,3 +4,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+
+
+

data/lib/sql_metrics/config.rb

@@ -0,0 +1,27 @@
+module SqlMetrics
+  class Configuration
+    require 'pg'
+    require 'logger'
+    require 'json'
+    require 'geocoder'
+
+    attr_accessor :host, :port, :options, :tty, :db_name, :user, :password, :database_schema, :event_table_name,
+                  :bots_regex, :logger
+
+    def initialize
+      self.host = nil
+      self.port = 5432
+      self.options = nil
+      self.tty = nil
+      self.db_name = nil
+      self.user = nil
+      self.password = nil
+      self.database_schema = 'public'
+      self.event_table_name = 'events'
+
+      self.bots_regex = /Googlebot|Pingdom|bing|Yahoo|Amazon|Twitter|Yandex|majestic12/i
+
+      self.logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+  end
+end

data/lib/sql_metrics/railtie.rb

@@ -0,0 +1,10 @@
+require 'sql_metrics'
+require 'rails'
+
+module SqlMetrics
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      import '../sql_metrics/lib/tasks/sql_metrics.rake'
+    end
+  end
+end

data/lib/sql_metrics/sql_metrics.rb

@@ -0,0 +1,86 @@
+module SqlMetrics
+  class << self
+    def track(name, properties = {}, request = nil, options = nil)
+      created_at = Time.now.utc
+
+      Thread.new do
+        track_now(created_at, name, properties, request, options)
+      end
+    end
+
+    def create_events_table
+      conn = pg_connection
+
+      conn.exec("CREATE TABLE #{SqlMetrics.configuration.event_table_name} (created_at timestamp, name varchar(200), properties json);")
+    end
+
+    private
+
+    def track_now(created_at, name, properties = {}, request = nil, options = nil)
+      properties = merge_request_and_options_into_properties(properties, request, options)
+
+      unless options and options[:filter_bots] == false
+        return false if properties[:user_agent] and properties[:user_agent].match(SqlMetrics.configuration.bots_regex)
+      end
+
+      send_async_query(created_at, name, properties)
+
+    rescue => e
+      SqlMetrics.configuration.logger.error e
+      SqlMetrics.configuration.logger.error e.backtrace.join("\n")
+    end
+
+    def merge_request_and_options_into_properties(properties, request, options)
+      if request
+        properties[:user_agent] = request.user_agent
+        properties[:session_id] = request.session_options[:id]
+        properties[:remote_ip] = request.remote_ip
+
+        unless options and options[:geo_lookup] == false
+          if properties[:remote_ip] and geo_object = Geocoder.search(properties[:remote_ip]).first
+            properties[:remote_city] = geo_object.city
+            properties[:remote_country] = geo_object.country
+            properties[:remote_country_code] = geo_object.country_code
+            properties[:remote_coordinates] = geo_object.coordinates
+          end
+        end
+
+        properties[:referer] = request.referer
+        referer = Addressable::URI.parse(request.referer)
+        properties[:referrer_host] = referer.host if referer
+
+        properties[:requested_url] = request.fullpath
+        fullpath = Addressable::URI.parse(request.fullpath)
+        properties[:requested_url_host] = fullpath.host if fullpath
+      end
+
+      properties
+    end
+
+    def send_async_query(created_at, name, properties)
+      pg_connection.send_query(build_psql_query(created_at, name, properties))
+    end
+
+    def build_psql_query(created_at, name, properties)
+      "INSERT INTO #{SqlMetrics.configuration.event_table_name} (
+        created_at,
+        name,
+        properties
+      ) VALUES (
+        '#{created_at}',
+        '#{name}',
+        '#{properties.to_json}'
+      );"
+    end
+
+    def pg_connection
+      PGconn.open(:dbname => SqlMetrics.configuration.db_name,
+                  :host => SqlMetrics.configuration.host,
+                  :port => SqlMetrics.configuration.port,
+                  :options => SqlMetrics.configuration.options,
+                  :tty => SqlMetrics.configuration.tty,
+                  :user => SqlMetrics.configuration.user,
+                  :password => SqlMetrics.configuration.password)
+    end
+  end
+end

data/lib/sql_metrics/version.rb

@@ -1,3 +1,3 @@
 module SqlMetrics
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/sql_metrics.rb

@@ -1,77 +1,12 @@
 require "sql_metrics/version"
+require "sql_metrics/config"
+require "sql_metrics/sql_metrics"
 
-module SqlMetrics
-  class Configuration
-    require 'pg'
-    require 'logger'
-    require 'json'
-    require 'geocoder'
-
-    attr_accessor :host, :port, :options, :tty, :db_name, :user, :password, :database_schema, :event_table_name,
-                  :bots_regex, :logger
-
-    def initialize
-      self.host = nil
-      self.port = 5432
-      self.options = nil
-      self.tty = nil
-      self.db_name = nil
-      self.user = nil
-      self.password = nil
-      self.database_schema = 'public'
-      self.event_table_name = 'events'
-
-      self.bots_regex = /Googlebot|Pingdom|bing|Yahoo|Amazon|Twitter|Yandex|majestic12/i
-
-      self.logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-    end
-  end
+require "sql_metrics/railtie" if defined?(Rails)
 
+module SqlMetrics
   class << self
     attr_accessor :configuration
-
-    def merge_request_and_options_into_properties(properties, request, options)
-      if request
-        properties[:user_agent] = request.user_agent
-        properties[:session_id] = request.session_options[:id]
-        properties[:remote_ip] = request.remote_ip
-
-        unless options and options[:geo_lookup] == false
-          if properties[:remote_ip] and geo_object = Geocoder.search(properties[:remote_ip]).first
-            properties[:remote_city] = geo_object.city
-            properties[:remote_country] = geo_object.country
-            properties[:remote_country_code] = geo_object.country_code
-            properties[:remote_coordinates] = geo_object.coordinates
-          end
-        end
-
-        properties[:referrer] = request.referer
-        referer = Addressable::URI.parse(request.referer)
-        properties[:referrer_host] = referer.host if referer
-
-        properties[:requested_url] = request.fullpath
-        fullpath = Addressable::URI.parse(request.fullpath)
-        properties[:requested_url_host] = fullpath.host if fullpath
-      end
-
-      properties
-    end
-
-    def send_async_query(name, properties)
-      pg_connection.send_query(build_psql_query(name, properties))
-    end
-
-    def build_psql_query(name, properties)
-      "INSERT INTO #{SqlMetrics.configuration.event_table_name} (
-        created_at,
-        name,
-        properties
-      ) VALUES (
-        '#{Time.now.utc}',
-        '#{name}',
-        '#{properties.to_json}'
-      );"
-    end
   end
 
   def self.configuration
@@ -81,27 +16,4 @@ module SqlMetrics
   def self.configure
     yield(configuration) if block_given?
   end
-
-  def self.track(name, properties = {}, request = nil, options = nil)
-    properties = merge_request_and_options_into_properties(properties, request, options)
-
-    unless options and options[:filter_bots] == false
-      return false if properties[:user_agent] and properties[:user_agent].match(SqlMetrics.configuration.bots_regex)
-    end
-
-    send_async_query(name, properties)
-  rescue => e
-    SqlMetrics.configuration.logger.error e
-    SqlMetrics.configuration.logger.error e.backtrace.join("\n")
-  end
-
-  def self.pg_connection
-    PGconn.open(:dbname => SqlMetrics.configuration.db_name,
-                :host => SqlMetrics.configuration.host,
-                :port => SqlMetrics.configuration.port,
-                :options => SqlMetrics.configuration.options,
-                :tty => SqlMetrics.configuration.tty,
-                :user => SqlMetrics.configuration.user,
-                :password => SqlMetrics.configuration.password)
-  end
 end

data/lib/tasks/sql_metrics.rake

@@ -0,0 +1,13 @@
+namespace :sql_metrics do
+
+  desc 'Insert the events table'
+  task :create_events_table => :environment do
+    begin
+      SqlMetrics.create_events_table
+      puts "Succesfully inserted #{SqlMetrics.configuration.event_table_name} table!"
+    rescue => e
+      puts e
+    end
+  end
+
+end

data/sql_metrics.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.3"
 
-  spec.add_runtime_dependency "pg"
-  spec.add_runtime_dependency "logging"
-  spec.add_runtime_dependency "geocoder"
+  spec.add_runtime_dependency "pg", "~> 0.18"
+  spec.add_runtime_dependency "logging", "~> 2.0"
+  spec.add_runtime_dependency "geocoder", "~> 1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sql_metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Matthias
@@ -42,58 +42,58 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: geocoder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 description: A simple gem to track metric events in your own postgres or Amazon Redshift
   database.
 email:
@@ -113,7 +113,11 @@ files:
 - bin/console
 - bin/setup
 - lib/sql_metrics.rb
+- lib/sql_metrics/config.rb
+- lib/sql_metrics/railtie.rb
+- lib/sql_metrics/sql_metrics.rb
 - lib/sql_metrics/version.rb
+- lib/tasks/sql_metrics.rake
 - sql_metrics.gemspec
 homepage: https://github.com/KaktusLab/sql_metrics
 licenses: