rtokbox 0.1

data/README

@@ -0,0 +1,60 @@
+= RTokBox: Gem for accessing the TokBox.com API.
+
+See http://rtokbox.rubyforge.org/ for more information.
+
+Version 0.1.
+
+== Basic Usage
+
+=== Creating a New User
+
+   tokb = RTokBox::TokBox.new('API_KEY', 'API_SECRET')
+ 
+   # Returns nil if it fails to create the user.
+   tokbuser = tokb.register_user('USER', 'FIRST NAME', 'LAST NAME', 'EMAIL', 'PASSWORD')
+
+=== The Widget Code
+
+    puts tokbuser.widget_code
+
+Just the widget id:
+
+    puts tokbuser.widget_id
+
+Just the TokBox user id:
+     
+    puts tokbuser.user_id
+
+Note: You can create an TokBoxUser Instance directly using:
+    tokbuser = = RTokBox::TokBoxUser.new(EMAIL, PASSWORD, API_KEY, API_SECRET)
+
+== License
+
+Copyright (c) 2007, Radu Spineanu
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+Neither the name of the original author nor the names of contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/lib/rtokbox/tokbox.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2007 Radu Spineanu
+# You can redistribute it and/or modify it under the same terms as Ruby.
+#
+
+module RTokBox
+
+  # The TokBox class can register new users and retrieve TokBoxUser classes.
+  # You use it by doing the following:
+  #       tokb = RTokBox::TokBox.new('API_KEY', 'API_SECRET')
+  #       tokbuser = tokb.register_user('USER', 'FIRST NAME', 'LAST NAME', 'EMAIL', 'PASSWORD')
+  class TokBox
+
+    # Initializes the TokBox Class.
+    def initialize(api_key, api_secret, api_url = 'http://api.tokbox.com/api.php')
+        @api_key = api_key
+        @api_secret = api_secret
+        @api_url = api_url
+    end
+
+    # Registers a new user. Returns nil if the request failed.
+    def register_user(username, firstname, lastname, email, password)
+        call = 'registerUser'
+        call_id = Time.now.to_i.to_s
+        cr_password = Digest::MD5.hexdigest(password)
+
+        msg = @api_key + call + call_id + email + firstname + FORMAT +  lastname + cr_password + username + VER
+        sig = Digest::MD5.hexdigest(msg +  @api_secret)
+
+        params = {}
+        params[:username]  = username
+        params[:firstname] = firstname
+        params[:lastname]  = lastname
+        params[:email]     = email
+        params[:password]  = cr_password
+
+        result = request(call, call_id, params, sig)
+        if result['success']
+                return TokBoxUser.new(email, password, @api_key, @api_secret)
+        else
+#                raise "Could not create user. (error: #{result['errorCode']})"
+                return nil                
+        end
+    end
+
+    # Returns an instance of TokBoxUser.
+    def get_user(email, password)
+        return TokBoxUser.new(email, password, @api_key, @api_secret)
+    end
+
+    # Processes the request. Creates the API call and returns a JSON parsed result.
+    def request(call, call_id, params, sig, api_key = @api_key, api_url = @api_url)
+        rq  = "#{api_url}?api_key=#{CGI.escape api_key}&format=#{CGI.escape FORMAT}&v=#{CGI.escape VER}"
+        rq += "&sig=#{CGI.escape sig}&call_id=#{CGI.escape call_id}&call=#{CGI.escape call}"
+
+        params.each_pair do |key, value|
+            rq += "&#{key}=#{CGI.escape value}"
+        end
+
+        result =  Net::HTTP.get_response(URI.parse(rq)).body
+        return JSON.parse(result)
+    end
+  end
+end

data/lib/rtokbox/tokbox_user.rb

@@ -0,0 +1,85 @@
+# Copyright (c) 2007 Radu Spineanu
+# You can redistribute it and/or modify it under the same terms as Ruby.
+#
+
+module RTokBox
+
+  # This class creates API calls for different user functions.
+  # You get an instance using TokBox.register_user, TokBox.get_user or directly:
+  #     tokbuser = RTokBox::TokBoxUser.new(EMAIL, PASSWORD, API_KEY, API_SECRET)
+  #
+  # Returns nil on failure to log in.
+  class TokBoxUser < TokBox
+    attr_accessor :email, :password, :widget_id, :user_id, :error_code
+    
+    # Initializes the class and retrieves the needed information.
+    # Practically validates a login and returns nil if it fails.
+    def initialize(email, password, api_key, api_secret, api_url = 'http://api.tokbox.com/api.php')
+        @api_key = api_key
+        @api_secret = api_secret
+        @api_url = api_url
+
+        self.email = email
+        self.password = Digest::MD5.hexdigest(password)
+
+        self.user_id = get_UserID
+        self.widget_id = get_WidgetID
+
+        unless self.user_id or self.widget_id
+#            raise "Could not log in. (error: #{self.error_code})"
+            return nul            
+        end 
+    end
+
+    # Retrieves the user's id.    
+    def get_UserID
+        call = 'getUserID'
+        call_id = Time.now.to_i.to_s
+
+        msg = @api_key + call + call_id + self.email + FORMAT + self.password + VER
+        sig = Digest::MD5.hexdigest(msg + @api_secret)
+
+        params = {}
+        params[:email] = self.email
+        params[:password] = self.password
+
+        result = request(call, call_id, params, sig, @api_key, @api_url)
+        if result['success']
+            return result['userid']
+        else
+            self.error_code = result['errorCode']   
+            return nil
+        end
+    end
+    
+    # Retrieves the user's widget id.
+    def get_WidgetID
+        call = 'getWidgetID'
+        call_id = Time.now.to_i.to_s
+
+        msg = @api_key + call + call_id + self.email + FORMAT + self.password + VER
+        sig = Digest::MD5.hexdigest(msg + @api_secret)
+
+        params = {}
+        params[:email] = self.email
+        params[:password] = self.password
+
+        result = request(call, call_id, params, sig, @api_key, @api_url)
+        if result['success']
+            return result['widgetid']
+        else
+            self.error_code = result['errorCode']
+            return nil
+        end
+    end
+
+    # Creates the Widget HTML code for this user.
+    def make_Widget
+        result = '<object type="application/x-shockwave-flash" data="http://www.tokbox.com/f/' + self.widget_id + '" width="540" height="260">
+                         <param name="movie" value="http://www.tokbox.com/f/' + self.widget_id + '"></param>
+                         <param name=FlashVars value="user=' + self.user_id + '&pass=' + self.password + '"></param>
+                  </object>'
+        result
+    end
+  end
+end

data/lib/rtokbox.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2007 Radu Spineanu
+# You can redistribute it and/or modify it under the same terms as Ruby.
+#
+
+require 'rubygems'
+require 'digest/md5'
+require "cgi"
+require 'net/http'
+require 'json'
+require 'json/ext'
+
+# RTokBox module contains a TokBox connection class and a TokBox user class.
+module RTokBox
+  FORMAT      = "JSON"
+  VER     = "1.0"
+end
+
+require 'rtokbox/tokbox'
+require 'rtokbox/tokbox_user'
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: rtokbox
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-11-28 00:00:00 +02:00
+summary: Gem for accessing the TokBox.com API.
+require_paths: 
+- lib
+email: radu @nospam@ mypadz.com
+homepage: 
+rubyforge_project: 
+description: 
+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: 
+- Radu Spineanu
+files: 
+- lib/rtokbox.rb
+- lib/rtokbox/tokbox_user.rb
+- lib/rtokbox/tokbox.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: