userbin 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bdd5a2e5b60112f95a92dae7500b03dbea87ee9
-  data.tar.gz: 4766121c403480224819add35e1c65e8b37666d9
+  metadata.gz: 7b561838ff6f87c720146c20d9817b0db06b8ff2
+  data.tar.gz: 3ecd413667cffa28272e8f7563ea1009b0057bfb
 SHA512:
-  metadata.gz: ceebaf8f995b7adc429b83601dead50efea180b7f2410bad462752b548b9402ef5d5ffd1af2840cf763e7cdd593e8edfca0b4fffdc064e3e14d506acdacfb9b3
-  data.tar.gz: 042c0a0bcad92c24e50c05b6adc0929c72736bc0fc75a860b3aa2e63060ea4a08745171dd6985ca1d5bd57656d34140067ca6177768f9d944e090f43c86aa663
+  metadata.gz: 9b7af19543462d9cb59d5f3060c3fafb91a529b06832d34aa43b52957a6b98b878694028ea75e428fcb5553686f976211ce4aa08b47b51457c49ee3cde9eb7a8
+  data.tar.gz: 33a11c347a277150e55f581b2cab91a4328b241aa2bd8758081cf11f784d1c97af5a9e3c8b8621e1a6cb7c0124a1ca758fffaeebcabbdb653a8e5fb8fbf24cc8

data/README.md

@@ -1,33 +1,47 @@
-Userbin Ruby gem
+Userbin for Ruby
 ================
 
+Userbin for Ruby adds user authentication, login flows and user management to your **Rails**, **Sinatra** or **Rack** app.
+
+[Userbin](https://userbin.com) provides a set of login, signup, and password reset forms that drop right into your application without any need of styling or writing markup. Connect your users via traditional logins or third party social networks. We take care of linking accounts across networks, resetting passwords, and keeping everything safe and secure. [Create a free account](https://userbin.com) to start accepting users in your application.
+
 Installation
 ------------
 
-Begin with signing up at [https://userbin.com](https://userbin.com) to obtain
-your App ID and API secret.
+1. Add the `userbin` gem to your `Gemfile`
 
-For simplicity’s sake, we will use the [Sinatra](http://www.sinatrarb.com/) framework. Start by installing Userbin and Sinatra:
+    ```ruby
+    gem "userbin"
+    ```
 
-```bash
-$ gem install sinatra userbin
-```
+1.  Install the gem
 
-Now create a file called app.rb, require the gems and configure Userbin.
+    ```shell
+    bundle install
+    ```
+    
+2.  Configure the Userbin module with the credentials you got from signing up.
 
-Set up your restricted path to which users will be redirected on a successful logins. Browsing to this path or a sub-path will require the user to login. Logging out redirects the user back to the root path.
+    In a Rails app, put the following code into a new file at `config/initializers/userbin.rb`
 
-```ruby
-# app.rb
-require "sinatra"
-require "userbin"
+    ```ruby
+    Userbin.configure do |config|
+      config.app_id = "YOUR_APP_ID"
+      config.api_secret = "YOUR_API_SECRET"
+      config.restricted_path = "/admin"
+    end
+    ```
 
-Userbin.app_id = "15_DIGIT_APP_ID"
-Userbin.api_secret = "32_BYTE_API_SECRET"
+    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.
+    
+    Set up your `restricted_path` to which users will be redirected on a successful login. Browsing to this path or a sub-path will require the user to login. Logging out redirects the user back to the root path.
 
-use Userbin::Authentication, restricted_path: '/admin'
-```
+3.  **Rack/Sinatra apps only**: Activate the Userbin Rack middleware
 
+    ```ruby
+    use Userbin::Authentication
+    ```
+    
 That's it! People are now able sign up and log in to your application.
 
 Usage
@@ -35,15 +49,15 @@ Usage
 
 ### Signup, login and logout
 
-To make installation as easy as possible, markup required for the Userbin UI are automatically inserted before the closing </body> and </head> tags in your HTML. It is therefore important that these tags are present on all pages where you want to use the links below.
+NOTE: To make installation as easy as possible, markup required for the Userbin UI are automatically inserted before the closing </body> and </head> tags in your HTML. It is therefore important that these tags are present on all pages where you want to use the links below.
 
 These links will open up the [Userbin Widget](https://userbin.com/docs/javascript#widget) with either the login or signup form.
 
 ```html
 <!-- put this on a public page -->
-<a class="ub-login">Login</a>
+<a class="ub-login">Log in</a>
 or
-<a class="ub-signup">Signup</a>
+<a class="ub-signup">Sign up</a>
 ```
 
 The logout link will clear the session and redirect the user back to your root path:

data/lib/userbin/authentication.rb

@@ -6,14 +6,13 @@ module Userbin
 
     def initialize(app, options = {})
       @app = app
-      @restricted_path = options[:restricted_path]
     end
 
     def call(env)
       request = Rack::Request.new(env)
 
       begin
-        if env["REQUEST_PATH"] == "/userbin" &&
+        if env["PATH_INFO"] == "/userbin" &&
            env["REQUEST_METHOD"] == "POST"
           signature, data = Userbin.authenticate_events!(request)
 
@@ -26,7 +25,7 @@ module Userbin
         else
           signature, data = Userbin.authenticate!(request)
 
-          if restrict && env["REQUEST_PATH"].start_with?(restrict) &&
+          if restrict && env["PATH_INFO"].start_with?(restrict) &&
              !Userbin.authenticated?
             return render_gateway(env["REQUEST_PATH"])
           end
@@ -51,7 +50,7 @@ module Userbin
     end
 
     def restrict
-      Userbin.config.restricted_path || @restricted_path
+      Userbin.config.restricted_path
     end
 
     def link_tags(login_path)
@@ -82,13 +81,13 @@ module Userbin
 <head>
   <title>Log in</title>
 </head>
-<body style="background-color: #DBDBDB;">
+<body>
   <a class="ub-login-form"></a>
 </body>
 </html>
       LOGIN_PAGE
       login_page = inject_tags(login_page, current_path)
-      [ 200,
+      [ 403,
         { 'Content-Type' => 'text/html',
           'Content-Length' => login_page.length.to_s },
         [login_page]
@@ -115,8 +114,10 @@ module Userbin
           body = response
         end
 
-        body = body.each.map do |chunk|
-          inject_tags(chunk)
+        if Userbin.config.auto_include_tags
+          body = body.each.map do |chunk|
+            inject_tags(chunk)
+          end
         end
 
         if response.respond_to?(:body)
@@ -124,8 +125,6 @@ module Userbin
         else
           response = body
         end
-
-        headers['Content-Length'] = body.join.length.to_s
       end
 
       if signature && data

data/lib/userbin/configuration.rb

@@ -2,7 +2,15 @@ module Userbin
   class Configuration
     attr_accessor :app_id
     attr_accessor :api_secret
+    attr_accessor :auto_include_tags
     attr_accessor :user_model
     attr_accessor :restricted_path
+
+    def initialize
+      self.app_id = ENV["USERBIN_APP_ID"]
+      self.api_secret = ENV["USERBIN_API_SECRET"]
+
+      self.auto_include_tags = true
+    end
   end
 end

data/lib/userbin/rails/auth_helpers.rb

@@ -0,0 +1,16 @@
+module Userbin
+  module AuthHelpers
+    def userbin_current_user
+      local_id = Userbin.current_user.local_id
+
+      if local_id
+        user_klass = if Userbin.config.user_model
+          Userbin.config.user_model.call
+        else
+          User
+        end
+        @current_user ||= user_klass.find(local_id)
+      end
+    end
+  end
+end

data/lib/userbin/railtie.rb

@@ -1,6 +1,13 @@
-module UserbinRails
+require 'userbin/rails/auth_helpers'
+
+module Userbin
+  ActiveSupport.on_load(:action_controller) do
+    include AuthHelpers
+  end
+
   class Railtie < Rails::Railtie
     initializer "userbin" do |app|
+      ActionView::Base.send :include, AuthHelpers
       app.config.middleware.use "Userbin::Authentication"
     end
   end

data/lib/userbin/version.rb

@@ -1,3 +1,3 @@
 module Userbin
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: userbin
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Johan
@@ -92,6 +92,7 @@ files:
 - lib/userbin/configuration.rb
 - lib/userbin/current.rb
 - lib/userbin/events.rb
+- lib/userbin/rails/auth_helpers.rb
 - lib/userbin/railtie.rb
 - lib/userbin/session.rb
 - lib/userbin/userbin.rb
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Userbin