discourse_mountable_sso 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODk3YWM0ZDgwODE4N2E1Mjk3NWYwYjMxOTZmYWYyMTUwMzJhYzY4Yw==
+    ODY3Y2VmNjE0Y2JhY2Y4NjE1MzU3Mjc3MGYyZTZkMzM3ZDUyNTI1Zg==
   data.tar.gz: !binary |-
-    YmI2NjQ4NDFhY2Q5ZWFjMGU3NjZkOTcxYjU2MjRmZTY2ODJjMWE2NA==
+    MzE0ZTU3MTE2NjBlMmQ1OTVkZmE2ZWI4ODBkMzhkYTNkM2E5Mjk2Zg==
 SHA512:
   metadata.gz: !binary |-
-    MjZhMGJiNmQwNzAyNGFlZmU2ZDdiYjY2NjEwZjZiZjEzMjNjMTFjYzU5YTIx
-    OWQzNWExOTBkNjk2ODk4ZmExODRlNDBiMjkwNWEyNjEyNTc4Y2E1ZTQ0ZDk1
-    ZWUyY2NkM2Y3MDA2MDBiZGVjNDQxYzQ4MWJiMDIyZTZkYmE1NWY=
+    ZjdmYWQ3MmU3ZjZlMTJjNDkzYTBiYTI5MTRhNmRiYWFkYTcwNzk5ODYyNGEx
+    YmM3MTRhYmRiYmMxYzA3YWM3ZjJkNmVlMmVlMWE0OWUyM2I4NjY2YjNmZWMw
+    MTI1ZTk0ZGFhODZjMTk0MzAwOTc1MDVkNWIyY2M3ZjdkNTQzN2M=
   data.tar.gz: !binary |-
-    YjgzMzYxNGZjZmJkZjZjMzYwNGViMTc3YTUyYTllZDIwZThhMTVlZmIyN2Yw
-    NWQ3YWEyMDU3MWE1YjhkODEzMGVkZDBkMmQ5ZTMzOTgwNjJjODcxNWQ2NGNh
-    ZDViOGM5Mjk4ZDEyYjNmMmZkMDQxMzZiZDg4YTA4NWU1N2FiZjM=
+    ZjRkNDA5NWNkMzk1Zjk3ZDU4NThlZDcwMWEzNzY4OTEwNWRiMTY0MmE4YmRm
+    N2NmOWUwYzNlMzYzYjRkM2U3YTQ3Yjg1YjlhNDRmZDZiM2RkYzRjYTdlMzhm
+    ZTNlMTcxOTYwNWJiNDZjZDZjZDNjYzkwOTU5MTQzZTlhNjhmNTQ=

data/README.md

@@ -0,0 +1,40 @@
+# DiscourseMountableSso
+
+Discourse Mountable Sso is a mountable engine made to handle [Discourse](https://github.com/discourse/discourse/) single sign on technique.
+
+##Getting started
+
+Discourse mountable sso 0.0.1 works with Rails 3.2.14 . You can add it to your Gemfile with:
+
+```ruby
+gem 'discourse_mountable_sso'
+```
+
+Run the bundle command to install it.
+
+After you install Discourse mountable sso and add it to your Gemfile, you need to create a file in config/initializers in your application named discourse_config.rb filled with the below data
+
+
+```ruby
+#config/initializers/discourse_config.rb
+DiscourseMountableSso.configuration.secret = "#{SECRET}"
+DiscourseMountableSso.configuration.discourse_url = "#{DISCOURSE_URL}"	
+DiscourseMountableSso.configuration.login_path = "#{LOGIN_PATH}"
+DiscourseMountableSso.configuration.discourse_data_method = "#{DISCOURSE_DATA_METHOD}"
+DiscourseMountableSso.configuration.logged_in_check_method = "#{CHECK_LOGIN_METHOD}"
+DiscourseMountableSso.configuration.store_return_to_url_method = "#{RETURN_TO_URL_METHOD}"
+```
+##Configuration description
+
+* secret : Is the the secret you configured in your discourse admin panel
+* discourse_url : Is the URL of your discourse application.
+* login_path : Is the login path of your own app as www.example.com/login then your login path will be "/login"
+* discourse_data_method : Is a method returns the user data for discourse in this format:
+    * ``` {:avatar_url=>"http://www.example.com/avatar1.jpg", :email=>"lorem@ipsum.com", :name=>"lorem", :username=>"lorem", :external_id=>1}```
+* logged_in_check_method : Is a method to check if the user is logged in or not and returns true or false.
+* store_return_to_url_method : Is a method to store the return_to path as after the user log-in in your app it'll be redirected back to discourse server.
+
+##Note: 
+  * We use a cookie named [:discourse_mountable_sso][:query_string]
+
+

data/lib/discourse_mountable_sso/version.rb

@@ -1,3 +1,3 @@
 module DiscourseMountableSso
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_mountable_sso
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mohamed N.Salah
@@ -14,22 +14,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - <
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.14
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - <
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.14
+        version: '3.2'
 description: Discourse Mountable Sso is a mountable engine made to handle Discourse
   single sign on technique,it works with Rails 3.2.14
 email:
@@ -39,7 +39,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/assets/javascripts/discourse_mountable_sso/application.js
 - app/assets/stylesheets/discourse_mountable_sso/application.css
@@ -115,8 +115,9 @@ files:
 - test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
 - test/integration/navigation_test.rb
 - test/test_helper.rb
-homepage: ''
-licenses: []
+homepage: https://rubygems.org/gems/discourse_mountable_sso
+licenses:
+- MIT-LICENSE
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/README.rdoc

@@ -1,6 +0,0 @@
-= DiscourseMountableSso
-
-First you need to create a file in config/initializers in your application name discourse_config.rb
-```ruby
-gem 'discourse_mountable_sso'
-```