omniauth-patreon 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6204fc3fab14e14e5824fe56d0b0cfc72d4cf344
+  data.tar.gz: 5d5770b449297ce7709067f0f4d0ba90d23eb907
+SHA512:
+  metadata.gz: 6e3526f837428919e1cea378c980df114160322646e9e05f69ca374582d5902db35607f21da23c18fc1fded7d8e31b147bc50ea18caaab026dd04739980157ac
+  data.tar.gz: 3466ccae50013ff4553c1f2d61b98a5bf5899b2e2524c7c5178596aaa182e4d0c366348abcb8319ee8ebb69dc63aa333249f82c92122641fbbbdf6283a960559

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
+.env
+.rspec

data/.rubocop-https---raw-githubusercontent-com-tmilewski-rubocop-defaults-master-rubocop-yml

@@ -0,0 +1,58 @@
+# see https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# for default configuration
+
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  Exclude:
+    - 'db/schema.rb'
+    - 'bin/*'
+    - 'vendor/**/*'
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 125
+  Exclude:
+    - 'db/migrate/*'
+    - 'config/initializers/devise.rb'
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 10
+  Exclude:
+    - 'db/migrate/*'
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or a Float.
+  # http://c2.com/cgi/wiki?AbcMetric
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  # http://www.rubydoc.info/github/bbatsov/rubocop/Rubocop/Cop/Style/CyclomaticComplexity
+  Max: 6
+
+Metrics/PerceivedComplexity:
+  # http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Metrics/PerceivedComplexity
+  Max: 7
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 100
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from:
+  - https://raw.githubusercontent.com/tmilewski/rubocop-defaults/master/rubocop.yml
+
+Style/FileName:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'tmp/**/*'

data/.travis.yml

@@ -0,0 +1,17 @@
+bundler_args: --without development
+before_install: gem update bundler
+cache: bundler
+env:
+  global:
+    - JRUBY_OPTS="$JRUBY_OPTS --debug"
+language: ruby
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - 2.4.1
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+sudo: false

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'rubocop', '>= 0.48.1'
+end
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'rack-test'
+  gem 'rspec', '~> 3.6.0'
+  gem 'simplecov', require: false
+end
+
+gemspec

data/README.md

@@ -0,0 +1,175 @@
+# omniauth-patreon
+
+[![Gem Version](https://badge.fury.io/rb/omniauth-patreon.svg)](http://badge.fury.io/rb/omniauth-patreon)
+[![Build Status](https://travis-ci.org/signalnerve/omniauth-patreon.svg?branch=master)](https://travis-ci.org/signalnerve/omniauth-patreon)
+
+Patreon OAuth2 Strategy for OmniAuth 1.x and supports the OAuth 2.0 server-side flow.
+
+You may view the Patreon API documentation [here](https://www.patreon.com/portal/).
+
+This project is a fork from [omniauth/omniauth-uber](https://github.com/omniauth/omniauth-uber), reconfigured for the Patreon API 🙂
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-patreon'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Patreon` is simply Rack middleware. Read the OmniAuth 1.0 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 :patreon, ENV['PATREON_CLIENT_ID'], ENV['PATREON_CLIENT_SECRET']
+end
+```
+
+## Configuration
+
+- `scope`: A _space separated_ list of permissions you want to request from the Patreon API (e.g: `users my-campaign`). View the Patreon API docs for [Scope](https://docs.patreon.com/#scopes). Default: `users pledges-to-me my-campaign`
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :patreon, ENV['patreon_CLIENT_ID'], ENV['patreon_CLIENT_SECRET'], scope: 'campaigns pledges'
+end
+```
+
+## Auth Hash
+
+Here's an example _Auth Hash_ available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider"=>"patreon",
+  "uid"=>"12345678",
+  "info"=>{
+    "email"=>"my@email.com",
+    "name"=>"Page",
+    "access_token"=>"faketoken",
+    "refresh_token"=>"faketoken"
+  },
+  "credentials"=>{
+    "token"=>"faketoken",
+    "refresh_token"=>"faketoken",
+    "expires_at"=>1542163217,
+    "expires"=>true
+  },
+  "extra"=>{
+    # See expanded selection below
+  }
+}
+```
+
+<details>
+
+<summary>Expanded OAuth response</summary>
+
+```ruby
+{
+  "provider"=>"patreon",
+  "uid"=>"12345678",
+  "info"=>{
+    "email"=>"my@email.com",
+    "name"=>"Page",
+    "access_token"=>"faketoken",
+    "refresh_token"=>"faketoken"
+  },
+  "credentials"=>{
+    "token"=>"faketoken",
+    "refresh_token"=>"faketoken",
+    "expires_at"=>1542163217,
+    "expires"=>true
+  },
+  "extra"=>{
+    "raw_info"=>{
+      "data"=>{
+        "attributes"=>{
+          "about"=>nil,
+          "can_see_nsfw"=>true,
+          "created"=>"2018-01-01T01:05:29+00:00",
+          "default_country_code"=>nil,
+          "discord_id"=>nil,
+          "email"=>"my@email.com",
+          "facebook"=>"https://www.facebook.com/pagename",
+          "facebook_id"=>nil,
+          "first_name"=>"First",
+          "full_name"=>"First Last",
+          "gender"=>0,
+          "has_password"=>true,
+          "image_url"=>"fakeurl",
+          "is_deleted"=>false,
+          "is_email_verified"=>true,
+          "is_nuked"=>false,
+          "is_suspended"=>false,
+          "last_name"=>"Last",
+          "social_connections"=>{
+            "deviantart"=>nil,
+            "discord"=>nil,
+            "facebook"=>nil,
+            "reddit"=>nil,
+            "spotify"=>nil,
+            "twitch"=>nil,
+            "twitter"=>nil,
+            "youtube"=>nil
+          },
+          "thumb_url"=>"fakeurl",
+          "twitch"=>"https://www.twitch.tv/pagename",
+          "twitter"=>"pagename",
+          "url"=>"https://www.patreon.com/pagename",
+          "vanity"=>"pagename",
+          "youtube"=>"https://www.youtube.com/pagename"
+        },
+        "id"=>"12345678",
+        "relationships"=>{
+          "pledges"=>{
+            "data"=>[]
+          }
+        },
+        "type"=>"user"
+      },
+      "links"=>{
+        "self"=>"https://www.patreon.com/api/user/12345678"
+      }
+    }
+  }
+}
+```
+
+</details>
+
+## Supported Ruby Versions
+
+`omniauth-patreon` is tested under 2.2.6, 2.3.3, 2.4.1, and ruby-head.
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+    spec.add_dependency 'omniauth-patreon', '~> 1.0'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
+## License
+
+Copyright (c) 2018 by Kristian Freeman
+
+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/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+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: %i[spec rubocop]

data/lib/omniauth-patreon.rb

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

data/lib/omniauth/patreon/version.rb

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

data/lib/omniauth/strategies/patreon.rb

@@ -0,0 +1,42 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Patreon < OmniAuth::Strategies::OAuth2
+      option :name, 'patreon'
+
+      option :client_options,
+        site: 'https://www.patreon.com',
+        authorize_url: 'https://www.patreon.com/oauth2/authorize',
+        token_url: 'https://api.patreon.com/oauth2/token'
+
+      uid { raw_info['data']['id'].to_s }
+
+      info do
+        {
+          email: raw_info['data']['attributes']['email'],
+          name: raw_info['data']['attributes']['full_name'],
+          access_token: access_token.token,
+          refresh_token: access_token.refresh_token
+        }
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= begin
+          response = client.request(:get, "https://api.patreon.com/oauth2/api/current_user", headers: {
+              'Authorization' => "Bearer #{access_token.token}"
+          }, parse: :json)
+          response.parsed
+        end
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/omniauth-patreon.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'omniauth/patreon/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'omniauth-patreon'
+  s.version       = OmniAuth::Patreon::VERSION
+  s.authors       = ['Kristian Freeman']
+  s.email         = ['kristian@bytesized.xyz']
+  s.summary       = 'Patreon strategy for OmniAuth'
+  s.description   = 'Patreon strategy for OmniAuth v1.2'
+  s.homepage      = 'https://github.com/tmilewski/omniauth-patreon'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").collect { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'omniauth', '~> 1.2'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+
+  s.add_development_dependency 'dotenv', '>= 2.0'
+  s.add_development_dependency 'sinatra', '>= 2.0'
+end

data/spec/app.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'dotenv'
+require 'sinatra'
+require 'omniauth'
+require 'omniauth-patreon'
+
+Dotenv.load
+
+enable :sessions
+
+use OmniAuth::Builder do
+  provider :patreon, ENV['CLIENT_ID'], ENV['CLIENT_SECRET'] # , :scope => 'profile'
+end
+
+get '/' do
+  <<-HTML
+  <a href='/auth/patreon'>Sign in with patreon</a>
+  HTML
+end
+
+get '/auth/failure' do
+  env['omniauth.error'].to_s
+end
+
+get '/auth/:name/callback' do
+  auth = request.env['omniauth.auth']
+
+  puts %(
+    >> UID
+      #{auth.uid.inspect}
+
+    >> CREDENTIALS
+      #{auth.credentials.inspect}
+
+    >> INFO
+      #{auth.info.inspect}
+      #
+    >> EXTRA
+      #{auth.extra.inspect}
+  )
+
+  'Check logs for user information.'
+end

data/spec/omniauth/strategies/uber_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Patreon do
+  subject do
+    @subject ||= begin
+      @options ||= {}
+      args = ['client_id', 'client_secret', @options].compact
+      OmniAuth::Strategies::Patreon.new(*args)
+    end
+  end
+
+  context 'client options' do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq('patreon')
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://www.patreon.com/api/oauth2/api')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('https://patreon.com/oauth2/authorize')
+    end
+
+    it 'should have correct access token url' do
+      expect(subject.options.client_options.token_url).to eq('https://patreon.com/api/oauth2/token')
+    end
+
+    it 'should indicate that the provider ignores the state parameted' do
+      expect(subject.options.provider_ignores_state).to eq false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'simplecov'
+SimpleCov.start
+
+require 'omniauth'
+require 'omniauth-patreon'
+
+RSpec.configure do |config|
+  config.extend OmniAuth::Test::StrategyMacros, type: :strategy
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-patreon
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kristian Freeman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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: 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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Patreon strategy for OmniAuth v1.2
+email:
+- kristian@bytesized.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop-https---raw-githubusercontent-com-tmilewski-rubocop-defaults-master-rubocop-yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-patreon.rb
+- lib/omniauth/patreon/version.rb
+- lib/omniauth/strategies/patreon.rb
+- omniauth-patreon.gemspec
+- spec/app.rb
+- spec/omniauth/strategies/uber_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tmilewski/omniauth-patreon
+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: Patreon strategy for OmniAuth
+test_files:
+- spec/app.rb
+- spec/omniauth/strategies/uber_spec.rb
+- spec/spec_helper.rb