ruby-safenet 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3da1bbf0bd8ef4702c376d3a285b747da5ebe8d6
-  data.tar.gz: 0a2c39886bf3935eb36f7bcd11ddffeabcb4e223
+  metadata.gz: 4d8672d7bee04b6dc531d7b333157ec41ea7eb4a
+  data.tar.gz: 07e73624093f756e27961f46df9bb8371a63ad92
 SHA512:
-  metadata.gz: ed01af92d3c24a9330a176339af88f1519da6dc4b5aa5be1fc84b23aaff6c558a329bee7ec2259f9132ffadfb1bff74deaf76935b117f5321a53cd20b09f1f0b
-  data.tar.gz: 5c672bfa76fec86cb219b619f0f315f259c99c47cd74d9386291963f45296fb1db72a07f22dabca81748d73019659708c30d03fb4ede0e0bef714b0242c9b980
+  metadata.gz: 07442a257f9a0bbe5e52c77cce19656074fb1de846beead178dc0f97ce106246e6df57666b7b885a00a7028d9d62da8a3d9af4c4bd33cfbc6c5a21f6410a0e75
+  data.tar.gz: 9f8c5050b9248d2067e5debf8efa0d03b702b950d8386361ceb36f84a86f49715bdef3947c42b5375c59e3ca1814e91fa20603191601d749b8e627cbb546cbb3

data/README.md

@@ -51,10 +51,27 @@ my_client.nfs.get_directory("/mydir")["files"].each do |file|
 end
 ```
 
+## Structured Data (SD): **EMULATED**
+SD's have not been officially implemented by MaidSafe, but we provide a sub-module (sd) that emulates it.
+All the information are stored in the Safe Network, through DNS/NFS sub-systems.
+
+Example:
+```ruby
+my_client.sd.create(37267, 102, "Hello World") # 37267 = id, 102 = tag_type
+my_client.sd.get(37267, 102)
+my_client.sd.update(37267, 102, "Hello World!")
+```
+
+For more information see:
+https://github.com/maidsafe/rfcs/blob/master/proposed/0028-launcher-low-level-api/0028-launcher-low-level-api.md
+
 ## Supported methods:
 |Module|Method|Arguments|Optional|Doc|
 |------|------|---------|--------|---|
-|nfs|create_directory|dir_path|is_private, is_versioned, is_path_shared|Reference: https://maidsafe.readme.io/docs/nfs-create-directory|
+|sd|create|id, tag_type, contents|||
+|sd|update|id, tag_type, contents|||
+|sd|get|id, tag_type|||
+|nfs|create_directory|dir_path|is_private, is_versioned, is_path_shared|https://maidsafe.readme.io/docs/nfs-create-directory|
 |nfs|get_directory|dir_path|is_path_shared|https://maidsafe.readme.io/docs/nfs-get-directory|
 |nfs|delete_directory|dir_path|is_path_shared|https://maidsafe.readme.io/docs/nfs-create-directory|
 |nfs|file|file_path|is_private, is_versioned, is_path_shared|https://maidsafe.readme.io/docs/nfsfile|

data/lib/safenet.rb

@@ -13,7 +13,7 @@ require "cgi" # CGI.escape method
 module SafeNet
 
   class Client
-    attr_reader :auth, :nfs, :dns, :app_info, :key_helper
+    attr_reader :auth, :nfs, :dns, :sd, :app_info, :key_helper
 
     def initialize(options = {})
       @app_info = defaults()
@@ -22,6 +22,7 @@ module SafeNet
       @auth = SafeNet::Auth.new(self)
       @nfs = SafeNet::NFS.new(self)
       @dns = SafeNet::DNS.new(self)
+      @sd = SafeNet::SD.new(self)
     end
 
     def set_app_info(options = {})
@@ -545,7 +546,7 @@ module SafeNet
 
     # https://maidsafe.readme.io/docs/dns-get-file-unauth
     # get_file_unauth("thegoogle", "www", "index.html", offset: 3, length: 5)
-    def self.get_file_unauth(long_name, service_name, file_path, options = {})
+    def get_file_unauth(long_name, service_name, file_path, options = {})
       # default values
       options[:offset] = 0 if ! options.has_key?(:offset)
 
@@ -566,4 +567,33 @@ module SafeNet
       res.code == "200" ? res.body : JSON.parse(res.body)
     end
   end
+
+  class SD
+    def initialize(client_obj)
+      @client = client_obj
+    end
+
+    def create(id, tag_type, contents)
+      version = 1
+      new_id = Digest::SHA2.new(512).hexdigest("#{id}#{tag_type}")
+      res = @client.nfs.create_directory("/#{new_id}", is_private: false) == true
+      res &&= @client.nfs.file("/#{new_id}/data.#{version}", is_private: false) == true
+      res &&= @client.nfs.update_file_content("/#{new_id}/data.#{version}", contents) == true
+      res &&= @client.dns.register_service("#{new_id}", "sd", "/#{new_id}") == true
+      res
+    end
+
+    def update(id, tag_type, contents)
+      version = 1
+      new_id = Digest::SHA2.new(512).hexdigest("#{id}#{tag_type}")
+      res = @client.nfs.update_file_content("/#{new_id}/data.#{version}", contents) == true
+      res
+    end
+
+    def get(id, tag_type)
+      version = 1
+      new_id = Digest::SHA2.new(512).hexdigest("#{id}#{tag_type}")
+      @client.dns.get_file_unauth("#{new_id}", "sd", "data.#{version}")
+    end
+  end
 end

data/lib/safenet/version.rb

@@ -1,3 +1,3 @@
 module Safenet
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

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