ruby-safenet 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d19872be0e8e5b424ad1d294cb7e1995ef94e5fb
-  data.tar.gz: ee22a0a1939f51c5f5cca9286432511c5bb51035
+  metadata.gz: 974008fc8230e6155b425d997bb8a305dcd8537e
+  data.tar.gz: 1183766c5674d6f23291a8e2a4259b68a120c10e
 SHA512:
-  metadata.gz: fd9425061291ce3644048530842316121962937b4413810d0bfca1f273623b2149b067a9439fe7fdff97893c8feee6f7a2361f77db0eac7bda46b314b77176ee
-  data.tar.gz: 041aa3a0e7e08cf270ad3bb4e93f9248d0f3fa412e5376d9db78da914a8597c48e0e5f22470ce65f14242e53c6cac68fa3c86b3d049f33977a0d37f7bb863b33
+  metadata.gz: 5eccd278929da2180b8e7da31eb8efe53cf6711eef128dcd7ac31ff167c9f9691798ea1dc3d4cc8cd258c1a8e0e311e3afe27142126a70dbbfbdcc48c50edccf
+  data.tar.gz: a3910ea35830bdde568de7d1f05ef67d40e6ab26c5607f6013f76fab5f860cb824dd7e07e7032491e1bd80deba9910979b1367211f6addfdf12bc8b52bb8d0bd

data/README.md

@@ -51,7 +51,19 @@ safe.nfs.get_directory("/mydir")["files"].each do |file|
 end
 ```
 
-## Structured Data (SD):
+## Structured Data (SD) - With helpers:
+
+```ruby
+safe = SafeNet::quick_start
+
+safe.sd.create('my_sd', 'Hello SD!')
+puts safe.sd.read('my_sd') # Hello SD!
+
+safe.sd.update('my_sd', 'Hello SD 2!')
+puts safe.sd.read('my_sd') # Hello SD 2!
+```
+
+## Structured Data (SD) - With safe primitives:
 
 ```ruby
 # client
@@ -61,8 +73,8 @@ safe = SafeNet::Client.new(permissions: ["LOW_LEVEL_API"])
 hnd_cipher = safe.cipher.get_handle
 
 # create
-name = SafeNet::s2h("my_sd")
-hnd = safe.sd.create(name, 500, hnd_cipher, IO.binread("#{Rails.root}/my_file.txt"))
+name = SafeNet::s2b('my_sd')
+hnd = safe.sd.create_sd(name, 500, hnd_cipher, IO.binread("#{Rails.root}/my_file.txt"))
 safe.sd.put(hnd) # saves on the network
 safe.sd.drop_handle(hnd) # release handler
 
@@ -70,16 +82,29 @@ safe.sd.drop_handle(hnd) # release handler
 safe.cipher.drop_handle(hnd_cipher)
 
 # read
-name = SafeNet::s2h("my_sd")
+name = SafeNet::s2b('my_sd')
 hnd_sd_data_id = safe.data_id.get_data_id_sd(name)
 hnd_sd = safe.sd.get_handle(hnd_sd_data_id)['handleId']
-contents = safe.sd.read(hnd_sd)
+contents = safe.sd.read_data(hnd_sd)
 safe.sd.drop_handle(hnd_sd)
 safe.data_id.drop_handle(hnd_sd_data_id)
 puts contents # print SD contents on screen
 ```
 
-## Immutable Data:
+## Immutable Data - With helpers:
+```ruby
+# client
+safe = SafeNet::quick_start
+
+# write
+name = safe.immutable.write('Hello SD')
+puts "Immutable name:\n  * Binary: #{name}\n  * Hex...: #{name.unpack("H*").first}\n  * Base64: #{Base64.encode64(name)}"
+
+# read
+puts safe.immutable.read(name)
+```
+
+## Immutable Data - With safe primitives:
 
 ```ruby
 # client
@@ -95,12 +120,15 @@ hnd_data_id = safe.immutable.close_writer(hnd_w, hnd_cipher)
 name = safe.data_id.serialize(hnd_data_id) # IMMUTABLE NAME
 safe.immutable.drop_writer_handle(hnd_w)
 safe.data_id.drop_handle(hnd_data_id)
-puts "Immutable name: #{name}"
+puts "Immutable name:\n  * Binary: #{name}\n  * Hex...: #{name.unpack("H*").first}\n  * Base64: #{Base64.encode64(name)}"
+
+# release cipher handler
+safe.cipher.drop_handle(hnd_cipher)
 
 # read
 hnd_data_id = safe.data_id.deserialize(name)
 hnd_r = safe.immutable.get_reader_handle(hnd_data_id)
-contents = safe.immutable.read(hnd_r)
+contents = safe.immutable.read_data(hnd_r)
 safe.immutable.drop_reader_handle(hnd_r)
 safe.data_id.drop_handle(hnd_data_id)
 puts contents
@@ -111,13 +139,13 @@ max_chunk_size = 100_000
 
 hnd_data_id = safe.data_id.deserialize(name)
 hnd_r = safe.immutable.get_reader_handle(hnd_data_id)
-contents = safe.immutable.read(hnd_r, "bytes=#{chunk_pos}-#{chunk_pos+max_chunk_size}")
+contents = safe.immutable.read_data(hnd_r, "bytes=#{chunk_pos}-#{chunk_pos+max_chunk_size}")
 safe.immutable.drop_reader_handle(hnd_r)
 safe.data_id.drop_handle(hnd_data_id)
 puts contents
 ```
 
-<!-- id = SafeNet.s2h("my_sd")
+<!-- id = SafeNet.s2b('my_sd')
 safe.sd.update(id, 500, "Hi John")
 safe.sd.get(id, 500)
 safe.sd.update(id, 500, "Hello World!") -->

data/lib/safenet.rb

@@ -838,7 +838,7 @@ module SafeNet
       @client = client_obj
     end
 
-    def create(name, type_tag = 500, hnd_cipher_opts = nil, data = nil, version = 0)
+    def create_sd(name, type_tag = 500, hnd_cipher_opts = nil, data = nil, version = 0)
       # Entry point
       url = "#{@client.app_info[:launcher_server]}#{API_VERSION}/structured-data"
 
@@ -934,7 +934,7 @@ module SafeNet
       JSON.parse(res.body)
     end
 
-    def read(handle_id, version = nil)
+    def read_data(handle_id, version = nil)
       # entry point
       url = "#{@client.app_info[:launcher_server]}#{API_VERSION}/structured-data/#{handle_id}"
       url = "#{url}/#{version}?" if ! version.nil?
@@ -960,6 +960,52 @@ module SafeNet
       res = http.request(req)
       res.code == "200" ? true : JSON.parse(res.body)
     end
+
+    def create(name, contents, type = 500)
+      name = name.is_a?(String) ? SafeNet::s2b(name) : name
+
+      # plain (not encrypted)
+      hnd_cipher = @client.cipher.get_handle
+
+      # create
+      hnd = @client.sd.create_sd(name, type, hnd_cipher, contents)
+      res = @client.sd.put(hnd) # saves on the network
+      @client.sd.drop_handle(hnd) # release handler
+
+      # release cipher handler
+      @client.cipher.drop_handle(hnd_cipher)
+
+      res
+    end
+
+    def read(name, type = 500)
+      name = name.is_a?(String) ? SafeNet::s2b(name) : name
+
+      hnd_sd_data_id = @client.data_id.get_data_id_sd(name)
+      hnd_sd = @client.sd.get_handle(hnd_sd_data_id)['handleId']
+      contents = @client.sd.read_data(hnd_sd)
+      @client.sd.drop_handle(hnd_sd)
+      @client.data_id.drop_handle(hnd_sd_data_id)
+
+      contents
+    end
+
+    def update(name, contents, type = 500)
+      name = name.is_a?(String) ? SafeNet::s2b(name) : name
+
+      # plain (not encrypted)
+      hnd_cipher = @client.cipher.get_handle
+
+      # create
+      hnd = @client.sd.create_sd(name, type, hnd_cipher, contents)
+      res = @client.sd.post(hnd) # saves on the network
+      @client.sd.drop_handle(hnd) # release handler
+
+      # release cipher handler
+      @client.cipher.drop_handle(hnd_cipher)
+
+      res
+    end
   end
 
   class Immutable
@@ -996,7 +1042,7 @@ module SafeNet
     end
 
     # eg range: "bytes=0-1000"
-    def read(handle_id, range = nil)
+    def read_data(handle_id, range = nil)
       # entry point
       url = "#{@client.app_info[:launcher_server]}#{API_VERSION}/immutable-data/#{handle_id}"
 
@@ -1070,6 +1116,40 @@ module SafeNet
       res = http.request(req)
       res.code == "200" ? true : JSON.parse(res.body)
     end
+
+    # helper
+    def write(contents)
+      # plain (not encrypted)
+      hnd_cipher = @client.cipher.get_handle
+
+      # write
+      hnd_w = @client.immutable.get_writer_handle
+      @client.immutable.write_data(hnd_w, contents)
+      hnd_data_id = @client.immutable.close_writer(hnd_w, hnd_cipher)
+      name = @client.data_id.serialize(hnd_data_id)
+      @client.immutable.drop_writer_handle(hnd_w)
+      @client.data_id.drop_handle(hnd_data_id)
+
+      # release cipher handler
+      @client.cipher.drop_handle(hnd_cipher)
+
+      name
+    end
+
+    # helper
+    def read(name, chunk_pos = nil, max_chunk_size = 1_000_000)
+      hnd_data_id = @client.data_id.deserialize(name)
+      hnd_r = @client.immutable.get_reader_handle(hnd_data_id)
+      contents = if chunk_pos
+        @client.immutable.read_data(hnd_r, "bytes=#{chunk_pos}-#{chunk_pos+max_chunk_size}")
+      else
+        @client.immutable.read_data(hnd_r)
+      end
+      @client.immutable.drop_reader_handle(hnd_r)
+      @client.data_id.drop_handle(hnd_data_id)
+
+      contents
+    end
   end
 
   class Cipher
@@ -1204,8 +1284,29 @@ module SafeNet
 
   end
 
-  def self.s2h(str)
+  def self.quick_start(low_level_api = true, safe_drive_access = true)
+    permissions = []
+    permissions << 'LOW_LEVEL_API' if low_level_api
+    permissions << 'SAFE_DRIVE_ACCESS' if safe_drive_access
+    SafeNet::Client.new(permissions: permissions)
+  end
+
+  def self.s2b(str)
     # Digest::SHA2.new(256).hexdigest(str)
     Digest::SHA2.new(256).base64digest(str)
   end
+
+  def self.bin_name(str)
+    BinName.new(str)
+  end
+
+  class BinName
+    def initializer(str)
+      @value = str
+    end
+
+    def to_s
+      @value
+    end
+  end
 end

data/lib/safenet/version.rb

@@ -1,3 +1,3 @@
 module Safenet
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-safenet
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Daniel Loureiro