omniauth-gab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80d7a86752512a8c766e6f40218d969b3b742507a3cb99c6e55095d33ebd88f6
+  data.tar.gz: f39f7e99299f56574f3de4ca891dce499fc97217fbf90c72aa1ee809c97550b5
+SHA512:
+  metadata.gz: 6d9101116ca00c638b85e987912bad2e6d3c4d43061f198983cbfada2c9eea88a17d77df68d0ff724f21e32379a7b97d35aac9b32c1a6a2fd7d7392bc27d6de3
+  data.tar.gz: 7e485a35fd88f10c4789fdf2ba34cd786404d27e8d190839019a9402269016f28c01bcb340163b4b9925f6153c23cc00bc41a85446fbd4af5b997c1098e04054

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/stubs
+/vendor

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,157 @@
+require:
+  - rubocop/rspec/focused
+
+AllCops:
+  TargetRubyVersion: 2.4
+  TargetRailsVersion: 5.2
+
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+  Exclude:
+    - 'Capfile'
+    - 'tmp/**/*'
+    - 'log/**/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+    - 'stubs/**/*'
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+    - 'features/step_definitions/*'
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+########################################
+# Style Cops
+
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: when_needed
+
+# String#format is private now
+Style/FormatString:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+########################################
+# Layout Cops
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+
+########################################
+# Naming Cops
+
+Naming/FileName:
+  Enabled: false
+
+########################################
+# Security Cops
+
+Security/Eval:
+  Enabled: true
+
+########################################
+# Lint Cops
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/EndAlignment:
+  Enabled: false
+
+########################################
+# Metrics Cops
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/MethodLength:
+  CountComments: false # count full line comments?
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+########################################
+# Bundler Cops
+
+Bundler/OrderedGems:
+  Enabled: false
+
+########################################
+# Bundler Cops
+
+RSpec/Focused:
+  Enabled: true

data/.travis.yml

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

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 87a1779b@opayq.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in omniauth-gab.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    omniauth-gab (0.1.0)
+      omniauth
+      omniauth-oauth2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.5.7)
+    jwt (1.5.6)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.8.1)
+      hashie (>= 3.4.6, < 3.6.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.5.0)
+      oauth2 (~> 1.1)
+      omniauth (~> 1.2)
+    rack (2.0.5)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  omniauth-gab!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chris Blackburn
+
+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,128 @@
+# Omniauth for Gab
+
+Ruby gem for authenticating with [Gab](https://gab.com), using an OAuth2 strategy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-gab'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-gab
+
+## Pre-requisites
+
+Register your Gab App by logging into your account and going to [Settings > Developer Apps](https://gab.com/settings/clients). Click `Create app` and fill in the requested information. Make note of the `REDIRECT URL` as you will need the exact url for your configuration.
+
+## Usage
+
+### Configuration
+
+In Rails add `config/initializers/omniauth.rb` with the following:
+
+If you are using environment variables or [dotenv](https://github.com/bkeepers/dotenv) (recommended):
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :gab, ENV['GAB_CLIENT_ID'], ENV['GAB_CLIENT_SECRET'],
+    scope: ENV['GAB_SCOPES'],
+    redirect_uri: ENV['GAB_REDIRECT_URI'],
+    provider_ignores_state: true
+end
+```
+
+Or you can hardcode your credentials:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :gab, 'your-app-client-id', 'your-app-secret-id',
+    scope: 'your scopes separated with a single space',
+    redirect_uri: 'the redirect uri from above',
+    provider_ignores_state: true
+end
+```
+
+### Routing
+
+```ruby
+get '/auth/:provider/callback' => 'sessions#create'
+get '/signin' => 'sessions#new', as: :signin
+get '/signout' => 'sessions#destroy', as: :signout
+get '/auth/failure' => 'sessions#failure'
+```
+
+### Model
+
+Make sure to add at least the following columns to your `User` model:
+
+```ruby
+t.string :provider
+t.string :uid
+```
+
+### Controller
+
+You can create a sessions controller something like this:
+
+```ruby
+# app/controllers/sessions_controller.rb
+class SessionsController < ApplicationController
+  def new
+    redirect_to '/auth/gab'
+  end
+
+  def create
+    auth = request.env['omniauth.auth']
+    user = User.where(
+      provider: auth['provider'],
+      uid: auth['uid'].to_s
+    ).first || User.create_with_omniauth(auth)
+    reset_session
+    session[:user_id] = user.id
+    redirect_to root_url, notice: 'Signed in!'
+  end
+
+  def destroy
+    reset_session
+    redirect_to root_url, notice: 'Signed out!'
+  end
+
+  def failure
+    redirect_to root_url, alert: "Authentication error: #{params[:message].humanize}"
+  end
+end
+```
+
+### View
+
+For a sign-in link:
+
+```haml
+= link_to 'Login to Gab', signin_path
+```
+
+## Resources
+
+* [The Gab API Docs](https://developers.gab.com/)
+* [OmniAuth](https://github.com/omniauth/omniauth)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/midwire/omniauth-gab. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Omniauth::Gab project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/midwire/omniauth-gab/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/omniauth/strategies/gab.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Gab < OmniAuth::Strategies::OAuth2
+      option :name, 'gab'
+
+      option :client_options,
+        site: 'https://api.gab.com',
+        authorize_url: 'https://api.gab.com/oauth/authorize',
+        token_url: 'https://api.gab.com/oauth/token',
+        grant_type: 'authorization_code'
+
+      uid { raw_info['id'].to_s }
+
+      info do
+        {
+          name: raw_info['name'],
+          username: raw_info['username'],
+          verified: raw_info['verified'],
+          image: raw_info['picture_url_full']
+        }
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        access_token.options[:parse] = :json
+        @raw_info ||= access_token.get('/v1.0/me/').parsed
+      end
+
+      def authorize_params(params = {})
+        params.merge(
+          'response_type' => 'code',
+          'client_id' => options.client_id,
+          'redirect_uri' => options.redirect_uri,
+          'scope' => options.scope
+        )
+      end
+
+      private
+
+      def callback_url
+        options['redirect_uri'] || (full_host + script_name + callback_path)
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'gab', 'Gab'

data/lib/omniauth-gab/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Omniauth
+  module Gab
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth-gab.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'omniauth-gab/version'
+require 'omniauth/strategies/gab'

data/omniauth-gab.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-gab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-gab'
+  spec.version       = Omniauth::Gab::VERSION
+  spec.authors       = ['Christopher Michael']
+  spec.email         = ['87a1779b@opayq.com']
+
+  spec.summary       = 'Omniauth provider for Gab Oauth2'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://midwiretech.com'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'omniauth'
+  spec.add_dependency 'omniauth-oauth2'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-gab
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Michael
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Omniauth provider for Gab Oauth2
+email:
+- 87a1779b@opayq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-gab.rb
+- lib/omniauth-gab/version.rb
+- lib/omniauth/strategies/gab.rb
+- omniauth-gab.gemspec
+homepage: https://midwiretech.com
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Omniauth provider for Gab Oauth2
+test_files: []