omniauth-intercom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9db0767314f658f4a3edbbfa8a378877c95f6e26
+  data.tar.gz: d799638a2712b3ddfcf817479c7477c3f0bfa8ee
+SHA512:
+  metadata.gz: 54bba5243a083f4bc7b36a378b736a06192c1289bcceaabd4daba13e2b56112490bcf651ec87eef1626472f7d33ff0bffbbe39db535eda02a14c1be3427ed057
+  data.tar.gz: 828e403a165adedd6e135d81da5eb554cf11cd94cfaf5c2fec25176bdbf80cc60f21b60353c61fe2c0673a61fadc655309bf6b28eae5a08a370601ac0b4e4a67

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+omniauth-intercom-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.12.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0 (2016-05-03)
+
+Features:
+
+  - Omniauth2 basic auth (@Skaelv)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Skaelv
+
+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,66 @@
+
+# OmniAuth Intercom
+
+Intercom OAuth2 Strategy for OmniAuth.
+
+Supports the OAuth 2.0 server-side and client-side flows. Read the [Intercom OAuth docs](https://developers.intercom.io/reference#oauth) for more details:
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-intercom'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Intercom` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :intercom, ENV['INTERCOM_KEY'], ENV['INTERCOM_SECRET']
+end
+```
+To start the authentication process with Intercom you simply need to access `/auth/intercom` route.
+
+**Important** You need the `read_admins` permissions to use this middleware.   
+**Important** Your `redirect_url` should be `/auth/intercom/callback`
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'intercom',
+  :uid => '342324',
+  :info => {
+    :email => 'kevin.antoine@intercom.io',
+    :name => 'Kevin Antoine'
+  },
+  :credentials => {
+    :token => 'dG9rOmNdrWt0ZjtgzzE0MDdfNGM5YVe4MzsmXzFmOGd2MDhiMfJmYTrxOtA=', # OAuth 2.0 access_token, which you may wish to store
+    :expires => false
+  },
+  :extra => {
+    :raw_info => {
+      :name => 'Kevin Antoine',
+      :email => 'kevin.antoine@intercom.io',
+      :type => 'admin',
+      :id => '342324',
+      :app => {
+        :id_code => 'abc123', # Company app_id
+        :type: 'app'
+      }
+      :avatar => {
+        :image_url => "https://static.intercomassets.com/avatars/343616/square_128/me.jpg?1454165491"
+      }
+    }
+  }
+}
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/intercom"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth-intercom.rb

@@ -0,0 +1 @@
+require 'omniauth/intercom'

data/lib/omniauth/intercom.rb

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

data/lib/omniauth/intercom/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Intercom
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/intercom.rb

@@ -0,0 +1,51 @@
+require 'omniauth-oauth2'
+module OmniAuth
+  module Strategies
+    class Intercom < OmniAuth::Strategies::OAuth2
+      # Give your strategy a name.
+      option :name, "intercom"
+
+      # This is where you pass the options you would pass when
+      # initializing your consumer from the OAuth gem.
+      option :client_options, {
+        :site => 'https://api.intercom.io',
+        # :site => 'http://localhost:4000',
+        :authorize_url => 'https://app.intercom.io/oauth',
+        :token_url => 'https://api.intercom.io/auth/eagle/token'
+      }
+
+      # These are called after authentication has succeeded. If
+      # possible, you should try to set the UID without making
+      # additional calls (if the user id is returned with the token
+      # or as a URI parameter). This may not be possible with all
+      # providers.
+      uid{ raw_info['id'] }
+
+      info do
+        {
+          :name => raw_info['name'],
+          :email => raw_info['email']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        accept_headers
+        access_token.options[:mode] = :body
+        @raw_info ||= access_token.get('/me').parsed
+      end
+
+      protected
+      def accept_headers
+        access_token.client.connection.headers['Authorization'] = access_token.client.connection.basic_auth(access_token.token, '')
+        access_token.client.connection.headers['Accept'] = "application/vnd.intercom.3+json"
+      end
+
+    end
+  end
+end

data/omniauth-intercom.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/intercom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-intercom"
+  spec.version       = OmniAuth::Intercom::VERSION
+  spec.authors       = ["Kevin Antoine"]
+  spec.email         = ["kevin.antoine@intercom.io"]
+
+  spec.summary  = 'Intercom OAuth2 Strategy for OmniAuth'
+  spec.homepage = 'https://github.com/intercom/omniauth-intercom'
+  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_runtime_dependency 'omniauth-oauth2', '~> 1.2'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-intercom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Antoine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- kevin.antoine@intercom.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-intercom.rb
+- lib/omniauth/intercom.rb
+- lib/omniauth/intercom/version.rb
+- lib/omniauth/strategies/intercom.rb
+- omniauth-intercom.gemspec
+homepage: https://github.com/intercom/omniauth-intercom
+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.8
+signing_key: 
+specification_version: 4
+summary: Intercom OAuth2 Strategy for OmniAuth
+test_files: []
+has_rdoc: