popularity_contest 0.0.6

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kasper Grubbe
+
+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,56 @@
+# PopularityContest
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'popularity_contest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install popularity_contest
+
+## Usage
+
+Add this rack application to your Rails routes:
+
+```ruby
+require 'popularity_contest/web'
+mount PopularityContest::Web, :at => "popularity"
+```
+
+You can now reach it from `HOSTNAME/popularity`.
+
+To use in your views you have a helper here:
+
+```ruby
+<%= popular_count_hit_path('event', 1337) %>
+# /popularity/event/1337
+```
+
+Or if you have jQuery available you can use this:
+
+```ruby
+<%= popular_count_hit_jquery('event', 1337) %>
+# <script>
+# (function(window, document, $, undefined) {
+#  $.ajax({
+#    url: '/popularity/event/1337',
+#    dataType: 'html',
+#    cache: false
+#  })
+# }(window, document, jQuery));
+# </script>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature 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 new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/popularity_contest/railtie.rb

@@ -0,0 +1,9 @@
+require 'popularity_contest/view_helpers'
+
+module PopularityContest
+  class Railtie < Rails::Railtie
+    initializer "popularity_contest.view_helpers" do |app|
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/popularity_contest/view_helpers.rb

@@ -0,0 +1,75 @@
+module PopularityContest
+  module ViewHelpers
+    def popular_count_hit_path(content_type, content_id)
+      begin
+        build_path(content_type, content_id)
+      rescue
+        "<!-- error occurred in PopularityContest :| -->"
+      end
+    end
+
+    def popular_count_hit_jquery(content_type, content_id)
+      begin
+        url = build_path(content_type, content_id)
+        <<-SJS
+<script>
+(function(window, document, $, undefined) {
+  $.ajax({
+    url: '#{url}',
+    dataType: 'html',
+    cache: false
+  })
+}(window, document, jQuery));
+</script>
+        SJS
+      rescue
+        "<!-- error occurred in PopularityContest :| -->"
+      end
+    end
+
+    def popular_content(content_type, limit=10, date=Date.today.strftime("%y-%m-%d"))
+      begin
+        PopularityContest::most_popular(content_type, redis_connection, limit)
+      rescue
+        []
+      end
+    end
+
+    def all_popular_content(content_type)
+      begin
+        PopularityContest::all_popular(content_type, redis_connection)
+      rescue
+        []
+      end
+    end
+
+   private
+    def build_path(content_type, content_id)
+      content_type = content_type.to_s.downcase
+      uri = []
+      uri << "#{Rails.application.routes.url_helpers.popularity_contest_web_path}"
+      uri << "#{content_type}"
+      uri << "#{content_id}"
+
+      strip_locale_uri(uri.join("/"))
+    end
+    # Because Billetto have locales in URLs like billetto.dk/da and billetto.dk/en
+    # and the paths returned from Rails will include those, and this route:
+    #   mount PopularityContest::Web, :at => "hit"
+    # will only bind on: billetto.dk/hit/our/app
+    # and not:           billetto.dk/en/hit/our/app
+    def strip_locale_uri(path)
+      path.to_s.gsub(/\/(en|da|no|sv)/i, "")
+    end
+
+    def redis_connection
+      if $redis.present?
+        redis = $redis
+      elsif @redis.present?
+        redis = @redis
+      else
+        raise 'Unable to find a usable redis instance'
+      end
+    end
+  end
+end

data/lib/popularity_contest/web.rb

@@ -0,0 +1,97 @@
+require 'sinatra'
+require "sinatra/reloader"
+require "sinatra/json"
+
+module PopularityContest
+  class Web < Sinatra::Base
+    helpers Sinatra::JSON
+
+    class BadRequest < StandardError; end
+
+    configure :development do
+      register Sinatra::Reloader # reload code when we develop
+
+      # For easier local development (act as production):
+      # set :raise_errors, false
+      # set :show_exceptions, false
+      # set :dump_errors, false
+    end
+
+    def initialize(app = nil)
+      super
+      @app = app
+      @redis = $redis
+
+      if @redis
+        puts "PopularityContest: Running in #{Sinatra::Base.environment} environment"
+      else
+        puts "=> Statistics Redis connection failure"
+      end
+    end
+
+    # For testing what is in the DB
+    # get '/pretty/:type' do
+    #   PopularityContest::most_popular(params[:type], @redis, 10).to_json
+    # end
+
+    # For testing populating the keys
+    # get '/test' do
+    #   100.times do |event_id|
+    #     Random.rand(1...1000).times do |hits|
+    #       incr_key('event', event_id)
+    #     end
+    #   end
+    # end
+
+    # For incrementing a key:
+    get '/:type/:id' do
+      content_id = params[:id].to_i
+      if(content_id != 0) # check if ID is present as an integer
+        content_type :json
+        incr_key(params[:type], content_id)
+        {:content => "#{params[:type]}##{content_id}", :key => PopularityContest::key(params[:type], content_id)}.to_json
+      else
+        raise BadRequest, "invalid input format"
+      end
+    end
+
+    options '/:type/:id' do
+      headers cors_headers_list
+      halt
+    end
+
+    private
+    # Redis-helpers
+    def incr_key(content_type, content_id)
+      @redis.multi do
+        key = PopularityContest::key(content_type, content_id)
+        puts "PopularityContest: Incrementing key='#{key}'" if Sinatra::Base.development?
+        @redis.incr(key)
+        @redis.expire(key, 48*60*60) # each time we increment we expire 48 hours out in the future
+      end
+    end
+
+    # Error-handling
+    def error(statuscode, message)
+      content_type :json
+      status statuscode.to_i # or whatever
+
+      logger.info "#{statuscode} - #{message}"
+
+      {:error => message}.to_json
+    end
+
+    def cors_headers_list
+     {
+       'Access-Control-Allow-Origin' => '*',
+       'Access-Control-Allow-Methods' => %w(GET OPTIONS).join(', '),
+       'Access-Control-Allow-Headers' => %w{Origin Accept Content-Type X-Requested-With X-CSRF-Token}.join(', '),
+     }
+    end
+
+    error BadRequest do
+      e = env['sinatra.error']
+      error(500, e.message)
+    end
+  end
+end

data/lib/popularity_contest.rb

@@ -0,0 +1,53 @@
+module PopularityContest
+  NAME = "PopularityContest"
+  LICENSE = 'See LICENSE for licensing details.'
+
+ private
+  # helpers
+  def self.key(content_type, content_id, date = Date.today.strftime("%y-%m-%d"))
+    key = []
+    key << "popular"
+    key << "type:#{content_type}"
+    key << "id:#{content_id}"
+    key << "date:#{date}"
+    key << "hits"
+    key.join(":")
+  end
+
+  def self.content_id_from_key(key)
+    # 'popular:type:#{content_type}:id:12456:date:#{Date.today.strftime("%y-%m-%d")}:count'.scan(/id:(\d+)/i).flatten.first
+    key.scan(/id:(\d+)/i).flatten.first.to_i
+  end
+
+  def self.most_popular(content_type, redis_connection, limit=10)
+      limit = 10 if limit.nil? || !limit.is_a?(Integer) # make sure limit is right, else default
+      all_popular(content_type, redis_connection).take(limit)
+  end
+
+  def self.all_popular(content_type, redis_connection)
+    keys = redis_connection.keys(PopularityContest::key(content_type, '*'))
+
+    hits = redis_connection.pipelined do
+      keys.each do |key|
+        redis_connection.mget(key)
+      end
+    end.flatten.collect{|hit| hit.to_i }
+    # each of these hits is an array, flatten that
+    # and convert the hits to integer
+    # unfortunately Redis doesn't support the integer datatype as default
+
+    # get all the content_ids
+    # TODO: Do this after sorting
+    content_ids = keys.collect{|key| PopularityContest::content_id_from_key(key) }
+
+
+    # merge the three arrays: [keys, hits, content_ids]
+    # [ "popular:type:event:id:66:date:13-04-18:count",
+    #   "2",
+    #   1337 ]
+    # and sort them highest to lowest
+    [keys, hits, content_ids].transpose.sort! { |x,y| y[1].to_i <=> x[1].to_i }
+  end
+end
+
+require 'popularity_contest/railtie' if defined?(::Rails::Engine)

data/popularity_contest.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "popularity_contest"
+  spec.version       = "0.0.6"
+  spec.authors       = ["Kasper Grubbe"]
+  spec.email         = ["kawsper@gmail.com"]
+  spec.description   = "A Rack application to count and sort popular content on our websites"
+  spec.summary       = "Count and sort popular content on our site"
+  spec.homepage      = ""
+  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", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mock_redis"
+
+  spec.add_dependency "sinatra"
+  spec.add_dependency "sinatra-contrib"
+  spec.add_dependency "redis"
+end

data/spec/popularity_contest/web.rb

@@ -0,0 +1,23 @@
+require 'rack/test'
+
+require File.expand_path '../../../lib/popularity_contest/web.rb', __FILE__
+
+ENV['RACK_ENV'] = 'test'
+
+module RSpecMixin
+  include Rack::Test::Methods
+  def app() ::PopularityContest::Web end
+end
+
+RSpec.configure { |c| c.include RSpecMixin }
+
+describe PopularityContest::Web do
+  it "handles cors options query" do
+    options '/event/123'
+    expect(last_response).to be_ok
+    expect(last_response.headers['Access-Control-Allow-Origin']).to eq('*')
+    expect(last_response.headers['Access-Control-Allow-Methods']).to eq('GET, OPTIONS')
+    expect(last_response.headers['Access-Control-Allow-Headers']).to eq('Origin, Accept, Content-Type, X-Requested-With, X-CSRF-Token')
+  end
+end
+

data/spec/popularity_contest_spec.rb

@@ -0,0 +1,51 @@
+require 'popularity_contest'
+require 'mock_redis'
+require 'date'
+
+describe PopularityContest do
+  before :each do
+    @redis = MockRedis.new
+  end
+
+  describe "#all_popular" do
+    it "should return all popular" do
+      (0..9).each do |index|
+        add_event_with_id(index)
+      end
+
+      result = PopularityContest::all_popular("event", @redis)
+      expect(result.size).to eq 10
+
+      mapped_ids = result.map{|x| x[2]}
+      (0..9).each do |index|
+        expect(mapped_ids).to include(index)
+      end
+    end
+  end
+
+  describe "#most_popular" do
+    it "should return 10 items by default" do
+      (0..20).each do |index|
+        add_event_with_id(index)
+      end
+
+      result = PopularityContest::most_popular("event", @redis)
+      expect(result.size).to eq 10
+    end
+
+    it "should return limited count of items when it is passed" do
+      (0..20).each do |index|
+        add_event_with_id(index)
+      end
+
+      result = PopularityContest::most_popular("event", @redis, 5)
+      expect(result.size).to eq 5
+    end
+  end
+
+  private
+    def add_event_with_id(id)
+      key = PopularityContest::key("event", id)
+      @redis.incr(key)
+    end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: popularity_contest
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Kasper Grubbe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rack application to count and sort popular content on our websites
+email:
+- kawsper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/popularity_contest.rb
+- lib/popularity_contest/railtie.rb
+- lib/popularity_contest/view_helpers.rb
+- lib/popularity_contest/web.rb
+- popularity_contest.gemspec
+- spec/popularity_contest/web.rb
+- spec/popularity_contest_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Count and sort popular content on our site
+test_files:
+- spec/popularity_contest/web.rb
+- spec/popularity_contest_spec.rb