beenverified 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2008-05-01
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/beenverified
+lib/beenverified.rb
+lib/beenverified/client.rb
+lib/beenverified/credentials.rb
+lib/beenverified/response.rb
+lib/beenverified/user.rb
+test/test_beenverified.rb
+spec/simple_spec.rb
+test/test_beenverified.rb
+test/test_helper.rb
+test/test_user.rb

data/README.txt

@@ -0,0 +1,125 @@
+== beenverified
+
+http://beenverifiedapi.rubyforge.net/
+
+== 0.1.0
+
+== DESCRIPTION:
+
+BeenVerified is a web service designed to build trust into the meetings
+and interactions that take place on websites and online communities. 
+Built using the OAuth protocol and with a focus on keeping the user in 
+complete control of their data, the BeenVerified API allows users to 
+present third-party, verified information about themselves within your 
+application. That verified user data (such as their identity and 
+credentials) can then be integrated directly into your application's 
+look and feel, providing a more trustworthy user experience for 
+everyone
+
+
+== FEATURES/PROBLEMS:
+
+* Wraps OAuth authentication
+* Wraps XML responses into a User object
+* User object has control of a hash of Credential objects
+
+== DEVELOPER KEY:
+
+Before you can access data from the BeenVerified Library, you must obtain a developer key at: 
+http://www.beenverified.com/developer/new?d=t
+
+== USAGE:
+
+Three Steps
+
+  
+==== 1) Obtaining a request token & sending user to Auth[sz]
+
+  >> require 'beenverified  
+  >> client = BeenVerified::Client.new( :consumer_key    => "consumer_key",
+                                     :consumer_secret => "consumer_secret")               
+  >> request_token = client.get_request_token
+
+  #save your request_token data to your database
+  #send user to request_token.authorize_url  
+  #User comes back to app to notify of authorization 
+  #(in a web flow it would be a redirect to the callback URL)
+  
+==== 2) Getting the access token
+
+  >> client = BeenVerified::Client.new( :consumer_key    => "consumer_key",
+                                      :consumer_secret => "consumer_secret",
+                                      :request_token        => "request_token",
+                                      :request_token_secret => "request_token_secret")
+  >> access_token = client.convert_to_access_token
+  
+  #save access_token data to your database
+
+==== 3) Accessing BeenVerified Resources
+
+  >> user = BeenVerified::Client.new( :consumer_key    => "consumer_key",
+                                      :consumer_secret => "consumer_secret",
+                                      :access_token        => "access_token",
+                                      :access_token_secret => "access_token_secret").user
+  
+=> <BeenVerified::User:0x02cf909 ...>
+
+  #showing a users full name if they are sharing it
+  >> user.identity.full_name if user.identity
+  => "Jason Amster"
+  
+  #showing the name of the organization where a user worked
+  >> user.work_experiences[0].organization if user.work_experiences[0].size > 0
+  => "BeenVerified"
+  
+  #showing the date the work_experience credential was verified
+  user.work_experiences[0].verified_on
+  
+  #displaying the raw xml of a user
+  >> user.raw_xml
+  =>  <?xml version="1.0" encoding="UTF-8"?>
+  	<user>
+  		<link_back>http://localhost/personas/cb79d21f</link_back>
+  		<credentials>
+  			...
+  		</credentials>
+  	</user>
+   
+
+  
+
+
+== REQUIREMENTS:
+
+	oauth
+	net/https
+	activesupport
+
+== INSTALL:
+
+  sudo gem install beenverified
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jason Amster
+
+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,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/beenverified.rb'
+require 'fileutils'
+
+Hoe.new('beenverified', BeenVerified::VERSION) do |p|
+   p.rubyforge_name = 'beenverified' # if different than lowercase project name
+   p.developer('Jason Amster', 'jayamster@gmail.com')
+end
+
+# vim: syntax=Ruby
+
+
+desc "Install GEM Locally"
+task :install_locally => [:install_gem] do
+  FileUtils.rm_rf File.dirname(__FILE__) + '/pkg'
+end

data/lib/beenverified.rb

@@ -0,0 +1,69 @@
+require 'net/https'
+require 'rubygems'
+gem 'oauth', ">= 0.2.1"
+require 'oauth/helper'
+require 'oauth/client/helper'
+require 'oauth/request_proxy/net_http'
+require 'activesupport'
+
+#require 'hpricot'
+
+class BeenVerified
+  VERSION = '0.1.0'
+  API_SERVER = "https://api.beenverified.com"
+  AUTH_SERVER = "https://www.beenverified.com"
+  DEBUG_API_SERVER = "http://localhost"
+  DEBUG_AUTH_SERVER = "http://localhost"
+  
+  API_PREFIX = "/rest/1.0"
+  FORMAT_XML = "xml"
+  REQUEST_TOKEN_PATH= "/oauth/request_token"
+  ACCESS_TOKEN_PATH= "/oauth/access_token"
+  AUTHORIZE_PATH= "/oauth/authorize"
+  USER_API_PATH="#{BeenVerified::API_PREFIX}/user/show"
+  
+  #CREDENTIAL_TYPES_PLURAL = %w(work_experiences  educations  professional_licenses  certifications  personal_references  emails web_sites)
+  #CREDENTIAL_TYPES =        %w(work_experience education professional_license certification personal_reference email web_site)
+  #CREDENTAIL_CLASSES =      %w(WorkExperience  Education  ProfessionalLicense  Certification  PersonalReference  Email  WebSite)
+  CREDENTIALS = {:identity=>{:singular=>'identity', :plural=>'identities', :class=>'Identity'}, 
+                 :work_experience=>{:singular=>'work_experience', :plural=>'work_experiences', :class=>'WorkExperience'},
+                 :education=>{:singular=>'education', :plural=>'educations', :class=>'Education'},
+                 :professional_license=>{:singular=>'professional_license', :plural=>'professional_licenses', :class=>'ProfessionalLicense'},
+                 :certification=>{:singular=>'certification', :plural=>'certifications', :class=>'Certification'},
+                 :personal_reference=>{:singular=>'personal_reference', :plural=>'personal_references', :class=>'PersonalReference'},
+                 :email=>{:singular=>'email', :plural=>'emails', :class=>'Email'},
+                 :web_site=>{:singular=>'web_site', :plural=>'web_sites', :class=>'WebSite'}}
+  
+  class Error < RuntimeError #:nodoc:
+  end
+
+  class ArgumentError < Error #:nodoc:
+  end
+
+  class BeenVerifiedException < Error #:nodoc:
+  end
+  
+  #To convert each key to a getter method for the class
+  #as seen at: http://blog.jayfields.com/2008/02/ruby-dynamically-define-method.html
+
+end
+class Hash
+  def to_mod
+    hash = self
+    Module.new do
+      hash.each_pair do |key, value|
+        define_method key do
+          value
+        end
+      end
+    end
+  end
+end
+
+#Dir['beenverified/**/*.rb'].sort.each { |lib| require lib }\
+#require File.dirname(__FILE__) + '/beenverified/client'
+
+require File.dirname(__FILE__) + '/beenverified/client'
+require File.dirname(__FILE__) + '/beenverified/response'
+require File.dirname(__FILE__) + '/beenverified/user'
+require File.dirname(__FILE__) + '/beenverified/credentials'

data/lib/beenverified/client.rb

@@ -0,0 +1,128 @@
+class BeenVerified  
+  class Client
+      attr_reader :access_token, :request_token, :consumer, :format
+        #attr_accessor :consumer
+
+      def initialize(options = {})
+        options = {
+          :debug  => false,
+          :format => BeenVerified::FORMAT_XML
+        }.merge(options)
+
+        # symbolize keys
+        options.map do |k,v|
+          options[k.to_sym] = v
+        end
+        site = if options[:debug]
+          BeenVerified::DEBUG_API_SERVER
+        else
+          BeenVerified::API_SERVER          
+        end
+        
+        raise BeenVerified::ArgumentError, "OAuth Consumer Key and Secret required" if options[:consumer_key].nil? || options[:consumer_secret].nil?
+        @consumer = OAuth::Consumer.new(options[:consumer_key], options[:consumer_secret],{
+          :site=>site,
+          :scheme=>:header,
+          :http_method=>:post,
+          :request_token_path=>BeenVerified::REQUEST_TOKEN_PATH,
+          :access_token_path=>BeenVerified::ACCESS_TOKEN_PATH,
+          :authorize_path=>BeenVerified::AUTHORIZE_PATH
+         })
+        @debug    = options[:debug]
+        @format   = options[:format]
+       # @app_id   = options[:app_id]
+        if options[:access_token] && options[:access_token_secret]
+          @access_token = OAuth::AccessToken.new(@consumer, options[:access_token], options[:access_token_secret])
+        else
+          @access_token = nil
+        end
+        if options[:request_token] && options[:request_token_secret]
+          @request_token = OAuth::RequestToken.new(@consumer, options[:request_token], options[:request_token_secret])
+        else
+          @request_token = nil
+        end
+      end
+
+      def get_request_token(force_token_regeneration = false)
+        if force_token_regeneration || @request_token.nil?
+          @request_token = consumer.get_request_token
+        end
+        @request_token
+      end
+      
+      def authorization_url
+        raise BeenVerified::ArgumentError, "call #get_request_token first" if @request_token.nil?
+        request_token.authorize_url
+      end
+      
+      def convert_to_access_token
+        raise BeenVerified::ArgumentError, "call #get_request_token and have user authorize the token first" if @request_token.nil?
+        @access_token = request_token.get_access_token
+      end
+      
+      def user(options={})
+        raise BeenVerified::ArgumentError, "OAuth Access Token Required" unless @access_token
+        response = get(BeenVerified::USER_API_PATH + ".#{format}", options)
+        response
+        BeenVerified::Response.new(response.body).user
+      end
+      
+      
+      alias_method :method_missing_with_type_filter, :method_missing
+      def method_missing_with_type_filter(method_id, *arguments)
+        if match = /^get_([_a-zA-Z]\w*|[_a-zA-Z]\w*s)$/.match(method_id.to_s) 
+          if credential_type_match(match.captures.first)
+           credential_type = match.captures.first
+           if credential_type[-1..credential_type.length]=='s'
+             get("#{API_PREFIX}/#{credential_type}.xml")           
+           else
+             get("#{API_PREFIX}/#{credential_type}s/#{arguments[0]}.xml")
+           end
+         else
+           method_missing_without_type_filter(method_id, *arguments)
+         end
+        else
+          method_missing_without_type_filter(method_id, *arguments)
+        end
+      end
+      alias_method :method_missing, :method_missing_with_type_filter
+
+
+      private
+      def credential_type_match(cred_type)
+        compare =  cred_type[-1..cred_type.length]=='s' ? cred_type[0..cred_type.length-2] : cred_type
+        if BeenVerified::CREDENTIAL_TYPES.include?(compare)
+          true
+        else
+          false
+        end
+      end
+      
+      protected
+      
+      def get(url, options = {}) #:nodoc:
+        request(:get, url, options)
+      end
+      
+      def request(method, url, options) #:nodoc:
+        response = case method
+        #when :post
+        #  access_token.request(:post, url, options[:params])
+        when :get
+          qs = options[:params].collect { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&") if options[:params]
+          access_token.request(:get, "#{url}?#{qs}")
+        else
+          raise ArgumentError, "method #{method} not supported"
+        end
+
+        case response.code
+        when '500'; then raise BeenVerified::BeenVerifiedException, "Internal Server Error"
+        when '400'; then raise BeenVerified::BeenVerifiedException, "Method Not Implemented Yet"
+        when '401'; then raise BeenVerified::BeenVerifiedException, "Token not Found"  
+        else response
+        end
+      end
+
+
+  end
+end

data/lib/beenverified/credentials.rb

@@ -0,0 +1,49 @@
+class BeenVerified
+    class Credential
+      attr_accessor :id
+      def initialize(data=nil)
+        unless data
+          @data_hash = nil
+          return
+        else
+          @id = data.attributes["id"]
+          @data_hash ={}
+          data.elements.each do |data_point|
+           @data_hash[data_point.name.to_sym]=data_point.text
+          end
+        end        
+        
+        methods = @data_hash.reject{|key, val| key==:verified_on}
+        self.extend methods.to_mod
+      end
+
+      def [](index)
+        if @data_hash==nil
+          return nil
+        else
+          return @data_hash[index]
+        end
+      end
+      
+      def verified_on
+        Date.parse(@data_hash[:verified_on])
+      end
+    
+    end
+
+    class Identity < Credential
+      def full_name
+        "#{@data_hash[:first_name]} #{@data_hash[:last_name]}"
+      end
+    end
+    
+    class WorkExperience < Credential;end
+    class Education < Credential;end
+    class ProfessionalLicense < Credential;end
+    class Certification < Credential;end
+    class PersonalReference < Credential;end
+    class Email < Credential;end
+    class WebSite < Credential;end
+
+  
+end

data/lib/beenverified/response.rb

@@ -0,0 +1,22 @@
+class BeenVerified
+  class Response
+
+    #Parses the XML response from BeenVerified
+    def initialize(doc)
+      doc = REXML::Document.new(doc) unless doc.is_a?(REXML::Document || REXML::Element)
+      @doc = doc
+      raise BeenVerified::BeenVerifiedException, @doc.elements['error'].attributes["error_code"] if !success? 
+    end
+
+    #does the response indicate success?
+    def success?
+      @doc.elements['error'].nil? 
+    end
+
+    def user
+      @user ||= BeenVerified::User.new(@doc)      
+    end
+
+
+  end
+end

data/lib/beenverified/user.rb

@@ -0,0 +1,46 @@
+class BeenVerified
+  class User
+    attr_accessor :raw_xml, :link_back, :credentials, *BeenVerified::CREDENTIALS.map{|credential_type| credential_type[1][:plural].to_sym}
+    def initialize(doc)
+      @raw_xml = doc.root
+      @link_back = doc.root.elements['link_back'].text
+      
+      #Cycle through all element types and see if there are any of them in the xml response
+      @credentials = {}
+      BeenVerified::CREDENTIALS.each do |credential_type|
+        
+        #set array to empty set
+        type_array = []
+        
+        #Get the matching xml node
+        credentials = doc.root.elements['credentials'].elements[credential_type[1][:plural]]
+        
+        #if there are credentials of this type, cycle through and instantiate objects of them
+        #and add it to the array
+        if credentials
+          klass = "BeenVerified::#{credential_type[1][:class]}".constantize
+          credentials.elements.each do |credential|
+            type_array << klass.new(credential)
+          end                    
+        end
+        eval("@#{credential_type[1][:plural]} = type_array")    
+        @credentials[credential_type[1][:plural]] = type_array
+        #puts @credentials.size
+      end        
+      
+      def number_of_credentials
+        credentials.inject(0){|sum, type| sum = sum+type[1].size }
+      end
+      
+      def identity
+        unless  identities.empty?
+          identities[0]
+        else
+          nil
+        end
+      end
+    end
+  end
+end
+
+

data/spec/simple_spec.rb

@@ -0,0 +1,12 @@
+class BeenVerifiedApi
+  def awesome?
+    true  
+  end
+end
+
+
+describe BeenVerifiedApi do 
+  it 'should be awesome' do 
+    BeenVerifiedApi.new.should be_awesome
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/beenverified'
+
+def requests(request)
+  Marshal.load(File.read(File.dirname(__FILE__) + '/fixtures/' + request))
+end
+

data/test/test_user.rb

@@ -0,0 +1,113 @@
+require 'rubygems'
+require "rexml/document"
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TestUser < Test::Unit::TestCase
+
+  def setup
+    @basic_user = <<DATA
+    <?xml version="1.0" encoding="UTF-8"?>
+    <user>
+      <link_back>http://localhost/personas/cb79d21f</link_back>
+      <credentials>
+        <identities>
+          <identity id="2">
+            <first_name>Jason</first_name>
+            <last_name>Amster</last_name>
+            <middle_name></middle_name>
+            <suffix></suffix>
+            <verified_on>09/26/2007</verified_on>
+            <source></source>
+            <notes></notes>
+          </identity>
+        </identities>
+        <educations>
+          <education id="1">
+            <school>Rutgers University</school>
+            <major>Computer Science</major>
+            <minor></minor>
+            <start_date></start_date>
+            <graduation_date>2003-06-01</graduation_date>
+            <verified_on>09/15/2007</verified_on>
+            <source></source>
+            <notes> 
+          </notes>
+          </education>
+        </educations>
+        <work_experiences>
+          <work_experience id="1">
+            <organization>Redken/L'Oreal USA</organization>
+            <title>Manager - Interactive Development</title>
+            <start_date>2004-08-01</start_date>
+            <end_date>2007-08-01</end_date>
+            <verified_on>09/22/2007</verified_on>
+            <source></source>
+            <notes></notes>
+          </work_experience>
+          <work_experience id="2">
+            <organization>BeenVerified.com</organization>
+            <title>CTO</title>
+            <start_date>2007-08-01</start_date>
+            <end_date></end_date>
+            <verified_on>10/31/2007</verified_on>
+            <source></source>
+            <notes></notes>
+          </work_experience>
+        </work_experiences>
+      </credentials>
+    </user>
+DATA
+    
+    
+    @empty_user = <<DATA
+    <?xml version="1.0" encoding="UTF-8"?>
+    <user>
+      <link_back>http://localhost/personas/cb79d21f</link_back>
+      <credentials>
+        
+      </credentials>
+    </user>
+DATA
+    
+    @basic_user = REXML::Document.new(@basic_user, {:compress_whitespace => %(credentials)})#file
+    @empty_user = REXML::Document.new(@empty_user, {:compress_whitespace => %(credentials)})#file
+
+
+  end
+  
+  def test_initialize
+    user = BeenVerified::User.new(@basic_user)
+    assert user
+    
+  end
+  def test_basic_user
+    user = BeenVerified::User.new(@basic_user)
+    assert_equal 4, user.number_of_credentials
+    assert_equal 2, user.work_experiences.size
+    assert_equal 1, user.educations.size
+    assert user.web_sites, nil
+    assert_equal 'http://localhost/personas/cb79d21f', user.link_back
+    assert user.identity
+    
+  end
+  def test_credential_values
+    user = BeenVerified::User.new(@basic_user)
+    assert_equal "Jason Amster", user.identity.full_name
+    assert_equal "Redken/L'Oreal USA", user.work_experiences.first[:organization]
+    assert_equal Date, user.work_experiences.first.verified_on.class
+    assert_equal '1', user.work_experiences.first.id
+    assert_equal '2', user.work_experiences[1].id
+    assert_equal 'Computer Science', user.educations[0].major
+    assert_equal 'Computer Science', user.educations[0][:major]
+  end
+
+  
+  def test_simple_user
+    user = BeenVerified::User.new(@empty_user)
+    assert_equal 0, user.number_of_credentials
+    BeenVerified::CREDENTIALS.map{|type| type[1][:plural]}.each do |type|
+      assert eval("user.#{type}.empty?")
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: beenverified
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Amster
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: BeenVerified is a web service designed to build trust into the meetings and interactions that take place on websites and online communities.  Built using the OAuth protocol and with a focus on keeping the user in  complete control of their data, the BeenVerified API allows users to  present third-party, verified information about themselves within your  application. That verified user data (such as their identity and  credentials) can then be integrated directly into your application's  look and feel, providing a more trustworthy user experience for  everyone
+email: 
+- jayamster@gmail.com
+executables: 
+- beenverified
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/beenverified
+- lib/beenverified.rb
+- lib/beenverified/client.rb
+- lib/beenverified/credentials.rb
+- lib/beenverified/response.rb
+- lib/beenverified/user.rb
+- test/test_beenverified.rb
+- spec/simple_spec.rb
+- test/test_helper.rb
+- test/test_user.rb
+has_rdoc: true
+homepage: http://beenverifiedapi.rubyforge.net/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: beenverified
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: BeenVerified is a web service designed to build trust into the meetings and interactions that take place on websites and online communities
+test_files: 
+- test/test_beenverified.rb
+- test/test_helper.rb
+- test/test_user.rb