badgeville_berlin 0.1.0

data/spec/use_case/readme_use_case_spec.rb

@@ -0,0 +1,262 @@
+require 'spec_helper'
+
+module BadgevilleBerlin
+  describe "README use case example set" do
+    before(:all) do
+      # Initializations
+      @rand1 = rand(5000)
+      @rand2 = rand(5000)
+      @my_network_id = '4d5dc61ed0c0b32b79000001'
+
+      # Set FakeWeb to allow a real connection to the Badgeville server as
+      # configured in spec_helper.rb
+      FakeWeb.allow_net_connect = true
+
+      # Configure the gem with the host site and the API Key
+      my_api_key     = "myapikey"
+      my_hostname = "http://myhostname.com"
+      Config.conf(:host_name => my_hostname, :api_key => my_api_key)
+
+      # Basic README: Create a new site
+      @new_site = Site.new(
+        :name       => "My Website #{@rand1}",
+        :url        => "mydomain#{@rand1}.com" ,
+        :network_id => @my_network_id )
+      @site_created = @new_site.save
+
+      # Basic README: Create a new user
+      @new_user = User.new(
+        :name       => "visitor#{@rand1}",
+        :network_id => @my_network_id,
+        :email      => "visitor#{@rand1}@emailserver.com",
+        :password   => 'visitor_password' )
+      @user_created = @new_user.save
+
+      # Basic README: See error messages from the remote server
+      @new_user2 = User.new(
+        :name       => "visitor#{@rand1}",
+        :network_id => @my_network_id,
+        :email      => "visitor#{@rand1}@emailserver.com",
+        :password   => 'visitor_password' )
+      @user_creation_failed = @new_user2.save
+      @attr_specific_err = @new_user2.errors[:email]
+
+      # Basic README: Create a player
+      @new_player = Player.new(
+        :site_id      => @new_site.id,
+        :user_id      => @new_user.id ,
+        :display_name => "Visitor #{@rand1}" )
+      @player_created = @new_player.save
+
+      # Advanced README: Create an activity (register a behavior 'share') for the newly created player
+      @share_activity = Activity.new(
+        :verb      => "share",
+        :player_id => @new_player.id )
+      @share_activity_created = @share_activity.save
+
+      # Advanced README: Create an activity definition to specify that a player will earn 4
+      # points each time they perform the "comment" behavior.
+      @new_activity_definition = ActivityDefinition.new(
+        :selector => '{"verb":"comment"}',
+        :name => "A Cool Comment Behavior #{@rand1}",
+        :site_id => @new_site.id,
+        :adjustment => '{"points":4}'
+        )
+      @new_activity_defn_created = @new_activity_definition.save
+
+      # Advanced README: Update the activity definition such that a player
+      # on your site will earn 3 points rather than 4 each time they
+      # perform the "comment" behavior.
+      @new_activity_definition.adjustment.points = 3
+      @new_activity_defn_updated = @new_activity_definition.save
+
+       # Advanced README: Update the activity definition to include a rate
+       # limit in order to prevent players from gaming the system.
+       @new_activity_definition.enable_rate_limiting = true
+       @new_activity_definition.bucket_drain_rate = 180
+       @new_activity_definition.bucket_max_capacity = 25
+       @new_activity_defn_updated_again = @new_activity_definition.save
+
+       # Advanced README: Create a reward definition
+       @new_reward_defn = RewardDefinition.new(
+        :site_id          => @new_site.id,
+        :name             => 'Comment Rockstar',
+        :reward_template  => '{"message":"Congrats, you are a Comment Rockstar!"}',
+        :components       => '[{"comparator":{"$gte":1},"where":{"verb":"comment","player_id":"%player_id"},"command":"count"}]',
+        :active           => true )
+       @new_reward_defn_created = @new_reward_defn.save
+
+       # Advanced README: Register a player behavior (e.g. comment) for an
+       # existing player.
+       @comment_activity = Activity.new(
+         :verb      => "comment",
+         :player_id => @new_player.id )
+       @comment_activity_created = @comment_activity.save
+
+    end
+
+    # CREATE Site
+    it "should have created a new site", :affects_bv_server => true do
+      @site_created.should == true
+    end
+
+    it "should have a new site with the name:  My Website #{@rand1}", :affects_bv_server => true do
+      @new_site.name.should == "My Website #{@rand1}"
+    end
+
+    # CREATE User
+    it "should have created a new user", :affects_bv_server => true do
+      @user_created.should == true
+    end
+
+    it "should have a new user with the name: visitor#{@rand1}", :affects_bv_server => true do
+      @new_user.name.should == "visitor#{@rand1}"
+    end
+
+    # CREATE User: See remote errors
+    it "should produce an error message from the remote server", :affects_bv_server => true do
+      @new_user2.errors.messages.should == {:email=>["user email is already taken"]}
+    end
+
+    it "should produce anattribute-specific error message from the remote server", :affects_bv_server => true do
+      @attr_specific_err.should == ["user email is already taken"]
+    end
+
+    # CREATE Player
+    it "should have created a new player", :affects_bv_server => true do
+      @player_created.should == true
+    end
+
+    it "should have a new player with user ID for @new_user", :affects_bv_server => true do
+      @new_player.user_id.should == @new_user.id
+    end
+
+    # CREATE Activity (share)
+    it "should have created a 1st activity", :affects_bv_server => true do
+      @share_activity_created.should == true
+    end
+
+    it "should have registered a new share activity", :affects_bv_server => true do
+      @share_activity.verb.should == "share"
+    end
+
+    # CREATE ActivityDefinition
+    it "should have created a new activity definition", :affects_bv_server => true do
+      @new_activity_defn_created.should == true
+    end
+
+    it "should have a new activity definition for comment", :affects_bv_server => true do
+      @new_activity_definition.verb.should == "comment"
+    end
+
+    # CREATE Activity (comment)
+    it "should have created a 2nd activity", :affects_bv_server => true do
+      @comment_activity_created.should == true
+    end
+
+    it "should have registered a new comment activity", :affects_bv_server => true do
+      @comment_activity.verb.should == "comment"
+    end
+
+    it "should have added 3 points to the new player", :affects_bv_server => true do
+      @updated_player = Player.find(@new_player.id)
+      @updated_player.points_all.should == 3
+    end
+
+    it "should have added 1 reward to the new player", :affects_bv_server => true do
+      Reward.find(:all, :params => {:player_id => @new_player.id})[0].name.should == "Comment Rockstar"
+    end
+
+    # CREATE RewardDefinition
+    it "should have created a new reward definition", :affects_bv_server => true do
+      @new_reward_defn_created.should == true
+    end
+
+    it "should have a new reward definition with the name 'Comment Rockstar'", :affects_bv_server => true do
+      @new_reward_defn.name.should == 'Comment Rockstar'
+    end
+
+    #UPDATE User
+    it "should update the user", :affects_bv_server => true do
+      # Basic README: Find the newly created user to update their email address
+      @user_found_by_id       = User.find( @new_user.id )
+      @user_found_by_id.email = "visitor#{@rand2}@emailserver.com"
+      @user_updated           = @user_found_by_id.save
+
+      User.find(@new_user.id).email.should == "visitor#{@rand2}@emailserver.com"
+      @user_updated.should == true
+    end
+
+    # UPDATE ActivityDefinition (points)
+    it "should have updated the activity definition a 1st time", :affects_bv_server => true do
+      @new_activity_defn_updated.should == true
+    end
+
+    it "should have updated the activity definition points for comment", :affects_bv_server => true do
+      @updated_activity_definition = ActivityDefinition.find(@new_activity_definition.id)
+      @updated_activity_definition.adjustment.points.should == 3
+    end
+
+    # UPDATE ActivityDefinition (rate-limiting)
+    it "should have updated the activity definition a 2nd time", :affects_bv_server => true do
+      @new_activity_defn_updated_again.should == true
+    end
+
+    it "should have updated the activity definition to enable rate limiting", :affects_bv_server => true do
+      @new_activity_definition.enable_rate_limiting.should == true
+      @new_activity_definition.bucket_drain_rate.should    == 180
+      @new_activity_definition.bucket_max_capacity.should  == 25
+    end
+
+    # UPDATE Player
+    it "should update the player with the display name \"Mitt Romney\"", :affects_bv_server => true do
+      @new_player.display_name = "Mitt Romney"
+      @new_player.save
+      Player.find(@new_player.id).display_name.should == "Mitt Romney"
+    end
+
+    # UPDATE RewardDefinition
+    it "should update the reward definition with the name \"Coment Superstar\"", :affects_bv_server => true do
+      @new_reward_defn.name = "Comment Superstar"
+      @new_reward_defn.save
+      RewardDefinition.find(@new_reward_defn.id).name.should == "Comment Superstar"
+    end
+
+    #UPDATE Site
+    it "should update the site", :affects_bv_server => true do
+      @new_site.name = "New Site Name"
+      @new_site.save
+      Site.find(@new_site.id).name.should == "New Site Name"
+    end
+
+    # DELETE RewardDefinition
+    it "should have deleted a reward definition", :affects_bv_server => true do
+      RewardDefinition.delete(@new_reward_defn.id)
+      lambda { RewardDefinition.find(@new_reward_defn.id) }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    # DELETE ActivityDefinition
+    it "should have deleted an activity definition", :affects_bv_server => true do
+      ActivityDefinition.delete(@new_activity_definition.id)
+      lambda { ActivityDefinition.find(@new_activity_definition.id) }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    # DELETE Player
+    it "should have deleted a player", :affects_bv_server => true do
+      Player.delete(@new_player.id)
+      lambda { Player.find(@new_player.id) }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    # DELETE User
+    it "should have deleted a user", :affects_bv_server => true do
+      User.delete(@new_user.id)
+      lambda { User.find(@new_user.id) }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    # DELETE Site
+    it "should have deleted a site", :affects_bv_server => true do
+      Site.delete(@new_site.id)
+      lambda { Site.find(@new_site.id) }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+  end
+end

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification
+name: badgeville_berlin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrija Perovic
+- Alex Tran
+- Jimmy Zhang
+- Supraja Narasimhan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70315875897720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315875897720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70315875897040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315875897040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70315875896320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315875896320
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70315875895660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315875895660
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &70315875894800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70315875894800
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: &70315875894240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315875894240
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &70315875878120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315875878120
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: &70315875877400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315875877400
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: &70315875876400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: *70315875876400
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: &70315875875660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70315875875660
+description: Uses the activeresource (3.0.5) gem to map ActiveModel-like RESTful methods
+  to resources on the remote Badgeville server.
+email:
+- supraja.n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .yardoc/checksums
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
+- Gemfile
+- LICENSE.md
+- README.md
+- README_ADVANCED.md
+- Rakefile
+- badgeville.gemspec
+- doc/BadgevilleBerlin.html
+- doc/BadgevilleBerlin/Activity.html
+- doc/BadgevilleBerlin/ActivityDefinition.html
+- doc/BadgevilleBerlin/BaseResource.html
+- doc/BadgevilleBerlin/Config.html
+- doc/BadgevilleBerlin/Errors.html
+- doc/BadgevilleBerlin/Group.html
+- doc/BadgevilleBerlin/Leaderboard.html
+- doc/BadgevilleBerlin/Player.html
+- doc/BadgevilleBerlin/Reward.html
+- doc/BadgevilleBerlin/RewardDefinition.html
+- doc/BadgevilleBerlin/Site.html
+- doc/BadgevilleBerlin/Track.html
+- doc/BadgevilleBerlin/User.html
+- doc/BadgevilleBerlinJsonFormat.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- examples/.DS_Store
+- examples/shell/.DS_Store
+- examples/shell/lib/.DS_Store
+- examples/shell/lib/berlin_shell.rb
+- examples/shell/lib/berlin_shell/.DS_Store
+- examples/shell/lib/berlin_shell/cd.rb
+- examples/shell/lib/berlin_shell/core.rb
+- examples/shell/lib/berlin_shell/ls.rb
+- examples/shell/lib/berlin_shell/prompt.rb
+- examples/shell/shell_demo.rb
+- examples/shell/spec/integration/basic_spec.rb
+- lib/.yardoc/checksums
+- lib/.yardoc/objects/root.dat
+- lib/.yardoc/proxy_types
+- lib/badgeville_berlin.rb
+- lib/badgeville_berlin/.yardoc/checksums
+- lib/badgeville_berlin/.yardoc/objects/root.dat
+- lib/badgeville_berlin/.yardoc/proxy_types
+- lib/badgeville_berlin/activity.rb
+- lib/badgeville_berlin/activity_definition.rb
+- lib/badgeville_berlin/base_resource.rb
+- lib/badgeville_berlin/config.rb
+- lib/badgeville_berlin/doc/_index.html
+- lib/badgeville_berlin/doc/class_list.html
+- lib/badgeville_berlin/doc/css/common.css
+- lib/badgeville_berlin/doc/css/full_list.css
+- lib/badgeville_berlin/doc/css/style.css
+- lib/badgeville_berlin/doc/file_list.html
+- lib/badgeville_berlin/doc/frames.html
+- lib/badgeville_berlin/doc/index.html
+- lib/badgeville_berlin/doc/js/app.js
+- lib/badgeville_berlin/doc/js/full_list.js
+- lib/badgeville_berlin/doc/js/jquery.js
+- lib/badgeville_berlin/doc/method_list.html
+- lib/badgeville_berlin/doc/top-level-namespace.html
+- lib/badgeville_berlin/errors.rb
+- lib/badgeville_berlin/formats/badgeville_berlin_json_format.rb
+- lib/badgeville_berlin/group.rb
+- lib/badgeville_berlin/leaderboard.rb
+- lib/badgeville_berlin/player.rb
+- lib/badgeville_berlin/reward.rb
+- lib/badgeville_berlin/reward_definition.rb
+- lib/badgeville_berlin/site.rb
+- lib/badgeville_berlin/track.rb
+- lib/badgeville_berlin/user.rb
+- lib/badgeville_berlin/version.rb
+- lib/doc/_index.html
+- lib/doc/class_list.html
+- lib/doc/css/common.css
+- lib/doc/css/full_list.css
+- lib/doc/css/style.css
+- lib/doc/file_list.html
+- lib/doc/frames.html
+- lib/doc/index.html
+- lib/doc/js/app.js
+- lib/doc/js/full_list.js
+- lib/doc/js/jquery.js
+- lib/doc/method_list.html
+- lib/doc/top-level-namespace.html
+- spec/factories.rb
+- spec/integration/activity_spec.rb
+- spec/integration/basic_spec.rb
+- spec/integration/player_spec.rb
+- spec/integration/site_spec.rb
+- spec/integration/user_spec.rb
+- spec/response_json.yml
+- spec/spec_helper.rb
+- spec/unit/badgeville_berlin_json_format_spec.rb
+- spec/unit/base_resource_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/errors_spec.rb
+- spec/use_case/readme_use_case_spec.rb
+homepage: https://github.com/badgeville/badgeville-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: badgeville_berlin
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Badgeville RESTful Berlin API.
+test_files:
+- spec/factories.rb
+- spec/integration/activity_spec.rb
+- spec/integration/basic_spec.rb
+- spec/integration/player_spec.rb
+- spec/integration/site_spec.rb
+- spec/integration/user_spec.rb
+- spec/response_json.yml
+- spec/spec_helper.rb
+- spec/unit/badgeville_berlin_json_format_spec.rb
+- spec/unit/base_resource_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/errors_spec.rb
+- spec/use_case/readme_use_case_spec.rb
+has_rdoc: