bookingsync-engine 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c7df488875dd2e228ce8c74459be6dbb7f3ae4a
-  data.tar.gz: d31908634bee600dfdcf836fd7f6383b4c1f2d91
+  metadata.gz: b1b9d11a0d56d08fc0fdd48963d497b108831ee7
+  data.tar.gz: fdf939d7ac7adc02cddd2690954551ad8d80503a
 SHA512:
-  metadata.gz: d93b62581b7795d0cf1331f8619f303fd27a57ba9cde5bcd74d05464643bf58d0dd6eca52dc8956b530c9d0ba128c428fb9e48094e7088ffc83dec3f11123f66
-  data.tar.gz: 53060b1c19e18b3549879015ae4e0a932555af158cc37b1e3cce5136d5bb2b221627ea8ee988f22c7cd10a67f970b722ddaedbd4b8a581494d9fe63a2e2237c0
+  metadata.gz: 848da48c3e30f183fa48b25f0e9ba4aede302dd28b607fd344c71ef79e28eb26e2fb38543f6455293f79ac588a79a443b25d928125d7836d104003b7bfac00cc
+  data.tar.gz: ff1a6a35e5b4a08b60990fa7e15941abbef6a742c940f68a790cdfaf2fe8cc722653149682e13629b2e812c657c0495e2fe174029558ae93ae544df3534c1fce

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 YOURNAME
+Copyright 2014 BookingSync SAS
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -97,13 +97,36 @@ BookingSync::Engine.standalone!
 
 ## Authentication in apps
 
-BookingSync Engine will create some helpers to use inside your controllers and views. To set up a controller with BookingSync account authentication, just add this before_filter:
+BookingSync Engine will create some helpers to use inside your controllers and views.
+
+### Ensure authentication
+
+To set up a controller with BookingSync account authentication, just add this `before_action`:
 
 ```ruby
 before_action :authenticate_account!
 ```
-It will make sure an account is authenticated (using OAuth).
+It will make sure an account is authenticated (using OAuth2).
+
+### New authorization process
+
+If the user is not currently authenticated, 3 responses can be expected:
+
+#### 1) Through Ajax requests
+
+By Ajax request, we consider them when the `X-Requested-With` header contains `XMLHttpRequest`.
+
+In this case, the authorization path will be returned a plain text with a **401 Unauthorized** status.
+
+#### 2) Embedded Application
+
+Embedded applications will be given a script tag forcing them to change their parent location to the authorization path. This is necessary so the authorization happens in the main window, not within an iFrame.
+
+#### 3) Standalone Application
+
+Standalone applications will simply be redirected to the authorization path.
 
+### Accessing the current account
 
 To retrieve the current signed-in account, this helper is available:
 

data/lib/bookingsync/engine/auth_helpers.rb

@@ -51,16 +51,52 @@ module BookingSync::Engine::AuthHelpers
     request_authorization!
   end
 
+  # Request a new authorization.
   def request_authorization!
-    if BookingSync::Engine.embedded
-      allow_bookingsync_iframe
-      path = "/auth/bookingsync/?account_id=#{session[:_bookingsync_account_id]}"
-      render text: "<script type='text/javascript'>top.location.href = '#{path}';</script>"
+    if request.xhr?
+      request_authorization_for_xhr!
+    elsif BookingSync::Engine.embedded
+      request_authorization_for_embedded!
     else
-      redirect_to "/auth/bookingsync"
+      request_authorization_for_standalone!
     end
   end
 
+  # Request a new authorization for Ajax requests.
+  #
+  # Renders the new authorization path with 401 Unauthorized status by default.
+  def request_authorization_for_xhr!
+    render text: new_authorization_url, status: :unauthorized
+  end
+
+  # Request a new authorization for Embedded Apps.
+  #
+  # Load the new authorization path using Javascript by default.
+  def request_authorization_for_embedded!
+    allow_bookingsync_iframe
+    render text: "<script type='text/javascript'>top.location.href = " +
+      "'#{new_authorization_path}';</script>"
+  end
+
+  # Request a new authorization for Standalone Apps.
+  #
+  # Redirects to new authorization path by default.
+  def request_authorization_for_standalone!
+    redirect_to new_authorization_path
+  end
+
+  # Path to which the user should be redirected to start a new
+  # Authorization process.
+  #
+  # Default to /auth/bookingsync/?account_id=SESSION_BOOKINGSYNC_ACCOUNT_ID
+  def new_authorization_path
+    "/auth/bookingsync/?account_id=#{session[:_bookingsync_account_id]}"
+  end
+
+  def new_authorization_url
+    request.base_url + new_authorization_path
+  end
+
   # Handler to rescue OAuth errors
   #
   # @param error [OAuth2::Error] the rescued error

data/lib/bookingsync/engine/version.rb

@@ -1,3 +1,3 @@
 module BookingSync
-  ENGINE_VERSION = "0.1.3"
+  ENGINE_VERSION = "0.2.0"
 end

data/spec/controllers/authenticated_controller_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe AuthenticatedController, type: :controller do
+  describe "GET index" do
+    context "when engine is embedded" do
+      before { BookingSync::Engine.embedded! }
+
+      it "redirects to auth using js" do
+        get :index
+        expect(response.status).to eq(200)
+        expect(response.body).to eq(
+          "<script type='text/javascript'>top.location.href = '/auth/bookingsync/?account_id=';</script>")
+      end
+    end
+
+    context "when engine is standalone" do
+      before { BookingSync::Engine.standalone! }
+
+      it "redirects to auth using 302 redirect" do
+        get :index
+        expect(response.status).to eq(302)
+        expect(response.redirect_url).to eq("http://test.host/auth/bookingsync/?account_id=")
+        expect(response.body).to eq(
+          "<html><body>You are being <a href=\"http://test.host/auth/bookingsync/?account_id=\">redirected</a>.</body></html>")
+      end
+    end
+  end
+
+  describe "XHR index" do
+    context "when engine is embedded" do
+      before { BookingSync::Engine.embedded! }
+
+      it "renders the target url in response" do
+        xhr :get, :index
+        expect(response.status).to eq(401)
+        expect(response.body).to eq("http://test.host/auth/bookingsync/?account_id=")
+      end
+    end
+
+    context "when engine is standalone" do
+      before { BookingSync::Engine.standalone! }
+
+      it "renders the target url in response" do
+        xhr :get, :index
+        expect(response.status).to eq(401)
+        expect(response.body).to eq("http://test.host/auth/bookingsync/?account_id=")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ ENV['RAILS_ENV'] ||= 'test'
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require 'rspec/rails'
+require 'pry-rails'
 
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookingsync-engine
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Sebastien Grosjean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Rails engine to simplify integration with BookingSync API
 email:
 - dev@bookingsync.com
@@ -132,6 +146,7 @@ files:
 - lib/bookingsync/engine/version.rb
 - lib/generators/bookingsync/install/install_generator.rb
 - lib/generators/bookingsync/install/templates/create_bookingsync_accounts.rb
+- spec/controllers/authenticated_controller_spec.rb
 - spec/controllers/sessions_controller_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -202,6 +217,7 @@ signing_key:
 specification_version: 4
 summary: A Rails engine to simplify integration with BookingSync API
 test_files:
+- spec/controllers/authenticated_controller_spec.rb
 - spec/controllers/sessions_controller_spec.rb
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css