vaas 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c4b8c8ed151fe77da284d60d07156dbc84b40346fcad1ef64162ef7a15cb14
-  data.tar.gz: 1fdce2973ded2543f3ff4e808d8263371c7add9ea7b5bee6f62d146125ad7763
+  metadata.gz: e23bd7f42275d3abaadea284ae353797be04d87481168e2c405d60e91b5f3651
+  data.tar.gz: 256a204cc03536ab392903e4301d05b8acc26599510ebf7982ce317ef6918cbb
 SHA512:
-  metadata.gz: bf6267e4f1c176b9c4dc3b760d8ec54fa475a73fef613d8c8220954cdadbc73f23a78baa529b338dd1a711051b8462471961443ea4c9ab94a69a8f2b3eb8a447
-  data.tar.gz: 8fe1af11c62026f93bf03e30353b826f0f0d9c99d481b3f8494e5da59e155b2a599dc362f78c3fc8df6009d15566754adc55fdd86f80b377ac924472535a2e1d
+  metadata.gz: d2101b2769f8016e5881e7e4fbdd364da661a9a0d39322d359e95af2288f227d21a2302a46a2339f063c44e8714165754f18bb75d25b454988481454a9a512f9
+  data.tar.gz: 153593621130ced28b394d6033e842192b112ba0169d37ffba1596473c231543689f466ed0cba3c50217f4ec9382d10996decd9a18d2c3d9ee968e9bb6bb6b78

data/examples/authentication.rb

@@ -0,0 +1,50 @@
+require 'vaas/client_credentials_grant_authenticator'
+require 'vaas/resource_owner_password_grant_authenticator'
+require 'vaas/vaas_main'
+require 'async'
+
+
+def main
+    client_id = "vaas-customer"
+    client_secret = ENV.fetch("CLIENT_SECRET")
+    user_name = ENV.fetch("VAAS_USER_NAME")
+    password = ENV.fetch("VAAS_PASSWORD")
+    token_url = ENV.fetch("TOKEN_URL") || "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token"
+    vaas_url = ENV.fetch("VAAS_URL") || "wss://gateway.production.vaas.gdatasecurity.de"
+    test_url = "https://gdata.de"
+
+    #If you got a username and password from us, you can use the ResourceOwnerPasswordAuthenticator like this
+    authenticator = VAAS::ResourceOwnerPasswordGrantAuthenticator.new(
+      client_id,
+      user_name,
+      password,
+      token_url
+    )
+    # You may use self registration and create a new username and password for the
+    # ResourceOwnerPasswordAuthenticator by yourself like the example above on https:#vaas.gdata.de/login
+
+    # Else if you got a client id and client secret from us, you can use the ClientCredentialsGrantAuthenticator like this
+    # authenticator = VAAS::ClientCredentialsGrantAuthenticator.new(
+    #   client_id,
+    #   client_secret,
+    #   token_url
+    # )
+
+
+    vaas = VAAS::VaasMain.new(vaas_url)
+    token = authenticator.get_token
+
+    Async do
+        vaas.connect(token)
+
+        verdict = vaas.for_url(test_url)
+        puts "Verdict #{verdict.wait.sha256} is detected as #{verdict.wait.verdict}"
+
+        vaas.close
+    end
+end
+
+
+if __FILE__  == $0
+    main
+end

data/examples/example_with_reconnect.rb

@@ -4,17 +4,20 @@ require 'vaas/vaas_main'
 
 CLIENT_ID = ENV.fetch('CLIENT_ID')
 CLIENT_SECRET = ENV.fetch('CLIENT_SECRET')
+VAAS_URL = ENV.fetch('VAAS_URL', "wss://gateway.production.vaas.gdatasecurity.de")
+TOKEN_URL = ENV.fetch('TOKEN_URL', 'https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token')
+
 URL = ENV.fetch('URL')
 
 def main
   authenticator = VAAS::ClientCredentialsGrantAuthenticator.new(
     CLIENT_ID,
     CLIENT_SECRET,
-    "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token"
+    TOKEN_URL
   )
 
   # create a vaas object and get a token to authenticate
-  vaas = VAAS::VaasMain.new
+  vaas = VAAS::VaasMain.new(VAAS_URL)
   token = authenticator.get_token
 
   Async do

data/examples/simple_example.rb

@@ -4,17 +4,20 @@ require 'vaas/vaas_main'
 
 CLIENT_ID = ENV.fetch('CLIENT_ID')
 CLIENT_SECRET = ENV.fetch('CLIENT_SECRET')
+VAAS_URL = ENV.fetch('VAAS_URL', "wss://gateway.production.vaas.gdatasecurity.de")
+TOKEN_URL = ENV.fetch('TOKEN_URL', 'https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token')
+
 URL = ENV.fetch('URL')
 
 def main
   authenticator = VAAS::ClientCredentialsGrantAuthenticator.new(
     CLIENT_ID,
     CLIENT_SECRET,
-    "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token"
+    TOKEN_URL
   )
 
   # create a vaas object and get a token to authenticate
-  vaas = VAAS::VaasMain.new
+  vaas = VAAS::VaasMain.new(VAAS_URL)
   token = authenticator.get_token
 
   Async do

data/lib/vaas/client_credentials_grant_authenticator.rb

@@ -7,7 +7,7 @@ module VAAS
 
     attr_accessor :client_id, :client_secret, :token_endpoint, :token
 
-    def initialize(client_id, client_secret, token_endpoint)
+    def initialize(client_id, client_secret, token_endpoint = 'https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token')
       @client_id = client_id
       @client_secret = client_secret
       @token_endpoint = token_endpoint
@@ -27,6 +27,8 @@ module VAAS
       ensure
         client&.close
       end
+
+      raise VaasAuthenticationError if token.nil?
       token
     end
   end

data/lib/vaas/resource_owner_password_grant_authenticator.rb

@@ -0,0 +1,36 @@
+require 'json'
+require 'async'
+require 'async/http/internet'
+
+module VAAS
+  class ResourceOwnerPasswordGrantAuthenticator
+
+    attr_accessor :client_id, :token_endpoint, :token, :username, :password
+
+    def initialize(client_id, username, password, token_endpoint = 'https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token')
+      @client_id = client_id
+      @username = username
+      @password = password
+      @token_endpoint = token_endpoint
+    end
+
+    def get_token
+      Async do
+        client = Async::HTTP::Internet.new
+
+        header = [['content-type', 'application/x-www-form-urlencoded']]
+        body = ["grant_type=password&client_id=#{client_id}&username=#{username}&password=#{password}"]
+
+        response = client.post(token_endpoint, header, body)
+        self.token = JSON.parse(response.read)['access_token']
+      rescue => e
+        raise VaasAuthenticationError, e
+      ensure
+        client&.close
+      end
+
+      raise VaasAuthenticationError if token.nil?
+      token
+    end
+  end
+end

data/lib/vaas/version.rb

@@ -1,3 +1,3 @@
 module VAAS
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

data/vaas.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.require_paths = ["lib"]
   s.metadata = { "documentation_uri" => "https://github.com/GDATASoftwareAG/vaas/blob/main/ruby/README.md" }
+  s.required_ruby_version = '>= 3.1.1'
 
   s.add_dependency 'async', '~> 2.3.1'
   s.add_dependency 'async-http', '~> 0.59.4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vaas
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Allie Weitenkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -91,10 +91,12 @@ files:
 - ".vscode/launch.json"
 - Gemfile
 - README.md
+- examples/authentication.rb
 - examples/example_with_reconnect.rb
 - examples/simple_example.rb
 - lib/vaas.rb
 - lib/vaas/client_credentials_grant_authenticator.rb
+- lib/vaas/resource_owner_password_grant_authenticator.rb
 - lib/vaas/vaas_errors.rb
 - lib/vaas/vaas_main.rb
 - lib/vaas/vaas_verdict.rb
@@ -113,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="