wallix_rest_client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3e4e95a562ab80ce426d989ced99aa0efadf095177b1946914cbbbe7ac0ed4b
-  data.tar.gz: '0690dfc248f66ba2d9b4fbe4614dd13014ce9bff986fec5858bc65b31e678945'
+  metadata.gz: b30200d7659e0acdd244cc6128627d986b3b54f55528ba1cc5cfd50c6466cf7e
+  data.tar.gz: 6a2919742098e026a14ba1615cbfa522b72cbb85fa382bc09c9baa60ba387a32
 SHA512:
-  metadata.gz: ad7a02ad80141bee73a33240734a5d075cda37fac8744701674ab7b3168f1b2bd8b26c281221254795ee2e5b1e42b39139bd87696a0b3fd98e65192fc6adf98c
-  data.tar.gz: 92c021907083e8af6a92b86cf2492fb47baaf44260bfa9c989decfb9893d1845b3f0996d0ef361fc52ef297974a49b00102334c0c5a2348d65d6c2d49b391c7f
+  metadata.gz: 2c99e789f85d0f06efb441782c34d6303d402e2e6d53db813cbbf14c81e6468867b31260fb8fa83d72b2384dd31e330c202aeb84e8dad56d0350752a205b7e17
+  data.tar.gz: d0c8d86ef10323f4b26ecc617a7f71bf09eeb74af7769ebbd3741648f4501b93e0a4ed88b110fc13e0c329ec6f3c391642b0750851439e66b35553e187807a69

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Cyberwatch SAS
+
+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

@@ -24,7 +24,90 @@ Or install it yourself as:
 
 ## Usage
 
-Todo.
+### Prerequisites
+
+- [ ] A user account to access the API + a password or key
+- [ ] A group in which the user is
+- [ ] A group in which **every** resources you need to access are located
+- [ ] A **password checkout** authorization between the user group and the resources group
+
+### Configuration
+
+The library needs to be configured using your account's password or API key, depending on which authentication mode you choose.
+
+**Basic mode**
+
+```ruby
+require 'wallix_rest_client'
+
+WallixRestClient.setup do |config|
+  config.base_uri = 'https://wallixbastion.localdomain'
+  config.user = 'username'
+  config.secret = 'mypassword'
+  config.options = { auth: :basic, verify_ssl: false }
+end
+```
+
+**API Key mode**
+
+```ruby
+require 'wallix_rest_client'
+
+WallixRestClient.setup do |config|
+  config.base_uri = 'https://wallixbastion.localdomain'
+  config.user = 'username'
+  config.secret = 'myapisecretkey'
+  config.options = { auth: :api_key, verify_ssl: false }
+end
+```
+
+### API Requests
+
+**Get the target's approval request**
+
+```ruby
+require 'wallix_rest_client'
+
+req = WallixRestClient.get_approvals_requests_target('testaccount@domaintest')
+
+req.code # => 200
+
+req.body # => {
+         #   "approval": "not_required",
+         #   "message": "You can connect to the target without an approval request.",
+         #   "id": "",
+         #   "ticket": "disabled",
+         #   "comment": "disabled"
+         # }
+```
+
+**Get the target's credentials**
+
+```ruby
+require 'wallix_rest_client'
+
+req = WallixRestClient.get_targetpasswords_checkout('testaccount@domaintest')
+
+req.code # => 200
+
+# With password
+req.body # => {
+         #   "login": "testaccount",
+         #   "password": "testpassword",
+         #   "locked": false,
+         #   "lock_time": null
+         # }
+
+# With SSH Key
+req.body # => {
+         #   "lock_time": null,
+         #   "locked": false,
+         #   "ssh_key": "-----BEGIN RSA PRIVATE KEY---...",
+         #   "login": "testaccount",
+         #   "password": "",
+         #   "ssh_certificate": null
+         # }
+```
 
 ## Development
 

data/lib/wallix_rest_client.rb

@@ -76,8 +76,7 @@ module WallixRestClient
 
     # Run the HTTP request
     def run_request(path, resource, type, query_params = {}, post_params = {})
-      uri = URI.parse([configuration.base_uri, '/api/', path, resource.to_s,
-                       build_query_params(query_params)].join(''))
+      uri = URI::join(configuration.base_uri, '/api/', path, resource.to_s, build_query_params(query_params))
 
       http = build_http(uri)
       request = build_request(type, uri)

data/lib/wallix_rest_client/version.rb

@@ -1,3 +1,3 @@
 module WallixRestClient
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wallix_rest_client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Maxime Alay-Eddine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2018-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -109,6 +109,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console