vgs_api_client 0.0.1.alpha202204221503 → 0.0.1.alpha202204221804

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b48c29f8b5d690e7110d5cb7f3a7622625b85a53481d058fe6e3ab9d6237710a
-  data.tar.gz: 1897de2f8e4fa967d976c22fccfb683936dbf8d38633f9c08db94e49d8910cf1
+  metadata.gz: ad6f53cf37b26adf6ad0d2d8601bce2d3812dfd8f33f5956fb2bc7a1a0adedc6
+  data.tar.gz: b1f5add24e6548547ffacda7cde9ebf25f2db4fcbe7f350b2fa8836efe93544e
 SHA512:
-  metadata.gz: ceb9411f171696dcff3c90bc84c32d2e4b802917b47521e8cd622071a916a09f13bb4b3568d54d5b61ef526678a13f85e43cd1590c9a747401c103f91c534164
-  data.tar.gz: a0ddbc915a425283bd67155342b57cdfbcd1781fb67f4986946e85136b0641226842d8364317c35a64a188d650217426b4c2906047c217012308c52d43e6ad29
+  metadata.gz: 0e24e515b39092e5027afa40defa1efb5c4162fbc9889118d9dcd114beb8b0fbdba030f181f4df81f7031d1e573f1743f2d7ed8e6e3057a255715c32bf91e967
+  data.tar.gz: d738f6848d1e2e61bd074319153ecd7dd8646efa59f428f103e86a208e54762d4e7921ad95090d530bfb1fb60725cf8e5f8f7c2978d3e0de05bc8dec1f0bd9c3

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    vgs_api_client (0.0.1.alpha202204221804)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.3)
+      stringio
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    stringio (3.0.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+  vgs_api_client!
+
+BUNDLED WITH
+   2.3.11

data/datadog.rb

@@ -0,0 +1,10 @@
+require 'datadog_api_client'
+
+api_instance = DatadogAPIClient::V1::IPRangesAPI.new
+
+begin
+  result = api_instance.get_ip_ranges
+  p result
+rescue DatadogAPIClient::V1::APIError => e
+  puts "Error when calling IPRangesAPI->get_ip_ranges: #{e}"
+end

data/lib/version.rb

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

data/lib/vgs_api_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.alpha202204221804/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/vgs_api_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.alpha202204221804'
 end

data/lib/vgs_api_client.rb

@@ -1,15 +1,3 @@
-=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'
@@ -34,20 +22,85 @@ 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)
+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
-        Configuration.default
+        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
+
+end

data/scripts/assemble/run.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 
-LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
+LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.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.alpha202204221804 . | xargs sed -i "s/0.0.1.alpha202204221804/${LIB_VERSION}/g"
 
 # build
 gem build vgs_api_client.gemspec

data/scripts/publish/run.sh

@@ -6,7 +6,7 @@ usage() { echo "Required env var '$1' is missing"; exit 1; }
 
 [ -z "${ARTIFACT_REPOSITORY_TOKEN}" ] && usage "ARTIFACT_REPOSITORY_TOKEN" ;
 
-LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
+LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")}
 
 mkdir ~/.gem
 echo ":rubygems_api_key: ${ARTIFACT_REPOSITORY_TOKEN}" > ~/.gem/credentials

data/scripts/publish.sh

@@ -6,7 +6,7 @@ usage() { echo "Required env var '$1' is missing"; exit 1; }
 
 [ -z "${ARTIFACT_REPOSITORY_TOKEN}" ] && usage "ARTIFACT_REPOSITORY_TOKEN" ;
 
-export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
+export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")}
 
 docker-compose build && \
 docker-compose run assemble && \

data/scripts/run-tests-e2e.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
+export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")}
 
 docker-compose build test-e2e && \
 docker-compose run test-e2e

data/scripts/test/run.sh

@@ -4,10 +4,10 @@ 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"
+VERSION=0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")
+grep -rl 0.0.1.alpha202204221804 . | xargs sed -i "s/0.0.1.alpha202204221804/$VERSION/g"
 
 bundle install
 
 echo "Running tests"
-bundle exec rspec ./spec/*.rb
+bundle exec rspec -f documentation ./spec/*.rb

data/scripts/test-e2e/run.sh

@@ -27,4 +27,4 @@ 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
+bundle exec rspec -f documentation ./spec/*.rb

data/spec/test_aliases_api_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 require 'securerandom'
-require 'vgs'
+require 'vgs_api_client'
 
 describe 'AliasesApiSpec' do
   before(:all) do

data/test.rb

@@ -0,0 +1,93 @@
+require 'vgs'
+
+# Defining the host is optional and defaults to https://api.sandbox.verygoodvault.com.
+# For production use https://api.live.verygoodvault.com
+config = VGS.config(
+  host = "https://api.sandbox.verygoodvault.com",
+  username = ENV["VAULT_API_USERNAME"],
+  password = ENV["VAULT_API_PASSWORD"]
+)
+
+# in this example we are storing three tokens within your VGS vault using a single API call
+# this will return three tokens which can be stored in your system and used individually or together
+# through any VGS Vault product including our Zero Data platform.
+#
+# the aliases namespace allows you to directly store, manage, and
+# retrieve tokens from your vgs vault.
+#
+# in the below example we demonstrate how to store payment card and personally identifiable
+# information in a single API call.
+#
+# see https://www.verygoodsecurity.com/docs/vault/what-is-zero-data
+# to learn how to remove any servers handling sentistive information
+# 100% from pci scope.
+
+api = VGS::Aliases.new(config)
+
+# first, let's create a request payload to tokenize our sensitive data.
+data = [
+  # credit card
+  dict(
+    # format is used to determine how the stored token is represented
+    # see https://www.verygoodsecurity.com/docs/terminology/nomenclature#alias-formats
+    # to learn about different formats and representations available
+    # to tokenize secured data.
+    :format => "PFPT",
+    :value => "4111111111111111",
+    # see https://www.verygoodsecurity.com/docs/vault/concepts#classifiers
+    # to learn how to classify and tag your data to help secure access and
+    # route data compliantly.
+    :classifiers => ["credit-card", "number"],
+    :storage => "PERSISTENT"
+  ),
+  # card security code
+  dict(
+    :format => "UUID",
+    :value => "123",
+    :classifiers => ["credit-card", "csc"],
+    # learn how volatile storage allows you to maintain full pci compliance
+    # https://www.verygoodsecurity.com/docs/terminology/nomenclature#storage
+    :storage => "VOLATILE"
+  ),
+  # social security number
+  dict(
+    :format => "UUID",
+    :value => "078-05-1120",
+    :classifiers => ["pii", "ssn"]
+  )
+]
+puts "Tokenizing multiple values..."
+
+aliases = api.redact(data)
+
+puts "Tokens created #{aliases}"
+
+# example of how to find the alias associated to each value
+puts aliases.map { |record| record.aliases[0]._alias }
+
+
+# next, let's update the classifiers and re-alias
+first_alias = aliases[0].aliases[0]._alias
+
+api.update(first_alias, { :classifiers => ["bank-account", "test-tag"] })
+
+puts "Token #{first_alias} updated"
+
+# now let's retrieve it back
+revealed = api.reveal(first_alias)
+
+puts "Token #{first_alias} retrieved\n{revealed}"
+
+# finally, let's delete an alias
+api.delete(first_alias)
+
+puts "Token #{first_alias} deleted"
+
+# now let's fetch it back to ensure it's not usable.
+puts "Trying to retrieve deleted token #{first_alias}..."
+begin
+  api.reveal(first_alias)
+rescue => error
+  puts "We can no longer fetch the token, it has been deleted: #{error.message}"
+end
+

data/vgs_api_client.gemspec

@@ -1,32 +1,26 @@
 # -*- 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.license     = "BSD"
   s.required_ruby_version = ">= 2.4"
 
+  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'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'

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.alpha202204221804
 platform: ruby
 authors:
 - Very Good Security
@@ -52,18 +52,20 @@ 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: []
 files:
 - DEVELOPMENT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - RELEASE.md
 - Rakefile
+- datadog.rb
 - docker-compose.yaml
-- lib/vgs.rb
+- lib/version.rb
 - lib/vgs_api_client.rb
 - lib/vgs_api_client/api/aliases_api.rb
 - lib/vgs_api_client/api_client.rb
@@ -98,11 +100,16 @@ files:
 - spec/configuration_spec.rb
 - spec/spec_helper.rb
 - spec/test_aliases_api_spec.rb
+- test.rb
 - vgs_api_client.gemspec
-homepage: https://openapi-generator.tech
+homepage: https://github.com/verygoodsecurity/vgs-api-client-ruby
 licenses:
-- Unlicense
-metadata: {}
+- BSD
+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:
@@ -121,7 +128,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