isaca 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97fea509339683c9463f68ff393cebab556f42f2
-  data.tar.gz: a647ea10cca6adac49c6cb48a2a4adb5c8e71efd
+  metadata.gz: 5731ab5c9f6520fdd6f707e6494742a012ca5cb9
+  data.tar.gz: 007ca4c7926f16168ce0c722e34f03e27766de90
 SHA512:
-  metadata.gz: 8fd1bbbf340e1dac3b8a17f0e5b821b131e9e113fdb65d33019953be4fcd47bd44c63444e6c5f741c465e3b4ebcf675965aed37604c4ca69fc6c7e72b8ddabaa
-  data.tar.gz: 4c7803105f8b2760a6777bfe3eb50b88c96516ea77b9d60c2a957169b3646eed2b41516eb077885701e2c7c09a5a1006f232c9fc90aeb79ec8b89da456e1ccb9
+  metadata.gz: baad6f6779e27c7452349d938023ae012a7b8015c62584866c824f42250cb81e0e45cf35f952d3ae07dbfc85e852080acf8ccd90b923cc32f076258c2a9fa424
+  data.tar.gz: e5a0df3b4085533b375d268cee2f8d04e99dc00fe3150a933ccfc9addcfc58c107580c70bc34c52e7e15bd2411c7e458265bb830b7b4302b4a606bb0f9e8316b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    isaca (1.0.1)
+    isaca (1.0.2)
       faraday (~> 0.14.0)
 
 GEM

data/README.md

@@ -24,22 +24,22 @@ Refer to the full documentation on how to use this library. Consider the followi
 
 ```ruby
 # Log the user in and get back a session token
-session = ISACA::Request::AuthenticateUser.get('username', 'password')
+session = Isaca::Request::AuthenticateUser.get('username', 'password')
 
 # Get user information of the current user 
-user = ISACA::Request::GetUserDetailsByToken.get(session.value)
+user = Isaca::Request::GetUserDetailsByToken.get(session.value)
 
 # Destroy a user session
-ISACA::Request::LogOut.get(session.value) 
+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
+Configuration of this library is fairly easy -- you just need to use the `Isaca.configure` block. Consider the following
 example:
 
 ```ruby
-ISACA.configure do |config|
+Isaca.configure do |config|
   config.url = 'https://partnerapi.isaca.org:8443/ISACAServices/Service1.svc'
   config.secret_pass = '1234567890ABCDEFGHI'
   config.user_agent = 'my_application'
@@ -49,7 +49,7 @@ end
 
 ## Rails Integration
 
-For Ruby on Rails applications, consider the `isaca-rails` engine which utilizes this library. `ISACA::Rails` is intended
+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

data/isaca.gemspec

@@ -5,7 +5,7 @@ require "isaca/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "isaca"
-  spec.version       = ISACA::VERSION
+  spec.version       = Isaca::VERSION
   spec.authors       = ["Matt Orahood"]
   spec.email         = ["morahood@gmail.com"]
 

data/lib/isaca/attribute_error.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   class AttributeError < ServiceError
     def initialize(attribute, klass, hash)
       super("Missing required attribute #{attribute.to_s} for #{klass}. Hash keys: #{hash.keys}")

data/lib/isaca/configuration_error.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   class ConfigurationError < StandardError
   end
 end

data/lib/isaca/connection_error.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   class ConnectionError < ServiceError
   end
 end

data/lib/isaca/helpers.rb

@@ -1,7 +1,7 @@
 require 'date'
 require 'json'
 
-module ISACA
+module Isaca
   # A series of helper methods for parsing the way ISACA sends some data.
   module Helpers
     # ISACA seems to use the default format to pass datetimes. This method exists so you don't have to remember

data/lib/isaca/models/authenticate_user.rb

@@ -1,6 +1,6 @@
-module ISACA
+module Isaca
   module Model
-    # Class that is used as an object representation of the response from {ISACA::Request::AuthenticateUser}.
+    # Class that is used as an object representation of the response from {Isaca::Request::AuthenticateUser}.
     class AuthenticateUser
       attr_reader :error
       # @!attribute error

data/lib/isaca/models/countries.rb

@@ -1,6 +1,6 @@
-module ISACA
+module Isaca
   module Model
-    # Class that is used as an object representation of the response from {ISACA::Request::Countries} and {ISACA::Request::ExplicitCountries}.
+    # Class that is used as an object representation of the response from {Isaca::Request::Countries} and {Isaca::Request::ExplicitCountries}.
     class Countries
       attr_reader :countries
       # @!attribute countries

data/lib/isaca/models/get_user_by_id.rb

@@ -1,6 +1,6 @@
-module ISACA
+module Isaca
   module Model
-    # Class is used as an object representation of the response from {ISACA::Request::GetUserByID}.
+    # Class is used as an object representation of the response from {Isaca::Request::GetUserByID}.
     class GetUserByID
       attr_reader :active_member
       # @!attribute active_member
@@ -24,9 +24,9 @@ module ISACA
       # @option params [String] :MemberType
       # @option params [String] :iMISID
       def initialize(params)
-        @active_member = ISACA::Helpers.parse_boolean(params[:ActiveMember])
-        @expiration_date = ISACA::Helpers.strptime(params[:ExpirationDate])
-        @member_type = ISACA::Helpers.normalize_member_type(params[:MemberType])
+        @active_member = Isaca::Helpers.parse_boolean(params[:ActiveMember])
+        @expiration_date = Isaca::Helpers.strptime(params[:ExpirationDate])
+        @member_type = Isaca::Helpers.normalize_member_type(params[:MemberType])
 
         if params[:iMISID].to_s.strip.empty?
           raise ServiceError.new('User with given IMIS ID not found')

data/lib/isaca/models/get_user_details_by_token.rb

@@ -1,7 +1,7 @@
 # An object representation of the GetUserDetailsByToken endpoint
-module ISACA
+module Isaca
   module Model
-    # Class is used as an object representation of the response from {ISACA::Request::GetUserDetailsByToken}.
+    # Class is used as an object representation of the response from {Isaca::Request::GetUserDetailsByToken}.
     class GetUserDetailsByToken
       attr_reader :imis_id
       # @!attribute imis_id
@@ -50,7 +50,7 @@ module ISACA
       # @option params [String] :PRIVACY
       # @option params [String] :MARKETING
       #
-      # @raise [ISACA::ServiceError] Raises error if IMIS ID is not present.
+      # @raise [Isaca::ServiceError] Raises error if IMIS ID is not present.
       def initialize(params)
         if params[:ID].to_s.strip.empty?
           raise ServiceError.new('User with given IMIS ID not found')

data/lib/isaca/partner_key_error.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   class PartnerKeyError < ServiceError
   end
 end

data/lib/isaca/requests/authenticate_user.rb

@@ -1,16 +1,16 @@
-module ISACA
+module Isaca
   module Request
     # Class used to create user sessions.
     class AuthenticateUser
       # Method used to generate a session token.
       #
-      # @raise [ISACA::SessionError] Raised if the returned session is invalid.
+      # @raise [Isaca::SessionError] Raised if the returned session is invalid.
       #
-      # @return [ISACA::Model::AuthenticateUser] An object representation of the response.
+      # @return [Isaca::Model::AuthenticateUser] An object representation of the response.
       def self.get(username, password)
         response = self.send_request(username, password)
 
-        model = ISACA::Model::AuthenticateUser.new(JSON.parse(response.body, {symbolize_names: true}))
+        model = Isaca::Model::AuthenticateUser.new(JSON.parse(response.body, {symbolize_names: true}))
         raise SessionError.new(model.value) unless model.is_valid?
 
         model
@@ -24,7 +24,7 @@ module ISACA
       #
       # @return [Faraday::Response]
       def self.send_request(username, password)
-        ISACA::Request.get do |request|
+        Isaca::Request.get do |request|
           request.path = request.path + '/AuthenticateUser'
           request.params['username'] = username
           request.params['password'] = password

data/lib/isaca/requests/countries.rb

@@ -1,13 +1,13 @@
-module ISACA
+module Isaca
   module Request
     # Class used to fetch countries recognized by ISACA.
     module Countries
       # Method used to fetch all countries.
       #
-      # @return [ISACA::Model::Countries] An object representation of the response.
+      # @return [Isaca::Model::Countries] An object representation of the response.
       def self.get
         response = self.send_request
-        ISACA::Model::Countries.new(JSON.parse(response.body, symbolize_names: true))
+        Isaca::Model::Countries.new(JSON.parse(response.body, symbolize_names: true))
       end
 
       private
@@ -16,8 +16,8 @@ module ISACA
       #
       # @return [Faraday::Response]
       def self.send_request
-        ISACA::Request.get do |request|
-          uri = URI(ISACA.configuration.url)
+        Isaca::Request.get do |request|
+          uri = URI(Isaca.configuration.url)
           request.path = "#{uri.scheme}://#{uri.hostname}:#{uri.port}/isacaservices/countries.json"
         end
       end

data/lib/isaca/requests/explicit_countries.rb

@@ -1,14 +1,14 @@
-module ISACA
+module Isaca
   module Request
     # Class used to fetch the explicit countries recognized by ISACA. Explicit countries are countries that require
     # consent for marketing.
     module ExplicitCountries
       # Method used to fetch all of the ExplicitCountries.
       #
-      # @return [ISACA::Model::Countries] An object representation of the response.
+      # @return [Isaca::Model::Countries] An object representation of the response.
       def self.get
         response = self.send_request
-        ISACA::Model::Countries.new(JSON.parse(response.body, symbolize_names: true))
+        Isaca::Model::Countries.new(JSON.parse(response.body, symbolize_names: true))
       end
 
       private
@@ -17,8 +17,8 @@ module ISACA
       #
       # @return [Faraday::Response]
       def self.send_request
-        ISACA::Request.get do |request|
-          uri = URI(ISACA.configuration.url)
+        Isaca::Request.get do |request|
+          uri = URI(Isaca.configuration.url)
           request.path = "#{uri.scheme}://#{uri.hostname}:#{uri.port}/isacaservices/explicitcountries.json"
         end
       end

data/lib/isaca/requests/get_user_by_id.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   module Request
     # Class used to fetch an ISACA user by their IMIS ID.
     module GetUserByID
@@ -6,10 +6,10 @@ module ISACA
       #
       # @param [String] id The IMIS ID of the requested user.
       #
-      # @return [ISACA::Model::GetUserByID] An object representation of the response.
+      # @return [Isaca::Model::GetUserByID] An object representation of the response.
       def self.get(id)
         response = self.send_request(id)
-        ISACA::Model::GetUserByID.new(JSON.parse(response.body, symbolize_names: true))
+        Isaca::Model::GetUserByID.new(JSON.parse(response.body, symbolize_names: true))
       end
 
       private
@@ -20,7 +20,7 @@ module ISACA
       #
       # @return [Faraday::Response]
       def self.send_request(id)
-        ISACA::Request.get do |request|
+        Isaca::Request.get do |request|
           request.path = request.path + '/GetUserByID'
           request.params['ID'] = id
         end

data/lib/isaca/requests/get_user_details_by_token.rb

@@ -1,18 +1,18 @@
-module ISACA
+module Isaca
   module Request
     class GetUserDetailsByToken
       # Method used to get user information by token
       #
       # @param token [String] The user's session token
       #
-      # @raise [ISACA::AttributeError] Raised if the returned IMIS ID is nil or the ID key is missing
+      # @raise [Isaca::AttributeError] Raised if the returned IMIS ID is nil or the ID key is missing
       #
-      # @return [ISACA::Model::GetUserDetailsByToken] An object representation of the response
+      # @return [Isaca::Model::GetUserDetailsByToken] An object representation of the response
       def self.get(token)
         response = self.send_request(token)
 
         data = JSON.parse(JSON.parse(response.body, quirks_mode: true), {symbolize_names: true})
-        ISACA::Model::GetUserDetailsByToken.new(data)
+        Isaca::Model::GetUserDetailsByToken.new(data)
       end
 
       private
@@ -22,7 +22,7 @@ module ISACA
       #
       # @return [Faraday::Response]
       def self.send_request(token)
-        ISACA::Request.get do |request|
+        Isaca::Request.get do |request|
           request.path = request.path + '/GetUserDetailsByToken'
           request.params['token'] = token
         end

data/lib/isaca/requests/log_out.rb

@@ -1,11 +1,11 @@
-module ISACA
+module Isaca
   module Request
     module LogOut
       # Method used to destroy a user session
       #
       # @param token [String] Session token to be destroyed
       #
-      # @raise [ISACA::ServiceError] An error is raised if this ever fails. See [ISACA::Request]
+      # @raise [Isaca::ServiceError] An error is raised if this ever fails. See [Isaca::Request]
       #
       # @return [Faraday::Response] Returns a response object
       def self.get(token)
@@ -20,7 +20,7 @@ module ISACA
       #
       # @return [Faraday::Response] Returns a response object
       def self.send_request(token)
-        ISACA::Request.get do |request|
+        Isaca::Request.get do |request|
           request.path = request.path + '/LogOut'
           request.params['token'] = token
         end

data/lib/isaca/requests/report_consent.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   module Request
     module ReportConsent
       # Method used to report marketing consent and acceptance of the privacy policy. ISACA assumes that when you
@@ -28,7 +28,7 @@ module ISACA
       #
       # @return [Faraday::Response] Returns a response object
       def self.send_request(imis_id, options={})
-        ISACA::Request.get do |request|
+        Isaca::Request.get do |request|
           request.path = request.path + '/ReportConsent'
           request.params['MarketingConsent'] = options[:marketing]
           request.params['iMISID'] = imis_id

data/lib/isaca/requests/request.rb

@@ -1,24 +1,24 @@
 require 'faraday'
 
-module ISACA
+module Isaca
   module Request
     # Generic GET request used to build REST calls
     #
-    # @raise [ISACA::ServiceError] Raised because server returned a 400 response code. Bad request.
-    # @raise [ISACA::PartnerKey] The partner has provided an invalid API Key.
-    # @raise [ISACA::ServiceError] Raised because the server returned a 500 response code. Server error.
+    # @raise [Isaca::ServiceError] Raised because server returned a 400 response code. Bad request.
+    # @raise [Isaca::PartnerKey] The partner has provided an invalid API Key.
+    # @raise [Isaca::ServiceError] Raised because the server returned a 500 response code. Server error.
     #
     # @return [Faraday::Response] Returns a Faraday Response object
     def self.get # :yields: [Faraday::Request] Yields a request object.
-      conn = Faraday.new(url: ISACA.configuration.url)
-      conn.ssl.verify_mode = OpenSSL::SSL::VERIFY_NONE unless ISACA.configuration.verify_ssl
+      conn = Faraday.new(url: Isaca.configuration.url)
+      conn.ssl.verify_mode = OpenSSL::SSL::VERIFY_NONE unless Isaca.configuration.verify_ssl
 
       response = conn.get do |request|
         set_default_request_options(request)
         yield(request) if block_given?
       end
 
-      ISACA.logger.debug("\n" + response.inspect + "\n") if ISACA.configuration.debug
+      Isaca.logger.debug("\n" + response.inspect + "\n") if Isaca.configuration.debug
       response.success? ? response : raise_response_error(response)
     end
 
@@ -26,7 +26,7 @@ module ISACA
 
     # Testing Request#get is difficult so this method was created for easier testing and stubbing
     #
-    # @raise [ISACA::ServiceError] Raises a type of service error depending on status code
+    # @raise [Isaca::ServiceError] Raises a type of service error depending on status code
     #
     # @param response [Faraday::Response] Accepts a response object
     def self.raise_response_error(response)
@@ -48,11 +48,11 @@ module ISACA
     #
     # @param request [Faraday::Request] The request to which the headers are applied
     def self.set_default_request_options(request)
-      uri = URI(ISACA.configuration.url)
+      uri = URI(Isaca.configuration.url)
       request.path = uri.path
       request.headers['Content-Type'] = 'application/json'
-      request.headers['User-Agent'] = ISACA.configuration.user_agent
-      request.params['secPass'] = ISACA.configuration.secret_pass
+      request.headers['User-Agent'] = Isaca.configuration.user_agent
+      request.params['secPass'] = Isaca.configuration.secret_pass
     end
   end
 end

data/lib/isaca/service_error.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   class ServiceError < StandardError
   end
 end

data/lib/isaca/session_error.rb

@@ -1,4 +1,4 @@
-module ISACA
+module Isaca
   class SessionError < ServiceError
   end
 end

data/lib/isaca/version.rb

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

data/lib/isaca.rb

@@ -31,11 +31,11 @@ require 'openssl'
 require 'logger'
 
 # Library intended to help ease the implementation of ISACA web services.
-module ISACA
+module Isaca
   class << self
     attr_accessor :configuration
     # @!attribute configuration
-    #   @return [ISACA::Configuration] Object used to configure the library.
+    #   @return [Isaca::Configuration] Object used to configure the library.
 
     attr_accessor :logger
     # @!attribute logger
@@ -43,14 +43,14 @@ module ISACA
 
     # Method used to fetch the configuration object.
     #
-    # @return [ISACA::Configuration]
+    # @return [Isaca::Configuration]
     def configuration
       @configuration ||= Configuration.new
     end
 
     # Method used to reset the ISACA configuration. Primarily used for testing.
     #
-    # @return [ISACA::Configuration]
+    # @return [Isaca::Configuration]
     def reset
       @configuration = Configuration.new
     end
@@ -69,10 +69,10 @@ module ISACA
 
   # Configuration block used to configure the library.
   #
-  # @yield [ISACA::Configuration]
+  # @yield [Isaca::Configuration]
   #
   # @example An example configuration
-  #     ISACA.configure do |config|
+  #     Isaca.configure do |config|
   #       config.url = 'https://partnerapi.isaca.org:8443/ISACAServices/Service1.svc'
   #       config.secret_pass = '1234567890ABCDEFGHI'
   #       config.user_agent = 'my_application'
@@ -117,7 +117,7 @@ module ISACA
 
     # Returns the secret_pass attribute value
     #
-    # @raise [ISACA::ConfigurationError] Raises if secret pass was not configured.
+    # @raise [Isaca::ConfigurationError] Raises if secret pass was not configured.
     #
     # @return [String]
     def secret_pass
@@ -125,7 +125,7 @@ module ISACA
         @secret_pass
       else
         msg = 'Missing SecretPass configuration. The ISACA Partners API requires an assigned SecretPass.'
-        msg << ' Example: ISACA.configure {|config| config.secret_pass = "MyPass"}'
+        msg << ' Example: Isaca.configure {|config| config.secret_pass = "MyPass"}'
 
         raise ConfigurationError.new(msg)
       end
@@ -133,7 +133,7 @@ module ISACA
 
     # Returns the url attribute value
     #
-    # @raise [ISACA::ConfigurationError] Raises if url was not configured.
+    # @raise [Isaca::ConfigurationError] Raises if url was not configured.
     #
     # @return [String]
     def url
@@ -141,7 +141,7 @@ module ISACA
         @url
       else
         msg = 'Missing URL configuration. The ISACA Partners API requires an endpoint URL.'
-        msg << ' Example: ISACA.configure {|config| config.url = "https://partnerapi.isaca.org:8443/ISACAServices/Service1.svc"}'
+        msg << ' Example: Isaca.configure {|config| config.url = "https://partnerapi.isaca.org:8443/ISACAServices/Service1.svc"}'
 
         raise ConfigurationError.new(msg)
       end
@@ -149,7 +149,7 @@ module ISACA
 
     # Returns the user_agent attribute value
     #
-    # @raise [ISACA::ConfigurationError] Raises if user agent was not configured.
+    # @raise [Isaca::ConfigurationError] Raises if user agent was not configured.
     #
     # @return [String]
     def user_agent
@@ -157,7 +157,7 @@ module ISACA
         @user_agent
       else
         msg = 'Missing User-Agent configuration. The ISACA Partners API requires a predefined User-Agent.'
-        msg << ' Example: ISACA.configure {|config| config.user_agent = "MyApplication"}'
+        msg << ' Example: Isaca.configure {|config| config.user_agent = "MyApplication"}'
 
         raise ConfigurationError.new(msg)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isaca
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Orahood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday