libkeycloak 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. checksums.yaml +4 -4
  2. metadata +6 -78
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '092425c0716ee45f8777708c27b2898b5a7af43edbe9c5cc194aa5998de2833d'
4
- data.tar.gz: 75c900a8efc01cab2af35a0ce53e40435ff0b1e3c8870c7a7991c48cfe36efd3
3
+ metadata.gz: 677c08c639b3df8da3ed5b16383cc0272d5de8df5a17a8c6b40c7544515d89cd
4
+ data.tar.gz: 9667f02115b454d657e132efc239c6fe523d2e2044e3ed72d835187ab11f6e00
5
5
  SHA512:
6
- metadata.gz: 73f0c5a082c94a0e51fa439d1182e20f9d8f8218374ad499c7a7b7591e66da0cd41c21fdc3a8ae6748fe7a39a05d9cdfacea6cf3ec901a2b41d2ceb2ff22f362
7
- data.tar.gz: 48917e889a59329faa173044761c206463f0196fc55e9362eefaab15b46132c1c4b6c4cdb85c27f76833b0866b61beb09d57f67725d6374bb98211647501dd75
6
+ metadata.gz: 3df998d200b56dc1dd3faefdff3f64bd36543cde9fe79dc96421341e6db33d2d81e44a85c7bcd4ccbfb18918f700f60278c52f15b6e4ed08ea3fc5cbd26edc21
7
+ data.tar.gz: 39242ec2c5078a53c7fd1b20e164ca0cbff94b8067c657226d0adf12448d278da457671b0ef211a7309cf8951b6d2f5dc18c16e4ee24b7c878fdb1bb10787970
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: libkeycloak
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonas Everaert
@@ -39,86 +39,14 @@ dependencies:
39
39
  - !ruby/object:Gem::Version
40
40
  version: '0.1'
41
41
  description: |
42
- # Keycloak C
42
+ == libkeycloak for Ruby
43
43
 
44
- A wrapper for the Keycloak API in C. Includes some bindings for different languages
44
+ This gem is a wrapper around libkeycloak (https://github.com/Jomy10/libkeycloak) to interact with the Keycloak API.
45
+ It also includes functions for verifying tokens. Examples can be found in the git repository.
45
46
 
46
- ## Usage
47
+ == Installation
47
48
 
48
- ### Installation
49
-
50
- #### C
51
-
52
- see [Building](#building).
53
-
54
- #### Ruby
55
-
56
- - Install the C library as a [dynamic library](#dynamic-library)
57
- - Include the ruby file at `bindings/ruby/keycloak.rb` in your project
58
-
59
- <!-- - OR: `gem install keycloak-api` -->
60
-
61
- ## Building
62
-
63
- You need Ruby and the colorize gem (`gem install colorize`)
64
-
65
- ### Static library
66
-
67
- ```sh
68
- ruby build.rb build static
69
- ```
70
-
71
- There is only one header to be included, located at src/keycloak.h
72
-
73
- ### Dynamic library
74
-
75
- ```sh
76
- ruby build.rb build dynamic
77
- ```
78
-
79
- The dynamc libraries are now located in the `build` folder. Copy them to a folder
80
- in `echo $LD_LIBRARY_PATH`.
81
-
82
- ## Keycloak.json
83
-
84
- The file `keycloak.json` is required by the library, you can obtain it from going to a Client in the Keycloak console
85
- and clicking "action" > "Download adapter config" and choose JSON.
86
-
87
- In settings, make sure "Client authentication" is turned on.
88
-
89
- ## Examples
90
-
91
- To run the examples, you need a keycloak.json. You can obtain it from going to a Client in the Keycloak console
92
- and clicking "action" > "Download adapter config" and choose JSON.
93
-
94
- Paste the file in the root of this repository to try out the examples.
95
-
96
- All the example code can be found in the root of this repository as `example.[lang]`.
97
-
98
- The `[user]` and `[pass]` arguments are used to log in to a user in the keycloak realm specified by the `keycloak.json`.
99
-
100
- ### C
101
-
102
- ```sh
103
- ruby build.rb test
104
- ./build/test/a.out [user] [pass]
105
- ```
106
-
107
- ### Ruby
108
-
109
- ```sh
110
- ruby build.rb build dynamic
111
- LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$(pwd)/build" ruby example.rb [user] [pass]
112
- # OR: copy the dynamic library to a path in LD_LIBRARY_PATH
113
- ```
114
-
115
- ## Questions
116
-
117
- Feel free to ask any questions regarding the library as an issue.
118
-
119
- ## License
120
-
121
- Licensed under the [MIT license](LICENSE).
49
+ The C library should be built and installed as a dynamic library first, see https://github.com/Jomy10/libkeycloak?tab=readme-ov-file#dynamic-library
122
50
  email:
123
51
  executables: []
124
52
  extensions: []