vgs_api_client 0.0.1.alpha202204221503 → 0.0.1.alpha202204222258

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b48c29f8b5d690e7110d5cb7f3a7622625b85a53481d058fe6e3ab9d6237710a
-  data.tar.gz: 1897de2f8e4fa967d976c22fccfb683936dbf8d38633f9c08db94e49d8910cf1
+  metadata.gz: ecfcd0dfd307b422f1e0a3e742e7c8802724021fb075fee588858efc4890d9ef
+  data.tar.gz: eadb71ebb0d43ec3017d94dc66da1eb07f363f27162148a5e7a3686cc9886ad9
 SHA512:
-  metadata.gz: ceb9411f171696dcff3c90bc84c32d2e4b802917b47521e8cd622071a916a09f13bb4b3568d54d5b61ef526678a13f85e43cd1590c9a747401c103f91c534164
-  data.tar.gz: a0ddbc915a425283bd67155342b57cdfbcd1781fb67f4986946e85136b0641226842d8364317c35a64a188d650217426b4c2906047c217012308c52d43e6ad29
+  metadata.gz: b8124a8486c7ab76e52c9f69e039825823f769ab5d540d73f263c1a392809330c2698c331be4ef765d2b57bfe6efb0d4d911e0bcb4f2da799a534ad823afe96b
+  data.tar.gz: 90c124eda152b8b803e5ee5e02e5f01da03b414bce2e289e7ce60903cf5125c522bc6b13c11b59fbc3127b524dd1c3180aab7aa1b1d00cf3c9462096d1addb32

data/README.md

@@ -0,0 +1,33 @@
+# vgs-api-client-python
+
+This repository contains a Ruby API client library for the Very Good Security API.
+
+### Requirements
+
+Building and using the API client library requires Ruby 2.6+.
+
+### Installation
+
+```
+gem install vgs-api-client
+```
+
+### Development
+
+Follow [DEVELOPMENT](DEVELOPMENT.md) instruction.
+
+### Release
+
+Follow [RELEASE](RELEASE.md) instruction.
+
+### Documentation
+
+https://www.verygoodsecurity.com/docs/vault/api/
+
+### Tutorial
+
+https://www.verygoodsecurity.com/docs/tokenization/ruby-tutorial
+
+### Support
+
+support@verygoodsecurity.com

data/lib/{vgs_api_client → 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.alpha202204221503/ruby"
+      @user_agent = "vgs-api-client/0.0.1.alpha202204222258/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/{vgs_api_client → openapi_client}/version.rb

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

data/lib/openapi_client.rb

@@ -0,0 +1,53 @@
+=begin
+#Vault HTTP API
+
+#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@verygoodsecurity.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+# Common files
+require 'openapi_client/api_client'
+require 'openapi_client/api_error'
+require 'openapi_client/version'
+require 'openapi_client/configuration'
+
+# Models
+require 'openapi_client/models/alias_format'
+require 'openapi_client/models/api_error'
+require 'openapi_client/models/create_aliases_request'
+require 'openapi_client/models/create_aliases_request_new'
+require 'openapi_client/models/create_aliases_request_reference'
+require 'openapi_client/models/inline_response200'
+require 'openapi_client/models/inline_response2001'
+require 'openapi_client/models/inline_response201'
+require 'openapi_client/models/inline_response_default'
+require 'openapi_client/models/model_alias'
+require 'openapi_client/models/revealed_data'
+require 'openapi_client/models/update_alias_request'
+require 'openapi_client/models/update_alias_request_data'
+
+# APIs
+require 'openapi_client/api/aliases_api'
+
+module VgsApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   VgsApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module VGS
+  VERSION = '0.0.1.alpha202204222258'
+end

data/lib/vgs_api_client.rb

@@ -1,53 +1,84 @@
-=begin
-#Vault HTTP API
-
-#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@verygoodsecurity.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
-
-=end
-
-# Common files
-require 'vgs_api_client/api_client'
-require 'vgs_api_client/api_error'
-require 'vgs_api_client/version'
-require 'vgs_api_client/configuration'
-
-# Models
-require 'vgs_api_client/models/alias_format'
-require 'vgs_api_client/models/api_error'
-require 'vgs_api_client/models/create_aliases_request'
-require 'vgs_api_client/models/create_aliases_request_new'
-require 'vgs_api_client/models/create_aliases_request_reference'
-require 'vgs_api_client/models/inline_response200'
-require 'vgs_api_client/models/inline_response2001'
-require 'vgs_api_client/models/inline_response201'
-require 'vgs_api_client/models/inline_response_default'
-require 'vgs_api_client/models/model_alias'
-require 'vgs_api_client/models/revealed_data'
-require 'vgs_api_client/models/update_alias_request'
-require 'vgs_api_client/models/update_alias_request_data'
-
-# APIs
-require 'vgs_api_client/api/aliases_api'
-
-module VgsApiClient
-  class << self
-    # Customize default settings for the SDK using block.
-    #   VgsApiClient.configure do |config|
-    #     config.username = "xxx"
-    #     config.password = "xxx"
-    #   end
-    # If no block given, return the default Configuration object.
-    def configure
-      if block_given?
-        yield(Configuration.default)
+require 'openapi_client'
+
+module VGS
+  class VgsApiException < StandardError
+  end
+
+  class Aliases
+    def initialize(config)
+      @aliases_api = VgsApiClient::AliasesApi.new(VgsApiClient::ApiClient.new(config))
+    end
+
+    def redact(data)
+      begin
+        requests = data.map do |item|
+          VgsApiClient::CreateAliasesRequestNew.new(attributes = {
+            :format => VgsApiClient::AliasFormat.build_from_hash(item[:format]),
+            :classifiers => item[:classifiers],
+            :value => item[:value],
+            :storage => item[:storage]
+          })
+        end
+
+        create_aliases_request = VgsApiClient::CreateAliasesRequest.new(attributes = {
+          :data => requests
+        })
+        response = @aliases_api.create_aliases(opts = {
+          :create_aliases_request => create_aliases_request.to_hash
+        })
+
+      rescue
+        raise VgsApiException, "Failed to redact data #{ data }"
+      else
+        response.data
+      end
+
+    end
+
+    def reveal(aliases)
+      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 }"
       else
-        Configuration.default
+        response.data
+      end
+    end
+
+    def delete(_alias)
+      begin
+        @aliases_api.delete_alias(_alias = _alias)
+      rescue
+        raise VgsApiException, "Failed to delete alias #{ _alias }"
+      end
+    end
+
+    def update(_alias, data)
+      begin
+        update_alias_request = VgsApiClient::UpdateAliasRequest.new(attributes = {
+          :data => VgsApiClient::UpdateAliasRequestData.new(attributes = {
+            :classifiers => data[:classifiers]
+          })
+        })
+        @aliases_api.update_alias(_alias = _alias, opts = {
+          :update_alias_request => update_alias_request.to_hash
+        })
+      rescue
+        raise VgsApiException, "Failed to update alias #{ _alias }"
       end
     end
   end
-end
+
+  def self.config(username, password, host = 'https://api.sandbox.verygoodvault.com')
+    raise ArgumentError, 'username is nil' if username.nil?
+    raise ArgumentError, 'password is nil' if password.nil?
+
+    config = VgsApiClient::Configuration.default
+    config.username = username
+    config.password = password
+    config.host = host
+    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.alpha202204221503 . | xargs sed -i "s/0.0.1.alpha202204221503/${LIB_VERSION}/g"
+grep -rl 0.0.1.alpha202204222258 . | xargs sed -i "s/0.0.1.alpha202204222258/${LIB_VERSION}/g"
 
 # build
 gem build vgs_api_client.gemspec

data/scripts/test/run.sh

@@ -5,9 +5,9 @@ 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.alpha202204221503 . | xargs sed -i "s/0.0.1.alpha202204221503/$VERSION/g"
+grep -rl 0.0.1.alpha202204222258 . | xargs sed -i "s/0.0.1.alpha202204222258/$VERSION/g"
 
 bundle install
 
 echo "Running tests"
-bundle exec rspec ./spec/*.rb
+bundle exec rspec -f documentation ./spec/*.rb

data/scripts/test-e2e/Dockerfile

@@ -4,19 +4,11 @@ RUN apk update && \
     apk add bash && \
     apk add build-base && \
     apk add libcurl && \
-    gem install bundler && \
-    gem install rspec-support
-
-RUN mkdir -p /vgs-api-client/ && \
-    mkdir -p /vgs-api-client/tmp
+    gem install rspec
 
 ADD ./scripts/test-e2e /vgs-api-client/scripts
 ADD ./spec /vgs-api-client/spec
 
-# Temporarily copying gem files to tmp/ dir
-ADD ./vgs_api_client.gemspec /vgs-api-client/tmp/vgs_api_client.gemspec
-ADD ./Gemfile /vgs-api-client/tmp/Gemfile
-
 WORKDIR /vgs-api-client/
 
 ENTRYPOINT ["bash", "./scripts/run.sh"]

data/scripts/test-e2e/run.sh

@@ -9,7 +9,6 @@ ATTEMPT=1
 while [  $ATTEMPT -lt 10 ]; do
   echo "Attempt ${ATTEMPT} ..."
 
-  bundle install --without production --binstubs
   gem install vgs_api_client -v ${LIB_VERSION}
 
   if [[ $? == 0 ]]; then
@@ -24,7 +23,6 @@ done
 set -e
 
 echo "Running tests"
-mv /vgs-api-client/tmp/Gemfile /vgs-api-client/
-mv /vgs-api-client/tmp/vgs_api_client.gemspec /vgs-api-client/
-bundle install --without production --binstubs
-bundle exec rspec ./spec/*.rb
+gem install rspec
+rspec -f documentation ./spec/*.rb
+

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ OpenAPI Generator version: 5.4.0
 =end
 
 # load the gem
-require 'vgs_api_client'
+require 'openapi_client'
 
 # The following  was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/spec/test_aliases_api_spec.rb

@@ -1,29 +1,27 @@
 require 'spec_helper'
 require 'securerandom'
-require 'vgs'
+require 'vgs_api_client'
 
 describe 'AliasesApiSpec' do
   before(:all) do
-    config = VGS.config(username = ENV["VAULT_API_USERNAME"], password = ENV["VAULT_API_PASSWORD"])
-    @aliases_api = VGS::Aliases.new(config)
+    config = VGS.config(username = ENV['VAULT_API_USERNAME'], password = ENV['VAULT_API_PASSWORD'])
+    @aliases_api = VGS::Aliases.new config
   end
 
   describe 'redact' do
     it 'should redact values' do
-      data = [
-        {
-          :format => 'UUID',
-          :value => '5201784564572092',
-          :classifiers => %w[credit-card number],
-          :storage => 'PERSISTENT',
-        },
-        {
-          :format => 'UUID',
-          :value => 'Joe Doe',
-          :storage => 'VOLATILE',
-        }
-      ]
-      aliases = @aliases_api.redact(data)
+      data = [{
+                format: 'UUID',
+                value: '5201784564572092',
+                classifiers: %w[credit-card number],
+                storage: 'PERSISTENT'
+              },
+              {
+                format: 'UUID',
+                value: 'Joe Doe',
+                storage: 'VOLATILE'
+              }]
+      aliases = @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]
@@ -37,22 +35,20 @@ describe 'AliasesApiSpec' do
 
   describe 'reveal' do
     it 'should reveal aliases' do
-      data = [
-        {
-          :format => 'UUID',
-          :value => '5201784564572092',
-          :classifiers => %w[credit-card number],
-          :storage => 'PERSISTENT',
-        },
-        {
-          :format => 'UUID',
-          :value => 'Joe Doe',
-          :storage => 'VOLATILE',
-        }
-      ]
+      data = [{
+                format: 'UUID',
+                value: '5201784564572092',
+                classifiers: %w[credit-card number],
+                storage: 'PERSISTENT'
+              },
+              {
+                format: 'UUID',
+                value: 'Joe Doe',
+                storage: 'VOLATILE'
+              }]
       aliases = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }
 
-      response = @aliases_api.reveal(aliases)
+      response = @aliases_api.reveal aliases
 
       expect(response.length).to eq 2
       original_values = data.map { |i| i[:value] }
@@ -63,15 +59,13 @@ describe 'AliasesApiSpec' do
 
   describe 'update' do
     it 'should update alias' do
-      data = [
-        {
-          :format => 'UUID',
-          :value => SecureRandom.alphanumeric(10),
-        }
-      ]
+      data = [{
+                format: 'UUID',
+                value: SecureRandom.alphanumeric(10)
+              }]
       _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
 
-      @aliases_api.update(_alias = _alias, data = { :classifiers => ["secure"] })
+      @aliases_api.update _alias, classifiers: %w[secure]
 
       response = @aliases_api.reveal(_alias)
       expect(response[_alias].classifiers).to eq %w[secure]
@@ -80,15 +74,13 @@ describe 'AliasesApiSpec' do
 
   describe 'delete' do
     it 'should delete alias' do
-      data = [
-        {
-          :format => 'UUID',
-          :value => '5201784564572092',
-        }
-      ]
+      data = [{
+                format: 'UUID',
+                value: '5201784564572092'
+              }]
       _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
 
-      @aliases_api.delete(_alias = _alias)
+      @aliases_api.delete _alias
 
       expect { @aliases_api.reveal(_alias) }.to raise_error(VGS::VgsApiException)
     end

data/vgs_api_client.gemspec

@@ -1,31 +1,25 @@
 # -*- encoding: utf-8 -*-
 
-=begin
-#Vault HTTP API
-
-#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@verygoodsecurity.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
-
-=end
-
-$:.push File.expand_path("../lib", __FILE__)
-require "vgs_api_client/version"
+require_relative "lib/version"
 
 Gem::Specification.new do |s|
   s.name        = "vgs_api_client"
-  s.version     = VgsApiClient::VERSION
+  s.version     = VGS::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Very Good Security"]
-  s.email       = ["dev@verygoodsecurity.com"]
-  s.homepage    = "https://openapi-generator.tech"
-  s.summary     = "A ruby wrapper for the VGS Vault API"
+  s.email       = ["support@verygoodsecurity.com"]
+  s.homepage    = "https://github.com/verygoodsecurity/vgs-api-client-ruby"
+  s.summary     = "VGS API Client"
   s.description = "This gem maps to VGS Vault API"
-  s.license     = "Unlicense"
-  s.required_ruby_version = ">= 2.4"
+  s.license     = "BSD-3-Clause"
+  s.required_ruby_version = ">= 2.6"
+
+  s.metadata = {
+    "homepage_uri"      => "https://www.verygoodsecurity.com",
+    "bug_tracker_uri"   => "https://github.com/verygoodsecurity/vgs-api-client-ruby/issues",
+    "documentation_uri" => "https://www.verygoodsecurity.com/docs",
+    "source_code_uri"   => "https://github.com/verygoodsecurity/vgs-api-client-ruby"
+  }
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vgs_api_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha202204221503
+  version: 0.0.1.alpha202204222258
 platform: ruby
 authors:
 - Very Good Security
@@ -52,7 +52,7 @@ dependencies:
         version: 3.6.0
 description: This gem maps to VGS Vault API
 email:
-- dev@verygoodsecurity.com
+- support@verygoodsecurity.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -60,29 +60,31 @@ files:
 - DEVELOPMENT.md
 - Gemfile
 - LICENSE
+- README.md
 - RELEASE.md
 - Rakefile
 - docker-compose.yaml
-- lib/vgs.rb
+- lib/openapi_client.rb
+- lib/openapi_client/api/aliases_api.rb
+- lib/openapi_client/api_client.rb
+- lib/openapi_client/api_error.rb
+- lib/openapi_client/configuration.rb
+- lib/openapi_client/models/alias_format.rb
+- lib/openapi_client/models/api_error.rb
+- lib/openapi_client/models/create_aliases_request.rb
+- lib/openapi_client/models/create_aliases_request_new.rb
+- lib/openapi_client/models/create_aliases_request_reference.rb
+- lib/openapi_client/models/inline_response200.rb
+- lib/openapi_client/models/inline_response2001.rb
+- lib/openapi_client/models/inline_response201.rb
+- lib/openapi_client/models/inline_response_default.rb
+- lib/openapi_client/models/model_alias.rb
+- lib/openapi_client/models/revealed_data.rb
+- lib/openapi_client/models/update_alias_request.rb
+- lib/openapi_client/models/update_alias_request_data.rb
+- lib/openapi_client/version.rb
+- lib/version.rb
 - lib/vgs_api_client.rb
-- lib/vgs_api_client/api/aliases_api.rb
-- lib/vgs_api_client/api_client.rb
-- lib/vgs_api_client/api_error.rb
-- lib/vgs_api_client/configuration.rb
-- lib/vgs_api_client/models/alias_format.rb
-- lib/vgs_api_client/models/api_error.rb
-- lib/vgs_api_client/models/create_aliases_request.rb
-- lib/vgs_api_client/models/create_aliases_request_new.rb
-- lib/vgs_api_client/models/create_aliases_request_reference.rb
-- lib/vgs_api_client/models/inline_response200.rb
-- lib/vgs_api_client/models/inline_response2001.rb
-- lib/vgs_api_client/models/inline_response201.rb
-- lib/vgs_api_client/models/inline_response_default.rb
-- lib/vgs_api_client/models/model_alias.rb
-- lib/vgs_api_client/models/revealed_data.rb
-- lib/vgs_api_client/models/update_alias_request.rb
-- lib/vgs_api_client/models/update_alias_request_data.rb
-- lib/vgs_api_client/version.rb
 - scripts/assemble/Dockerfile
 - scripts/assemble/run.sh
 - scripts/publish.sh
@@ -99,10 +101,14 @@ files:
 - spec/spec_helper.rb
 - spec/test_aliases_api_spec.rb
 - vgs_api_client.gemspec
-homepage: https://openapi-generator.tech
+homepage: https://github.com/verygoodsecurity/vgs-api-client-ruby
 licenses:
-- Unlicense
-metadata: {}
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://www.verygoodsecurity.com
+  bug_tracker_uri: https://github.com/verygoodsecurity/vgs-api-client-ruby/issues
+  documentation_uri: https://www.verygoodsecurity.com/docs
+  source_code_uri: https://github.com/verygoodsecurity/vgs-api-client-ruby
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -111,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -121,7 +127,7 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A ruby wrapper for the VGS Vault API
+summary: VGS API Client
 test_files:
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb

data/lib/vgs.rb

@@ -1,82 +0,0 @@
-module VGS
-  class VgsApiException < StandardError
-  end
-
-  class Aliases
-    def initialize(config)
-      @aliases_api = VgsApiClient::AliasesApi.new(VgsApiClient::ApiClient.new(config))
-    end
-
-    def redact(data)
-      begin
-        requests = data.map do |item|
-          VgsApiClient::CreateAliasesRequestNew.new(attributes = {
-            :format => VgsApiClient::AliasFormat.build_from_hash(item[:format]),
-            :classifiers => item[:classifiers],
-            :value => item[:value],
-            :storage => item[:storage]
-          })
-        end
-
-        create_aliases_request = VgsApiClient::CreateAliasesRequest.new(attributes = {
-          :data => requests
-        })
-        response = @aliases_api.create_aliases(opts = {
-          :create_aliases_request => create_aliases_request.to_hash
-        })
-
-      rescue
-        raise VgsApiException, "Failed to redact data #{ data }"
-      else
-        response.data
-      end
-
-    end
-
-    def reveal(aliases)
-      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 }"
-      else
-        response.data
-      end
-    end
-
-    def delete(_alias)
-      begin
-        @aliases_api.delete_alias(_alias = _alias)
-      rescue
-        raise VgsApiException, "Failed to delete alias #{ _alias }"
-      end
-    end
-
-    def update(_alias, data)
-      begin
-        update_alias_request = VgsApiClient::UpdateAliasRequest.new(attributes = {
-          :data => VgsApiClient::UpdateAliasRequestData.new(attributes = {
-            :classifiers => data[:classifiers]
-          })
-        })
-        @aliases_api.update_alias(_alias = _alias, opts = {
-          :update_alias_request => update_alias_request.to_hash
-        })
-      rescue
-        raise VgsApiException, "Failed to update alias #{ _alias }"
-      end
-    end
-  end
-
-  def self.config(username, password, host = 'https://api.sandbox.verygoodvault.com')
-    raise ArgumentError, 'username is nil' if username.nil?
-    raise ArgumentError, 'password is nil' if password.nil?
-
-    config = VgsApiClient::Configuration.default
-    config.username = username
-    config.password = password
-    config.host = host
-    config
-  end
-
-end

data/lib/vgs_api_client/models/api_error.rb

@@ -1,249 +0,0 @@
-=begin
-#Vault HTTP API
-
-#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@verygoodsecurity.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
-
-=end
-
-require 'date'
-require 'time'
-
-module VgsApiClient
-  class ApiError
-    # Explanation of what exactly went wrong.
-    attr_accessor :detail
-
-    # Request URL.
-    attr_accessor :href
-
-    # HTTP status code.
-    attr_accessor :status
-
-    # High-level reason of why the request failed.
-    attr_accessor :title
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'detail' => :'detail',
-        :'href' => :'href',
-        :'status' => :'status',
-        :'title' => :'title'
-      }
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'detail' => :'String',
-        :'href' => :'String',
-        :'status' => :'Integer',
-        :'title' => :'String'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `VgsApiClient::ApiError` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `VgsApiClient::ApiError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'detail')
-        self.detail = attributes[:'detail']
-      end
-
-      if attributes.key?(:'href')
-        self.href = attributes[:'href']
-      end
-
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      end
-
-      if attributes.key?(:'title')
-        self.title = attributes[:'title']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          detail == o.detail &&
-          href == o.href &&
-          status == o.status &&
-          title == o.title
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [detail, href, status, title].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = VgsApiClient.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-  end
-
-end