userbin 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b49115ba8bce94342e0738a96b33f6c95102e9b
-  data.tar.gz: 0b9596b630e74103533891606a1cdd96aa7214c4
+  metadata.gz: 9bdd5a2e5b60112f95a92dae7500b03dbea87ee9
+  data.tar.gz: 4766121c403480224819add35e1c65e8b37666d9
 SHA512:
-  metadata.gz: a6c29ce4ffc880fa041f2c429427a4bcec59078ec2777b2d2b19d553721392e58561219c42edd533528cabe9454a1dd88f4fb4526739f0993ad3bda36d0c0623
-  data.tar.gz: e67479d5e41349e976d87f462afff529e5d0b2d11cdd2e2ded7e3f07093e69b30322b80760ea0129b638a2a5d0cbfd451251bc00501207f238cd1043b873b4c1
+  metadata.gz: ceebaf8f995b7adc429b83601dead50efea180b7f2410bad462752b548b9402ef5d5ffd1af2840cf763e7cdd593e8edfca0b4fffdc064e3e14d506acdacfb9b3
+  data.tar.gz: 042c0a0bcad92c24e50c05b6adc0929c72736bc0fc75a860b3aa2e63060ea4a08745171dd6985ca1d5bd57656d34140067ca6177768f9d944e090f43c86aa663

data/README.md

@@ -1,4 +1,76 @@
 Userbin Ruby gem
 ================
 
-Hold tight for more info.
+Installation
+------------
+
+Begin with signing up at [https://userbin.com](https://userbin.com) to obtain
+your App ID and API secret.
+
+For simplicity’s sake, we will use the [Sinatra](http://www.sinatrarb.com/) framework. Start by installing Userbin and Sinatra:
+
+```bash
+$ gem install sinatra userbin
+```
+
+Now create a file called app.rb, require the gems and configure Userbin.
+
+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.
+
+```ruby
+# app.rb
+require "sinatra"
+require "userbin"
+
+Userbin.app_id = "15_DIGIT_APP_ID"
+Userbin.api_secret = "32_BYTE_API_SECRET"
+
+use Userbin::Authentication, restricted_path: '/admin'
+```
+
+That's it! People are now able sign up and log in to your application.
+
+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.
+
+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>
+or
+<a class="ub-signup">Signup</a>
+```
+
+The logout link will clear the session and redirect the user back to your root path:
+
+```html
+<!-- put this on a restricted page -->
+<a class="ub-logout">Log out</a>
+```
+
+See the [Javascript reference](https://userbin.com/docs/javascript#markup) for more info on this markup.
+
+### The current user
+
+Userbin keeps track of the currently logged in user:
+
+```erb
+Welcome to your account, <%= Userbin.user.email %>
+```
+
+To check if a user is logged in, use the following helper:
+
+```erb
+<% if Userbin.authenticated? %>
+  You are logged in!
+<% end %>
+```
+
+Documentation
+-------------
+For complete documentation go to [userbin.com/docs](https://userbin.com/docs)

data/lib/userbin/authentication.rb

@@ -18,7 +18,7 @@ module Userbin
           signature, data = Userbin.authenticate_events!(request)
 
           MultiJson.decode(data)['events'].each do |event|
-            Userbin.trigger(event)
+            Userbin::Events.trigger(event)
           end
 
           [ 200, { 'Content-Type' => 'text/html',
@@ -51,7 +51,7 @@ module Userbin
     end
 
     def restrict
-      Userbin.restricted_path || @restricted_path
+      Userbin.config.restricted_path || @restricted_path
     end
 
     def link_tags(login_path)
@@ -72,7 +72,7 @@ module Userbin
         "https://userbin.com/js/v0"
       }
       str = <<-SCRIPT_TAG
-<script src="#{script_url}?#{Userbin.app_id}"></script>
+<script src="#{script_url}?#{Userbin.config.app_id}"></script>
       SCRIPT_TAG
     end
 

data/lib/userbin/basic_auth.rb

@@ -1,7 +1,7 @@
 module Userbin
   class BasicAuth < Faraday::Middleware
     def call(env)
-      value = Base64.encode64([Userbin.app_id, Userbin.api_secret].join(':'))
+      value = Base64.encode64([Userbin.config.app_id, Userbin.config.api_secret].join(':'))
       value.gsub!("\n", '')
       env[:request_headers]["Authorization"] = "Basic #{value}"
       @app.call(env)

data/lib/userbin/configuration.rb

@@ -0,0 +1,8 @@
+module Userbin
+  class Configuration
+    attr_accessor :app_id
+    attr_accessor :api_secret
+    attr_accessor :user_model
+    attr_accessor :restricted_path
+  end
+end

data/lib/userbin/events.rb

@@ -0,0 +1,44 @@
+module Userbin
+
+  Callback = Struct.new(:pattern, :block) do; end
+
+  class Events
+    def self.on(*names, &block)
+      pattern = Regexp.union(names.empty? ? TYPE_LIST.to_a : names)
+      callbacks.each do |callback|
+        if pattern == callback.pattern
+          callbacks.delete(callback)
+          callbacks << Userbin::Callback.new(pattern, block)
+          return
+        end
+      end
+      callbacks << Userbin::Callback.new(pattern, block)
+    end
+
+    def self.trigger(raw_event)
+      event = Userbin::Event.new(raw_event)
+      callbacks.each do |callback|
+        if event.type =~ callback.pattern
+          object = case event['type']
+          when /^user\./
+            Userbin::User.new(event.object)
+          else
+            event.object
+          end
+          model = event.instance_exec object, &callback.block
+
+          if event.type =~ /user\.created/ && model.respond_to?(:id)
+            object.update_local_id(model.id)
+          end
+        end
+      end
+    end
+
+    private
+
+    def self.callbacks
+      @callbacks ||= []
+    end
+  end
+
+end

data/lib/userbin/railtie.rb

@@ -0,0 +1,7 @@
+module UserbinRails
+  class Railtie < Rails::Railtie
+    initializer "userbin" do |app|
+      app.config.middleware.use "Userbin::Authentication"
+    end
+  end
+end

data/lib/userbin/userbin.rb

@@ -1,11 +1,4 @@
 module Userbin
-
-  Callback = Struct.new(:pattern, :block) do; end
-
-  class << self
-    attr_accessor :app_id, :api_secret, :restricted_path
-  end
-
   def self.authenticate_events!(request, now = Time.now)
     signature, data =
       request.params.values_at('userbin_signature', 'userbin_data')
@@ -43,9 +36,9 @@ module Userbin
   def self.refresh_session(user_id)
     api_endpoint = ENV["USERBIN_API_ENDPOINT"] || 'https://userbin.com/api/v0'
     uri = URI("#{api_endpoint}/users/#{user_id}/sessions")
-    uri.user = app_id
-    uri.password = api_secret
     net = Net::HTTP.post_form(uri, {})
+    uri.user = config.app_id
+    uri.password = config.api_secret
     [net['X-Userbin-Signature'], net.body]
   end
 
@@ -69,54 +62,13 @@ module Userbin
     current_user
   end
 
-  # Event handling
-  #
-  class << self
-    def on(*names, &block)
-      pattern = Regexp.union(names.empty? ? TYPE_LIST.to_a : names)
-      callbacks.each do |callback|
-        if pattern == callback.pattern
-          callbacks.delete(callback)
-          callbacks << Userbin::Callback.new(pattern, block)
-          return
-        end
-      end
-      callbacks << Userbin::Callback.new(pattern, block)
-    end
-
-    def trigger(raw_event)
-      event = Userbin::Event.new(raw_event)
-      callbacks.each do |callback|
-        if event.type =~ callback.pattern
-          object = case event['type']
-          when /^user\./
-            Userbin::User.new(event.object)
-          else
-            event.object
-          end
-          model = event.instance_exec object, &callback.block
-
-          if event.type =~ /user\.created/ && model.respond_to?(:id)
-            object.update_local_id(model.id)
-          end
-        end
-      end
-    end
-
-    private
-
-    def callbacks
-      @callbacks ||= []
-    end
-  end
-
   private
 
   # Checks signature against secret and returns boolean
   #
   def self.valid_signature?(signature, data)
     digest = OpenSSL::Digest::SHA256.new
-    valid = signature == OpenSSL::HMAC.hexdigest(digest, api_secret, data)
+    valid = signature == OpenSSL::HMAC.hexdigest(digest, config.api_secret, data)
     raise SecurityError, "Invalid signature" unless valid
     valid
   end

data/lib/userbin/version.rb

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

data/lib/userbin.rb

@@ -6,6 +6,8 @@ require 'net/http'
 require "userbin/userbin"
 require "userbin/basic_auth"
 
+require "userbin/railtie" if defined?(Rails::Railtie)
+
 api_endpoint = ENV.fetch('USERBIN_API_ENDPOINT') {
   "https://userbin.com/api/v0"
 }
@@ -18,6 +20,8 @@ api_endpoint = ENV.fetch('USERBIN_API_ENDPOINT') {
   c.use Userbin::VerifySignature
 end
 
+require "userbin/configuration"
+require "userbin/events"
 require "userbin/current"
 require "userbin/session"
 require "userbin/authentication"
@@ -25,4 +29,20 @@ require "userbin/authentication"
 class Userbin::Error < Exception; end
 class Userbin::SecurityError < Userbin::Error; end
 
+module Userbin
+  class << self
+    def configure(config_hash=nil)
+      if config_hash
+        config_hash.each do |k,v|
+          config.send("#{k}=", v)
+        end
+      end
+
+      yield(config) if block_given?
+    end
 
+    def config
+      @configuration ||= Userbin::Configuration.new
+    end
+  end
+end

data/spec/session_spec.rb

@@ -3,8 +3,10 @@ require 'multi_json'
 
 describe 'Userbin::Session' do
   before do
-    Userbin.app_id = '100000000000000'
-    Userbin.api_secret = 'test'
+    Userbin.configure do |config|
+      config.app_id = '100000000000000'
+      config.api_secret = 'test'
+    end
   end
 
   before do

data/spec/userbin_spec.rb

@@ -3,8 +3,10 @@ require 'cgi'
 
 describe Userbin do
   before do
-    Userbin.app_id = '1000'
-    Userbin.api_secret = '1234'
+    Userbin.configure do |config|
+      config.app_id = '1000'
+      config.api_secret = '1234'
+    end
   end
 
   let (:args) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: userbin
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Johan
@@ -89,9 +89,13 @@ extra_rdoc_files: []
 files:
 - lib/userbin/authentication.rb
 - lib/userbin/basic_auth.rb
+- lib/userbin/configuration.rb
 - lib/userbin/current.rb
+- lib/userbin/events.rb
+- lib/userbin/railtie.rb
 - lib/userbin/session.rb
 - lib/userbin/userbin.rb
+- lib/userbin/version.rb
 - lib/userbin.rb
 - README.md
 - spec/session_spec.rb