keycloak_oauth 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a3dfc84a2766877741594fae7d8e8ca52ad93851df6fc080d12021db85a597b
-  data.tar.gz: 37b4ec746be19b275d235d2e516c7c430d93d06679e2ec3595efb16dfa1cf796
+  metadata.gz: e6275c7d379287488ef1df79cde709790cbe5858bd34744471bda26287fe8f34
+  data.tar.gz: 354c76209bae9a13b6cb356b044265b3460c4c83d913b225aad814990aa9e080
 SHA512:
-  metadata.gz: e0e9a333fde254ba6dc36d6ca25b2394bb1421ec179433426b7c2e6c77b75c69c32a5e02533b7aa72c8f00a06b127518c8ceb97a68e9674a8a1d8bc55c0ebcec
-  data.tar.gz: 6de9107265fc738a8e95f9996a2a80e13e15b26377bac5712fccde24ee49b930cb0ebec85d253d6ca0fba4c77ddf244b50ae07e6cc20cb4f06b5b654ddaf2fa5
+  metadata.gz: a4aef68f5760de30b1efdd98a5df1b57d1bfeaa79c4d09d1832002a65fac4dcd65910bd4bcac6af2b82dabb718991ae0797d8e08def30f4ed2400e3fc9ebb917
+  data.tar.gz: 1f0b961b0e5704a3b1fe3f1f838db547148671ba190e3dd3e8ad2a767678feb23219d7c20f6994eb70cda64987264b8d4028ce4ef66c843aadc3d828633c4569

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    keycloak_oauth (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  keycloak_oauth!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -22,7 +22,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Using `keycloak_oauth` in a Ruby on Rails app
+
+The configuration must be defined in the app by initialising the relevant attributes within a configuration block. For example, you could add an initializer script called `keycloak_oauth.rb` holding the following code:
+
+```ruby
+KeycloakOauth.configure do |config|
+  config.auth_url = 'TBA' # (you could reference a Rails credential here for example)
+  config.realm = 'TBA'
+  config.client_id = 'TBA'
+  config.client_secret = 'TBA'
+end
+```
+
+This then allows you to access the `KeycloakOauth` APIs:
+`KeycloakOauth.connection.authorization_endpoint`
 
 ## Development
 

data/lib/keycloak_oauth.rb

@@ -1,6 +1,22 @@
-require "keycloak_oauth/version"
+require 'keycloak_oauth/version'
+require 'keycloak_oauth/configuration'
+require 'keycloak_oauth/connection'
 
 module KeycloakOauth
-  class Error < StandardError; end
-  # Your code goes here...
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.configuration
+    Configuration.instance
+  end
+
+  def self.connection
+    @connection ||= KeycloakOauth::Connection.new(
+      auth_url: configuration.auth_url,
+      realm: configuration.realm,
+      client_id: configuration.client_id,
+      client_secret: configuration.client_secret
+    )
+  end
 end

data/lib/keycloak_oauth/configuration.rb

@@ -0,0 +1,9 @@
+require 'singleton'
+
+module KeycloakOauth
+  class Configuration
+    include Singleton
+
+    attr_accessor :auth_url, :realm, :client_id, :client_secret
+  end
+end

data/lib/keycloak_oauth/connection.rb

@@ -0,0 +1,19 @@
+module KeycloakOauth
+  class Connection
+    attr_reader :auth_url, :realm, :client_id, :client_secret
+
+    DEFAULT_RESPONSE_TYPE = 'code'.freeze
+
+    def initialize(auth_url:, realm:, client_id:, client_secret:)
+      @auth_url = auth_url
+      @realm = realm
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    def authorization_endpoint(options: {})
+      endpoint = "#{auth_url}/realms/#{realm}/protocol/openid-connect/auth?client_id=#{client_id}"
+      endpoint += "&response_type=#{options[:response_type] || DEFAULT_RESPONSE_TYPE}"
+    end
+  end
+end

data/lib/keycloak_oauth/version.rb

@@ -1,3 +1,3 @@
 module KeycloakOauth
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak_oauth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - simplificator
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -21,6 +21,7 @@ files:
 - ".rspec"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -28,6 +29,8 @@ files:
 - bin/setup
 - keycloak_oauth.gemspec
 - lib/keycloak_oauth.rb
+- lib/keycloak_oauth/configuration.rb
+- lib/keycloak_oauth/connection.rb
 - lib/keycloak_oauth/version.rb
 homepage: https://rubygems.org/gems/keycloak_oauth
 licenses: