omnidesk_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee9281ad3b8a8321b91f25331a69a9f9f5bf172a
+  data.tar.gz: 657ab493b1b7eef8fecbe962726c98bfa2dc754a
+SHA512:
+  metadata.gz: 4c585d590640ad5c89c2a61d586d15182bc46380357afcf4fcad0b15a4e9b5d72b90cd1d8bb0da6a3d50a6cf03e9aa6e77edbdd32b3d07b77da326ff42d7d769
+  data.tar.gz: 376e2663b7037fbb339662151fc823860f1ee635e49669ce07cb8c9abfe95f45383e659d133fa7abf9c0ccf928998cf0d96523eef0d53a767ed7192bde676de4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 V.Kolesnikov
+
+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,84 @@
+[![Build Status](https://travis-ci.org/justCxx/omnidesk_auth.svg?branch=master)](https://travis-ci.org/justCxx/omnidesk_auth)
+[![Code Climate](https://codeclimate.com/github/justCxx/omnidesk_auth/badges/gpa.svg)](https://codeclimate.com/github/justCxx/omnidesk_auth)
+[![Test Coverage](https://codeclimate.com/github/justCxx/omnidesk_auth/badges/coverage.svg)](https://codeclimate.com/github/justCxx/omnidesk_auth/coverage)
+
+# OmnideskAuth
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omnidesk_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omnidesk_auth
+
+## Usage
+
+### Rails
+
+#### Configure
+
+```ruby
+# config/initializers/omnidesk_auth.rb
+OmnideskAuth.configure do |auth|
+  auth.endpoint = 'http://mycompany.omnidesk.ru'
+  auth.secret = '<secret token>'
+end
+```
+
+Note: The OmnideskAuth module takes the configuration defaults from environment variables:
+
+ - OMNIDESK_AUTH_SECRET
+ - OMNIDESK_AUTH_ENDPOINT
+ - OMNIDESK_AUTH_EXPIRE
+
+See: [OmnideskAuth::Default](lib/omnidesk_auth/default.rb)
+
+#### Controller
+```ruby
+# app/controllers/support_controller.rb
+class SupportController < ApplicationController
+  def omnidesk_sign_in
+    redirect_to OmnideskAuth.sso_auth_url(email: current_user.email)
+  end
+end
+```
+
+According to the documentation omnidesk service accepts as binding the following fields:
+
+- iat (required) - Issued At (the time when the token was generated))
+- email (required) - user email
+
+Parameter "iat" is installed automatically during the generation of the token, but is also available for self-installation via the options hash.
+Parameter email is the only field that you need to be sure to pass.
+
+Example of filling in all possible fields:
+
+```ruby
+def omnidesk_sign_in
+  redirect_to OmnideskAuth.sso_auth_url(
+    iat: Time.current.to_i,
+    name: current_user.name,
+    email: current_user.email,
+    external_id: current_user.id,
+    company_name: current_user.company.name,
+    company_position: current_user.position,
+    remote_photo_url: current_user.avatar_url,
+    exp: 1.day)
+end
+```
+
+See more: [Omnidesk documention](https://support.omnidesk.ru/knowledge_base/item/54180)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/omnidesk_auth.rb

@@ -0,0 +1,28 @@
+require 'omnidesk_auth/client'
+require 'omnidesk_auth/configurable'
+require 'omnidesk_auth/default'
+require 'omnidesk_auth/version'
+
+module OmnideskAuth
+  class << self
+    include OmnideskAuth::Configurable
+
+    def client
+      return @client if defined?(@client) && @client.same_options?(options)
+      @client = OmnideskAuth::Client.new(options)
+    end
+
+    private
+
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private)
+    end
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end
+
+OmnideskAuth.setup

data/lib/omnidesk_auth/client.rb

@@ -0,0 +1,71 @@
+require 'omnidesk_auth/configurable'
+require 'omnidesk_auth/error'
+require 'jwt'
+
+module OmnideskAuth
+  class Client
+    include OmnideskAuth::Configurable
+
+    def initialize(options = {})
+      OmnideskAuth::Configurable.keys.each do |key|
+        value = options[key] || OmnideskAuth.instance_variable_get(:"@#{key}")
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    def inspect
+      super.tap do |inspected|
+        inspected.gsub! secret, "#{secret[0..4]}..." if secret
+      end
+    end
+
+    def sso_auth_url(options = {})
+      url_from_response_body(access_url(options))
+    end
+
+    def access_url(options = {})
+      payload = jwt_payload(options)
+      URI.parse("#{base_url}?jwt=#{payload}")
+    end
+
+    def base_url
+      return unless endpoint
+      @base_url ||= URI.join(endpoint, 'access/jwt')
+    end
+
+    def jwt_payload(options = {})
+      return unless secret
+      JWT.encode(payload(options), secret)
+    end
+
+    def payload(options = {})
+      payload = options.select { |k, _| payload_keys.include?(k) }
+
+      payload[:iat] ||= Time.now.to_i
+      payload[:exp] ||= expire if expire
+      payload[:exp] += payload[:iat] if payload[:exp]
+
+      payload
+    end
+
+    def payload_keys
+      @payload_keys ||=
+        [:iat,
+         :email,
+         :name,
+         :external_id,
+         :company_name,
+         :company_position,
+         :remote_photo_url,
+         :exp]
+    end
+
+    private
+
+    def url_from_response_body(url)
+      response = Net::HTTP.get_response(url)
+      return response.body if response.code.to_i == 200
+      raise OmnideskAuth::ResponseError, response
+    end
+  end
+end

data/lib/omnidesk_auth/configurable.rb

@@ -0,0 +1,35 @@
+module OmnideskAuth
+  module Configurable
+    attr_accessor :endpoint, :secret, :expire
+
+    class << self
+      def keys
+        @keys ||= [:endpoint, :secret, :expire]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset!
+      OmnideskAuth::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", OmnideskAuth::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    private
+
+    def options
+      OmnideskAuth::Configurable.keys.each_with_object({}) do |key, hash|
+        hash[key] = instance_variable_get(:"@#{key}")
+      end
+    end
+  end
+end

data/lib/omnidesk_auth/default.rb

@@ -0,0 +1,21 @@
+module OmnideskAuth
+  module Default
+    class << self
+      def options
+        Hash[OmnideskAuth::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+
+      def endpoint
+        ENV['OMNIDESK_AUTH_ENDPOINT']
+      end
+
+      def secret
+        ENV['OMNIDESK_AUTH_SECRET']
+      end
+
+      def expire
+        ENV['OMNIDESK_AUTH_EXPIRE']
+      end
+    end
+  end
+end

data/lib/omnidesk_auth/error.rb

@@ -0,0 +1,16 @@
+module OmnideskAuth
+  class Error < StandardError
+  end
+
+  class ResponseError < Error
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    def build_error_message
+      return if @response.nil?
+      "#{@response.uri}: #{@response.code}"
+    end
+  end
+end

data/lib/omnidesk_auth/version.rb

@@ -0,0 +1,3 @@
+module OmnideskAuth
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: omnidesk_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- V.Kolesnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'Simple Omnidesk SSO authentication client. See more: https://support.omnidesk.ru/knowledge_base/item/54180'
+email:
+- re.vkolesnikov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/omnidesk_auth.rb
+- lib/omnidesk_auth/client.rb
+- lib/omnidesk_auth/configurable.rb
+- lib/omnidesk_auth/default.rb
+- lib/omnidesk_auth/error.rb
+- lib/omnidesk_auth/version.rb
+homepage: http://github.com/justcxx/omnidesk_auth
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Omnidesk SSO authentication client
+test_files: []
+has_rdoc: