zendesk_remote_authentication 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.rdoc +17 -0
- data/Rakefile +53 -0
- data/VERSION +1 -0
- data/lib/zendesk_remote_authentication.rb +52 -0
- data/test/helper.rb +10 -0
- data/test/test_zendesk_remote_authentication.rb +63 -0
- data/zendesk_remote_authentication.gemspec +54 -0
- metadata +91 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 James Wachira
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
= Zendesk Remote Authentication
|
2
|
+
|
3
|
+
Description goes here.
|
4
|
+
|
5
|
+
== Note on Patches/Pull Requests
|
6
|
+
|
7
|
+
* Fork the project.
|
8
|
+
* Make your feature addition or bug fix.
|
9
|
+
* Add tests for it. This is important so I don't break it in a
|
10
|
+
future version unintentionally.
|
11
|
+
* Commit, do not mess with rakefile, version, or history.
|
12
|
+
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
|
13
|
+
* Send me a pull request. Bonus points for topic branches.
|
14
|
+
|
15
|
+
== Copyright
|
16
|
+
|
17
|
+
Copyright (c) 2010 James Wachira. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "zendesk_remote_authentication"
|
8
|
+
gem.summary = "Zendesk Remote Authentication"
|
9
|
+
gem.description = "Allow users to authenticate remotely"
|
10
|
+
gem.email = "jamomathenge@gmail.com"
|
11
|
+
gem.homepage = "http://github.com/jwachira/zendesk_remote_authentication"
|
12
|
+
gem.authors = ["James Wachira"]
|
13
|
+
gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
|
14
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
15
|
+
end
|
16
|
+
Jeweler::GemcutterTasks.new
|
17
|
+
rescue LoadError
|
18
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
19
|
+
end
|
20
|
+
|
21
|
+
require 'rake/testtask'
|
22
|
+
Rake::TestTask.new(:test) do |test|
|
23
|
+
test.libs << 'lib' << 'test'
|
24
|
+
test.pattern = 'test/**/test_*.rb'
|
25
|
+
test.verbose = true
|
26
|
+
end
|
27
|
+
|
28
|
+
begin
|
29
|
+
require 'rcov/rcovtask'
|
30
|
+
Rcov::RcovTask.new do |test|
|
31
|
+
test.libs << 'test'
|
32
|
+
test.pattern = 'test/**/test_*.rb'
|
33
|
+
test.verbose = true
|
34
|
+
end
|
35
|
+
rescue LoadError
|
36
|
+
task :rcov do
|
37
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
task :test => :check_dependencies
|
42
|
+
|
43
|
+
task :default => :test
|
44
|
+
|
45
|
+
require 'rake/rdoctask'
|
46
|
+
Rake::RDocTask.new do |rdoc|
|
47
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
48
|
+
|
49
|
+
rdoc.rdoc_dir = 'rdoc'
|
50
|
+
rdoc.title = "zendesk_remote_authentication #{version}"
|
51
|
+
rdoc.rdoc_files.include('README*')
|
52
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
53
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.5.0
|
@@ -0,0 +1,52 @@
|
|
1
|
+
require 'digest/md5'
|
2
|
+
require 'active_support' #gives us Hash.to_query
|
3
|
+
|
4
|
+
module Zendesk
|
5
|
+
class RemoteAuthentication
|
6
|
+
class << self
|
7
|
+
attr_writer :auth_url, :token
|
8
|
+
|
9
|
+
def token
|
10
|
+
raise ArgumentError.new('Zendesk Token has not been set yet. Set with Zendesk::RemoteAuthentication.token = <token>') unless @token
|
11
|
+
@token
|
12
|
+
end
|
13
|
+
|
14
|
+
def auth_url
|
15
|
+
raise ArgumentError.new('Zendesk authentication url has not been set yet. Set with Zendesk::RemoteAuthentication.auth_url = <token>') unless @auth_url
|
16
|
+
@auth_url
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
module RemoteAuthenticationHelper
|
25
|
+
#you can either pass username and email or a user object which contains email and username attributes
|
26
|
+
def zendesk_remote_authentication_url(params)
|
27
|
+
params = params.is_a?(Hash) ? params : convert_user_to_a_hash(params)
|
28
|
+
|
29
|
+
#TODO: Need a class to validate the params
|
30
|
+
raise ArgumentError.new("You must provide name and email address") unless (params[:name] && params[:email])
|
31
|
+
|
32
|
+
#add timestamp if none is passed in the params
|
33
|
+
params[:timestamp] = Time.now.utc.to_i unless params[:timestamp]
|
34
|
+
|
35
|
+
params[:hash] = params[:external_id] ? generate_authentication_hash(Zendesk::RemoteAuthentication.token, params) : ''
|
36
|
+
|
37
|
+
"#{Zendesk::RemoteAuthentication.auth_url}?#{params.to_query}"
|
38
|
+
end
|
39
|
+
|
40
|
+
def convert_user_to_a_hash(user)
|
41
|
+
params = {}
|
42
|
+
params[:name] = "#{user.first_name} #{user.last_name}"
|
43
|
+
params[:email] = user.email
|
44
|
+
params[:external_id] = user.id
|
45
|
+
return params
|
46
|
+
end
|
47
|
+
|
48
|
+
def generate_authentication_hash(token, params)
|
49
|
+
Digest::MD5.hexdigest(params[:name] + params[:email] + params[:external_id] + token + params[:timestamp])
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
data/test/helper.rb
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
require 'helper'
|
2
|
+
|
3
|
+
class TestZendeskRemoteAuthentication < Test::Unit::TestCase
|
4
|
+
|
5
|
+
context "Ioffer to Zendesk Remote Authentication" do
|
6
|
+
setup do
|
7
|
+
Zendesk::RemoteAuthentication.token = Zendesk::RemoteAuthentication.auth_url = nil
|
8
|
+
end
|
9
|
+
|
10
|
+
should "raise an exception if a token is not set" do
|
11
|
+
assert_raise ArgumentError do
|
12
|
+
Zendesk::RemoteAuthentication.token
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
should "raise an exception if authentication url is not set" do
|
17
|
+
assert_raise ArgumentError do
|
18
|
+
Zendesk::RemoteAuthentication.auth_url
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
should "return a token without an exception" do
|
23
|
+
token = Zendesk::RemoteAuthentication.token = "bang"
|
24
|
+
assert token == "bang"
|
25
|
+
end
|
26
|
+
|
27
|
+
should "return authentication url without an exception" do
|
28
|
+
authentication_url = Zendesk::RemoteAuthentication.auth_url = "ding.ioffer.com"
|
29
|
+
assert authentication_url == "ding.ioffer.com"
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
context "Authentication Url Generator" do
|
34
|
+
setup do
|
35
|
+
@object = Object.new
|
36
|
+
@object.send(:extend, RemoteAuthenticationHelper)
|
37
|
+
@token = Zendesk::RemoteAuthentication.token = 'ujLcNkJkrr5ezvppUHI2CdtJPne5qszX2Twlfm397ear6pm5'
|
38
|
+
@auth_url = Zendesk::RemoteAuthentication.auth_url = 'https://www.ioffer.com/login?request_uri=http://help.ioffer.com'
|
39
|
+
@params = { :email => 'james@ioffer.com', :name => 'James'}
|
40
|
+
end
|
41
|
+
|
42
|
+
context "Required Attributes" do
|
43
|
+
should 'raise an argument error if the name is not provided' do
|
44
|
+
assert_raise ArgumentError do
|
45
|
+
@params.delete(:name)
|
46
|
+
@object.zendesk_remote_authentication_url(@params)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
should 'raise an argument error if an email is not provided' do
|
51
|
+
assert_raise ArgumentError do
|
52
|
+
@params.delete(:email)
|
53
|
+
@object.zendesk_remote_authentication_url(@params)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# should "generate remote external authentication url" do
|
58
|
+
# raise @object.zendesk_remote_authentication_url(@params).inspect
|
59
|
+
# end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = %q{zendesk_remote_authentication}
|
8
|
+
s.version = "0.5.0"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["James Wachira"]
|
12
|
+
s.date = %q{2010-11-04}
|
13
|
+
s.description = %q{Allow users to authenticate remotely}
|
14
|
+
s.email = %q{jamomathenge@gmail.com}
|
15
|
+
s.extra_rdoc_files = [
|
16
|
+
"LICENSE",
|
17
|
+
"README.rdoc"
|
18
|
+
]
|
19
|
+
s.files = [
|
20
|
+
".document",
|
21
|
+
".gitignore",
|
22
|
+
"LICENSE",
|
23
|
+
"README.rdoc",
|
24
|
+
"Rakefile",
|
25
|
+
"VERSION",
|
26
|
+
"lib/zendesk_remote_authentication.rb",
|
27
|
+
"test/helper.rb",
|
28
|
+
"test/test_zendesk_remote_authentication.rb",
|
29
|
+
"zendesk_remote_authentication.gemspec"
|
30
|
+
]
|
31
|
+
s.homepage = %q{http://github.com/jwachira/zendesk_remote_authentication}
|
32
|
+
s.rdoc_options = ["--charset=UTF-8"]
|
33
|
+
s.require_paths = ["lib"]
|
34
|
+
s.rubygems_version = %q{1.3.7}
|
35
|
+
s.summary = %q{Zendesk Remote Authentication}
|
36
|
+
s.test_files = [
|
37
|
+
"test/helper.rb",
|
38
|
+
"test/test_zendesk_remote_authentication.rb"
|
39
|
+
]
|
40
|
+
|
41
|
+
if s.respond_to? :specification_version then
|
42
|
+
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
43
|
+
s.specification_version = 3
|
44
|
+
|
45
|
+
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
46
|
+
s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
47
|
+
else
|
48
|
+
s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
49
|
+
end
|
50
|
+
else
|
51
|
+
s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
metadata
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: zendesk_remote_authentication
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
hash: 11
|
5
|
+
prerelease: false
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 5
|
9
|
+
- 0
|
10
|
+
version: 0.5.0
|
11
|
+
platform: ruby
|
12
|
+
authors:
|
13
|
+
- James Wachira
|
14
|
+
autorequire:
|
15
|
+
bindir: bin
|
16
|
+
cert_chain: []
|
17
|
+
|
18
|
+
date: 2010-11-04 00:00:00 -07:00
|
19
|
+
default_executable:
|
20
|
+
dependencies:
|
21
|
+
- !ruby/object:Gem::Dependency
|
22
|
+
name: thoughtbot-shoulda
|
23
|
+
prerelease: false
|
24
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
hash: 3
|
30
|
+
segments:
|
31
|
+
- 0
|
32
|
+
version: "0"
|
33
|
+
type: :development
|
34
|
+
version_requirements: *id001
|
35
|
+
description: Allow users to authenticate remotely
|
36
|
+
email: jamomathenge@gmail.com
|
37
|
+
executables: []
|
38
|
+
|
39
|
+
extensions: []
|
40
|
+
|
41
|
+
extra_rdoc_files:
|
42
|
+
- LICENSE
|
43
|
+
- README.rdoc
|
44
|
+
files:
|
45
|
+
- .document
|
46
|
+
- .gitignore
|
47
|
+
- LICENSE
|
48
|
+
- README.rdoc
|
49
|
+
- Rakefile
|
50
|
+
- VERSION
|
51
|
+
- lib/zendesk_remote_authentication.rb
|
52
|
+
- test/helper.rb
|
53
|
+
- test/test_zendesk_remote_authentication.rb
|
54
|
+
- zendesk_remote_authentication.gemspec
|
55
|
+
has_rdoc: true
|
56
|
+
homepage: http://github.com/jwachira/zendesk_remote_authentication
|
57
|
+
licenses: []
|
58
|
+
|
59
|
+
post_install_message:
|
60
|
+
rdoc_options:
|
61
|
+
- --charset=UTF-8
|
62
|
+
require_paths:
|
63
|
+
- lib
|
64
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ">="
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
hash: 3
|
70
|
+
segments:
|
71
|
+
- 0
|
72
|
+
version: "0"
|
73
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
74
|
+
none: false
|
75
|
+
requirements:
|
76
|
+
- - ">="
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
hash: 3
|
79
|
+
segments:
|
80
|
+
- 0
|
81
|
+
version: "0"
|
82
|
+
requirements: []
|
83
|
+
|
84
|
+
rubyforge_project:
|
85
|
+
rubygems_version: 1.3.7
|
86
|
+
signing_key:
|
87
|
+
specification_version: 3
|
88
|
+
summary: Zendesk Remote Authentication
|
89
|
+
test_files:
|
90
|
+
- test/helper.rb
|
91
|
+
- test/test_zendesk_remote_authentication.rb
|