omniauth-sproutmark 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dab97df7750a35d6a021624f1165d01995a0ce0
+  data.tar.gz: 6557acfa4e33b76b2c44a659e5bf24956d4ab397
+SHA512:
+  metadata.gz: 911a74783414b392a82276f947a98954f1143846602844500599df7aafc48479dff6966432d216226b66c51133f672c6d943f4e25a2dde72ca412b3ecc9fbd93
+  data.tar.gz: 845aa0e1250207356bc6e2ab3260773081c178dde8c0b48ef6608068f5739f09a420265fcde56ea05e86b60d0780677cb4fdb19b8c930de2e6d2d2e6e8405bca

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jon@mccartie.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :test do
+  if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.0.0")
+    # for jruby 1.7.x
+    gem "addressable", "2.4.0"
+  end
+
+  if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.2.2")
+    gem "rack", "~> 1.6"
+  end
+
+  gem 'rspec', '~> 3.2'
+  gem 'rack-test'
+  gem 'simplecov'
+  gem 'webmock'
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jon McCartie
+
+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,63 @@
+![image](https://travis-ci.org/jmccartie/omniauth-sproutmark.svg?branch=master)
+
+# OmniAuth Sproutmark OAuth2 Strategy
+
+A SproutMark OAuth2 strategy for OmniAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-sproutmark'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-sproutmark
+
+## Usage
+
+Register your application with SproutMark: https://www.sproutmark.com/profile/apps
+
+This is an example that you might put into a Rails initializer at `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :sproutmark, ENV['SPROUTMARK_APP_ID'], ENV['SPROUTMARK_SECRET']
+end
+```
+
+## Granting Permissions to Your Application
+
+With the SproutMark API, you have the ability to specify which permissions you want users to grant your application.
+
+By default, omniauth-sproutmark requests the following permissions:
+
+    'global'
+
+You can configure the scope option:
+
+```ruby
+provider :sproutmark, ENV['SPROUTMARK_APP_ID'], ENV['SPROUTMARK_SECRET'], :scope => 'identity'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-sproutmark. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/sproutmark"
+
+# 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(__FILE__)

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-sproutmark.rb

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

data/lib/omniauth-sproutmark/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Sproutmark
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/sproutmark.rb

@@ -0,0 +1,37 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Sproutmark < OmniAuth::Strategies::OAuth2
+      option :name, 'sproutmark'
+
+      option :client_options, {
+        :site => "https://www.sproutmark.com",
+        :authorize_url => "/oauth/authorize"
+      }
+
+      uid { raw_info["id"] }
+
+      info do
+        {
+          :first_name => raw_info["first_name"],
+          :last_name => raw_info["last_name"],
+          :email => raw_info["email"]
+        }
+      end
+
+      extra do
+        raw_info
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me.json').parsed
+      end
+
+      # https://github.com/intridea/omniauth-oauth2/issues/81
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/omniauth-sproutmark.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-sproutmark/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-sproutmark"
+  spec.version       = Omniauth::Sproutmark::VERSION
+  spec.authors       = ["Jon McCartie"]
+  spec.email         = ["jon@mccartie.com"]
+  spec.description   = %q{Omniauth strategy for SproutMark}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/jmccartie/omniauth-sproutmark"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth-oauth2", '~> 1.4'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/fixtures/user_info.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+X-Ratelimit-Limit: 16384
+X-Ratelimit-Remaining: 16384
+X-Ratelimit-Reset: 1459720721
+Content-Type: application/json; charset=utf-8
+Vary: Accept-Encoding
+Date: Sun, 03 Apr 2016 21:05:23 GMT
+Server: Google Frontend
+Cache-Control: private
+Alt-Svc: quic=":443"; ma=2592000; v="32,31,30,29,28,27,26,25"
+Accept-Ranges: none
+Transfer-Encoding: chunked
+
+{"id":1,"first_name":"Jon","last_name":"McCartie","email":"jon@mccartie.com","created_at":"2014-06-27T20:41:26.765Z","updated_at":"2017-04-12T23:38:53.088Z","due_day":5,"time_zone":"Sydney","organization_id":1,"admin":true,"notification_settings":{"notify_report_reviewed":"1","notify_report_submitted":"1","notify_new_comment":"1","notify_report_due":"1","notify_follow_up":"1","notify_shared_answer":"1","notify_huddle_questions":"1"},"activation_state":"active"}

data/spec/omniauth/strategies/sproutmark_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'omniauth-sproutmark'
+
+describe OmniAuth::Strategies::Sproutmark do
+  subject { OmniAuth::Strategies::Sproutmark.new(nil) }
+
+  it 'should add a camelization for itself' do
+    expect(OmniAuth::Utils.camelize('sproutmark')).to eq('Sproutmark')
+  end
+
+  describe '#client' do
+    it 'has correct Sproutmark site' do
+      expect(subject.client.site).to eq('https://www.sproutmark.com')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.client.options[:authorize_url]).to eq('/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      expect(subject.client.options[:token_url]).to eq('/oauth/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      expect(subject.callback_path).to eq('/auth/sproutmark/callback')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      allow(subject).to receive(:raw_info) { { 'id' => 'uid' } }
+    end
+
+    it 'returns the id from raw_info' do
+      expect(subject.uid).to eq('uid')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      allow(subject).to receive(:raw_info) { {} }
+    end
+
+    context 'and therefore has all the necessary fields' do
+      it { expect(subject.info).to have_key :email }
+      it { expect(subject.info).to have_key :first_name }
+      it { expect(subject.info).to have_key :last_name }
+    end
+  end
+
+
+  describe '#raw_info' do
+    before :each do
+      access_token = double('access token')
+      response = double('response', :parsed => { :foo => 'bar' })
+      expect(access_token).to receive(:get).with("/api/v1/me.json").and_return(response)
+
+      allow(subject).to receive(:option_fields) { ['baz', 'qux'] }
+      allow(subject).to receive(:access_token) { access_token }
+    end
+
+    it 'returns parsed response from access token' do
+      expect(subject.raw_info).to eq({ :foo => 'bar' })
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start do
+  minimum_coverage(85.0)
+end
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-sproutmark'
+require 'pry'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-sproutmark
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon McCartie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-18 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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Omniauth strategy for SproutMark
+email:
+- jon@mccartie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-sproutmark.rb
+- lib/omniauth-sproutmark/version.rb
+- lib/omniauth/strategies/sproutmark.rb
+- omniauth-sproutmark.gemspec
+- spec/fixtures/user_info.txt
+- spec/omniauth/strategies/sproutmark_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jmccartie/omniauth-sproutmark
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Omniauth strategy for SproutMark
+test_files:
+- spec/fixtures/user_info.txt
+- spec/omniauth/strategies/sproutmark_spec.rb
+- spec/spec_helper.rb