recommendations2 0.0.4

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Victor Rodrigues
+
+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,29 @@
+# Recommendations
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'recommendations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install recommendations
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/recommendations/configuration.rb

@@ -0,0 +1,23 @@
+module Recommendations
+  class Configuration
+    attr_accessor :redis
+    attr_writer :similar_items_count, :item_tolerance
+    attr_writer :similar_users_count, :user_tolerance
+
+    def similar_items_count
+      @similar_items_count || 10
+    end
+
+    def similar_users_count
+      @similar_items_count || 10
+    end
+
+    def item_tolerance
+      @item_tolerance || 30
+    end
+
+    def user_tolerance
+      @user_tolerance || 1
+    end
+  end
+end

data/lib/recommendations/item/ratings.rb

@@ -0,0 +1,9 @@
+module Recommendations
+  class Item
+    module Ratings
+      def ratings(rating, tolerance = Recommendations.configuration.user_tolerance)
+        Recommendations.redis.zrevrangebyscore("recommendations:ratings:item:#{id}", Float(rating) + tolerance, Float(rating) - tolerance)
+      end
+    end
+  end
+end

data/lib/recommendations/item/similarity.rb

@@ -0,0 +1,22 @@
+module Recommendations
+  class Item
+    module Similarity
+      def similars(count = Recommendations.configuration.similar_users_count)
+        Recommendations.redis.zrange("recommendations:similars:item:#{id}", 0, count - 1)
+      end
+
+      def update_similars
+        Recommendations.redis.del("recommendations:similars:item:#{id}")
+
+        categories.each do |category, score|
+          items = Recommendations.redis.hgetall("recommendations:categories:#{category}")
+
+          items.reject {|k, v| k == id}.each do |item, item_score|
+            difference = (Float(item_score) - Float(score)).abs
+            Recommendations.redis.zincrby("recommendations:similars:item:#{id}", difference, item)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/recommendations/item.rb

@@ -0,0 +1,30 @@
+module Recommendations
+  class Item
+    include Item::Ratings
+    include Item::Similarity
+
+    attr_accessor :id
+    attr_writer :categories
+
+    def initialize(id, categories = {})
+      @id, @categories = id, categories
+    end
+
+    def categories
+      @categories || {}
+    end
+
+    def save!
+      Recommendations.redis.hmset("recommendations:item:#{id}", *categories.flatten)
+
+      categories.each do |category, score|
+        Recommendations.redis.hset("recommendations:categories:#{category}", id, score)
+      end
+    end
+
+    def self.find(id)
+      categories = Recommendations.redis.hgetall("recommendations:item:#{id}")
+      new(id, categories)
+    end
+  end
+end

data/lib/recommendations/user/ratings.rb

@@ -0,0 +1,14 @@
+module Recommendations
+  class User
+    module Ratings
+      def rate(item_id, rating)
+        Recommendations.redis.hset("recommendations:ratings:user:#{id}", item_id, rating)
+        Recommendations.redis.zadd("recommendations:ratings:item:#{item_id}", rating, id)
+      end
+
+      def ratings
+        Recommendations.redis.hgetall("recommendations:ratings:user:#{id}")
+      end
+    end
+  end
+end

data/lib/recommendations/user/similarity.rb

@@ -0,0 +1,38 @@
+module Recommendations
+  class User
+    module Similarity
+      def similars(count = Recommendations.configuration.similar_items_count)
+        Recommendations.redis.zrevrange("recommendations:similars:user:#{id}", 0, count - 1)
+      end
+
+      def update_similars
+        Recommendations.redis.del("recommendations:similars:user:#{id}")
+
+        similar_users = {}
+
+        ratings.each do |item_id, rating|
+          similars = Item.find(item_id).ratings(rating)
+
+          similars.reject {|uid| uid == id}.each do |user_id|
+            user_rating = Recommendations.redis.zscore("recommendations:ratings:item:#{item_id}", user_id)
+            difference = (Float(user_rating) - Float(rating)).abs
+
+            similar_users[user_id] ||= [0,0]
+            similar_users[user_id][0] += difference
+            similar_users[user_id][1] += 1
+          end
+        end
+
+        similar_users.each do |user_id, (difference, common_items)|
+          difference_factor = Float(Recommendations.configuration.user_tolerance) - Float(difference)/Float(common_items)
+          common_items_factor = 0.2 * Float(common_items)
+          similar_users[user_id] = difference_factor + common_items_factor
+        end
+
+        similar_users.each do |user_id, score|
+          Recommendations.redis.zincrby("recommendations:similars:user:#{id}", score, user_id)
+        end
+      end
+    end
+  end
+end

data/lib/recommendations/user/suggestions.rb

@@ -0,0 +1,40 @@
+module Recommendations
+  class User
+    module Suggestions
+      def suggestions
+        Recommendations.redis.hgetall("recommendations:suggestions:user:#{id}")
+                             .select {|key, value| Float(value) > 0}
+      end
+
+      def update_suggestions
+        ratings = self.ratings
+
+        suggestions = ratings.inject({}) do |buffer, (item_id, score)|
+          similars = Item.find(item_id).similars
+          similars.reject! {|i| ratings.key?(i)}
+
+          similars.each do |similar|
+            buffer[similar] ||= 0
+            buffer[similar] += (Float(score) - 3) # 0..5 score => -2..2
+          end
+
+          buffer
+        end
+
+        #
+        self.similars.each do |similar| #similars users
+          #remover os ratings q o usuário já fez
+          similar_ratings = User.new(similar).ratings
+          similar_ratings.reject! {|i| ratings.key?(i.key)}
+
+          similar_ratings.each do |(item_id, score)| #user ratings
+            suggestions[item_id] ||= 0
+            suggestions[item_id] += (Float(score) - 3) # 0..5 score => -2..2
+          end
+        end
+        #
+        Recommendations.redis.hmset("recommendations:suggestions:user:#{id}", *suggestions.flatten)
+      end
+    end
+  end
+end

data/lib/recommendations/user.rb

@@ -0,0 +1,13 @@
+module Recommendations
+  class User
+    include User::Ratings
+    include User::Similarity
+    include User::Suggestions
+
+    attr_accessor :id
+
+    def initialize(id)
+      @id = id
+    end
+  end
+end

data/lib/recommendations/version.rb

@@ -0,0 +1,3 @@
+module Recommendations
+  VERSION = "0.0.4"
+end

data/lib/recommendations.rb

@@ -0,0 +1,29 @@
+require "redis"
+
+require "recommendations/version"
+require "recommendations/configuration"
+require "recommendations/user/ratings"
+require "recommendations/user/similarity"
+require "recommendations/user/suggestions"
+require "recommendations/user"
+require "recommendations/item/ratings"
+require "recommendations/item/similarity"
+require "recommendations/item"
+
+module Recommendations
+  extend self
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure(&block)
+    configuration.instance_eval(&block)
+  end
+
+  def redis
+    @redis ||= begin
+      configuration.redis ? Redis.new(configuration.redis) : Redis.new
+    end
+  end
+end

data/recommendations.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/recommendations/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Victor Rodrigues", "Thiago Ferreira"]
+  gem.email         = ["victorc.rodrigues@gmail.com", "ferreira07@gmail.com"]
+  gem.description   = "recommendations between similar items"
+  gem.summary       = ""
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "recommendations2"
+  gem.require_paths = ["lib"]
+  gem.version       = Recommendations::VERSION
+  gem.add_development_dependency "rspec", "~> 2.10"
+  gem.add_runtime_dependency "redis"
+end

data/spec/recommendations/item/ratings_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Recommendations::Item::Ratings do
+  describe "#ratings" do
+    subject {Recommendations::Item.new("1")}
+
+    let :ratings do
+      {
+        "1" => "5",
+        "2" => "4",
+        "3" => "3",
+        "4" => "4",
+        "5" => "5"
+      }
+    end
+
+    before do
+      ratings.each {|k, v| Recommendations::User.new(k).rate("1", v)}
+    end
+
+    it "returns all ratings" do
+      subject.ratings(5, 1).should == %w(5 1 4 2)
+    end
+  end
+end

data/spec/recommendations/item_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Recommendations::Item do
+  subject {Recommendations::Item.new("1", violent: 100, romantic: 25)}
+
+  describe "#initialize" do
+    its(:id)         {should == "1"}
+    its(:categories) {should == {violent: 100, romantic: 25}}
+  end
+
+  describe "#similars" do
+    context "when count was not specified" do
+      let(:count) {Recommendations.configuration.similar_items_count - 1}
+
+      it "gets sorted set range from similar count configuration" do
+        Recommendations.redis.should_receive(:zrange)
+                             .with("recommendations:similars:item:1", 0, count)
+                             .and_return ["2", "3", "4"]
+        subject.similars.should == ["2", "3", "4"]
+      end
+    end
+
+    context "when count was specified" do
+      it "gets sorted set range until count" do
+        Recommendations.redis.should_receive(:zrange)
+                             .with("recommendations:similars:item:1", 0, 9)
+                             .and_return ["2", "3", "4"]
+        subject.similars(10).should == ["2", "3", "4"]
+      end
+    end
+  end
+end

data/spec/recommendations/user/ratings_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe Recommendations::User::Ratings do
+  subject {Recommendations::User.new("1")}
+
+  describe "#rate" do
+    before {subject.rate("890", 4.5)}
+
+    it "stores a user rating for this item" do
+      Recommendations.redis.hget("recommendations:ratings:user:1", "890").should == "4.5"
+    end
+
+    it "stores an item rating for this user" do
+      Recommendations.redis.zscore("recommendations:ratings:item:890", "1").should == "4.5"
+    end
+  end
+
+  describe "#ratings" do
+    let :ratings do
+      {
+        "1" => "5",
+        "2" => "4",
+        "3" => "3",
+        "4" => "2",
+        "5" => "1"
+      }
+    end
+
+    before do
+      ratings.each {|k, v| subject.rate(k, v)}
+    end
+
+    it "returns all ratings" do
+      subject.ratings.should == ratings
+    end
+  end
+end

data/spec/recommendations/user/similarity_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Recommendations::User::Similarity do
+  describe "#update similarity" do
+    subject {Recommendations::User.new("1")}
+
+    let :ratings do
+      {
+        "1" => {
+          "1" => "5",
+          "2" => "4",
+          "3" => "3",
+          "4" => "2"
+        },
+        "2" => {
+          "1" => "5",
+          "2" => "4",
+          "3" => "2",
+          "4" => "1"
+        },
+        "3" => {
+          "1" => "1",
+          "2" => "2",
+          "3" => "1",
+          "4" => "1"
+        },
+        "4" => {
+          "1" => "4",
+          "2" => "3",
+          "3" => "2",
+          "4" => "1"
+        }
+      }
+    end
+
+    before do
+      ratings.each do |user_id, user_ratings|
+        user = Recommendations::User.new(user_id)
+        user_ratings.each {|item_id, rating| user.rate(item_id, rating)}
+      end
+    end
+
+    it "update similars" do
+      subject.update_similars
+      subject.similars.should == %w(2 4 3)
+    end
+  end
+end

data/spec/recommendations/user/suggestions_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Recommendations::User::Suggestions do
+  describe "#update_suggestions" do
+    subject {Recommendations::User.new("1")}
+
+    before do
+      i1 = Recommendations::Item.new("1", violento: 100, romantico: 0,   acao: 50)
+      i2 = Recommendations::Item.new("2", violento: 50,  romantico: 0,   acao: 50) # 1.50
+      i3 = Recommendations::Item.new("3", violento: 100, romantico: 100, acao: 0)  # 1.150, 2.200
+      i4 = Recommendations::Item.new("4", violento: 70,  romantico: 30,  acao: 20) # 1.90,  2.80
+
+      items = [i1, i2, i3, i4]
+      items.each(&:save!)
+      items.each(&:update_similars)
+
+      subject.rate("1", 5)
+    end
+
+    it "updates suggestions" do
+      subject.update_suggestions
+      subject.suggestions.should == {"2" => "2.0", "4" => "2.0", "3" => "2.0"}
+    end
+  end
+end

data/spec/recommendations/user_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Recommendations::User do
+
+end

data/spec/recommendations_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Recommendations do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "rspec"
+require "recommendations"
+
+RSpec.configure do |config|
+  config.before do
+    Recommendations.redis.flushdb
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: recommendations2
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Victor Rodrigues
+- Thiago Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22145412 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: *22145412
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &22145052 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22145052
+description: recommendations between similar items
+email:
+- victorc.rodrigues@gmail.com
+- ferreira07@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/recommendations.rb
+- lib/recommendations/configuration.rb
+- lib/recommendations/item.rb
+- lib/recommendations/item/ratings.rb
+- lib/recommendations/item/similarity.rb
+- lib/recommendations/user.rb
+- lib/recommendations/user/ratings.rb
+- lib/recommendations/user/similarity.rb
+- lib/recommendations/user/suggestions.rb
+- lib/recommendations/version.rb
+- recommendations.gemspec
+- spec/recommendations/item/ratings_spec.rb
+- spec/recommendations/item_spec.rb
+- spec/recommendations/user/ratings_spec.rb
+- spec/recommendations/user/similarity_spec.rb
+- spec/recommendations/user/suggestions_spec.rb
+- spec/recommendations/user_spec.rb
+- spec/recommendations_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.16
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []