userbin 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cca8bc4a6426e0d967af3cc4746ff35f0ec24d43
-  data.tar.gz: 70f0ad7d7a4b46f9603aee952b7451be197c0eba
+  metadata.gz: 7a6270eb20148c6bebb1da458c2a6430ace408da
+  data.tar.gz: 2d901a0419f4604cb4a65e85c6a6b7c74a7e266b
 SHA512:
-  metadata.gz: 55cfd4067825ff8db777b0d188c95f7a631a12d201b335503c037ca2c50e25c9f923c41f4d8b3e1cc5532802b473aa161340d3029980fa6f05501a0c06fc7e14
-  data.tar.gz: 46d8f465f92b40b9c606a844850fadee936fc131c70717a5e74693de617d9267b40c4e4fd28426f590a869316d2c941f572008f28e8b0b9f00cc4063c322d498
+  metadata.gz: d1f7c44451117fed832fc641fcf0116656c43d6ec9639065da58d8173974d48020a89e4c12f7b34dd304325b73e1952fce8b044dead9cd8aabdb17a8330be333
+  data.tar.gz: 02de0cea84a2f0bc8e3830e91754623f44b7e2d4fb0926b0ba90037b8e8b649397e67ea2b8cf5619eb548edb6f99770168243149f8c634cf827ef04763c7bd30

data/README.md

@@ -14,7 +14,7 @@ Userbin for Ruby adds user authentication, login flows and user management to yo
 Installation
 ------------
 
-1.  Add the `userbin` gem to your `Gemfile`
+1. Add the `userbin` gem to your `Gemfile`
 
     ```ruby
     gem "userbin"
@@ -26,7 +26,7 @@ Installation
     bundle install
     ```
 
-1.  Configure the Userbin module with the credentials you got from signing up.
+2.  Configure the Userbin module with the credentials you got from signing up.
 
     In a Rails app, put the following code into a new file at `config/initializers/userbin.rb`, and in Sinatra put it in your main application file and add `require "userbin"`.
 
@@ -37,35 +37,9 @@ Installation
     end
     ```
 
-    *If you don't configure the `app_id` and `api_secret`, the Userbin module will read the `USERBIN_APP_ID` and `USERBIN_API_SECRET` environment variables. This may come in handy on Heroku.*
+    If you don't configure the `app_id` and `api_secret`, the Userbin module will read the `USERBIN_APP_ID` and `USERBIN_API_SECRET` environment variables. This may come in handy on Heroku.
 
-1.  Implement getter and setter for your user model.
-
-    ```ruby
-    # will be called when accessing `current_user`
-    config.find_user = -> (userbin_id) do
-      User.find_by_userbin_id(userbin_id)
-    }
-
-    # will be called when a user signs up
-    config.create_user = -> (profile) do
-      User.create! do |user|
-        user.userbin_id = profile.id
-        user.email      = profile.email
-        user.photo      = profile.image
-      end
-    end
-    ```
-
-    *For more information about the available attributes in the profile see the [Userbin profile](https://userbin.com/docs/concepts) documentation.*
-
-1.  Migrate your users (or do it manually if not using Rails) and add a reference to the Userbin profile:
-
-    ```ruby
-    rails g migration AddUserbinIdToUsers userbin_id:integer:index
-    ```
-
-1.  **Rack/Sinatra apps only**: Activate the Userbin Rack middleware
+3.  **Rack/Sinatra apps only**: Activate the Userbin Rack middleware
 
     ```ruby
     use Userbin::Authentication
@@ -75,98 +49,92 @@ Installation
 Usage
 -----
 
-### Authenticating
+### Forms
 
-#### Rails
+An easy way to integrate Userbin is via the [Widget](https://userbin.com/docs/javascript#widget), which will take care of building forms, validating input and provides a drop-in design that adapts nicely to all devices.
 
-Userbin keeps track of the currently logged in user which can be accessed through `current_user` in controllers, views, and helpers. This automatically taps into libraries such as the authorization solution [CanCan](https://github.com/ryanb/cancan).
+The Widget is fairly high level, so remember that you can still use Userbin with your [own forms](https://userbin.com) if it doesn't fit your use-case.
 
-```haml
-- if logged_in?
-  = current_user.email
-- else
-  Not logged in
-```
+The following links will open up the Widget with the login or the signup form respectively.
 
-<!-- **Rack/Sinatra apps only**: Since above helpers aren't available outside Rails, instead use `Userbin.current_user` and `Userbin.logged_in?`.
- -->
+```html
+<a class="ub-login">Log in</a>
+```
 
-To set up a controller with user authentication, just add this before_filter:
+```html
+<a class="ub-signup">Sign up</a>
+```
 
-```ruby
-class ArticlesController < ApplicationController
-  before_filter :authenticate_user!
+The logout link will clear the session and redirect the user back to your root path:
 
-  def index
-    current_user.articles
-  end
-end
+```html
+<a class="ub-logout">Log out</a>
 ```
 
-#### Sinatra
+### The current user
 
-Helpers are accessed through the global Userbin object:
+Userbin keeps track of the currently logged in user which can be accessed through the `current_user` property. This automatically taps into libraries such as the authorization solution [CanCan](https://github.com/ryanb/cancan).
 
-```haml
-- if Userbin.logged_in?
-  = Userbin.current_user.email
-- else
-  Not logged in
+```erb
+Welcome to your account, <%= current_user.email %>
 ```
 
-To set up routes with user authentication, just wrap them like this:
+To check if a user is logged in, use `user_logged_in?` (or its alias `user_signed_in?` if you prefer Devise conventions)
 
-```ruby
-authenticate_user do
-  get "/articles" do
-    "Restricted page that logged in users can access"
-  end
-end
+```erb
+<% if user_logged_in? %>
+  You are logged in!
+<% end %>
 ```
 
+**Rack/Sinatra apps only**: Since above helpers aren't available outside Rails, instead use `Userbin.current_user` and `Userbin.user_logged_in?`.
 
-### Forms
+Configuration
+-------------
 
-#### Ready-made forms
+The `Userbin.configure` block supports a range of options additional to the Userbin credentials. None of the following options are mandatory.
 
-These are opened in a popup.
+### protected_path
 
-```haml
-%a{href: "/account", rel: "login"} Log in
-%a{href: "/account", rel: "signup"} Sign up
-%a{href: "/", rel: 'logout'} Log out
+By default, Userbin reloads the current page on a successful login. If you set the `protected_path` option, users will be redirected to this path instead.
+
+Once set, this path and any sub-path of it will be protected from unauthenticated users by instead rendering a login form.
+
+```ruby
+config.protected_path = '/dashboard'
 ```
 
-#### Social buttons
+### root_path
 
-These require you to first configure your social apps in the dashboard.
+By default, Userbin reloads the current page on a successful logout. If you set the `root_path` option, users will be redirected to this path instead.
 
-```haml
-%a{href: "/account", rel: "facebook"} Connect with Facebook
-%a{href: "/account", rel: "twitter"} Connect with Twitter
+```ruby
+config.root_path = '/login'
 ```
 
-#### Custom forms
-
-Only
-
-```haml
-%form{action: "/account", name: "signup"}
-  %span.errors
-  .form-row
-    %label
-      %span E-mail
-      %input{name: "email", type: "text"}
-  .form-row
-    %label
-      %span Password
-      %input{name: "password", type: "password"}
-  %button{type: "submit"} Sign up
+### create_user and find_user
+
+By default, `current_user` will reference a *limited* Userbin profile, enabling you to work without a database. If you override the functions `create_user` and `find_user`, the current user will instead reference one of your models. The `profile` object is an *extended* Userbin profile. For more information about the available attributes in the profile see the [Userbin profile](https://userbin.com/docs/concepts) documentation.
+
+```ruby
+config.create_user = Proc.new { |profile|
+  User.create! do |user|
+    user.userbin_id = profile.id
+    user.email      = profile.email
+    user.photo      = profile.image
+  end
+}
+
+config.find_user = Proc.new { |userbin_id|
+  User.find_by_userbin_id(userbin_id)
+}
 ```
 
+You'll need to migrate your users and add a reference to the Userbin profile:
 
-Further configuration
----------------------
+```ruby
+rails g migration AddUserbinIdToUsers userbin_id:integer:index
+```
 
 ### skip_script_injection
 
@@ -177,10 +145,10 @@ config.skip_script_injection = true
 ```
 
 
-Admin dashboard
----------------
+Further configuration and customization
+---------------------------------------
 
-Your [dashboard](https://userbin.com/dashboard) gives you access to a range of functionality:
+Your Userbin dashboard gives you access to a range of functionality:
 
 - Configure the appearance of the login widget to feel more integrated with your service
 - Connect 10+ OAuth providers like Facebook, Github and Google.

data/lib/userbin/userbin.rb

@@ -48,6 +48,10 @@ module Userbin
     current.authenticated? rescue false
   end
 
+  def self.logged_in?
+    authenticated?
+  end
+
   def self.user_logged_in?
     authenticated?
   end
@@ -60,6 +64,10 @@ module Userbin
     current.user if current
   end
 
+  def self.current_profile
+    _current_user
+  end
+
   def self.current_user
     if _current_user
       if Userbin.config.find_user

data/lib/userbin/version.rb

@@ -1,3 +1,3 @@
 module Userbin
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: userbin
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Johan
@@ -94,8 +94,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Plug n' play user accounts. The simplest way to integrate a full authentication
-  and user management stack into your web application.
+description: Drop-in user login for mobile and web apps. Add a full user authentication
+  stack to your application in minutes. Userbin is easily customized to fit your current
+  design and infrastructure.
 email: johan@userbin.com
 executables: []
 extensions: []