ruby-mojeid 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/examples/README

@@ -1,32 +1,16 @@
-This directory contains several examples that demonstrate use of the
-OpenID library.  Make sure you have properly installed the library
-before running the examples.  These examples are a great place to
-start in integrating OpenID into your application.
+This directory contains example that demonstrate use of the
+ruby-mojeID library.  Make sure you have properly installed the library
+before running the example.  These example are a great place to
+start in integrating ruby-mojeID into your application.
 
 ==Rails example
 
-The rails_openid contains a fully functional OpenID server and relying
-party, and acts as a starting point for implementing your own
-production rails server.  You'll need the latest version of Ruby on
-Rails installed, and then:
+You'll need the Ruby on Rails 2.3.9 installed, and then:
 
  cd rails_openid
  ./script/server
 
-Open a web browser to http://localhost:3000/ and follow the instructions.
+Open a web browser to http://localhost:3000/ and try to get data or store data.
 
-The relevant code to work from when writing your Rails OpenID Relying
-Party is: 
-  rails_openid/app/controllers/consumer_controller.rb
-If you are working on an OpenID provider, check out
-  rails_openid/app/controllers/server_controller.rb
 
-Since the library and examples are Apache-licensed, don't be shy about 
-copy-and-paste.
-
-==Rails ActiveRecord OpenIDStore plugin
-
-For various reasons you may want or need to deploy your ruby openid
-consumer/server using an SQL based store.  The active_record_openid_store 
-is a plugin that makes using an SQL based store simple.  Follow the
-README inside the plugin's dir for usage.
+For more examples how to use ruby-OpenID, please look at https://github.com/openid/ruby-openid

data/examples/rails_openid/Gemfile

@@ -4,4 +4,4 @@ source 'http://gems.github.com'
 
 gem 'rails', '2.3.9'
 gem "mysql", '2.7'
-gem 'ruby-mojeid', :path => "/home/robin/rails_workspace/ruby-mojeid"
+gem 'ruby-mojeid'

data/examples/rails_openid/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /home/robin/rails_workspace/ruby-mojeid
   specs:
-    ruby-mojeid (0.1.0)
+    ruby-mojeid (0.2.0)
       ruby-openid (= 2.1.8)
       ruby-openid (= 2.1.8)
 

data/examples/rails_openid/README

@@ -1,153 +1,6 @@
-== Welcome to Rails
+This app contains 2 examples how to manipulate with ruby-mojeID library.
 
-Rails is a web-application and persistence framework that includes everything
-needed to create database-backed web-applications according to the
-Model-View-Control pattern of separation. This pattern splits the view (also
-called the presentation) into "dumb" templates that are primarily responsible
-for inserting pre-built data in between HTML tags. The model contains the
-"smart" domain objects (such as Account, Product, Person, Post) that holds all
-the business logic and knows how to persist themselves to a database. The
-controller handles the incoming requests (such as Save New Account, Update
-Product, Show Post) by manipulating the model and directing data to the view.
-
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in 
-link:files/vendor/rails/activerecord/README.html.
-
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails.  You can read more about Action Pack in 
-link:files/vendor/rails/actionpack/README.html.
-
-
-== Getting started
-
-1. Run the WEBrick servlet: <tt>ruby script/server</tt> (run with --help for options)
-   ...or if you have lighttpd installed: <tt>ruby script/lighttpd</tt> (it's faster)
-2. Go to http://localhost:3000/ and get "Congratulations, you've put Ruby on Rails!"
-3. Follow the guidelines on the "Congratulations, you've put Ruby on Rails!" screen
-
-
-== Example for Apache conf
-
-  <VirtualHost *:80>
-    ServerName rails
-    DocumentRoot /path/application/public/
-    ErrorLog /path/application/log/server.log
-  
-    <Directory /path/application/public/>
-      Options ExecCGI FollowSymLinks
-      AllowOverride all
-      Allow from all
-      Order allow,deny
-    </Directory>
-  </VirtualHost>
-
-NOTE: Be sure that CGIs can be executed in that directory as well. So ExecCGI
-should be on and ".cgi" should respond. All requests from 127.0.0.1 go
-through CGI, so no Apache restart is necessary for changes. All other requests
-go through FCGI (or mod_ruby), which requires a restart to show changes.
-
-
-== Debugging Rails
-
-Have "tail -f" commands running on both the server.log, production.log, and
-test.log files. Rails will automatically display debugging and runtime
-information to these files. Debugging info will also be shown in the browser
-on requests from 127.0.0.1.
-
-
-== Breakpoints
-
-Breakpoint support is available through the script/breakpointer client. This
-means that you can break out of execution at any point in the code, investigate
-and change the model, AND then resume execution! Example:
-
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.find_all
-      breakpoint "Breaking out from the list"
-    end
-  end
-  
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the breakpointer window. Here you can do things like:
-
-Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
-
-  >> @posts.inspect
-  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, 
-       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
-  >> @posts.first.title = "hello from a breakpoint"
-  => "hello from a breakpoint"
-
-...and even better is that you can examine how your runtime objects actually work:
-
-  >> f = @posts.first 
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
-
-Finally, when you're ready to resume execution, you press CTRL-D
-
-
-== Console
-
-You can interact with the domain model by starting the console through script/console. 
-Here you'll have all parts of the application configured, just like it is when the
-application is running. You can inspect domain models, change values, and save to the
-database. Starting the script without arguments will launch it in the development environment.
-Passing an argument will specify a different environment, like <tt>console production</tt>.
-
-
-== Description of contents
-
-app
-  Holds all the code that's specific to this particular application.
-
-app/controllers
-  Holds controllers that should be named like weblog_controller.rb for
-  automated URL mapping. All controllers should descend from
-  ActionController::Base.
-
-app/models
-  Holds models that should be named like post.rb.
-  Most models will descend from ActiveRecord::Base.
-  
-app/views
-  Holds the template files for the view that should be named like
-  weblog/index.rhtml for the WeblogController#index action. All views use eRuby
-  syntax. This directory can also be used to keep stylesheets, images, and so on
-  that can be symlinked to public.
-  
-app/helpers
-  Holds view helpers that should be named like weblog_helper.rb.
-
-config
-  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
-
-components
-  Self-contained mini-applications that can bundle together controllers, models, and views.
-
-lib
-  Application specific libraries. Basically, any kind of custom code that doesn't
-  belong under controllers, models, or helpers. This directory is in the load path.
-    
-public
-  The directory available for the web server. Contains subdirectories for images, stylesheets,
-  and javascripts. Also contains the dispatchers and the default HTML files.
-
-script
-  Helper scripts for automation and generation.
-
-test
-  Unit and functional tests along with fixtures.
-
-vendor
-  External libraries that the application depends on. Also includes the plugins subdirectory.
-  This directory is in the load path.
+1) How to retrieve data form user mojeID account
+  - controller actions named: "start_get_data" and "complete_get_data"
+2) How to post data to user mojeID account
+  - controller actions named: "start_update_data" and "complete_update_data"

data/examples/rails_openid/app/controllers/consumer_controller.rb

@@ -2,23 +2,29 @@ class ConsumerController < ApplicationController
   layout nil
 
   def index
-    # render an openid form
   end
 
 
-  # EXAMPLE HOW TO RETRIEVE DATA FROM MOJEID
+  # Example how to retrieve data from mojeID
   def start_get_data
     begin
       identifier = params[:openid_identifier].to_s + params[:openid_domain].to_s
+
+      # First, try to create request to mojeID server with user identifier
       @moje_id = MojeID.fetch_request(consumer, identifier)
     rescue OpenID::OpenIDError => e
       flash[:error] = "Discovery failed for #{identifier}: #{e}"
       return redirect_to :action => 'index'
     end
-    
+
+    # Next you can add to your request all attributes, you would like to get.
     @moje_id.add_attributes(MojeIDAttributes::AVAILABLE_ATTRIBUTES[0..3])
+
+    # Setup your realm and return_to path.
     @moje_id.return_to = url_for(:action => 'complete_get_data', :only_path => false)
     @moje_id.realm = url_for(:action => 'index', :id => nil, :only_path => false)
+
+    # Redirect to generated url
     redirect_to @moje_id.redirect_url
   end
 
@@ -30,7 +36,7 @@ class ConsumerController < ApplicationController
   end
 
 
-  # EXAMPLE HOW TO UPDATE DATA TO MOJEID
+  # Example how to update data to mojeID
   def start_update_data
     begin
       identifier = params[:openid_identifier]
@@ -53,6 +59,10 @@ class ConsumerController < ApplicationController
     render :action => 'index'
   end
 
+
+
+  
+
   private
 
   require 'openid/store/memcache'

data/examples/rails_openid/app/views/consumer/index.rhtml

@@ -1,6 +1,6 @@
 <html>
   <head>
-    <title>Rails OpenID Example Relying Party</title>
+    <title>Rails mojeID Example</title>
   </head>
   <style type="text/css">
     * {
@@ -41,7 +41,7 @@
     table tr th {background: #dddddd; text-align: left;}
   </style>
   <body>
-    <h1>Rails OpenID Example Relying Party</h1>
+    <h1>Rails mojeID Example</h1>
     <% if flash[:alert] %>
       <div class='alert'>
         <%= h(flash[:alert]) %>

data/lib/available_attributes.rb

@@ -1,4 +1,4 @@
-#for more informations about attributes look at http://www.mojeid.cz/page/800/jak-zavest-mojeid-/
+# for more informations about attributes look at http://www.mojeid.cz/page/800/jak-zavest-mojeid-/
 
 module MojeIDAttributes
   AVAILABLE_ATTRIBUTES = %w(

data/lib/ruby-mojeid.rb

@@ -5,6 +5,22 @@ require 'available_attributes'
 class MojeID
   attr_accessor :moje_id_request, :moje_id_response, :fetch_request, :fetch_response, :realm, :return_to
 
+  # Prepare request for openid server 
+  # 
+  # openid_identifier is user identifier like fullname.mojeid.cz
+  # consumer is object of OpenID::Consumer class.
+  #
+  # here is example how to create consumer
+  # * store = OpenID::Store::Memcache.new(MemCache.new('localhost:11211'))
+  # * @consumer = OpenID::Consumer.new(session, store)
+  #
+  # You can choose if you will be read data or store data by request_type param
+  # * request_type == :get mean that you will be read data about user
+  # * request_type == :put mean that you will be store data about user
+  #
+  # here is example how to create MojeID fetch request
+  # * @moje_id = MojeID.fetch_request(@consumer, 'fullname.mojeid.cz')
+
   def self.fetch_request(consumer, openid_identifier, request_type = :get)
     moje_id = MojeID.new
     moje_id.moje_id_request = consumer.begin(openid_identifier)
@@ -12,6 +28,17 @@ class MojeID
     moje_id
   end
 
+  # Get response from openid server
+  #
+  # * consumer is object of OpenID::Consumer class, like in the fetch_request method
+  # * params are a params from request which openid server send to you
+  # * request is a request object from controller. It is necessary to remove dirty params
+  # * current_url is url of action which recieve the openid server response
+  # * with request_type you say, if this response become from get request or put request
+  #
+  # here is example how to create MojeID fetch response 
+  # * @moje_id = MojeID.fetch_response(@consumer, params, request, url_for(:action => 'complete_update_data', :only_path => false), :put)
+
   def self.fetch_response(consumer, params, request, current_url, request_type = :get)
     moje_id = MojeID.new
     parameters = params.reject{|k,v| request.path_parameters[k]}
@@ -20,51 +47,75 @@ class MojeID
     moje_id
   end
 
+
+  # Return the status of openid server response
+  # the statuses are :
+  # * OpenID::Consumer::FAILURE
+  # * OpenID::Consumer::SUCCESS
+  # * OpenID::Consumer::SETUP_NEEDED
+  # * OpenID::Consumer::CANCEL
+  
   def response_status
     fetch_response.status
   end
 
+  # Return the openid identifier like fullname.mojeid.cz
   def identifier
     fetch_response.display_identifier
   end
 
+  # Return the response message
   def message
-    fetch_response.display_identifier
+    fetch_response.message
   end
 
+  # Return data parsed to Hash, if it is a "fetch_response" with request_type == :get, else return blank Hash
   def data
     (!moje_id_response.nil? && moje_id_response.respond_to?('data') ) ? moje_id_response.data : {}
   end
 
+  # Add attributes you would like to read about user, to request.
+  # You can pass attribute as array and change options like ns_alias or require.
+  # * example: @moje_id.add_attributes(['http://axschema.org/namePerson', nil, false])
+  # * or simple : @moje_id.add_attributes('http://axschema.org/namePerson')
   def add_attributes(attributes = [])
-    attributes.each{ |attribute| add_attribute(attribute)}
+    attributes.each{ |attribute| attribute.is_a?(Array) ? add_attribute(attribute[0], attribute[1], attribute[2]) : add_attribute(attribute)}
   end
-  
+
+  # Add attributes and they values which you would like to update user profile, to request.
+  # Accept hash like {'http://axschema.org/namePerson' => 'my new great name'}
   def update_attributes(data = {})
-    data.each{ |attribute,value| set_attribute(attribute, value)}
+    data.each{ |attribute, value| set_attribute(attribute, value)}
   end
 
+  # Add additional data to request
+  # Accept hash like {'is_this_my_request' => 'yes'}
   def add_additional_data(data = {})
     data.each{|k,v| moje_id_request.return_to_args[k.to_s] = v}
     bundle_to_request
   end
-  
+
+  # Should this OpenID authentication request be sent as a HTTP redirect or as a POST (form submission)?
   def send_redirect?(immediate = false)
     moje_id_request.send_redirect?(realm, return_to, immediate)
   end
 
+  # Return the url you have to redirect after you compose your request
   def redirect_url(immediate = false)
     moje_id_request.redirect_url(realm, return_to, immediate)
   end
 
+  # Get a complete HTML document that autosubmits the request to the IDP with javascript.
   def html_markup(realm, return_to, immediate = false, form_tag_attrs = {})
     moje_id_request.html_markup(realm, return_to, immediate, form_tag_attrs)
   end
 
+  # Return a value of attribute, when you recieve a data from openid server
   def get_attribute_value(attribute)
     data[attribute]
   end
 
+  
   def set_fetch_request_by_type(request_type)
     self.fetch_request = case request_type
     when :get then OpenID::AX::FetchRequest.new
@@ -84,14 +135,16 @@ class MojeID
   def bundle_to_request
     moje_id_request.add_extension(fetch_request)
   end
-  
-  def add_attribute(attribute)
+
+  # Pack attribute to request when you would like to get attribute
+  def add_attribute(attribute, ns_alais = nil, required = false)
     if MojeID.is_attribute_available?(attribute)
-      fetch_request.add(OpenID::AX::AttrInfo.new(attribute))
+      fetch_request.add(OpenID::AX::AttrInfo.new(attribute, ns_alais, required))
       bundle_to_request
     end
   end
 
+  # Pack attribute and his value to request when you would like to store attribute
   def set_attribute(attribute, value)
     if MojeID.is_attribute_available?(attribute)
       fetch_request.set_values(attribute, value)
@@ -99,6 +152,7 @@ class MojeID
     end
   end
 
+  # Check if the attribute is available. You can find full list of attributes in lib/available_attributes.rb
   def self.is_attribute_available?(attribute)
     MojeIDAttributes::AVAILABLE_ATTRIBUTES.include?(attribute) ? true : raise("#{attribute} is not available")
   end

data/ruby-mojeid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-mojeid}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robin Bortlik"]
-  s.date = %q{2011-01-28}
+  s.date = %q{2011-01-31}
   s.description = %q{This gem extend ruby-openid gem}
   s.email = %q{robinbortlik@gmail.com}
   s.extra_rdoc_files = [
@@ -32,7 +32,6 @@ Gem::Specification.new do |s|
     "examples/rails_openid/app/controllers/application_controller.rb",
     "examples/rails_openid/app/controllers/consumer_controller.rb",
     "examples/rails_openid/app/views/consumer/index.rhtml",
-    "examples/rails_openid/app/views/layouts/server.rhtml",
     "examples/rails_openid/config/boot.rb",
     "examples/rails_openid/config/database.sample.yml",
     "examples/rails_openid/config/environment.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-mojeid
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Robin Bortlik
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-28 00:00:00 +01:00
+date: 2011-01-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -135,7 +135,6 @@ files:
 - examples/rails_openid/app/controllers/application_controller.rb
 - examples/rails_openid/app/controllers/consumer_controller.rb
 - examples/rails_openid/app/views/consumer/index.rhtml
-- examples/rails_openid/app/views/layouts/server.rhtml
 - examples/rails_openid/config/boot.rb
 - examples/rails_openid/config/database.sample.yml
 - examples/rails_openid/config/environment.rb

data/examples/rails_openid/app/views/layouts/server.rhtml

@@ -1,68 +0,0 @@
-<html>
-  <head><title>OpenID Server Example</title></head>
-  <style type="text/css">
-      * {
-        font-family: verdana,sans-serif;
-      }
-      body {
-        width: 50em;
-        margin: 1em;
-      }
-      div {
-        padding: .5em;
-      }
-      table {
-        margin: none;
-        padding: none;
-      }
-      .notice {
-        border: 1px solid #60964f;
-        background: #b3dca7;
-      }
-      .error {
-        border: 1px solid #ff0000;
-        background: #ffaaaa;
-      }
-      #login-form {
-        border: 1px solid #777777;
-        background: #dddddd;
-        margin-top: 1em;
-        padding-bottom: 0em;
-      }
-      table {
-        padding: 1em;
-      }
-      li {margin-bottom: .5em;}
-      span.openid:before {
-        content: url(<%= @base_url %>images/openid_login_bg.gif) ;
-      }
-      span.openid {
-        font-size: smaller;
-      }
-  </style>
-  <body>
-
-
-
-    <% if session[:username] %>
-      <div style="float:right;">
-        Welcome, <%= session[:username] %> | <%= link_to('Log out', :controller => 'login', :action => 'logout') %><br />
-	<span class="openid"><%= @base_url %>user/<%= session[:username] %></span>
-      </div>
-    <% end %>
-
-    <h3>Ruby OpenID Server Example</h3>
-
-    <hr/>
-
-    <% if flash[:notice] or flash[:error] %>
-     <div class="<%= flash[:notice].nil? ? 'error' : 'notice' %>">
-       <%= flash[:error] or flash[:notice] %>
-     </div>
-    <% end %>
-
-    <%= @content_for_layout %>
-
-
-  </body>
-</html>