ripple_keycloak 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c695a14343b4ad57269888035cff4e7f1cf6c358a265cc21bc730b0a3356f86
+  data.tar.gz: 467cd8d7424584d050c1ff9cbc3a2156cf71556e5b8e454994d522375666f51d
+SHA512:
+  metadata.gz: 1b3184c41d29d70f9b7b4ac59a2d45bdb949108ba74cc4169400dc80fe4821f1b2cbaab331584507cfac8cf7ecbd8aa3875768daf68e790894353baf1f1e2e74
+  data.tar.gz: e9a2534b9e40c6043679720b6f039a37994cb555252d74c86b5aa375269e7b6f13e4088459f095158d2a2b0e8df162c07dbf1dd7c9a83c8cf5c623ef51b48802

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ollie@nyemail.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ripple_keycloak.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ollie Nye
+
+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,44 @@
+# RippleKeycloak
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ripple_keycloak`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ripple_keycloak'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ripple_keycloak
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ripple_keycloak. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ripple_keycloak/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RippleKeycloak project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ripple_keycloak/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ripple_keycloak'
+
+# 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/ripple_keycloak.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'ripple_keycloak/version'
+require 'ripple_keycloak/client'
+require 'ripple_keycloak/base_model'
+require 'ripple_keycloak/group'
+require 'ripple_keycloak/role'
+require 'ripple_keycloak/user'
+
+module RippleKeycloak
+  class Error < StandardError; end
+  class UnauthorizedClientError < Error; end
+  class UnauthorizedError < Error; end
+  class RealmDoesNotExistError < Error; end
+  class GroupNotFoundError < Error; end
+  class RoleNotFoundError < Error; end
+  class UserNotFoundError < Error; end
+  class MissingPropertyError < Error; end
+  class NotFoundError < Error; end
+
+  class ConflictError < Error; end
+end

data/lib/ripple_keycloak/base_model.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RippleKeycloak
+  class BaseModel
+    class << self
+      delegate :get, :post, to: :client
+
+      def object_type(object_type)
+        @object_type = object_type
+      end
+
+      def search(value)
+        client.search(@object_type, value)
+      end
+
+      def all(first: nil, max: nil)
+        url = "#{@object_type}?"
+        url += "first=#{first}" if first
+        url += "max=#{max}" if max
+
+        client.get(url)
+      end
+
+      def find(id)
+        client.get("#{@object_type}/#{id}")
+      end
+
+      def find_by(field:, value:)
+        client.find_by(@object_type, field, value)
+      end
+
+      def delete(id)
+        client.delete("#{@object_type}/#{id}")
+      end
+
+      private
+
+      def client
+        RippleKeycloak::Client.new
+      end
+    end
+
+    delegate :base_model, to: :class
+  end
+end

data/lib/ripple_keycloak/client.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'active_support/core_ext/module/delegation'
+
+require 'ripple_keycloak/error_handler'
+require 'ripple_keycloak/configuration'
+
+module RippleKeycloak
+  class Client
+    include HTTParty
+    # debug_output $stdout
+
+    class << self
+      def configure
+        @configuration = Configuration.new
+        yield(configuration)
+        auth
+        'Authenticated successfully'
+      end
+
+      def post_formatted(resource, json: true, authed: true, **options)
+        if authed
+          options = add_auth_header(options)
+          resource = "admin/realms/#{realm}/" + resource
+        end
+        if json
+          options = add_header(options, 'Content-Type', 'application/json')
+          options[:body] = options[:body].to_json
+        end
+
+        return_or_raise post("#{base_uri}/#{resource}", options)
+      end
+
+      def put_formatted(resource, json: true, authed: true, **options)
+        if authed
+          options = add_auth_header(options)
+          resource = "admin/realms/#{realm}/" + resource
+        end
+        if json
+          options = add_header(options, 'Content-Type', 'application/json')
+          options[:body] = options[:body].to_json
+        end
+
+        return_or_raise put("#{base_uri}/#{resource}", options)
+      end
+
+      def get_formatted(resource, authed: true, **options)
+        if authed
+          options = add_auth_header(options)
+          resource = "admin/realms/#{realm}/" + resource
+        end
+
+        return_or_raise get("#{base_uri}/#{resource}", options)
+      end
+
+      def delete_formatted(resource, json: true, authed: true, **options)
+        if authed
+          options = add_auth_header(options)
+          resource = "admin/realms/#{realm}/" + resource
+        end
+        if json
+          options = add_header(options, 'Content-Type', 'application/json')
+          options[:body] = options[:body].to_json
+        end
+
+        return_or_raise delete("#{base_uri}/#{resource}", options)
+      end
+
+      private
+
+      attr_accessor :configuration,
+                    :access_token,
+                    :access_token_expiry
+
+      delegate :base_url,
+               :realm,
+               :client_id,
+               :client_secret,
+               to: :configuration
+
+      delegate :raise_error, to: :error_handler
+
+      def return_or_raise(response)
+        if [200, 201, 204].include? response.code
+          response
+        else
+          raise_error response
+        end
+      end
+
+      def auth
+        response = post_formatted("realms/#{realm}/protocol/openid-connect/token",
+                                  body: {
+                                    grant_type: 'client_credentials',
+                                    client_id: client_id,
+                                    client_secret: client_secret
+                                  }, json: false, authed: false)
+        update_token_fields response
+        access_token
+      end
+
+      def update_token_fields(response)
+        @access_token = response['access_token']
+        @access_token_expiry = Time.now + response['expires_in']
+      end
+
+      def base_uri
+        "#{base_url}/auth"
+      end
+
+      def error_handler
+        ErrorHandler
+      end
+
+      def token
+        now = Time.now
+        if access_token_expiry < now
+          auth
+        else
+          access_token
+        end
+      end
+
+      def add_auth_header(options)
+        add_header(options, 'Authorization', "Bearer #{token}")
+      end
+
+      def add_header(options, header, value)
+        options[:headers] ||= {}
+        options[:headers] = options[:headers].merge({ "#{header}": value })
+        options
+      end
+    end
+
+    def post(resource, body)
+      self.class.post_formatted(resource, body: body)
+    end
+
+    def put(resource, body)
+      self.class.put_formatted(resource, body: body)
+    end
+
+    def get(resource)
+      self.class.get_formatted(resource)
+    end
+
+    def delete(resource, body = {})
+      self.class.delete_formatted(resource, body: body)
+    end
+
+    def search(type, value)
+      get("#{type}?search=#{value}")
+    end
+
+    def find_by(type, field, value)
+      results = search(type, value).parsed_response
+      if results.is_a? Array
+        results.each do |instance|
+          return instance if instance[field] == value
+        end
+      end
+      raise NotFoundError, "Object type: #{type}, field: #{field}, value: #{value}"
+    end
+  end
+end

data/lib/ripple_keycloak/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RippleKeycloak
+  class Configuration
+    attr_accessor :base_url,
+                  :realm,
+                  :client_id,
+                  :client_secret
+  end
+end

data/lib/ripple_keycloak/error_handler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RippleKeycloak
+  class ErrorHandler
+    class << self
+      def error_map
+        {
+          'Realm does not exist' => RealmDoesNotExistError,
+          'unauthorized_client' => UnauthorizedClientError,
+          'HTTP 401 Unauthorized' => UnauthorizedError,
+          'Could not find role' => RoleNotFoundError,
+          'User not found' => UserNotFoundError
+        }
+      end
+
+      def raise_error(response)
+        formatted_error = {
+          code: response.code,
+          body: response.parsed_response
+        }
+
+        raise RippleKeycloak::ConflictError, formatted_error if response.code == 409
+
+        raise RippleKeycloak::Error, formatted_error unless response.key? 'error'
+
+        error_class = error_map[response['error']]
+
+        raise error_class, formatted_error
+      end
+    end
+  end
+end

data/lib/ripple_keycloak/group.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RippleKeycloak
+  class Group < BaseModel
+    object_type 'groups'
+
+    class << self
+      def create(name:, parent: false)
+        payload = { name: name }
+        path = create_path(parent)
+        response = client.post(path, payload)
+        group_id = response.headers['location'].split('/').last
+
+        group_id
+      end
+
+      def add_role(group_id, role_name)
+        role = RippleKeycloak::Role.find_by(field: 'name', value: role_name)
+        client.post("groups/#{group_id}/role-mappings/realm", [role])
+      end
+
+      def remove_role(group_id, role_name)
+        role = RippleKeycloak::Role.find_by(field: 'name', value: role_name)
+        client.delete("groups/#{group_id}/role-mappings/realm", [role])
+      end
+
+      private
+
+      def create_path(parent)
+        if parent
+          parent_group = find_by(field: 'name', value: parent)
+          raise GroupNotFoundError, parent unless parent_group
+
+          path = "groups/#{parent_group['id']}/children"
+        else
+          path = 'groups'
+        end
+        path
+      end
+    end
+  end
+end

data/lib/ripple_keycloak/role.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RippleKeycloak
+  class Role < BaseModel
+    object_type 'roles'
+
+    class << self
+      def create(name:)
+        payload = { name: name }
+        response = client.post('roles', payload)
+        role_id = response.headers['location'].split('/').last
+
+        role_id
+      end
+    end
+  end
+end

data/lib/ripple_keycloak/user.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RippleKeycloak
+  class User < BaseModel
+    object_type 'users'
+
+    class << self
+      def create(payload)
+        response = client.post('users', payload)
+        user_id = response.headers['location'].split('/').last
+
+        user_id
+      end
+
+      def add_to_group(user_id, group_id)
+        client.put("users/#{user_id}/groups/#{group_id}", {
+          groupId: group_id,
+          userId: user_id
+        })
+      end
+
+      def remove_from_group(user_id, group_id)
+        client.delete("users/#{user_id}/groups/#{group_id}")
+      end
+
+      def add_role(user_id, role_name)
+        role = RippleKeycloak::Role.find_by(field: 'name', value: role_name)
+        client.post("users/#{user_id}/role-mappings/realm", [role])
+      end
+
+      def remove_role(user_id, role_name)
+        role = RippleKeycloak::Role.find_by(field: 'name', value: role_name)
+        client.delete("users/#{user_id}/role-mappings/realm", [role])
+      end
+
+      def send_email(user_id, actions, lifespan: 86400, client_id: false, redirect_uri: false)
+        url = "users/#{user_id}/execute-actions-email?"
+        url += "?lifespan=#{lifespan}"
+        url += "&client_id=#{client_id}" if client_id
+        url += "&redirect_uri=#{redirect_uri}" if redirect_uri
+
+        client.put(url, actions)
+      end
+    end
+  end
+end

data/lib/ripple_keycloak/version.rb

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

data/ripple_keycloak.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ripple_keycloak/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ripple_keycloak'
+  spec.version       = RippleKeycloak::VERSION
+  spec.authors       = ['Hex Event Solutions Limited']
+  spec.email         = ['ruby@hexes.co.uk']
+
+  spec.summary       = "Ruby interface to Keycloak's admin API"
+  spec.homepage      = 'https://rubygems.org/gems/ripple_keycloak'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hex-event-solutions/ripple_keycloak'
+
+  # 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.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activesupport', '6.0.3.1')
+  spec.add_dependency('httparty', '0.18.0')
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ripple_keycloak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hex Event Solutions Limited
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+description: 
+email:
+- ruby@hexes.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ripple_keycloak.rb
+- lib/ripple_keycloak/base_model.rb
+- lib/ripple_keycloak/client.rb
+- lib/ripple_keycloak/configuration.rb
+- lib/ripple_keycloak/error_handler.rb
+- lib/ripple_keycloak/group.rb
+- lib/ripple_keycloak/role.rb
+- lib/ripple_keycloak/user.rb
+- lib/ripple_keycloak/version.rb
+- ripple_keycloak.gemspec
+homepage: https://rubygems.org/gems/ripple_keycloak
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/ripple_keycloak
+  source_code_uri: https://github.com/hex-event-solutions/ripple_keycloak
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby interface to Keycloak's admin API
+test_files: []