sql_metrics 0.1.1

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sql_metrics.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matthias
+
+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,149 @@
+# SqlMetrics
+
+A simple gem to track metric events in your own postgres or Amazon Redshift database.
+
+## Why?
+I got sick of being limited by tracking services dashboards...and also of paying these services crazy monthy fee's.
+
+Yes I know about Google Analytics...but I am also tired of GA missing 20-30% of my data.
+
+So I went ahead a rewrote a library I had written to store events in mixpanel to instead put save them into a postgres database (which means it will also work with Amazon Redshift!).
+
+I have it running just fine on heroku's postgres offering with a site thats being hit with ~ 250k users per month.
+
+## Features
+
+* Asynchronously stores events into Postgres or Amazon Redshift based db
+* Filters commonly known bots by default
+* Uses geoip gem to extract city/country from client ip's
+
+## Todo
+
+* Write some unit tests
+* Batch inserting events to db to improve performance under very high load
+* Track Users (just because thats a common thing to do besides tracking raw events)
+* Offer SQL based dashboard that allows to run custom queries and also render charts
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql_metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sql_metrics
+
+## Usage
+
+### 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:
+
+    SqlMetrics.configure do |config|
+      config.host = '127.0.0.1'
+      config.db_name = 'my_metrics_db'
+      config.user = 'my_postgres_user'
+      config.password = 'my_password'
+    end
+
+### Track a event
+
+A simple event can look like this:
+
+    SqlMetrics.track(
+      'event_name',
+      {
+        :a_property => 'hello world',
+        :another_property => 'hello user'
+      }
+    )
+
+You can also pass a rails request object from a controller:
+
+    SqlMetrics.track(
+      'event_name',
+      {
+        :a_property => 'hello world',
+        :another_property => 'hello user'
+      },
+      request
+    )
+
+The gem automaticall filters bots for you using the user_agent property from the rails request object...you can disable this if you want:
+
+    SqlMetrics.track(
+      'event_name',
+      {
+        :a_property => 'hello world',
+        :another_property => 'hello user'
+      },
+      request,
+      {
+        :filter_bots => false
+      }
+    )
+
+This will automatically fetch properties like the user agent, client ip, requested url, etc
+
+## Additional Config parameters
+
+### Change DB Table name to use
+
+    SqlMetrics.configure do |config|
+      config.host = '127.0.0.1'
+      config.db_name = 'my_metrics_db'
+      config.user = 'my_postgres_user'
+      config.password = 'my_password'
+
+      config.event_table_name = 'my_custom_events_table'
+    end
+
+### Change DB Schema to use
+
+    SqlMetrics.configure do |config|
+      config.host = '127.0.0.1'
+      config.db_name = 'my_metrics_db'
+      config.user = 'my_postgres_user'
+      config.password = 'my_password'
+
+      config.database_schema = 'my_custom_schema'
+    end
+
+### Change Bot regex filter
+
+    SqlMetrics.configure do |config|
+      config.host = '127.0.0.1'
+      config.db_name = 'my_metrics_db'
+      config.user = 'my_postgres_user'
+      config.password = 'my_password'
+
+      config.bots_regex = /Googlebot|Pingdom|bing|Yahoo|Amazon|Twitter|Yandex|majestic12/i
+    end
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/KaktusLab/sql_metrics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sql_metrics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sql_metrics/version.rb

@@ -0,0 +1,3 @@
+module SqlMetrics
+  VERSION = "0.1.1"
+end

data/lib/sql_metrics.rb

@@ -0,0 +1,97 @@
+require "sql_metrics/version"
+
+module SqlMetrics
+  class Configuration
+    require 'pg'
+    require 'logger'
+    require 'json'
+
+    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
+
+  class << self
+    attr_accessor :configuration
+
+    def merge_request_into_properties(properties, request)
+      if request
+        properties[:user_agent] = request.user_agent
+        properties[:session_id] = request.session_options[:id]
+        properties[:remote_ip] = request.remote_ip
+
+        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
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.track(name, properties = {}, request = nil, options = nil)
+    properties = merge_request_into_properties(properties, request)
+
+    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/sql_metrics.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sql_metrics"
+  spec.version       = SqlMetrics::VERSION
+  spec.authors       = ["Matthias"]
+  spec.email         = ["matthias.chills@gmail.com"]
+
+  spec.summary       = %q{Track events in your own postgres database.}
+  spec.description   = %q{A simple gem to track metric events in your own postgres or Amazon Redshift database.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "pg"
+  spec.add_runtime_dependency "logging"
+  spec.add_runtime_dependency "geoip"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: sql_metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthias
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geoip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple gem to track metric events in your own postgres or Amazon Redshift
+  database.
+email:
+- matthias.chills@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/.rakeTasks"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/sql_metrics.iml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sql_metrics.rb
+- lib/sql_metrics/version.rb
+- sql_metrics-0.1.0.gem
+- sql_metrics.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Track events in your own postgres database.
+test_files: []