badgeville 0.0.1 → 0.0.2

data/README.md

@@ -23,6 +23,23 @@ badgeville = Badgeville::Client.new(email, settings)
 badgeville.log_activity "commented"
 ```
 
+* get all logged activities
+
+```ruby
+badgeville.get_activities
+```
+
+* get list of reward definitions
+
+```ruby
+badgeville.reward_definitions
+```
+
+* manually award some reward
+```ruby
+badgeville.award "Best User"
+```
+
 Installing
 ----------
  1) add to your Gemfile

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/badgeville.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{badgeville}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gilad Buchman"]
+  s.date = %q{2011-09-06}
+  s.description = %q{Client for Badgeville's Core API v2. http://rules.badgeville.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "badgeville.gemspec",
+    "examples/log_and_check_status.rb",
+    "keys.json.example",
+    "lib/badgeville.rb",
+    "lib/badgeville/activity.rb",
+    "lib/badgeville/reward.rb",
+    "spec/badgeville_spec.rb",
+    "spec/reward_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/Keasinc/badgeville}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Client for Badgeville's Core API}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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<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<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<rcov>, [">= 0"])
+  end
+end
+

data/examples/log_and_check_status.rb

@@ -4,6 +4,15 @@ require 'badgeville'
 require 'pp'
 
 settings = JSON.parse(File.read('keys.json'))
-badgeville = Badgeville::Client.new('4@keas.com', settings)
+badgeville = Badgeville::Client.new('me@example.com', settings)
+
+pp badgeville.reward_definitions #all defined definitions for site
 
 pp badgeville.log_activity "commented"
+
+pp badgeville.log_activity "join_team", :team => "myteam"
+
+pp badgeville.get_activities
+pp badgeville.get_rewards #earned for user
+
+badgeville.award "Best User Ever"

data/lib/badgeville.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'rest_client'
 require 'badgeville/activity'
+require 'badgeville/reward'
 
 module Badgeville
   TIMEOUT = 1000
@@ -16,6 +17,7 @@ module Badgeville
   end
 
   class Client
+    attr_accessor :user, :site, :player_id, :site_id
 
     def initialize (email, opts={})
       # Required Parameters
@@ -31,10 +33,88 @@ module Badgeville
       params = {
         "activity[verb]" => activity,
       }
+      opts.inject(params) do |params, entry|
+        k, v = entry
+        params["activity[#{k.to_s}]"] = v
+        params
+      end
       response = make_call(:post, :activities, params)
       Activity.new(response)
     end
 
+    def get_activities
+      response = make_call(:get, :activities)
+      response["data"].inject([]) do |activities, activity_json|
+        activities<< Activity.new(activity_json)
+        activities
+      end
+    end
+
+    def reward_definitions
+      unless @reward_definitions
+        response = make_call(:get, :reward_definitions)
+        @reward_definitions = response["data"].inject([]) do
+          |rewards, reward_json|
+          rewards<< Reward.new(reward_json)
+          rewards
+        end
+      end
+      @reward_definitions
+    end
+
+    def get_rewards
+      response = make_call(:get, :rewards)
+      response["data"].inject([]) do |rewards, reward_json|
+        rewards<< Reward.new(reward_json)
+        rewards
+      end
+    end
+
+    def award reward_name
+      reward = reward_definitions.select do |reward|
+        reward.name == reward_name
+      end.first
+      params = {
+        'reward[player_id]' => player_id,
+        'reward[site_id]' => site_id,
+        'reward[definition_id]' => reward.id,
+      }
+      make_call(:post, :rewards, params)
+    end
+
+    def set_player
+      end_point = "#{@site}/players/#{@user}.json"
+      begin
+        response = session[end_point].get
+        data = response.body
+        json = JSON.parse(data)
+        json = json["data"]
+        @player_id = json["id"]
+        @site_id = json["site_id"]
+      rescue => e
+        if e.respond_to? :response
+          data = JSON.parse(e.response)
+          raise BadgevilleError.new(e.code, data["error"])
+        else
+          raise e
+        end
+      end
+    end
+
+    def site_id
+      unless @site_id
+        set_player
+      end
+      @site_id
+    end
+
+    def player_id
+      unless @player_id
+        set_player
+      end
+      @player_id
+    end
+
     private
 
     def valid_response?(obj)
@@ -53,11 +133,18 @@ module Badgeville
       @session
     end
 
-    def make_call(method, action, params)
+    def make_call(method, action, params={})
       end_point = "#{action.to_s}.json"
-      params.merge!(:user => @user, :site => @site)
+      unless params.keys.any? { |k| k =~ /player_id/ }
+        params.merge!(:user => @user, :site => @site)
+      end
       begin
-        response = session[end_point].send(method, to_query(params))
+        case method
+        when :get
+          response = session[end_point].send(method, :params => params)
+        when :post, :put, :delete
+          response = session[end_point].send(method, to_query(params))
+        end
         data = response.body
         json = JSON.parse(data)
       rescue => e

data/lib/badgeville/activity.rb

@@ -5,14 +5,21 @@ module Badgeville
   class Activity
     attr_accessor :verb, :player_id, :user_id, :points, :rewards, :created_at, :meta
 
-    def initialize(json)
-      @verb = json.delete("verb")
-      @player_id = json.delete("player_id")
-      @user_id = json.delete("user_id")
-      @points = json.delete("points").to_i
-      @created_at = DateTime.parse(json.delete("created_at")).to_time
-      @rewards = json.delete("rewards").inject([]) do |rewards, award|
-        rewards << Reward.new(award["definition"])
+    def initialize(json=nil)
+      if json
+        @verb = json.delete("verb")
+        @player_id = json.delete("player_id")
+        @user_id = json.delete("user_id")
+        @points = json.delete("points").to_i
+        @created_at = DateTime.parse(json.delete("created_at")).to_time
+        @rewards = json.delete("rewards").inject([]) do |rewards, award|
+          rewards << Reward.new(award["definition"])
+        end
+        @meta = json.inject({}) do |meta, entry|
+          k,v = entry
+          meta[k.to_sym] = v
+          meta
+        end
       end
     end
   end

data/lib/badgeville/reward.rb

@@ -1,7 +1,6 @@
 module Badgeville
   class Reward
-    attr_accessor :name, :hint, :image_url, :active
-  end
+    attr_accessor :name, :hint, :image_url, :active, :earned_at, :id
 
 #  example: 
 #  {
@@ -13,7 +12,7 @@ module Badgeville
 #      "threshold": 2
 #    },
 #    "created_at": "2011-08-18T22:55:03-07:00",
-#    "image_url": "http://s3.amazonaws.com/badgeville-production-reward-definitions/images/4e4dfab6c47eed727b005c38/original.png?1313733302",
+#    "image_url": "http://s3.amazonaws.com/badgeville-production-reward-definitions/images/original.png?1313733302",
 #    "components": "[{\"command\":\"count\",\"comparator\":{\"$gte\":2},\"config\":{},\"where\":{\"verb\":\"commented\",\"player_id\":\"%player_id\"}}]",
 #    "reward_template": {
 #      "message": ""
@@ -29,10 +28,28 @@ module Badgeville
 #    "site_id": "4e4d5bf5c47eed25a0000e8f",
 #    "active": true
 #   }
-  def initialize(json)
-    @name = json["name"]
-    @active = json["active"]
-    @hint = json["hint"]
-    @image_url = json["image_url"]
+    def initialize(json=nil)
+      if json
+        reward_definition = json["definition"]
+        reward_definition ? init_from(reward_definition) : init_from(json)
+        if json.has_key?('user_id') # it's an earned reward for a specific user
+          @earned_at = DateTime.parse(json["created_at"]).to_time
+        end
+      end
+    end
+
+    def grayscale_url
+      @image_url.sub('original.png', 'grayscale.png')
+    end
+
+    private
+
+    def init_from(json)
+      @name = json["name"]
+      @active = json["active"]
+      @hint = json["hint"]
+      @image_url = json["image_url"]
+      @id = json["_id"]
+    end
   end
 end

data/spec/badgeville_spec.rb

@@ -9,29 +9,100 @@ describe Badgeville do
 
   describe "#log_activity" do
     before do
-      action_name = "action"
-      @result = {"verb" => "commented",
+      @action_name = "commented"
+      @url = "http://" + Badgeville::HOST + ".*activities.json"
+      @result = {"verb" => @action_name,
         "created_at" => "2011-08-30T12:27:47-07:00",
         "points" => 0,
         "player_id" => "4e5d3992c47eed202d00148c",
         "user_id" => "4e5d3992c47eed202d00148b",
         "rewards" =>[]
       }
+      @body = "activity[verb]=#{@action_name}"
+      @user_data = "&user=#{@user}&site=example.com"
+    end
 
-      body = "activity[verb]=#{action_name}&user=#{@user}&site=example.com"
-      url = "http://" + Badgeville::HOST + ".*activities.json"
+    context "when no meta data" do
+      before do
+        @body += @user_data
+        stub_http_request(:post, Regexp.new(@url)).with(:body => @body).
+          to_return(:body => @result.to_json)
+        @activity =  @badgeville.log_activity @action_name
+      end
 
-      stub_http_request(:post, Regexp.new(url)).with(:body => body).
-        to_return(:body => @result.to_json)
+      it "returns an activity object" do
+        @activity.is_a? Badgeville::Activity
+      end
 
-      @activity =  @badgeville.log_activity action_name
+      it "parses response from activity record api call" do
+        @activity.verb.should == "commented"
+        @activity.created_at.iso8601.should == @result["created_at"]
+        @activity.points.should == 0
+        @activity.rewards.should be_empty
+        @activity.meta.should be_empty
+      end
     end
 
-    it "parses response from activity record api call" do
-      @activity.verb.should == "commented"
-      @activity.created_at.iso8601.should == @result["created_at"]
-      @activity.points.should == 0
-      @activity.rewards.should be_empty
+    context "with meta data" do
+      before do
+        @team = "myteam"
+        @result["team"] = @team
+        @body += "&activity[team]=#{@team}" + @user_data
+
+        stub_http_request(:post, Regexp.new(@url)).with(:body => @body).
+          to_return(:body => @result.to_json)
+        @activity =  @badgeville.log_activity @action_name, :team => @team
+      end
+
+      it "parses the meta data as well" do
+        @activity.meta[:team] = @team
+      end
     end
   end
+
+  describe "#get_activities" do
+    before do
+      @url = /http:\/\/#{Badgeville::HOST}.*activities.json.*user=#{@user}.*/
+      mock_activities = { 
+        "data" => [
+                   {
+                     "verb" => "join_team",
+                     "created_at" => "2011-09-01T14:12:13-07:00",
+                     "rewards" => []
+                   }
+                  ]
+      }
+      stub_http_request(:get, @url).to_return(:body => mock_activities.to_json)
+      @activities = @badgeville.get_activities
+    end
+
+    it "should return an array of activities" do
+      @activities.class.should be(Array)
+      @activities.first.class.should be(Badgeville::Activity)
+    end
+  end
+
+  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 = @badgeville.reward_definitions
+    end
+
+    it "should return an array of rewards" do
+      @rewards.class.should be(Array)
+      @rewards.first.class.should be(Badgeville::Reward)
+    end
+  end
+
+  describe "#set_player" do
+    before do
+      @url = /http:\/\/#{Badgeville::HOST}.*example.com\/players\/#{@user}\.json.*/
+      stub_http_request(:get, @url).to_return(:body => {"data" => {"id" => "1", "site_id" => "site"}}.to_json)
+    end
+
+    it {@badgeville.player_id.should == "1"}
+    it {@badgeville.site_id.should == "site"}
+  end
 end

data/spec/reward_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'json'
+
+describe Badgeville::Reward do
+  before do
+    @parsed_json = JSON.parse('{
+    "name": "A Way with Words",
+    "active_start_at": null,
+    "image_file_name": "9fQ2IU6-0.ftbs4fsoogp3c8fr.png",
+    "data": {
+      "verb": "commented",
+      "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",
+    "components": "[{\"command\":\"count\",\"comparator\":{\"$gte\":2},\"config\":{},\"where\":{\"verb\":\"commented\",\"player_id\":\"%player_id\"}}]",
+    "reward_template": {
+      "message": ""
+    },
+      "_id": "4e4dfab6c47eed727b005c38",
+    "tags": null,
+    "id": "4e4dfab6c47eed727b005c38",
+    "active_end_at": null,
+    "type": "achievement",
+    "hint": "Reply to 25 Comments",
+    "assignable": false,
+    "allow_duplicates": false,
+    "site_id": "4e4d5bf5c47eed25a0000e8f",
+    "active": true
+   }')
+  end
+
+  context "when json is a reward definition" do
+    before do
+      @reward = Badgeville::Reward.new(@parsed_json)
+    end
+
+    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"
+    end
+
+    it "has an grayscale image" do
+      @reward.grayscale_url.should == @reward.image_url.sub('original','grayscale')
+    end
+  end
+
+  context "when json is a reward earned by user" do
+    before do
+      @parsed_json = {"user_id" => "1", 
+        "created_at" => "2011-08-18T22:55:03-07:00",
+        "definition" => @parsed_json}
+      @reward = Badgeville::Reward.new(@parsed_json)
+    end
+
+    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.earned_at.iso8601.should == @parsed_json["created_at"]
+      @reward.id.should == "4e4dfab6c47eed727b005c38"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badgeville
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-30 00:00:00.000000000 -07:00
+date: 2011-09-06 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2160484700 !ruby/object:Gem::Requirement
+  requirement: &2156516220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160484700
+  version_requirements: *2156516220
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2160483340 !ruby/object:Gem::Requirement
+  requirement: &2156515140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160483340
+  version_requirements: *2156515140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160482360 !ruby/object:Gem::Requirement
+  requirement: &2156514580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2160482360
+  version_requirements: *2156514580
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160481280 !ruby/object:Gem::Requirement
+  requirement: &2156513980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2160481280
+  version_requirements: *2156513980
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2160480100 !ruby/object:Gem::Requirement
+  requirement: &2156512980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2160480100
+  version_requirements: *2156512980
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2160479240 !ruby/object:Gem::Requirement
+  requirement: &2156511560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160479240
+  version_requirements: *2156511560
 description: Client for Badgeville's Core API v2. http://rules.badgeville.com
 email: 
 executables: []
@@ -91,12 +91,14 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- badgeville.gemspec
 - examples/log_and_check_status.rb
 - keys.json.example
 - lib/badgeville.rb
 - lib/badgeville/activity.rb
 - lib/badgeville/reward.rb
 - spec/badgeville_spec.rb
+- spec/reward_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/Keasinc/badgeville
@@ -114,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -517773847151955177
+      hash: -3222885892070570977
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: