security_client 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d414ee4d64b1d5d83dce94954ac9e277bceeaa78acf629de189d53efcaffeb7
-  data.tar.gz: b3f078e1b935ded80a33beb8f25340913cba7128d24bdd31eaca723a502b42ab
+  metadata.gz: 6ba34b89c38cbeec82bd31c16e69fd4a71b113dae0731d776de0afea82c89252
+  data.tar.gz: '08ba3f1263e955dae3480a580120b0930428ac1c9b28e2acd167f090eb3fe5c8'
 SHA512:
-  metadata.gz: 01765f4d12333752073394d11530affc49163e48118aee5866bd2cc17a7eef2947adfa77f38fa2cf7a4aa18ce7c31ee39e21fa8873adfb268de65ac3a96dee70
-  data.tar.gz: 67975fedd2e1a69b906a8d0c4c2e1609694d5c77e460eb62dc9403577aeace82a8ac678e6367735963dcc0c23bc0b79d2448e3bcbd4990951507b4e4009df109
+  metadata.gz: 3b98a62e29222c6acabc41a13653f3b102f98859eb340cd69b1ba7b2728c6fc23891b5d0d3df0a84999a5abe69e547dce628cdd8722c6d0c9a397b4555c532d4
+  data.tar.gz: ba7b5c6eb6cae8a6fbd289db8cf78884a9e86ddaf24fc70b1cae8d9eece4c3df52abb125af2eb796d0fb87b63c97340a42da96f424ca816e9bd36f0f9189b5b5

data/README.md

@@ -22,7 +22,67 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  # Initialize the Client
+  client = SecurityClient::Voltron.new(
+    access_key_id: 'Your access key',
+    secret_signing_key: 'Your secret signing key',
+    secret_crypto_access_key: 'Your secret crypto access key',
+    host: 'Your host'
+  )
+
+  # Simple Encryption
+  encrypted_result = client.encrypt(
+    uses: 'Key Uses',
+    data: 'Data to be encrypted'
+  )
+
+  # Simple Decryption
+  original_data = client.decrypt(
+    data: 'Encrypted Data'
+  )
+
+  # Piecewise Encryption
+    # Get your credentials ready
+    credentials = OpenStruct.new(
+      access_key_id: 'Your access key',
+      secret_signing_key: 'Your secret signing key',
+      secret_crypto_access_key: 'Your secret crypto access key',
+      host: 'Your host'
+    )
+
+    # Build the encryption object
+    enc = SecurityClient::Encryption.new(credentials, uses)
+    # Begin the encryption
+    enc.begin()
+    # Update the cipher with the raw data, can be supplied directly or in chunks
+    enc.update(data)
+    # End the encryption
+    enc.end()
+    # Reset the encryption object to initial state and cleanup the memory in use
+    enc.close()
+
+  # Piecewise Decryption
+    # Get your credentials ready
+    credentials = OpenStruct.new(
+      access_key_id: 'Your access key',
+      secret_signing_key: 'Your secret signing key',
+      secret_crypto_access_key: 'Your secret crypto access key',
+      host: 'Your host'
+    )
+
+    # Build the decryption object
+    dec = SecurityClient::Decryption.new(credentials)
+    # Begin the decryption
+    dec.begin()
+    # Update the cipher with the raw data, can be supplied directly or in chunks
+    dec.update(data)
+    # End the decryption
+    dec.end()
+    # Reset the decryption object to initial state and cleanup the memory in use
+    dec.close()
+
+```
 
 ## Development
 

data/lib/security_client/version.rb

@@ -1,3 +1,3 @@
 module SecurityClient
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/security_client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["vinay.ymca@gmail.com"]
 
   spec.summary       = %q{Ubiq Security ruby client}
-
+  spec.homepage      = "https://github.com/vinaymehta/security_client"
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: security_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - vinaymehta
@@ -70,7 +70,7 @@ files:
 - lib/security_client.rb
 - lib/security_client/version.rb
 - security_client.gemspec
-homepage:
+homepage: https://github.com/vinaymehta/security_client
 licenses: []
 metadata: {}
 post_install_message: