omniauth-dnsimple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 161b5f083454c753efba2d266b22af6947bb17bdb31761f89993fd492f75e0e9
+  data.tar.gz: 75aa71c0b063f1a57454b5bc68678c1f4f9c3d39a9989d5fd67295a9345fb48f
+SHA512:
+  metadata.gz: d96bc47aef3330b29bae7bfa3d765ab4c3c4a7858356e9851bb34b9607bf8001660c188e0e60575058e5b56fd978312e1df73d53986e1ea040fa946a78b7e8cb
+  data.tar.gz: 521f4a3f60795da60d6ec1bc9ee35cb769b70d08f104656ceb9f7ecf2f4c0a72a668a24a4465ec337f62119a9e24e2ea712b890bf2ddc8f4316293600e00c8ca

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-03-29
+
+### Added
+- Initial release
+- Basic OmniAuth strategy for DNSimple OAuth2 authentication
+- Support for fetching account information through the DNSimple API 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jonathan Siegel
+
+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,93 @@
+# OmniAuth DNSimple
+
+This is an UNOFFICIAL OmniAuth strategy for authenticating to DNSimple. To use it, you'll need to sign up for an OAuth2 Application ID and Secret on the [DNSimple website](https://dnsimple.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-dnsimple'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install omniauth-dnsimple
+```
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :dnsimple, ENV['DNSIMPLE_CLIENT_ID'], ENV['DNSIMPLE_CLIENT_SECRET']
+end
+```
+
+### Configuring
+
+You can configure several options, which you pass in to the `provider` method via a hash:
+
+* `fetch_info`: When set to `true`, the strategy will make an additional API call to get the account information. Defaults to `true`.
+
+For example:
+
+```ruby
+use OmniAuth::Builder do
+  provider :dnsimple, ENV['DNSIMPLE_CLIENT_ID'], ENV['DNSIMPLE_CLIENT_SECRET'], 
+           fetch_info: false
+end
+```
+
+### Authentication Hash
+
+An example auth hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider" => "dnsimple",
+  "uid" => "123456",
+  "info" => {
+    "name" => "user@example.com",
+    "email" => "user@example.com"
+  },
+  "credentials" => {
+    "token" => "a1b2c3d4e5f6g7h8i9j0", # The OAuth 2.0 access token
+    "refresh_token" => "1a2b3c4d5e6f7g8h9i0j", # The OAuth 2.0 refresh token
+    "expires_at" => 1496120719, # The time the token expires as a unix timestamp
+    "expires" => true # A boolean for whether the token expires
+  },
+  "extra" => {
+    "raw_info" => {
+      "data" => {
+        "user" => {
+          "id" => 1234,
+          "email" => "user@example.com"
+        },
+        "account" => {
+          "id" => 123456,
+          "email" => "user@example.com"
+        }
+      }
+    }
+  }
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/usiegj00/omniauth-dnsimple.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). 

data/lib/omniauth/dnsimple/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module DNSimple
+    VERSION = "0.1.0"
+  end
+end 

data/lib/omniauth/strategies/dnsimple.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class DNSimple < OmniAuth::Strategies::OAuth2
+      option :name, :dnsimple
+
+      # This allows overriding the OAuth endpoints via environment variables
+      AUTH_URL = ENV.fetch("DNSIMPLE_AUTH_URL", "https://dnsimple.com")
+      API_URL = ENV.fetch("DNSIMPLE_API_URL", "https://api.dnsimple.com")
+      
+      private_constant :AUTH_URL, :API_URL
+
+      option :client_options, {
+        site: API_URL,
+        authorize_url: "#{AUTH_URL}/oauth/authorize",
+        token_url: "#{API_URL}/v2/oauth/access_token"
+      }
+
+      option :token_method, :post
+      option :auth_scheme, :request_body
+      option :client_params_in_body, true
+      
+      # Configure whether we make another API call to DNSimple to fetch
+      # additional account info
+      option :fetch_info, true
+
+      uid do
+        access_token.params["account_id"] || (raw_info["data"]["account"]["id"].to_s if raw_info.dig("data", "account"))
+      end
+
+      info do
+        if options.fetch_info && raw_info.dig("data", "account")
+          {
+            name: raw_info["data"]["account"]["email"],
+            email: raw_info["data"]["account"]["email"]
+          }
+        else
+          { name: "DNSimple user" } # only mandatory field
+        end
+      end
+
+      extra do
+        if options.fetch_info
+          { raw_info: raw_info }
+        else
+          {}
+        end
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + callback_path)
+      end
+
+      # override method in OmniAuth::Strategies::OAuth2 to error
+      # when we don't have a client_id or secret:
+      def request_phase
+        if missing_client_id?
+          fail!(:missing_client_id)
+        elsif missing_client_secret?
+          fail!(:missing_client_secret)
+        else
+          super
+        end
+      end
+
+      private
+
+      def raw_info
+        @raw_info ||= access_token.get('v2/whoami').parsed
+      rescue StandardError
+        {}
+      end
+
+      def missing_client_id?
+        [nil, ""].include?(options.client_id)
+      end
+
+      def missing_client_secret?
+        [nil, ""].include?(options.client_secret)
+      end
+    end
+  end
+end 

data/lib/omniauth-dnsimple.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "omniauth/strategies/dnsimple" 

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-dnsimple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Siegel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-29 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.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: webmock
+  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'
+description: OmniAuth strategy for authenticating with DNSimple via OAuth2
+email:
+- usiegj00@no-spam-please.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/omniauth-dnsimple.rb
+- lib/omniauth/dnsimple/version.rb
+- lib/omniauth/strategies/dnsimple.rb
+homepage: https://github.com/usiegj00/omniauth-dnsimple
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/usiegj00/omniauth-dnsimple
+  source_code_uri: https://github.com/usiegj00/omniauth-dnsimple
+  changelog_uri: https://github.com/usiegj00/omniauth-dnsimple/blob/main/CHANGELOG.md
+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.5.16
+signing_key:
+specification_version: 4
+summary: OmniAuth strategy for DNSimple
+test_files: []