turnstile-rb 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 3cd7be07aee113fee488b2839dc8eadc611a3be257e6c37a7de50618e55fce94
-  data.tar.gz: f13265ed097e7bb4f4625ed6fcf7da9e45208f33e382c6af0df7157345af3efa
+SHA1:
+  metadata.gz: 64573d2b1f394251482822e130a7d9ca777554d3
+  data.tar.gz: ef96805bb0b4dc31541894c950b102e389a6cc05
 SHA512:
-  metadata.gz: d68205747142bb284446c06221046a8746c7cf301e4d0306624872fc9ecc8a443386325a00581a22add14816822ac08fa98356ae36246bad49e1080001f04f02
-  data.tar.gz: 3f84e37343fd99ae8bed3fad5182b5f66c716d945db21e2c1d8be27258a1b97fd26aa5f8696a1f52226ad3a07b303b56ff5ccdf678bef8f2089c8b9dd128253f
+  metadata.gz: 3a66e638ee0a591f9ea4acc1c72f9b20e59a35f682bb147e0bf688f57b7d4e2ee36b0e97e540168218351fc875f22f253a1bad00c4fcc414b689d4e238be6c09
+  data.tar.gz: 139bf132ff6ab3f18f31f9f4196484889974a1eb7137556f1963e044c1cbffb3c61cfc731d5b4b204b7a4ae8ad51a77a2067279155feab5974f37355b57aac44

data/.gitignore

@@ -18,3 +18,5 @@ tmp
 .DS_Store
 coverate
 Gemfile.lock
+.ruby-version
+.rake_tasks*

data/.travis.yml

@@ -6,7 +6,7 @@ services:
 - redis-server
 env:
   global:
-    - CC_TEST_REPORTER_ID=d17e91219ca5c271ca9bdd9eb447611f1be6b750abe8e4bc48146f5dec1154d4
+    - CC_TEST_REPORTER_ID=c6e51bc4755c4602fccb935a436625bbac4be498193c4f40ba8c8e2ee0745182
 sudo: false
 language: ruby
 cache: bundler

data/Gemfile

@@ -2,5 +2,5 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in turnstile.gemspec
+# Specify your gem's dependencies in turnstile-rb.gemspec
 gemspec

data/README.md

@@ -1,7 +1,7 @@
-[![Build Status](https://travis-ci.org/kigster/turnstile.svg?branch=master)](https://travis-ci.org/kigster/turnstile)
-[![Test Coverage](https://codeclimate.com/github/wanelo/turnstile/badges/coverage.svg)](https://codeclimate.com/github/kigster/turnstile/coverage)
-[![Code Climate](https://codeclimate.com/github/wanelo/turnstile/badges/gpa.svg)](https://codeclimate.com/github/kigster/turnstile)
-[![Issue Count](https://codeclimate.com/github/wanelo/turnstile/badges/issue_count.svg)](https://codeclimate.com/github/kigster/turnstile)
+[![Gem Version](https://badge.fury.io/rb/turnstile-rb.svg)](https://badge.fury.io/rb/turnstile-rb)
+[![Build Status](https://travis-ci.org/kigster/turnstile-rb.svg?branch=master)](https://travis-ci.org/kigster/turnstile-rb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8031931b7924461f6a90/maintainability)](https://codeclimate.com/github/kigster/turnstile-rb/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8031931b7924461f6a90/test_coverage)](https://codeclimate.com/github/kigster/turnstile-rb/test_coverage)
 
 # Turnstile
 
@@ -11,17 +11,9 @@ The gem uses (and depends on) a [Redis](http://redis.io/) instance in order to k
 
 ## Installation
 
-Add this line to your application's Gemfile (Note that another gem with a competing name is on RubyGems, so you **must** specify the path below):
+Add this line to your application's Gemfile:
 
-    gem 'turnstile-rb'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install turnstile
+    $ gem install turnstile-rb
 
 ## Usage
 
@@ -42,20 +34,27 @@ Asynchronous tracking has a slight initial setup overhead, but has zero run-time
 
 With Real Time tracking you can use sampling to _estimate_ the number of online users. 
 
- * To do sampling, use the ```Turnstile::Tracker#track``` method 
- * To store and analyze 100% of your data use ```Turnstile::Adapter#add```. 
+ * To possibly use sampling, use the ```Turnstile::Tracker#track``` method.
+ * To store and analyze 100% of your data use ```Turnstile::Tracker#add```. 
 
 **Example:**
 
 ```ruby
-@turnstile = Turnstile::Adapter.new
+@tracker = Turnstile::Tracker.new
 
 user_id   = 12345
 platform  = 'desktop'
 ip        = '224.247.12.4'
 
 # register user
-@turnstile.add(user_id, platform, ip)
+@tracker.add(user_id, platform, ip)
+
+# or you can add a colon-delimited string token:
+@tracker.add_token("ios:172.2.5.3:39898098098")
+
+# or you with a custom delimiter:
+@tracker.add_token("ios|172.2.5.3|39898098098", '|')
+
 ```
 
 Without any further calls to ```track()``` method for this particular user/platform/ip combination, the user  is considered _online_ for 60 seconds.  Each subsequent call to ```track()``` resets the TTL.
@@ -145,25 +144,48 @@ this does not incur any additional cost for the application (as user tracking is
 
 Once the tracking information is sent, the data can be queried.  
 
-If you used sampling, then you should query using ```Turnstile::Observer``` class that provides 
-exprapolation of the results based on sample size configuration.
+If you used sampling, then you should query using ```Turnstile::Observer``` class that provides  exprapolation of the results based on sample size configuration.
+
 ```ruby
 # Return data for sampled users and the summary 
 Turnstile::Observer.new.stats
-# => { stats: { total: 3, platforms: 2 }, users: [ { uid: 1, platform: 'desktop', ip: '123.2.4.54' }, ... ]
+# => { stats: { 
+        total: 3, 
+        platforms: 2 }, 
+       users: [ { uid: 1, platform: 'desktop', ip: '123.2.4.54' }, ... ]
 ```
-If you did not use sampling, you can get some answers from the ```Turnstile::Adapter``` class:
+
+If you did not use sampling, you can get some answers from the`Turnstile::Adapter` class:
+
 ```ruby
 Turntstile::Adapter.new.fetch
 # => [ { uid: 213, :platform: 'desktop', '123.2.4.54' }, { uid: 215, ... } ]
 ```
+
 You can also request an aggregate results, suitable for sending to graphing systems or displaying on a dashboard:
+
 ```ruby
 Turntstile::Adapter.new.aggregate
 # => { 'desktop' => 234, 'ios' => 3214, ...,  'total' => 4566 }
 ```
 
-## Circonus NAD Integration
+### Summary Printing
+
+### JSON and CSV
+
+Use the following syntax:
+
+```bash
+# To see JSON summary:
+turnstile -s json
+
+# Or, for CSV
+turnstile -s csv
+```
+
+
+
+#### Circonus NAD
 
 We use Circonus to collect and graph data. You can use ```turnstile```
 to dump the current aggregate statistics from redis to standard output,
@@ -171,17 +193,18 @@ which is a tab-delimited format consumable by the nad daemon.
 
 (below output is formatted to show tabs as aligned for readability).
 
-```ruby
-> turnstile --summary
+```bash
+> turnstile -s
 
-turnstile.iphone	   n      383
+turnstile.iphone     n     383
 turnstile.ipad       n	    34
-turnstile.android    n      108
+turnstile.android    n     108
 turnstile.ipod_touch n      34
 turnstile.unknown    n      36
-turnstile.total      n      595
+turnstile.total      n     595
 ```
 
+
 ## TODO:
 
 * Allow users of the gem to easier customize log reader to fit their own custom log files

data/Rakefile

@@ -1 +1,21 @@
 require "bundler/gem_tasks"
+require 'yard'
+
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :permissions do
+  shell('rm -rf pkg/')
+  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+end
+
+task :build => :permissions
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE)
+  t.options.unshift('--title','"Turnstile — Active User Counter"')
+  t.after = ->() { exec('open doc/index.html') }
+end

data/bin/turnstile

@@ -1,91 +1,11 @@
 #!/usr/bin/env ruby
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
 require 'rubygems'
 require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
 require 'turnstile'
-require 'optparse'
-require 'colored2'
-
-options = {}
-ARGV << '-?' if ARGV.empty?
-
-Colored2.disable! unless STDOUT.tty?
-
-DESCRIPTION = <<-EOF
-Turnstile consists of two components:
-
-   1. A daemon process started with #{'turnstile -f <log-file> [ --daemon ]'.bold.green}
-      This process should run on every server that generates a log 
-      file, and they should all connect to the same Redis server. 
-
-   2. Query command, ran as #{'turnstile --summary'.bold.green}
-
-In the first form, turnstile can tail a given log file, 
-parsing and tallying and periodically syncing to the master 
-Redis server.
-
-When the query is invoked, data from all reporters is shown on STDOUT.
-EOF
-
-OptionParser.new do |opts|
-  opts.banner = "Usage:\n".bold.magenta +
-    "    turnstile -f <file> [ --daemon ] [options]\n".green +
-    "    turnstile --summary [options]\n".green
-
-  opts.separator "Description:".bold.magenta
-  opts.separator '    ' + DESCRIPTION.gsub(/\n/, "\n   ")
 
-  opts.separator "Log File Specification:".bold.magenta
-  opts.on('-f', '--file FILE', 'File to monitor') do |file|
-    options[:file] = file
-  end
-  opts.on('-t', '--file-type TYPE',
-          'Either: json_formatted, pipe_delimited,',
-          'or comma_delimited (default).') do |type|
-    options[:filetype] = type
-  end
-  opts.on('-D', '--delimiter CHAR',
-          'Forces "delimited" file type, and uses ',
-          'the character in the argument as the delimiter') do |v|
-    options[:delimiter] = v
-  end
-  opts.separator "\nRedis Server:".bold.magenta
-  opts.on('-h', '--redis-host HOST', 'Redis server host') do |host|
-    Turnstile.config.redis_host = host
-  end
-  opts.on('-p', '--redis-port PORT', 'Redis server port') do |port|
-    Turnstile.config.redis_port = port
-  end
-  opts.on('-n', '--redis-db DB', 'Redis server db') do |db|
-    Turnstile.config.redis_db = db
-  end
-  opts.separator "\nMode of Operation:".bold.magenta
-  opts.on('-d', '--daemonize', 'Daemonize to watch the logs') do |v|
-    options[:daemonize] = true
-  end
-  opts.on('-s', '--summary', 'Print current stats (using NAD format) and exit') do |v|
-    options[:summary] = true
-  end
-  opts.separator "\nTiming Adjustments:".bold.magenta
-  opts.on('-b', '--buffer-interval INTERVAL', 'Buffer for this many seconds') do |v|
-    options[:buffer_interval] = v.to_i
-  end
-  opts.on('-i', '--flush-interval INTERVAL', 'Flush then sleep for this many seconds') do |v|
-    options[:flush_interval] = v.to_i
-  end
-  opts.separator "\nMiscellaneous:".bold.magenta
-  opts.on('-v', '--verbose', 'Print status to stdout') do |v|
-    options[:debug] = true
-  end
-  opts.on_tail('-?', '--help', 'Show this message') do
-    puts opts
-    exit
-  end
-end.parse!
+require 'turnstile/runner'
 
-if options[:summary]
-  STDOUT.puts Turnstile::Nad.new.data
-else
-  Turnstile::Collector::Runner.new(options).run
-end
+Turnstile::Runner.new(ARGV).execute!
 

data/lib/turnstile/adapter.rb

@@ -7,9 +7,11 @@ module Turnstile
     include Timeout
 
     def initialize
-      self.redis = ::Redis.new(host: config.redis.host,
-                               port: config.redis.port,
-                               db:   config.redis.db)
+      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)
@@ -51,7 +53,6 @@ module Turnstile
       Turnstile.config
     end
 
-
     def compose_key(uid, platform = nil, ip = nil)
       "t:#{uid}:#{platform}:#{ip}"
     end

data/lib/turnstile/collector/matcher.rb

@@ -14,7 +14,7 @@ module Turnstile
       end
 
       def matches?(line)
-        regexp && regexp.match?(line)
+        regexp && regexp.match(line)
       end
     end
   end

data/lib/turnstile/collector/runner.rb

@@ -1,5 +1,6 @@
 require 'thread'
 require 'daemons/daemonize'
+require 'colored2'
 
 
 module Turnstile
@@ -26,7 +27,7 @@ module Turnstile
       def wait_for_file(file)
         sleep_period = 1
         while !File.exist?(file)
-          STDERR.puts "File #{file} does not exist, waiting for it to appear..."
+          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

data/lib/turnstile/configuration.rb

@@ -5,6 +5,7 @@ module Turnstile
   class RedisConfig < ::Hashie::Dash
     include Hashie::Extensions::Dash::PropertyTranslation
 
+    property :url, required: false
     property :host, default: '127.0.0.1', required: true
     property :port, default: 6379, required: true, transform_with: ->(value) { value.to_i }
     property :db, default: 1, required: true, transform_with: ->(value) { value.to_i }

data/lib/turnstile/parser.rb

@@ -0,0 +1,107 @@
+require 'optparse'
+require 'colored2'
+require 'forwardable'
+
+require 'turnstile/version'
+
+module Turnstile
+  class Parser
+    extend Forwardable
+    def_delegators :@system, :stdout, :stdin, :stderr
+
+    attr_accessor :options, :argv, :system
+
+    def initialize(argv, system)
+      self.system  = system
+      self.argv    = argv.dup
+      self.options = Hashie::Mash.new
+      self.argv << '-h' if argv.empty?
+    end
+
+    def parse
+      OptionParser.new do |opts|
+        opts.banner = "Usage:\n".bold.magenta +
+          "     turnstile -f <file> [ --daemon ]  [ options ]\n".yellow +
+          "     turnstile -s [ json | csv | nad ] [ options ]\n".yellow +
+          "     turnstile -a 'platform:ip:user'   [ options ]\n".yellow
+
+        opts.separator 'Description:'.bold.magenta
+        opts.separator '   ' + ::Turnstile::DESCRIPTION.gsub(/\n/, "\n   ")
+
+        opts.separator 'Log File Specification:'.bold.magenta
+        opts.on('-f', '--file FILE', 'File to monitor') do |file|
+          options[:file] = file
+        end
+        opts.on('-t', '--file-type TYPE',
+                'Either: json_formatted, pipe_delimited,',
+                'or comma_delimited (default).') do |type|
+          options[:filetype] = type
+        end
+        opts.on('-D', '--delimiter CHAR',
+                'Forces "delimited" file type, and uses ',
+                'the character in the argument as the delimiter') do |v|
+          options[:delimiter] = v
+        end
+        opts.separator "\nRedis Server:".bold.magenta
+        opts.on('-r', '--redis-url URL', 'Redis server URL') do |host|
+          Turnstile.config.redis_url = host
+        end
+        opts.on('--redis-host HOST', 'Redis server host') do |host|
+          Turnstile.config.redis_host = host
+        end
+        opts.on('--redis-port PORT', 'Redis server port') do |port|
+          Turnstile.config.redis_port = port
+        end
+        opts.on('--redis-db DB', 'Redis server db') do |db|
+          Turnstile.config.redis_db = db
+        end
+        opts.separator "\nMode of Operation:".bold.magenta
+        opts.on('-d', '--daemonize', 'Daemonize to watch the logs') do |v|
+          options[:daemonize] = true
+        end
+        opts.on('-s', '--summary [FORMAT]',
+                'Print current stats and exit. Optional format can be',
+                'json (default), nad, yaml, or csv') do |v|
+          options[:summary]        = true
+          options[:summary_format] = (v || 'json').to_sym
+        end
+        opts.on('-a', '--add TOKEN',
+                'Registers an event from the token, such as ',
+                '"ios:123.4.4.4:32442". Use -d to customize delimiter.') do |v|
+          options[:add] = v
+        end
+        opts.separator "\nTiming Adjustments:".bold.magenta
+        opts.on('-b', '--buffer-interval INTERVAL', 'Buffer for this many seconds') do |v|
+          options[:buffer_interval] = v.to_i
+        end
+        opts.on('-i', '--flush-interval INTERVAL', 'Flush then sleep for this many seconds') do |v|
+          options[:flush_interval] = v.to_i
+        end
+        opts.separator "\nMiscellaneous:".bold.magenta
+        opts.on('-v', '--verbose', 'Print status to stdout') do |v|
+          options[:debug] = true
+        end
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          return
+        end
+      end.parse!(argv)
+
+      if options[:summary]
+        Turnstile::Summary.print(options[:summary_format] || :json, options[:delimiter])
+      elsif options[:add]
+        Turnstile::Tracker.new.add_token(options[:add], options[:delimiter] || ':')
+        Turnstile::Summary.print(options[:summary_format] || :json)
+      else
+        Turnstile::Collector::Runner.new(options).run
+      end
+
+    rescue OptionParser::MissingArgument => e
+      STDERR.puts e.message.bold.red
+    rescue Exception => e
+      STDERR.puts e.message.bold.red
+    end
+  end
+end
+
+

data/lib/turnstile/runner.rb

@@ -0,0 +1,54 @@
+require 'optparse'
+require 'colored2'
+
+require 'turnstile/version'
+require 'turnstile/parser'
+
+module Turnstile
+
+
+  class Runner
+    attr_reader :argv, :stdin, :stdout, :stderr, :kernel
+
+    # Allow everything fun to be injected from the outside while defaulting to normal implementations.
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+    end
+
+    def execute!
+      exit_code = begin
+
+        Colored2.disable! unless stdout.tty?
+
+        $stderr = stderr
+        $stdin  = stdin
+        $stdout = stdout
+
+        Turnstile::Parser.new(argv, self).parse
+
+        # Thor::Base#start does not have a return value, assume success if no exception is raised.
+        0
+      rescue StandardError => e
+        # The ruby interpreter would pipe this to STDERR and exit 1 in the case of an unhandled exception
+        b = e.backtrace
+        @stderr.puts("#{b.shift}: #{e.message} (#{e.class})")
+        @stderr.puts(b.map { |s| "\tfrom #{s}" }.join("\n"))
+        1
+      rescue SystemExit => e
+        e.status
+      ensure
+        $stderr = STDERR
+        $stdin  = STDIN
+        $stdout = STDOUT
+      end
+
+      # Proxy our exit code back to the injected kernel.
+      @kernel.exit(exit_code)
+    end
+  end
+end
+
+module Turnstile
+
+end
+

data/lib/turnstile/summary.rb

@@ -0,0 +1,57 @@
+require 'csv'
+module Turnstile
+  class Summary
+
+    class << self
+      def print(method, delimiter = nil)
+        summary = new
+        if summary.respond_to?(method)
+          STDOUT.puts summary.send(method, delimiter)
+        else
+          STDERR.puts "don't know how to use format '#{method}'mac"
+        end
+      end
+    end
+
+    def json(*)
+      out = "{\n"
+      first = true
+      aggregate.each_pair do |key, value|
+        out << ",\n" unless first
+        first = false
+        out << json_row(key, value)
+      end
+      out << "\n}"
+      out
+    end
+
+    def nad(*)
+      out = ''
+      aggregate.each_pair do |key, value|
+        out << nad_row(key, value)
+      end
+      out
+    end
+
+    def csv(delimiter = nil)
+      out = CSV.generate do |csv|
+        aggregate.each_pair do |key, value|
+          csv << [key, value]
+        end
+      end
+      delimiter ? out.gsub(/,/m, delimiter) : out
+    end
+
+    def nad_row(key, value)
+      %Q(turnstile:#{key}#{"\tn\t"}#{value}\n)
+    end
+
+    def json_row(key, value)
+      %Q(  "#{key}": #{value})
+    end
+
+    def aggregate
+      Turnstile::Adapter.new.aggregate
+    end
+  end
+end

data/lib/turnstile/tracker.rb

@@ -1,9 +1,20 @@
 module Turnstile
   class Tracker
-    def track(uid, platform = 'unknown', ip = nil)
+    def sample(uid, platform = 'unknown', ip = nil)
       adapter.add(uid, platform, ip) if sampler.sample(uid)
     end
 
+    alias track sample
+
+    def add(uid, platform = 'unknown', ip = nil)
+      adapter.add(uid, platform, ip)
+    end
+
+    def add_token(token, delimiter = ':')
+      platform, ip, uid = token.split(delimiter)
+      adapter.add(uid, platform, ip) if uid
+    end
+
     private
 
     def adapter

data/lib/turnstile/version.rb

@@ -1,3 +1,21 @@
 module Turnstile
-  VERSION = '2.0.0'
+  VERSION     = '2.0.1'
+
+  GEM_DESCRIPTION = <<-EOF
+  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.
+  EOF
+
+  DESCRIPTION = <<-EOF
+  Turnstile can run as a daemon, in which mode it monitors a given log file. 
+  Alternatively, turnstile binary can be used to print current stats, and even
+  add new data into the registry.  
+ 
+  If you are using Turnstile to tail log files, make sure you run on each app sever
+  that's generating log files.
+  EOF
+
 end

data/lib/turnstile.rb

@@ -6,7 +6,7 @@ require 'turnstile/tracker'
 require 'turnstile/observer'
 require 'turnstile/logger'
 require 'turnstile/collector'
-require 'turnstile/nad'
+require 'turnstile/summary'
 
 module Turnstile
   def self.configure(&block)

data/spec/turnstile/summary_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Turnstile::Summary do
+  subject { described_class.new }
+
+  let(:aggregate) {
+    {
+      'android' => 3,
+      'ios'     => 2,
+      'total'   => 5
+    }
+  }
+
+  before { expect(subject).to receive(:aggregate).once.and_return(aggregate) }
+
+  describe '#nad' do
+    context 'have some data' do
+      let(:expected_string) {
+        <<-EOF
+turnstile:android#{"\t"}n#{"\t"}3
+turnstile:ios#{"\t"}n#{"\t"}2
+turnstile:total#{"\t"}n#{"\t"}5
+        EOF
+      }
+
+      it 'return data in NAD format' do
+        expect(subject.nad).to eql(expected_string)
+      end
+    end
+  end
+
+  describe '#json' do
+    context 'have some data' do
+      let(:json) { subject.json }
+      let(:hash) { JSON.load(json) }
+      it 'return data in NAD format' do
+        expect(hash).to eql(aggregate)
+      end
+    end
+  end
+end

data/turnstile-rb.gemspec

@@ -8,8 +8,11 @@ Gem::Specification.new do |spec|
   spec.version       = Turnstile::VERSION
   spec.authors       = ['Konstantin Gredeskoul']
   spec.email         = %w(kigster@gmail.com)
+
   spec.summary       = %q{Asynchronous and non-invasive concurrent user tracking with Redis, by scanning application logs across all servers.}
-  spec.description   = %q{Asynchronous and non-invasive concurrent user tracking with Redis, by scanning application logs across all servers.}
+
+  spec.description   = Turnstile::GEM_DESCRIPTION
+
   spec.homepage      = 'https://github.com/kigster/turnstile-rb'
   spec.license       = 'MIT'
 
@@ -27,10 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'yard'
 
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'rb-fsevent'
   spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turnstile-rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,21 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
-  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: guard-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,8 +178,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Asynchronous and non-invasive concurrent user tracking with Redis, by
-  scanning application logs across all servers.
+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.
 email:
 - kigster@gmail.com
 executables:
@@ -205,7 +195,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -220,10 +209,11 @@ files:
 - lib/turnstile/collector/updater.rb
 - lib/turnstile/configuration.rb
 - lib/turnstile/logger.rb
-- lib/turnstile/nad.rb
 - lib/turnstile/observer.rb
-- lib/turnstile/rb.rb
+- lib/turnstile/parser.rb
+- lib/turnstile/runner.rb
 - lib/turnstile/sampler.rb
+- lib/turnstile/summary.rb
 - lib/turnstile/tracker.rb
 - lib/turnstile/version.rb
 - spec/fixtures/sample-production.log
@@ -232,9 +222,9 @@ files:
 - spec/turnstile/adapter_spec.rb
 - spec/turnstile/collector/log_reader_spec.rb
 - spec/turnstile/configuration_spec.rb
-- spec/turnstile/nad_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
@@ -258,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Asynchronous and non-invasive concurrent user tracking with Redis, by scanning
@@ -270,8 +260,8 @@ test_files:
 - spec/turnstile/adapter_spec.rb
 - spec/turnstile/collector/log_reader_spec.rb
 - spec/turnstile/configuration_spec.rb
-- spec/turnstile/nad_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/Guardfile

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-#^syntax detection
-
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec' do
-  watch(%r{^lib/(.+)\.rb$}) { "spec" }
-  watch(%r{^spec/.+_spec\.rb$})
-  watch('spec/spec_helper.rb')  { "spec" }
-  watch(%r{spec/support/.*}) { "spec" }
-end
-

data/lib/turnstile/nad.rb

@@ -1,16 +0,0 @@
-module Turnstile
-  class Nad
-
-    def data
-      out = ""
-      aggregate.each_pair do |key, value|
-        out << %Q(turnstile:#{key}#{"\tn\t"}#{value}\n)
-      end
-      out
-    end
-
-    def aggregate
-      Turnstile::Adapter.new.aggregate
-    end
-  end
-end

data/lib/turnstile/rb.rb

@@ -1 +0,0 @@
-require_relative '../turnstile'

data/spec/turnstile/nad_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-describe 'Turnstile::Nad' do
-
-  subject { Turnstile::Nad.new }
-
-  describe '#data' do
-    context 'have some data' do
-      let(:aggregate) { {
-            'android' => 3,
-            'ios' => 2,
-            'total' => 5
-        }
-      }
-
-      let(:expected_string) {
-          <<-EOF
-turnstile:android#{"\t"}n#{"\t"}3
-turnstile:ios#{"\t"}n#{"\t"}2
-turnstile:total#{"\t"}n#{"\t"}5
-          EOF
-      }
-
-      it "return data in NAD tab dilimited format" do
-        expect(subject).to receive(:aggregate).once.and_return(aggregate)
-        expect(subject.data).to eql(expected_string)
-      end
-    end
-
-  end
-end