octorecommender 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8c71b55542fbe8ecfc53e19f2943491a5a1510d
+  data.tar.gz: 320d5056ee304ab7b94f82a71496d8b660c86d21
+SHA512:
+  metadata.gz: 3fa4e9b0d64fa9e6838d46924e89a92e8a5e6a79d19a2fdd3fb67c9a428084870836cca057fee2428c8525c75fb6794a42ce8c4cfb8b2018ca22d7ec400bac19
+  data.tar.gz: a437e579d27d2e103a9ff4f6a75bb14ba00b876174fecfae784753032ee2e382ec5f23fd5275dce1095ef36df73bc4d80bffb17b3da5fbd199d2f089c1d3d214

data/lib/octorecommender.rb

@@ -0,0 +1,20 @@
+require 'predictor'
+require 'octocore'
+
+require 'octorecommender/recommenders'
+require 'octorecommender/version'
+require 'octorecommender/helpers'
+require 'octorecommender/octohooks'
+require 'octorecommender/scheduler'
+
+module Octo
+
+  # Override Octo's default connection to include
+  #   connection to Predictor as well
+  # See Octo#connect
+  def self.connect(configuration)
+    self._connect(configuration)
+    Predictor.redis = Cequel::Record.redis
+  end
+
+end

data/lib/octorecommender/helpers.rb

@@ -0,0 +1,2 @@
+require 'octorecommender/helpers/record'
+require 'octorecommender/helpers/generic'

data/lib/octorecommender/helpers/generic.rb

@@ -0,0 +1,11 @@
+module Octo
+
+  private
+
+  # Generate the recommender instance
+  # @return [Octo::Recommender]
+  def recommender
+    @recommender = Octo::Recommender.new unless @recommender
+    @recommender
+  end
+end

data/lib/octorecommender/helpers/record.rb

@@ -0,0 +1,20 @@
+# Overriding Product class so as to add
+#   recommender related helper methods
+module Octo
+  module Record
+
+    def similarities(opts={})
+      eid = self.enterprise.id
+      recommender.similar_products self, opts
+    end
+
+    private
+
+    # Generate the recommender instance
+    # @return [Octo::Recommender]
+    def recommender
+      @recommender = Octo::Recommender.new unless @recommender
+      @recommender
+    end
+  end
+end

data/lib/octorecommender/octohooks.rb

@@ -0,0 +1,31 @@
+require 'octocore/callbacks'
+
+module Octo
+
+  module OctoHooks
+
+    # Define the custom tasks that need to be done
+    #   upon various hooks
+    Octo::Callbacks.after_productpage_view lambda { |opts|
+      update_recommenders opts
+    }
+
+    # Extend the methods here
+    module ClassMethods
+
+      # Updates the recommenders
+      # @param [Hash] opts The options hash as passed
+      def update_recommenders(opts)
+        user = opts[:user]
+        product = opts[:product]
+
+        if user and product
+          recommender = Octo::Recommender.new
+          recommender.register_user_product_view(user, product)
+          recommender.register_user_action_time(user, Time.now.floor)
+        end
+      end
+
+    end
+  end
+end

data/lib/octorecommender/recommenders.rb

@@ -0,0 +1,143 @@
+require 'predictor'
+require 'octorecommender/recommenders/product_recommender'
+require 'octorecommender/recommenders/time_recommender'
+
+
+module Octo
+  class Recommender
+
+    # Queue for resque worker processing
+    @queue = :recommender
+
+    # Time format to convert a Time into HHMM format
+    TIME_HHMM = '%H%M'
+
+    # Initializes the Recommender.
+    def initialize
+      @product_recommenders = {}
+      @time_recommenders = {}
+
+      # This option chosen as ruby seems to take a LOOOOOOOOOOT of time
+      # in processing.
+      Octo::Recommenders::ProductRecommender.processing_technique(:union)
+      Octo::Recommenders::ProductRecommender.processing_technique :union
+
+      Octo::Enterprise.each do |enterprise|
+        @product_recommenders[enterprise.id] = Octo::Recommenders::ProductRecommender.new(enterprise.id)
+        @time_recommenders[enterprise.id] = Octo::Recommenders::TimeRecommender.new(enterprise.id)
+      end
+    end
+
+    # Register a user, product view relation.
+    # @param [Octo::User] user The user object
+    # @param [Octo::Product] product The product object
+    def register_user_product_view(user, product)
+      @product_recommenders[user.enterprise_id].add_to_matrix(:users,
+          user.id,
+          product.id
+      )
+
+      register_product product
+    end
+
+    # Register a Product for recommendation
+    # @param [Octo::Product] product The product object
+    def register_product(product)
+      eid = product.enterprise_id
+      product.categories.each do |cat_text|
+        @product_recommenders[eid].add_to_matrix(:categories,
+            cat_text,
+            product.id
+        )
+      end
+      product.tags.each do |tag_text|
+        @product_recommenders[eid].add_to_matrix(:tags,
+            tag_text,
+            product.id
+        )
+      end
+    end
+
+    # Register a user, action-time view relation.
+    # @param [Octo::User] user The user object
+    # @param [Time] ts The time at which user takes some action
+    def register_user_action_time(user, ts = Time.now.floor)
+      eid = user.enterprise_id
+      @time_recommenders[eid].add_to_matrix(:users,
+          user.id,
+          ts.to_i
+      )
+
+      @time_recommenders[eid].add_to_matrix(:hourminutes,
+          ts.strftime(TIME_HHMM),
+          ts.to_i
+      )
+
+      @time_recommenders[eid].add_to_matrix(:days,
+          ts.strftime('%A'),
+          ts.to_i
+      )
+    end
+
+    # Get recommended products for a user
+    # @param [Octo::User] user The user object for whom product
+    #   recommendations to be fetched
+    # @return [Array<Octo::Product>] An array of Octo::Product recommended
+    def recommended_products(user)
+      eid = user.enterprise_id
+      recommendations = @product_recommenders[eid].predictions_for(
+          user.id,
+          matrix_label: :users
+      )
+      recommendations.collect do |x|
+        args = { enterprise_id: eid, id: x.to_i}
+        Octo::Product.get_cached(args)
+      end
+    end
+
+    # Get similar products for products
+    # @param [Octo::Product] product The product for which similarities
+    #   have to be found
+    # @return [Array<Octo::Product>] An array containing similar
+    #   products
+    def similar_products(product, opts={})
+      eid = product.enterprise.id
+      @product_recommenders[eid].similarities_for(product.id, opts)
+    end
+
+    # Get recommended time for a user
+    # @param [Octo::User] user The user for whom time to be fetched
+    # @return [Array<Time>] The array of time recommended
+    def recommended_time(user)
+      eid = user.enterprise_id
+      recommendations = @time_recommenders[eid].predictions_for(user.id, matrix_label: :users)
+      recommendations.map do |ts|
+        convert_to_future(Time.at(ts.to_i))
+      end
+    end
+
+    # Creates a delayed job to process all the recommenders for all the
+    #   enterprises or can provide specific options as well
+    def process!(opts = {})
+      @product_recommenders.values.each do |recomm|
+        recomm.process!
+      end
+      @time_recommenders.values.each do |recomm|
+        recomm.process!
+      end
+    end
+
+    # Converts a time from past to a similar time in future.
+    #   This is necessary as CF would return one of the dates
+    #   from past. We need sometime from future.
+    def convert_to_future(ts)
+      ts + (Time.now.beginning_of_day - ts.beginning_of_day) + 7.day
+    end
+
+    # Callback method for resque worker
+    def self.perform
+      self.new.process!
+    end
+
+  end
+end

data/lib/octorecommender/recommenders/product_recommender.rb

@@ -0,0 +1,33 @@
+require 'predictor'
+require 'octorecommender'
+
+module Octo
+  module Recommenders
+    # The product recommender class. This class is responsible for recommending
+    #   a (user, product)
+    class ProductRecommender
+      include Predictor::Base
+
+      def initialize(prefix)
+        @prefix = prefix
+      end
+
+      def get_redis_prefix
+        @prefix
+      end
+
+      limit_similarities_to 20
+
+      # Stores the user and product relation
+      input_matrix :users, weight: 3.0
+
+      # Store the relation between products asserted by their tags
+      input_matrix :tags, weight: 2.0
+
+      # Store the relation between products asserted by their
+      #   categories
+      input_matrix :categories, weight: 1.0
+    end
+  end
+
+end

data/lib/octorecommender/recommenders/time_recommender.rb

@@ -0,0 +1,41 @@
+require 'predictor'
+require 'octorecommender'
+
+module Octo
+
+  module Recommenders
+
+    # The time recommender class. This class would be responsible for recommending
+    #   the next set of time for a (user, action)
+    class TimeRecommender
+      include Predictor::Base
+
+      def initialize(prefix)
+        @prefix = prefix
+      end
+
+      def get_redis_prefix
+        @prefix
+      end
+
+      limit_similarities_to 20
+
+      # This matrix stores the user and their action
+      input_matrix :users, weight: 1.0
+
+      # This matrix stores the relation between times in terms of
+      # HHMM.
+      # Ex:
+      #   11/3/2016 11:30 and 12/3/2016 11:30 have the same HHMM
+      input_matrix :hourminutes, weight: 3.0
+
+      # This matrix stores the relation between times in terms of
+      # days.
+      # Ex:
+      #   4/4/2016 (Monday) and 11/4/2016 (Monday) have the same day
+      input_matrix :days, weight: 2.0
+    end
+
+  end
+
+end

data/lib/octorecommender/scheduler.rb

@@ -0,0 +1,19 @@
+
+module Octo
+  module Scheduler
+
+    # Setup Schedule for recommenders
+    def schedule_recommender
+      name = 'recommender_processing'
+      config = {
+            class: 'Octo::Recommender',
+            args: [],
+            cron: '0,30 * * * *',
+            persist: true,
+            queue: 'recommender'
+          }
+      Resque.set_schedule name, config
+    end
+
+  end
+end

data/lib/octorecommender/version.rb

@@ -0,0 +1,7 @@
+module Octo
+  module Recommenders
+
+    # The version of Recommender module
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: octorecommender
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pranav Prakash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: predictor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: octocore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: |2
+    Contains recommendation specific stuff
+email: pp@octo.ai
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/octorecommender.rb
+- lib/octorecommender/helpers.rb
+- lib/octorecommender/helpers/generic.rb
+- lib/octorecommender/helpers/record.rb
+- lib/octorecommender/octohooks.rb
+- lib/octorecommender/recommenders.rb
+- lib/octorecommender/recommenders/product_recommender.rb
+- lib/octorecommender/recommenders/time_recommender.rb
+- lib/octorecommender/scheduler.rb
+- lib/octorecommender/version.rb
+homepage: http://phab.octo.ai/diffusion/GEMS/
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Octo Recommender(s) Module
+test_files: []
+has_rdoc: true