vgs_api_client 0.0.1.alpha202205041401 → 0.0.1.alpha202205061657

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aca2a7276532fd047363d6709fb86ad758b98c377799f74eb31ccc41898659f
-  data.tar.gz: 5426a43aea34516ccf91abb8e258f8d33936f98a89dcda48c51e7291ce2d6a08
+  metadata.gz: 123134048a65ef511bc67624fafed31288e6976eee580153b83a05595525758b
+  data.tar.gz: 8c424e099764200fb6b90e7278f1f73b377c9aead2a18d3f8aa0bd8cc71413cd
 SHA512:
-  metadata.gz: '088118fca1debb13b98f7940fbeae6e6da2976eadea5848e251766a3b56e7319f7a274b9159f3c3ef5ae6fe2fac8e3dd19c37b4c944c48b8551e63894521944f'
-  data.tar.gz: 49bad418da5df2d3f1471e8bf776fe48afc4e0d5b695ecd4af0fa0172f3e2b2b8a48e9a2914d68a77b952beab9e52000a00a255c24e780f89ad9170d347b6dda
+  metadata.gz: cdd8095625820809fb3cdebd1c4952b227d3d839709a902e9ff9ec75691d60a43f19f02b6f7de79816dea3e10ddfd40ca1c53398042a4a1c366a776ddbfeca79
+  data.tar.gz: d322b0b5f3ca7325018a6b52086ae1eaa64fcda5d459b407de89cc0a932a22fd489084017f2c2ed43e8f3ef2533e3c2b9663b36f11c6cb17abe12970237c603e

data/README.md

@@ -16,11 +16,11 @@ gem install vgs-api-client
 
 ### Development
 
-Follow [DEVELOPMENT](https://github.com/verygoodsecurity/vgs-api-client-ruby/blob/master/DEVELOPMENT.md) instruction.
+Follow [DEVELOPMENT](DEVELOPMENT.md) instruction.
 
 ### Release
 
-Follow [RELEASE](https://github.com/verygoodsecurity/vgs-api-client-ruby/blob/master/RELEASE.md) instruction.
+Follow [RELEASE](RELEASE.md) instruction.
 
 ### Documentation
 

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha202205041401
+0.0.1.alpha202205061657

data/lib/openapi_client/api_client.rb

@@ -31,7 +31,7 @@ module VgsApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "vgs-api-client/0.0.1.alpha202205041401/ruby"
+      @user_agent = "vgs-api-client/0.0.1.alpha202205061657/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/openapi_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module VgsApiClient
-  VERSION = '0.0.1.alpha202205041401'
+  VERSION = '0.0.1.alpha202205061657'
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module VGS
-  VERSION = '0.0.1.alpha202205041401'
+  VERSION = '0.0.1.alpha202205061657'
 end

data/lib/vgs_api_client.rb

@@ -1,19 +1,48 @@
 require 'openapi_client'
 
 module VGS
-  class VgsApiException < StandardError
+  class VgsApiError < StandardError
+  end
+
+  class UnauthorizedError < VgsApiError
+  end
+
+  class NotFoundError < VgsApiError
+  end
+
+  class ForbiddenError < VgsApiError
   end
 
   class Aliases
     def initialize(config)
+      raise ArgumentError, 'config is nil' if config.nil?
       @aliases_api = VgsApiClient::AliasesApi.new(VgsApiClient::ApiClient.new(config))
     end
 
+    private def map_exception(message, error)
+      error_message = message
+      if error.is_a? VgsApiClient::ApiError
+        error_message += ". Details: #{error.message}"
+        case error.code
+        when 401
+          UnauthorizedError.new error_message
+        when 403
+          ForbiddenError.new error_message
+        when 404
+          NotFoundError.new error_message
+        else
+          VgsApiError.new error_message
+        end
+      else
+        VgsApiError.new error_message
+      end
+    end
+
     def redact(data)
       begin
         requests = data.map do |item|
           VgsApiClient::CreateAliasesRequestNew.new(attributes = {
-            :format => VgsApiClient::AliasFormat.build_from_hash(item[:format] || "UUID"),
+            :format => VgsApiClient::AliasFormat.build_from_hash(item[:format]),
             :classifiers => item[:classifiers],
             :value => item[:value],
             :storage => item[:storage]
@@ -26,9 +55,8 @@ module VGS
         response = @aliases_api.create_aliases(opts = {
           :create_aliases_request => create_aliases_request.to_hash
         })
-
-      rescue
-        raise VgsApiException, "Failed to redact data #{ data }"
+      rescue Exception => e
+        raise map_exception("Failed to redact data #{ data }", e)
       else
         response.data
       end
@@ -38,8 +66,8 @@ module VGS
       begin
         query = aliases.kind_of?(Array) ? aliases.join(",") : aliases
         response = @aliases_api.reveal_multiple_aliases(q = query)
-      rescue
-        raise VgsApiException, "Failed to reveal aliases #{ aliases }"
+      rescue Exception => e
+        raise map_exception("Failed to reveal aliases #{ aliases }", e)
       else
         response.data
       end
@@ -48,8 +76,8 @@ module VGS
     def delete(_alias)
       begin
         @aliases_api.delete_alias(_alias = _alias)
-      rescue
-        raise VgsApiException, "Failed to delete alias #{ _alias }"
+      rescue Exception => e
+        raise map_exception("Failed to delete alias #{ _alias }", e)
       end
     end
 
@@ -63,8 +91,8 @@ module VGS
         @aliases_api.update_alias(_alias = _alias, opts = {
           :update_alias_request => update_alias_request.to_hash
         })
-      rescue
-        raise VgsApiException, "Failed to update alias #{ _alias }"
+      rescue Exception => e
+        raise map_exception("Failed to update alias #{ _alias }", e)
       end
     end
   end
@@ -77,6 +105,7 @@ module VGS
     config.username = username
     config.password = password
     config.host = host
+    config.server_index = nil
     config
   end
 end

data/scripts/assemble/run.sh

@@ -3,7 +3,7 @@
 LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
 
 # fix version
-grep -rl 0.0.1.alpha202205041401 . | xargs sed -i "s/0.0.1.alpha202205041401/${LIB_VERSION}/g"
+grep -rl 0.0.1.alpha202205061657 . | xargs sed -i "s/0.0.1.alpha202205061657/${LIB_VERSION}/g"
 
 # build
 gem build vgs_api_client.gemspec

data/scripts/test/run.sh

@@ -5,7 +5,7 @@ set -e
 echo "Installing lib from local sources"
 # fix version
 VERSION=0.0.1.alpha$(date "+%Y%m%d%H%M")
-grep -rl 0.0.1.alpha202205041401 . | xargs sed -i "s/0.0.1.alpha202205041401/$VERSION/g"
+grep -rl 0.0.1.alpha202205061657 . | xargs sed -i "s/0.0.1.alpha202205061657/$VERSION/g"
 
 bundle install
 

data/spec/test_aliases_api_spec.rb

@@ -3,9 +3,43 @@ require 'securerandom'
 require 'vgs_api_client'
 
 describe 'AliasesApiSpec' do
-  before(:all) do
+  before(:each) do
     config = VGS.config(username = ENV['VAULT_API_USERNAME'], password = ENV['VAULT_API_PASSWORD'])
-    @aliases_api = VGS::Aliases.new config
+    @api = VGS::Aliases.new config
+  end
+
+  describe 'invalid auth' do
+    it 'should fail if invalid auth provided' do
+      invalid_config = VGS.config(username = 'Invalid', password = 'Invalid')
+      api = VGS::Aliases.new invalid_config
+      data = [{
+                format: 'UUID',
+                value: 'Joe Doe'
+              }]
+
+      expect { api.redact data }.to raise_error(VGS::UnauthorizedError)
+    end
+  end
+
+  describe 'invalid config' do
+    it 'should fail if invalid config provided' do
+      expect { VGS::Aliases.new nil }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe 'invalid host' do
+    it 'should fail if invalid host provided' do
+      config = VGS.config(
+        username = ENV['VAULT_API_USERNAME'],
+        password = ENV['VAULT_API_PASSWORD'],
+        host = 'https://echo.apps.verygood.systems')
+      api = VGS::Aliases.new config
+      data = [{
+                format: 'UUID',
+                value: 'Joe Doe'
+              }]
+      expect { api.redact data }.to raise_error(VGS::NotFoundError)
+    end
   end
 
   describe 'redact' do
@@ -21,7 +55,7 @@ describe 'AliasesApiSpec' do
                 value: 'Joe Doe',
                 storage: 'VOLATILE'
               }]
-      aliases = @aliases_api.redact data
+      aliases = @api.redact data
       expect(aliases.length).to eq 2
       data.each_with_index do |item, index|
         expect(aliases[index].value).to eq item[:value]
@@ -46,14 +80,14 @@ describe 'AliasesApiSpec' do
                 value: 'Joe Doe',
                 storage: 'VOLATILE'
               }]
-      aliases = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }
+      aliases = @api.redact(data).map { |item| item.aliases[0]._alias }
 
-      response = @aliases_api.reveal aliases
+      response = @api.reveal aliases
 
       expect(response.length).to eq 2
       original_values = data.map { |i| i[:value] }
       revealed_values = response.values.map { |i| i.value }
-      expect(Set.new(original_values)).to eq Set.new(revealed_values)
+      expect(Set.new original_values).to eq Set.new revealed_values
     end
   end
 
@@ -63,11 +97,11 @@ describe 'AliasesApiSpec' do
                 format: 'UUID',
                 value: SecureRandom.alphanumeric(10)
               }]
-      _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
+      _alias = @api.redact(data).map { |item| item.aliases[0]._alias }[0]
 
-      @aliases_api.update _alias, classifiers: %w[secure]
+      @api.update _alias, classifiers: %w[secure]
 
-      response = @aliases_api.reveal(_alias)
+      response = @api.reveal _alias
       expect(response[_alias].classifiers).to eq %w[secure]
     end
   end
@@ -78,11 +112,11 @@ describe 'AliasesApiSpec' do
                 format: 'UUID',
                 value: '5201784564572092'
               }]
-      _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
+      _alias = @api.redact(data).map { |item| item.aliases[0]._alias }[0]
 
-      @aliases_api.delete _alias
+      @api.delete _alias
 
-      expect { @aliases_api.reveal(_alias) }.to raise_error(VGS::VgsApiException)
+      expect { @api.reveal _alias }.to raise_error(VGS::VgsApiError)
     end
   end
 

data/vgs_api_client.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Very Good Security"]
   s.email       = ["support@verygoodsecurity.com"]
   s.homepage    = "https://github.com/verygoodsecurity/vgs-api-client-ruby"
-  s.summary     = "Very Good Security API Client"
-  s.description = "Very Good Security API Client library. More details on https://www.verygoodsecurity.com/"
+  s.summary     = "VGS API Client"
+  s.description = "This gem maps to VGS Vault API"
   s.license     = "BSD-3-Clause"
   s.required_ruby_version = ">= 2.6"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vgs_api_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha202205041401
+  version: 0.0.1.alpha202205061657
 platform: ruby
 authors:
 - Very Good Security
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -50,7 +50,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-description: Very Good Security API Client library. More details on https://www.verygoodsecurity.com/
+description: This gem maps to VGS Vault API
 email:
 - support@verygoodsecurity.com
 executables: []
@@ -132,7 +132,7 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Very Good Security API Client
+summary: VGS API Client
 test_files:
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb