omniauth-thecity 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 312c6654746cb1c428df7b35af63e5998e2ea8ee
-  data.tar.gz: ef00eca5182724d46d59d82201f9838428fcd148
+  metadata.gz: 0ef1f6ca2d04f19825de6df66da44858cdea2146
+  data.tar.gz: 42128cb835c4f7d5556f0ac739d0939d0c48b2e3
 SHA512:
-  metadata.gz: 1e0e978e99c5a5aef901a19df0209537c0183a61264cac8dedf3bbda65fa0b37a0b5c452d3851f27f75a0dba9ab6115520dbe990019b31c8cc80a9d5080f213a
-  data.tar.gz: 075dee350e0371e7de0c2fcf92d220fe586fba7dc7f2898f97dc23f53b2dffe75760017aa3a2a7cfc273e8bc5b94927b63200d06625889a9286ed5a5d6aeac12
+  metadata.gz: 7b44be598fda2c028e0150fa1720c4db1b78e1307b937a3c00dc916f358bca5b9617eb7b876a00662bf7c785ae53e52f688dbbf03f7584554c62bb7a22e9116f
+  data.tar.gz: 8c575b464dc6c2c6c2837f51b6bcef38ba9ec8d901b1cc9cd070db062795a25ae143f569544fb948ebafe9c328bbf78e2daac8d3e009ac7974737579869447f1

data/README.md

@@ -1,6 +1,7 @@
 # Omniauth::Thecity
 
 [![Gem Version](https://badge.fury.io/rb/omniauth-thecity.png)](http://badge.fury.io/rb/omniauth-thecity)
+[![Dependency Status](https://gemnasium.com/thecity/omniauth-thecity.png)](https://gemnasium.com/thecity/omniauth-thecity)
 
 This gem contains The City strategy for OmniAuth.
 
@@ -30,6 +31,33 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
+### The City subdomains
+
+City users have one global user, and then a local user for each subdomain (City) they have an active account. 
+
+When a user successfully authenticates, omnniauth-thecity returns an array of local users belonging to the City global user.  If you pass along a subdomain, The City authentication service will only return an active local user for the subdomain you passed in.
+
+If your app only cares about one City subdomain (e.g. gracechurch.onthecity.org ), you can configure omniauth-thecity globally like this:
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :thecity, "APPID", "SECRET", :scope => 'user_basic user_extended', :subdomain => 'gracechurch'}
+end
+```
+
+Otherwise, you can set the subdomain per request as a query parameter, or header.
+
+For example, when using [devise](https://github.com/plataformatec/devise) you can pass the subdomain using the route helper:
+
+```ruby
+user_omniauth_authorize_path(:thecity, params: {subdomain: 'gracechurch'})
+```
+
+or as a custom header in your request:
+
+```
+X_THECITY_SUBDOMAIN: gracechurch
+```
+
 ## Authentication Hash
 An example auth hash available in `request.env['omniauth.auth']`:
 

data/lib/omniauth-thecity/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module TheCity
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/omniauth/strategies/thecity.rb

@@ -25,7 +25,7 @@ module OmniAuth
       end
 
       def subdomain
-        options.subdomain ||= request.params["subdomain"] || request.headers['HTTP_X_CITY_SUBDOMAIN'] || nil rescue nil
+        options.subdomain ||= request.params["subdomain"] || request.headers['HTTP_X_THECITY_SUBDOMAIN'] || nil rescue nil
       end
 
       uid do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-thecity
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mark Blair