ninsho 0.0.1 → 0.0.2

data/README.md

@@ -123,7 +123,10 @@ en:
 
 ### Changelog
 
-* Current gem version 0.0.1
+* Current gem version 0.0.2
+* Add more documentation on code
+* Add aouth token for Facebook friends
+* Released gem version 0.0.1
 
 ### Devs
 
@@ -135,8 +138,7 @@ en:
 * Add tests
 * Support for Mongoid
 * Add handy helpers
-* Add aouth token for Facebook friends
-* Add more documentation on code
+
 
 ## Credits
 Icalia Labs - weare@icalialabs.com
@@ -146,7 +148,17 @@ Icalia Labs - weare@icalialabs.com
 
 [Like us on Facebook](https://www.facebook.com/icalialab "Like us on Facebook")
 
+### Special thanks
+
+Inspired by the plataformatec guys, and pieces of code based on you! Thanks!
+
+https://github.com/plataformatec/
 
 ### License
 
 MIT License. Copyright 2012-2013 IcaliaLabs. http://icalialabs.com
+
+
+
+
+

data/app/controllers/ninsho/sessions_controller.rb

@@ -4,6 +4,7 @@ class Ninsho::SessionsController < NinshoController
     @providers = Ninsho.providers
   end
 
+  # Handles the omniauth record creation
   def create
     resource = build_resource_from_omniauth
     if resource.authenticated?

data/app/controllers/ninsho_controller.rb

@@ -14,6 +14,7 @@ class NinshoController < Ninsho.parent_controller.constantize
     instance_variable_get(:"@#{resource_name}")
   end
 
+  # Omniauth hash for creating the records
   def resource_params
     env['omniauth.auth']
   end
@@ -23,6 +24,8 @@ class NinshoController < Ninsho.parent_controller.constantize
     Ninsho.resource_name #authentication
   end
 
+  # Class name for the ninsho model
+  # commonly Authentication
   def resource_class
     Ninsho.resource_class 
   end
@@ -32,13 +35,12 @@ class NinshoController < Ninsho.parent_controller.constantize
     instance_variable_set(:"@#{resource_name}", new_resource)
   end
 
-  # Parent resource
+  # Parent resource, commonly user
   def parent_resource
     resource_class.reflect_on_all_associations(:belongs_to).first.name.to_s
   end
 
-  # Build a ninsho resource.
-  # Assignment bypasses attribute protection when :unsafe option is passed
+  # Build a ninsho resource, from the omniauth hash
   def build_resource_from_omniauth 
       self.resource = resource_class.from_omniauth(resource_params)
   end

data/lib/generators/active_record/ninsho_generator.rb

@@ -40,10 +40,11 @@ CONTENT
 
        def migration_data
 <<RUBY
-      ## Database authentications 
+      ## Ninsho model fields
       t.integer :user_id
       t.string :provider
       t.string :uid
+      t.string :oauth_token
 RUBY
       end
     end

data/lib/generators/ninsho/views_generator.rb

@@ -2,7 +2,6 @@ module Ninsho
   module Generators
     # Include this module in your generator to generate Ninsho views.
     # `copy_views` is the main method and by default copies all views
-    # with forms.
     module ViewPathTemplates #:nodoc:
       extend ActiveSupport::Concern
 

data/lib/generators/templates/README

@@ -6,5 +6,9 @@ Hey you, thanks for installing Ninsho, here are some tips:
 
        rails g ninsho:views
 
+  2. Having trouble?, Check out the documentation at:
+
+       https://github.com/IcaliaLabs/ninsho
+
 ===============================================================================
 

data/lib/ninsho.rb

@@ -12,29 +12,46 @@ module Ninsho
     autoload :Helpers, 'ninsho/controllers/helpers'
   end
 
+  # The parent controller all Ninsho controllers inherits from.
+  # The Default is set to ApplicationController.
   mattr_accessor :parent_controller
   @@parent_controller = "ApplicationController"
 
+  # The name class of the resource generate by the Ninsho model generator
+  # Comonly Authentication
   mattr_accessor :resource_class
   @@resource_class = ""
 
+  # The resource name singularized and downcased
+  # Used as a proxy to map ninsho resource
+  # Used in routes on ninsho_on method
   mattr_accessor :resource_name
   @@resource_name = ""
 
+  # List all providers added in the initializer
+  # All of them are symbols
+  # [ :facebook, :twitter, :github ]
   mattr_reader :providers
   @@providers = []
 
+  # The class name for the resource relation
+  # Is commonly the class User
   mattr_accessor :parent_resource_name
   @@parent_resource_name = '' 
 
-
+  # Hash which contains omniauth configurations
   mattr_reader :omniauth_configs
   @@omniauth_configs = ActiveSupport::OrderedHash.new
   
+  # Default setup for Ninsho. 
+  # Run the rails g ninsho:install to create a fresh initializer
   def self.setup
     yield self
   end
 
+  # It is used toe get the resource class and map it with
+  # ActiveSupport to get the class name
+  # :user will become User
   class Getter
     def initialize name
       @name = name
@@ -54,6 +71,10 @@ module Ninsho
     end
   end
 
+  # Used to specify an omniauth provider
+  #
+  #   config.omniauth :facebook, 'APPD_ID', 'APP_SECRET'
+  #
   def self.omniauth(provider, *args)
     config = Ninsho::OmniAuth::Config.new(provider, args)
     @@providers << config.strategy_name.to_sym

data/lib/ninsho/authentication.rb

@@ -1,11 +1,14 @@
 module Ninsho
+  # 
+  # Responsible for manage the authentication process with the
+  # omniauth hash 
+  #
   class Authentication
-    PARENT_RESOURCE_NAME = Ninsho.parent_resource_name.to_s.downcase
-
      def initialize(omniauth = nil)
       @omniauth = omniauth
       @provider = omniauth['provider'] 
       @uid = omniauth['uid']
+      @oauth_token = @omniauth.credentials.token
       @email = omniauth['info']['email']
      end
 
@@ -13,24 +16,27 @@ module Ninsho
        user.present?
      end
 
+     # Little method to check if the record is find by the provider and uid
      def from_oauth
-       Ninsho.resource_class.find_by_provider_and_uid(@provider, @uid) 
+       Ninsho.resource_class.where(@omniauth.slice(:provider, :uid)).first_or_initialize.tap do |resource|
+         resource.provider = @provider
+         resource.uid = @uid
+         resource.oauth_token = @oauth_token
+         resource.save if resource.respond_to?(Ninsho.parent_resource_name.to_s.downcase.to_sym) && !resource.new_record?
+       end
      end
 
+     # Method to create an authentication record when user is find,
+     # otherwise creates a user with the authentication
      def from_user
        user = Ninsho.parent_resource_name.send :find_by_email, @email
-       if user
-         user.send("#{Ninsho.resource_name.pluralize}").build(provider: @provider, uid: @uid)
-         user.send(:save)
-         user
-       else
-         user = Ninsho.parent_resource_name.send :new, { email: @email }
-         user.send("#{Ninsho.resource_name.pluralize}").build(provider: @provider, uid: @uid)
-         user.send(:save)
-         user
-       end
+       user = Ninsho.parent_resource_name.send :new, { email: @email } unless user
+       user.send("#{Ninsho.resource_name.pluralize}").build(provider: @provider, uid: @uid, oauth_token: @oauth_token)
+       user.send(:save)
+       user
      end
 
+     # Check if a parent record is returned
      def user
        from_oauth.try(Ninsho.parent_resource_name.to_s.downcase.to_sym) || from_user
      end

data/lib/ninsho/controllers/helpers.rb

@@ -3,40 +3,49 @@ module Ninsho
     module Helpers
       extend ActiveSupport::Concern
 
-  RESOURCE_NAME = Ninsho.resource_name.singularize
-  PARENT_RESOURCE_NAME = Ninsho.parent_resource_name.to_s.downcase
-
-  def store_location
-    session[:return_to] = request.fullpath
-  end
-
-  def clear_return_to
-    session[:return_to] = nil 
-  end
-
-  def redirect_back_or(default)
-    redirect_to(session[:return_to] || default )
-    clear_return_to 
-  end
-
-  def after_sign_in_path_for
-    redirect_back_or redirect_to_root
-  end
-
-  def sign_out
-    session["#{PARENT_RESOURCE_NAME}_id".to_sym] = nil 
-  end
-
-  def sign_in_and_redirect(parent_id, path=nil)
-    session["#{PARENT_RESOURCE_NAME}_id".to_sym] = parent_id
-    redirect_to path
-  end
-
-  def sign_in(parent_id)
-    session["#{PARENT_RESOURCE_NAME}_id".to_sym] = parent_id
-  end
-
-  class_eval <<-METHODS, __FILE__, __LINE__ + 1
+      RESOURCE_NAME = Ninsho.resource_name.singularize
+      PARENT_RESOURCE_NAME = Ninsho.parent_resource_name.to_s.downcase
+
+      # Stores the location for better redirection
+      def store_location
+        session[:return_to] = request.fullpath
+      end
+      
+      # Clears the session after redirection is done
+      def clear_return_to
+        session[:return_to] = nil 
+      end
+
+      # Method which handles the redirection
+      def redirect_back_or(default)
+        redirect_to(session[:return_to] || default )
+        clear_return_to 
+      end
+
+      # Destroy the user session
+      def sign_out
+        session["#{PARENT_RESOURCE_NAME}_id".to_sym] = nil 
+      end
+
+      def sign_in_and_redirect(parent_id, path=nil)
+        session["#{PARENT_RESOURCE_NAME}_id".to_sym] = parent_id
+        redirect_to path
+      end
+
+      # Set the session for the authenticated user
+      def sign_in(parent_id)
+        session["#{PARENT_RESOURCE_NAME}_id".to_sym] = parent_id
+      end
+
+      # There be monsters!
+      # Creates several methods according to the parent resource
+      #
+      # authenticate_user!
+      #
+      # user_signed_in?
+      #
+      # current_user
+      class_eval <<-METHODS, __FILE__, __LINE__ + 1
     def current_#{PARENT_RESOURCE_NAME}
       @current_#{PARENT_RESOURCE_NAME} ||= #{Ninsho.parent_resource_name}.find(session[:#{PARENT_RESOURCE_NAME}_id]) if session[:#{PARENT_RESOURCE_NAME}_id] 
     end
@@ -49,31 +58,32 @@ module Ninsho
       deny_access unless #{PARENT_RESOURCE_NAME}_signed_in?
     end
 
-  METHODS
-
-  define_method "link_#{RESOURCE_NAME}_with" do |provider|
-    link_to "Connect with #{provider.to_s.capitalize}", "auth/#{provider.to_s}"
-  end
-
+    METHODS
 
-  # Method used by sessions controller to sign out a user. 
-  # You can overwrite it in your ApplicationController
-  #
-  # By default it is the root_path.
-  def redirect_on_sign_out_path
-    redirect_to_root
-  end
+    define_method "link_#{RESOURCE_NAME}_with" do |provider|
+      link_to "Connect with #{provider.to_s.capitalize}", "auth/#{provider.to_s}"
+    end
 
-  def redirect_on_sign_in_path
-    redirect_to_root
-  end
-  def redirect_to_root
-    redirect_to respond_to?(:root_path) ? root_path : "/"
-  end
 
-  def deny_access
-    redirect_to_root
-  end
+      # Method used by sessions controller to sign out a user. 
+      # You can overwrite it in your ApplicationController
+      #
+      # By default it is the root_path.
+      def redirect_on_sign_out_path
+        redirect_to_root
+      end
+
+      def redirect_on_sign_in_path
+        redirect_to_root
+      end
+      def redirect_to_root
+        redirect_to respond_to?(:root_path) ? root_path : "/"
+      end
+
+      # Redirection if user has no right to enter
+      def deny_access
+        redirect_to_root
+      end
     end
   end
 end

data/lib/ninsho/interface.rb

@@ -20,7 +20,9 @@ module Ninsho
           Ninsho.parent_resource_name = Ninsho.ref(associated_model.to_s.classify).get
         end
       end
-
+      
+      # Responsible for creating or find the record with the
+      # omniauth hash
       def from_omniauth(omniauth = nil)
         Ninsho::Authentication.new(omniauth)
       end

data/lib/ninsho/omniauth.rb

@@ -1,3 +1,4 @@
+# Thanks to plataformatec for providing this 
 begin
   require "omniauth"
   require 'omniauth/version'

data/lib/ninsho/omniauth/config.rb

@@ -7,6 +7,8 @@ module Ninsho
       end
     end
 
+    # Responsible for setting upt the configuration for omniauth
+    # providers and mount it into ninsho
     class Config
       attr_accessor :strategy
       attr_reader :args, :options, :provider, :strategy_name

data/lib/ninsho/rails.rb

@@ -7,10 +7,13 @@ module Ninsho
     # Force routes to be loaded if we are doing any eager load.
     config.before_eager_load { |app| app.reload_routes! }
 
+    # Loads then Ninsho Helpers into the Ninsho Controllers
+    # for the ones whicn inherits from have access
     ActiveSupport.on_load(:action_controller) do
       include Ninsho::Controllers::Helpers 
     end
 
+    # Setup for omniauth strategies when initializer is run
     initializer "ninsho.omniauth" do |app|
       Ninsho.omniauth_configs.each do |provider, config|
         app.middleware.use config.strategy_class, *config.args do |strategy|

data/lib/ninsho/rails/routes.rb

@@ -1,6 +1,5 @@
-
 module ActionDispatch::Routing
-  
+
 
   class Mapper
     #Includes the ninsho_on method for routes. This method is responsible
@@ -20,22 +19,21 @@ module ActionDispatch::Routing
     #       authentication_session_path POST /authentication/:provider/callback { controller: 'ninsho/sessions', action: 'create' }
     #   destroy_authentication_session_path DELETE /sign_out { controller: 'ninsho/sessions', action: 'destroy' }
     #
+    def ninsho_on(resources_name)
+      drawer = Ninsho::RoutesDrawer.new resources_name
+      Ninsho.resource_class = drawer.to
+      Ninsho.resource_name = drawer.resource
+      ninsho_session(drawer.singular_name)
+    end
 
-     def ninsho_on(resources_name)
-       drawer = Ninsho::RoutesDrawer.new resources_name
-       Ninsho.resource_class = drawer.to
-       Ninsho.resource_name = drawer.resource
-       ninsho_session(drawer.singular_name)
-     end
-
-     protected
+    protected
 
-     def ninsho_session(name) #:nodoc:
-       resource :session, :only => [], :controller => 'ninsho/sessions', :path => "" do
-       get :new, :path => 'sign_in', as: "new_#{name}"
-       match :create, path: "auth/:provider/callback", as: "#{name}"
-       delete :destroy, path: 'sign_out', as: "destroy_#{name}"
-     end
-     end
+    def ninsho_session(name) #:nodoc:
+      resource :session, :only => [], :controller => 'ninsho/sessions', :path => "" do
+        get :new, :path => 'sign_in', as: "new_#{name}"
+        match :create, path: "auth/:provider/callback", as: "#{name}"
+        delete :destroy, path: 'sign_out', as: "destroy_#{name}"
+      end
+    end
   end
 end

data/lib/ninsho/railtie.rb

@@ -1,4 +1,7 @@
 module Ninsho
+  # Responsible for loading and mounting the Ninsho::Interface method on
+  # ActiveRecord, which allows it to add the belongs_to_ninsho method
+  # inside models
   class Railtie < Rails::Railtie
     ActiveSupport.on_load :active_record do
       ActiveRecord::Base.send :include, Ninsho::Interface

data/lib/ninsho/routes_drawer.rb

@@ -3,6 +3,8 @@ module Ninsho
   # The required value in ninsho_on is actually not used internally, but it's
   # inflected to find all other values.
   #
+  # routes_drawer.to #=> Authentication
+  #
   class RoutesDrawer #:nodoc:
     attr_reader :singular_name, :klass, :resource
 

data/lib/ninsho/version.rb

@@ -1,3 +1,3 @@
 module Ninsho
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ninsho
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter