badgeville_berlin 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.

data/.rspec

@@ -0,0 +1 @@
+--colour -d -r ./spec/spec_helper.rb

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p290@badgeville.badgeville.master --create

data/.yardoc/checksums

@@ -0,0 +1,17 @@
+lib/badgeville-berlin.rb 1543d72a75b231f8fa8a7d5b11cf462346b19e12
+lib/badgeville-berlin/user.rb b70c2750c03dd6e43a92e577d3ca99e93b3d4393
+lib/badgeville-berlin/site.rb eecf141020b23fead4f92b6e53604e8c8fccd51a
+lib/badgeville-berlin/group.rb 0c834789d7709714274e97c9f8ace0afd592cc69
+lib/badgeville-berlin/track.rb 83a40a1838fc533cf92363f2c04b58192b6456d2
+lib/badgeville-berlin/errors.rb 72e69af99f07f0dee3580ba89172c86e3e89e301
+lib/badgeville-berlin/config.rb b596e2e690b6b99eba8f5ef64fbb693acbbb0d40
+lib/badgeville-berlin/reward.rb 0b2ee38fe0d198f1ad7c06020e0c2d2905321f78
+lib/badgeville-berlin/player.rb bedaabc39b28a63e9836c3dcfa29fda509c7f187
+lib/badgeville-berlin/logger.rb 3ca3162076ed8de34802f87736caafbb29f62e63
+lib/badgeville-berlin/version.rb 9f2de3caf725256bbebd4f6230fd2e20c242a8aa
+lib/badgeville-berlin/activity.rb 03ae14bff804e9baa369b47e70768f6c6e57ff05
+lib/badgeville-berlin/leaderboard.rb d35917d02a46e9d05abeae463db0f44d931cfbc9
+lib/badgeville-berlin/base_resource.rb 707e506beb5b45f72a83d4c51f4518ef9c2d397d
+lib/badgeville-berlin/reward_definition.rb f5194f6b3da163e851ff497f379f4e7370363142
+lib/badgeville-berlin/activity_definition.rb 8b780f21c343748b012f359492c3a9fc503b4554
+lib/badgeville-berlin/formats/badgeville_berlin_json_format.rb c5b6c4a54a35fe13957d318d1f86cfe3bb48dc1d

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in badgeville_berlin.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Badgeville
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# Badgeville RESTful Wrapper for Berlin API -- Basic README
+
+This is an open source Ruby wrapper for interacting with the [Badgeville RESTful Berlin API](http://rules.badgeville.com/display/doc/2.0+Core+API+Documentation).
+
+
+## Features
+* Uses the activeresource (3.1.3) gem to map ActiveModel-like RESTful methods to resources on the remote Badgeville server.
+* Allows creating, reading (finding), updating and deleting the following classes of remote resources: Site, User, Player, ActivityDefinition, Activity, Reward and RewardDefinition.
+
+##Basic Examples
+
+### 1. Configure the gem to use your Badgeville Private API Key and the site to which your requests should go.
+```ruby
+        BadgevilleBerlin::Config.conf(
+          :host_name => "http://example.com",
+          :api_key   => MY_API_KEY)
+```
+
+### 2. Add a new site to your network. Find your network ID the Publisher Module's tabbed menu ( Develop > Home ) or contact <support@badgeville.com>
+```ruby
+        new_site = BadgevilleBerlin::Site.new(
+          :name       => "My Website",
+          :url        => "mydomain.com",
+          :network_id => MY_NETWORK_ID )
+        success = new_site.save
+```
+
+### 3. Create a user on your network.
+<ul>
+  <li>See the API Explorer for required and optional parameters.</li>
+</ul>
+
+```ruby
+        new_user = BadgevilleBerlin::User.new(
+          :name       => 'visitor_username',
+          :network_id => MY_NETWORK_ID,
+          :email      => 'visitor@emailserver.com',
+          :password   => 'visitor_password' )
+        success = new_user.save
+```
+
+### 4. See error messages from the remote server.
+<ul>
+  <li>Here we attempt to create a second user on the network with the same email as the first user.</li>
+  <li>See the API Explorer for required and optional parameters.</li>
+</ul>
+
+```ruby
+        new_user2 = BadgevilleBerlin::User.new(
+          :name       => 'visitor_username',
+          :network_id => MY_NETWORK_ID,
+          :email      => 'visitor@emailserver.com',
+          :password   => 'visitor_password' )
+        success = new_user2.save
+
+        puts new_user2.errors.messages # {:email=>["user email is already taken"]}
+        puts new_user2.errors[:email]  # ["user email is already taken"]
+
+```
+
+### 5. Find a user to update user properties.
+<ul>
+  <li>Here we find the newly created user by ID to update their email address.</li>
+  <li>See the API Explorer for a full list of user properties to update.</li>
+</ul>
+```ruby
+        user_found_by_id = BadgevilleBerlin::User.find( new_user.id )
+        user_found_by_id.email = 'revised_visitor@emailserver.com'
+        success = user_found_by_id.save
+
+        updated_user = BadgevilleBerlin::User.find( new_user.id )
+        puts updated_user.email # revised_visitor@emailserver.com
+```
+
+### 6. Create a player.
+<ul>
+  <li>Here we create a player for the new site, corresponding to the user with the updated email address.</li>
+  <li>See the API Explorer for required and optional parameters.</li>
+</ul>
+```ruby
+        new_player = BadgevilleBerlin::Player.new(
+          :site_id => new_site.id,
+          :user_id => user_found_by_id.id )
+        success = new_player.save
+```
+
+### 7. Register a player behavior.
+<ul>
+  <li>Here we record the fact that the newly created player performed a "share" behavior.</li>
+  <li>See the API Explorer for required and optional parameters.</li>
+</ul>
+```ruby
+        new_activity = BadgevilleBerlin::Activity.new(
+          :verb      => 'share',
+          :player_id => new_player.id )
+        success = new_activity.save
+```
+
+## Monitoring HTTP Requests and JSON Responses
+Print HTTP requests and JSON responses by installing the "logger" gem and including this code in your script.
+
+```ruby
+        require 'logger'
+        BadgevilleBerlin::BaseResource.logger       = Logger.new(STDOUT)
+        BadgevilleBerlin::BaseResource.logger.level = Logger::DEBUG
+```
+
+## Dependencies
+* activeresource (3.1.3) - Provides Ruby classes to RESTfully interact with remote resources.
+
+
+## Installation
+gem install badgeville_berlin
+
+
+## Documentation
+For more documentation on how the Badgeville RESTful Berlin API works, see [here] (http://rules.badgeville.com/display/doc/2.0+Core+API+Documentation).
+
+
+## Submitting an Issue
+You can use the [GitHub issue tracker](https://github.com/badgeville/badgeville-ruby/issues) to report bugs. After ensuring that the bug has not already been submitted, please submit:
+
+1. A [gist](https://gist.github.com/) a that contains a stack trace.
+2. Details needed to reproduce the bug, including gem version, Ruby version and operating system.
+
+
+## Submitting a Pull Request
+1. Click the GitHub "Fork" button to fork this project.
+2. Clone the repository for a local copy:
+
+        git clone git@github.com:username/badgeville-ruby.git
+
+3. Create a topic branch:
+
+        git checkout -b my_bug_fix_or_feature_branch
+
+4. Add documentation and specs for your bug fix or feature.
+5. Implement your bug fix or feature.
+6. Run the following command to ensure your tests cover your changes:
+
+        bundle exec rake spec
+
+7. Commit and push your changes.
+8. Click the GitHub "Pull Request" to submit a pull request. Please do not include changes to the gemspec, version or history file.
+
+## Contributors
+David Czarnecki of Major League Gaming wrote the initial gem that inspired this wrapper.
+
+
+Copyright (c) 2012 Badgeville.

data/README_ADVANCED.md

@@ -0,0 +1,120 @@
+# Badgeville RESTful Wrapper for Berlin API -- Advanced README
+
+This is an open source Ruby wrapper for interacting with the [Badgeville RESTful Berlin API](http://rules.badgeville.com/display/doc/2.0+Core+API+Documentation).
+
+
+## Features
+* Uses the activeresource (3.1.3) gem to map ActiveModel-like RESTful methods to resources on the remote Badgeville server.
+* Allows creating, reading (finding), updating and deleting the following classes of remote resources: Site, User, Player, ActivityDefinition, Activity, Reward and RewardDefinition.
+
+##Advanced Examples
+
+
+### 0. Please see Basic Examples in the [Basic README](https://github.com/badgeville/badgeville-ruby/blob/alpha/README.markdown) first.
+
+
+### 1. Configure the gem to use your Badgeville Private API Key and the site to which your requests should go.
+```ruby
+        BadgevilleBerlin::Config.conf(
+          :host_name => "http://example.com",
+          :api_key   => MY_API_KEY)
+```
+
+### 2. Create an activity definition. [(more on activity definition)](http://rules.badgeville.com/display/doc/Creating+and+Managing+Behaviors#CreatingandManagingBehaviors-CreatingAdvancedBehaviors)
+<ul>
+  <li>Create an activity definition to store additional information you want to use in rewards determination.</li>
+  <li>Here we create an activity definition to specify that a player will earn 4 points each time they perform the "comment" behavior.</li>
+  <li>See the API Explorer for required and optional parameters.</li>
+</ul>
+```ruby
+        new_activity_definition = ActivityDefinition.new(
+          :adjustment => '{"points": 4}',
+          :name => 'A Cool Comment Behavior',
+          :site_id => new_site.id,
+          :selector => '{"verb":"vote"}' )
+        success = new_activity_definition.save
+```
+
+### 3. Update the properties of activity definition: points. [(more on points)](http://rules.badgeville.com/display/doc/Creating+and+Managing+Behaviors#CreatingandManagingBehaviors-CreatingSimpleBehaviors)
+<ul>
+  <li>Here we update the activity definition so that a player on our site will earn 3 points rather than 4 each time they perform the "comment" behavior.
+  </li>
+  <li>See the API Explorer for a full list of activity definition properties to update.</li>
+</ul>
+```ruby
+        new_activity_definition.adjustment.points = 3
+        success = new_activity_definition.save
+
+        activity_def_points_updated = BadgevilleBerlin::ActivityDefinition.find(new_activity_definition.id)
+        puts activity_def_points_updated.points # 3.0
+```
+
+### 4. Update the properties of activity definition: enable rate-limiting. [(more on rate-limiting)](http://rules.badgeville.com/display/doc/Creating+and+Managing+Behaviors#CreatingandManagingBehaviors-BehaviorRateLimits)
+<ul>
+  <li>Here we update the activity definition to make it rate-limiting to prevent players from gaming the system.</li>
+  <li>See the API Explorer for a full list of activity definition properties to update.</li>
+</ul>
+```ruby
+        activity_def_points_updated.enable_rate_limiting   = true
+        activity_def_points_updated.bucket_drain_rate      = 180
+        activity_def_points_updated.bucket_max_capacity    = 25
+        activity_def_points_updated.save
+
+        activity_def_rate_limit_updated = BadgevilleBerlin::ActivityDefinition.find(new_activity_definition.id)
+        puts activity_def_rate_limit_updated.enable_rate_limiting # true
+```
+
+### 5. Create a reward definition. [(more on rewards)](http://rules.badgeville.com/display/doc/Creating+and+Managing+DGE+Rewards)
+<ul>
+  <li>Create a reward definition to specify criteria to earn a particular reward.</li>
+  <li>Here we create a reward definition to specify that a player receive a reward for making at least 1 comment.</li>
+  <li>See the API Explorer for required and optional parameters.</li>
+</ul>
+```ruby
+        new_reward_def = BadgevilleBerlin::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_def_created = new_reward_def.save
+```
+
+### 6. Register a player behavior.
+<ul>
+  <li>Here we record the fact that the newly created player performed a "comment" behavior.</li>
+  <li>See the API Explorer for required and optional parameters.</li>
+</ul>
+```ruby
+        new_activity = BadgevilleBerlin::Activity.new(
+          :verb      => 'comment',
+          :player_id => new_player.id )
+        success = new_activity.save
+```
+
+### 7. Find the updated player to verify properties and rewards.
+<ul>
+  <li>Here we verify that the player was credited 4 points and received a reward for the comment behavior.</li>
+  <li>Print out the BadgevilleBerlin::Player object (i.e. updated_player) to get a full list of player properties.</li>
+</ul>
+```ruby
+        updated_player = BadgevilleBerlin::Player.find(new_player.id)
+        puts updated_player.points_all # 3.0
+
+        player_specific_rewards = BadgevilleBerlin::Reward.find(:all, :params => {:player_id => @new_player.id})
+        puts player_specific_rewards[0].name # "Comment Rockstar"
+
+```
+
+### 8. Delete a reward definition.
+```ruby
+        BadgevilleBerlin::RewardDefinition.delete(new_reward_def.id)
+```
+## Dependencies, Installation & Documentation
+Please see the [Basic README](https://github.com/badgeville/badgeville-ruby/blob/alpha/README.markdown) for details.
+
+## Contributors
+David Czarnecki of Major League Gaming wrote the initial gem that inspired this wrapper.
+
+
+Copyright (c) 2012 Badgeville.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+task :default => :spec

data/badgeville.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "badgeville_berlin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "badgeville_berlin"
+  s.version     = BadgevilleBerlin::VERSION
+  s.authors     = ["Andrija Perovic", "Alex Tran", "Jimmy Zhang", "Supraja Narasimhan"]
+  s.email       = ["supraja.n@gmail.com"]
+  s.homepage    = "https://github.com/badgeville/badgeville-ruby"
+  s.summary     = %q{A Ruby wrapper for the Badgeville RESTful Berlin API.}
+  s.description = %q{Uses the activeresource (3.0.5) gem to map ActiveModel-like RESTful methods to resources on the remote Badgeville server.}
+
+  s.rubyforge_project = "badgeville_berlin"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here
+
+  # development-only dependencies
+  s.add_development_dependency "ruby-debug19"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "fakeweb"
+  s.add_development_dependency "factory_girl", '=2.4.0'
+  s.add_development_dependency "ZenTest"
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "autotest-growl"
+  s.add_development_dependency "logger", ">=1.2.8"
+
+  s.add_runtime_dependency "activeresource", '= 3.1.3'
+  # s.add_runtime_dependency "rest-client"
+end

data/doc/BadgevilleBerlin.html

@@ -0,0 +1,131 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: BadgevilleBerlin
+  
+    &mdash; Documentation by YARD 0.7.1
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (B)</a> &raquo; 
+    
+    
+    <span class="title">BadgevilleBerlin</span>
+  
+  
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a id="class_list_link" href="#">Class List</a>
+  
+    <a id="method_list_link" href="#">Method List</a>
+  
+    <a id="file_list_link" href="#">File List</a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+    
+    <iframe id="search_frame"></iframe>
+    
+    <div id="content"><h1>Module: BadgevilleBerlin
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/badgeville-berlin/user.rb<span class="defines">,<br />
+  lib/badgeville-berlin.rb,<br /> lib/badgeville-berlin/site.rb,<br /> lib/badgeville-berlin/group.rb,<br /> lib/badgeville-berlin/track.rb,<br /> lib/badgeville-berlin/errors.rb,<br /> lib/badgeville-berlin/config.rb,<br /> lib/badgeville-berlin/reward.rb,<br /> lib/badgeville-berlin/player.rb,<br /> lib/badgeville-berlin/logger.rb,<br /> lib/badgeville-berlin/version.rb,<br /> lib/badgeville-berlin/activity.rb,<br /> lib/badgeville-berlin/leaderboard.rb,<br /> lib/badgeville-berlin/base_resource.rb,<br /> lib/badgeville-berlin/reward_definition.rb,<br /> lib/badgeville-berlin/activity_definition.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+Subclasses BaseResource to represent a remote resource model class.
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+   
+    
+   
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="BadgevilleBerlin/Activity.html" title="BadgevilleBerlin::Activity (class)">Activity</a></span>, <span class='object_link'><a href="BadgevilleBerlin/ActivityDefinition.html" title="BadgevilleBerlin::ActivityDefinition (class)">ActivityDefinition</a></span>, <span class='object_link'><a href="BadgevilleBerlin/BaseResource.html" title="BadgevilleBerlin::BaseResource (class)">BaseResource</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Config.html" title="BadgevilleBerlin::Config (class)">Config</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Errors.html" title="BadgevilleBerlin::Errors (class)">Errors</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Group.html" title="BadgevilleBerlin::Group (class)">Group</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Leaderboard.html" title="BadgevilleBerlin::Leaderboard (class)">Leaderboard</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Player.html" title="BadgevilleBerlin::Player (class)">Player</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Reward.html" title="BadgevilleBerlin::Reward (class)">Reward</a></span>, <span class='object_link'><a href="BadgevilleBerlin/RewardDefinition.html" title="BadgevilleBerlin::RewardDefinition (class)">RewardDefinition</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Site.html" title="BadgevilleBerlin::Site (class)">Site</a></span>, <span class='object_link'><a href="BadgevilleBerlin/Track.html" title="BadgevilleBerlin::Track (class)">Track</a></span>, <span class='object_link'><a href="BadgevilleBerlin/User.html" title="BadgevilleBerlin::User (class)">User</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.6</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+</div>
+    
+    <div id="footer">
+  Generated on Tue Jan 24 14:21:13 2012 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.1 (ruby-1.9.2).
+</div>
+
+  </body>
+</html>