recommend_it 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de2266a44910ede2906b3d2d14432400e1947c8730554d7421c64534ce2a5ffb
-  data.tar.gz: df6b2b1849fa821b9b9a0eb7a8e6138e4de8fdd2190a6b84d191ccc7ad6a2d0f
+  metadata.gz: 6bd007a6750f5f64fa9337dd3f649280c536e0836e9cc02ee40177871d9fa975
+  data.tar.gz: 2c5f656a202541520ad3c83076117ee32f230eca508fbd6cbbd1e8543ecd3b58
 SHA512:
-  metadata.gz: a746eb1b0c828b1c9f652f0096cc87544c2c833f29da588de20fd1a9cd36982efdf4ef01e315e76558ab285e855d61ff4ca3a488764e89160312f0ab148d1cf1
-  data.tar.gz: 6e7747d78b0f8844383c586df8a70329aca144483add71691917c681c8e9594691a53b8bd71da2ca6bb57a984230b779ace2ee54667251607d3b6ab586f6221c
+  metadata.gz: a41234b4c247f53ffd754dcb2bf3a21839683e41df8f7d0320cb6785fa06a32bc2354e37196038fd8bfcc7ae0d42ed4821428e2ebe76411f094b1a281890d941
+  data.tar.gz: 8a8cdfae16218d636f6c558f5b68e387f267ec4d667cf02be8c53057f2f5c309acdfe6f9aa761547fdf5ed7d2651ba631181a2608128df93f28c12651e00a816

data/lib/item_based_recommendation.rb

@@ -0,0 +1,23 @@
+require 'utils/similars'
+class ItemBasedRecommendation
+    include Similars
+
+    # Get recommendation for item
+    # item => menu item to get recommendation for
+    # data => matrix collection of item's views and orders
+    def recommendation(context)
+        item = context.item
+        data = context.data
+        similar_items = Similars.get_similars(item,data)
+        result = Hash.new
+        if similar_items.length > 0
+            recommend = Array.new
+            similar_items.each do |key, sim_index|
+                recommend.push(key)
+            end
+            result[:recommendation] = recommend
+        end
+        return result
+    end
+
+end

data/lib/models/menu.rb

@@ -0,0 +1,9 @@
+class Menu
+    def initialize(id)
+        @id = id
+    end
+
+    def id
+        return @id
+    end
+end

data/lib/recommend.rb

@@ -1,13 +1,14 @@
 require 'user_based_recommendation'
+require 'item_based_recommendation'
 
 class Recommend
     attr_reader :item, :order_details, :data
     attr_accessor :type
 
-    # @param type = This is the type of recommendation to be performed e.g UserBasedRecommendation.new
+    # @param type = This is the type of recommendation to be performed e.g UserBasedRecommendation.new, ItemBasedRecommendation
     # @param item = This is the object the recommendation will be performed for e.g user
     # @param order_details = Hash containing array of users ordered menu items
-    # @param data = Matrix data of users against their purchase count of menu items
+    # @param data = Matrix data of implicit ratings of users/items
     def initialize(type, item, order_details = [], data)
         @type = type
         @item = item
@@ -15,7 +16,7 @@ class Recommend
         @data = data
     end
 
-    # Returns hash of user previous menus and new recommended menu items
+    # Returns hash of recommendations
     def recommendation()
         @type.recommendation(self)
     end

data/lib/user_based_recommendation.rb

@@ -10,7 +10,7 @@ class UserBasedRecommendation
         user = context.item
         data = context.data
         order_details = context.order_details
-        similar_users = Similars.get_similar_users(user,data)
+        similar_users = Similars.get_similars(user,data)
         result = Hash.new
         if similar_users.length > 0
             user_menus = Array.new
@@ -30,7 +30,6 @@ class UserBasedRecommendation
 
     # Returns all similars menu items
     def get_similars_menus(similar_users,order_details)
-        number_of_users = similar_users.length
         similars_menus = Array.new
         similar_users.each do |user_id, sim_index|
             get_all_similar_users_menu_items(order_details,user_id,similars_menus)

data/lib/utils/item_based_mock.rb

@@ -0,0 +1,35 @@
+module ItemBasedMock
+
+    # Matrix data for items
+    # index 0 => number of views
+    # index 1 => number of orders placed
+    def self.matrix_data
+        return {
+            1 => [7,5],
+            2 => [1,1],
+            3 => [9,2],
+            4 => [30,17],
+            5 => [13,13],
+            6 => [50,1]
+        }
+    end
+
+    def self.matrix_data_different
+        return {
+            1 => [7,5],
+            2 => [0,0]
+        }
+    end
+
+    # Returns an array of items with similarity indexes
+    def self.similarity_indexes
+        return {
+            4 => 0.9945239101364354,
+            5 => 0.9863939238321439,
+            2 => 0.9863939238321436,
+            3 => 0.9204443524957583,
+            6 => 0.8251932129390934
+        }
+    end
+
+end

data/lib/utils/similars.rb

@@ -36,15 +36,15 @@ module Similars
         return Math.sqrt(sum).to_f
     end
 
-    # Returns an array of similarity index of users against the logged in user
-    # Sort the similarity indexes in descending order to get like users first
-    def self.get_similar_users(user,data)
+    # Returns an array of similarity indexes
+    # Sort the similarity indexes in descending order
+    def self.get_similars(target,data)
         sim = Hash.new
-        d1 = data[user.id]
+        d1 = data[target.id]
         data.each do |key, d2|
-            if key != user.id
+            if key != target.id
                 index = similarity_index(d1, d2)
-                if index > 0 && !index.nan? # Only store users that have similarity index greater than 0 and is not NaN (NaN values are derived when document vector is filled with only zero values)
+                if index > 0 && !index.nan? # Only store records that have similarity index greater than 0 and is not NaN (NaN values are derived when document vector is filled with only zero values)
                     sim[key] = index
                 end
             end

data/lib/utils/{mock.rb → user_based_mock.rb}

@@ -1,4 +1,4 @@
-module Mock
+module UserBasedMock
     # Mock data to use for testing purposes
 
     # Returns document vector of valid length

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recommend_it
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Weje Emmanuel Okechukwu
@@ -16,11 +16,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/item_based_recommendation.rb
+- lib/models/menu.rb
 - lib/models/user.rb
 - lib/recommend.rb
 - lib/user_based_recommendation.rb
-- lib/utils/mock.rb
+- lib/utils/item_based_mock.rb
 - lib/utils/similars.rb
+- lib/utils/user_based_mock.rb
 homepage: http://rubygems.org/gems/recommend_it
 licenses: []
 metadata: {}