ripple_keycloak 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c695a14343b4ad57269888035cff4e7f1cf6c358a265cc21bc730b0a3356f86
-  data.tar.gz: 467cd8d7424584d050c1ff9cbc3a2156cf71556e5b8e454994d522375666f51d
+  metadata.gz: a1110e9ee63adcb8fe9c9b21859d4b887b2041f4cb0b1890d11fb4b9e1850ba4
+  data.tar.gz: ea16bf655491f58786463fd8809b29572ed2dc8fbf11453ac287185c7e50f0dd
 SHA512:
-  metadata.gz: 1b3184c41d29d70f9b7b4ac59a2d45bdb949108ba74cc4169400dc80fe4821f1b2cbaab331584507cfac8cf7ecbd8aa3875768daf68e790894353baf1f1e2e74
-  data.tar.gz: e9a2534b9e40c6043679720b6f039a37994cb555252d74c86b5aa375269e7b6f13e4088459f095158d2a2b0e8df162c07dbf1dd7c9a83c8cf5c623ef51b48802
+  metadata.gz: 72a51cd15b79be3aa6fb54aa469d0e71a5012e38999fa7f69d96f83630a7a948c4defec527eb725ec09d7e106bce4f0a63a066e09c7002b0c6f960f18f149d96
+  data.tar.gz: 57cd5ae0d044e93e8a814af2a10fe9b3c98576bf0838dbabc672fabf7de8cba974710c882a62662d35094b8b949b2f8d29f5edd5424a696ff5c21a4939f24881

data/.github/workflows/bump-version.yml

@@ -0,0 +1,17 @@
+name: Bump gem version tag
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  tag-new-versions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+      - uses: salsify/action-detect-and-tag-new-version@v1
+        with:
+          version-command: |
+            cat lib/ripple_keycloak/version.rb

data/.github/workflows/gem-push.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.github/workflows/lint-and-test.yml

@@ -0,0 +1,34 @@
+name: Lint and test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Lint + Test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Restore cache
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run Rubocop
+      run: bundle exec rubocop
+    - name: Run rspec
+      run: bundle exec rspec

data/.rspec

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

data/.rubocop.yml

@@ -27,3 +27,16 @@ Style/SlicingWithRange:
 
 Style/Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/**
+
+Style/TrivialAccessors:
+  Exclude:
+    - lib/ripple_keycloak/base_model.rb
+
+AllCops:
+  Exclude:
+    - bin/**
+    - vendor/**/**

data/README.md

@@ -1,8 +1,8 @@
-# RippleKeycloak
+# Ripple Keycloak
 
-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.
+![Lint and test](https://github.com/hex-event-solutions/ripple_keycloak/workflows/Lint%20and%20test/badge.svg)
 
-TODO: Delete this and the text above, and describe your gem
+Slim interface focused on groups, roles and users for Keycloak's Admin REST API
 
 ## Installation
 
@@ -22,7 +22,48 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The client must be configured before usage
+
+```ruby
+RippleKeycloak::Client.configure do |c|
+  c.base_url = <keycloak_url>
+  c.realm = <keycloak_realm>
+  c.client_id = <client_id>
+  c.client_secret = <client_secret>
+end
+```
+
+The supplied client must be of 'confidential' type, and allow service account login.
+
+After configuring, use the supplied interfaces to query, create, update or delete resources in Keycloak.
+
+### Standard methods
+
+The below methods are available on `RippleKeycloak::User`, `RippleKeycloak::Group` and `RippleKeycloak::Role`.
+
+- find(id) - returns the resource with the given id
+- find_by(field:, value:) - searches the resource type for an exact match against field and value
+- search(value) - searches the resource type for a match in any field
+- all - returns all resources
+- delete(id) - deletes the resource with the given id
+
+### RippleKeycloak::User
+
+- create(payload) - posts given payload to user create
+- add_to_group(user_id, group_id) - adds given user to given group
+- remove_from_group(user_id, group_id) - removes given user from given group
+- add_role(user_id, role_name) - adds given role to user
+- remove_role(user_id, role_name) - removes given role from user
+
+### RippleKeycloak::Group
+
+- create(name:, parent: false) - creates a group with the given name, optionally under the given parent
+- add_role(group_id, role_name) - adds given role to group
+- remove_role(group_id, role_name) - removes given role from group
+
+### RippleKeycloak::Role
+
+- create(name:) - creates a role with the given name
 
 ## Development
 
@@ -32,7 +73,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/hex-event-solutions/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/hex-event-solutions/ripple_keycloak/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +82,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/hex-event-solutions/ripple_keycloak/blob/master/CODE_OF_CONDUCT.md).

data/lib/ripple_keycloak/base_model.rb

@@ -10,12 +10,12 @@ module RippleKeycloak
       end
 
       def search(value)
-        client.search(@object_type, value)
+        client.get("#{@object_type}?search=#{value}")
       end
 
       def all(first: nil, max: nil)
         url = "#{@object_type}?"
-        url += "first=#{first}" if first
+        url += "first=#{first}&" if first
         url += "max=#{max}" if max
 
         client.get(url)
@@ -26,7 +26,13 @@ module RippleKeycloak
       end
 
       def find_by(field:, value:)
-        client.find_by(@object_type, field, value)
+        results = search(value).parsed_response
+        if results.is_a? Array
+          results.each do |instance|
+            return instance if instance[field] == value
+          end
+        end
+        raise NotFoundError, "Object type: #{@object_type}, field: #{field}, value: #{value}"
       end
 
       def delete(id)
@@ -40,6 +46,6 @@ module RippleKeycloak
       end
     end
 
-    delegate :base_model, to: :class
+    delegate :object_type, to: :class
   end
 end

data/lib/ripple_keycloak/client.rb

@@ -24,10 +24,7 @@ module RippleKeycloak
           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
+        options = format_as_json(options) if json
 
         return_or_raise post("#{base_uri}/#{resource}", options)
       end
@@ -37,10 +34,7 @@ module RippleKeycloak
           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
+        options = format_as_json(options) if json
 
         return_or_raise put("#{base_uri}/#{resource}", options)
       end
@@ -59,43 +53,37 @@ module RippleKeycloak
           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
+        options = format_as_json(options) if json
 
         return_or_raise delete("#{base_uri}/#{resource}", options)
       end
 
       private
 
-      attr_accessor :configuration,
-                    :access_token,
-                    :access_token_expiry
+      attr_accessor :configuration, :access_token, :access_token_expiry
 
-      delegate :base_url,
-               :realm,
-               :client_id,
-               :client_secret,
-               to: :configuration
+      delegate :base_url, :realm, :client_id, :client_secret, to: :configuration
 
       delegate :raise_error, to: :error_handler
 
+      def format_as_json(options)
+        options = add_header(options, 'Content-Type', 'application/json')
+        options[:body] = options[:body].to_json
+        options
+      end
+
       def return_or_raise(response)
-        if [200, 201, 204].include? response.code
-          response
-        else
-          raise_error response
-        end
+        return response if [200, 201, 204].include? response.code
+
+        raise_error response
       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)
+        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
@@ -115,11 +103,9 @@ module RippleKeycloak
 
       def token
         now = Time.now
-        if access_token_expiry < now
-          auth
-        else
-          access_token
-        end
+        return auth if access_token_expiry < now
+
+        access_token
       end
 
       def add_auth_header(options)
@@ -148,19 +134,5 @@ module RippleKeycloak
     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/user.rb

@@ -13,10 +13,13 @@ module RippleKeycloak
       end
 
       def add_to_group(user_id, group_id)
-        client.put("users/#{user_id}/groups/#{group_id}", {
-          groupId: group_id,
-          userId: user_id
-        })
+        client.put(
+          "users/#{user_id}/groups/#{group_id}",
+          {
+            groupId: group_id,
+            userId: user_id
+          }
+        )
       end
 
       def remove_from_group(user_id, group_id)
@@ -33,7 +36,7 @@ module RippleKeycloak
         client.delete("users/#{user_id}/role-mappings/realm", [role])
       end
 
-      def send_email(user_id, actions, lifespan: 86400, client_id: false, redirect_uri: false)
+      def send_email(user_id, actions, lifespan: 86_400, client_id: false, redirect_uri: false)
         url = "users/#{user_id}/execute-actions-email?"
         url += "?lifespan=#{lifespan}"
         url += "&client_id=#{client_id}" if client_id

data/lib/ripple_keycloak/version.rb

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

data/ripple_keycloak.gemspec

@@ -27,4 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency('activesupport', '6.0.3.1')
   spec.add_dependency('httparty', '0.18.0')
+
+  spec.add_development_dependency('rspec', '3.9.0')
+  spec.add_development_dependency('rubocop', '0.85.1')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ripple_keycloak
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hex Event Solutions Limited
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.85.1
 description: 
 email:
 - ruby@hexes.co.uk
@@ -45,6 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/bump-version.yml"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/lint-and-test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"