rpx_now 0.6.4 → 0.6.5

data/README.markdown

@@ -33,9 +33,15 @@ View
     #'mywebsite' is your subdomain/realm on RPX
     <%=RPXNow.embed_code('mywebsite',rpx_token_sessions_url)%>
     OR
-    <%=RPXNow.popup_code('Login here...','mywebsite',rpx_token_sessions_url,:language=>'de')%>
+    <%=RPXNow.popup_code('Login here...', 'mywebsite', rpx_token_sessions_url, options)%>
 
-`popup_code` can also be called with `:unobstrusive=>true`
+Options
+    :language=>'en' # rpx tries to detect the users language, but you may overwrite it [possible languages](https://rpxnow.com/docs#sign-in_localization)
+    :default_provider=>'google' # [possible default providers](https://rpxnow.com/docs#sign-in_default_provider)
+    :flags=>'show_provider_list' # [possible flags](https://rpxnow.com/docs#sign-in_interface)
+
+`popup_code` can also be called with `:unobstrusive=>true`, to still get a nice popup include `RPXNow.popup_source('mywebsite',rpx_token_sessions_url, [options])` somewhere else.
+Options like :language / :flags should be given for both.
 
 Environment
 -----------
@@ -50,6 +56,8 @@ Environment
 
 Controller
 ----------
+    skip_before_filter :verify_authenticity_token, :only => [:rpx_token] # RPX does not pass Rails form tokens...
+
     # user_data
     # found: {:name=>'John Doe', :username => 'john', :email=>'john@doe.com', :identifier=>'blug.google.com/openid/dsdfsdfs3f3'}
     # not found: nil (can happen with e.g. invalid tokens)

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.6.5

data/lib/rpx_now.rb

@@ -64,18 +64,20 @@ module RPXNow
   end
   alias get_contacts contacts
 
-  def embed_code(subdomain,url,options={})
-    options = {:width => '400', :height => '240', :language => 'en'}.merge(options)
+  # iframe for rpx login
+  # options: :width, :height, :language, :flags
+  def embed_code(subdomain, url, options={})
+    options = {:width => '400', :height => '240'}.merge(options)
     <<-EOF
-      <iframe src="https://#{subdomain}.#{Api::HOST}/openid/embed?token_url=#{url}&language_preference=#{options[:language]}"
+      <iframe src="#{Api.host(subdomain)}/openid/embed?#{embed_params(url, options)}"
         scrolling="no" frameBorder="no" style="width:#{options[:width]}px;height:#{options[:height]}px;">
       </iframe>
     EOF
   end
 
+  # popup window for rpx login
+  # options: :language / :flags / :unobtrusive
   def popup_code(text, subdomain, url, options = {})
-    options = options.dup
-    options[:language] ||= 'en'
     if options[:unobtrusive]
       unobtrusive_popup_code(text, subdomain, url, options)
     else
@@ -83,12 +85,39 @@ module RPXNow
     end
   end
 
-  def extract_version!(options)
-    options.delete(:api_version) || api_version
+  # javascript for popup
+  # only needed in combination with popup_code(x,y,z, :unobtrusive => true)
+  def popup_source(subdomain, url, options={})
+    <<-EOF
+      <script src="#{Api.host}/openid/v#{extract_version(options)}/widget" type="text/javascript"></script>
+      <script type="text/javascript">
+        //<![CDATA[
+        RPXNOW.token_url = '#{url}';
+        RPXNOW.realm = '#{subdomain}';
+        RPXNOW.overlay = true;
+        #{ "RPXNOW.language_preference = '#{options[:language]}';" if options[:language] }
+        #{ "RPXNOW.default_provider = '#{options[:default_provider]}';" if options[:default_provider] }
+        #{ "RPXNOW.flags = '#{options[:flags]}';" if options[:flags] }
+        //]]>
+      </script>
+    EOF
+  end
+
+  def extract_version(options)
+    options[:api_version] || api_version
   end
 
   private
 
+  def self.embed_params(url, options)
+    {
+      :token_url => url,
+      :language_preference => options[:language],
+      :flags => options[:flags],
+      :default_provider => options[:default_provider]
+    }.map{|k,v| "#{k}=#{v}" if v}.compact.join('&')
+  end
+
   def self.parse_user_data(response)
     user_data = response['profile']
     data = {}
@@ -101,27 +130,12 @@ module RPXNow
   end
 
   def unobtrusive_popup_code(text, subdomain, url, options={})
-    version = extract_version! options
-    %Q(<a class="rpxnow" href="https://#{subdomain}.#{Api::HOST}/openid/v#{version}/signin?token_url=#{url}&language_preference=#{options[:language]}">#{text}</a>)
+    %Q(<a class="rpxnow" href="#{Api.host(subdomain)}/openid/v#{extract_version(options)}/signin?#{embed_params(url, options)}">#{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}.#{Api::HOST}/openid/v#{version}/signin?token_url=#{url}">
-        #{text}
-      </a>
-      <script src="https://#{Api::HOST}/openid/v#{version}/widget" type="text/javascript"></script>
-      <script type="text/javascript">
-        //<![CDATA[
-        RPXNOW.token_url = "#{url}";
-
-        RPXNOW.realm = "#{subdomain}";
-        RPXNOW.overlay = true;
-        RPXNOW.language_preference = '#{options[:language]}';
-        //]]>
-      </script>
-    EOF
+    unobtrusive_popup_code(text, subdomain, url, options) +
+    popup_source(subdomain, url, options)
   end
 
   class ServerError < RuntimeError; end #backwards compatibility / catch all

data/lib/rpx_now/api.rb

@@ -8,12 +8,23 @@ module RPXNow
     SSL_CERT = File.join(File.dirname(__FILE__), '..', '..', 'certs', 'ssl_cert.pem')
 
     def self.call(method, data)
-      version = RPXNow.extract_version! data
+      data = data.dup
+      version = RPXNow.extract_version(data)
+      data.delete(:api_version)
+
       path = "/api/v#{version}/#{method}"
       response = request(path, {:apiKey => RPXNow.api_key}.merge(data))
       parse_response(response)
     end
 
+    def self.host(subdomain=nil)
+      if subdomain
+        "https://#{subdomain}.#{Api::HOST}"
+      else
+        "https://#{Api::HOST}"
+      end
+    end
+
     private
 
     def self.request(path, data)

data/rpx_now.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rpx_now}
-  s.version = "0.6.4"
+  s.version = "0.6.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2009-10-09}
+  s.date = %q{2009-10-11}
   s.email = %q{grosser.michael@gmail.com}
   s.extra_rdoc_files = [
     "README.markdown"

data/spec/rpx_now_spec.rb

@@ -76,10 +76,10 @@ describe RPXNow do
       RPXNow.embed_code('xxx','my_url').should =~ /token_url=my_url/
     end
     
-    it "defaults to English" do
-      RPXNow.embed_code('xxx', 'my_url').should =~ /language_preference=en/
+    it "defaults to no language" do
+      RPXNow.embed_code('xxx', 'my_url').should_not =~ /language_preference/
     end
-    
+
     it "has a changeable language" do
       RPXNow.embed_code('xxx', 'my_url', :language => 'es').should =~ /language_preference=es/
     end
@@ -114,9 +114,9 @@ describe RPXNow do
 
     describe 'unobstrusive' do
       it "can build an unobtrusive widget" do
-        expected = %Q(<a class="rpxnow" href="https://subdomain.rpxnow.com/openid/v2/signin?token_url=http://fake.domain.com/&language_preference=en">sign on</a>)
+        expected = %Q(<a class="rpxnow" href="https://subdomain.rpxnow.com/openid/v2/signin?token_url=http://fake.domain.com/">sign on</a>)
         actual = RPXNow.popup_code('sign on', 'subdomain', 'http://fake.domain.com/', :unobtrusive => true)
-        expected.should == actual
+        actual.should == expected
       end
 
       it "can change api version" do
@@ -124,7 +124,15 @@ describe RPXNow do
       end
 
       it "can change language" do
-        RPXNow.popup_code('x', 'y', 'z', :unobtrusive => true, :language => 'XX').should include("&language_preference=XX")
+        RPXNow.popup_code('x', 'y', 'z', :unobtrusive => true, :language => 'XX').should include("language_preference=XX")
+      end
+
+      it "can add flags" do
+        RPXNow.popup_code('x', 'y', 'z', :unobtrusive => true, :flags => 'test').should include("flags=test")
+      end
+
+      it "can add default_provider" do
+        RPXNow.popup_code('x', 'y', 'z', :unobtrusive => true, :default_provider => 'test').should include("default_provider=test")
       end
     end
 
@@ -136,12 +144,34 @@ describe RPXNow do
       RPXNow.popup_code('x','y','z').should =~ %r(/openid/v2/signin)
     end
 
-    it "defaults to english" do
-      RPXNow.popup_code('x','y','z').should =~ /RPXNOW.language_preference = 'en'/
+    describe 'language' do
+      it "defaults to no language" do
+        RPXNow.popup_code('x','y','z').should_not =~ /RPXNOW.language_preference/
+      end
+
+      it "has a changeable language" do
+        RPXNow.popup_code('x','y','z', :language=>'de').should =~ /RPXNOW.language_preference = 'de'/
+      end
     end
-    
-    it "has a changeable language" do
-      RPXNow.popup_code('x','y','z',:language=>'de').should =~ /RPXNOW.language_preference = 'de'/
+
+    describe 'flags' do
+      it "defaults to no language" do
+        RPXNow.popup_code('x','y','z').should_not =~ /RPXNOW.flags/
+      end
+
+      it "can have flags" do
+        RPXNow.popup_code('x','y','z', :flags=>'test').should =~ /RPXNOW.flags = 'test'/
+      end
+    end
+
+    describe 'default_provider' do
+      it "defaults to no provider" do
+        RPXNow.popup_code('x','y','z').should_not =~ /RPXNOW.default_provider/
+      end
+
+      it "can have default_provider" do
+        RPXNow.popup_code('x','y','z', :default_provider=>'test').should =~ /RPXNOW.default_provider = 'test'/
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rpx_now
 version: !ruby/object:Gem::Version 
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 +02:00
+date: 2009-10-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency