omniauth-miro 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5cc474775b124338f8f92ae946477d796f6e56a6d05d37a766061458685cd6e
+  data.tar.gz: 17a7311149f2706f295defca7024fdac8dd5ddb922288852b73842c1ec901804
+SHA512:
+  metadata.gz: 2d89e74ef9d0bebf0fc1def6070f748658cc41a2c3bd23e5b31a227a469a2945348655a60cc17af5c9ba036fabde98f0afe32ff40bd68b9eb6dbc6e85abcf55d
+  data.tar.gz: 01a5779d24c2661b4687d69a12f0e9c51cfdf202e30d7673ea7dd4a6e4fd807b08c2c0576801379cef3e0caba1ab900f03614ce0707d3cca478f7eb7f2877b31

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+**/.DS_Store
+InstalledFiles
+_yardoc
+coverage/
+doc/
+lib/bundler/man
+pkg
+vendor/
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,131 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 3.2
+  StyleGuideBaseURL: https://github.com/rewindio/ruby-style-configs/
+  NewCops: enable
+  Exclude:
+    - .git/**/*
+    - bin/**/*
+    - log/**/*
+    - tmp/**/*
+    - vendor/**/*
+
+# Layout cop configuration
+
+Layout/LineLength:
+  Max: 160
+
+# Lint cop configuration
+
+Lint/Debugger:
+  Enabled: true
+Lint/SuppressedException:
+  AllowComments: true
+
+# Metrics cop configuration
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Naming cop configuration
+Naming/MethodParameterName:
+  Enabled: true
+  Exclude:
+    - spec/support/helpers.rb
+
+Naming/BlockForwarding:
+  EnforcedStyle: explicit
+
+Naming/FileName:
+  Exclude:
+    - lib/omniauth-miro.rb
+
+# Minitest cop configuration
+
+# Performance cop configuration
+
+# Rails cop configuration
+
+# RSpec cop configuration
+
+RSpec/ExampleLength:
+  Max: 15
+  CountAsOne: ['array', 'heredoc', 'hash']
+RSpec/MultipleExpectations:
+  Max: 5
+# This cop does more harm than good and makes certain data-heavy classes difficult to test.
+# Even Rubocop themselves disables this one.
+# https://github.com/rubocop/rubocop/blob/efb1e628adfec08d2fe7875779fc16b42bde9f77/.rubocop.yml#L145
+# https://stackoverflow.com/a/67149191
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 5
+RSpec/VerifiedDoubleReference:
+  Enabled: false
+RSpec/FilePath:
+  Exclude:
+    - spec/omni_auth/miro/version_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - spec/omni_auth/miro/version_spec.rb
+
+# Style cop configuration
+Style/ArgumentsForwarding:
+  UseAnonymousForwarding: false
+Style/AsciiComments:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Exclude:
+    - config/**/*.rb
+    - lib/**/*.rb
+Style/DateTime:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Details: >-
+    Add `# frozen_string_literal: true` to the top of the file. Frozen string
+    literals will become the default in a future Ruby version, and we want to
+    make sure we're ready.
+  EnforcedStyle: always
+  SupportedStyles:
+    - always
+    - never
+Style/HashEachMethods:
+  Enabled: true
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/NumericPredicate:
+  Enabled: false # This is an unsafe setting which has the potential to introduce bugs because nil == 0 is false, where nil.zero? throws an exception.
+Style/RedundantSelf:
+  Enabled: true
+Style/RescueStandardError:
+  Enabled: false
+
+# Gem Spec cop configuration
+Gemspec/RequireMFA:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [1.0.0]
+
+- New omniauth-miro strategy for Miro OAuth 2.0

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'bundler', '~> 2.4'
+  gem 'pry'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.9.0'
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
+  gem 'simplecov', '~> 0.22'
+  gem 'simplecov-console', '~> 0.9'
+end

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    omniauth-miro (1.0.0)
+      omniauth (>= 1, < 3)
+      omniauth-oauth2 (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    hashie (5.0.0)
+    json (2.6.3)
+    jwt (2.8.1)
+      base64
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    multi_xml (0.6.0)
+    net-http (0.4.1)
+      uri
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    omniauth (2.1.2)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.1)
+    rack (3.0.9.1)
+    rack-protection (4.0.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0, < 4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.24.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.4.2)
+    uri (0.13.0)
+    version_gem (1.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.4)
+  omniauth-miro!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.9.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  simplecov (~> 0.22)
+  simplecov-console (~> 0.9)
+
+BUNDLED WITH
+   2.4.19

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Rewind Software Inc.
+
+MIT License
+
+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,57 @@
+# OmniAuth Miro Strategy
+
+OmniAuth Miro is a Ruby gem that provides authentication for your Ruby applications via the Miro OAuth 2.0 authentication system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-miro'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+1. Register your application with Miro to obtain the `MIRO_CLIENT_ID` and `MIRO_CLIENT_SECRET` credentials.
+
+2. In your application configuration, add the following line to use the Miro OmniAuth strategy:
+
+   ```ruby
+   provider :miro, ENV['MIRO_CLIENT_ID'], ENV['MIRO_CLIENT_SECRET'], scope: 'vso.auditlog etc...', callback_path: '/link/miro/oauth_callback'
+   ```
+
+   Replace `ENV['MIRO_CLIENT_ID']` and `ENV['MIRO_CLIENT_SECRET']` with your Miro client credentials.
+
+3. Implement the necessary routes and views to initiate the authentication process and handle the callback.
+
+4. When users access the authentication route, they will be redirected to Miro for authentication. After successful authentication, Miro will redirect them back to your specified callback URL.
+
+5. Access user information and tokens as needed in your application by utilizing the OmniAuth authentication data.
+
+## Running Tests
+
+You can run the test suite using the following command:
+
+```bash
+rake spec
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the spec. 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/rewindio/omniauth-miro](https://github.com/rewindio/omniauth-miro). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
+
+## License
+
+This gem is available as open-source software under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'omniauth-miro'
+
+# 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/omni_auth/miro/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Miro
+    VERSION = '1.0.0'
+  end
+end

data/lib/omni_auth/strategies/miro.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Miro < OmniAuth::Strategies::OAuth2
+      option :name, :miro
+
+      option :client_options, {
+        site: 'https://miro.com/',
+        authorize_url: 'https://miro.com/oauth/authorize',
+        token_url: 'https://api.miro.com/v1/oauth/token'
+      }
+
+      uid { raw_info['team']['id'] }
+
+      info do
+        {
+          name: raw_info['user']['name'],
+          user_id: raw_info['user']['id'],
+          organization_id: raw_info['organization']['id'],
+          team_id: raw_info['team']['id']
+        }
+      end
+
+      extra do
+        {
+          raw_info: raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/v1/oauth-token').parsed
+      end
+
+      def callback_url
+        full_host + callback_path
+      end
+    end
+  end
+end

data/lib/omniauth-miro.rb

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

data/omniauth-miro.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/omni_auth/miro/version', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-miro'
+  gem.version       = OmniAuth::Miro::VERSION
+  gem.authors       = ['Rewind Software Inc. | Calvin Chen']
+  gem.email         = ['team@rewind.io']
+
+  gem.summary       = 'A Miro OAuth strategy for OmniAuth 2.0'
+  gem.description   = 'A Miro OAuth strategy for OmniAuth 2.0'
+  gem.homepage      = 'https://github.com/rewindio/omniauth-miro'
+  gem.license       = 'MIT'
+  gem.metadata = {
+    'rubygems_mfa_required' => 'false',
+    'bug_tracker_uri' => "#{gem.homepage}/issues",
+    'changelog_uri' => "#{gem.homepage}/blob/main/CHANGELOG.md",
+    'documentation_uri' => gem.homepage.to_s,
+    'homepage_uri' => gem.homepage.to_s,
+    'source_code_uri' => gem.homepage.to_s
+  }
+
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|.github|examples)/}) }
+  gem.bindir        = 'exe'
+  gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 3.2'
+
+  gem.add_runtime_dependency 'omniauth', '>= 1', '< 3'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-miro
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rewind Software Inc. | Calvin Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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'
+description: A Miro OAuth strategy for OmniAuth 2.0
+email:
+- team@rewind.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omni_auth/miro/version.rb
+- lib/omni_auth/strategies/miro.rb
+- lib/omniauth-miro.rb
+- omniauth-miro.gemspec
+homepage: https://github.com/rewindio/omniauth-miro
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+  bug_tracker_uri: https://github.com/rewindio/omniauth-miro/issues
+  changelog_uri: https://github.com/rewindio/omniauth-miro/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/rewindio/omniauth-miro
+  homepage_uri: https://github.com/rewindio/omniauth-miro
+  source_code_uri: https://github.com/rewindio/omniauth-miro
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: A Miro OAuth strategy for OmniAuth 2.0
+test_files: []