badgeville 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,3 +1,8 @@
+* 0.0.7
+
+* support pagination and get all pages for rewards and rewards definitions
+* misc bug fixes
+
 * 0.0.6
 
 * change set player to use new players/info end point

data/README.md

@@ -1,4 +1,4 @@
-Nitro API
+Badgeville API
 ============
 
 Client for Badgeville API http://rules.badgeville.com/

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/badgeville.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{badgeville}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gilad Buchman"]
-  s.date = %q{2011-10-10}
+  s.date = %q{2011-11-30}
   s.description = %q{Client for Badgeville's Core API v2. http://rules.badgeville.com}
   s.extra_rdoc_files = [
     "README.md"
@@ -45,24 +45,24 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end
 end

data/lib/badgeville.rb

@@ -6,8 +6,8 @@ require 'badgeville/reward'
 
 module Badgeville
   TIMEOUT_SECS = 3
-  HOST = "sandbox.v2.badgeville.com"
-  PROTOCOL = "http"
+  HOST         = "sandbox.v2.badgeville.com"
+  PROTOCOL     = "http"
 
   class BadgevilleError < StandardError
     attr_accessor :code, :data
@@ -35,6 +35,7 @@ module Badgeville
       @host = opts['host'] || HOST
       @protocol = opts['protocol'] || PROTOCOL
       @user = email
+      @per_page = opts['per_page']
     end
 
     def log_activity(activity, opts={})
@@ -58,15 +59,15 @@ module Badgeville
     end
 
     def count_activities(opts={})
-      response = make_call(:get, :activities, opts)
+      response = make_call(:get, :activities, opts.merge(:include_totals => true))
       response["paging"]["total_entries"].to_i
     end
 
     def reward_definitions
       unless @reward_definitions
-        response = make_call(:get, :reward_definitions)
-        @reward_definitions = response["data"].map do |reward_json|
-          Reward.new(reward_json)
+        pages = all_pages_for(:reward_definitions)
+        @reward_definitions = pages.inject([]) do |definitions, page|
+          definitions += rewards_from_response(page)
         end
       end
       @reward_definitions
@@ -74,9 +75,9 @@ module Badgeville
 
     def get_rewards
       begin
-        response = make_call(:get, :rewards)
-        response["data"].map do |reward_json|
-          Reward.new(reward_json)
+        pages = all_pages_for(:rewards)
+        pages.inject([]) do |rewards, page|
+          rewards += rewards_from_response(page)
         end
       rescue BadgevilleError => e
         raise e unless e.code == 404
@@ -166,6 +167,9 @@ module Badgeville
       begin
         case method
         when :get
+          unless @per_page.nil? || params.has_key?(:per_page)
+            params[:per_page] = @per_page
+          end
           response = session[end_point].send(method, :params => params)
         when :post, :put, :delete
           response = session[end_point].send(method, to_query(params))
@@ -193,5 +197,33 @@ module Badgeville
     def to_query params
       URI.escape(params.map { |k,v| "#{k.to_s}=#{v.to_s}" }.join("&"))
     end
+
+    def rewards_from_response(response)
+      response["data"].map do |reward_json|
+        Reward.new(reward_json)
+      end
+    end
+
+    def get_page(action, page, params={})
+      make_call(:get, action, params.merge(page: page))
+    end
+
+    def all_pages_for(action, params={})
+      pages = []
+      current_page = 1
+      total_pages = nil
+      while total_pages.nil? || current_page <= total_pages
+        params[:include_totals] = true unless total_pages
+        response  = get_page(:reward_definitions, current_page, params)
+        pages << response
+        if response["paging"]
+          current_page = response["paging"]["current_page"].to_i + 1
+          total_pages = response["paging"]["total_pages"].to_i if total_pages.nil?
+        else
+          total_pages = 0
+        end
+      end
+      pages
+    end
   end
 end

data/lib/badgeville/reward.rb

@@ -2,10 +2,12 @@
 module Badgeville
   class Reward
     include Badgeville::Helpers
-    attr_accessor :name, :hint, :image_url, :active, :earned_at, :id
+    attr_accessor :name, :hint, :active, :earned_at, :id, :message
     attr_accessor :verb, :threshold, :tags, :definition_id
 
-#  example: 
+    attr_writer :image_url
+
+#  example:
 #  {
 #    "name": "A Way with Words",
 #    "active_start_at": null,
@@ -29,7 +31,8 @@ module Badgeville
 #    "assignable": false,
 #    "allow_duplicates": false,
 #    "site_id": "4e4d5bf5c47eed25a0000e8f",
-#    "active": true
+#    "active": true,
+#    "message": "You won the internet!"
 #   }
     def initialize(json=nil)
       if json
@@ -42,18 +45,25 @@ module Badgeville
       end
     end
 
+    def image_url(format = :original)
+      @image_url.sub('original', format.to_s)
+    end
+
+    # <b>DEPRECATED:</b> Please use <tt>image_url('grayscale')</tt> instead.
     def grayscale_url
-      @image_url.sub('original.png', 'grayscale.png')
+      warn "[DEPRECATION] `grayscale_url` is deprecated.  Please use `image_url(:grayscale)` instead."
+      image_url(:grayscale)
     end
 
     private
 
     def init_from(json)
-      @name = json["name"]
-      @active = json["active"]
-      @hint = json["hint"]
-      @image_url = json["image_url"]
+      ['name', 'active', 'hint', 'image_url', 'message'].each do |key|
+        send("#{key}=", json[key])
+      end
+
       @id = @definition_id = json["_id"]
+
       if json["data"] && json["type"] == "achievement"
         @verb = json["data"]["verb"]
         @threshold = json["data"]["threshold"].to_i

data/spec/badgeville_spec.rb

@@ -86,13 +86,13 @@ describe Badgeville do
     before do
       site = "example.com"
       base_url = "http://#{Badgeville::HOST}/api/berlin/api_key/activities.json"
-      total_url = base_url + "?site=#{site}&user=#{@user}"
+      total_url = base_url + "?include_totals=true&site=#{site}&user=#{@user}"
       @total_count = 2
       total_response = {"data" => [],
         "paging" => {"total_entries" => @total_count}}
       stub_http_request(:get, total_url).to_return(:body => total_response.to_json)
       @verb_count = 1
-      verb_url = base_url + "?site=#{site}&user=#{@user}&verb=verb"
+      verb_url = base_url + "?include_totals=true&site=#{site}&user=#{@user}&verb=verb"
       verb_response = {"data" => [],
         "paging" => {"total_entries" => @verb_count}}
       stub_http_request(:get, verb_url).
@@ -111,15 +111,32 @@ describe Badgeville do
   describe "#reward_definitions" do
     before do
       @url = /http:\/\/#{Badgeville::HOST}.*reward_definitions.json.*user=#{@user}.*/
-      mock_rewards = {"data" => [{"name" => "Big Bang"}]}
-      stub_http_request(:get, @url).to_return(:body => mock_rewards.to_json)
+      rewards_on_first_page = {
+        "data" => [{"name" => "Big Bang"}],
+        "paging" => {"current_page" => 1,"total_pages" => 2}
+      }
+      rewards_on_second_page = {
+        "data" => [{"name" => "Small Bang"}],
+        "paging" => {"current_page" => 2,"total_pages" => 2}
+      }
+
+      stub_http_request(:get, @url).to_return(
+        {:body => rewards_on_first_page.to_json},
+        {:body => rewards_on_second_page.to_json}
+      )
+
       @rewards = @badgeville.reward_definitions
     end
 
-    it "should return an array of rewards" do
+    it "should return an array of all rewards" do
       @rewards.class.should be(Array)
+      @rewards.count.should == 2
+
       @rewards.first.class.should be(Badgeville::Reward)
       @rewards.first.name.should == "Big Bang"
+
+      @rewards[1].class.should be(Badgeville::Reward)
+      @rewards[1].name.should == "Small Bang"
     end
   end
 

data/spec/reward_spec.rb

@@ -12,7 +12,7 @@ describe Badgeville::Reward do
       "threshold": 2
     },
     "created_at": "2011-08-18T22:55:03-07:00",
-    "image_url": "http://s3.amazonaws.com/badgeville-production-reward-definitions/images/someid/original.png?1313733302",
+    "image_url": "http://s3.amazon.com/original.png?1",
     "components": "[{\"command\":\"count\",\"comparator\":{\"$gte\":2},\"config\":{},\"where\":{\"verb\":\"commented\",\"player_id\":\"%player_id\"}}]",
     "reward_template": {
       "message": ""
@@ -26,7 +26,8 @@ describe Badgeville::Reward do
     "assignable": false,
     "allow_duplicates": false,
     "site_id": "4e4d5bf5c47eed25a0000e8f",
-    "active": true
+    "active": true,
+    "message": "You won the internet!"
    }')
   end
 
@@ -37,15 +38,23 @@ describe Badgeville::Reward do
 
     it "initialize based on json" do
       @reward.name.should == "A Way with Words"
-      @reward.image_url.should =~ /original.png/
       @reward.active.should be_true
       @reward.id.should == "4e4dfab6c47eed727b005c38"
       @reward.tags.should == []
       @reward.definition_id.should == '4e4dfab6c47eed727b005c38'
+      @reward.message.should == 'You won the internet!'
     end
 
-    it "has an grayscale image" do
-      @reward.grayscale_url.should == @reward.image_url.sub('original','grayscale')
+    describe "image_url" do
+      it "returns the original url by default" do
+        @reward.image_url.should == 'http://s3.amazon.com/original.png?1'
+      end
+
+      it "allows to request specific formats" do
+        [:original, :large, :medium, :grayscale, :grayscale_small].each do |format|
+          @reward.image_url(format).should == "http://s3.amazon.com/#{format}.png?1"
+        end
+      end
     end
 
     context "has one tag" do
@@ -82,6 +91,7 @@ describe Badgeville::Reward do
       @reward.earned_at.iso8601.should == Time.parse(@parsed_json["created_at"]).iso8601
       @reward.id.should == "new_id"
       @reward.definition_id.should == '4e4dfab6c47eed727b005c38'
+      @reward.message.should == 'You won the internet!'
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badgeville
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-15 00:00:00.000000000 -08:00
+date: 2011-11-30 00:00:00.000000000 -08:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2152997400 !ruby/object:Gem::Requirement
+  requirement: &2160373920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152997400
+  version_requirements: *2160373920
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2152996920 !ruby/object:Gem::Requirement
+  requirement: &2160372140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152996920
+  version_requirements: *2160372140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152996440 !ruby/object:Gem::Requirement
+  requirement: &2160370280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152996440
+  version_requirements: *2160370280
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152995960 !ruby/object:Gem::Requirement
+  requirement: &2160368540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152995960
+  version_requirements: *2160368540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2152995480 !ruby/object:Gem::Requirement
+  requirement: &2160363980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152995480
+  version_requirements: *2160363980
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2152995000 !ruby/object:Gem::Requirement
+  requirement: &2160362220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152995000
+  version_requirements: *2160362220
 description: Client for Badgeville's Core API v2. http://rules.badgeville.com
 email: 
 executables: []
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1071652726597665833
+      hash: 4192287598569772720
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: