omniauth-contactually 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68c7c3aefcfbd88974c1ecd2abe83edcdd561ffe
+  data.tar.gz: 0918d9018e778e84f340d6ab9583c98a161208af
+SHA512:
+  metadata.gz: a2c8a1e1338184db35a7c57b3e2557a530701e919bb1c44d444d2ea181febe6608e3b09fbadb4c4e6079d6f9473719a39bb704200f578b2c70b157eef8d1d289
+  data.tar.gz: 9711eafcdbe2800829d37c5c9f124a3509ce38df1150dd6eb0f0decffe8267d05af0ea4e16d6ec8fb07d0de96ed23b48c250dd2b617acc3a8eb4fde96147fa76

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+example/app.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--tty
+--profile

data/.rubocop.yml

@@ -0,0 +1,177 @@
+Style/AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same
+  # column as the first parameter.
+  #
+  #     method_call(a,
+  #                 b)
+  #
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_fixed_indentation
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+  SupportedStyles:
+    # The `braces` style enforces braces around all method parameters that are
+    # hashes.
+    - braces
+    # The `no_braces` style checks that the last parameter doesn't have braces
+    # around it.
+    - no_braces
+    # The `context_dependent` style checks that the last parameter doesn't have
+    # braces around it, but requires braces if the second to last parameter is
+    # also a hash literal.
+    - context_dependent
+
+# Indentation of `when`.
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+Style/ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separate line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  EnforcedStyle: nested
+  SupportedStyles:
+    - nested
+    - compact
+  Enabled: false
+
+Style/CommandLiteral:
+  EnforcedStyle: mixed
+  # backticks: Always use backticks.
+  # percent_x: Always use %x.
+  # mixed: Use backticks on single-line commands, and %x on multi-line commands.
+  SupportedStyles:
+    - backticks
+    - percent_x
+    - mixed
+  # If false, the cop will always recommend using %x if one or more backticks
+  # are found in the command string.
+  AllowInnerBackticks: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+  SupportedStyles:
+    - ruby19
+    - hash_rockets
+
+# Checks the indentation of the first element in an array literal.
+Style/IndentArray:
+  # The value `special_inside_parentheses` means that array literals with
+  # brackets that have their opening bracket on the same line as a surrounding
+  # opening round parenthesis, shall have their first element indented relative
+  # to the first position inside the parenthesis.
+  #
+  # The value `consistent` means that the indentation of the first element shall
+  # always be relative to the first position of the line where the opening
+  # bracket is.
+  #
+  # The value `align_brackets` means that the indentation of the first element
+  # shall always be relative to the position of the opening bracket.
+  EnforcedStyle: consistent
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+    - align_brackets
+  # By default, the indentation width from Style/IndentationWidth is used
+  # But it can be overridden by setting this parameter
+  IndentationWidth: ~
+
+# Checks the indentation of the first key in a hash literal.
+Style/IndentHash:
+  # The value `special_inside_parentheses` means that hash literals with braces
+  # that have their opening brace on the same line as a surrounding opening
+  # round parenthesis, shall have their first key indented relative to the
+  # first position inside the parenthesis.
+  # The value `consistent` means that the indentation of the first key shall
+  # always be relative to the first position of the line where the opening
+  # brace is.
+  EnforcedStyle: consistent
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented
+  # By default, the indentation width from Style/IndentationWidth is used
+  # But it can be overridden by setting this parameter
+  IndentationWidth: ~
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented
+
+Style/SymbolProc:
+  IgnoredMethods:
+    - proc
+    - respond_to
+
+# Enforces: "Provide an exception class and message as arguments to raise."
+# Overly restrictive when testing ActiveRecord errors
+# EG: ActiveRecord::RecordInvalid.new(model_with_errs) doesn't take a message
+Style/RaiseArgs:
+  Enabled: false
+
+##################### Metrics #############################
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 10
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+##################### Lint ################################
+
+Lint/AssignmentInCondition:
+  Description: "Don't use assignment in conditions."
+  Enabled: false
+
+##################### Performance #########################
+
+# Performance improvement is negligible and the readability is poor. See:
+# https://github.com/bbatsov/rubocop/issues/2614
+Performance/Casecmp:
+  Enabled: false
+
+##################### Rails ###############################
+
+Rails/ActionFilter:
+  Description: 'Enforces consistent use of action filter methods.'
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,24 @@
+before_install: gem install bundler
+env:
+  global:
+    - JRUBY_OPTS="$JRUBY_OPTS --debug"
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: jruby-18mode
+    - rvm: jruby-head
+    - rvm: ruby-head
+  fast_finish: true
+sudo: false

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2016 Zvi Band and Contactually, Inc
+
+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,39 @@
+# OmniAuth Contactually
+
+[![Gem Version](http://img.shields.io/gem/v/omniauth-contactually.svg)][gem]
+[![Build Status](http://img.shields.io/travis/contactually/omniauth-contactually.svg)][travis]
+[![Code Climate](http://img.shields.io/codeclimate/github/contactually/omniauth-contactually.svg)][codeclimate]
+
+[gem]: https://rubygems.org/gems/omniauth-contactually
+[travis]: http://travis-ci.org/contactually/omniauth-contactually
+[codeclimate]: https://codeclimate.com/github/contactually/omniauth-contactually
+
+Gem to authenticate applications to Contactually via OAuth2.
+
+# Background
+Contactually has a full API (docs at https://developers.contactually.com), and as of Q1 2016, has switched to OAuth2 for authentication (https://developers.contactually.com/docs/auth).
+
+To aid in the development of applications that provide value by connecting to Contactually, we've provided this OmniAuth strategy. You see existing integrations and add your own at http://marketplace.contactually.com/
+
+# Setup
+Register for your OAuth2 credentials by creating an application at https://www.contactually.com/developer/applications (you'll need a Contactually account - contact us at api@contactually.com if you want it converted to a free developer account).
+
+You can see what scope(s) your application will require at https://developers.contactually.com/docs/auth/. Limiting your application to only access necessary information will instill better user trust with your application.
+
+## Standard setup:
+
+```ruby
+  # Add to your initializers/omniauth.rb
+
+  use OmniAuth::Builder do
+    provider :contactually, ENV['CONTACTUALLY_APP_ID'], ENV['CONTACTUALLY_APP_SECRET'], :scope=>"all:manage"
+  end
+```
+
+## Setup with Devise:
+
+```ruby
+  # Add to your devise.rb
+
+  config.omniauth :contactually, ENV['CONTACTUALLY_APP_ID'], ENV['CONTACTUALLY_APP_SECRET'], :scope=>"all:manage"
+```

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :test => :spec
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    $stderr.puts 'RuboCop is disabled'
+  end
+end
+
+task :default => [:spec, :rubocop]

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'omniauth-contactually', :path => '../'

data/example/README.md

@@ -0,0 +1,32 @@
+# Example App
+
+This folder contains a sample Sinatra app to test the Contactually OAuth2 flow.
+
+## Setup
+
+Ensure your Contactually App ID and Secret are available in the environment:
+
+```bash
+export CONTACTUALLY_APP_ID=YOUR_APP_ID_HERE
+export CONTACTUALLY_APP_SECRET=YOUR_APP_SECRET_HERE
+```
+
+Run bundle install from the command line:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Run the app:
+
+```bash
+rackup -p 4567
+```
+
+NOTE: Since Contactually requires SSL, you'll probably need to set up a tunnel using a service like ngrok:
+
+```bash
+ngrok http -subdomain=some-custom-subdomain 4567
+```

data/example/app.rb

@@ -0,0 +1,27 @@
+require 'sinatra'
+
+# Configure sinatra
+set :run, false
+set :raise_errors, true
+set :protection, :except => [:json_csrf]
+
+# Setup logging to file
+log = File.new('app.log', 'a+')
+$stdout.reopen(log)
+$stderr.reopen(log)
+$stderr.sync = true
+$stdout.sync = true
+
+get '/' do
+  redirect '/auth/contactually'
+end
+
+get '/auth/:provider/callback' do
+  content_type 'application/json'
+  MultiJson.encode(request.env)
+end
+
+get '/auth/failure' do
+  content_type 'application/json'
+  MultiJson.encode(request.env)
+end

data/example/config.ru

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'omniauth-contactually'
+require './app.rb'
+
+use Rack::Session::Cookie, :secret => 'abc123'
+
+use OmniAuth::Builder do
+  provider :contactually, ENV['CONTACTUALLY_APP_ID'], ENV['CONTACTUALLY_APP_SECRET'], :scope => 'all:manage'
+end
+
+run Sinatra::Application

data/lib/omniauth-contactually.rb

@@ -0,0 +1,3 @@
+# rubocop:disable Style/FileName
+require 'omniauth-contactually/version'
+require 'omniauth/strategies/contactually'

data/lib/omniauth-contactually/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Contactually
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/omniauth/strategies/contactually.rb

@@ -0,0 +1,55 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    # Authentication strategy for connecting with the Contactually API.
+    class Contactually < OmniAuth::Strategies::OAuth2
+      # Give your strategy a name.
+      option :name, 'contactually'
+
+      # This is where you pass the options you would pass when
+      # initializing your consumer from the OAuth gem.
+      option :client_options, :site => 'https://api.contactually.com/',
+                              :authorize_url => 'https://auth.contactually.com/oauth2/authorize',
+                              :token_url => 'https://auth.contactually.com/oauth2/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'] }
+
+      # https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema#schema-10-and-later
+      info do
+        {
+          :name => name_from_raw_info,
+          :email => raw_info['email'],
+          :first_name => raw_info['first_name'],
+          :last_name => raw_info['last_name'],
+          :image => raw_info['avatar_url']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/v2/me').parsed['data']
+      end
+
+      private
+
+      def name_from_raw_info
+        if raw_info['first_name'] || raw_info['last_name']
+          "#{raw_info['first_name']} #{raw_info['last_name']}".strip
+        else
+          raw_info['email']
+        end
+      end
+    end
+  end
+end

data/omniauth-contactually.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path('../lib/omniauth-contactually/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = 'Contactually'
+  gem.email         = 'api@contactually.com'
+  gem.description   = 'OmniAuth OAuth2 strategy for Contactually.'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/contactually/omniauth-contactually'
+  gem.licenses      = %w(MIT)
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").collect { |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'omniauth-contactually'
+  gem.require_paths = %w(lib)
+  gem.version       = OmniAuth::Contactually::VERSION
+
+  # Lock at 1.3.x due to https://github.com/intridea/omniauth-oauth2/issues/81
+  gem.add_dependency 'omniauth-oauth2', '~> 1.3.1'
+
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop'
+end

data/spec/omniauth/strategies/contactually_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::OAuth2 do
+  def app
+    ->(_env) { [200, {}, ['Hello.']] }
+  end
+
+  let(:strategy) do
+    OmniAuth::Strategies::Contactually.new(nil, @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) { @request }
+    end
+  end
+
+  before do
+    @request = double('Request')
+    allow(@request).to receive(:params) { {} }
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  context 'client options' do
+    subject { strategy.options.client_options }
+
+    it 'has correct api site' do
+      expect(subject.site).to eq('https://api.contactually.com/')
+    end
+
+    it 'has correct access token path' do
+      expect(subject.token_url).to eq('https://auth.contactually.com/oauth2/token')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.authorize_url).to eq('https://auth.contactually.com/oauth2/authorize')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'rack/test'
+require 'omniauth-contactually'
+
+RSpec.configure do |config|
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-contactually
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Contactually
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-16 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.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rake
+  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
+  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: rubocop
+  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: OmniAuth OAuth2 strategy for Contactually.
+email: api@contactually.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- example/Gemfile
+- example/README.md
+- example/app.rb
+- example/config.ru
+- lib/omniauth-contactually.rb
+- lib/omniauth-contactually/version.rb
+- lib/omniauth/strategies/contactually.rb
+- omniauth-contactually.gemspec
+- spec/omniauth/strategies/contactually_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/contactually/omniauth-contactually
+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.1
+signing_key: 
+specification_version: 4
+summary: OmniAuth OAuth2 strategy for Contactually.
+test_files:
+- spec/omniauth/strategies/contactually_spec.rb
+- spec/spec_helper.rb