isaca 1.0.1 → 1.0.2
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.
- checksums.yaml +4 -4
- data/README.md +31 -9
- data/lib/isaca/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 97fea509339683c9463f68ff393cebab556f42f2
|
4
|
+
data.tar.gz: a647ea10cca6adac49c6cb48a2a4adb5c8e71efd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8fd1bbbf340e1dac3b8a17f0e5b821b131e9e113fdb65d33019953be4fcd47bd44c63444e6c5f741c465e3b4ebcf675965aed37604c4ca69fc6c7e72b8ddabaa
|
7
|
+
data.tar.gz: 4c7803105f8b2760a6777bfe3eb50b88c96516ea77b9d60c2a957169b3646eed2b41516eb077885701e2c7c09a5a1006f232c9fc90aeb79ec8b89da456e1ccb9
|
data/README.md
CHANGED
@@ -1,8 +1,6 @@
|
|
1
|
-
#
|
1
|
+
# ISACA
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
3
|
+
This library helps ease the integration of ISACA web services into your Ruby applications.
|
6
4
|
|
7
5
|
## Installation
|
8
6
|
|
@@ -22,14 +20,38 @@ Or install it yourself as:
|
|
22
20
|
|
23
21
|
## Usage
|
24
22
|
|
25
|
-
|
23
|
+
Refer to the full documentation on how to use this library. Consider the following authentication example:
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
# Log the user in and get back a session token
|
27
|
+
session = ISACA::Request::AuthenticateUser.get('username', 'password')
|
28
|
+
|
29
|
+
# Get user information of the current user
|
30
|
+
user = ISACA::Request::GetUserDetailsByToken.get(session.value)
|
31
|
+
|
32
|
+
# Destroy a user session
|
33
|
+
ISACA::Request::LogOut.get(session.value)
|
34
|
+
```
|
35
|
+
|
36
|
+
## Configuration
|
37
|
+
|
38
|
+
Configuration of this library is fairly easy -- you just need to use the `ISACA.configure` block. Consider the following
|
39
|
+
example:
|
26
40
|
|
27
|
-
|
41
|
+
```ruby
|
42
|
+
ISACA.configure do |config|
|
43
|
+
config.url = 'https://partnerapi.isaca.org:8443/ISACAServices/Service1.svc'
|
44
|
+
config.secret_pass = '1234567890ABCDEFGHI'
|
45
|
+
config.user_agent = 'my_application'
|
46
|
+
config.verify_ssl = false
|
47
|
+
end
|
48
|
+
```
|
28
49
|
|
29
|
-
|
50
|
+
## Rails Integration
|
30
51
|
|
31
|
-
|
52
|
+
For Ruby on Rails applications, consider the `isaca-rails` engine which utilizes this library. `ISACA::Rails` is intended
|
53
|
+
to give you a jump start on your ISACA integrated Rails applications.
|
32
54
|
|
33
55
|
## Contributing
|
34
56
|
|
35
|
-
|
57
|
+
This gem is maintained by the CSX development team at ISACA. Contact csx@isaca.org for requests or concerns.
|
data/lib/isaca/version.rb
CHANGED