vgs_api_client 0.0.1.alpha202204221804 → 0.0.1.alpha202204222331

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -0
  3. data/lib/{vgs_api_client → openapi_client}/api/aliases_api.rb +0 -0
  4. data/lib/{vgs_api_client → openapi_client}/api_client.rb +1 -1
  5. data/lib/{vgs_api_client → openapi_client}/api_error.rb +0 -0
  6. data/lib/{vgs_api_client → openapi_client}/configuration.rb +0 -0
  7. data/lib/{vgs_api_client → openapi_client}/models/alias_format.rb +0 -0
  8. data/lib/{vgs_api_client → openapi_client}/models/api_error.rb +0 -0
  9. data/lib/{vgs_api_client → openapi_client}/models/create_aliases_request.rb +0 -0
  10. data/lib/{vgs_api_client → openapi_client}/models/create_aliases_request_new.rb +0 -0
  11. data/lib/{vgs_api_client → openapi_client}/models/create_aliases_request_reference.rb +0 -0
  12. data/lib/{vgs_api_client → openapi_client}/models/inline_response200.rb +0 -0
  13. data/lib/{vgs_api_client → openapi_client}/models/inline_response2001.rb +0 -0
  14. data/lib/{vgs_api_client → openapi_client}/models/inline_response201.rb +0 -0
  15. data/lib/{vgs_api_client → openapi_client}/models/inline_response_default.rb +0 -0
  16. data/lib/{vgs_api_client → openapi_client}/models/model_alias.rb +0 -0
  17. data/lib/{vgs_api_client → openapi_client}/models/revealed_data.rb +0 -0
  18. data/lib/{vgs_api_client → openapi_client}/models/update_alias_request.rb +0 -0
  19. data/lib/{vgs_api_client → openapi_client}/models/update_alias_request_data.rb +0 -0
  20. data/lib/{vgs_api_client → openapi_client}/version.rb +1 -1
  21. data/lib/openapi_client.rb +53 -0
  22. data/lib/version.rb +1 -1
  23. data/lib/vgs_api_client.rb +1 -23
  24. data/openapi_client.gemspec +38 -0
  25. data/scripts/assemble/run.sh +2 -2
  26. data/scripts/publish/run.sh +1 -1
  27. data/scripts/publish.sh +1 -1
  28. data/scripts/run-tests-e2e.sh +1 -1
  29. data/scripts/test/run.sh +2 -2
  30. data/spec/spec_helper.rb +1 -1
  31. data/spec/test_aliases_api_spec.rb +36 -44
  32. data/vgs_api_client.gemspec +2 -2
  33. metadata +24 -24
  34. data/Gemfile.lock +0 -70
  35. data/datadog.rb +0 -10
  36. data/test.rb +0 -93
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ad6f53cf37b26adf6ad0d2d8601bce2d3812dfd8f33f5956fb2bc7a1a0adedc6
4
- data.tar.gz: b1f5add24e6548547ffacda7cde9ebf25f2db4fcbe7f350b2fa8836efe93544e
3
+ metadata.gz: accb9960204c2fb676b087b2058d010bb91ebf79f52b9b499c8274af88e3d504
4
+ data.tar.gz: '09fdb9b31c256659c5ec9ffc95d558e1998627b1c62daa9b290d01af65282c6d'
5
5
  SHA512:
6
- metadata.gz: 0e24e515b39092e5027afa40defa1efb5c4162fbc9889118d9dcd114beb8b0fbdba030f181f4df81f7031d1e573f1743f2d7ed8e6e3057a255715c32bf91e967
7
- data.tar.gz: d738f6848d1e2e61bd074319153ecd7dd8646efa59f428f103e86a208e54762d4e7921ad95090d530bfb1fb60725cf8e5f8f7c2978d3e0de05bc8dec1f0bd9c3
6
+ metadata.gz: 8d8b2df4b825a2e03715ab0213f447976f686b7109dc54873e37899d9225b3d88f21015c814ca3bcf17638be8334c3b20874801b5f40ea1a66f6e1100f9a12b7
7
+ data.tar.gz: 03601153f237e61f623bd99a425b4b854302855dd98907e34cf0dc054cf856c435899233aecfd11a8dfe798475bff66f54259d0b8f0cb18bda05e582223feae2
data/README.md ADDED
@@ -0,0 +1,33 @@
1
+ # vgs-api-client-python
2
+
3
+ This repository contains a Ruby API client library for the Very Good Security API.
4
+
5
+ ### Requirements
6
+
7
+ Building and using the API client library requires Ruby 2.6+.
8
+
9
+ ### Installation
10
+
11
+ ```
12
+ gem install vgs-api-client
13
+ ```
14
+
15
+ ### Development
16
+
17
+ Follow [DEVELOPMENT](DEVELOPMENT.md) instruction.
18
+
19
+ ### Release
20
+
21
+ Follow [RELEASE](RELEASE.md) instruction.
22
+
23
+ ### Documentation
24
+
25
+ https://www.verygoodsecurity.com/docs/vault/api/
26
+
27
+ ### Tutorial
28
+
29
+ https://www.verygoodsecurity.com/docs/tokenization/ruby-tutorial
30
+
31
+ ### Support
32
+
33
+ support@verygoodsecurity.com
@@ -31,7 +31,7 @@ module VgsApiClient
31
31
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
32
  def initialize(config = Configuration.default)
33
33
  @config = config
34
- @user_agent = "vgs-api-client/0.0.1.alpha202204221804/ruby"
34
+ @user_agent = "vgs-api-client/0.0.1.alpha202204222331/ruby"
35
35
  @default_headers = {
36
36
  'Content-Type' => 'application/json',
37
37
  'User-Agent' => @user_agent
File without changes
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
11
11
  =end
12
12
 
13
13
  module VgsApiClient
14
- VERSION = '0.0.1.alpha202204221804'
14
+ VERSION = '0.0.1.alpha202204222331'
15
15
  end
@@ -0,0 +1,53 @@
1
+ =begin
2
+ #Vault HTTP API
3
+
4
+ #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\" } ] } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@verygoodsecurity.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ # Common files
14
+ require 'openapi_client/api_client'
15
+ require 'openapi_client/api_error'
16
+ require 'openapi_client/version'
17
+ require 'openapi_client/configuration'
18
+
19
+ # Models
20
+ require 'openapi_client/models/alias_format'
21
+ require 'openapi_client/models/api_error'
22
+ require 'openapi_client/models/create_aliases_request'
23
+ require 'openapi_client/models/create_aliases_request_new'
24
+ require 'openapi_client/models/create_aliases_request_reference'
25
+ require 'openapi_client/models/inline_response200'
26
+ require 'openapi_client/models/inline_response2001'
27
+ require 'openapi_client/models/inline_response201'
28
+ require 'openapi_client/models/inline_response_default'
29
+ require 'openapi_client/models/model_alias'
30
+ require 'openapi_client/models/revealed_data'
31
+ require 'openapi_client/models/update_alias_request'
32
+ require 'openapi_client/models/update_alias_request_data'
33
+
34
+ # APIs
35
+ require 'openapi_client/api/aliases_api'
36
+
37
+ module VgsApiClient
38
+ class << self
39
+ # Customize default settings for the SDK using block.
40
+ # VgsApiClient.configure do |config|
41
+ # config.username = "xxx"
42
+ # config.password = "xxx"
43
+ # end
44
+ # If no block given, return the default Configuration object.
45
+ def configure
46
+ if block_given?
47
+ yield(Configuration.default)
48
+ else
49
+ Configuration.default
50
+ end
51
+ end
52
+ end
53
+ end
data/lib/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module VGS
2
- VERSION = '0.0.1.alpha202204221804'
2
+ VERSION = '0.0.1.alpha202204222331'
3
3
  end
@@ -1,26 +1,4 @@
1
- # Common files
2
- require 'vgs_api_client/api_client'
3
- require 'vgs_api_client/api_error'
4
- require 'vgs_api_client/version'
5
- require 'vgs_api_client/configuration'
6
-
7
- # Models
8
- require 'vgs_api_client/models/alias_format'
9
- require 'vgs_api_client/models/api_error'
10
- require 'vgs_api_client/models/create_aliases_request'
11
- require 'vgs_api_client/models/create_aliases_request_new'
12
- require 'vgs_api_client/models/create_aliases_request_reference'
13
- require 'vgs_api_client/models/inline_response200'
14
- require 'vgs_api_client/models/inline_response2001'
15
- require 'vgs_api_client/models/inline_response201'
16
- require 'vgs_api_client/models/inline_response_default'
17
- require 'vgs_api_client/models/model_alias'
18
- require 'vgs_api_client/models/revealed_data'
19
- require 'vgs_api_client/models/update_alias_request'
20
- require 'vgs_api_client/models/update_alias_request_data'
21
-
22
- # APIs
23
- require 'vgs_api_client/api/aliases_api'
1
+ require 'openapi_client'
24
2
 
25
3
  module VGS
26
4
  class VgsApiException < StandardError
@@ -0,0 +1,38 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ =begin
4
+ #Vault HTTP API
5
+
6
+ #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\" } ] } ```
7
+
8
+ The version of the OpenAPI document: 1.0.0
9
+ Contact: support@verygoodsecurity.com
10
+ Generated by: https://openapi-generator.tech
11
+ OpenAPI Generator version: 5.4.0
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "openapi_client/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "openapi_client"
20
+ s.version = VgsApiClient::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["Very Good Security"]
23
+ s.email = ["support@verygoodsecurity.com"]
24
+ s.homepage = "https://openapi-generator.tech"
25
+ s.summary = "VGS Vault API"
26
+ s.description = "This gem maps to VGS Vault API"
27
+ s.license = "Unlicense"
28
+ s.required_ruby_version = ">= 2.4"
29
+
30
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
+
32
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
33
+
34
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
35
+ s.test_files = `find spec/*`.split("\n")
36
+ s.executables = []
37
+ s.require_paths = ["lib"]
38
+ end
@@ -1,9 +1,9 @@
1
1
  #!/bin/bash
2
2
 
3
- LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")}
3
+ LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
4
4
 
5
5
  # fix version
6
- grep -rl 0.0.1.alpha202204221804 . | xargs sed -i "s/0.0.1.alpha202204221804/${LIB_VERSION}/g"
6
+ grep -rl 0.0.1.alpha202204222331 . | xargs sed -i "s/0.0.1.alpha202204222331/${LIB_VERSION}/g"
7
7
 
8
8
  # build
9
9
  gem build vgs_api_client.gemspec
@@ -6,7 +6,7 @@ usage() { echo "Required env var '$1' is missing"; exit 1; }
6
6
 
7
7
  [ -z "${ARTIFACT_REPOSITORY_TOKEN}" ] && usage "ARTIFACT_REPOSITORY_TOKEN" ;
8
8
 
9
- LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")}
9
+ LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
10
10
 
11
11
  mkdir ~/.gem
12
12
  echo ":rubygems_api_key: ${ARTIFACT_REPOSITORY_TOKEN}" > ~/.gem/credentials
data/scripts/publish.sh CHANGED
@@ -6,7 +6,7 @@ usage() { echo "Required env var '$1' is missing"; exit 1; }
6
6
 
7
7
  [ -z "${ARTIFACT_REPOSITORY_TOKEN}" ] && usage "ARTIFACT_REPOSITORY_TOKEN" ;
8
8
 
9
- export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")}
9
+ export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
10
10
 
11
11
  docker-compose build && \
12
12
  docker-compose run assemble && \
@@ -2,7 +2,7 @@
2
2
 
3
3
  set -e
4
4
 
5
- export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")}
5
+ export LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
6
6
 
7
7
  docker-compose build test-e2e && \
8
8
  docker-compose run test-e2e
data/scripts/test/run.sh CHANGED
@@ -4,8 +4,8 @@ set -e
4
4
 
5
5
  echo "Installing lib from local sources"
6
6
  # fix version
7
- VERSION=0.0.1.alpha202204221804.alpha$(date "+%Y%m%d%H%M")
8
- grep -rl 0.0.1.alpha202204221804 . | xargs sed -i "s/0.0.1.alpha202204221804/$VERSION/g"
7
+ VERSION=0.0.1.alpha$(date "+%Y%m%d%H%M")
8
+ grep -rl 0.0.1.alpha202204222331 . | xargs sed -i "s/0.0.1.alpha202204222331/$VERSION/g"
9
9
 
10
10
  bundle install
11
11
 
data/spec/spec_helper.rb CHANGED
@@ -11,7 +11,7 @@ OpenAPI Generator version: 5.4.0
11
11
  =end
12
12
 
13
13
  # load the gem
14
- require 'vgs_api_client'
14
+ require 'openapi_client'
15
15
 
16
16
  # The following was generated by the `rspec --init` command. Conventionally, all
17
17
  # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -4,26 +4,24 @@ require 'vgs_api_client'
4
4
 
5
5
  describe 'AliasesApiSpec' do
6
6
  before(:all) do
7
- config = VGS.config(username = ENV["VAULT_API_USERNAME"], password = ENV["VAULT_API_PASSWORD"])
8
- @aliases_api = VGS::Aliases.new(config)
7
+ config = VGS.config(username = ENV['VAULT_API_USERNAME'], password = ENV['VAULT_API_PASSWORD'])
8
+ @aliases_api = VGS::Aliases.new config
9
9
  end
10
10
 
11
11
  describe 'redact' do
12
12
  it 'should redact values' do
13
- data = [
14
- {
15
- :format => 'UUID',
16
- :value => '5201784564572092',
17
- :classifiers => %w[credit-card number],
18
- :storage => 'PERSISTENT',
19
- },
20
- {
21
- :format => 'UUID',
22
- :value => 'Joe Doe',
23
- :storage => 'VOLATILE',
24
- }
25
- ]
26
- aliases = @aliases_api.redact(data)
13
+ data = [{
14
+ format: 'UUID',
15
+ value: '5201784564572092',
16
+ classifiers: %w[credit-card number],
17
+ storage: 'PERSISTENT'
18
+ },
19
+ {
20
+ format: 'UUID',
21
+ value: 'Joe Doe',
22
+ storage: 'VOLATILE'
23
+ }]
24
+ aliases = @aliases_api.redact data
27
25
  expect(aliases.length).to eq 2
28
26
  data.each_with_index do |item, index|
29
27
  expect(aliases[index].value).to eq item[:value]
@@ -37,22 +35,20 @@ describe 'AliasesApiSpec' do
37
35
 
38
36
  describe 'reveal' do
39
37
  it 'should reveal aliases' do
40
- data = [
41
- {
42
- :format => 'UUID',
43
- :value => '5201784564572092',
44
- :classifiers => %w[credit-card number],
45
- :storage => 'PERSISTENT',
46
- },
47
- {
48
- :format => 'UUID',
49
- :value => 'Joe Doe',
50
- :storage => 'VOLATILE',
51
- }
52
- ]
38
+ data = [{
39
+ format: 'UUID',
40
+ value: '5201784564572092',
41
+ classifiers: %w[credit-card number],
42
+ storage: 'PERSISTENT'
43
+ },
44
+ {
45
+ format: 'UUID',
46
+ value: 'Joe Doe',
47
+ storage: 'VOLATILE'
48
+ }]
53
49
  aliases = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }
54
50
 
55
- response = @aliases_api.reveal(aliases)
51
+ response = @aliases_api.reveal aliases
56
52
 
57
53
  expect(response.length).to eq 2
58
54
  original_values = data.map { |i| i[:value] }
@@ -63,15 +59,13 @@ describe 'AliasesApiSpec' do
63
59
 
64
60
  describe 'update' do
65
61
  it 'should update alias' do
66
- data = [
67
- {
68
- :format => 'UUID',
69
- :value => SecureRandom.alphanumeric(10),
70
- }
71
- ]
62
+ data = [{
63
+ format: 'UUID',
64
+ value: SecureRandom.alphanumeric(10)
65
+ }]
72
66
  _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
73
67
 
74
- @aliases_api.update(_alias = _alias, data = { :classifiers => ["secure"] })
68
+ @aliases_api.update _alias, classifiers: %w[secure]
75
69
 
76
70
  response = @aliases_api.reveal(_alias)
77
71
  expect(response[_alias].classifiers).to eq %w[secure]
@@ -80,15 +74,13 @@ describe 'AliasesApiSpec' do
80
74
 
81
75
  describe 'delete' do
82
76
  it 'should delete alias' do
83
- data = [
84
- {
85
- :format => 'UUID',
86
- :value => '5201784564572092',
87
- }
88
- ]
77
+ data = [{
78
+ format: 'UUID',
79
+ value: '5201784564572092'
80
+ }]
89
81
  _alias = @aliases_api.redact(data).map { |item| item.aliases[0]._alias }[0]
90
82
 
91
- @aliases_api.delete(_alias = _alias)
83
+ @aliases_api.delete _alias
92
84
 
93
85
  expect { @aliases_api.reveal(_alias) }.to raise_error(VGS::VgsApiException)
94
86
  end
@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
11
11
  s.homepage = "https://github.com/verygoodsecurity/vgs-api-client-ruby"
12
12
  s.summary = "VGS API Client"
13
13
  s.description = "This gem maps to VGS Vault API"
14
- s.license = "BSD"
15
- s.required_ruby_version = ">= 2.4"
14
+ s.license = "BSD 3-Clause Clear License"
15
+ s.required_ruby_version = ">= 2.6"
16
16
 
17
17
  s.metadata = {
18
18
  "homepage_uri" => "https://www.verygoodsecurity.com",
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vgs_api_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1.alpha202204221804
4
+ version: 0.0.1.alpha202204222331
5
5
  platform: ruby
6
6
  authors:
7
7
  - Very Good Security
@@ -59,32 +59,33 @@ extra_rdoc_files: []
59
59
  files:
60
60
  - DEVELOPMENT.md
61
61
  - Gemfile
62
- - Gemfile.lock
63
62
  - LICENSE
63
+ - README.md
64
64
  - RELEASE.md
65
65
  - Rakefile
66
- - datadog.rb
67
66
  - docker-compose.yaml
67
+ - lib/openapi_client.rb
68
+ - lib/openapi_client/api/aliases_api.rb
69
+ - lib/openapi_client/api_client.rb
70
+ - lib/openapi_client/api_error.rb
71
+ - lib/openapi_client/configuration.rb
72
+ - lib/openapi_client/models/alias_format.rb
73
+ - lib/openapi_client/models/api_error.rb
74
+ - lib/openapi_client/models/create_aliases_request.rb
75
+ - lib/openapi_client/models/create_aliases_request_new.rb
76
+ - lib/openapi_client/models/create_aliases_request_reference.rb
77
+ - lib/openapi_client/models/inline_response200.rb
78
+ - lib/openapi_client/models/inline_response2001.rb
79
+ - lib/openapi_client/models/inline_response201.rb
80
+ - lib/openapi_client/models/inline_response_default.rb
81
+ - lib/openapi_client/models/model_alias.rb
82
+ - lib/openapi_client/models/revealed_data.rb
83
+ - lib/openapi_client/models/update_alias_request.rb
84
+ - lib/openapi_client/models/update_alias_request_data.rb
85
+ - lib/openapi_client/version.rb
68
86
  - lib/version.rb
69
87
  - lib/vgs_api_client.rb
70
- - lib/vgs_api_client/api/aliases_api.rb
71
- - lib/vgs_api_client/api_client.rb
72
- - lib/vgs_api_client/api_error.rb
73
- - lib/vgs_api_client/configuration.rb
74
- - lib/vgs_api_client/models/alias_format.rb
75
- - lib/vgs_api_client/models/api_error.rb
76
- - lib/vgs_api_client/models/create_aliases_request.rb
77
- - lib/vgs_api_client/models/create_aliases_request_new.rb
78
- - lib/vgs_api_client/models/create_aliases_request_reference.rb
79
- - lib/vgs_api_client/models/inline_response200.rb
80
- - lib/vgs_api_client/models/inline_response2001.rb
81
- - lib/vgs_api_client/models/inline_response201.rb
82
- - lib/vgs_api_client/models/inline_response_default.rb
83
- - lib/vgs_api_client/models/model_alias.rb
84
- - lib/vgs_api_client/models/revealed_data.rb
85
- - lib/vgs_api_client/models/update_alias_request.rb
86
- - lib/vgs_api_client/models/update_alias_request_data.rb
87
- - lib/vgs_api_client/version.rb
88
+ - openapi_client.gemspec
88
89
  - scripts/assemble/Dockerfile
89
90
  - scripts/assemble/run.sh
90
91
  - scripts/publish.sh
@@ -100,11 +101,10 @@ files:
100
101
  - spec/configuration_spec.rb
101
102
  - spec/spec_helper.rb
102
103
  - spec/test_aliases_api_spec.rb
103
- - test.rb
104
104
  - vgs_api_client.gemspec
105
105
  homepage: https://github.com/verygoodsecurity/vgs-api-client-ruby
106
106
  licenses:
107
- - BSD
107
+ - BSD 3-Clause Clear License
108
108
  metadata:
109
109
  homepage_uri: https://www.verygoodsecurity.com
110
110
  bug_tracker_uri: https://github.com/verygoodsecurity/vgs-api-client-ruby/issues
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
118
118
  requirements:
119
119
  - - ">="
120
120
  - !ruby/object:Gem::Version
121
- version: '2.4'
121
+ version: '2.6'
122
122
  required_rubygems_version: !ruby/object:Gem::Requirement
123
123
  requirements:
124
124
  - - ">"
data/Gemfile.lock DELETED
@@ -1,70 +0,0 @@
1
- PATH
2
- remote: .
3
- specs:
4
- vgs_api_client (0.0.1.alpha202204221804)
5
- typhoeus (~> 1.0, >= 1.0.1)
6
-
7
- GEM
8
- remote: https://rubygems.org/
9
- specs:
10
- ast (2.4.2)
11
- byebug (11.1.3)
12
- coderay (1.1.3)
13
- diff-lcs (1.5.0)
14
- ethon (0.15.0)
15
- ffi (>= 1.15.0)
16
- ffi (1.15.5)
17
- jaro_winkler (1.5.4)
18
- method_source (1.0.0)
19
- parallel (1.22.1)
20
- parser (3.1.2.0)
21
- ast (~> 2.4.1)
22
- pry (0.13.1)
23
- coderay (~> 1.1)
24
- method_source (~> 1.0)
25
- pry-byebug (3.9.0)
26
- byebug (~> 11.0)
27
- pry (~> 0.13.0)
28
- psych (4.0.3)
29
- stringio
30
- rainbow (3.1.1)
31
- rake (13.0.6)
32
- rspec (3.11.0)
33
- rspec-core (~> 3.11.0)
34
- rspec-expectations (~> 3.11.0)
35
- rspec-mocks (~> 3.11.0)
36
- rspec-core (3.11.0)
37
- rspec-support (~> 3.11.0)
38
- rspec-expectations (3.11.0)
39
- diff-lcs (>= 1.2.0, < 2.0)
40
- rspec-support (~> 3.11.0)
41
- rspec-mocks (3.11.1)
42
- diff-lcs (>= 1.2.0, < 2.0)
43
- rspec-support (~> 3.11.0)
44
- rspec-support (3.11.0)
45
- rubocop (0.66.0)
46
- jaro_winkler (~> 1.5.1)
47
- parallel (~> 1.10)
48
- parser (>= 2.5, != 2.5.1.1)
49
- psych (>= 3.1.0)
50
- rainbow (>= 2.2.2, < 4.0)
51
- ruby-progressbar (~> 1.7)
52
- unicode-display_width (>= 1.4.0, < 1.6)
53
- ruby-progressbar (1.11.0)
54
- stringio (3.0.1)
55
- typhoeus (1.4.0)
56
- ethon (>= 0.9.0)
57
- unicode-display_width (1.5.0)
58
-
59
- PLATFORMS
60
- x86_64-darwin-21
61
-
62
- DEPENDENCIES
63
- pry-byebug
64
- rake (~> 13.0.1)
65
- rspec (~> 3.6, >= 3.6.0)
66
- rubocop (~> 0.66.0)
67
- vgs_api_client!
68
-
69
- BUNDLED WITH
70
- 2.3.11
data/datadog.rb DELETED
@@ -1,10 +0,0 @@
1
- require 'datadog_api_client'
2
-
3
- api_instance = DatadogAPIClient::V1::IPRangesAPI.new
4
-
5
- begin
6
- result = api_instance.get_ip_ranges
7
- p result
8
- rescue DatadogAPIClient::V1::APIError => e
9
- puts "Error when calling IPRangesAPI->get_ip_ranges: #{e}"
10
- end
data/test.rb DELETED
@@ -1,93 +0,0 @@
1
- require 'vgs'
2
-
3
- # Defining the host is optional and defaults to https://api.sandbox.verygoodvault.com.
4
- # For production use https://api.live.verygoodvault.com
5
- config = VGS.config(
6
- host = "https://api.sandbox.verygoodvault.com",
7
- username = ENV["VAULT_API_USERNAME"],
8
- password = ENV["VAULT_API_PASSWORD"]
9
- )
10
-
11
- # in this example we are storing three tokens within your VGS vault using a single API call
12
- # this will return three tokens which can be stored in your system and used individually or together
13
- # through any VGS Vault product including our Zero Data platform.
14
- #
15
- # the aliases namespace allows you to directly store, manage, and
16
- # retrieve tokens from your vgs vault.
17
- #
18
- # in the below example we demonstrate how to store payment card and personally identifiable
19
- # information in a single API call.
20
- #
21
- # see https://www.verygoodsecurity.com/docs/vault/what-is-zero-data
22
- # to learn how to remove any servers handling sentistive information
23
- # 100% from pci scope.
24
-
25
- api = VGS::Aliases.new(config)
26
-
27
- # first, let's create a request payload to tokenize our sensitive data.
28
- data = [
29
- # credit card
30
- dict(
31
- # format is used to determine how the stored token is represented
32
- # see https://www.verygoodsecurity.com/docs/terminology/nomenclature#alias-formats
33
- # to learn about different formats and representations available
34
- # to tokenize secured data.
35
- :format => "PFPT",
36
- :value => "4111111111111111",
37
- # see https://www.verygoodsecurity.com/docs/vault/concepts#classifiers
38
- # to learn how to classify and tag your data to help secure access and
39
- # route data compliantly.
40
- :classifiers => ["credit-card", "number"],
41
- :storage => "PERSISTENT"
42
- ),
43
- # card security code
44
- dict(
45
- :format => "UUID",
46
- :value => "123",
47
- :classifiers => ["credit-card", "csc"],
48
- # learn how volatile storage allows you to maintain full pci compliance
49
- # https://www.verygoodsecurity.com/docs/terminology/nomenclature#storage
50
- :storage => "VOLATILE"
51
- ),
52
- # social security number
53
- dict(
54
- :format => "UUID",
55
- :value => "078-05-1120",
56
- :classifiers => ["pii", "ssn"]
57
- )
58
- ]
59
- puts "Tokenizing multiple values..."
60
-
61
- aliases = api.redact(data)
62
-
63
- puts "Tokens created #{aliases}"
64
-
65
- # example of how to find the alias associated to each value
66
- puts aliases.map { |record| record.aliases[0]._alias }
67
-
68
-
69
- # next, let's update the classifiers and re-alias
70
- first_alias = aliases[0].aliases[0]._alias
71
-
72
- api.update(first_alias, { :classifiers => ["bank-account", "test-tag"] })
73
-
74
- puts "Token #{first_alias} updated"
75
-
76
- # now let's retrieve it back
77
- revealed = api.reveal(first_alias)
78
-
79
- puts "Token #{first_alias} retrieved\n{revealed}"
80
-
81
- # finally, let's delete an alias
82
- api.delete(first_alias)
83
-
84
- puts "Token #{first_alias} deleted"
85
-
86
- # now let's fetch it back to ensure it's not usable.
87
- puts "Trying to retrieve deleted token #{first_alias}..."
88
- begin
89
- api.reveal(first_alias)
90
- rescue => error
91
- puts "We can no longer fetch the token, it has been deleted: #{error.message}"
92
- end
93
-