timed-rediscounter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abc6230c879819d52482f8d11b8a7a88b8b5f4a9
+  data.tar.gz: e9b4a4336ba02e1062f6ababd6f1fe1760a0a8bb
+SHA512:
+  metadata.gz: 777ccd32facd6d3028b8355c6d3011a3fbbed8dd541f5254ecdea9f1c37c28aa57da72fc3ff2a0b1100a2a62b215f0aecc14250054dbd6efbb1ee81777a6a07f
+  data.tar.gz: b0c354cd2aa008f081caa57e327c42e2e7ab0a6594794ebe14ffe75ab2b1344159fbd72817bc55474c04f96a5f93ce520125a9d1d22cca062235efc13d6044e8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 christopher.geduhn@ticketpay.de. 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 timed-rediscounter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+# Timed::Rediscounter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/timed/rediscounter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'timed-rediscounter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timed-rediscounter
+
+## Usage
+
+```ruby
+class TestObject
+  include Timed::Rediscounter
+
+  #class neeeds an id or another id field => see below
+  def id 
+    1
+  end
+
+  # Define a counter like: 
+  timed_rediscounter(:test1)
+  # only a counter for hours and days
+  # valid periods are [:minute, :hour,   :day,     :month,  :year]
+  timed_rediscounter(:test2,periods: [:hour,:day])
+
+  # you can pass a other id field
+  timed_rediscounter(:test2,id_field: :special_id_field)
+
+end
+
+##Incrementation
+obj.test1.incr()
+#if you want to incrment by a value bigger than 1
+obj.test1.incr(offset: 10)
+#if you want to increment for a specific timestamp
+obj.test1.incr(time: 10.years.ago)
+#if you want to increment for a specific timestamp
+obj.test1.incr(time: 10.years.ago)
+#if you only want to increment for specific periods
+obj.test1.incr(periods: [:year])
+
+
+##Results
+
+#return a timestamp hash with timestamp as key and count as value
+obj.history(1.minute.ago)
+
+#returns the sum in the given range
+obj.sum(1.minute.ago..Time.now) #or obj.sum(1.minute.ago)
+
+
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cgeduhn/timed-rediscounter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Timed::Rediscounter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/timed-rediscounter/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "timed/rediscounter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/timed/rediscounter/version.rb

@@ -0,0 +1,5 @@
+module Timed
+  module Rediscounter
+    VERSION = "1.0.0"
+  end
+end

data/lib/timed/rediscounter.rb

@@ -0,0 +1,68 @@
+require 'active_support'
+require 'active_support/time'
+
+require 'active_support/core_ext/date/conversions'
+require 'active_support/core_ext/hash'
+
+require "redis"
+
+require "timed/rediscounter/version"
+require "timed/rediscounter/counter"
+
+
+
+module Timed
+  module Rediscounter
+    extend ActiveSupport::Concern
+
+    def self.redis=(r)
+      @redis = r if r.is_a?(Redis)
+    end
+
+    def self.redis
+      @redis || $redis
+    end
+
+
+    module ClassMethods
+      #examples
+      # Define like: 
+      #
+      # timed_rediscounter(:test1)
+      # timed_rediscounter(:test2,periods: [:hour,:day])
+      # timed_rediscounter(:test3,steps: [1.day,1.month,1.year])
+      # timed_rediscounter(:test4,periods: [:hour,:day,:year], steps: [1.day,1.month,1.year])
+      # 
+      # Steps are for defining limits when to output which timehash for a given range
+      #
+      # EXAMPLES
+      # steps: : [1.day,1.month,1.year]
+      # periods: [:hour,:day,:year]
+      #
+      #   counter.hash_for_range(1.hour.ago..Time.now) will return daty by hour:
+      # 
+      #   {2017-09-21 16:00:00 +0200=>0, 2017-09-21 17:00:00 +0200=>0, 2017-09-21 18:00:00 +0200=>0, 2017-09-21 19:00:00 +0200=>0, ... .. 
+      #
+      #
+      # 
+      #   counter.hash_for_range(27.days.ago..Time.now) will return dates by day:
+      #
+      #   {2017-08-26 02:00:00 +0200=>0, 2017-08-27 02:00:00 +0200=>0, 2017-08-28 02:00:00 +0200=>0, 2017-08-29 02:00:00 +0200=>0, 2
+      def timed_rediscounter(key_name,options={})
+        obj_v_string = "@#{key_name}_instance_variable"
+
+        id_field = (options.delete(:id_field) || :id)
+        define_method(key_name) do 
+          if instance_variable_get(obj_v_string)
+            instance_variable_get(obj_v_string)
+          else
+            o = Timed::Rediscounter::Counter.new([key_name,send(id_field)].join("::"),options)
+            instance_variable_set(obj_v_string, o)
+          end
+        end
+      end
+    end
+
+
+  end
+end

data/timed-rediscounter.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "timed/rediscounter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "timed-rediscounter"
+  spec.version       = Timed::Rediscounter::VERSION
+  spec.authors       = ["Christopher Geduhn"]
+  spec.email         = ["christopher.geduhn@googlemail.com"]
+
+  spec.summary       = %q{A timed counter based on redis hashes}
+  spec.description   = %q{A timed counter based on redis hashes}
+  spec.homepage      = "https://github.com/cgeduhn/timed-rediscounter/wiki"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "https://github.com/cgeduhn/timed-rediscounter"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis"
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: timed-rediscounter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christopher Geduhn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: A timed counter based on redis hashes
+email:
+- christopher.geduhn@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/timed/rediscounter.rb
+- lib/timed/rediscounter/version.rb
+- timed-rediscounter.gemspec
+homepage: https://github.com/cgeduhn/timed-rediscounter/wiki
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A timed counter based on redis hashes
+test_files: []