omniauth-mlh 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 622c9053382357ade0f161e78ed3f13ae01ae9f939b9bae87b43ff3281b618e2
-  data.tar.gz: bc057ee83655fcac77978e15a21891013981853cebc8e7c235d08601468d8156
+  metadata.gz: a8a63e3530dc45956b6373c50995939ce8ea698a3118c473a0a5d497fb75ed55
+  data.tar.gz: 14a9fa6f3ee6eb9d26b4496fe0678f17aa805eaf1b15457cc13f172e698ada6e
 SHA512:
-  metadata.gz: b4cd23553337c4dc6537a4c432c61d00f84334cd0d0372d7c3148b0c85bf175834a97ac9e213623e17541349f16b15e4489bfe0f8658302ae7fc01d71e4ad76f
-  data.tar.gz: fb197ac156fb8a6ff76c8ce5b7e01ba016ff3859ad3741cd10da11932c274c7dc33c0f1dffbc766e0479cc4607d29621267e942ed1d26f22df37bdbb8f432050
+  metadata.gz: 525b5b9983beda5ed9c922e451430f7c6ead1d3ce508fddfd6f2616eab46de12772540d4252a1db6ed632b39a6b388ce35dbb3ba28ef108633f7e38bd3a73102
+  data.tar.gz: 9ec5f8644840ceeb01267be362bf26f7cec1e36853611c718ffe46b9a2e48fb9b6c0804c242c65f8612dfde7da80915bbd5d940bcee63c06e6dcf1a25c47ac12

data/.github/workflows/gem-push.yml

@@ -0,0 +1,30 @@
+name: Push Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 3.2
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"

data/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+    branches:
+      - 'main'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest 
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.2']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+      - name: Run Spec
+        run: bundle exec rake spec
+      - name: Run Rubocop
+        run: bundle exec rake rubocop

data/.rubocop.yml

@@ -1,12 +1,28 @@
-AllCops:
-  TargetRubyVersion: '2.2.0'
+require: 
+  - rubocop-rspec
+  - rubocop-performance
 
-Naming/FileName:
+AllCops:
+  # Ruby 2.7 is the MINIMUM Ruby version supported
+  TargetRubyVersion: '2.7.0'
   Exclude:
-    - 'lib/omniauth-mlh.rb'
+    - vendor/**/*
 
-Metrics/BlockLength:
-  Exclude:
-    - 'Rakefile'
-    - '**/*.rake'
-    - 'spec/**/*'
+Style/WordArray:
+  Description: Force arrays of words to use bracket notation instead of %w
+  EnforcedStyle: brackets
+  Enabled: true
+
+Style/SymbolArray: 
+  Description: Force symbol arrays to use bracket notation instead of %i
+  EnforcedStyle: brackets 
+  Enabled: true
+
+Style/RegexpLiteral:
+  Description: Allow forward slashes within regular expressions
+  AllowInnerSlashes: true
+  Enabled: true
+
+RSpec/MultipleExpectations: 
+  Description: Allow tests to contain multiple expectations 
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 3.0.5
+  - 2.2.0

data/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing Guidelines
+
+Thank you for considering contributing to omniauth-mlh.
+
+## Contributor Checklist
+
+- Fork the Repo ( https://github.com/mlh/omniauth-mlh/fork )
+- Create your feature branch (`git checkout -b my-new-feature`)
+- Commit your changes (`git commit -am 'Add some feature'`)
+- Push to the branch (`git push origin my-new-feature`)
+- Create a new Pull Request
+
+### Running tests
+
+Following command can be used to run the test 
+
+```bash
+$ bundle exec rake spec
+```
+
+## Code quality tools
+
+Code quality is enforced across the entire gem with Rubocop:
+
+```bash
+$ bundle exec rubocop
+```

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in omniauth-mlh.gemspec

data/README.md

@@ -1,6 +1,6 @@
-# MLH/my-mlh-omniauth
+# MLH/omniauth-mlh
 
-[![Build Status](https://travis-ci.org/MLH/my-mlh-omniauth.svg?branch=master)](https://travis-ci.org/MLH/my-mlh-omniauth)
+[![Test](https://github.com/MLH/omniauth-mlh/actions/workflows/test.yml/badge.svg)](https://github.com/MLH/omniauth-mlh/actions/workflows/test.yml)
 
 This is the official [OmniAuth](https://github.com/omniauth/omniauth) strategy for
 authenticating with [MyMLH](https://my.mlh.io). To use it, you'll need to
@@ -12,7 +12,8 @@ Once you have done so, you can follow the instructions below:
 
 ## Requirements
 
-You need to have at least Ruby 3.0.5 to use this gem.
+This Gem requires your Ruby version to be at least `2.2.0`, which is set
+downstream by [Omniauth](https://github.com/omniauth/omniauth/blob/master/omniauth.gemspec#L22).
 
 ## Installation
 
@@ -50,11 +51,7 @@ end
 
 ## Contributing
 
-1. Fork it ( https://github.com/mlh/my-mlh-omniauth/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+For guidance on setting up a development environment and how to make a contribution to omniauth-mlh, see the [contributing guidelines](https://github.com/MLH/omniauth-mlh/blob/main/CONTRIBUTING.md).
 
 ## Credit
 

data/Rakefile

@@ -1,8 +1,12 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
 
 desc 'Run specs'
 task default: :spec

data/lib/omniauth/strategies/mlh.rb

@@ -48,5 +48,5 @@ module OmniAuth
 end
 
 OmniAuth.config.add_camelization 'mlh', 'MLH'
-OmniAuth.config.allowed_request_methods = %i[post get]
+OmniAuth.config.allowed_request_methods = [:post, :get]
 OmniAuth.config.silence_get_warning = true

data/lib/omniauth-mlh/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module MLH
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/lib/{omniauth-mlh.rb → omniauth_mlh.rb}

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
-require 'active_support'
 require 'omniauth-mlh/version'
 require 'omniauth/strategies/mlh'

data/omniauth-mlh.gemspec

@@ -8,15 +8,15 @@ require 'omniauth-mlh/version'
 Gem::Specification.new do |spec|
   spec.name          = 'omniauth-mlh'
   spec.version       = OmniAuth::MLH::VERSION
-  spec.authors       = ['Swift']
-  spec.email         = ['swift@mlh.io']
+  spec.authors       = ['Major League Hacking (MLH)']
+  spec.email         = ['hi@mlh.io']
 
   spec.summary       = 'Official OmniAuth strategy for MyMLH.'
   spec.description   = 'Official OmniAuth strategy for MyMLH.'
   spec.homepage      = 'http://github.com/mlh/omniauth-mlh'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.executables    = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.files          = `git ls-files`.split("\n")
@@ -26,13 +26,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'oauth2', '~> 2.0.9'
   spec.add_dependency 'omniauth', '~> 2.1.1'
   spec.add_dependency 'omniauth-oauth2', '~> 1.8.0'
-  spec.add_dependency 'omniauth-rails_csrf_protection', '~> 1.0.1'
-
-  spec.add_dependency 'activesupport'
 
   spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rake', '~> 10.5'
-  spec.add_development_dependency 'rspec', '~> 2.7'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
 end

data/spec/omni_auth/mlh_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe OmniAuth::MLH do
+  subject(:omniauth_mlh) do
+    # The instance variable @options is being used to pass options to the subject of the shared examples
+    OmniAuth::Strategies::MLH.new(nil, @options || {}) # rubocop:disable RSpec/InstanceVariable
+  end
+
+  it_behaves_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct MyMLH site' do
+      expect(omniauth_mlh.client.site).to eq('https://my.mlh.io')
+    end
+
+    it 'has correct authorize url' do
+      expect(omniauth_mlh.client.options[:authorize_url]).to eq('oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      expect(omniauth_mlh.client.options[:token_url]).to eq('oauth/token')
+    end
+
+    it 'runs the setup block if passed one' do
+      counter = ''
+      @options = { setup: proc { |_env| counter = 'ok' } }
+      omniauth_mlh.setup_phase
+      expect(counter).to eq('ok')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      expect(omniauth_mlh.callback_path).to eq('/auth/mlh/callback')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ require 'rspec'
 require 'rack/test'
 require 'webmock/rspec'
 require 'omniauth'
-require 'omniauth-mlh'
+require 'omniauth_mlh'
 
 Dir[File.expand_path('support/**/*', __dir__)].sort.each { |f| require f }
 

data/spec/support/shared_examples.rb

@@ -5,35 +5,40 @@
 
 shared_examples 'an oauth2 strategy' do
   describe '#client' do
-    it 'should be initialized with symbolized client_options' do
+    it 'is initialized with symbolized client_options' do
       @options = { client_options: { 'authorize_url' => 'https://example.com' } }
+
       expect(subject.client.options[:authorize_url]).to eq('https://example.com')
     end
   end
 
   describe '#authorize_params' do
-    it 'should include any authorize params passed in the :authorize_params option' do
+    it 'includes any authorize params passed in the :authorize_params option' do
       @options = { authorize_params: { foo: 'bar', baz: 'zip' } }
+
       expect(subject.authorize_params['foo']).to eq('bar')
       expect(subject.authorize_params['baz']).to eq('zip')
     end
 
-    it 'should include top-level options that are marked as :authorize_options' do
-      @options = { authorize_options: %i[scope foo], scope: 'bar', foo: 'baz' }
+    it 'includes top-level options that are marked as :authorize_options' do
+      @options = { authorize_options: ['scope', 'foo'], scope: 'bar', foo: 'baz' }
+
       expect(subject.authorize_params['scope']).to eq('bar')
       expect(subject.authorize_params['foo']).to eq('baz')
     end
   end
 
   describe '#token_params' do
-    it 'should include any token params passed in the :token_params option' do
+    it 'includes any token params passed in the :token_params option' do
       @options = { token_params: { foo: 'bar', baz: 'zip' } }
+
       expect(subject.token_params['foo']).to eq('bar')
       expect(subject.token_params['baz']).to eq('zip')
     end
 
-    it 'should include top-level options that are marked as :token_options' do
-      @options = { token_options: %i[scope foo], scope: 'bar', foo: 'baz' }
+    it 'includes top-level options that are marked as :token_options' do
+      @options = { token_options: [:scope, :foo], scope: 'bar', foo: 'baz' }
+
       expect(subject.token_params['scope']).to eq('bar')
       expect(subject.token_params['foo']).to eq('baz')
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-mlh
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
-- Swift
-autorequire:
+- Major League Hacking (MLH)
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -53,75 +53,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: omniauth-rails_csrf_protection
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 12.3.3
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        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-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: '2.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -152,31 +166,34 @@ dependencies:
         version: '0'
 description: Official OmniAuth strategy for MyMLH.
 email:
-- swift@mlh.io
+- hi@mlh.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/omniauth-mlh.rb
 - lib/omniauth-mlh/version.rb
 - lib/omniauth/strategies/mlh.rb
+- lib/omniauth_mlh.rb
 - omniauth-mlh.gemspec
-- spec/omniauth/mlh_spec.rb
+- spec/omni_auth/mlh_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
 homepage: http://github.com/mlh/omniauth-mlh
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -184,18 +201,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Official OmniAuth strategy for MyMLH.
-test_files:
-- spec/omniauth/mlh_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples.rb
+test_files: []

data/spec/omniauth/mlh_spec.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe OmniAuth::MLH do
-  subject do
-    OmniAuth::Strategies::MLH.new(nil, @options || {})
-  end
-
-  it_should_behave_like 'an oauth2 strategy'
-
-  describe '#client' do
-    it 'has correct MyMLH site' do
-      expect(subject.client.site).to eq('https://my.mlh.io')
-    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
-
-    it 'runs the setup block if passed one' do
-      counter = ''
-      @options = { setup: proc { |_env| counter = 'ok' } }
-      subject.setup_phase
-      expect(counter).to eq('ok')
-    end
-  end
-
-  describe '#callback_path' do
-    it 'has the correct callback path' do
-      expect(subject.callback_path).to eq('/auth/mlh/callback')
-    end
-  end
-end