ruby-safenet 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 974008fc8230e6155b425d997bb8a305dcd8537e
-  data.tar.gz: 1183766c5674d6f23291a8e2a4259b68a120c10e
+  metadata.gz: 65eb893168713c7f73eb4215b249373a0bbf2b6a
+  data.tar.gz: 8c3409c023698747ec846be0f3af97ecca26ce84
 SHA512:
-  metadata.gz: 5eccd278929da2180b8e7da31eb8efe53cf6711eef128dcd7ac31ff167c9f9691798ea1dc3d4cc8cd258c1a8e0e311e3afe27142126a70dbbfbdcc48c50edccf
-  data.tar.gz: a3910ea35830bdde568de7d1f05ef67d40e6ab26c5607f6013f76fab5f860cb824dd7e07e7032491e1bd80deba9910979b1367211f6addfdf12bc8b52bb8d0bd
+  metadata.gz: 507e67bb1b94ef540de9ce2fddd16c827c2c26050afbf9db7e98c9ed225204eed87cd17aa9a5f8670c6becfec215ed83c0b93a844b031bbce31c8d67e1194e04
+  data.tar.gz: 0781b391ce210bb7177a0cba85c54c89c39d62f1c28c31312d4f8e28706cbd6f2af09e3ed0a2ff656e791371c1f321afe066d30c6e142b54c1992fe64ccc6b1c

data/README.md

@@ -20,7 +20,7 @@ safe.nfs.create_file("/mydir/index.html", "Hello world!<br>I'm a webpage :D")
 safe.dns.register_service("my-wonderful-app", "www", "/mydir")
 safe.nfs.get_file("/mydir/index.html")
 
-# Then, open http://www.my-wonderful-app.safenet/
+# Then, open safe://www.my-wonderful-app/
 ```
 
 You can also set a more detailed App info:
@@ -54,7 +54,7 @@ end
 ## Structured Data (SD) - With helpers:
 
 ```ruby
-safe = SafeNet::quick_start
+safe = safenet_quick
 
 safe.sd.create('my_sd', 'Hello SD!')
 puts safe.sd.read('my_sd') # Hello SD!
@@ -63,6 +63,20 @@ safe.sd.update('my_sd', 'Hello SD 2!')
 puts safe.sd.read('my_sd') # Hello SD 2!
 ```
 
+## Immutable Data - With helpers:
+```ruby
+# client
+safe = safenet_quick
+
+# write / read
+name = safe.immutable.create('Hello SD') # name = base64 encoded
+puts safe.immutable.read(name)
+
+# write from file
+name = safe.immutable.create_from_file("#{Rails.root}/my_file.txt")
+safe.immutable.dump(name, "#{Rails.root}/from_safenet.txt")
+```
+
 ## Structured Data (SD) - With safe primitives:
 
 ```ruby
@@ -91,19 +105,6 @@ safe.data_id.drop_handle(hnd_sd_data_id)
 puts contents # print SD contents on screen
 ```
 
-## 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
@@ -145,16 +146,6 @@ safe.data_id.drop_handle(hnd_data_id)
 puts contents
 ```
 
-<!-- id = SafeNet.s2b('my_sd')
-safe.sd.update(id, 500, "Hi John")
-safe.sd.get(id, 500)
-safe.sd.update(id, 500, "Hello World!") -->
-
-<!-- id = safe.immutable.create("Hello World!") # => "861844d6704e8573fec34d967e20bcfef3d424cf48be04e6dc08f2bd58c729743371015ead891cc3cf1c9d34b49264b510751b1ff9e537937bc46b5d6ff4ecc8"
-safe.immutable.create_from_file("/home/daniel/dog.jpg")
-safe.immutable.get(id) # => "Hello World!" -->
-```
-
 ## Supported methods:
 |Module|Method|Arguments|Optional|Doc|
 |------|------|---------|--------|---|

data/lib/safenet.rb

@@ -1006,6 +1006,16 @@ module SafeNet
 
       res
     end
+
+    def read_or_create(name, contents = '', type = 500)
+      sd = @client.sd.read(name)
+      if sd.is_a?(Hash) # doesn't exist
+        sd = contents
+        @client.sd.create(name, sd, type)
+      end
+
+      sd
+    end
   end
 
   class Immutable
@@ -1118,7 +1128,7 @@ module SafeNet
     end
 
     # helper
-    def write(contents)
+    def create(contents)
       # plain (not encrypted)
       hnd_cipher = @client.cipher.get_handle
 
@@ -1133,11 +1143,30 @@ module SafeNet
       # release cipher handler
       @client.cipher.drop_handle(hnd_cipher)
 
-      name
+      Base64.encode64(name).chomp
+    end
+
+    # helper
+    def create_from_file(path)
+      @client.immutable.create(IO.binread(path))
+    end
+
+    # helper
+    def dump(name, path)
+      contents = nil
+
+      File.open(path, "wb") do |file|
+        contents = @client.immutable.read(name)
+        file.write(contents)
+      end
+
+      contents.is_a?(Hash) ? contents : true
     end
 
     # helper
     def read(name, chunk_pos = nil, max_chunk_size = 1_000_000)
+      name = Base64.decode64(name)
+
       hnd_data_id = @client.data_id.deserialize(name)
       hnd_r = @client.immutable.get_reader_handle(hnd_data_id)
       contents = if chunk_pos
@@ -1281,14 +1310,6 @@ module SafeNet
       res = http.request(req)
       res.code == "200" ? JSON.parse(res.body)['handleId'] : JSON.parse(res.body)
     end
-
-  end
-
-  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)
@@ -1310,3 +1331,10 @@ module SafeNet
     end
   end
 end
+
+def safenet_quick(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

data/lib/safenet/version.rb

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

metadata

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