openid_registrable 0.0.2

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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/README.rdoc

@@ -0,0 +1,52 @@
+= OpenidRegistrable
+
+OpenidRegistrable is gem for Rails. It makes possible define required and optional fields for registration via OpenID and to map them to fields of your model.
+
+== Usage
+
+ class User < ActiveRecord::Base
+   openid_registrable :required_fields => {
+       :email => 'http://axschema.org/contact/email',
+     },
+     :optional_fields => {
+       :first_name => 'http://axschema.org/namePerson/first',
+       :last_name => 'http://axschema.org/namePerson/last',
+     }
+ end
+
+ User.openid_required_fields => ['http://axschema.org/contact/email']
+ User.openid_optional_fields => ['http://axschema.org/namePerson/first', 'http://axschema.org/namePerson/last']
+
+ User.openid_fields_to_model_fields_mapping =>
+
+ {:email => 'http://axschema.org/contact/email'
+  :first_name => 'http://axschema.org/namePerson/first',
+  :last_name => 'http://axschema.org/namePerson/last'
+ }
+
+ # assign fields
+ @user = User.new
+ @user.assign_openid_fields(openid_ax_data)
+ @user.save
+
+=== Usage with open_id_authentication
+https://github.com/Velir/open_id_authentication
+
+ authenticate_with_open_id(@openid_identifier, :required => User.openid_required_fields, :optional => User.openid_optional_fields) do |result, identity_url, sreg_data, ax_data|
+   if result.successful?
+     if self.current_user = User.find_by_identity_url(identity_url)
+       current_user.assign_openid_fields(ax_data, [:username])
+
+       current_user.changes.empty? ? successful_login : successful_login(edit_user_path(:user => current_user.attributes))
+     else
+       self.current_user = User.new(:identity_url => identity_url)
+       current_user.assign_openid_fields(ax_data)
+
+       successful_login(registration_via_openid_path(:user => current_user.attributes))
+     end
+   else
+     failed_login result.message
+   end
+ end
+
+Copyright (c) 2011 Vít Krchov, KRAXNET s.r.o., released under the MIT license

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OpenidRegistrable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/openid_registrable.rb

@@ -0,0 +1,3 @@
+require 'openid_registrable/openid_registrable'
+
+ActiveRecord::Base.send(:include, OpenidRegistrable)

data/lib/openid_registrable/openid_registrable.rb

@@ -0,0 +1,94 @@
+# Makes possible define required and optional fields for registration via OpenID
+# and to map them to fields of your model.
+
+module OpenidRegistrable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    # Using:
+    #
+    # class User < ActiveRecord::Base
+    #   openid_registrable :required_fields => {
+    #       :email => 'http://axschema.org/contact/email',
+    #     },
+    #     :optional_fields => {
+    #       :first_name => 'http://axschema.org/namePerson/first',
+    #       :last_name => 'http://axschema.org/namePerson/last',
+    #     }
+    # end
+
+    def openid_registrable(options)
+      [:required_fields, :optional_fields].each do |fields|
+        unless options[fields].empty?
+          (class << self; self; end).instance_eval do
+            # define methods openid_require_fields and openid_optional_fields
+            # methods returns array generated from options given in #openid_registrable, e.g.:
+            # => ['http://axschema.org/namePerson/first', 'http://axschema.org/namePerson/last']
+            define_method "openid_#{fields}" do
+              options[fields].values
+            end
+          end
+        end
+      end
+
+      # define method :openid_fields_to_model_fields_mapping
+      # method returns hash genered from options given in #openid_registrable, e.g.:
+      # => {:first_name=>"http://axschema.org/namePerson/first",
+      #     :last_name=>"http://axschema.org/namePerson/last"}
+
+      if options[:required_fields] or options[:optional_fields]
+        (class << self; self; end).instance_eval do
+          define_method :openid_fields_to_model_fields_mapping do
+            mapping = {}
+            mapping.merge!(options[:required_fields]) if options[:required_fields]
+            mapping.merge!(options[:optional_fields]) if options[:optional_fields]
+          end
+        end
+      end
+
+      send :include, InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+
+    # Using with open_id_authentication (https://github.com/Velir/open_id_authentication)
+    #
+    # authenticate_with_open_id(@openid_identifier, :required => User.openid_required_fields, :optional => User.openid_optional_fields) do |result, identity_url, sreg_data, ax_data|
+    #   if result.successful?
+    #     if self.current_user = User.find_by_identity_url(identity_url)
+    #       current_user.assign_openid_fields(ax_data, [:username])
+    #
+    #       current_user.changes.empty? ? successful_login : successful_login(edit_user_path(:user => current_user.attributes))
+    #     else
+    #       self.current_user = User.new(:identity_url => identity_url)
+    #       current_user.assign_openid_fields(ax_data)
+    #
+    #       successful_login(registration_via_openid_path(:user => current_user.attributes))
+    #     end
+    #   else
+    #     failed_login result.message
+    #   end
+    # end
+
+    def assign_openid_fields(openid_fields, ignored_fields=[])
+      if self.class.respond_to?(:openid_fields_to_model_fields_mapping)
+        self.class.openid_fields_to_model_fields_mapping.each do |model_field, openid_field|
+
+          if openid_fields[openid_field].kind_of?(Array)
+            value = openid_fields[openid_field].first
+          else
+            value = openid_fields[openid_field]
+          end
+
+          if value.present? and not ignored_fields.include?(model_field)
+            self.send("#{model_field}=", value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openid_registrable/version.rb

@@ -0,0 +1,3 @@
+module OpenidRegistrable
+  VERSION = '0.0.2'
+end

data/openid_registrable.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/openid_registrable/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "openid_registrable"
+  s.summary = "Adds to ActiveRecord model method for defining required and optional fields for registration via OpenID."
+  s.description = "OpenidRegistrable is gem for Rails. It makes possible define required and optional fields for registration via OpenID and to map them to fields of your model."
+  s.authors = ['Vít Krchov']
+  s.email = 'vit.krchov@gmail.com'
+  s.homepage = 'https://github.com/vita/openid_registrable'
+
+  s.version = OpenidRegistrable::VERSION
+  s.platform = Gem::Platform::RUBY
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+
+  s.add_dependency 'rails'
+
+  s.add_development_dependency 'turn'
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'sqlite3'
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,14 @@
+class User < ActiveRecord::Base
+  openid_registrable :required_fields => {
+      :email => 'http://axschema.org/contact/email',
+      :username => 'http://axschema.org/namePerson/friendly',
+    },
+    :optional_fields => {
+      :first_name => 'http://axschema.org/namePerson/first',
+      :last_name => 'http://axschema.org/namePerson/last',
+      :address => 'http://axschema.org/contact/postalAddress/home',
+      :city => 'http://axschema.org/contact/city/home',
+      :zip => 'http://axschema.org/contact/postalCode/home',
+      :phone => 'http://axschema.org/contact/phone/default'
+    }
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "openid_registrable"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end