grosser-rpx_now 0.3 → 0.3.1

data/README.markdown

@@ -35,10 +35,11 @@ View
 Controller
 ----------
     # simple: use defaults
+    # user_data returns e.g. {:name=>'John Doe',:email=>'john@doe.com',:identifier=>'blug.google.com/openid/dsdfsdfs3f3'}
+    # when no user_data was found (invalid token supplied), data is empty, you may want to handle that seperatly...
+    # your user model must have an identifier column
     def rpx_token
-      data = RPXNow.user_data(params[:token],'YOUR RPX API KEY') # :name=>'John Doe',:email=>'john@doe.com',:identifier=>'blug.google.com/openid/dsdfsdfs3f3'
-      #when no user_data was found, data is empty, you may want to handle that seperatly...
-      #your user model must have an identifier column
+      data = RPXNow.user_data(params[:token],'YOUR RPX API KEY')
       self.current_user = User.find_by_identifier(data[:identifier]) || User.create!(data)
       redirect_to '/'
     end
@@ -49,6 +50,10 @@ Controller
     # request extended parameters (most users and APIs do not supply them)
     RPXNow.user_data(params[:token],'YOUR RPX API KEY',:extended=>'true'){|raw| ...have a look at the RPX API DOCS...}
 
+    # you can provide the api key once, and leave it out on all following calls
+    RPXNow.api_key = 'YOUR RPX API KEY'
+    RPXNow.user_data(params[:token],:extended=>'true')
+
 Advanced: Mappings
 ------------------
 You can map your primary keys (e.g. user.id) to identifiers, so that  

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 3

data/lib/rpx_now.rb

@@ -2,10 +2,13 @@ require 'activesupport'
 module RPXNow
   extend self
 
+  attr_writer :api_key
+
   # retrieve the users data, or return nil when nothing could be read/token was invalid or data was not found
-  def user_data(token,api_key,parameters={})
+  def user_data(token,*args)
+    api_key, parameters = extract_key_and_options(args)
     begin
-      data = secure_json_post('https://rpxnow.com/api/v2/auth_info',{:token=>token,:apiKey=>api_key}.merge(parameters))
+      data = secure_json_post('https://rpxnow.com/api/v2/auth_info',{:token=>token,:apiKey=>api_key||@api_key}.merge(parameters))
     rescue ServerError
       return nil if $!.to_s =~ /token/ or $!.to_s=~/Data not found/
       raise
@@ -14,18 +17,19 @@ module RPXNow
   end
 
   # maps an identifier to an primary-key (e.g. user.id)
-  def map(identifier,primary_key,api_key,options={})
-    secure_json_post('https://rpxnow.com/api/v2/map',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key}.merge(options))
+  def map(identifier,primary_key,*args)
+    api_key, options = extract_key_and_options(args)
+    secure_json_post('https://rpxnow.com/api/v2/map',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key||@api_key}.merge(options))
   end
 
   # un-maps an identifier to an primary-key (e.g. user.id)
-  def unmap(identifier,primary_key,api_key)
-    secure_json_post('https://rpxnow.com/api/v2/unmap',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key})
+  def unmap(identifier,primary_key,api_key=nil)
+    secure_json_post('https://rpxnow.com/api/v2/unmap',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key||@api_key})
   end
 
   # returns an array of identifiers which are mapped to one of your primary-keys (e.g. user.id)
-  def mappings(primary_key,api_key)
-    data = secure_json_post('https://rpxnow.com/api/v2/mappings',{:primaryKey=>primary_key,:apiKey=>api_key})
+  def mappings(primary_key,api_key=nil)
+    data = secure_json_post('https://rpxnow.com/api/v2/mappings',{:primaryKey=>primary_key,:apiKey=>api_key||@api_key})
     data['identifiers']
   end
 
@@ -56,6 +60,19 @@ EOF
   end
 
 private
+  # [API_KEY,{options}] or
+  # [{options}] or
+  # []
+  def extract_key_and_options(args)
+    if args.length == 2
+      [args[0],args[1]]
+    elsif args.length==1
+      if args[0].is_a? Hash then [@api_key,args[0]] else [args[0],{}] end
+    else
+      raise unless @api_key
+      [@api_key,{}]
+    end
+  end
 
   def read_user_data_from_response(response)
     user_data = response['profile']

data/spec/rpx_now_spec.rb

@@ -3,6 +3,18 @@ require File.expand_path("spec_helper", File.dirname(__FILE__))
 API_KEY = '4b339169026742245b754fa338b9b0aebbd0a733'
 
 describe RPXNow do
+  before do
+    RPXNow.api_key=nil
+  end
+
+  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 '{"stat":"ok"}'
+      RPXNow.mappings(1)
+    end
+  end
+
   describe :embed_code do
     it "contains the subdomain" do
       RPXNow.embed_code('xxx','my_url').should =~ /xxx/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-rpx_now
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: 0.3.1
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-28 00:00:00 -08:00
+date: 2009-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,45 +21,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: Helper to simplify RPX Now user login/creation
+description: 
 email: grosser.michael@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- CHANGELOG
-- lib/rpx_now.rb
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- Manifest
-- CHANGELOG
+- VERSION.yml
+- README.markdown
 - lib/rpx_now.rb
 - spec/rpx_now_spec.rb
 - spec/spec_helper.rb
-- rpx_now.gemspec
-- init.rb
-- Rakefile
-- README.markdown
 has_rdoc: true
 homepage: http://github.com/grosser/rpx_now
 post_install_message: 
 rdoc_options: 
-- --line-numbers
 - --inline-source
-- --title
-- Rpx_now
-- --main
-- README.markdown
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,11 +53,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
-rubyforge_project: rpx_now
+rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2

data/CHANGELOG

@@ -1 +0,0 @@
-0.3 -- RPXNow::ServerError will be thrown when something is invalid/goes wrong, so watch out (not for invalid tokens in user_data)...

data/Rakefile

@@ -1,21 +0,0 @@
-require 'rubygems'
-require 'echoe'
-
-desc "Run all specs in spec directory"
-task :test do |t|
-  options = "--colour --format progress --loadby --reverse"
-  files = FileList['spec/**/*_spec.rb']
-  system("spec #{options} #{files}")
-end
-
-#Gemspec
-porject_name = 'rpx_now'
-Echoe.new(porject_name , '0.3') do |p|
-  p.description    = "Helper to simplify RPX Now user login/creation"
-  p.url            = "http://github.com/grosser/#{porject_name}"
-  p.author         = "Michael Grosser"
-  p.email          = "grosser.michael@gmail.com"
-  p.dependencies   = %w[activesupport]
-end
-
-task :update_gemspec => [:manifest, :build_gemspec]

data/init.rb

@@ -1 +0,0 @@
-require 'rpx_now'

data/rpx_now.gemspec

@@ -1,37 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{rpx_now}
-  s.version = "0.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michael Grosser"]
-  s.date = %q{2009-01-28}
-  s.description = %q{Helper to simplify RPX Now user login/creation}
-  s.email = %q{grosser.michael@gmail.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/rpx_now.rb", "README.markdown"]
-  s.files = ["Manifest", "CHANGELOG", "lib/rpx_now.rb", "spec/rpx_now_spec.rb", "spec/spec_helper.rb", "rpx_now.gemspec", "init.rb", "Rakefile", "README.markdown"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/grosser/rpx_now}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rpx_now", "--main", "README.markdown"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{rpx_now}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Helper to simplify RPX Now user login/creation}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_development_dependency(%q<echoe>, [">= 0"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<echoe>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<echoe>, [">= 0"])
-  end
-end