rpx_now 0.5.10 → 0.5.11

data/README.markdown

@@ -23,7 +23,7 @@ Usage
 Install
 =======
  - As Rails plugin: `script/plugin install git://github.com/grosser/rpx_now.git `
- - As gem: `sudo gem install grosser-rpx_now --source http://gems.github.com/`
+ - As gem: `sudo gem install rpx_now`
 
 Examples
 ========
@@ -40,10 +40,13 @@ View
 Environment
 -----------
     Rails::Initializer.run do |config|
-      config.gem "grosser-rpx_now", :lib => "rpx_now", :source => "http://gems.github.com/"
+      config.gem "rpx_now"
       ...
+
+      config.after_initialize do # so rake gems:install works
+        RPXNow.api_key = "YOU RPX API KEY"
+      end
     end
-    RPXNow.api_key = "YOU RPX API KEY"
 
 Controller
 ----------

data/VERSION

@@ -1 +1 @@
-0.5.10
+0.5.11

data/lib/rpx_now.rb

@@ -1,4 +1,8 @@
+require 'net/http'
+require 'net/https'
 require 'json'
+
+require 'rpx_now/request'
 require 'rpx_now/contacts_collection'
 require 'rpx_now/user_integration'
 require 'rpx_now/user_proxy'
@@ -6,15 +10,14 @@ require 'rpx_now/user_proxy'
 module RPXNow
   extend self
 
-  HOST = 'rpxnow.com'
-  SSL_CERT = File.join(File.dirname(__FILE__), '..', 'certs', 'ssl_cert.pem')
-
   attr_accessor :api_key
   attr_accessor :api_version
   self.api_version = 2
 
-  # retrieve the users data, or return nil when nothing could be read/token was invalid
-  # or data was not found
+  # retrieve the users data
+  # - cleaned Hash
+  # - complete/unclean response when block was given user_data{|response| ...; return hash }
+  # - nil when token was invalid / data was not found
   def user_data(token, *args)
     api_key, version, options = extract_key_version_and_options!(args)
     options = {:token=>token,:apiKey=>api_key}.merge options
@@ -25,7 +28,7 @@ module RPXNow
       return nil if $!.to_s=~/Data not found/
       raise
     end
-    if block_given? then yield(data) else read_user_data_from_response(data) end
+    if block_given? then yield(data) else parse_user_data(data) end
   end
 
   # set the users status
@@ -80,7 +83,7 @@ module RPXNow
   def embed_code(subdomain,url,options={})
     options = {:width => '400', :height => '240', :language => 'en'}.merge(options)
 <<EOF
-<iframe src="https://#{subdomain}.#{HOST}/openid/embed?token_url=#{url}&language_preference=#{options[:language]}"
+<iframe src="https://#{subdomain}.#{Request::HOST}/openid/embed?token_url=#{url}&language_preference=#{options[:language]}"
   scrolling="no" frameBorder="no" style="width:#{options[:width]}px;height:#{options[:height]}px;">
 </iframe>
 EOF
@@ -96,18 +99,29 @@ EOF
 
   private
 
+  def self.parse_user_data(response)
+    user_data = response['profile']
+    data = {}
+    data[:identifier] = user_data['identifier']
+    data[:email] = user_data['verifiedEmail'] || user_data['email']
+    data[:username] = user_data['preferredUsername'] || data[:email].to_s.sub(/@.*/,'')
+    data[:name] = user_data['displayName'] || data[:username]
+    data[:id] = user_data['primaryKey'] unless user_data['primaryKey'].to_s.empty?
+    data
+  end
+
   def unobtrusive_popup_code(text, subdomain, url, options={})
     version = extract_version! options
-    "<a class=\"rpxnow\" href=\"https://#{subdomain}.#{HOST}/openid/v#{version}/signin?token_url=#{url}\">#{text}</a>"
+    "<a class=\"rpxnow\" href=\"https://#{subdomain}.#{Request::HOST}/openid/v#{version}/signin?token_url=#{url}\">#{text}</a>"
   end
 
   def obtrusive_popup_code(text, subdomain, url, options = {})
     version = extract_version! options
     <<EOF
-<a class="rpxnow" onclick="return false;" href="https://#{subdomain}.#{HOST}/openid/v#{version}/signin?token_url=#{url}">
+<a class="rpxnow" onclick="return false;" href="https://#{subdomain}.#{Request::HOST}/openid/v#{version}/signin?token_url=#{url}">
   #{text}
 </a>
-<script src="https://#{HOST}/openid/v#{version}/widget" type="text/javascript"></script>
+<script src="https://#{Request::HOST}/openid/v#{version}/widget" type="text/javascript"></script>
 <script type="text/javascript">
   //<![CDATA[
   RPXNOW.token_url = "#{url}";
@@ -144,52 +158,8 @@ EOF
     options.delete(:api_version) || api_version
   end
 
-  def read_user_data_from_response(response)
-    user_data = response['profile']
-    data = {}
-    data[:identifier] = user_data['identifier']
-    data[:email] = user_data['verifiedEmail'] || user_data['email']
-    data[:username] = user_data['preferredUsername'] || data[:email].to_s.sub(/@.*/,'')
-    data[:name] = user_data['displayName'] || data[:username]
-    data[:id] = user_data['primaryKey'] unless user_data['primaryKey'].to_s.empty?
-    data
-  end
-
   def secure_json_post(path, data)
-    parse_response(post(path,data))
-  end
-
-  def post(path, data)
-    require 'net/http'
-    require 'net/https'
-    request = Net::HTTP::Post.new(path)
-    request.form_data = data.map{|k,v| [k.to_s,v]}#symbol keys -> string because of ruby 1.9.x bug http://redmine.ruby-lang.org/issues/show/1351
-    make_request(request)
-  end
-
-  def make_request(request)
-    http = Net::HTTP.new(HOST, 443)
-    http.use_ssl = true
-    http.ca_file = SSL_CERT
-    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-    http.verify_depth = 5
-    http.request(request)
-  end
-
-  def parse_response(response)
-    if response.code.to_i >= 400
-      raise ServiceUnavailableError, "The RPX service is temporarily unavailable. (4XX)"
-    else
-      result = JSON.parse(response.body)
-      return result unless result['err']
-      
-      code = result['err']['code']
-      if code == -1
-        raise ServiceUnavailableError, "The RPX service is temporarily unavailable."
-      else
-        raise ApiError, "Got error: #{result['err']['msg']} (code: #{code}), HTTP status: #{response.code}"
-      end
-    end
+    Request.post(path, data)
   end
 
   class ServerError < RuntimeError; end #backwards compatibility / catch all

data/lib/rpx_now/request.rb

@@ -0,0 +1,43 @@
+module RPXNow
+  class Request
+    HOST = 'rpxnow.com'
+    SSL_CERT = File.join(File.dirname(__FILE__), '..', '..', 'certs', 'ssl_cert.pem')
+
+    def self.post(path, data)
+      parse_response(request(path,data))
+    end
+
+    private
+
+    def self.request(path, data)
+      request = Net::HTTP::Post.new(path)
+      request.form_data = data.map{|k,v| [k.to_s,v]}#symbol keys -> string because of ruby 1.9.x bug http://redmine.ruby-lang.org/issues/show/1351
+      make_request(request)
+    end
+
+    def self.make_request(request)
+      http = Net::HTTP.new(HOST, 443)
+      http.use_ssl = true
+      http.ca_file = SSL_CERT
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.verify_depth = 5
+      http.request(request)
+    end
+
+    def self.parse_response(response)
+      if response.code.to_i >= 400
+        raise ServiceUnavailableError, "The RPX service is temporarily unavailable. (4XX)"
+      else
+        result = JSON.parse(response.body)
+        return result unless result['err']
+
+        code = result['err']['code']
+        if code == -1
+          raise ServiceUnavailableError, "The RPX service is temporarily unavailable."
+        else
+          raise ApiError, "Got error: #{result['err']['msg']} (code: #{code}), HTTP status: #{response.code}"
+        end
+      end
+    end
+  end
+end

data/rdoc/README.rdoc

@@ -0,0 +1 @@
+documentation is at http://github.com/grosser/rpx_now

data/rpx_now.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rpx_now}
-  s.version = "0.5.10"
+  s.version = "0.5.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2009-10-06}
+  s.date = %q{2009-10-07}
   s.email = %q{grosser.michael@gmail.com}
   s.extra_rdoc_files = [
     "README.markdown"
@@ -24,12 +24,16 @@ Gem::Specification.new do |s|
      "init.rb",
      "lib/rpx_now.rb",
      "lib/rpx_now/contacts_collection.rb",
+     "lib/rpx_now/request.rb",
      "lib/rpx_now/user_integration.rb",
      "lib/rpx_now/user_proxy.rb",
      "pkg/rpx_now-0.5.10.gem",
+     "pkg/rpx_now-0.5.11.gem",
+     "rdoc/README.rdoc",
      "rpx_now.gemspec",
      "spec/fixtures/get_contacts_response.json",
      "spec/rpx_now/contacts_collection_spec.rb",
+     "spec/rpx_now/request_spec.rb",
      "spec/rpx_now/user_proxy_spec.rb",
      "spec/rpx_now_spec.rb",
      "spec/spec_helper.rb"
@@ -44,6 +48,7 @@ Gem::Specification.new do |s|
     "spec/rpx_now_spec.rb",
      "spec/rpx_now/contacts_collection_spec.rb",
      "spec/rpx_now/user_proxy_spec.rb",
+     "spec/rpx_now/request_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/spec/rpx_now/contacts_collection_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../spec_helper", File.dirname(__FILE__))
+require 'spec/spec_helper'
 
 describe RPXNow::ContactsCollection do
   before do

data/spec/rpx_now/request_spec.rb

@@ -0,0 +1,41 @@
+require 'spec/spec_helper'
+
+describe RPXNow::Request do
+  describe 'ssl cert' do
+    it "has an absolute path" do
+      RPXNow::Request::SSL_CERT[0..0].should == '/' #start with '/'
+    end
+
+    it "exists" do
+      File.read(RPXNow::Request::SSL_CERT).to_s.should_not be_empty
+    end
+  end
+
+  describe :parse_response do
+    it "parses json when status is ok" do
+      response = mock(:code=>'200', :body=>%Q({"stat":"ok","data":"xx"}))
+      RPXNow::Request.send(:parse_response, response)['data'].should == "xx"
+    end
+
+    it "raises when there is a communication error" do
+      response = stub(:code=>'200', :body=>%Q({"err":"wtf","stat":"ok"}))
+      lambda{
+        RPXNow::Request.send(:parse_response,response)
+      }.should raise_error(RPXNow::ApiError)
+    end
+
+    it "raises when service has downtime" do
+      response = stub(:code=>'200', :body=>%Q({"err":{"code":-1},"stat":"ok"}))
+      lambda{
+        RPXNow::Request.send(:parse_response,response)
+      }.should raise_error(RPXNow::ServiceUnavailableError)
+    end
+
+    it "raises when service is down" do
+      response = stub(:code=>'400',:body=>%Q({"stat":"err"}))
+      lambda{
+        RPXNow::Request.send(:parse_response,response)
+      }.should raise_error(RPXNow::ServiceUnavailableError)
+    end
+  end
+end

data/spec/rpx_now/user_proxy_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../spec_helper", File.dirname(__FILE__))
+require 'spec/spec_helper'
 
 class User
   include RPXNow::UserIntegration

data/spec/rpx_now_spec.rb

@@ -1,10 +1,10 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require 'spec/spec_helper'
 
 describe RPXNow do
   describe :api_key= do
     it "stores the api key, so i do not have to supply everytime" do
       RPXNow.api_key='XX'
-      RPXNow.expects(:post).with{|x,data|data[:apiKey]=='XX'}.returns mock(:code=>'200', :body=>%Q({"stat":"ok"}))
+      RPXNow::Request.should_receive(:request).with{|x,data|data[:apiKey]=='XX'}.and_return mock(:code=>'200', :body=>%Q({"stat":"ok"}))
       RPXNow.mappings(1)
     end
   end
@@ -98,55 +98,61 @@ describe RPXNow do
     end
     
     it "parses JSON response to user data" do
-      RPXNow.expects(:post).returns fake_response
-      RPXNow.user_data('').should == {:name=>'Michael Grosser',:email=>'grosser.michael@googlemail.com',:identifier=>"https://www.google.com/accounts/o8/id?id=AItOawmaOlyYezg_WfbgP_qjaUyHjmqZD9qNIVM", :username => 'grosser.michael'}
+      expected = {
+        :name       => 'Michael Grosser',
+        :email      => 'grosser.michael@googlemail.com',
+        :identifier => 'https://www.google.com/accounts/o8/id?id=AItOawmaOlyYezg_WfbgP_qjaUyHjmqZD9qNIVM',
+        :username   => 'grosser.michael',
+      }
+      RPXNow::Request.should_receive(:request).and_return fake_response
+      RPXNow.user_data('').should == expected
     end
     
     it "adds a :id when primaryKey was returned" do
       @response_body.sub!(%Q("verifiedEmail"), %Q("primaryKey":"2","verifiedEmail"))
-      RPXNow.expects(:post).returns fake_response
+      RPXNow::Request.should_receive(:request).and_return fake_response
       RPXNow.user_data('')[:id].should == '2'
     end
 
     it "handles primaryKeys that are not numeric" do
       @response_body.sub!(%Q("verifiedEmail"), %Q("primaryKey":"dbalatero","verifiedEmail"))
-      RPXNow.expects(:post).returns fake_response
+      RPXNow::Request.should_receive(:request).and_return fake_response
       RPXNow.user_data('')[:id].should == 'dbalatero'
     end
     
     it "hands JSON response to supplied block" do
-      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%Q({"x":"1","stat":"ok"}))
+      RPXNow::Request.should_receive(:request).and_return mock(:code=>'200',:body=>%Q({"x":"1","stat":"ok"}))
       response = nil
       RPXNow.user_data(''){|data| response = data}
       response.should == {"x" => "1", "stat" => "ok"}
     end
     
     it "returns what the supplied block returned" do
-      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%Q({"x":"1","stat":"ok"}))
+      RPXNow::Request.should_receive(:request).and_return mock(:code=>'200',:body=>%Q({"x":"1","stat":"ok"}))
       RPXNow.user_data(''){|data| "x"}.should == 'x'
     end
     
     it "can send additional parameters" do
-      RPXNow.expects(:post).with{|url,data|
+      RPXNow::Request.should_receive(:request).with{|url,data|
         data[:extended].should == 'true'
-      }.returns fake_response
+      }.and_return fake_response
       RPXNow.user_data('',:extended=>'true')
     end
 
     it "works with api key as 2nd parameter (backwards compatibility)" do
-      RPXNow.expects(:secure_json_post).with('/api/v2/auth_info', :apiKey=>'THE KEY', :token=>'id').returns @fake_user_data
+      RPXNow.should_receive(:secure_json_post).with('/api/v2/auth_info', :apiKey=>'THE KEY', :token=>'id').and_return @fake_user_data
       RPXNow.user_data('id', 'THE KEY')
       RPXNow.api_key.should == API_KEY
     end
 
     it "works with api key as 2nd parameter and options (backwards compatibility)" do
-      RPXNow.expects(:secure_json_post).with('/api/v2/auth_info', :apiKey=>'THE KEY', :extended=>'abc', :token=>'id' ).returns @fake_user_data
+      RPXNow.should_receive(:secure_json_post).with('/api/v2/auth_info', :apiKey=>'THE KEY', :extended=>'abc', :token=>'id' ).and_return @fake_user_data
       RPXNow.user_data('id', 'THE KEY', :extended=>'abc')
       RPXNow.api_key.should == API_KEY
     end
 
     it "works with api version as option (backwards compatibility)" do
-      RPXNow.expects(:secure_json_post).with('/api/v123/auth_info', :apiKey=>API_KEY, :token=>'id', :extended=>'abc').returns @fake_user_data
+      RPXNow.should_receive(:secure_json_post).with('/api/v123/auth_info', :apiKey=>API_KEY, :token=>'id', :extended=>'abc').and_return @fake_user_data
       RPXNow.user_data('id', :extended=>'abc', :api_version=>123)
       RPXNow.api_version.should == API_VERSION
     end
@@ -162,79 +168,51 @@ describe RPXNow do
     end
 
     it "parses JSON response to result hash" do
-      RPXNow.expects(:post).returns fake_response
+      RPXNow::Request.should_receive(:request).and_return fake_response
       RPXNow.set_status('identifier', 'Chillen...').should == {'stat' => 'ok'}
     end
   end
 
   describe :read_user_data_from_response do
     it "reads secondary names" do
-      RPXNow.send(:read_user_data_from_response,{'profile'=>{'preferredUsername'=>'1'}})[:name].should == '1'
+      RPXNow.send(:parse_user_data,{'profile'=>{'preferredUsername'=>'1'}})[:name].should == '1'
     end
     
     it "parses email when no name is found" do
-      RPXNow.send(:read_user_data_from_response,{'profile'=>{'email'=>'1@xxx.com'}})[:name].should == '1'
+      RPXNow.send(:parse_user_data,{'profile'=>{'email'=>'1@xxx.com'}})[:name].should == '1'
     end
   end
 
   describe :contacts do
     it "finds all contacts" do
       response = JSON.parse(File.read('spec/fixtures/get_contacts_response.json'))
-      RPXNow.expects(:secure_json_post).with('/api/v2/get_contacts',:identifier=>'xx', :apiKey=>API_KEY).returns response
+      RPXNow.should_receive(:secure_json_post).with('/api/v2/get_contacts',:identifier=>'xx', :apiKey=>API_KEY).and_return response
       RPXNow.contacts('xx').size.should == 5
     end
   end
 
-  describe :parse_response do
-    it "parses json when status is ok" do
-      response = mock(:code=>'200', :body=>%Q({"stat":"ok","data":"xx"}))
-      RPXNow.send(:parse_response, response)['data'].should == "xx"
-    end
-
-    it "raises when there is a communication error" do
-      response = stub(:code=>'200', :body=>%Q({"err":"wtf","stat":"ok"}))
-      lambda{
-        RPXNow.send(:parse_response,response)
-      }.should raise_error(RPXNow::ApiError)
-    end
-
-    it "raises when service has downtime" do
-      response = stub(:code=>'200', :body=>%Q({"err":{"code":-1},"stat":"ok"}))
-      lambda{
-        RPXNow.send(:parse_response,response)
-      }.should raise_error(RPXNow::ServiceUnavailableError)
-    end
-
-    it "raises when service is down" do
-      response = stub(:code=>'400',:body=>%Q({"stat":"err"}))
-      lambda{
-        RPXNow.send(:parse_response,response)
-      }.should raise_error(RPXNow::ServiceUnavailableError)
-    end
-  end
-
   describe :mappings do
     it "parses JSON response to unmap data" do
-      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%Q({"stat":"ok", "identifiers": ["http://test.myopenid.com/"]}))
+      RPXNow::Request.should_receive(:request).and_return mock(:code=>'200',:body=>%Q({"stat":"ok", "identifiers": ["http://test.myopenid.com/"]}))
       RPXNow.mappings(1, "x").should == ["http://test.myopenid.com/"]
     end
   end
 
   describe :map do
     it "adds a mapping" do
-      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%Q({"stat":"ok"}))
+      RPXNow::Request.should_receive(:request).and_return mock(:code=>'200',:body=>%Q({"stat":"ok"}))
       RPXNow.map('http://test.myopenid.com',1, API_KEY)
     end
   end
 
   describe :unmap do
     it "unmaps a indentifier" do
-      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%Q({"stat":"ok"}))
+      RPXNow::Request.should_receive(:request).and_return mock(:code=>'200',:body=>%Q({"stat":"ok"}))
       RPXNow.unmap('http://test.myopenid.com', 1, "x")
     end
 
     it "can be called with a specific version" do
-      RPXNow.expects(:secure_json_post).with{|a,b|a == "/api/v300/unmap"}
+      RPXNow.should_receive(:secure_json_post).with{|a,b|a == "/api/v300/unmap"}
       RPXNow.unmap('http://test.myopenid.com', 1, :api_key=>'xxx', :api_version=>300)
     end
   end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 # ---- requirements
 require 'rubygems'
 require 'spec'
-require 'mocha'
 
 $LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
 
@@ -12,7 +11,6 @@ API_VERSION = RPXNow.api_version
 
 # ---- rspec
 Spec::Runner.configure do |config|
-  config.mock_with :mocha
   config.before :each do
     RPXNow.api_key = API_KEY
     RPXNow.api_version = API_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rpx_now
 version: !ruby/object:Gem::Version 
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 +02:00
+date: 2009-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,12 +40,16 @@ files:
 - init.rb
 - lib/rpx_now.rb
 - lib/rpx_now/contacts_collection.rb
+- lib/rpx_now/request.rb
 - lib/rpx_now/user_integration.rb
 - lib/rpx_now/user_proxy.rb
 - pkg/rpx_now-0.5.10.gem
+- pkg/rpx_now-0.5.11.gem
+- rdoc/README.rdoc
 - rpx_now.gemspec
 - spec/fixtures/get_contacts_response.json
 - spec/rpx_now/contacts_collection_spec.rb
+- spec/rpx_now/request_spec.rb
 - spec/rpx_now/user_proxy_spec.rb
 - spec/rpx_now_spec.rb
 - spec/spec_helper.rb
@@ -81,4 +85,5 @@ test_files:
 - spec/rpx_now_spec.rb
 - spec/rpx_now/contacts_collection_spec.rb
 - spec/rpx_now/user_proxy_spec.rb
+- spec/rpx_now/request_spec.rb
 - spec/spec_helper.rb