lra_client 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35298c5706f221732cdb53f372d95ffc76cc7721
-  data.tar.gz: ffa9118cf81704ea7a8c295b2cb23983ee85ef7d
+  metadata.gz: d375d12b47958dbd15927d665ccab0e38de53fac
+  data.tar.gz: 17b1d9835198ab8cc9d379a69e61ad691f00bc07
 SHA512:
-  metadata.gz: b9c4eb67fce91a7cfab85f1e85e8f5ddfe816dd4947dc2d451928778312953ee6be0743de402431422d01a7fec2e6bed874674755af3d335eed554b3720789ae
-  data.tar.gz: 39f75a64010e37d909293b3fc4b699408c7fbca2ad9f01b0b2f208a9488bddba0514fac1430bd657dc32bf4318cd2506425e54f5e0f1a27c7a33ef051b180cc3
+  metadata.gz: 150cf5b14c2988a67eb92e332e0463eac66ee23123cfdea0feb4f1c89ebdd49c8e52724f0ffb111e1de16038f254e2b9ffbebc2e1e88ff264e730efcb5840df4
+  data.tar.gz: 2def0facde50210e369b6bc2b96c55d5fd87bbaf56ce5a52c15b4abb367d1a6335c4a6e3c05a010da3a4f7092d5ffccd72466d93b977690b3af2b56925e68296

data/README.md

@@ -1,9 +1,3 @@
-# LraClient
-Short description and motivation.
-
-## Usage
-How to use my plugin.
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -11,18 +5,52 @@ Add this line to your application's Gemfile:
 gem 'lra_client'
 ```
 
-And then execute:
+And then execute the following to setup:
 ```bash
-$ bundle
+$ bundle install
+$ bundle exec rake lra_client:install:migrations
+$ bundle exec rake db:migrate
 ```
 
-Or install it yourself as:
-```bash
-$ gem install lra_client
+To configure the client, add a new initializer to your project with the following:
+```ruby
+LraClient.app_id = [your app ID]
+LraClient.key = '[your app key]'
+LraClient.domain_namespace = 'https://my.website.com/[mountpoint]'
+LraClient.login_completion_url = '[where to redirect after login attempt]'
 ```
 
-## Contributing
-Contribution directions go here.
+Finally, mount the engine into your `config/routes.rb` file:
+```ruby
+mount LraClient::Engine, at: '[mountpoint]'
+```
+
+(A good example mountpoint for the above might be simply `/lra`)
+
+## Usage
+
+Assuming you have mounted the engine at `/lra`, direct your users to `/lra/login` in order to
+start the login process. After a login attempt, your user will be redirected back to the endpoint
+you have specified by `LraClient.login_completion_url`. If the login was successful, a record
+in the `lra_client_users` table will have been created with some basic details. In addition,
+two session variables will have been set to identify the user:
+```ruby
+session[:current_user_id] # the ID of a LraClient::User
+session[:current_user_type] # always set to the string "LraClient::User"
+```
+
+At any point, you can validate that the current user has a valid LRA session by calling
+`LraClient.validate_session(session)`. The `LraClient::User` object will be returned if
+the session is valid, and `nil` otherwise. This can be used to restrict access to pages
+by doing something similar to:
+```ruby
+before_filter :validate_session
+
+def validate_session
+  @current_user = LraClient.validate_session
+  return true if @current_user.present?
+  redirect_to '/lra/login'
+  false
+end
+```
 
-## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/assets/javascripts/lra_client/lra.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/lra_client/lra.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/lra_client/lra_controller.rb

@@ -0,0 +1,46 @@
+require_dependency "lra_client/application_controller"
+
+module LraClient
+  class LraController < ApplicationController
+
+    def login
+      result = send_post_request(
+        LraClient.request_challenge_url,
+        app_id: LraClient.app_id,
+        key: LraClient.key,
+        return_url: LraClient.return_url
+      )
+
+      redirect_to result['login_url']
+    end
+
+    def return
+      result = send_post_request(
+        LraClient.load_details_url,
+        app_id: LraClient.app_id,
+        key: LraClient.key,
+        answer: params[:answer]
+      )
+
+      if result['success']
+        user = LraClient::User.create_or_update_from_loft(result)
+        session[:current_user_id] = user.id
+        session[:current_user_type] = 'LraClient::User'
+      end
+
+      redirect_to LraClient.login_completion_url
+    end
+
+    private
+
+    def send_post_request(url, data)
+      uri = URI.parse(url)
+      req = Net::HTTP::Post.new(uri.path)
+      req.form_data = data
+      con = Net::HTTP.new(uri.host, uri.port)
+      con.use_ssl = true
+      result = con.start { |https| https.request(req) }
+      JSON.parse(result.body)
+    end
+  end
+end

data/app/helpers/lra_client/lra_helper.rb

@@ -0,0 +1,4 @@
+module LraClient
+  module LraHelper
+  end
+end

data/app/models/lra_client/user.rb

@@ -0,0 +1,14 @@
+module LraClient
+  class User < ApplicationRecord
+    def self.create_or_update_from_loft(params)
+      user = User.find_by(loft_id: params['id'])
+      user = User.new if user.nil?
+      user.loft_id = params['id']
+      user.name    = params['name']
+      user.avatar  = params['avatar']
+      user.email   = params['email']
+      user.save!
+      user
+    end
+  end
+end

data/config/routes.rb

@@ -1,2 +1,4 @@
 LraClient::Engine.routes.draw do
+  get 'login', to: 'lra#login'
+  get 'return', to: 'lra#return'
 end

data/db/migrate/20161219184020_create_lra_client_users.rb

@@ -0,0 +1,11 @@
+class CreateLraClientUsers < ActiveRecord::Migration[5.0]
+  def change
+    create_table :lra_client_users do |t|
+      t.integer :loft_id
+      t.string :name
+      t.string :avatar
+      t.string :email
+      t.timestamps
+    end
+  end
+end

data/lib/lra_client/version.rb

@@ -1,3 +1,3 @@
 module LraClient
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/lra_client.rb

@@ -1,5 +1,20 @@
 require "lra_client/engine"
 
 module LraClient
-  # Your code goes here...
+  class << self
+    attr_accessor :app_id, :key, :domain_namespace, :login_completion_url
+    attr_accessor :request_challenge_url, :load_details_url
+
+    def return_url
+      self.domain_namespace + '/return'
+    end
+
+    def validate_session(session)
+      return nil if session[:current_user_type] != 'LraClient::User'
+      User::find_by(id: session[:current_user_id])
+    end
+  end
+
+  self.request_challenge_url = 'https://lifemakesuslaugh.com/api/lra/request_challenge.json'
+  self.load_details_url = 'https://lifemakesuslaugh.com/api/lra/load_details.json'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lra_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Caleb Simpson
@@ -56,14 +56,20 @@ files:
 - Rakefile
 - app/assets/config/lra_client_manifest.js
 - app/assets/javascripts/lra_client/application.js
+- app/assets/javascripts/lra_client/lra.js
 - app/assets/stylesheets/lra_client/application.css
+- app/assets/stylesheets/lra_client/lra.css
 - app/controllers/lra_client/application_controller.rb
+- app/controllers/lra_client/lra_controller.rb
 - app/helpers/lra_client/application_helper.rb
+- app/helpers/lra_client/lra_helper.rb
 - app/jobs/lra_client/application_job.rb
 - app/mailers/lra_client/application_mailer.rb
 - app/models/lra_client/application_record.rb
+- app/models/lra_client/user.rb
 - app/views/layouts/lra_client/application.html.erb
 - config/routes.rb
+- db/migrate/20161219184020_create_lra_client_users.rb
 - lib/lra_client.rb
 - lib/lra_client/engine.rb
 - lib/lra_client/version.rb