security_client 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5d414ee4d64b1d5d83dce94954ac9e277bceeaa78acf629de189d53efcaffeb7
4
- data.tar.gz: b3f078e1b935ded80a33beb8f25340913cba7128d24bdd31eaca723a502b42ab
3
+ metadata.gz: 6ba34b89c38cbeec82bd31c16e69fd4a71b113dae0731d776de0afea82c89252
4
+ data.tar.gz: '08ba3f1263e955dae3480a580120b0930428ac1c9b28e2acd167f090eb3fe5c8'
5
5
  SHA512:
6
- metadata.gz: 01765f4d12333752073394d11530affc49163e48118aee5866bd2cc17a7eef2947adfa77f38fa2cf7a4aa18ce7c31ee39e21fa8873adfb268de65ac3a96dee70
7
- data.tar.gz: 67975fedd2e1a69b906a8d0c4c2e1609694d5c77e460eb62dc9403577aeace82a8ac678e6367735963dcc0c23bc0b79d2448e3bcbd4990951507b4e4009df109
6
+ metadata.gz: 3b98a62e29222c6acabc41a13653f3b102f98859eb340cd69b1ba7b2728c6fc23891b5d0d3df0a84999a5abe69e547dce628cdd8722c6d0c9a397b4555c532d4
7
+ data.tar.gz: ba7b5c6eb6cae8a6fbd289db8cf78884a9e86ddaf24fc70b1cae8d9eece4c3df52abb125af2eb796d0fb87b63c97340a42da96f424ca816e9bd36f0f9189b5b5
data/README.md CHANGED
@@ -22,7 +22,67 @@ Or install it yourself as:
22
22
 
23
23
  ## Usage
24
24
 
25
- TODO: Write usage instructions here
25
+ ```ruby
26
+ # Initialize the Client
27
+ client = SecurityClient::Voltron.new(
28
+ access_key_id: 'Your access key',
29
+ secret_signing_key: 'Your secret signing key',
30
+ secret_crypto_access_key: 'Your secret crypto access key',
31
+ host: 'Your host'
32
+ )
33
+
34
+ # Simple Encryption
35
+ encrypted_result = client.encrypt(
36
+ uses: 'Key Uses',
37
+ data: 'Data to be encrypted'
38
+ )
39
+
40
+ # Simple Decryption
41
+ original_data = client.decrypt(
42
+ data: 'Encrypted Data'
43
+ )
44
+
45
+ # Piecewise Encryption
46
+ # Get your credentials ready
47
+ credentials = OpenStruct.new(
48
+ access_key_id: 'Your access key',
49
+ secret_signing_key: 'Your secret signing key',
50
+ secret_crypto_access_key: 'Your secret crypto access key',
51
+ host: 'Your host'
52
+ )
53
+
54
+ # Build the encryption object
55
+ enc = SecurityClient::Encryption.new(credentials, uses)
56
+ # Begin the encryption
57
+ enc.begin()
58
+ # Update the cipher with the raw data, can be supplied directly or in chunks
59
+ enc.update(data)
60
+ # End the encryption
61
+ enc.end()
62
+ # Reset the encryption object to initial state and cleanup the memory in use
63
+ enc.close()
64
+
65
+ # Piecewise Decryption
66
+ # Get your credentials ready
67
+ credentials = OpenStruct.new(
68
+ access_key_id: 'Your access key',
69
+ secret_signing_key: 'Your secret signing key',
70
+ secret_crypto_access_key: 'Your secret crypto access key',
71
+ host: 'Your host'
72
+ )
73
+
74
+ # Build the decryption object
75
+ dec = SecurityClient::Decryption.new(credentials)
76
+ # Begin the decryption
77
+ dec.begin()
78
+ # Update the cipher with the raw data, can be supplied directly or in chunks
79
+ dec.update(data)
80
+ # End the decryption
81
+ dec.end()
82
+ # Reset the decryption object to initial state and cleanup the memory in use
83
+ dec.close()
84
+
85
+ ```
26
86
 
27
87
  ## Development
28
88
 
@@ -1,3 +1,3 @@
1
1
  module SecurityClient
2
- VERSION = "0.1.3"
2
+ VERSION = "0.1.4"
3
3
  end
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
9
9
  spec.email = ["vinay.ymca@gmail.com"]
10
10
 
11
11
  spec.summary = %q{Ubiq Security ruby client}
12
-
12
+ spec.homepage = "https://github.com/vinaymehta/security_client"
13
13
  # Specify which files should be added to the gem when it is released.
14
14
  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
15
15
  spec.files = `git ls-files -z`.split("\x0").reject do |f|
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: security_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - vinaymehta
@@ -70,7 +70,7 @@ files:
70
70
  - lib/security_client.rb
71
71
  - lib/security_client/version.rb
72
72
  - security_client.gemspec
73
- homepage:
73
+ homepage: https://github.com/vinaymehta/security_client
74
74
  licenses: []
75
75
  metadata: {}
76
76
  post_install_message: