tamber 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdd3589d598228fa188dcf72fbf58c415811eaa9
-  data.tar.gz: 3e97977c9c85bfa56a643ef612daf17651376b58
+  metadata.gz: ff938263efc3c5aa656aab523beb101c9de80e86
+  data.tar.gz: d0c573e996b8f58c27d0e9ec47f189d2691d22ec
 SHA512:
-  metadata.gz: 376c257df9d66d181def153f3aad03b20da2c97409805691c75875de9b7a7aa0ed83d09d878e6760728170e574edeced64862b7cc9290bb722ea32bdf3eb8d2a
-  data.tar.gz: bd19752b928644a430c146d08a6bd41ad81f50a0dc330a86900948e5802216aa1a456c74aac1a941b25af617303ccb02112f5c951939f7a78398a7dfe065cbc5
+  metadata.gz: babeb332768806e4d7a7d55f6dd79ab74557d75325ca7203298533727fa38680871e5d7a9519e294d433757c467cd01f5998e40b5793cca3032eb24d2ded23a4
+  data.tar.gz: 69712d840fef4413e9626e65453f9113bf5a6ac166b65aee443da4efdd9dc382dad965b60b19fd0c0844f1c6ae2630541360430f06d52366c2c0132bec1d0244

data/README.md

@@ -60,19 +60,18 @@ end
 
 Once you have tracked enough events and created your engine, it's time to put personalized recommendations in your app.
 
-The primary method of discovery in Tamber is the `Discover.next` method, which returns the optimal set of items that the user should be shown next.
+The primary methods of discovery in Tamber are the `Discover.next` and `Discover.recommended` methods, which returns the optimal set of items that the user should be shown next on a given item page, and in a personalized recommendations section, respectively.
 
-#### For You
+#### Up Next
 
-To put personalized recommendations on your homepage, or in any recommended section, just call `Discover.next` with the given user's id and the number of recommendations you want to display.
+Don't make an item page a deadend. Keep users engaged by creating paths of discovery as they navigate from item to item, always showing the right mix of items they should check out next. Just add the id of the item that the user is navigating to / looking at.
 
 ```rb
-Tamber.project_key = 'your_project_key'
-
 begin
   d = Tamber::Discover.next(
     user: 'user_rlox8k927z7p',
-    number: 10
+    item: 'item_wmt4fn6o4zlk',
+    number: 14
   )
   d.each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
 rescue TamberError => error
@@ -80,16 +79,17 @@ rescue TamberError => error
 end
 ```
 
-#### Up Next
+#### For You
 
-Keep users engaged by creating a path of discovery as they navigate from item to item, always showing the right mix of items they should check out next. Just add the id of the item that the user is navigating to / looking at.
+To put personalized recommendations on your homepage, or in any recommended section, just call `Discover.recommended` with the given user's id and the number of recommendations you want to display.
 
 ```rb
+Tamber.project_key = 'your_project_key'
+
 begin
-  d = Tamber::Discover.next(
+  d = Tamber::Discover.recommended(
     user: 'user_rlox8k927z7p',
-    item: 'item_wmt4fn6o4zlk',
-    number: 14
+    number: 10
   )
   d.each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
 rescue TamberError => error
@@ -100,9 +100,9 @@ end
 
 ##### `continuation`
 
-`Discover.next` is optimized for the exact moment and context of the user at the time of request, so standard pagination is not possible. Instead, `Discover.next` uses automatic continuation to allow you to 'show more' or implement infinite scrolling. 
+Recommendations are optimized for the exact moment and context of the user at the time of request, but sometimes a user wants to see more recommended items than are shown by default. In order to 'Show More', Tamber supports automatic continuation. 
 
-When you want to add more recommendations to those currently displayed to the user, just set the `continuation` field to `true`. Tamber will automatically generate the set of items that should be appended to the current user-session's list. The `Discover.next` user-session is reset when `Discover.next` is called without `continuation`.
+When you want to add more recommendations to those currently displayed to the user, just set the `continuation` field to `true`. Tamber will automatically generate the set of items that should be appended to the current user-session's list. The user-session is reset when `Discover.recommended` or `Discover.next` is called without `continuation`.
 
 ```rb
 Tamber.project_key = 'your_project_key'
@@ -150,19 +150,19 @@ Tamber allows you to use lower-level methods to get lists of recommended items,
 
 ```rb
 begin
-  Tamber::Discover.recommended(user: 'user_rlox8k927z7p').each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
+  Tamber::Discover.basicRecommended(user: 'user_rlox8k927z7p').each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
 rescue TamberError => error
   puts error.message
 end
 
 begin
-  Tamber::Discover.similar(item: 'item_wmt4fn6o4zlk').each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
+  Tamber::Discover.basicSimilar(item: 'item_wmt4fn6o4zlk').each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
 rescue TamberError => error
   puts error.message
 end
 
 begin
-  Tamber::Discover.recommendedSimilar(
+  Tamber::Discover.basicRecommendedSimilar(
     user: 'user_rlox8k927z7p',
     item: 'item_wmt4fn6o4zlk'
   ).each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.1.12

data/lib/tamber/api_resource.rb

@@ -10,7 +10,11 @@ module Tamber
       if self == APIResource
         raise TamberError.new('APIResource is an abstract class.  You should perform actions on its subclasses (Event, Discover, etc.)')
       end
-      "/#{CGI.escape(class_name.downcase)}"
+      if class_name.downcase == "basic"
+        "/discover/#{CGI.escape(class_name.downcase)}"
+      else
+        "/#{CGI.escape(class_name.downcase)}"
+      end
     end
 
     def url

data/lib/tamber/discover.rb

@@ -1,6 +1,5 @@
 module Tamber
   class Discover < APIResource
-
     def self.next(params={})
       response = request(:get, self.next_url, params)
       Util.convert_to_tamber_object(response)
@@ -11,15 +10,15 @@ module Tamber
       Util.convert_to_tamber_object(response)
     end 
 
-    def self.similar(params={})
-      response = request(:get, self.similar_url, params)
+    def self.weekly(params={})
+      response = request(:get, self.weekly_url, params)
       Util.convert_to_tamber_object(response)
-    end
+    end 
 
-    def self.recommendedSimilar(params={})
-      response = request(:get, self.recommendedSimilar_url, params)
+    def self.daily(params={})
+      response = request(:get, self.daily_url, params)
       Util.convert_to_tamber_object(response)
-    end
+    end 
 
     def self.meta(params={})
       response = request(:get, self.meta_url, params)
@@ -46,20 +45,22 @@ module Tamber
       Util.convert_to_tamber_object(response)
     end
 
+    
+
     def self.recommended_url
       url + '/recommended'
     end
 
-    def self.similar_url
-      url + '/similar'
+    def self.next_url
+      url + '/next'
     end
 
-    def self.recommendedSimilar_url
-      url + '/recommended_similar'
+    def self.weekly_url
+      url + '/weekly'
     end
 
-    def self.next_url
-      url + '/next'
+    def self.daily_url
+      url + '/daily'
     end
 
     def self.meta_url
@@ -82,6 +83,33 @@ module Tamber
       url + '/new'
     end
 
+    class Basic < APIResource
+      def self.recommended(params={})
+        response = request(:get, self.recommended_url, params)
+        Util.convert_to_tamber_object(response)
+      end 
+
+      def self.similar(params={})
+        response = request(:get, self.similar_url, params)
+        Util.convert_to_tamber_object(response)
+      end
+
+      def self.recommendedSimilar(params={})
+        response = request(:get, self.recommendedSimilar_url, params)
+        Util.convert_to_tamber_object(response)
+      end
+      def self.recommended_url
+        url + '/recommended'
+      end
+
+      def self.similar_url
+        url + '/similar'
+      end
+
+      def self.recommendedSimilar_url
+        url + '/recommended_similar'
+      end
+    end
   end
 
   # Discover requests return an array of 'discovery' objects

data/lib/tamber/version.rb

@@ -1,3 +1,3 @@
 module Tamber
-  VERSION = '0.1.11'
+  VERSION = '0.1.12'
 end

data/test/discover_test.rb

@@ -76,7 +76,7 @@ module Tamber
 
     should "return similar" do
       begin
-        d = Tamber::Discover.similar(
+        d = Tamber::Discover::Basic.similar(
           :item => 'item_i5gq90scc1'
         )
         d.each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
@@ -85,7 +85,7 @@ module Tamber
 
     should "return recommendedSimilar" do
       begin
-        d = Tamber::Discover.recommendedSimilar(
+        d = Tamber::Discover::Basic.recommendedSimilar(
           :user => 'user_jctzgisbru',
           :item => 'item_i5gq90scc1'
         )

data/test/test_helper.rb

@@ -9,7 +9,6 @@ class Test::Unit::TestCase
 
   setup do
     Tamber.project_key = "Mu6DUPXdDYe98cv5JIfX"
-    Tamber.engine_key = "SbWYPBNdARfIDa0IIO9L"
     Tamber.open_timeout = 3
     Tamber.read_timeout = 2
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamber
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Alexi Robbins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client