turnstile-rb 2.0.1 → 3.0.2

data/spec/turnstile/commands/show_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'turnstile/commands/show'
+
+EXPECTED_NAD_RESPONSE = <<-EOF
+turnstile:android#{"\t"}n#{"\t"}3
+turnstile:ios#{"\t"}n#{"\t"}2
+turnstile:total#{"\t"}n#{"\t"}5
+EOF
+ .strip
+
+module Turnstile
+  module Commands
+    RSpec.describe Show do
+      let(:options) { { summary: true }}
+      subject { described_class.new(options) }
+
+      let(:aggregate) {
+        {
+          'android' => 3,
+          'ios'     => 2,
+          'total'   => 5
+        }
+      }
+
+      describe '#execute' do
+        it 'return data in NAD format' do
+          expect(subject.nad(aggregate)).to eql(EXPECTED_NAD_RESPONSE)
+        end
+      end
+
+      describe '#json' do
+        let(:json) { subject.json(aggregate) }
+        let(:hash) { JSON.load(json) }
+        it 'return data in JSON format' do
+          expect(hash).to eql(aggregate)
+        end
+      end
+    end
+  end
+end

data/spec/turnstile/tracker_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Turnstile::Tracker do
 
-  subject { Turnstile::Tracker.new }
+  subject(:tracker) { Turnstile::Tracker.new }
 
   let(:adapter) { subject.send(:adapter) }
 
@@ -10,16 +10,30 @@ describe Turnstile::Tracker do
   let(:platform) { :ios }
   let(:ip) { '1.2.3.4' }
 
-  describe "#track" do
-    it "calls adapter with correct parameters" do
+  describe '#track_and_sample' do
+    it 'calls adapter with correct parameters' do
       expect(adapter).to receive(:add).once.with(uid, platform, ip)
-      subject.track(uid, platform, ip)
+      subject.track_and_sample(uid, platform, ip)
     end
 
-    it "does not track if sampler returns no" do
-      allow_any_instance_of(Turnstile::Sampler).to receive(:sample).and_return false
+    it 'does not track if sampler returns no' do
+      allow(tracker).to receive(:should_track?).and_return false
       expect(adapter).to receive(:add).never
-      subject.track(uid)
+      subject.track_and_sample(uid)
+    end
+  end
+
+  describe '#track_token' do
+    it 'calls adapter with correct parameters' do
+      expect(adapter).to receive(:add).once.with(uid.to_s, platform.to_s, ip)
+      subject.track_token("#{platform}:#{ip}:#{uid}")
+    end
+  end
+
+  describe '#track_all' do
+    it 'does not track if sampler returns no' do
+      expect(adapter).to receive(:add).once
+      subject.track_all(uid)
     end
   end
 end

data/spec/turnstile_spec.rb

@@ -4,6 +4,7 @@ describe Turnstile do
 
   let(:tracker) { Turnstile::Tracker.new }
   let(:observer) { Turnstile::Observer.new }
+  let(:adapter) { tracker.adapter }
 
   let(:uid_1) { 1238438 }
   let(:uid_2) { 1238439 }
@@ -21,6 +22,8 @@ describe Turnstile do
   let(:other_ip) { '4.3.2.1' }
 
   describe 'general tests' do
+    before { adapter.flushdb }
+
     let(:expected_stats) do
       {
         stats: {

data/turnstile-rb.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/kigster/turnstile-rb'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/).reject {|f| f =~ /Gemfile/ }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
@@ -24,13 +24,16 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'redis'
   spec.add_dependency 'file-tail'
   spec.add_dependency 'daemons'
-  spec.add_dependency 'json'
   spec.add_dependency 'hashie'
   spec.add_dependency 'colored2'
+  spec.add_dependency 'connection_pool'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'sinatra'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'irbtools'
 
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnstile-rb
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: colored2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colored2
+  name: connection_pool
+  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: activesupport
+  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: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: irbtools
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -178,12 +220,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-    Turnstile is a Redis-based library that can accurately track total number of concurrent
-    users accessing a web/API based server application. It can break it down by "platform"
-    or a device type, and returns data in JSON, CSV of NAD formats. While user tracking
-    may happen synchronously using a Rack middleware, another method is provided that is
-    based on log file analysis, and can therefore be performed outside web server process.
+description: |+
+  Turnstile is a Redis-based library that can accurately track total number
+  of concurrent users accessing a web/API based server application. It can
+  break it down by "platform" or a device type, and returns data in JSON,
+  CSV of NAD formats. While user tracking may happen synchronously using a
+  Rack middleware, another method is provided that is based on log file
+  analysis, and can therefore be performed outside web server process.
+
+
 email:
 - kigster@gmail.com
 executables:
@@ -194,37 +239,56 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/turnstile
+- example/custom_csv_matcher.rb
 - lib/turnstile.rb
-- lib/turnstile/adapter.rb
+- lib/turnstile/cli/launcher.rb
+- lib/turnstile/cli/parser.rb
+- lib/turnstile/cli/runner.rb
 - lib/turnstile/collector.rb
+- lib/turnstile/collector/actor.rb
+- lib/turnstile/collector/controller.rb
+- lib/turnstile/collector/flusher.rb
 - lib/turnstile/collector/formats.rb
+- lib/turnstile/collector/formats/custom_matcher.rb
+- lib/turnstile/collector/formats/delimited_matcher.rb
+- lib/turnstile/collector/formats/json_matcher.rb
 - lib/turnstile/collector/log_reader.rb
-- lib/turnstile/collector/matcher.rb
-- lib/turnstile/collector/runner.rb
-- lib/turnstile/collector/updater.rb
+- lib/turnstile/collector/regexp_matcher.rb
+- lib/turnstile/collector/session.rb
+- lib/turnstile/commands.rb
+- lib/turnstile/commands/base.rb
+- lib/turnstile/commands/flushdb.rb
+- lib/turnstile/commands/print_keys.rb
+- lib/turnstile/commands/show.rb
 - lib/turnstile/configuration.rb
+- lib/turnstile/dependencies.rb
 - lib/turnstile/logger.rb
+- lib/turnstile/logger/helper.rb
+- lib/turnstile/logger/provider.rb
 - lib/turnstile/observer.rb
-- lib/turnstile/parser.rb
-- lib/turnstile/runner.rb
+- lib/turnstile/redis/adapter.rb
+- lib/turnstile/redis/connection.rb
+- lib/turnstile/redis/spy.rb
 - lib/turnstile/sampler.rb
-- lib/turnstile/summary.rb
 - lib/turnstile/tracker.rb
 - lib/turnstile/version.rb
+- lib/turnstile/web_app.rb
+- spec/fixtures/custom-production.log
 - spec/fixtures/sample-production.log
 - spec/fixtures/sample-production.log.json
 - spec/spec_helper.rb
+- spec/support/logging.rb
 - spec/turnstile/adapter_spec.rb
+- spec/turnstile/collector/flusher_spec.rb
 - spec/turnstile/collector/log_reader_spec.rb
+- spec/turnstile/commands/show_spec.rb
 - spec/turnstile/configuration_spec.rb
 - spec/turnstile/observer_spec.rb
 - spec/turnstile/sampler_spec.rb
-- spec/turnstile/summary_spec.rb
 - spec/turnstile/tracker_spec.rb
 - spec/turnstile_spec.rb
 - turnstile-rb.gemspec
@@ -248,20 +312,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Asynchronous and non-invasive concurrent user tracking with Redis, by scanning
   application logs across all servers.
 test_files:
+- spec/fixtures/custom-production.log
 - spec/fixtures/sample-production.log
 - spec/fixtures/sample-production.log.json
 - spec/spec_helper.rb
+- spec/support/logging.rb
 - spec/turnstile/adapter_spec.rb
+- spec/turnstile/collector/flusher_spec.rb
 - spec/turnstile/collector/log_reader_spec.rb
+- spec/turnstile/commands/show_spec.rb
 - spec/turnstile/configuration_spec.rb
 - spec/turnstile/observer_spec.rb
 - spec/turnstile/sampler_spec.rb
-- spec/turnstile/summary_spec.rb
 - spec/turnstile/tracker_spec.rb
 - spec/turnstile_spec.rb

data/Gemfile

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in turnstile-rb.gemspec
-gemspec

data/lib/turnstile/adapter.rb

@@ -1,61 +0,0 @@
-require 'redis'
-require 'timeout'
-
-module Turnstile
-  class Adapter
-    attr_accessor :redis
-    include Timeout
-
-    def initialize
-      self.redis = config.redis.url ?
-                     ::Redis.new(url: config.redis.url) :
-                     ::Redis.new(host: config.redis.host,
-                                 port: config.redis.port,
-                                 db:   config.redis.db)
-    end
-
-    def add(uid, platform, ip)
-      key = compose_key(uid, platform, ip)
-      timeout(config.redis.timeout) do
-        redis.setex(key, config.activity_interval, 1)
-      end
-    rescue StandardError => e
-      Turnstile::Logger.log "exception while writing to redis: #{e.inspect}"
-    end
-
-    def fetch
-      redis.keys('t:*').map do |key|
-        fields = key.split(':')
-        {
-          uid:      fields[1],
-          platform: fields[2],
-          ip:       fields[3],
-        }
-      end
-    end
-
-    def aggregate
-      redis.keys('t:*').inject({}) { |hash, key| increment_platform(hash, key) }.tap do |h|
-        h['total'] = h.values.inject(&:+) || 0
-      end
-    end
-
-    private
-
-    def increment_platform(hash, key)
-      platform       = key.split(':')[2]
-      hash[platform] ||= 0
-      hash[platform] += 1
-      hash
-    end
-
-    def config
-      Turnstile.config
-    end
-
-    def compose_key(uid, platform = nil, ip = nil)
-      "t:#{uid}:#{platform}:#{ip}"
-    end
-
-  end
-end

data/lib/turnstile/collector/runner.rb

@@ -1,72 +0,0 @@
-require 'thread'
-require 'daemons/daemonize'
-require 'colored2'
-
-
-module Turnstile
-  module Collector
-    class Runner
-      attr_accessor :config, :queue, :reader, :updater, :file
-
-      def initialize(*args)
-        @config = args.last.is_a?(Hash) ? args.pop : {}
-        @file   = config[:file]
-        @queue  = Queue.new
-
-        config[:debug] ? Turnstile::Logger.enable : Turnstile::Logger.disable
-
-        wait_for_file(@file)
-
-        self.reader
-        self.updater
-
-        Daemonize.daemonize if config[:daemonize]
-        STDOUT.sync = true if config[:debug]
-      end
-
-      def wait_for_file(file)
-        sleep_period = 1
-        while !File.exist?(file)
-          STDERR.puts "File #{file.bold.yellow} does not exist, waiting for it to appear..."
-          STDERR.puts 'Press Ctrl-C to abort.' if sleep_period == 1
-
-          sleep sleep_period
-          sleep_period *= 1.2
-        end
-      end
-
-      def run
-        threads = [reader, updater].map(&:run)
-        threads.last.join
-      end
-
-      def updater
-        @updater ||= Turnstile::Collector::Updater.new(queue,
-                                                       config[:buffer_interval] || 5,
-                                                       config[:flush_interval] || 6)
-      end
-
-      def log_reader_class
-        Turnstile::Collector::LogReader
-      end
-
-      def reader
-        args    = [file, queue]
-        matcher = :default
-
-        if config[:delimiter]
-          matcher = :delimited
-          args << config[:delimiter]
-        elsif config[:filetype]
-          matcher = config[:filetype].to_sym
-        end
-
-        @reader ||= if log_reader_class.respond_to?(matcher)
-                      log_reader_class.send(matcher, *args)
-                    else
-                      raise ArgumentError, "Invalid matcher #{matcher}"
-                    end
-      end
-    end
-  end
-end