SuperRewards 0.5.1

data/History.txt

@@ -0,0 +1,5 @@
+== 0.5.1 / 2007-12-17
+
+* Initial Release
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/super_rewards
+lib/super_rewards.rb
+lib/super_rewards/client.rb
+lib/super_rewards/parser.rb
+test/test_super_rewards.rb

data/README.txt

@@ -0,0 +1,50 @@
+SuperRewards
+    by Shane Vitarana
+    http://shanesbrain.net
+
+== DESCRIPTION:
+  
+A Ruby client for the Super Rewards API by KITN Media
+
+== FEATURES/PROBLEMS:
+  
+* Aims to implement all the functionality of the Super Rewards PHP client
+
+== SYNOPSIS:
+
+  offer_code = SuperRewards::Client.offers_display(:iframe, uid)
+	points = SuperRewards::Client.get_points(uids).first.user.points
+
+== REQUIREMENTS:
+
+* API / Secret keys for the Super Rewards service
+* Shoulda gem (for testing)
+
+== INSTALL:
+
+* sudo gem install super_rewards
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Shane Vitarana
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/super_rewards.rb'
+
+Hoe.new('SuperRewards', SuperRewards::VERSION) do |p|
+  p.rubyforge_name = 'superrewards'
+  p.author = 'Shane Vitarana'
+  p.email = 'shanev@gmail.com'
+  p.summary = 'A Ruby client for the Super Rewards web service'
+  p.description = 'A Ruby client for the Super Rewards web service'
+  p.url = 'http://shanesbrain.net'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/lib/super_rewards.rb

@@ -0,0 +1,13 @@
+require 'net/http'
+require 'rexml/document'
+require 'lib/super_rewards/parser'
+require 'lib/super_rewards/client'
+
+module SuperRewards
+  VERSION = '0.5.1'
+
+  SUPERREWARDS_API_KEY = "gsdf7g987sdg987dsfg897sd9g87sdf98g7dfs"
+  SUPERREWARDS_SECRET_KEY = "adsfasdf908asdf908asdf09a8dsf09ad8sf09ads8"
+  SUPERREWARDS_ENDPOINT = "http://apps.kitnmedia.com/superrewards/service.php"
+  SUPERREWARDS_VERSION = "1.0"
+end

data/lib/super_rewards/client.rb

@@ -0,0 +1,53 @@
+module SuperRewards
+  class Client
+    def self.get_required_fields(uid)
+      instance.post('superrewards.users.getRequiredFields', :uid => uid)
+    end
+
+    def self.offers_display(mode, uid, user_info=nil)
+      if user_info
+        instance.post('superrewards.offers.display', :display_mode => mode.to_s, :uid => uid, :user_info => user_info)
+      else
+        instance.post('superrewards.offers.display', :display_mode => mode.to_s, :uid => uid)
+      end        
+    end
+
+    def self.get_points(uids)
+      instance.post('superrewards.users.getPoints', :uids => uids.join(','))
+    end
+    
+    def post(method, params = {})
+      params[:method] = method
+      params[:api_key] = SUPERREWARDS_API_KEY
+      params[:version] = SUPERREWARDS_VERSION
+      service.post(params.merge(:sig => signature_for(params)))
+    end
+    
+    def self.instance
+      @instance ||= self.new
+    end
+    
+    def service
+      @service ||= Service.new
+    end
+
+  private
+    def signature_for(params)
+      raw_string = params.inject([]) do |collection, pair|
+        collection << pair.join("=")
+        collection
+      end.sort.join
+      Digest::MD5.hexdigest([SUPERREWARDS_SECRET_KEY, raw_string].join)
+    end
+  end
+  
+  class Service
+    def post(params)
+      Parser.parse(params[:method], Net::HTTP.post_form(url, params))
+    end
+  private
+    def url
+      URI.parse(SUPERREWARDS_ENDPOINT)
+    end
+  end  
+end

data/lib/super_rewards/parser.rb

@@ -0,0 +1,68 @@
+module SuperRewards
+  class Parser
+    module REXMLElementExtensions
+      def text_value
+        self.children.first.to_s.strip
+      end
+    end
+    ::REXML::Element.__send__(:include, REXMLElementExtensions)
+  
+    def self.parse(method, data)
+      parser = Parser::PARSERS[method]
+      parser.process(data)
+    end
+  
+    def self.element(name, data)
+      data = data.body rescue data # either data or an HTTP response
+      doc = REXML::Document.new(data)
+      doc.elements.each(name) do |element|
+        return element
+      end
+      raise "Element #{name} not found in #{data}"
+    end
+  end
+
+  class GetRequiredFields < Parser
+    def self.process(data)
+      fields = element('users_getRequiredFields_response', data).text_value
+      fields.split(',').map { |f| f.to_sym }
+    end
+  end
+
+  class OffersDisplay < Parser
+    def self.process(data)
+      element('offers_display_response', data).text_value
+    end
+  end
+
+  class User
+    attr_accessor :uid, :points
+  end
+
+  class GetPoints < Parser
+    def self.process(data)
+      users = []
+      data = data.body rescue data # either data or an HTTP response
+      doc = REXML::Document.new(data)
+      doc.elements.each("users_getPoints_response/user") do |element|
+        user = User.new
+        element.each_element("uid") do |uid_element|
+          user.uid = uid_element.get_text.to_s
+        end
+        element.each_element("points") do |points_element|
+          user.points = points_element.get_text.to_s.to_i
+        end        
+        users << user
+      end
+      users
+    end
+  end    
+
+  class Parser
+    PARSERS = {
+      'superrewards.users.getRequiredFields' => GetRequiredFields,
+      'superrewards.offers.display'          => OffersDisplay,
+      'superrewards.users.getPoints'         => GetPoints
+    }
+  end
+end

data/test/test_super_rewards.rb

@@ -0,0 +1,110 @@
+require 'test/unit'
+require 'digest/md5'
+require 'cgi'
+require 'rubygems'
+require 'shoulda'
+require 'super_rewards'
+
+class TestSuperRewards < Test::Unit::TestCase
+  
+  TEST_UID = "1342314"
+  
+  context "Using curl" do
+    setup do
+      @params = {}
+      @params[:api_key] = SuperRewards::SUPERREWARDS_API_KEY
+      @params[:version] = SuperRewards::SUPERREWARDS_VERSION
+    end
+    
+    context "for a single user" do
+      setup do
+        @params[:uid] = TEST_UID
+      end
+      
+      should "get required fields" do
+        @params[:method] = "superrewards.users.getRequiredFields"
+        out = `curl -d "#{curl_params}" #{SuperRewards::SUPERREWARDS_ENDPOINT}`      
+        assert_equal "<?xml version=\"1.0\" encoding=\"UTF-8\"?><users_getRequiredFields_response>affiliations,birthday,sex,meeting_for</users_getRequiredFields_response>", out
+      end
+
+      should "get offer display code" do
+        @params[:method] = "superrewards.offers.display"
+        @params[:display_mode] = "iframe"
+        # TODO: sending the XML user_info always gives us an invalid signature
+        # @params[:user_info] = CGI.escape(user_info.to_s)
+        out = `curl -d "#{curl_params}" #{SuperRewards::SUPERREWARDS_ENDPOINT}`
+        assert_match(/<offers_display_response>/, out)
+      end
+    end
+    
+    should "get points for the given users" do
+      @params[:method] = "superrewards.users.getPoints"
+      @params[:uids] = TEST_UID
+      out = `curl -d "#{curl_params}" #{SuperRewards::SUPERREWARDS_ENDPOINT}`
+      assert_match(/users_getPoints_response list=\"true\"/, out)      
+    end
+  end
+  
+  context "Using SuperRewards Ruby API" do
+    should "get required fields" do
+      fields = SuperRewards::Client.get_required_fields(TEST_UID)
+      [ :affiliations, :birthday, :sex, :meeting_for ].each do |field|
+        assert fields.include?(field)
+      end
+    end
+    
+    should "get offer display code" do
+      offer_code = SuperRewards::Client.offers_display(:iframe, TEST_UID, nil)
+      assert_match(/offers.php/, offer_code)
+    end
+    
+    should "get points for the given users" do
+      uids = [TEST_UID, "1234"]
+      users = SuperRewards::Client.get_points(uids)
+      assert_equal TEST_UID, users.first.uid
+      assert_equal 0, users.first.points
+    end
+  end
+
+private
+  def curl_params
+    @params.map { |k,v| "#{k}=#{v}" }.join('&') + "&sig=#{signature_for(@params)}"
+  end  
+  
+  def signature_for(params)
+    raw_string = params.inject([]) do |collection, pair|
+      collection << pair.join("=")
+      collection
+    end.sort.join
+    Digest::MD5.hexdigest([SuperRewards::SUPERREWARDS_SECRET_KEY, raw_string].join)
+  end
+  
+  def user_info
+    xml =<<EOF
+<?xml version='1.0' encoding='UTF-8'?>
+<users_getInfo_response xmlns='http://api.facebook.com/1.0/'
+xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+xsi:schemaLocation='http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd' list='true'>
+  <user>
+    <uid>8055</uid>
+    <affiliations list='true'>
+      <affiliation>
+        <nid>50453093</nid>
+        <name>Facebook Developers</name>
+        <type>work</type>
+        <status/>
+        <year/>
+      </affiliation>
+    </affiliations> 
+    <birthday>November 3</birthday>
+     <meeting_for list='true'>
+       <seeking>Friendship</seeking>
+     </meeting_for>
+     <sex>male</sex>
+  </user>
+</users_getInfo_response>
+EOF
+  xml.gsub!(/[\t\r\n]/,'') 
+  end
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: SuperRewards
+version: !ruby/object:Gem::Version 
+  version: 0.5.1
+date: 2007-12-17 00:00:00 -06:00
+summary: A Ruby client for the Super Rewards web service
+require_paths: 
+- lib
+email: shanev@gmail.com
+homepage: http://shanesbrain.net
+rubyforge_project: superrewards
+description: A Ruby client for the Super Rewards web service
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Shane Vitarana
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/super_rewards
+- lib/super_rewards.rb
+- lib/super_rewards/client.rb
+- lib/super_rewards/parser.rb
+- test/test_super_rewards.rb
+test_files: 
+- test/test_super_rewards.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- super_rewards
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: