sql_fingerprint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 926aef84c8e2c58bf3c3b633e4ad490ce27577c4
+  data.tar.gz: 8071ef06e595011602886f3d2a39a4cebdb8b78d
+SHA512:
+  metadata.gz: de1f1371912ad4306df9525ac7d0bf5d7430b15f901964924f93a3f78481366380a5abfd3e0dc7386cc29a555163283a61e57a7425fb1a32eeab2e71ffed2297
+  data.tar.gz: ae6ed8dd588beb69ad1e89635696ba9de988f2b65f278b9333665ae3b4f1f70a47e000201262d94891907291c23571e95df8d1a97bdf614cebbf619d23b9f715

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@vinted.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sql_fingerprint.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    sql_fingerprint (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sql_fingerprint!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Laurynas Butkus
+
+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,36 @@
+# SqlFingerprint
+
+[![Build Status](https://travis-ci.org/vinted/sql_fingerprint.svg?branch=master)](https://travis-ci.org/vinted/sql_fingerprint)
+
+Abstracts SQL query and calculates fingerprint. 
+Using fingerprint makes it possible to group similar queries together.
+
+Query rewriting is based on [Percona Toolkit implementation](https://github.com/percona/percona-toolkit/blob/b118e39d1057058b59f0a606946f189f640a693e/lib/QueryRewriter.pm#L147).
+
+## Usage
+
+```ruby
+fingerprint = SqlFingerprint.calculate('SELECT * FROM users WHERE id=1') 
+```
+
+Result: `dd1d44f7cffa757aad5152a27b811d6735ef6661`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql_fingerprint'
+```
+
+Or install it yourself as:
+
+    $ gem install sql_fingerprint
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SqlFingerprint project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vinted/sql_fingerprint/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/sql_fingerprint.rb

@@ -0,0 +1,16 @@
+require 'digest/sha1'
+require 'sql_fingerprint/version'
+require 'sql_fingerprint/abstract_query'
+
+module SqlFingerprint
+  module_function
+
+  def calculate(query)
+    abstract_query = abstract(query)
+    Digest::SHA1.hexdigest(abstract_query)
+  end
+
+  def abstract(query)
+    SqlFingerprint::AbstractQuery.build(query)
+  end
+end

data/lib/sql_fingerprint/abstract_query.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module SqlFingerprint
+  class AbstractQuery
+    class << self
+      def build(query)
+        query = query.downcase.chomp
+        query = remove_comments(query)
+        query = remove_quotes(query)
+        query = remove_constants(query)
+        query = remove_double_spaces(query)
+        query = remove_newlines(query)
+        query = remove_in_values(query)
+        query = remove_offsets(query)
+        query.strip
+      end
+
+      private
+
+      def remove_comments(query)
+        query
+          .gsub(/(?:--|#)[^'"\r\n]*(?=[\r\n]|\Z)/, ' ')
+          .gsub(%r{/\*[^!].*?\*/}m, ' ')
+      end
+
+      def remove_newlines(query)
+        query.gsub(/\r\n?/, ' ')
+      end
+
+      def remove_double_spaces(query)
+        query.gsub(/\s+/, ' ')
+      end
+
+      def remove_quotes(query)
+        query.gsub(/\\["']/, '')
+      end
+
+      def remove_constants(query)
+        query
+          .gsub(/".*?"/, '?')
+          .gsub(/'.*?'/, '?')
+          .gsub(/\bfalse\b|\btrue\b/, '?')
+          .gsub(/[0-9+-][0-9a-f.xb+-]*/, '?')
+          .gsub(/\b[0-9+-][0-9a-f.xb+-]*/, '?')
+          .gsub(/\bnull\b/, '?')
+      end
+
+      def remove_in_values(query)
+        query.gsub(/\b(in|values?)(?:[\s,]*\([\s?,]*\))+/, '\1(?+)')
+      end
+
+      def remove_offsets(query)
+        query.gsub(/\blimit \?(?:, ?\?| offset \?)?/, 'limit ?')
+      end
+    end
+  end
+end

data/lib/sql_fingerprint/version.rb

@@ -0,0 +1,3 @@
+module SqlFingerprint
+  VERSION = "0.1.0"
+end

data/sql_fingerprint.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_fingerprint/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sql_fingerprint'
+  spec.version = SqlFingerprint::VERSION
+  spec.authors = ['Laurynas Butkus', 'Tomas Didžiokas']
+  spec.email = ['laurynas.butkus@gmail.com', 'tomas.did@gmail.com']
+  spec.summary = 'Abstracts SQL query and calculates fingerprint'
+  spec.homepage = 'https://github.com/vinted/sql_fingerprint'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: sql_fingerprint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laurynas Butkus
+- Tomas Didžiokas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- laurynas.butkus@gmail.com
+- tomas.did@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sql_fingerprint.rb
+- lib/sql_fingerprint/abstract_query.rb
+- lib/sql_fingerprint/version.rb
+- sql_fingerprint.gemspec
+homepage: https://github.com/vinted/sql_fingerprint
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Abstracts SQL query and calculates fingerprint
+test_files: []