uboost-client 0.1.5 → 0.1.6

data/README.markdown

@@ -59,6 +59,32 @@ client.points.add_points_to_account(921679359, 30, {:description => 'a descripti
 client.badges.award(921679359, 1)
 
 client.badges.unaward(921679359, 1)
+```
+
+The widgets section can make use of a session store. Just pass a session object - something that quacks like a hash - and the first call it makes will cache the `uboost_session_id`.
+
+````ruby
+
+# No caching
+client.widgets.profile(:account_id => 921679373)  
+# Caching activated. It will cache the uboost sesion.
+client.widgets(:session => session).profile(:account_id => 921679373)
+# Caching activated. It will use the cached uboost sesion.
+client.widgets(:session => session).profile(:account_id => 921679373)
+
+client.widgets.my_badges(:account_id => 921679373)
+client.widgets(:session => session).my_badges(:account_id => 921679373)
+client.widgets(:session => session).my_badges(:account_id => 921679373)
+
+client.widgets.ubar(921679373)
+
+client.widgets.list_of_leaderboards(:account_id => 921679373)
+client.widgets(:session => session).list_of_leaderboards(:account_id => 921679373)
+client.widgets(:session => session).list_of_leaderboards(:account_id => 921679373)
+
+client.widgets.leaderboard(:account_id => 921679373, :leaderboard_id => 226)
+client.widgets(:session => session).leaderboard(:account_id => 921679373, :leaderboard_id => 226)
+client.widgets(:session => session).leaderboard(:account_id => 921679373, :leaderboard_id => 226)
 
 client.widgets.profile(921679358)
 

data/lib/uboost-client/uboost_client.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'faraday'
 require 'json'
 require 'ostruct'
+require 'cgi'
 
 module UboostClient
 
@@ -12,6 +13,7 @@ module UboostClient
     def initialize(options = Hash.new)
       @subdomain        = options[:subdomain]
       @api_credentials  = options[:api_credentials]
+      @debug            = options[:debug] || false
     end
 
     def connection
@@ -23,6 +25,15 @@ module UboostClient
       end
     end
 
+    def connection_with_uboost_session(uboost_session_id)
+      url = "https://#{@subdomain}.uboost.com"
+      Faraday.new(url, {:headers=>{'Cookie'=> uboost_session_id}}) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
     def account
       @account ||= UboostClient::Account.new(self)
     end
@@ -35,8 +46,8 @@ module UboostClient
       @badges ||= UboostClient::Badges.new(self)
     end
 
-    def widgets
-      @widgets ||= UboostClient::Widgets.new(self)
+    def widgets(options = Hash.new)
+      @widgets = UboostClient::Widgets.new(self, options)
     end
 
   end
@@ -165,44 +176,75 @@ module UboostClient
   end
 
   class Widgets
-    attr_accessor :url, :client
+    attr_accessor :url, :client, :session
 
-    def initialize(client)
+    def initialize(client, options)
       @client = client
       @url = '/api/widgets'
+      @session = options[:session] || false
+    end
+
+    def session_cache_available?
+      @session
+    end
+
+    def cached_uboost_id_available?
+      @session && @session[:uboost_session_id]
     end
 
     def get_sso_token(account_id)
       client.account.token(account_id).student["sso_token"]
     end
 
-    def profile(account_id)
-      response = @client.connection.get @url + '/profile', :sso_token => get_sso_token(account_id)
-      OpenStruct.new(JSON.parse(response.body))
+    def cache_uboost_cookie(response)
+      cookie = CGI::Cookie.parse(response.headers['set-cookie'])
+      @session[:uboost_session_id] = "_uboost_session_id=" + cookie["_uboost_session_id"][0]
     end
     
-    def my_badges(account_id, badge_category_id = "all")
-      response = @client.connection.get @url + '/badges/mine/' + badge_category_id, :sso_token => get_sso_token(account_id)
+    def get(url, options)
+      response = nil
+      if !session_cache_available?
+        response = @client.connection.get url, :sso_token => get_sso_token(options[:account_id])
+      elsif !cached_uboost_id_available?
+        response = @client.connection.get url, :sso_token => get_sso_token(options[:account_id])
+        cache_uboost_cookie(response)
+      elsif cached_uboost_id_available?
+        response = @client.connection_with_uboost_session(@session[:uboost_session_id]).get url
+        cache_uboost_cookie(response)
+      end
+      response
+    end
+
+    def profile(options)
+      options = {:account_id => nil}.merge(options)
+      response = get(@url + '/profile', options)
       OpenStruct.new(JSON.parse(response.body))
     end
-    
-    def list_of_leaderboards(account_id)
-      response = @client.connection.get @url + '/leaderboards', :sso_token => get_sso_token(account_id)
+
+    def my_badges(options)
+      options = {:account_id => nil, :badge_category_id => 'all'}.merge(options)
+      response = get(@url + '/badges/mine/' + options[:badge_category_id], options)
       OpenStruct.new(JSON.parse(response.body))
     end
-    
-    def leaderboard(account_id, leaderboard_id)
-      response = @client.connection.get @url + '/leaderboards/' + leaderboard_id.to_s, :sso_token => get_sso_token(account_id)
-      OpenStruct.new(JSON.parse(response.body))          
+
+    def list_of_leaderboards(options)      
+      response = get(@url + '/leaderboards/', options)
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def leaderboard(options)
+      options = {:account_id => nil, :leaderboard_id => nil}.merge(options)
+      response = get(@url + '/leaderboards/' + options[:leaderboard_id].to_s, options)
+      OpenStruct.new(JSON.parse(response.body))
     end
 
     def ubar(account_id, options = Hash.new)
-      options = {:align => "", :bar_color => '', :div_id => ''}.merge(options)
+      options = {:align => "", :bar_color => '', :div_id => 'ubar'}.merge(options)
       token = get_sso_token(account_id)
       subdomain_url = "http://" + client.subdomain + ".uboost.com"
 
-"     <script type='text/javascript' src='#{subdomain_url}/javascripts/uBar.js'></script> 
-      <div style='position: absolute; bottom: 0px; z-index: 2; height: 36px;' id='#{options[:div_id]}'>
+"     <script type='text/javascript' src='#{subdomain_url}/javascripts/uBar.js'></script>
+      <div class='uboost_ubar' id='#{options[:div_id]}'>
         <object>
           <param value='#{subdomain_url}/uBar.swf' name='movie'>
           <param value='100%' name='width'>

data/lib/uboost-client/version.rb

@@ -1,3 +1,3 @@
 class UboostClient
-  VERSION = "0.1.5"  
+  VERSION = "0.1.6"  
 end

data/spec/simple_test.rb

@@ -1,7 +1,9 @@
 require File.expand_path('lib/uboost-client')
+require "pp"
 
 subdomain        = ENV['UBOOST_SUBDOMAIN']
 api_credentials  = { :username => ENV['UBOOST_USERNAME'], :password => ENV['UBOOST_PASSWORD'] }
+session = Hash.new 
 
 client = UboostClient::Client.new(:subdomain => subdomain, :api_credentials => api_credentials)
 
@@ -17,10 +19,21 @@ client = UboostClient::Client.new(:subdomain => subdomain, :api_credentials => a
 # puts client.points.add_points_to_account(921679359, 30, {:description => 'whatps'})
 # puts client.badges.award(921679373, 467)
 # puts client.badges.unaward(921679373, 467)
-# puts client.widgets.profile(921679373)
-# puts client.widgets.my_badges(921679373)
+
+# puts client.widgets.profile(:account_id => 921679373)
+# puts client.widgets(:session => session).profile(:account_id => 921679373)
+# puts client.widgets(:session => session).profile(:account_id => 921679373)
+
+# puts client.widgets.my_badges(:account_id => 921679373)
+# puts client.widgets(:session => session).my_badges(:account_id => 921679373)
+# puts client.widgets(:session => session).my_badges(:account_id => 921679373)
+
 # puts client.widgets.ubar(921679373)
-# puts client.widgets.list_of_leaderboards(921679373)
-puts client.widgets.leaderboard(921679373, 226)
-puts client.widgets.leaderboard(921679373, 227)
-puts client.widgets.leaderboard(921679373, 228)
+
+# puts client.widgets.list_of_leaderboards(:account_id => 921679373)
+# puts client.widgets(:session => session).list_of_leaderboards(:account_id => 921679373)
+# puts client.widgets(:session => session).list_of_leaderboards(:account_id => 921679373)
+
+# puts client.widgets.leaderboard(:account_id => 921679373, :leaderboard_id => 226)
+# puts client.widgets(:session => session).leaderboard(:account_id => 921679373, :leaderboard_id => 226)
+# puts client.widgets(:session => session).leaderboard(:account_id => 921679373, :leaderboard_id => 226)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uboost-client
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday