tamber 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f8004eba3105bccbba37c06ea731792477a3a6a5
-  data.tar.gz: 4258a7685450ee4e22a553f019917068840c9fa2
+SHA256:
+  metadata.gz: cbcc5f581e5dcfe9f92aa08dda5925063b04bcdef53018d53109568e238ee20c
+  data.tar.gz: 2a5e6a4bbdaa10de0148dcc2ad44bf05b08ed38b68741b0d27f8579055e25ac2
 SHA512:
-  metadata.gz: a207f215cf2c5fa4a6aa7308b6d4d3bb48ff58856ae5ee7488e60cb41bf6e24078134f603f5370d24fb293fa7612ef440c58b99f836ae2074ca69c7d263d2830
-  data.tar.gz: 0f58d0e36a8c03fb44b6e882829d0a052e7d71538dd2eb5271abdd14b4b4f3c754ffbcae861e84e4034e84fddeae2dfae06095284dfd4e3bf9409df288f4bdbf
+  metadata.gz: 7680dd74aa4eabc5db6b28bbd1e51fa091d53984b059a426b423b69960bccc7f6064729d4453c972a70a3d6fc07a9dd3a8dd851a925c7638446bc6a99d48684f
+  data.tar.gz: 67dc999d917874866db92440b77f7d02f3ec5129561eb44425eaf2decc2e954f29e78f3dcfd5458cdaf4fd3b205b39e4b86f818baeab916d93b4344785532561

data/.travis.yml

@@ -4,8 +4,8 @@ before_install:
   - gem update bundler # -v 1.7.14 if a specific version is needed
 
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.5
   - jruby-19mode

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Tamber, Inc.
+Copyright (c) 2019 Tamber, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,7 +2,7 @@
 
 Recommendation engines for developers, easy as π. Build blazing fast, head-scratchingly accurate hosted recommendation engines in minutes.
 
-The Tamber iOS SDK makes it easy to track events (user-item interactions) and get recommendations for your users inside your iOS app. 
+The Tamber iOS SDK makes it easy to track events (user-item interactions) and get recommendations for your users in real time. 
 
 [Get a free api key][homepage] to get started.
 
@@ -48,7 +48,10 @@ begin
     user: 'user_rlox8k927z7p',
     behavior: 'like'
     item:  'item_wmt4fn6o4zlk',
-    context: ["homepage", "featured_section"]
+    context: {
+      "page": "homepage", 
+      "section": "featured_section"
+    }
   )
 rescue TamberError => error
   puts error.message
@@ -60,19 +63,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 dead-end. 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 supply the user and the item that they are 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 +82,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 +103,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'
@@ -126,21 +129,21 @@ Help your users keep their fingers on the pulse of your platform by showing them
 
 ```rb
 begin
-  d = Tamber::Discover.hot() // the hottest (trending) items
+  d = Tamber::Discover.hot # the hottest (trending) items
   d.each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
 end
 
 begin
-  d = Tamber::Discover.popular() // the hottest (trending) items
+  d = Tamber::Discover.popular # the most popular items
 end
 
 # BETA endpoints
 begin
-  d = Tamber::Discover.uac() // the most up-and-coming items
+  d = Tamber::Discover.uac # the most up-and-coming items
 end
 
 begin
-  d = Tamber::Discover.new() // the newest items
+  d = Tamber::Discover.new # the newest items
 end
 ```
 
@@ -150,19 +153,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::Basic.recommended(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::Basic.Similar(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::Basic.RecommendedSimilar(
     user: 'user_rlox8k927z7p',
     item: 'item_wmt4fn6o4zlk'
   ).each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.2.0

data/lib/tamber.rb

@@ -13,6 +13,7 @@ require 'json'
 require 'tamber/version'
 
 require 'tamber/api_operations/create'
+require 'tamber/api_operations/save'
 require 'tamber/api_operations/update'
 require 'tamber/api_operations/remove'
 require 'tamber/api_operations/retrieve'
@@ -157,7 +158,7 @@ module Tamber
       "'host tamber.com' from the command line and try again. " \
       "Still borked? Email us at support@tamber.com and we'll get to the bottom of it."
 
-    when RestClient::Timeout
+    when RestClient::RequestTimeout
       message = "Could not connect to Tamber at #{api_url}. " \
       "Please check your internet connection and try again. " \
       "Still borked? Email us at support@tamber.com and we'll get to the bottom of it."

data/lib/tamber/api_operations/remove.rb

@@ -3,7 +3,7 @@ module Tamber
     module Remove
       def remove(params={})
         response = request(:get, url+"/remove", params)
-        # initialize_from(response, opts)
+        Util.convert_to_tamber_object(response)
       end
     end
   end

data/lib/tamber/api_resource.rb

@@ -10,7 +10,14 @@ 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)}"
+      elsif class_name.downcase == "usertrend"
+        "/discover/user_trend"
+      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,25 @@ module Tamber
       Util.convert_to_tamber_object(response)
     end
 
+    def self.uac(params={})
+      response = request(:get, self.uac_url, params)
+      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 +86,66 @@ module Tamber
       url + '/new'
     end
 
+    class UserTrend < APIResource
+      def self.popular(params={})
+        response = request(:get, self.popular_url, params)
+        Util.convert_to_tamber_object(response)
+      end 
+
+      def self.hot(params={})
+        response = request(:get, self.hot_url, params)
+        Util.convert_to_tamber_object(response)
+      end
+
+      def self.uac(params={})
+        response = request(:get, self.uac_url, params)
+        Util.convert_to_tamber_object(response)
+      end
+
+      def self.popular_url
+        url + '/popular'
+      end
+
+      def self.hot_url
+        url + '/hot'
+      end
+
+      def self.uac_url
+        url + '/uac'
+      end
+    end
+
+    # deprecated
+    class Basic < APIResource
+      def self.recommended(params={})
+        warn "[DEPRECATION] `Discover.Basic.recommended` is deprecated.  Please use `Discover.recommended` instead."
+        response = request(:get, self.recommended_url, params)
+        Util.convert_to_tamber_object(response)
+      end 
+
+      def self.similar(params={})
+        warn "[DEPRECATION] `Discover.Basic.similar` is deprecated.  Please use `Discover.next` instead."
+        response = request(:get, self.similar_url, params)
+        Util.convert_to_tamber_object(response)
+      end
+
+      def self.recommendedSimilar(params={})
+        warn "[DEPRECATION] `Discover.Basic.recommendedSimilar` is deprecated.  Please use `Discover.next` instead."
+        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/item.rb

@@ -1,10 +1,17 @@
 module Tamber
   class Item < APIResource
     extend Tamber::APIOperations::Create
+    extend Tamber::APIOperations::Save
     extend Tamber::APIOperations::Update
     extend Tamber::APIOperations::Retrieve
     extend Tamber::APIOperations::List
 
+    # hide an item from all Discover results
+    def self.batch(params={})
+      response = request(:post, self.batch_url, params)
+      Util.convert_to_tamber_object(response)
+    end
+
     # hide an item from all Discover results
     def self.hide(params={})
       response = request(:post, self.hide_url, params)
@@ -23,6 +30,10 @@ module Tamber
       Util.convert_to_tamber_object(response)
     end
 
+    def self.batch_url
+      url + '/batch'
+    end
+
     def self.hide_url
       url + '/hide'
     end

data/lib/tamber/user.rb

@@ -1,12 +1,19 @@
 module Tamber
   class User < APIResource
     extend Tamber::APIOperations::Create
-    extend Tamber::APIOperations::Update
+    extend Tamber::APIOperations::Save
     extend Tamber::APIOperations::Retrieve
     extend Tamber::APIOperations::List
 
+    def self.update(params={})
+      warn "[DEPRECATION] `User.update` is deprecated.  Please use `User.save` instead."
+      response = request(:post, url + '/update', params)
+      Util.convert_to_tamber_object(response)
+    end
+
     def self.search(params={})
-      response = request(:post, url + '/search', params)
+      warn "[DEPRECATION] `User.search` is deprecated.  Please use `User.list` instead."
+      response = request(:post, url + '/list', params)
       Util.convert_to_tamber_object(response)
     end
 
@@ -14,6 +21,13 @@ module Tamber
       response = request(:post, url + '/merge', params)
       Util.convert_to_tamber_object(response)
     end
+
+    # Deprecated in api version 2020-6-11
+    def self.update(params={})
+      warn "[DEPRECATION] `User.update` is deprecated.  Please use `User.save` instead."
+      response = request(:post, url + '/save', params)
+      Util.convert_to_tamber_object(response)
+    end
     
   end
 end

data/lib/tamber/version.rb

@@ -1,3 +1,3 @@
 module Tamber
-  VERSION = '0.1.10'
+  VERSION = '0.2.0'
 end

data/tamber.gemspec

@@ -13,8 +13,8 @@ spec = Gem::Specification.new do |s|
   s.authors = ['Alexi Robbins', 'Mark Canning']
   s.email = ['alexi@tamber.com', 'argusdusty@tamber.com']
 
-  s.add_dependency('rest-client', '~> 1.4')
-  s.add_dependency('json', '~> 1.8.1')
+  s.add_dependency('rest-client', '~> 2.0')
+  s.add_dependency('json', '>= 1.8.1')
   s.add_dependency('activesupport', '>= 4.2.4')
 
   s.add_development_dependency('mocha', '~> 0.13.2')

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'
         )
@@ -93,5 +93,14 @@ module Tamber
       end
     end
 
+    should "return user hot" do
+      begin
+        d = Tamber::Discover::UserTrend.hot(
+          :user => 'user_jctzgisbru'
+        )
+        d.each { |rec| puts "item: #{rec.item}, score: #{rec.score}"}
+      end
+    end
+
   end
 end

data/test/event_test.rb

@@ -9,8 +9,7 @@ module Tamber
           :item =>  'item_i5gq90scc1',
           :behavior => 'mention',
           :hit => true,
-          :context => ['recommended', 'detail-view'],
-          :get_recs => {}
+          :context => {'page'=>'recommended'}
         )
         puts e
       end

data/test/test_helper.rb

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

data/test/user_test.rb

@@ -59,19 +59,19 @@ module Tamber
       end
     end
 
-    should "search user" do
-      begin
-        users = Tamber::User.search(
-          :filter => {
-            'city' => 'Mountain View, CA'
-          }
-        )
-        puts users.inspect
-        # assert users.length >= 1
-      rescue TamberError => error
-        puts error.message
-      end
-    end
+    # should "search user" do
+    #   begin
+    #     users = Tamber::User.search(
+    #       :filter => {
+    #         'city' => 'Mountain View, CA'
+    #       }
+    #     )
+    #     puts users.inspect
+    #     # assert users.length >= 1
+    #   rescue TamberError => error
+    #     puts error.message
+    #   end
+    # end
 
     # Breaks production test
     # should "merge user" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamber
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexi Robbins
@@ -9,104 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.4
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.2
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Tamber is the easiest way to put head-scratchingly accurate, real time
@@ -118,8 +118,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -161,17 +161,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Tamber API