fatboy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14480b9fa576ac0e81318733af2789f82f5caaa8
+  data.tar.gz: 987e8724d2cd01bfad21a66853cf3f53803cd0a6
+SHA512:
+  metadata.gz: 78061dc924ed74f6205bfb8715eb3c7edcbf91eb14b2c2c8066e01137396b0bcca307a46d5058e4118c5eb7f5e2cffa51760b869da8195b856371101fbcab939
+  data.tar.gz: 48a20e5e25c67f52e6a0e0631beab08abe409cd512e32e0fc9d995b1948e05ed9fe9de9d5decdfbb800347dfda444b6e4fc171f5a65ef5fcd3a89f4cc2f274b0

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Anthony Super
+
+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,97 @@
+# Fatboy
+##### See views, right here, right now
+Fatboy is a gem which manages view counts on ActiveRecord objects (or things that quack like them).
+It's great for seeing the most (and least) viewed models on your website.
+To make things even better, Fatboy will store view counts by day, month, year,
+and all-time.
+
+It doesn't touch your SQL database. 
+Fatboy stays slim in Redis.
+
+NOTE: This is currenlty not production-ready. 
+It will be soon, though.
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fatboy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fatboy
+
+## Usage
+
+Fatboy is easy to set up. First, initialize it:
+
+```ruby
+  # if you don't provide your own redis, fatoby will create one 
+  # with Redis.new
+  fatboy = Fatboy.new(redis: redis)
+```
+
+Then, just tell it what your users look at.
+
+```ruby
+  # As long as the variable you're passing in responds to
+  # .id, this will work
+  fatboy.view(image)
+  # You can also use the shorthand method:
+  # fatboy[image]
+```
+
+Now, managing views is pretty useless if you can't retrieve them later.
+Thankfully, fatboy makes this easy as well:
+
+```ruby
+  fatboy.views_for(image) # => 1
+```
+
+Don't worry if that's a brand-new Fatboy instance---as long as the Redis is the same, Fatboy's view count will be the same.
+
+#### Getting Top Viewed
+
+Fatboy makes it easy to retrieve a list of the most-popular records in your database.
+Check it now now:
+```ruby
+  fatboy.popular(Image).today.most # => most viewed image today
+  fatboy.popular("Image").all_time.most # => Top viewed image of all time
+```
+
+Want it from other days?
+
+```ruby
+  # most popular image a month ago
+  fatboy.popular(Image).day(Time.now << 1).most
+  # Or with active support
+  fatboy.popular(Image).day(1.months.ago).most
+```
+Don't want just the most popular?
+Maybe you'd like the least popular?
+
+```ruby
+  fatboy.popular(Image).day(Time.now).least
+  fatboy.popular(Image).month(Time.now).least
+```
+
+Or perhaps a range?
+
+```ruby
+  fatboy.popular(Image).this_month.range(10..20)
+  # or, a range for a while ago
+  fatboy.popular(Image).month(3.months.ago).range(10..20)
+```
+
+Fatboy makes it easier. See the rdoc for details. 
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fatboy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write functionality and tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/fatboy.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fatboy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fatboy"
+  spec.version       = Fatboy::VERSION
+  spec.authors       = ["Anthony Super"]
+  spec.email         = ["anthony@noided.media"]
+  spec.summary       = %q{Fatboy keeps track of your models's views, right here, right now.}
+  spec.description = %q{
+  Fatboy is a gem designed to easily keep track of views.
+  It doesn't touch your SQL, and stays slim in redis.
+  It also makes it easy to query based on how viewed something is.
+  }
+  spec.homepage      = "http://github.com/AnthonySuper/fatboy"
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "mock_redis"
+  spec.add_development_dependency "simplecov"
+  spec.add_runtime_dependency "redis"
+  spec.required_ruby_version = ">= 2.0"
+
+end

data/lib/fatboy/helpers.rb

@@ -0,0 +1,44 @@
+class Fatboy
+  ##
+  # Common helper functions, which are used across many
+  # classes.
+  module Helpers
+    ##
+    # Given a model_name and the properly formated hour, day, etc. string,
+    # give the name of the key views are stored in
+    def self.format_store(model_name, store_name)
+      "#{model_name}-#{store_name}"
+    end
+    ##
+    # Properly format the time to retrieve or set an hour
+    def self.hour_format(hr)
+      hr.utc.strftime(Fatboy::HOUR_FORMAT_STR)
+    end
+
+    ##
+    # Properly format the time to retrieve or set a day
+    def self.day_format(day)
+      day.utc.strftime(Fatboy::DAY_FORMAT_STR)
+    end
+
+    ##
+    # Properly format the time to retrieve or set a month
+    def self.month_format(mth)
+      mth.utc.strftime(Fatboy::MONTH_FORMAT_STR)
+    end
+
+    ##
+    # Properly format the time to retrieve or set a year
+    def self.year_format(yr)
+      yr.utc.strftime(Fatboy::YEAR_FORMAT_STR)
+    end
+    ##
+    # Get an array of the hour format, the day format, the month format, and 
+    # the year format
+    def self.all_format(time)
+      [:hour_format, :day_format, :month_format, :year_format].map do |func|
+        self.send(func, time)
+      end
+    end
+  end
+end

data/lib/fatboy/popularity.rb

@@ -0,0 +1,70 @@
+require_relative './time_based_popularity'
+class Fatboy
+  ##
+  # This class is used to query how popular something is. 
+  class Popularity
+    ##
+    # We always pass in a redis
+    def initialize(model, redis)
+      @redis = redis
+      @model_name  = model.to_s
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for a specific hour in time.
+    # Arguments:
+    #  * +time+: a DateTime or Time containing the hour in time you wish to query
+    def hour(time)
+      fmt_tim = Fatboy::Helpers.hour_format(time.utc)
+      store_name = Fatboy::Helpers.format_store(@model_name, fmt_tim)
+      Fatboy::TimeBasedPopularity.new(@redis, store_name)
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for a specific day in time.
+    # Arguments:
+    #  * +time+: A Datetime or Time in the day you wish to query.
+    def day(time)
+      fmt_time = Fatboy::Helpers.day_format(time.utc)
+      store_name = Fatboy::Helpers.format_store(@model_name, fmt_time)
+      
+      Fatboy::TimeBasedPopularity.new(@redis, store_name)
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for a specific month in time.
+    # Arguments:
+    #  * +time+: A time within the month you wish to query.
+    def month(time)
+      fmt_time = Fatboy::Helpers.month_format(time.utc)
+      store_name = Fatboy::Helpers.format_store(@model_name, fmt_time)
+      Fatboy::TimeBasedPopularity.new(@redis, store_name)
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for a specific year in time.
+    # Arguments:
+    #  * +time+: A DateTime or Time in the year you wish to query.
+    def year(time)
+      fmt_time = Fatboy::Helpers.year_format(time.utc)
+      store_name = Fatboy::Helpers.format_store(@model_name, fmt_time)
+      Fatboy::TimeBasedPopularity.new(@redis, store_name)
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for this hour.
+    def this_hour
+      hour(Time.now)
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for this day.
+    def today
+      day(Time.now)
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for this month.
+    def this_month
+      month(Time.now)
+    end
+    ##
+    # Get a Fatboy::TimeBasedPopularity for this year. 
+    def this_year
+      year(Time.now)
+    end
+  end
+end

data/lib/fatboy/time_based_popularity.rb

@@ -0,0 +1,63 @@
+require_relative './viewed_item'
+class Fatboy
+  ##
+  # TimeBasedPopularity measures the popularity based on a set period of time.
+  # You should probably never initialize this yourself.
+  class TimeBasedPopularity
+    ##
+    # What redis to look in, and what sorted set we're using.
+    # Probably don't ever initialize this yourself.
+    def initialize(redis, store)
+      @redis = redis
+      @store = store
+    end
+    ##
+    # Get an enumerator of all viewed items, as a Fatboy::ViewedItem, in 
+    # rank order.
+    # Pretty useful for lazy operations and such.
+    def enumerator
+      Enumerator.new(size) do |yielder|
+        range(0..(size-1)).each{|x| yielder.yield x}
+      end
+    end
+    ##
+    # Get the most viewed item. 
+    # Returns a Fatboy::ViewedItem
+    def most
+      range(0..1).first
+    end
+    ##
+    # Get the least viewed item.
+    # Returns a Fatboy::ViewedItem
+    def least
+      range(-1..-2).first
+    end
+
+    ##
+    # Get the total number of items viewed.
+    def size
+      @redis.zcard(@store)
+    end
+
+    ##
+    # Specify a range of ranks, and gets them.
+    # Returns an array of Fatboy::ViewedItem
+    def range(rng)
+      start = rng.first
+      stop = rng.last
+      ##
+      # Build up a list of pairs: [id, score]
+      pairs = @redis.zrevrange(@store, start, stop, withscores: true)
+      ##
+      # Get rid of nils, zip up list with range of rank
+      triplets = pairs.reject{|p| !p}.zip(start..stop)
+      # After the zip, we have [[[id, score], rank], [[id, score], rank]]
+      # So we flatten out the inner arrays, giving us
+      # [[id, score, rank], [id, score, rank]]
+      triplets.map!(&:flatten)
+      ##
+      # Use the array splat to more easily pass in the 3 arguments
+      triplets.map{|trip| Fatboy::ViewedItem.new(*trip)}
+    end
+  end
+end

data/lib/fatboy/version.rb

@@ -0,0 +1,5 @@
+class Fatboy
+  ##
+  # Gem version of Fatboy
+  VERSION = "0.0.1"
+end

data/lib/fatboy/viewed_item.rb

@@ -0,0 +1,28 @@
+class Fatboy
+  ##
+  # The viewed item class provides a (very) simple interface for interacting
+  # with views on Models.
+  # Almost always obtained from a TimeBasedPopularity, this struct simply
+  # shows the id of the model, the number of views, and the rank.
+  # NOTE: The highest-ranked item has rank 0. Ranks are 0-indexed.
+  class ViewedItem
+    def initialize(id, views, rank)
+      @id = id.to_i
+      @views = views.to_i
+      @rank = rank.to_i
+    end
+    ##
+    # Id of the model contained this this ViewedItem
+    attr_reader :id
+    ##
+    # Amount this ViewedItem has been viewed in a time period.
+    # This time period was pre-set on construction.
+    attr_reader :views
+    ##
+    # The rank, 0 being the most viewed, of this item.
+    # The time period was pre-set on construction, typically from a
+    # Fatboy::TimeBasedView
+    attr_reader :rank
+  end
+end
+

data/lib/fatboy.rb

@@ -0,0 +1,56 @@
+require "fatboy/version"
+require 'redis'
+require_relative './fatboy/popularity'
+require_relative './fatboy/helpers'
+##
+# Fatboy is the main class for interacting with the system.
+# It provides a variety of functionality. 
+class Fatboy
+  ##
+  # Create a new Fatboy.
+  # Options:
+  #  * +redis:+ : The redis to store views in. By default, Redis.new
+  def initialize(redis: Redis.new)
+    @redis = redis
+  end
+  ##
+  # Say that you have viewed an object, making the proper records for
+  # hour, day, month, and year.
+  # * +model+ - a model of some sort. Should quack like an ActiveRecord model (that is, responding to .id)
+  def view(obj)
+    throw ArgumentError.new("That doesn't quack like a model!") unless obj.respond_to?(:id)
+    stores = Fatboy::Helpers.all_format(Time.now).map do |time|
+      Fatboy::Helpers.format_store(obj.class.to_s, time)
+    end
+    stores.map{|store| inc_member(store, obj.id)}
+  end
+  ##
+  # let users view with a shorthand
+  alias :[] view
+  ##
+  # This method returns a Fatboy::Popularity, the main interface for 
+  # determining the popularity of your models. 
+  # Example:
+  #   fatboy.popular(Image)
+  #   fatboy.popular("Image")
+  #   fatboy.popular(model.class)
+  def popular(model)
+    Popularity.new(model, @redis)
+  end
+  ##
+  # Format string we use to store the views per hour 
+  HOUR_FORMAT_STR = "%Y%m%d%H"
+  ##
+  # Format string we use to store the views per day
+  DAY_FORMAT_STR = "%Y%m%d"
+  ##
+  # Format string we use to store the views per month
+  MONTH_FORMAT_STR = "%Y%m"
+  ##
+  # Format string we use to store the views per year
+  YEAR_FORMAT_STR = "%Y"
+  private
+  def inc_member(store, id)
+    @redis.zincrby(store, 1, id)
+  end
+end

data/spec/fatboy_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+RSpec.describe Fatboy do
+  it "can be initialized" do
+    expect{Fatboy.new}.to_not raise_error
+  end
+  let(:redis){MockRedis.new}
+  let(:f){Fatboy.new(redis: redis)}
+  describe "storage" do
+    before(:each){Timecop.freeze(Date.today)}
+    after(:each){Timecop.return}
+    it "ads to the redis" do
+      l = Fatboy::Helpers.day_format(Time.now)
+      l = Fatboy::Helpers.format_store("Model", l)
+      expect{
+        f.view(Model.new(10))
+      }.to change{redis.zcount(l, -100, 100)}.from(0).to(1)
+      f.view(Model.new(11))
+      expect(redis.zscore(l, 11)).to eq(1)
+    end
+
+  end
+  describe "ordering" do
+
+    before(:each){Timecop.freeze(Date.today)}
+    after(:each){Timecop.return}
+    it "orders views by day" do
+      2.times{f.view(Model.new(10))}
+      1.times{f.view(Model.new(11))}
+      expect(f.popular(Model).today.most.id).to eq(10)
+    end
+    it "orders views by month" do
+      2.times{f.view(Model.new(10))}
+      1.times{f.view(Model.new(11))}
+      expect(f.popular(Model).this_month.most.id).to eq(10)
+    end
+    it "orders views by year" do
+      2.times{f.view(Model.new(10))}
+      1.times{f.view(Model.new(11))}
+      expect(f.popular(Model).this_year.most.id).to eq(10)
+    end
+  end
+  describe "popularity finding" do
+    it "doesn't throw an error" do
+      expect{f.popular(Model)}.to_not raise_error
+    end
+    it "returns a popularity" do
+      expect(f.popular(Model)).to be_instance_of(Fatboy::Popularity)
+    end
+  end
+end

data/spec/mocks/model.rb

@@ -0,0 +1,8 @@
+##
+# Insanely simple mock model class.
+class Model
+  def initialize(id)
+    @id = id
+  end
+  attr_accessor :id
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.setup
+require 'simplecov'
+SimpleCov.start
+require 'fatboy'
+require_relative './mocks/model.rb'
+require 'timecop'
+require 'mock_redis'
+
+RSpec.configure do |config|
+  # Don't need to actually do anything
+end
+

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: fatboy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anthony Super
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: mock_redis
+  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: simplecov
+  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: 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'
+description: "\n  Fatboy is a gem designed to easily keep track of views.\n  It doesn't
+  touch your SQL, and stays slim in redis.\n  It also makes it easy to query based
+  on how viewed something is.\n  "
+email:
+- anthony@noided.media
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fatboy.gemspec
+- lib/fatboy.rb
+- lib/fatboy/helpers.rb
+- lib/fatboy/popularity.rb
+- lib/fatboy/time_based_popularity.rb
+- lib/fatboy/version.rb
+- lib/fatboy/viewed_item.rb
+- spec/fatboy_spec.rb
+- spec/mocks/model.rb
+- spec/spec_helper.rb
+homepage: http://github.com/AnthonySuper/fatboy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.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: Fatboy keeps track of your models's views, right here, right now.
+test_files:
+- spec/fatboy_spec.rb
+- spec/mocks/model.rb
+- spec/spec_helper.rb
+has_rdoc: