omniauth-figma-oauth2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35812759a8cce30338e2eb7a86c3d5c10f572424188b366b48697466de0f8c7f
+  data.tar.gz: 382df3bca3150a689ef5bdb5aedaac753afab1ec01eb520255f9994aa76cd10c
+SHA512:
+  metadata.gz: 8f159e5cd8ab7c5d669f66245ab854f8cf2a2d71cf7b02d6cf08b01c451e2f9e5a4682bb68539146dac146f62f3a6f78510957aa2c79035b15db5ef14d2078f3
+  data.tar.gz: 35563d93fa2b103b8841a599def47094ceba0cb2f589240b3b6eb1c68eb47228d40531cb92cd583b023874b6c46a0476f59f63000a5cff9f82a7054fca2ca2d7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2024-08-22
+
+- Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-figma.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Philipp Riedel
+
+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,75 @@
+<div align="center">
+<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/33/Figma-logo.svg/400px-Figma-logo.svg.png" width="80">
+
+# OmniAuth Figma
+A Figma OAuth2 strategy for OmniAuth.
+
+</div>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-figma-oauth2'
+    gem 'omniauth-rails_csrf_protection'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-figma-oauth2
+
+
+## Usage
+
+Register your application with Figma to receive your Client ID and Secret key: https://www.figma.com/developers/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 :figma, ENV['CLIENT_ID'], ENV['CLIENT_SECRET']
+end
+```
+
+You can now access the OmniAuth Figma OAuth2 URL: `/auth/figma`.
+
+Make sure that all links to /auth/figma use POST requests. For example:
+```ruby
+link_to 'Sign in via Figma', '/auth/figma', method: :post
+# or
+button_to 'Sign in via Figma', '/auth/figma'
+```
+
+For more info check: https://github.com/omniauth/omniauth/wiki/Resolving-CVE-2015-9284
+
+
+## Auth Hash
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  provider: 'figma',
+  uid: '510245748683192988',
+  info: {
+    email: 'john@doe.com',
+    name: 'John',
+    image: 'https://s3-alpha.figma.com/static/user_j.png',
+  },
+  credentials: {
+    access_token: '<TOKEN>',
+    expires_in: '<EXPIRATION (in seconds)>',
+    refresh_token: 'refresh_token'
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/phiele/omniauth-figma-oauth2.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/figma"
+
+# 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.
+
+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/strategies/figma.rb

@@ -0,0 +1,48 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Figma < OmniAuth::Strategies::OAuth2
+
+      option :name, 'figma'
+      option :scope, 'file_read'
+
+      option :client_options, {
+        site:           'https://www.figma.com',
+        authorize_url:  '/oauth',
+        token_url:      '/api/oauth/token'
+      }
+
+      option :token_options, [:client_id, :client_secret]
+      option :token_params, { parse: :json }
+
+      uid { raw_info['id'].to_s }
+
+      info do
+        {
+          :name    => raw_info['handle'],
+          :email   => raw_info['email'],
+          :image   => raw_info['img_url']
+        }
+      end
+
+      credentials do
+        {
+          :access_token   => access_token.token,
+          :expires_at     => access_token.expires_at,
+          :expires        => access_token.expires?,
+          :refresh_token  => access_token.refresh_token
+        }
+      end
+
+      def raw_info
+        @raw_info = access_token.get('https://api.figma.com/v1/me').parsed
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+    end
+  end
+end

data/lib/omniauth-figma/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Figma
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth-figma-oauth2.rb

@@ -0,0 +1,2 @@
+require "omniauth-figma/version"
+require "omniauth/strategies/figma"

data/omniauth-figma-oauth2.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "omniauth-figma/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "omniauth-figma-oauth2"
+  spec.version = Omniauth::Figma::VERSION
+  spec.authors = ["Philipp Riedel"]
+  spec.email = ["riedel.philipp@gmx.net"]
+  spec.summary = "Figma OAuth2 strategy for OmniAuth"
+  spec.description = "Figma OAuth2 strategy for OmniAuth"
+  spec.homepage = "https://github.com/phiele/omniauth-figma-oauth2"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # # 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['lib/**/*.rb'] + Dir['bin/*']
+  spec.files += Dir['[A-Z]*']
+  spec.files.reject! { |fn| fn.include? "CVS" }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  # Register dependencies for this gem
+  spec.add_dependency "omniauth-oauth2", "~> 1.8"
+  spec.add_dependency "omniauth", "~> 2.1"
+
+  # Add development dependencies
+  spec.add_development_dependency "bundler", "~> 2.4", ">= 2.4.20"
+  spec.add_development_dependency "rake", "~> 13.2", ">= 13.2.1"
+  spec.add_development_dependency "rspec", "~> 3.1", ">= 3.1.2"
+  spec.add_development_dependency "rack-test", "~> 2.1.0"
+  spec.add_development_dependency "simplecov", "~> 0.22.0"
+  spec.add_development_dependency "webmock", "~> 3.23.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-figma-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Philipp Riedel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-22 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.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.20
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+description: Figma OAuth2 strategy for OmniAuth
+email:
+- riedel.philipp@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-figma-oauth2.rb
+- lib/omniauth-figma/version.rb
+- lib/omniauth/strategies/figma.rb
+- omniauth-figma-oauth2.gemspec
+homepage: https://github.com/phiele/omniauth-figma-oauth2
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Figma OAuth2 strategy for OmniAuth
+test_files: []