keycloak-connect-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 180d60b0cea5a62dc228132572cc72eceb89002f0a232c017b38368730b66983
+  data.tar.gz: f3fa190ce0dae9fa402cc00f9e4630411c83fe0706691f081b20179feaa68c2a
+SHA512:
+  metadata.gz: 8bd82583a660c35b2eecb5a973d02a04d0f3900ba05925c8394cbe78c2d75bd45838a1991eb319cfcd038523e8e2474c45197ef3a86149cb2ac42087ea9f0ac9
+  data.tar.gz: 3534faedd7a25d73d5f44ce878b16f3556cda531a1e3c9727445f89278004b70732718a0a5fe81447703a8c139818fbb391d066a674c7d95fda25efaf6da7048

data/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  dockerfile:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build Dockerfile
+        run: docker build -t keycloak_connect_ruby_specs .
+
+      - name: Run tests inside Docker container
+        run: docker run -v $(pwd):/app/ -i keycloak_connect_ruby_specs
+
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.7, 3.0]
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests with Ruby ${{ matrix.ruby-version }}
+        run: bundle exec rake

data/.github/workflows/publish_to_rubygems.yml

@@ -0,0 +1,30 @@
+name: Publish to Rubygems
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+
+      - name: Install dependencies
+        run: bundle install
+
+      - 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_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+/Gemfile.lock
+*.gem
+*.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,54 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - spec/*
+    - keycloak-connect-ruby.gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/OpenStructUse:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Lint/ScriptPermission:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:3.0.0-alpine
+RUN apk update && apk add git build-base
+WORKDIR /app/
+COPY . .
+RUN bundle install
+CMD bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# Keycloak connect ruby
+
+```ruby
+require 'logger'
+
+KeycloakConnectRuby.configure do |c|
+  c.url = 'http://keycloak_server:8080'
+  c.realm = 'my-company'
+  c.client_id = 'my-sinatra-app'
+  c.client_secret = 'dsfgfdgfdgfd'
+  c.logger = Logger.new(STDOUT) # Or Rails.logger
+  c.proxy = nil
+end
+
+class MyApiController < ApplicationController
+  before_action :keycloak_authenticate_and_check_role!
+
+  def current_user
+    KeycloakConnectRuby::User.from_token(keycloak_token)
+  end
+
+  private
+
+  def keycloak_token
+    KeycloakConnectRuby::Token.validate_and_decode(bearer_token)
+  end
+
+  def bearer_token
+    request.authorization&.to_s&.gsub(/^Bearer /, "")
+  end
+
+  def keycloak_authenticate_and_check_role!
+    unless current_user.has_role?('my-role-name')
+      render json: { error: 'your message here' }, status: :unauthorized
+    end
+  rescue KeycloakConnectRuby::Errors::Token::ExpiredError => e
+    # ...
+  rescue KeycloakConnectRuby::Errors::Token::NoProvidedError => e
+    # ...
+  rescue KeycloakConnectRuby::Errors::Token::InvalidFormatError => e
+    # ...
+  end
+
+  def generate_keycloak_token_for_api_calls
+    # Client Credentials Grant flow
+    KeycloakConnectRuby::Token.generate_from_client_credentials
+
+    # Resource Owner Password Credentials flow (or Direct Grant flow)
+    KeycloakConnectRuby::Token.generate_from_password_credentials('username here', 'password here')
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'keycloak-connect-ruby'
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle install

data/keycloak-connect-ruby.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/keycloak-connect-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name                        = 'keycloak-connect-ruby'
+  spec.version                     = KeycloakConnectRuby::VERSION
+  spec.authors                     = ['Pedro Furtado']
+  spec.email                       = ['pedro.felipe.azevedo.furtado@gmail.com']
+  spec.summary                     = 'Ruby gem for integration with Keycloak API'
+  spec.description                 = 'Ruby gem for integration with Keycloak API'
+  spec.homepage                    = 'https://github.com/pedrofurtado/keycloak-connect-ruby'
+  spec.license                     = 'MIT'
+  spec.required_ruby_version       = Gem::Requirement.new('>= 2.0.0')
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.files                       = Dir.chdir(File.expand_path('..', __FILE__)) { `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } }
+  spec.bindir                      = 'exe'
+  spec.executables                 = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths               = ['lib']
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'codecov'
+end

data/lib/keycloak-connect-ruby/configuration.rb

@@ -0,0 +1,43 @@
+require 'ostruct'
+
+module KeycloakConnectRuby
+  CONFIG_OPTIONS = [
+    'url',
+    'realm',
+    'client_id',
+    'client_secret',
+    'logger',
+    'proxy'
+  ]
+
+  def self.configure
+    options = OpenStruct.new
+    yield options
+    validate_options(options)
+    @configuration ||= options
+  end
+
+  def self.config
+    @configuration
+  end
+
+  def self.logger
+    config.logger
+  end
+
+  def self.validate_options(options)
+    keys = options.each_pair.to_a.map { |p| p[0].to_s }
+
+    keys.each do |key|
+      unless CONFIG_OPTIONS.include?(key)
+        raise KeycloakConnectRuby::Errors::Configuration::UnknownOptionError, "Unknown option: #{key}. The config options are: #{CONFIG_OPTIONS.join(', ')}"
+      end
+    end
+
+    missing_options = CONFIG_OPTIONS - keys
+
+    if missing_options.any?
+      raise KeycloakConnectRuby::Errors::Configuration::MissingOptionsError, "Missing options: #{missing_options.join(', ')}. The config options are: #{CONFIG_OPTIONS.join(', ')}"
+    end
+  end
+end

data/lib/keycloak-connect-ruby/errors.rb

@@ -0,0 +1,16 @@
+module KeycloakConnectRuby
+  module Errors
+    module Configuration
+      class Error < StandardError; end
+      class UnknownOptionError < Error; end
+      class MissingOptionsError < Error; end
+    end
+
+    module Token
+      class Error < StandardError; end
+      class ExpiredError < Error; end
+      class NoProvidedError < Error; end
+      class InvalidFormatError < Error; end
+    end
+  end
+end

data/lib/keycloak-connect-ruby/token.rb

@@ -0,0 +1,22 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module KeycloakConnectRuby
+  class Token
+    def self.generate_from_client_credentials
+      # colocar logger e proxy aqui
+      uri = URI("#{KeycloakConnectRuby.config.url}/realms/#{KeycloakConnectRuby.config.realm}/protocol/openid-connect/token")
+
+      params = {
+        'client_id' => KeycloakConnectRuby.config.client_id,
+        'client_secret' => KeycloakConnectRuby.config.client_secret,
+        'grant_type' => 'client_credentials'
+      }
+
+      response = Net::HTTP.post_form(uri, params)
+      tokens = JSON.parse(response.body)
+      tokens['access_token']
+    end
+  end
+end

data/lib/keycloak-connect-ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KeycloakConnectRuby
+  VERSION = '1.0.0'
+end

data/lib/keycloak-connect-ruby.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'keycloak-connect-ruby/version'
+require_relative 'keycloak-connect-ruby/errors'
+require_relative 'keycloak-connect-ruby/configuration'
+require_relative 'keycloak-connect-ruby/token'
+
+module KeycloakConnectRuby; end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: keycloak-connect-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pedro Furtado
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: 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: webmock
+  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
+  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: codecov
+  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'
+description: Ruby gem for integration with Keycloak API
+email:
+- pedro.felipe.azevedo.furtado@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish_to_rubygems.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keycloak-connect-ruby.gemspec
+- lib/keycloak-connect-ruby.rb
+- lib/keycloak-connect-ruby/configuration.rb
+- lib/keycloak-connect-ruby/errors.rb
+- lib/keycloak-connect-ruby/token.rb
+- lib/keycloak-connect-ruby/version.rb
+homepage: https://github.com/pedrofurtado/keycloak-connect-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pedrofurtado/keycloak-connect-ruby
+  source_code_uri: https://github.com/pedrofurtado/keycloak-connect-ruby
+  changelog_uri: https://github.com/pedrofurtado/keycloak-connect-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Ruby gem for integration with Keycloak API
+test_files: []