http-auth0 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f53f0e6ddc1989adf00d2f1cb4aee9aa53f47a543726f9c6fd89072db9d55149
+  data.tar.gz: d594ac5151d17c2d5e144544e0cdb5e6aa2cf7d9ddbda7c949f0e1a092cdc4c6
+SHA512:
+  metadata.gz: 2f33d47e9c207ee606509782cdf33469c68d2018907bdaa41a21682fb74f4ff3e58d37bdad674d42e4346f27cd3af36e0bdc8ae5ab74b52b67e312cee5cceec8
+  data.tar.gz: 1eca6ddf26c59ffa868345bbc35dbf4ecfd9c571f2875f218a0107917025a088b4ee97abebffd9ae5a66b74510ff35c632b0f59a26edf152a5a07406fd500ab7

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 John Chlark Sumatra
+Copyright (c) 2022 First Circle Growth Finance Corp.
+
+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,80 @@
+# http-auth0
+
+[![CI](https://github.com/itsmechlark/http-auth0/actions/workflows/release.yml/badge.svg)](https://github.com/itsmechlark/http-auth0/actions/workflows/release.yml)
+[![Coverage Status](https://coveralls.io/repos/github/itsmechlark/http-auth0/badge.svg?branch=main)](https://coveralls.io/github/itsmechlark/http-auth0?branch=main)
+[![Maintainability](https://api.codeclimate.com/v1/badges/298974e71e03a3b26a47/maintainability)](https://codeclimate.com/github/itsmechlark/http-auth0/maintainability)
+
+HTTP client abstraction layer for Auth Application [RFC](https://github.com/itsmechlark/rfcs/pull/2)
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+source 'https://rubygems.pkg.github.com/itsmechlark' do
+  gem 'http-auth0'
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+### Configure the gem in an initializer
+
+```ruby
+HTTP::Auth0.configure do |auth0|
+  auth0.domain = 'insert-domain-here.jp.auth0.com'
+  auth0.client_id = 'insert-client-id-here'
+  auth0.client_secret = 'insert-client-secret-here'
+end
+```
+
+### Use with your preferred HTTP client
+#### Faraday Example
+
+```ruby
+require 'faraday'
+require 'faraday/net_http'
+require 'http/auth0/middleware'
+
+conn = Faraday.new do |f|
+  f.use HTTP::Auth0::Middleware
+end
+
+conn.post("https://example.com/graphql")
+```
+
+#### Net::HTTP Example
+
+```ruby
+require 'http/auth0'
+require 'net/http'    
+
+uri = URI("https://example.com/graphql")
+req = Net::HTTP::Get.new(uri)
+req['Authorization'] = HTTP::Auth0.token(aud: uri.to_s)
+
+res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+  http.request(req)
+end
+
+puts res.body
+```
+
+## Dependencies
+
+- [Auth0](https://auth0.com/)
+- [dry-configurable](https://github.com/dry-rb/dry-configurable)
+- [ruby-jwt](https://github.com/jwt/ruby-jwt)
+
+## Contributing
+
+1. Clone the [http-auth0 repo](https://github.com/itsmechlark/http-auth0)
+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

data/lib/http/auth0/middleware.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "http/auth0"
+
+module HTTP
+  class Auth0
+    # Request middleware for the Auth0 Authorization HTTP header
+    class Middleware < Faraday::Middleware
+      KEY = "Authorization"
+
+      # @param app [#call]
+      def initialize(app)
+        super(app)
+      end
+
+      # @param env [Faraday::Env]
+      def on_request(env)
+        return if env.request_headers[KEY]
+
+        env.request_headers[KEY] = "Bearer #{auth0_token(env)}"
+      end
+
+      private
+
+      # @param env [Faraday::Env]
+      # @return [String] a header value
+      def auth0_token(env)
+        uri = env.url.to_s
+        aud_uri = URI.parse(uri)
+        aud_uri.fragment = aud_uri.query = nil
+        Auth0.token(aud: aud_uri.to_s)
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(auth0: HTTP::Auth0::Middleware)

data/lib/http/auth0/token.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "json"
+require "jwt"
+require "net/http"
+require "openssl"
+require "uri"
+
+module HTTP
+  class Auth0
+    class ConfigurationError < StandardError; end
+
+    class Token
+      include Singleton
+
+      def token(aud:)
+        validate_configuration(key: :client_id)
+        validate_configuration(key: :client_secret)
+
+        if (cached = access_tokens[aud])
+          return cached unless expired?(token: cached)
+        end
+        request_access_token(aud: aud)
+      end
+
+      private
+
+      def access_tokens
+        @access_tokens ||= {}
+      end
+
+      def validate_configuration(key:)
+        raise ConfigurationError, "Missing #{key} in configuration" if [nil, ""].any?(config.send(key))
+      end
+
+      def expired?(token:)
+        decoded_token = JWT.decode(token, nil, false)
+        payload = decoded_token.first
+        expiration = payload["exp"]
+        current_time = Time.now.to_i
+        seconds_before_refresh = config.seconds_before_refresh
+        expiration_time = Time.at(expiration).to_i - seconds_before_refresh.to_i
+
+        current_time >= expiration_time
+      rescue StandardError => e
+        config.logger.error(e)
+        true
+      end
+
+      def request_access_token(aud:)
+        url = URI("#{issuer}/oauth/token")
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+        request = Net::HTTP::Post.new(url)
+        request["content-type"] = "application/x-www-form-urlencoded"
+
+        body = request_body(aud: aud)
+        request.body = body.map { |key, value| "#{key}=#{value}" }.join("&")
+
+        response = http.request(request)
+        body = response.read_body
+
+        case response
+        when Net::HTTPSuccess
+          auth0_response = JSON.parse(body)
+          auth0_response["access_token"].tap do |access_token|
+            access_tokens[aud] = access_token
+          end
+        else
+          config.logger.warn("#{response.message}: #{body}")
+          nil
+        end
+      end
+
+      def request_body(aud:)
+        {
+          audience: aud,
+          client_id: config.client_id,
+          client_secret: config.client_secret,
+          grant_type: "client_credentials",
+        }
+      end
+
+      def issuer
+        "https://#{config.custom_domain || config.domain}"
+      end
+
+      def config
+        ::HTTP::Auth0.config
+      end
+    end
+  end
+end

data/lib/http/auth0/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module HTTP
+  class Auth0
+    VERSION = "1.0.0"
+
+    class << self
+      def gem_version
+        Gem::Version.new(VERSION)
+      end
+    end
+  end
+end

data/lib/http/auth0.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
+require "dry/configurable"
+
+require_relative "auth0/token"
+
+module HTTP
+  class Auth0
+    extend(Dry::Configurable)
+
+    setting(:client_id, default: ENV["AUTH0_CLIENT_ID"].presence)
+    setting(:client_secret, default: ENV["AUTH0_CLIENT_SECRET"].presence)
+    setting(:custom_domain, default: ENV["AUTH0_CUSTOM_DOMAIN"].presence)
+    setting(:domain, default: ENV["AUTH0_DOMAIN"].presence)
+    setting(:logger, default: Logger.new($stdout))
+    setting(:seconds_before_refresh, default: 60)
+
+    class << self
+      def token(aud:)
+        Token.instance.token(aud: aud)
+      end
+    end
+  end
+end
+
+require_relative "auth0/version"

metadata

@@ -0,0 +1,348 @@
+--- !ruby/object:Gem::Specification
+name: http-auth0
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Chlark Sumatra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: 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: code-scanning-rubocop
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: multipart-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !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: rubocop-performance
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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: '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: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Faraday adapter for Auth0
+email:
+- clark@sumatra.com.ph
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- LICENSE.md
+- README.md
+- lib/http/auth0.rb
+- lib/http/auth0/middleware.rb
+- lib/http/auth0/token.rb
+- lib/http/auth0/version.rb
+homepage: https://github.com/itsmechlark/http-auth0
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/itsmechlark/http-auth0
+  changelog_uri: https://github.com/itsmechlark/http-auth0/releases/tag/v1.0.0
+  source_code_uri: https://github.com/itsmechlark/http-auth0/tree/v1.0.0
+  bug_tracker_uri: https://github.com/itsmechlark/http-auth0/issues
+  github_repo: https://github.com/itsmechlark/http-auth0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: Faraday adapter for Auth0
+test_files: []