omniauth-zendesk-oauth2 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3745a07b89e2248bdc3d2d46ba8413d7b80f539d
+  data.tar.gz: d62dd6ea014b7e3ff249177b3d6ae33d089482fa
+SHA512:
+  metadata.gz: 0df36567ad7f57b5aa089ad3a1af78a0e90d02cefa880880f440a12c9dfd980d2e4a55489bfc4e5bfc145e21a6c7592cd1b6498242b4fe32e36d3abcd5d7620a
+  data.tar.gz: e4b432561debc57f349c35e5b12c763b97ce1d43a63c8e97fa15103571892541bd35890741f260a61c9e682eb47699bc336eadd9e94d54423d55fc03ac889c48

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+.bundle
+*.gem
+.config
+.yardoc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 1.9.3
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jonas Oberschweiber
+
+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,18 @@
+# OmniAuth Zendesk via OAuth2
+
+This strategy authenticates against Zendesk via OAuth2. You'll need an OAuth2
+Application ID and Secret. See the [Zendesk help page][1] for details.
+
+## Usage
+
+```ruby
+use OmniAuth::Builder.do
+  provider :zendesk, ENV['ZD_CLIENT'], ENV['ZD_SECRET'], client_options: {
+    site: 'https://yours.zendesk.com'
+  }, scope: 'read'
+end
+```
+
+Scope can be either `read`, `write` or `read write`.
+
+[1]: https://support.zendesk.com/hc/en-us/articles/203663836-Using-OAuth-authentication-with-your-application#topic_pvr_ncl_1l

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/lib/omniauth-zendesk-oauth2.rb

@@ -0,0 +1,2 @@
+require 'omniauth-zendesk-oauth2/version'
+require 'omniauth/strategies/zendesk'

data/lib/omniauth-zendesk-oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Zendesk
+    VERSION = "0.1"
+  end
+end

data/lib/omniauth/strategies/zendesk.rb

@@ -0,0 +1,46 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Zendesk < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        site: 'https://test.zendesk.com',
+        authorize_url: '/oauth/authorizations/new',
+        token_url: '/oauth/tokens'
+      }
+
+      option :scopes
+
+      def authorize_params
+        super.tap do |params|
+          if request.params['scope']
+            params[:scope] = request.params[v]
+          end
+        end
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v2/users/me.json').parsed
+      end
+
+      uid { raw_info['user']['email'].to_s }
+
+      info do
+        u = raw_info['user']
+        {
+          'id' => u['id'],
+          'name' => u['name'],
+          'email' => u['email'],
+          'role' => u['role'],
+          'organization_id' => u['organization_id']
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'zendesk', 'Zendesk'

data/omniauth-zendesk-oauth2.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/omniauth-zendesk-oauth2/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Jonas Oberschweiber"]
+  gem.email = "jonas.oberschweiber@d-velop.de"
+  gem.description = %q{OmniAuth Strategy for Zendesk via OAuth2}
+  gem.summary = %q{OmniAuth Strategy for Zendesk via OAuth2}
+  gem.homepage = "https://github.com/jonasoberschweiber/omniauth-zendesk-oauth2"
+
+  gem.name = "omniauth-zendesk-oauth2"
+  gem.files = `git ls-files`.split("\n")
+  gem.require_paths = ["lib"]
+  gem.version = OmniAuth::Zendesk::VERSION
+  gem.license = 'MIT'
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.1'
+  gem.add_development_dependency 'rspec', '~> 3'
+end

data/spec/omniauth/strategies/zendesk_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Zendesk do
+  subject do
+    OmniAuth::Strategies::Zendesk.new({})
+  end
+
+  context 'client options' do
+    it 'should have correct site' do
+      site = subject.options.client_options.site
+      expect(site).to eq('https://test.zendesk.com')
+    end
+
+    it 'should let client override site' do
+      strategy = OmniAuth::Strategies::Zendesk.new(
+        'KEY', 'SECRET',
+        client_options: { site: 'https://test2.zendesk.com' }
+      )
+      site = strategy.options.client_options.site
+      expect(site).to eq('https://test2.zendesk.com')
+    end
+  end
+
+  context 'info' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(
+        'user' => {
+          'email' => 'test@test.org',
+          'id' => 123,
+          'name' => 'Marty McFly',
+          'role' => 'admin',
+          'organization_id' => 456
+        }
+      )
+    end
+
+    it 'returns the email as uid' do
+      expect(subject.uid).to eq 'test@test.org'
+    end
+
+    context 'puts all the info in the info hash' do
+      it {expect(subject.info).to have_key 'name'}
+      it {expect(subject.info).to have_key 'id'}
+      it {expect(subject.info).to have_key 'email'}
+      it {expect(subject.info).to have_key 'role'}
+      it {expect(subject.info).to have_key 'organization_id'}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'omniauth'
+require 'omniauth-zendesk-oauth2'
+
+RSpec.configure do |config|
+  config.extend OmniAuth::Test::StrategyMacros, type: :strategy
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-zendesk-oauth2
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Jonas Oberschweiber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: OmniAuth Strategy for Zendesk via OAuth2
+email: jonas.oberschweiber@d-velop.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/omniauth-zendesk-oauth2.rb
+- lib/omniauth-zendesk-oauth2/version.rb
+- lib/omniauth/strategies/zendesk.rb
+- omniauth-zendesk-oauth2.gemspec
+- spec/omniauth/strategies/zendesk_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jonasoberschweiber/omniauth-zendesk-oauth2
+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.2.2
+signing_key: 
+specification_version: 4
+summary: OmniAuth Strategy for Zendesk via OAuth2
+test_files: []