hit_list 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b66c6daf960a7b4f088908bda841f84826764ae
+  data.tar.gz: bb2ab292705bc84bb727475922897d43bb8ffbe0
+SHA512:
+  metadata.gz: 03d341c62daa4992d6d64a9152d27ca358392a0edcafee8315cb07d434d3a8b80e690124df2d53cdddacad1d7d1f7396abe9a663545fde6eb2bca1bfb46d5392
+  data.tar.gz: 52fecd21ee1eaff7cb2d4f6f16f2485e48fa10b7df9f3ef28922fa4678ab25e6e1e4f92c7a2efa1aec2c40f01291b9ab313dcaf8273a18bc98bb4b10ee9fc3c2

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- jruby-19mode
+- rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hot_or_not.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Krists Ozols
+
+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,95 @@
+# HitList
+
+Very simple and fast hit and popularity counter using Redis sorted sets.
+It solves problem where you need to know most popular article or project in last X days.
+
+[![Build Status](https://travis-ci.org/krists/hit_list.png?branch=master)](https://travis-ci.org/krists/hit_list)
+[![Gem Version](https://badge.fury.io/rb/hit_list.png)](http://badge.fury.io/rb/hit_list)
+[![Code Climate](https://codeclimate.com/github/krists/hit_list.png)](https://codeclimate.com/github/krists/hit_list)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hit_list'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hit_list
+    
+## Usage with Rails
+
+    # Set Redis connection in initializer
+    HitList::RailsModelExtension.redis_connection= Redis.new(host: '127.0.0.1', port: 6380)
+
+    # If you don't do this HitList will attempt to create one on its own with default arguments
+    # Equivalent to:
+    HitList::RailsModelExtension.redis_connection= Redis.new
+
+    # include in models..
+    class Article < ActiveRecord::Base
+      include HitList::RailsModelExtension
+      # ..
+    end
+
+    # Use..
+    Article.top_records(3) # => ["1", "43", "13"]
+
+    article = Article.first
+    article.total_hits # => 4
+    article.increment_hit_counter! # Increments total hits counter and ranking for days
+    article.increment_only_total_hits!
+    article.increment_only_rank!
+
+    # When you want to preserve rank stats for more than default 7 days you have to overwrite method hit_list_day_count
+    class Article < ActiveRecord::Base
+      include HitList::RailsModelExtension
+
+      def hit_list_day_count
+        14
+      end
+
+      # ..
+
+    end
+
+
+## Usage without Rails
+
+    # connect to redis db
+    redis_connection = Redis.new(:host => "10.0.1.1", :port => 6380)
+
+    # pass connection when initializing counter
+    counter = HitList::Counter.new(connection, 'articles')
+
+    # make hits..
+    counter.hit!(2)
+    counter.hit!(2)
+    counter.hit!('bob')
+
+    # see results..
+    counter.total_hits(2) # => 2
+    counter.total_hits('bob') # => 1
+
+    # You can track hits on objects. Just provide different name
+    counter_1 = HitList::Counter.new(connection, 'articles')
+    counter_1.hit!('top-story')
+    counter_2 = HitList::Counter.new(connection, 'users')
+    counter_2.hit!('alice')
+
+    # Finaly you can see top records for any given time.
+    counter_1 = HitList::Counter.new(connection, 'articles')
+    counter_1.top_records(3) # => ["91","5","34"]
+
+    # or rankings 3 days ago..
+    counter_1.top_records(2, Time.now - 3.days) # => ["5","34"]
+
+If you want to preserve ranking for more than 7 days you have to provide day count when initializing `HitList::Counter` object
+
+    # Preserve rankings for 2 weeks
+    counter = HitList::Counter.new(connection, 'articles', 14)
+    counter.hit!('something')

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/hit_list.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hit_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hit_list"
+  spec.version       = HitList::VERSION
+  spec.authors       = ["Krists Ozols"]
+  spec.email         = ["krists.ozols@gmail.com"]
+  spec.description   = %q{Very simple and fast hit and popularity counter using Redis sorted sets.}
+  spec.summary       = %q{It solves problem where you need to know most popular article or project in last X days.}
+  spec.homepage      = "https://github.com/krists/hit_list"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency "fakeredis"
+
+end

data/lib/hit_list.rb

@@ -0,0 +1,6 @@
+require "hit_list/version"
+require "hit_list/counter"
+require "hit_list/rails_model_extension"
+
+module HitList
+end

data/lib/hit_list/counter.rb

@@ -0,0 +1,78 @@
+module HitList
+  class Counter
+    DEFAULT_NAMESPACE = 'hit_list'
+    DEFAULT_DAYS_OF_INTEREST = 7
+    SECONDS_IN_DAY = 86400
+    DATE_PARTIAL_FORMAT = "%Y-%m-%d"
+    DEFAULT_INCR_VALUE = 1
+
+    # Creates new instance of counter. It requires a working Redis connection as first argument.
+    #
+    # ==== Examples
+    #
+    #   counter = HitList::Counter.new(connection, 'articles', 7)
+    #   counter = HitList::Counter.new(connection, 'articles')
+    def initialize(connection, name, days_of_interest = DEFAULT_DAYS_OF_INTEREST)
+      @connection, @name, @days_of_interest = connection, name, days_of_interest
+    end
+
+    attr_reader :namespace, :connection, :name, :days_of_interest
+
+    # Returns namespace used in keys
+    def namespace
+      DEFAULT_NAMESPACE
+    end
+
+    # Returns integer representing total hit count for specific id
+    #
+    # ==== Examples
+    #
+    #   counter.total_hits(5) # => 12
+    #   counter.total_hits('some-slug') # => 3
+    def total_hits(id)
+      connection.get("#{namespace}:#{name}:total:#{id}").to_i
+    end
+
+    # Returns array of ids sorted by most hits first
+    #
+    # ==== Examples
+    #
+    #   counter.top_records(3) # => ["31", "1", "44"]
+    #   counter.top(1, Time.now - 4.days) # => ["5"]
+    def top_records(limit, time_of_interest = nil)
+      time = time_of_interest || Time.now
+      date = time.strftime(DATE_PARTIAL_FORMAT)
+      connection.zrevrange("#{namespace}:#{name}:date:#{date}", 0, limit - 1)
+    end
+
+    # Increments total hits and rank for given id
+    def hit!(id)
+      increment_total_hits!(id)
+      increment_rank!(id)
+    end
+
+    # Increments total hits only for given id
+    def increment_total_hits!(id)
+      connection.incr("#{namespace}:#{name}:total:#{id}")
+    end
+
+    # Increments rank only for given id
+    def increment_rank!(id)
+      @connection.pipelined do
+        date_partials.each do |date_partial|
+          connection.zincrby("#{namespace}:#{name}:date:#{date_partial}", DEFAULT_INCR_VALUE, id)
+        end
+      end
+    end
+
+    private
+
+    def date_partials
+      partials = []
+      0.upto(days_of_interest - 1) do |index|
+        partials << (Time.now + (index * SECONDS_IN_DAY)).strftime(DATE_PARTIAL_FORMAT)
+      end
+      partials.to_enum
+    end
+  end
+end

data/lib/hit_list/rails_model_extension.rb

@@ -0,0 +1,52 @@
+module HitList::RailsModelExtension
+
+    def self.redis_connection
+      @redis_connection ||= begin
+        puts "HitList::RailsModelExtension: No Redis connection provided. Creating new with default settings"
+        Redis.new
+      end
+    end
+
+    def self.redis_connection=(connection)
+      @redis_connection = connection
+    end
+
+    module ClassMethods
+      def top_records(count = 5)
+        counter = HitList::Counter.new(HitList::RailsModelExtension.redis_connection, self.name)
+        counter.top_records(count)
+      end
+    end
+
+    module InstanceMethods
+
+      def hit_list_day_count
+        7
+      end
+
+      def total_hits
+        hit_counter.total_hits(self.id)
+      end
+
+      def increment_hit_counter!
+        hit_counter.hit!(self.id)
+      end
+
+      def increment_only_total_hits!
+        hit_counter.increment_total_hits!(self.id)
+      end
+
+      def increment_only_rank!
+        hit_counter.increment_rank!(self.id)
+      end
+
+      def hit_counter
+        @hit_counter ||= HitList::Counter.new(HitList::RailsModelExtension.redis_connection, self.class.name, hit_list_day_count)
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+end

data/lib/hit_list/version.rb

@@ -0,0 +1,3 @@
+module HitList
+  VERSION = "1.1.1"
+end

data/spec/counter_end_to_end_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe HitList::Counter do
+  let(:real_connection) { Redis.new }
+  let(:name) { 'article' }
+  let(:days_of_interest) { 7 }
+
+  subject { described_class.new(real_connection, name, days_of_interest) }
+
+  before(:each) do
+    real_connection.flushall
+  end
+
+  describe "#total_hits" do
+    it "works as expected" do
+      Timecop.travel(Date.parse('2013-01-21'))
+      subject.hit!(22)
+      subject.hit!(22)
+      subject.hit!(7)
+      subject.hit!(44)
+      subject.hit!(44)
+      subject.hit!(44)
+      subject.total_hits(22).should eq(2)
+      subject.total_hits(7).should eq(1)
+      subject.total_hits(44).should eq(3)
+      Timecop.return
+    end
+  end
+
+  describe "#top_records" do
+    it 'top records should work' do
+      Timecop.travel(Date.parse('2013-01-21'))
+      subject.hit!(22)
+      subject.hit!(22)
+      subject.hit!(22)
+      subject.hit!(7)
+      Timecop.travel(Date.parse('2013-01-22'))
+      subject.hit!(22)
+      subject.hit!(22)
+      Timecop.travel(Date.parse('2013-01-23'))
+      subject.hit!(22)
+      subject.hit!(7)
+      subject.hit!(7)
+      subject.hit!(7)
+      subject.hit!(7)
+      subject.top_records(2).should eq(["22", "7"])
+      Timecop.travel(Date.parse('2013-01-25'))
+      subject.top_records(2).should eq(["22", "7"])
+      Timecop.travel(Date.parse('2013-01-28'))
+      subject.top_records(2).should eq(["7", "22"])
+      Timecop.return
+    end
+  end
+end

data/spec/counter_spec.rb

@@ -0,0 +1,88 @@
+require "spec_helper"
+
+describe HitList::Counter do
+  let(:connection) { double "connection" }
+  let(:name) { 'article' }
+  let(:days_of_interest) { 7 }
+
+  subject { described_class.new(connection, name, days_of_interest) }
+
+  before(:each) do
+    connection.stub(:get) { '' }
+    connection.stub(:incr) { '' }
+    connection.stub(:zincrby) { '' }
+    connection.stub(:pipelined).and_yield
+  end
+
+  describe "#initialize" do
+    it "requires connection, name and days of interest as arguments" do
+      expect { subject }.not_to raise_error
+    end
+  end
+
+  describe "#namespace" do
+    it "returns default namespace for counter keys" do
+      subject.namespace.should eq("hit_list")
+    end
+  end
+
+  describe "#total_hits" do
+    it "calls #get to connection with key like '<namespace>:<name>:total:<id>'" do
+      connection.should_receive(:get).with('hit_list:article:total:12')
+      subject.total_hits(12)
+    end
+  end
+
+  describe "#hit!" do
+    it "calls #increment_total_hits!" do
+      subject.should_receive(:increment_total_hits!).with(13)
+      subject.hit!(13)
+    end
+    it "calls #increment_rank!" do
+      subject.should_receive(:increment_rank!).with(13)
+      subject.hit!(13)
+    end
+  end
+
+  describe "#increment_total_hits!" do
+    it "calls #incr to connection with key like '<namespace>:<name>:total:<id>'" do
+      connection.should_receive(:incr).with('hit_list:article:total:14')
+      subject.increment_total_hits!(14)
+    end
+  end
+
+  describe "#increment_rank!" do
+    it "calls #zincrby on connection with key like '<namespace>:<name>:date:<date>:<id>' multiple times with right dates" do
+      Timecop.freeze(Date.parse('2013-07-29')) do
+        connection.should_receive(:zincrby).with("hit_list:article:date:2013-07-29", 1, 66)
+        connection.should_receive(:zincrby).with("hit_list:article:date:2013-07-30", 1, 66)
+        connection.should_receive(:zincrby).with("hit_list:article:date:2013-07-31", 1, 66)
+        connection.should_receive(:zincrby).with("hit_list:article:date:2013-08-01", 1, 66)
+        connection.should_receive(:zincrby).with("hit_list:article:date:2013-08-02", 1, 66)
+        connection.should_receive(:zincrby).with("hit_list:article:date:2013-08-03", 1, 66)
+        connection.should_receive(:zincrby).with("hit_list:article:date:2013-08-04", 1, 66)
+        subject.increment_rank!(66)
+      end
+    end
+  end
+
+  describe "#top_records" do
+    context "when time not specified" do
+      it "should get top records in period" do
+        Timecop.freeze(Date.parse('2013-07-29')) do
+          connection.should_receive(:zrevrange).with("hit_list:article:date:2013-07-29", 0, 4)
+          subject.top_records(5)
+        end
+      end
+    end
+
+    context "when time is specified" do
+      it "should get top records in period" do
+        Timecop.freeze(Date.parse('2013-07-29')) do
+          connection.should_receive(:zrevrange).with("hit_list:article:date:2013-02-22", 0, 2)
+          subject.top_records(3, Date.parse('2013-02-22'))
+        end
+      end
+    end
+  end
+end

data/spec/rails_model_extension_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe HitList::RailsModelExtension do
+
+  describe "#module methods" do
+    subject { HitList::RailsModelExtension }
+    describe "#redis_connection" do
+      context "when not specifying any specific connection" do
+        it "returns Redis connection with default configuration" do
+          expect(subject.redis_connection).to be_a_kind_of(Redis)
+        end
+      end
+    end
+
+    describe "#redis_connection=" do
+      it "allows to set Redis connection" do
+        subject.redis_connection= 'fake connection'
+        subject.redis_connection.should eq('fake connection')
+      end
+    end
+  end
+
+  describe "Class with RailsModelExtension included" do
+
+    SomethingModelish = Struct.new(:id) do
+      include HitList::RailsModelExtension
+    end
+
+    describe "class methods" do
+      subject { SomethingModelish }
+
+      describe "#top_records" do
+        it "calls counter top_records method" do
+          HitList::Counter.any_instance.should_receive(:top_records).with(3)
+          subject.top_records(3)
+        end
+      end
+    end
+
+    describe "instance methods" do
+      subject { SomethingModelish.new(:the_id) }
+
+      describe "#total_hits" do
+        it "calls counter total_hits method with model id" do
+          HitList::Counter.any_instance.should_receive(:total_hits).with(:the_id)
+          subject.total_hits
+        end
+      end
+
+      describe "#increment_hit_counter!" do
+        it "calls counter hit! method with record id" do
+          HitList::Counter.any_instance.should_receive(:hit!).with(:the_id)
+          subject.increment_hit_counter!
+        end
+      end
+
+      describe "#increment_only_total_hits!" do
+        it "calls counter hit! method with record id" do
+          HitList::Counter.any_instance.should_receive(:increment_total_hits!).with(:the_id)
+          subject.increment_only_total_hits!
+        end
+      end
+
+      describe "#increment_only_rank!" do
+        it "calls counter hit! method with record id" do
+          HitList::Counter.any_instance.should_receive(:increment_rank!).with(:the_id)
+          subject.increment_only_rank!
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require "fakeredis"
+require 'timecop'
+require 'hit_list'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: hit_list
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Krists Ozols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+    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: timecop
+  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: fakeredis
+  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'
+description: Very simple and fast hit and popularity counter using Redis sorted sets.
+email:
+- krists.ozols@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hit_list.gemspec
+- lib/hit_list.rb
+- lib/hit_list/counter.rb
+- lib/hit_list/rails_model_extension.rb
+- lib/hit_list/version.rb
+- spec/counter_end_to_end_spec.rb
+- spec/counter_spec.rb
+- spec/rails_model_extension_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/krists/hit_list
+licenses:
+- MIT
+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.6.10
+signing_key: 
+specification_version: 4
+summary: It solves problem where you need to know most popular article or project
+  in last X days.
+test_files:
+- spec/counter_end_to_end_spec.rb
+- spec/counter_spec.rb
+- spec/rails_model_extension_spec.rb
+- spec/spec_helper.rb