badgeville 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,19 @@
+source 'http://rubygems.org'
+
+# Please keep me alphabetized!
+gem 'json'
+gem 'rest-client'
+# Please keep me alphabetized!
+
+# 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 "rcov", ">= 0"
+end
+
+group :test do
+  gem "webmock"
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    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)
+      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)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    webmock (1.6.4)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  json
+  rcov
+  rest-client
+  rspec (~> 2.3.0)
+  webmock

data/README.md

@@ -0,0 +1,35 @@
+Nitro API
+============
+
+Client for Badgeville API http://rules.badgeville.com/
+
+(not complete)
+
+Usage
+--------
+First, checkout the examples folder. TL;DR:
+
+* create connection object with your api_key, and secret.
+
+```ruby
+require 'badgeville'
+settings = JSON.parse(File.read('keys.json.example'))
+badgeville = Badgeville::Client.new(email, settings)
+```
+
+* log actions
+
+```ruby
+badgeville.log_activity "commented"
+```
+
+Installing
+----------
+ 1) add to your Gemfile
+
+```
+gem 'badgeville'
+```
+
+ 2) Create a keys.json file with your api_key and secret (see keys.json.example file)
+

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "badgeville"
+  gem.homepage = "http://github.com/Keasinc/badgeville"
+  gem.license = "MIT"
+  gem.summary = "Client for Badgeville's Core API"
+  gem.description = "Client for Badgeville's Core API v2. http://rules.badgeville.com"
+  gem.authors = ["Gilad Buchman"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "badgeville #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/log_and_check_status.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'badgeville'
+require 'pp'
+
+settings = JSON.parse(File.read('keys.json'))
+badgeville = Badgeville::Client.new('4@keas.com', settings)
+
+pp badgeville.log_activity "commented"

data/keys.json.example

@@ -0,0 +1,7 @@
+{
+  "private_key" : "8aab2065219a35ddf7fbd277140fc44f",
+  "public_key" : "6e221fe1358f6999cd778fb46c08344b",
+  "host" : "sandbox.v2.badgeville.com",
+  "protocol" : "http",
+  "site" : "example.com"
+}

data/lib/badgeville.rb

@@ -0,0 +1,77 @@
+require 'json'
+require 'rest_client'
+require 'badgeville/activity'
+
+module Badgeville
+  TIMEOUT = 1000
+  HOST = "sandbox.v2.badgeville.com"
+  PROTOCOL = "http"
+
+  class BadgevilleError < StandardError
+    attr_accessor :code
+
+    def initialize (err_code=nil)
+      @code = err_code
+    end
+  end
+
+  class Client
+
+    def initialize (email, opts={})
+      # Required Parameters
+      @site = opts['site']
+      @private_key = opts['private_key']
+      @public_key = opts['public_key']
+      @host = opts['host'] || HOST
+      @protocol = opts['protocol'] || PROTOCOL
+      @user = email
+    end
+
+    def log_activity(activity, opts={})
+      params = {
+        "activity[verb]" => activity,
+      }
+      response = make_call(:post, :activities, params)
+      Activity.new(response)
+    end
+
+    private
+
+    def valid_response?(obj)
+      obj.is_a?(Array) || obj.is_a?(Hash)
+    end
+
+    def ensure_array(items)
+      items.is_a?(Array) ? items : [items]
+    end
+
+    def session
+      if @session.nil?
+        base_url = "#{@protocol}://#{@host}/api/berlin/#{@private_key}"
+        @session = RestClient::Resource.new base_url
+      end
+      @session
+    end
+
+    def make_call(method, action, params)
+      end_point = "#{action.to_s}.json"
+      params.merge!(:user => @user, :site => @site)
+      begin
+        response = session[end_point].send(method, to_query(params))
+        data = response.body
+        json = JSON.parse(data)
+      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 to_query params
+      URI.escape(params.map { |k,v| "#{k.to_s}=#{v.to_s}" }.join("&"))
+    end
+  end
+end

data/lib/badgeville/activity.rb

@@ -0,0 +1,19 @@
+require 'date'
+require 'badgeville/reward'
+
+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"])
+      end
+    end
+  end
+end

data/lib/badgeville/reward.rb

@@ -0,0 +1,38 @@
+module Badgeville
+  class Reward
+    attr_accessor :name, :hint, :image_url, :active
+  end
+
+#  example: 
+#  {
+#    "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/4e4dfab6c47eed727b005c38/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
+#   }
+  def initialize(json)
+    @name = json["name"]
+    @active = json["active"]
+    @hint = json["hint"]
+    @image_url = json["image_url"]
+  end
+end

data/spec/badgeville_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Badgeville do
+  before do
+    @user = "user"
+    @badgeville = Badgeville::Client.new @user, 'private_key' => "api_key",
+      'site' => 'example.com'
+  end
+
+  describe "#log_activity" do
+    before do
+      action_name = "action"
+      @result = {"verb" => "commented",
+        "created_at" => "2011-08-30T12:27:47-07:00",
+        "points" => 0,
+        "player_id" => "4e5d3992c47eed202d00148c",
+        "user_id" => "4e5d3992c47eed202d00148b",
+        "rewards" =>[]
+      }
+
+      body = "activity[verb]=#{action_name}&user=#{@user}&site=example.com"
+      url = "http://" + Badgeville::HOST + ".*activities.json"
+
+      stub_http_request(:post, Regexp.new(url)).with(:body => body).
+        to_return(:body => @result.to_json)
+
+      @activity =  @badgeville.log_activity action_name
+    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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'badgeville'
+require 'webmock/rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: badgeville
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gilad Buchman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-30 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2160484700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160484700
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2160483340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160483340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160482360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160482360
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2160481280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160481280
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2160480100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2160480100
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2160479240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160479240
+description: Client for Badgeville's Core API v2. http://rules.badgeville.com
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- 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/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Keasinc/badgeville
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -517773847151955177
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Client for Badgeville's Core API
+test_files: []