uboost-client 0.1.9 → 0.2.0

data/README.markdown

@@ -1,6 +1,6 @@
 # uBoost Client API
 
-This is the unofficial ruby client for uBoost API. It is a wrapper for the REST interface described at [https://github.com/chriskk/uBoost-API-v2](https://github.com/chriskk/uBoost-API-v2)
+This is the unofficial ruby client for uBoost API. It is a wrapper for the REST interface described at [https://github.com/uboost/uBoost-API-v2](https://github.com/uboost/uBoost-API-v2)
 
 ## Installing
 
@@ -43,7 +43,7 @@ response.message
 
 ### Account
 
-https://github.com/chriskk/uBoost-API-v2#accounts-api
+https://github.com/uboost/uBoost-API-v2#accounts-api
 
 ```ruby
 client.account.create({ "user_name" => "test_user_2" })
@@ -63,7 +63,7 @@ client.account.token(921679358)
 
 ### Points
 
-https://github.com/chriskk/uBoost-API-v2#points-api
+https://github.com/uboost/uBoost-API-v2#points-api
 
 ```ruby
 client.points.point_transactions_for_account(921679358)
@@ -75,7 +75,7 @@ client.points.add_points_to_account(921679359, 30, {:description => 'a descripti
 
 ### Badges
 
-https://github.com/chriskk/uBoost-API-v2#badges-api
+https://github.com/uboost/uBoost-API-v2#badges-api
 
 ```ruby
 client.badges.award(921679359, 1)
@@ -85,7 +85,16 @@ client.badges.unaward(921679359, 1)
 
 ### Widgets
 
-https://github.com/chriskk/uBoost-API-v2#widgets-api
+https://github.com/uboost/uBoost-API-v2#widgets-api
+
+Authentication for the Widgets API can be made by: sending in a student account's username and password, or have the gem automatically use SSO and cookies.
+
+```ruby
+# Use the student's username and password
+response = client.account.select(921679358)
+credentials = { credentials: { username: response.student["user_name"], password: response.student["password"]} }
+client.widgets(credentials).profile
+```
 
 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` that the uBoost API returns, to `:uboost_session_id` in the session object.
 
@@ -93,20 +102,23 @@ The widgets section can make use of a session store. Just pass a session object
 session = Hash.new # or a Ruby on Rails session, for example
 
 # No caching
-client.widgets.profile(:account_id => 921679373)  
+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.ubar(:account_id => 921679373)
+client.widgets.ubar(:account_id => 921679373) # ubar doesn't accept :session
 
 client.widgets.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.badge_categories(:account_id => 921679373)
+
+client.widgets.badges_for_category(:account_id => 921679373, :badge_category_id => 31)
+
+client.widgets.unearned_badges(:account_id => 921679373, :badge_category_id => 31)
 ```

data/lib/uboost-client/uboost_client.rb

@@ -233,9 +233,26 @@ module UboostClient
       OpenStruct.new(JSON.parse(response.body))
     end
 
+    def badge_categories(options = Hash.new)      
+      response = get(@url + '/badge_categories', options)
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def badges_for_category(options = Hash.new)
+      options = {:account_id => nil, :badge_category_id => nil}.merge(options)
+      response = get(@url + '/badge_categories/' + options[:badge_category_id].to_s + '/badges', options)
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
     def my_badges(options = Hash.new)
       options = {:account_id => nil, :badge_category_id => 'all'}.merge(options)
-      response = get(@url + '/badges/mine/' + options[:badge_category_id], options)
+      response = get(@url + '/badges/mine/' + options[:badge_category_id].to_s, options)
+      OpenStruct.new(JSON.parse(response.body))
+    end
+
+    def unearned_badges(options = Hash.new)
+      options = {:account_id => nil, :badge_category_id => nil}.merge(options)
+      response = get(@url + '/badges/unearned/' + options[:badge_category_id].to_s, options)
       OpenStruct.new(JSON.parse(response.body))
     end
 

data/lib/uboost-client/version.rb

@@ -1,3 +1,3 @@
 class UboostClient
-  VERSION = "0.1.9"  
+  VERSION = "0.2.0"  
 end

data/spec/simple_test.rb

@@ -15,25 +15,29 @@ client = UboostClient::Client.new(:subdomain => subdomain, :api_credentials => a
 # puts client.account.find(:external_id => '3253466')
 # puts client.account.token(921679358)
 # puts client.points.point_transactions_for_account(921679358)
+
 # puts client.account.points_transactions(921679358)
 # 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(: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(:account_id => 921679373)
+# puts client.widgets.ubar(:account_id => 921679373)
 
 # 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)
+
+# puts client.widgets.badge_categories(:account_id => 921679373)
+
+# puts client.widgets.badges_for_category(:account_id => 921679373, :badge_category_id => 31)
+
+# puts client.widgets.unearned_badges(:account_id => 921679373, :badge_category_id => 31)

metadata

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