isaca 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 268dab3df3c97c1c62f49e26c3e667429acb7017
-  data.tar.gz: 916311a0bc1f19b868bede5ea267f2310c9a412f
+  metadata.gz: 97fea509339683c9463f68ff393cebab556f42f2
+  data.tar.gz: a647ea10cca6adac49c6cb48a2a4adb5c8e71efd
 SHA512:
-  metadata.gz: 4340024fce029cafe8593391db2be6eb65a8190f5d9de7a2e310dc55220dcc3c8c1873239629831ffb164d608640e51732d0f84c2a4bc6151dec4a997a218012
-  data.tar.gz: de6b0cde98d07991a7f8fce17706c04c1eafb48e161eead69f6449d408a8d77beab387ab39386fb493ec58fecee27e1eed3e36342b9dc879e70676a7e38fd0fc
+  metadata.gz: 8fd1bbbf340e1dac3b8a17f0e5b821b131e9e113fdb65d33019953be4fcd47bd44c63444e6c5f741c465e3b4ebcf675965aed37604c4ca69fc6c7e72b8ddabaa
+  data.tar.gz: 4c7803105f8b2760a6777bfe3eb50b88c96516ea77b9d60c2a957169b3646eed2b41516eb077885701e2c7c09a5a1006f232c9fc90aeb79ec8b89da456e1ccb9

data/README.md

@@ -1,8 +1,6 @@
-# Isaca
+# ISACA
 
-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/isaca`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This library helps ease the integration of ISACA web services into your Ruby applications.
 
 ## Installation
 
@@ -22,14 +20,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Refer to the full documentation on how to use this library. Consider the following authentication example:
+
+```ruby
+# Log the user in and get back a session token
+session = ISACA::Request::AuthenticateUser.get('username', 'password')
+
+# Get user information of the current user 
+user = ISACA::Request::GetUserDetailsByToken.get(session.value)
+
+# Destroy a user session
+ISACA::Request::LogOut.get(session.value) 
+```
+
+## Configuration
+
+Configuration of this library is fairly easy -- you just need to use the `ISACA.configure` block. Consider the following
+example:
 
-## Development
+```ruby
+ISACA.configure do |config|
+  config.url = 'https://partnerapi.isaca.org:8443/ISACAServices/Service1.svc'
+  config.secret_pass = '1234567890ABCDEFGHI'
+  config.user_agent = 'my_application'
+  config.verify_ssl = false
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Rails Integration
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For Ruby on Rails applications, consider the `isaca-rails` engine which utilizes this library. `ISACA::Rails` is intended
+to give you a jump start on your ISACA integrated Rails applications.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/isaca.
+This gem is maintained by the CSX development team at ISACA. Contact csx@isaca.org for requests or concerns.

data/lib/isaca/version.rb

@@ -1,3 +1,3 @@
 module ISACA
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isaca
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Matt Orahood