rack-ackee 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41c375767c90a1df2a4dcf0f1f7eab055bca4211f9bae786d3a9a635421a4e30
+  data.tar.gz: fc5d743f9e430ec9db26c35d87848800aef2622d50f73c5d03559cdadbd44646
+SHA512:
+  metadata.gz: 0b947f2ee4aa76fcd8fd8483bf630b79c9cee68edfbb678278eb01c90e0263cfa6bf45d7926463c2364b14e03e2fcb7d40664e954b4bb0d2d6d214fa9c75351c
+  data.tar.gz: ed1255163d3b94151029a960c062a5942baed1ec9f64a3642c26e5882bdb34f844fc02f5da719de500f8d7de8eac03afec62a2810079c413e05be24342de29a2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'coveralls', :group => :test, :require => false

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Mateusz Kozak [https://github.com/meal]
+
+MIT License
+
+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,30 @@
+# rack-ackee
+
+> [Rack](https://github.com/rack/rack) middleware reporting requests to [Ackee](https://ackee.electerious.com/), self-hosted  analytics tool for those who care about privacy. Alternative to using the client-side JS tracker.
+
+## Installation
+
+Install gem
+
+```
+gem install rack-ackee
+```
+
+If you don't have the Ackee instance yet, you can quickly [deploy it on Heroku](https://docs.ackee.electerious.com/#/docs/Get%20started#with-heroku).
+
+## Configuration with Rails
+
+In your Gemfile
+
+```
+gem 'rack-ackee'
+```
+
+In your `config/application.rb`
+```
+config.middleware.use "Rack::Ackee", server: "https://myackeeserver.com", domain_id: "YOUR DOMAIN ID"
+```
+
+Remember to change the server and domain ID to your values.
+
+

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end

data/lib/rack-ackee.rb

@@ -0,0 +1 @@
+require 'rack/ackee'

data/lib/rack/ackee.rb

@@ -0,0 +1,44 @@
+require 'net/http'
+require 'user_agent_parser'
+
+module Rack
+  class Ackee
+
+    def initialize(app, options={})
+      @app = app
+      @server = options[:server]
+      @domain_id = options[:domain]
+    end
+
+    def call(env)
+      unless env['DNT'] == 1
+        send_data(env)
+        status, headers, response = @app.call(env)
+        [status, headers, response]
+      else
+        status, headers, response = @app.call(env)
+        [status, headers, response]
+      end
+    end
+
+    private
+
+    def send_data(env)
+      ua_header = env['HTTP_USER_AGENT']
+      user_agent = UserAgentParser.parse(ua_header)
+      req = Rack::Request.new(env)
+      data = {
+        "siteLocation": req.url,
+        "siteReferrer": env['HTTP_REFERER'],
+        "deviceName": user_agent.device.model,
+        "deviceManufacturer": user_agent.device.brand,
+        "osName": user_agent.os.family,
+        "osVersion": user_agent.os.version.to_s,
+        "browserName": user_agent.family,
+        "browserVersion": user_agent.version.to_s
+      }.to_json
+      url = "#{@server}/domains/#{@domain_id}/records"
+      Net::HTTP.post URI(url), data, "Content-Type" => "application/json"
+    end
+  end
+end

data/rack-ackee.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matt Kozak"]
+  gem.email         = ["matt@mkozak.pl"]
+  gem.description   = %q{middleware reporting requests to Ackee, self-hosted analytics tool for those who care about privacy. Alternative to using the client-side JS tracker.}
+  gem.summary       = %q{middleware reporting requests to Ackee, self-hosted analytics tool for those who care about privacy. Alternative to using the client-side JS tracker.}
+  gem.homepage      = "https://github.com/meal/rack-ackee-middleware"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rack-ackee"
+  gem.require_paths = ["lib"]
+  gem.version       = '0.1.2'
+
+  gem.add_development_dependency('minitest')
+  gem.add_development_dependency('rack-test')
+  gem.add_runtime_dependency('rack')
+  gem.add_runtime_dependency('user_agent_parser')
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rack-ackee
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Matt Kozak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rack-test
+  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: rack
+  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: user_agent_parser
+  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: middleware reporting requests to Ackee, self-hosted analytics tool for
+  those who care about privacy. Alternative to using the client-side JS tracker.
+email:
+- matt@mkozak.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-ackee.rb
+- lib/rack/ackee.rb
+- rack-ackee.gemspec
+homepage: https://github.com/meal/rack-ackee-middleware
+licenses: []
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: middleware reporting requests to Ackee, self-hosted analytics tool for those
+  who care about privacy. Alternative to using the client-side JS tracker.
+test_files: []