kf5 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3eb3a3fec42ed6f95a4a436ecaece42593d6edd
+  data.tar.gz: c7d1515809f053724790d54cca8c3e2b12cfdb28
+SHA512:
+  metadata.gz: 5aa8979a24e1087d587f50ff52288bc520d3dab17ea589fc42b6e69eb346f28faf5de8fc903945960b39853ddd68f546c3ece1af85273201a409d68776e68e01
+  data.tar.gz: dab062f39fbdaa8dc5ba06b28c10f9d55ef1123ae1546582c5b467b28f91efdb52f7c73d06bc27ff0118383de023a0081532846118a3822e7a177aee5452ff22

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 / 2015-09-03
+
+Create project

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in presenters.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    kf5 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  kf5!
+  rake (~> 10.0)
+  rspec
+  rspec-its
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chen Yi-Cyuan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# KF5
+
+A library to integrate with KF5 help desk.[逸創云客服](http://www.kf5.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kf5'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install kf5
+
+For rails, create config `config/initializers/kf5.rb`
+```ruby
+KF5.configure do |config|
+  config.key = "your key of KF5 service"
+  config.domain = "your domain of KF5 service"
+
+  # if you use devise, it will fetch following information from current_user if exsit
+  # default is :username, this is identification
+  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
+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:
+```ruby
+# ... my controller
+def my_action
+  redirect_to_kf5
+end
+```
+Or you can assaign arguments manaully
+```ruby
+redirect_to_kf5 :username => 'username' # others....
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contact
+The project's website is located at https://github.com/emn178/kf5  
+Author: emn178@gmail.com

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/kf5.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kf5/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kf5"
+  spec.version       = KF5::VERSION
+  spec.authors       = ["Chen Yi-Cyuan"]
+  spec.email         = ["emn178@gmail.com"]
+
+  spec.summary       = %q{A simple presenter pattern for ruby. It can work in rails.}
+  spec.description   = %q{A simple presenter pattern for ruby. It can work in rails.}
+  spec.homepage      = "https://github.com/emn178/kf5"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+end

data/lib/kf5/configuration.rb

@@ -0,0 +1,13 @@
+module KF5
+  class Configuration
+    attr_reader :properties
+    attr_accessor :key, :domain
+
+    def initialize(options = {})
+      options.each { |key, value| 
+        instance_variable_set("@#{key}", value)
+      }
+      @properties = Properties.new(options[:properties] || {})
+    end
+  end
+end

data/lib/kf5/helper.rb

@@ -0,0 +1,52 @@
+module KF5
+  module Helper
+    def kf5_url(options)
+      username = Helper.indifferent_access(options, :username)
+      time = Time.now.to_i
+      token = Digest::MD5.hexdigest "#{username}#{time}#{KF5.configuration.key}"
+
+      params = {
+        :username => username,
+        :time => time,
+        :token => token
+      }
+      Helper.copy_if_exist(options, params, :name)
+      Helper.copy_if_exist(options, params, :phone)
+      Helper.copy_if_exist(options, params, :return_to)
+
+      query = URI.encode_www_form(params)
+      "https://#{KF5.configuration.domain}.kf5.com/user/remote?#{query}"
+    end
+
+    def redirect_to_kf5(options = {})
+      redirect_to current_user_kf5_url(options)
+    end
+
+    private
+
+    def current_user_kf5_url(options = {})
+      kf5_url(current_user_kf5_options.merge(options))
+    end
+
+    def current_user_kf5_options
+      options = {}
+      return options unless respond_to? :current_user
+      [:username, :name, :phone].each { |key| 
+        property = KF5.configuration.properties.send(key)
+        next if property.nil? || !current_user.respond_to?(property)
+        value = current_user.send(property)
+        options[key] = value unless value.nil?
+      }
+      options
+    end
+
+    def self.indifferent_access(hash, key)
+      hash[key.to_s] || hash[key.to_sym]
+    end
+
+    def self.copy_if_exist(from_hash, to_hash, key)
+      value = indifferent_access(from_hash, key)
+      to_hash[key] = value unless value.nil?
+    end
+  end
+end

data/lib/kf5/properties.rb

@@ -0,0 +1,14 @@
+module KF5
+  class Properties
+    attr_accessor :username, :name, :phone
+
+    def initialize(options = {})
+      @username = :username
+      @name = :name
+      @phone = :phone
+      options.each { |key, value| 
+        instance_variable_set("@#{key}", value)
+      }
+    end
+  end
+end

data/lib/kf5/version.rb

@@ -0,0 +1,3 @@
+module KF5
+  VERSION = "0.1.0"
+end

data/lib/kf5.rb

@@ -0,0 +1,27 @@
+require 'digest'
+require 'uri'
+
+require "kf5/version"
+require "kf5/configuration"
+require "kf5/properties"
+require "kf5/helper"
+
+module KF5
+  def self.configure(&block)
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  if defined?(::Rails::Engine)
+    class Engine < ::Rails::Engine
+      initializer "kf5" do
+        ActiveSupport.on_load :action_controller do
+          include KF5::Helper
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: kf5
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chen Yi-Cyuan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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 simple presenter pattern for ruby. It can work in rails.
+email:
+- emn178@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- kf5.gemspec
+- lib/kf5.rb
+- lib/kf5/configuration.rb
+- lib/kf5/helper.rb
+- lib/kf5/properties.rb
+- lib/kf5/version.rb
+homepage: https://github.com/emn178/kf5
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A simple presenter pattern for ruby. It can work in rails.
+test_files: []