Project

kf5

0.0
No release in over 3 years
Low commit activity in last 3 years
kf5emn178/kf5HomepageDocumentationSource CodeBug TrackerWiki
A simple presenter pattern for ruby. It can work in rails.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
14,959
Stars
0
Forks
0
Watchers
3
 Releases
Current version
0.4.0
Total releases
6
First release
2015-09-03
Latest release
2016-05-30
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2015-10-22
Reverse Dependencies
0

 Dependencies

Development

actionview
>= 0
bundler
~> 1.10
rake
~> 10.0
rspec
>= 0
rspec-its
>= 0
 Project Readme

KF5

Build Status Coverage Status

A library to integrate with KF5 help desk.逸創云客服

Installation

Add this line to your application's Gemfile:

gem 'kf5'

Make sure you have:

gem 'jquery-rails'

And then execute:

bundle

Or install it yourself as:

gem install kf5

For rails, create config config/initializers/kf5.rb

KF5.configure do |config|
  config.domain = "your.domain"

  # disable SSO if key is nil
  config.key = "your key of KF5 service"

  # 1: login for 30 days, 0: login for 30 minutes
  # config.remember_me = 1

  # if you use devise, it will fetch following information from current_user if exsit
  # default is :username, this is identification with email format
  config.properties.username = :your_username_column

  # default is :name, optional
  config.properties.name = :your_name_column

  # default is :phone, optional
  config.properties.phone = :your_phone_column

  # default is :photo, optional
  config.properties.photo = :your_photo_column
end

Usage

In rails controllers, you can call redirect_to_kf5 to redirect_to_kf5 for SSO. This will fetch information from current_user automatically if you use devise:

# ... my controller
def my_action
  redirect_to_kf5
end

Or you can assaign arguments manaully

redirect_to_kf5 :username => 'username' # others....

Or you do not want to sso

redirect_to_kf5 :sso => false

In view, you can use kf5_tag to include javascript plugin.

= kf5_tag

Turbolinks

If you're using turbolinks, add the following to js file:

//= require kf5.turbolinks

License

The gem is available as open source under the terms of the MIT License.

Contact

The project's website is located at https://github.com/emn178/kf5
Author: Chen, Yi-Cyuan (emn178@gmail.com)