badgeville 0.0.5 → 0.0.6

data/CHANGELOG

@@ -1,3 +1,9 @@
+* 0.0.6
+
+* change set player to use new players/info end point
+* add delete method for earned rewards
+* add definition_id to reward
+
 * 0.0.5
 
 * set default timeout to 3s

data/Gemfile

@@ -8,9 +8,9 @@ gem 'rest-client'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
+  gem "rspec"
+  gem "bundler"
+  gem "jeweler"
   gem "rcov", ">= 0"
 end
 

data/Gemfile.lock

@@ -2,28 +2,28 @@ GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.2.6)
-    crack (0.1.8)
-    diff-lcs (1.1.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
     git (1.2.5)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.5.3)
-    mime-types (1.16)
-    rake (0.8.7)
-    rcov (0.9.9)
-    rest-client (1.6.1)
+    json (1.6.1)
+    mime-types (1.17.2)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    webmock (1.6.4)
+    rspec-mocks (2.7.0)
+    webmock (1.7.7)
       addressable (~> 2.2, > 2.2.5)
       crack (>= 0.1.7)
 
@@ -31,10 +31,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.4)
+  bundler
+  jeweler
   json
   rcov
   rest-client
-  rspec (~> 2.3.0)
+  rspec
   webmock

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/badgeville.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gilad Buchman"]
-  s.date = %q{2011-10-07}
+  s.date = %q{2011-10-10}
   s.description = %q{Client for Badgeville's Core API v2. http://rules.badgeville.com}
   s.extra_rdoc_files = [
     "README.md"

data/examples/log_and_check_status.rb

@@ -20,4 +20,6 @@ pp badgeville.count_activities :verb => "junk"
 
 pp badgeville.get_rewards #earned for user
 
-badgeville.award "Best User Ever"
+#award and delete rewards
+reward = badgeville.award "The First Step"
+badgeville.delete reward

data/lib/badgeville/reward.rb

@@ -3,7 +3,7 @@ module Badgeville
   class Reward
     include Badgeville::Helpers
     attr_accessor :name, :hint, :image_url, :active, :earned_at, :id
-    attr_accessor :verb, :threshold, :tags
+    attr_accessor :verb, :threshold, :tags, :definition_id
 
 #  example: 
 #  {
@@ -37,6 +37,7 @@ module Badgeville
         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
+          @id = json["id"]
         end
       end
     end
@@ -52,7 +53,7 @@ module Badgeville
       @active = json["active"]
       @hint = json["hint"]
       @image_url = json["image_url"]
-      @id = json["_id"]
+      @id = @definition_id = json["_id"]
       if json["data"] && json["type"] == "achievement"
         @verb = json["data"]["verb"]
         @threshold = json["data"]["threshold"].to_i

data/lib/badgeville.rb

@@ -10,16 +10,16 @@ module Badgeville
   PROTOCOL = "http"
 
   class BadgevilleError < StandardError
-    attr_accessor :code
+    attr_accessor :code, :data
 
-    def initialize (err_code=nil, error_msg="")
-      super error_msg
-      @message = error_msg
+    def initialize (err_code=nil, error_data="")
+      super error_data.to_s
+      @data = error_data
       @code = err_code
     end
 
     def to_s
-      "ERROR #{@code} : #{@message}"
+      "ERROR #{@code} : #{@data}"
     end
   end
 
@@ -96,11 +96,24 @@ module Badgeville
       Reward.new(make_call(:post, :rewards, params))
     end
 
+    def delete reward
+      if reward.respond_to?(:earned_at) && reward.earned_at
+        end_point = "rewards/#{reward.id}.json"
+        begin
+          !!session[end_point].delete
+        rescue => e
+          raise BadgevilleError.new(e.http_code, e.message)
+        end
+      else
+        raise BadgevilleError.new(nil, "can only remove earned rewards. a #{reward.to_json} was given")
+      end
+    end
+
     def set_player
-      end_point = "#{@site}/players/info.json"
+      end_point = "/players/info.json"
       begin
         response = session[end_point].get(:params =>
-                                          {:user => @user, :site => @site})
+                                          {:email => @user, :site => @site})
         data = response.body
         json = JSON.parse(data)
         json = json["data"]
@@ -116,10 +129,6 @@ module Badgeville
       end
     end
 
-    def timeout
-      @timeout
-    end
-
     def site_id
       unless @site_id
         set_player
@@ -143,7 +152,8 @@ module Badgeville
     def session
       if @session.nil?
         base_url = "#{@protocol}://#{@host}/api/berlin/#{@private_key}"
-        @session = RestClient::Resource.new base_url, :timeout => @timeout
+        @session = RestClient::Resource.new base_url,
+          :timeout => @timeout, :open_timeout => @timeout
       end
       @session
     end
@@ -166,9 +176,13 @@ module Badgeville
         if e.respond_to? :response
           begin
             data = JSON.parse(e.response)
+            data.merge!(:params => params,
+                        :end_point => end_point,
+                        :method => method)
             raise BadgevilleError.new(e.http_code, data)
           rescue TypeError, JSON::ParserError
-            raise BadgevilleError.new(e.http_code, e.message)
+            msg = "#{e.message} on #{method} #{end_point}: #{params}"
+            raise BadgevilleError.new(e.http_code, msg)
           end
         else
           raise e

data/spec/badgeville_spec.rb

@@ -36,7 +36,7 @@ describe Badgeville do
 
       it "parses response from activity record api call" do
         @activity.verb.should == "commented"
-        @activity.created_at.iso8601.should == @result["created_at"]
+        @activity.created_at.iso8601.should == Time.parse(@result["created_at"]).iso8601
         @activity.points.should == 0
         @activity.rewards.should be_empty
         @activity.meta.should be_empty
@@ -123,9 +123,43 @@ describe Badgeville do
     end
   end
 
+  describe "#delete" do
+    before do
+      @mock_reward = Badgeville::Reward.new
+      @mock_reward.id = 5
+      @mock_reward.earned_at = Time.now
+      @url = /http:\/\/#{Badgeville::HOST}.*rewards\/5.json/
+      stub_http_request(:delete, @url).to_return(:status => 200)
+    end
+
+    it "succeed for an earned reward" do
+      @badgeville.delete(@mock_reward).should be_true
+    end
+
+    it "fails for an un-earned reward (reward definition)" do
+      @mock_reward.earned_at = nil
+      lambda {
+        @badgeville.delete(@mock_reward)
+      }.should raise_error(Badgeville::BadgevilleError)
+    end
+
+    it "fails for non reward object" do
+      lambda {
+        @badgeville.delete(nil)
+      }.should raise_error(Badgeville::BadgevilleError)
+    end
+
+    it "handles response error codes" do
+      stub_http_request(:delete, @url).to_return(:status => 500)
+      lambda {
+        @badgeville.delete(@mock_reward)
+      }.should raise_error(Badgeville::BadgevilleError)
+    end
+  end
+
   describe "#set_player" do
     before do
-      @url = /http:\/\/#{Badgeville::HOST}.*example.com\/players\/info\.json.*user=#{@user}.*/
+      @url = /http:\/\/#{Badgeville::HOST}.*\/players\/info\.json.*email=#{@user}.*/
       stub_http_request(:get, @url).to_return(:body => {"data" => {"id" => "1", "site_id" => "site"}}.to_json)
     end
 

data/spec/reward_spec.rb

@@ -17,7 +17,7 @@ describe Badgeville::Reward do
     "reward_template": {
       "message": ""
     },
-      "_id": "4e4dfab6c47eed727b005c38",
+    "_id": "4e4dfab6c47eed727b005c38",
     "tags": null,
     "id": "4e4dfab6c47eed727b005c38",
     "active_end_at": null,
@@ -41,6 +41,7 @@ describe Badgeville::Reward do
       @reward.active.should be_true
       @reward.id.should == "4e4dfab6c47eed727b005c38"
       @reward.tags.should == []
+      @reward.definition_id.should == '4e4dfab6c47eed727b005c38'
     end
 
     it "has an grayscale image" do
@@ -68,7 +69,7 @@ describe Badgeville::Reward do
 
   context "when json is a reward earned by user" do
     before do
-      @parsed_json = {"user_id" => "1", 
+      @parsed_json = {"user_id" => "1", "id" => "new_id",
         "created_at" => "2011-08-18T22:55:03-07:00",
         "definition" => @parsed_json}
       @reward = Badgeville::Reward.new(@parsed_json)
@@ -78,8 +79,9 @@ describe Badgeville::Reward 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"
+      @reward.earned_at.iso8601.should == Time.parse(@parsed_json["created_at"]).iso8601
+      @reward.id.should == "new_id"
+      @reward.definition_id.should == '4e4dfab6c47eed727b005c38'
     end
   end
 
@@ -88,7 +90,7 @@ describe Badgeville::Reward do
       @reward = Badgeville::Reward.new(@parsed_json)
     end
 
-    it "has verb adn threshold accessors" do
+    it "has verb and threshold accessors" do
       @reward.verb.should == "commented"
       @reward.threshold.should == 2
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badgeville
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-10 00:00:00.000000000 -07:00
+date: 2011-11-15 00:00:00.000000000 -08:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2160449300 !ruby/object:Gem::Requirement
+  requirement: &2152997400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160449300
+  version_requirements: *2152997400
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2160448300 !ruby/object:Gem::Requirement
+  requirement: &2152996920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,43 +33,43 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160448300
+  version_requirements: *2152996920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160447640 !ruby/object:Gem::Requirement
+  requirement: &2152996440 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160447640
+  version_requirements: *2152996440
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160447000 !ruby/object:Gem::Requirement
+  requirement: &2152995960 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160447000
+  version_requirements: *2152995960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2160446280 !ruby/object:Gem::Requirement
+  requirement: &2152995480 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160446280
+  version_requirements: *2152995480
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2160445520 !ruby/object:Gem::Requirement
+  requirement: &2152995000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160445520
+  version_requirements: *2152995000
 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: 832478503767646954
+      hash: 1071652726597665833
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: