popular_stream 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6df6ce9f9726447977830802fe8a7e6f15cb8c00
+  data.tar.gz: 72253cc504abd85e4893ce25ac9d1310c3b5ddc3
+SHA512:
+  metadata.gz: 3952dc948f1bef9002534db2d36891ad893e05ad5b790d49b6ab27b08e2cb90a217f8c09310c553f057617a99456f00dca7250d39946fd3c6de3ec410baf2b60
+  data.tar.gz: 5e7cdca746f55e2922ecdaec2ee25e06b1120562bf78222a86983c3c3f0e77221f9b2cce34226f051de3b42b952af032ddd35bba8c22458488032da9dadc01bc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicolás Hock Isaza
+
+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,86 @@
+# Popular Stream
+
+# THIS IS NOT READY YET!
+
+Simple popular content tracker with a Redis backend.
+
+Mostly taken from the "Popular Stream" code
+[here](http://stdout.heyzap.com/2013/04/08/surfacing-interesting-content/) but
+bundled up as a gem.
+
+PopularStream tracks an "event" on a group of "fields" and returns the ones that
+are currently popular.
+
+For example, if you want to track the most popular tags right now you, the event
+would be "tagging" and the field would be the tag name ("rubygems" for example).
+
+The way this works is that "old" votes will count less than newer votes, that way
+a tag that was used 20 times today will be more popular than a tag used 30 times
+last week.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'popular_stream'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install popular_stream
+
+## Usage
+
+There are two main methods `vote` and `get`. `vote` adds an event to the list
+and `get` gets the most popular fields on the distribution.
+
+```ruby
+stream = PopularStream.new("popular_tags")
+
+stream.vote(field: 'rubygems')
+
+# You can also add an optional `weight` param.
+stream.vote(field: 'ruby', weight: 2)
+
+# And you can even specify when the event happened.
+# Notice that time is a number, meaning seconds since Epoc.
+time = Date.yesterday.to_time
+stream.vote(field: 'rubygems', time: time.to_i)
+
+stream.get # => ['rubygems', 'ruby']
+
+# You can pass `limit` and `offset`
+stream.get(limit: 1, offset: 1) # => ['ruby']
+stream.get(offset: 10) # => []
+```
+
+## Seting up & Configuring Redis
+
+Popular Stream uses Redis as the storage database. By default it will connect to
+the redis client on `ENV['REDIS_URL']`. You can also specify what redis client to
+use with `PopularStream.redis = Redis.new(host: 'example.com')`.
+
+Notice that this is for *all* streams. This is because we don't want to create new
+connections for every new stream instance we create, so the same client is used.
+
+## TODO
+
+* Sinatra application. I want to bundle an optional Sinatra application that
+makes this gem super simple to setup as a service.
+
+* Multiple storage databases. Right now everything's stored on Redis but it should
+be simple to use more stuff. People should be able to create "adapters" and use
+them as needed.
+
+## Contributing
+
+1. Fork it ( https://github.com/nhocki/popular_stream/fork )
+2. Create your a new branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/popular_stream/version.rb

@@ -0,0 +1,3 @@
+class PopularStream
+  VERSION = "1.0.0"
+end

data/lib/popular_stream.rb

@@ -0,0 +1,56 @@
+require "popular_stream/version"
+
+# Most of this was taken from:
+# http://stdout.heyzap.com/2013/04/08/surfacing-interesting-content/
+class PopularStream
+  attr_reader :name, :epoch, :max_items
+
+  # 2.5 * half_life (in days) years from now. Make this far in the future!
+  DEFAULT_EPOC = Date.new(2017, 5, 29).to_time.to_i
+  DAY = 60 * 60 * 24
+  HALF_LIFE = 1 * DAY
+
+  class << self
+    attr_accessor :redis
+
+    def redis
+      @redis ||= Redis.new(url: ENV['REDIS_URL'])
+    end
+  end
+
+  def initialize(name, **options)
+    @name      = name
+    @epoch     = options.fetch(:epoch)     { DEFAULT_EPOC }
+    @max_items = options.fetch(:max_items) { 10_000 }
+  end
+
+  def vote(field:, time: Time.now.to_i, weight: 1)
+    time = time.to_i if time.respond_to?(:to_i)
+
+    delta = 2 ** ((time - epoch) / HALF_LIFE)
+    redis.zincrby(name, weight * delta.to_f, field)
+    trim
+  end
+
+  def get(limit: 20, offset: 0)
+    redis.zrevrange(name, offset, offset + limit - 1)
+  end
+
+  def clear!
+    redis.del(name)
+  end
+
+  def count
+    redis.zcard(name)
+  end
+
+  def trim
+    redis.zremrangebyrank(name, 0, -max_items)
+  end
+
+  private
+
+  def redis
+    self.class.redis
+  end
+end

data/popular_stream.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'popular_stream/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "popular_stream"
+  spec.version       = PopularStream::VERSION
+  spec.authors       = ["Nicolás Hock Isaza"]
+  spec.email         = ["nhocki@gmail.com"]
+  spec.summary       = %q{Ruby gem to track popular streams with a redis backend.}
+  spec.description   = %q{Ruby gem to track popular streams with a redis backend.}
+  spec.homepage      = "https://github.com/nhocki/popular_streams"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "timecop", "~> 0.7.1"
+  spec.add_development_dependency "fakeredis", "~> 0.5.0"
+
+  spec.add_dependency "redis", "~> 3.1.0"
+end

data/spec/lib/popular_stream_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+RSpec.describe PopularStream do
+  let(:one_week) { 60 * 60 * 24 * 7 } # 1 week in seconds.
+  let(:stream) { PopularStream.new("popular_stream") }
+
+  describe ".redis" do
+    let(:redis) { double }
+
+    it "is possible to set a redis instace" do
+      expect { PopularStream.redis = redis }.not_to raise_error
+    end
+  end
+
+  describe "#get" do
+    before do
+      stream.vote(field: '1', time: Time.now - one_week)
+      stream.vote(field: '2')
+    end
+
+    it "ranks older votes lower than newer votes" do
+      expect(stream.get).to eql(['2', '1'])
+    end
+
+    it "#get takes limit & offset arguments" do
+      expect(stream.get(limit: 1)).to eql(['2'])
+      expect(stream.get(offset: 1)).to eql(['1'])
+    end
+
+    it "paginates" do
+      stream.vote(field: '3', time: Time.now + one_week)
+      expect(stream.get(limit: 1, offset: 0)).to eql([ '3' ])
+      expect(stream.get(limit: 1, offset: 1)).to eql([ '2' ])
+      expect(stream.get(limit: 1, offset: 2)).to eql([ '1' ])
+    end
+  end
+
+  it "ranks most popular for same time as higher" do
+    Timecop.freeze do
+      stream.vote(field: '1')
+      stream.vote(field: '1')
+      stream.vote(field: '2')
+      expect(stream.get).to eql(['1', '2'])
+    end
+  end
+
+  it "accepts a weight for the vote of a specific field" do
+    Timecop.freeze do
+      stream.vote(field: '1')
+      stream.vote(field: '1')
+      stream.vote(field: '2', weight: 3)
+      expect(stream.get).to eql(['2', '1'])
+    end
+  end
+
+  it "keeps old votes with lower weight on values" do
+    Timecop.freeze do
+      stream.vote(field: '1', time: Time.now - 2 * one_week)
+      stream.vote(field: '2', time: Time.now - 3 * one_week)
+
+      stream.vote(field: '1')
+      stream.vote(field: '2')
+    end
+    expect(stream.get).to eql(['1', '2'])
+  end
+
+  it "#count gets the number of elements and #clear! removes them all" do
+    stream.vote(field: '1')
+    stream.vote(field: '1')
+    expect(stream.count).to eql(1)
+    stream.clear!
+    expect(stream.count).to eql(0)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'popular_stream'
+require 'fakeredis/rspec'
+
+Bundler.require(:default, :test, :development)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: popular_stream
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nicolás Hock Isaza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Ruby gem to track popular streams with a redis backend.
+email:
+- nhocki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/popular_stream.rb
+- lib/popular_stream/version.rb
+- popular_stream.gemspec
+- spec/lib/popular_stream_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nhocki/popular_streams
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem to track popular streams with a redis backend.
+test_files:
+- spec/lib/popular_stream_spec.rb
+- spec/spec_helper.rb