trifle-stats 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd4c1f777b76f6684d0ba5bbe2e3931585506325b4984192754570631d0c988
-  data.tar.gz: 11b7dafeaead2148f1659c663335b6a0d6e4f4daba8dd7b9dbf339783d757db6
+  metadata.gz: 61ed8d636a39a6b304b1877d29f6c70b6653b59c0a0a4e18bf9099cf0c903c7d
+  data.tar.gz: 99488122d8ac47e900dd3764cc61f3012a00a47433dd8b6a857185220fc72335
 SHA512:
-  metadata.gz: 8a84f59fe3277ce49ab4608a2fd47e7238488ae98e616d071c290900843b13ce33560a46d10a94d402cf33416b417f22f39c1bebfeb4340d6d5aae33753d7655
-  data.tar.gz: 6f4b533bebe8f4fb2cda97d40b7e3b7d503033be99441194dfe5266eec35462c3b4db1641742c67a035692e618c3b9411fcb29471ef2592a74e0bd705401de89
+  metadata.gz: 7e4885fb88963d054b811c68a717e7e77dc9ddad55c11a499f98d599531f2fda6c12dd14e8cb680c367a7260976a6a411f7008845913323813bcaa9d1854e1bb
+  data.tar.gz: ca1153f0d6ea56daf21d1fd507e0603e82bcfda0670a2093e6148a199928350d31ca7a980067d90add1e8c810fb719024602596764e8b025a490b7f9e3970780

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trifle-stats (0.1.0)
+    trifle-stats (0.2.0)
       redis (>= 4.2)
       tzinfo (~> 2.0)
 

data/README.md

@@ -1,4 +1,4 @@
-# Trifle
+# Trifle::Stats
 
 [![Gem Version](https://badge.fury.io/rb/trifle-stats.svg)](https://badge.fury.io/rb/trifle-stats)
 ![Ruby](https://github.com/trifle-io/trifle-stats/workflows/Ruby/badge.svg?branch=main)
@@ -6,9 +6,13 @@
 
 Simple analytics backed by Redis, Postgres, MongoDB, Google Analytics, Segment, or whatever. [^1]
 
-Trifle is a _way too_ simple timeline analytics that helps you track custom metrics. Automatically increments counters for each enabled range. It supports timezones and different week beginning.
+`Trifle::Stats` is a _way too_ simple timeline analytics that helps you track custom metrics. Automatically increments counters for each enabled range. It supports timezones and different week beginning.
 
-[^1] TBH only Redis for now 💔.
+[^1]: TBH only Redis for now 💔.
+
+## Documentation
+
+You can find guides and documentation at https://trifle.io/docs/stats
 
 ## Installation
 
@@ -54,19 +58,6 @@ Trifle::Stats.track(key: 'event::logs', at: Time.now, values: {count: 1, duratio
 => [{2021-01-25 16:00:00 +0100=>{:count=>1, :duration=>5, :lines=>361}}, {2021-01-25 00:00:00 +0100=>{:count=>1, :duration=>5, :lines=>361}}]
 ```
 
-You can also store nested counters like
-```ruby
-Trifle::Stats.track(key: 'event::logs', at: Time.now, values: {
-  count: 1,
-  duration: {
-    parsing: 21,
-    compression: 8,
-    upload: 1
-  },
-  lines: 25432754
-})
-```
-
 ### Get values
 
 Retrieve your values for specific `range`.
@@ -75,55 +66,6 @@ Trifle::Stats.values(key: 'event::logs', from: Time.now, to: Time.now, range: :d
 => [{2021-01-25 00:00:00 +0100=>{"count"=>3, "duration"=>8, "lines"=>658}}]
 ```
 
-### Configuration
-
-Configuration allows you to specify:
-- `driver` - backend driver used to persist and retrieve data.
-- `track_ranges` - list of timeline ranges you would like to track. Value must be list of symbols, defaults to `[:minute, :hour, :day, :week, :month, :quarter, :year]`.
-- `separator` - keys can get serialized in backend, separator is used to join these values. Value must be string, defaults to `::`.
-- `time_zone` - TZInfo zone to properly generate range for timeline values. Value must be valid TZ string identifier, otherwise it defaults and fallbacks to `'GMT'`.
-- `beginning_of_week` - first day of week. Value must be string, defaults to `:monday`.
-
-Gem expecs global configuration to be present. You can do this by creating initializer, or calling it on the beginning of your ruby script.
-
-Custom configuration can be passed as a keyword argument to `Resource` objects and all module methods (`track`, `values`). This way you can pass different driver or ranges for different type of data youre storing - ie set different ranges or set expiration date on your data.
-
-```ruby
-configuration = Trifle::Stats::Configuration.new
-configuration.driver = Trifle::Stats::Driver::Redis.new
-configuration.track_ranges = [:day]
-configuration.time_zone = 'GMT'
-configuration.separator = '#'
-
-# or use different driver
-mongo_configuration = Trifle::Stats::Configuration.new
-mongo_configuration.driver = Trifle::Stats::Driver::MongoDB.new
-mongo_configuration.time_zone = 'Asia/Dubai'
-```
-
-You can then pass it into module methods.
-```ruby
-Trifle::Stats.track(key: 'event#checkout', at: Time.now, values: {count: 1}, config: configuration)
-
-Trifle::Stats.track(key: 'event#checkout', at: Time.now, values: {count: 1}, config: mongo_configuration)
-```
-
-### Driver
-
-Driver is a wrapper around existing client libraries that talk to DB or API. It is used to store and retrieve values. You can read more in [Driver Readme](https://github.com/trifle-io/trifle-stats/tree/main/lib/trifle/ruby/driver).
-
-## 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).
-
-## Gitpod
-
-This repository comes Gitpod ready. If you wanna try and get your hands dirty with Trifle, click [here](https://gitpod.io/#https://github.com/trifle-io/trifle-stats) and watch magic happening.
-
-It launches from custom base image that includes Redis, MongoDB, Postgres & MariaDB. This should give you enough playground to launch `./bin/console` and start messing around. You can see the Gitpod image in the [hub](https://hub.docker.com/r/trifle/gitpod).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/trifle-io/trifle-stats.

data/lib/trifle/stats.rb

@@ -6,6 +6,7 @@ require 'trifle/stats/mixins/packer'
 require 'trifle/stats/nocturnal'
 require 'trifle/stats/configuration'
 require 'trifle/stats/operations/timeseries/increment'
+require 'trifle/stats/operations/timeseries/set'
 require 'trifle/stats/operations/timeseries/values'
 require 'trifle/stats/version'
 
@@ -33,6 +34,15 @@ module Trifle
       ).perform
     end
 
+    def self.assert(key:, at:, values:, config: nil)
+      Trifle::Stats::Operations::Timeseries::Set.new(
+        key: key,
+        at: at,
+        values: values,
+        config: config
+      ).perform
+    end
+
     def self.values(key:, from:, to:, range:, config: nil)
       Trifle::Stats::Operations::Timeseries::Values.new(
         key: key,

data/lib/trifle/stats/driver/README.md

@@ -1,59 +1,11 @@
 # Driver
 
 Driver is a wrapper class that persists and retrieves values from backend. It needs to implement:
-- `inc(key:, **values)` method to store values
-- `get(key:)` method to retrieve values
-
-## Packer Mixin
-
-Some databases cannot store nested hashes/values. Or they cannot perform increment on nested values that does not exist. For this reason you can use Packer mixin that helps you convert values to dot notation.
-
-```ruby
-class Sample
-  include Trifle::Stats::Mixins::Packer
-end
-
-values = { a: 1, b: { c: 22, d: 33 } }
-=> {:a=>1, :b=>{:c=>22, :d=>33}}
-
-packed = Sample.pack(hash: values)
-=> {"a"=>1, "b.c"=>22, "b.d"=>33}
-
-Sample.unpack(hash: packed)
-=> {"a"=>1, "b"=>{"c"=>22, "d"=>33}}
-```
 
-## Dummy driver
-
-Sample of using custom driver that does, well, nothing useful.
-
-```ruby
-irb(main):001:1* class Dummy
-irb(main):002:2*   def inc(key:, **values)
-irb(main):003:2*     puts "Dumping #{key} => #{values}"
-irb(main):004:1*   end
-irb(main):005:2*   def get(key:)
-irb(main):006:2*     puts "Random for #{key}"
-irb(main):007:2*     { count: rand(1000) }
-irb(main):008:1*   end
-irb(main):009:0> end
-=> :get
-
-irb(main):010:0> c = Trifle::Stats::Configuration.new
-=> #<Trifle::Stats::Configuration:0x00007fe179aed848 @separator="::", @ranges=[:minute, :hour, :day, :week, :month, :quarter, :year], @beginning_of_week=:monday, @time_zone="GMT">
-
-irb(main):011:0> c.driver = Dummy.new
-=> #<Dummy:0x00007fe176302ac8>
-
-irb(main):012:0> c.track_ranges = [:minute, :hour]
-=> [:minute, :hour]
+- `inc(key:, **values)` method add values
+- `set(key:, **values)` method set values
+- `get(key:)` method to retrieve values
 
-irb(main):013:0> Trifle::Stats.track(key: 'sample', at: Time.now, values: {count: 1}, config: c)
-Dumping sample::minute::1611696240 => {:count=>1}
-Dumping sample::hour::1611694800 => {:count=>1}
-=> [{2021-01-26 21:24:00 +0000=>{:count=>1}}, {2021-01-26 21:00:00 +0000=>{:count=>1}}]
+## Documentation
 
-irb(main):014:0> Trifle::Stats.values(key: 'sample', from: Time.now, to: Time.now, range: :hour, config: c)
-Random for sample::hour::1611694800
-=> [{2021-01-26 21:00:00 +0000=>{:count=>405}}]
-```
+For more details about Drivers, please refer to https://trifle.io/docs/stats/drivers

data/lib/trifle/stats/driver/redis.rb

@@ -23,6 +23,12 @@ module Trifle
           end
         end
 
+        def set(key:, **values)
+          pkey = [@prefix, key].join('::')
+
+          @client.hmset(pkey, *self.class.pack(hash: values))
+        end
+
         def get(key:)
           pkey = [@prefix, key].join('::')
 

data/lib/trifle/stats/operations/timeseries/set.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Stats
+    module Operations
+      module Timeseries
+        class Set
+          attr_reader :key, :values
+
+          def initialize(**keywords)
+            @key = keywords.fetch(:key)
+            @at = keywords.fetch(:at)
+            @values = keywords.fetch(:values)
+            @config = keywords[:config]
+          end
+
+          def config
+            @config || Trifle::Stats.default
+          end
+
+          def perform
+            config.ranges.map do |range|
+              at = Nocturnal.new(@at, config: config).send(range)
+              config.driver.set(
+                key: [key, range, at.to_i].join(config.separator),
+                **values
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trifle/stats/version.rb

@@ -2,6 +2,6 @@
 
 module Trifle
   module Stats
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/trifle-stats.gemspec

@@ -6,15 +6,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jozef Vaclavik']
   spec.email         = ['jozef@hey.com']
 
-  spec.summary       = 'Simple analytics for tracking events and status counts'
-  spec.description   = 'Trifle Stats allows you to submit counters and'\
-                       'automatically storing them for each range.'\
-                       'Supports multiple backend drivers.'
-  spec.homepage      = "https://github.com/trifle-io/trifle-stats"
+  spec.summary       = 'Simple analytics backed by Redis, Postgres, MongoDB, '\
+                       'Google Analytics, Segment, or whatever.'
+  spec.description   = 'Trifle::Stats is a way too simple timeline analytics '\
+                       'that helps you track custom metrics. Automatically '\
+                       'increments counters for each enabled range. '\
+                       'It supports timezones and different week beginning.'
+  spec.homepage      = "https://trifle.io"
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = "https://github.com/trifle-io/trifle-stats"
+  spec.metadata['source_code_uri'] = 'https://github.com/trifle-io/trifle-stats'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trifle-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jozef Vaclavik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,8 +122,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Trifle Stats allows you to submit counters andautomatically storing them
-  for each range.Supports multiple backend drivers.
+description: Trifle::Stats is a way too simple timeline analytics that helps you track
+  custom metrics. Automatically increments counters for each enabled range. It supports
+  timezones and different week beginning.
 email:
 - jozef@hey.com
 executables: []
@@ -139,7 +140,6 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".tool-versions"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -155,13 +155,14 @@ files:
 - lib/trifle/stats/mixins/packer.rb
 - lib/trifle/stats/nocturnal.rb
 - lib/trifle/stats/operations/timeseries/increment.rb
+- lib/trifle/stats/operations/timeseries/set.rb
 - lib/trifle/stats/operations/timeseries/values.rb
 - lib/trifle/stats/version.rb
 - trifle-stats.gemspec
-homepage: https://github.com/trifle-io/trifle-stats
+homepage: https://trifle.io
 licenses: []
 metadata:
-  homepage_uri: https://github.com/trifle-io/trifle-stats
+  homepage_uri: https://trifle.io
   source_code_uri: https://github.com/trifle-io/trifle-stats
 post_install_message:
 rdoc_options: []
@@ -181,5 +182,6 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Simple analytics for tracking events and status counts
+summary: Simple analytics backed by Redis, Postgres, MongoDB, Google Analytics, Segment,
+  or whatever.
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.4