ruby-safenet 0.0.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90946ad95b2eb47e5f0e1d89e46e3b826fcb76f5
-  data.tar.gz: b660969da66807f9cbe228d4a4150bf152b2441b
+  metadata.gz: 3da1bbf0bd8ef4702c376d3a285b747da5ebe8d6
+  data.tar.gz: 0a2c39886bf3935eb36f7bcd11ddffeabcb4e223
 SHA512:
-  metadata.gz: 171fcca1cb7dcf7f31d2760c70f19b3de3cba2d4d96abd4ecf47d1257419e1c4dad809b6886181c8796ab55d6d309cb60251b1a1a760ae5f9c42cd4efecde472
-  data.tar.gz: b7034064dd83d23b485634306cdc89ace5713796e163d24d3a024026bab323736aaa27459f4f9186732665780b21eae855247309594d9c4b4282232c28d76113
+  metadata.gz: ed01af92d3c24a9330a176339af88f1519da6dc4b5aa5be1fc84b23aaff6c558a329bee7ec2259f9132ffadfb1bff74deaf76935b117f5321a53cd20b09f1f0b
+  data.tar.gz: 5c672bfa76fec86cb219b619f0f315f259c99c47cd74d9386291963f45296fb1db72a07f22dabca81748d73019659708c30d03fb4ede0e0bef714b0242c9b980

data/README.md

@@ -1,6 +1,6 @@
 # Ruby-Safenet
 
-A Ruby library for accessing the SAFE network
+A simple SAFE API wrapper written in Ruby.
 
 ## Installation
 ```
@@ -12,37 +12,58 @@ A Ruby library for accessing the SAFE network
 ```ruby
 require "safenet"
 
-SafeNet.set_app_info({
+my_client = SafeNet::Client.new
+my_client.nfs.create_directory("/mydir", is_private: false)
+my_client.nfs.file("/mydir/index.html", is_private: false)
+my_client.nfs.update_file_content("/mydir/index.html", "Hello world!<br>I'm a webpage :D")
+my_client.dns.register_service("my-wonderful-app", "www", "/mydir")
+my_client.dns.get_file("/mydir/index.html")
+
+# Then, open http://www.my-wonderful-app.safenet/
+```
+
+You can also set a more detailed App info:
+```
+my_client = SafeNet::Client.new({
   name:      "Ruby Demo App",
   version:   "0.0.1",
   vendor:    "Vendor's Name",
   id:        "org.thevendor.demo",
 })
-
-SafeNet.create_directory("/mydir", is_private: false)
-SafeNet.file("/mydir/index.html", is_private: false)
-SafeNet.update_file_content("/mydir/index.html", "Hello world!<br>I'm a webpage :D")
-SafeNet.register_service("my-wonderful-app", "www", "/mydir")
-SafeNet.get_file("/mydir/index.html")
-
-# Then, open http://www.my-wonderful-app.safenet/
 ```
 
 *File Upload / Download:*
 ```ruby
 # upload
-SafeNet.file("/mydir/dog.jpg")
-SafeNet.update_file_content("/mydir/dog.jpg", File.read("/home/daniel/Pictures/dog.jpg"))
+my_client.nfs.file("/mydir/dog.jpg")
+my_client.nfs.update_file_content("/mydir/dog.jpg", File.read("/home/daniel/Pictures/dog.jpg"))
 
 # download
 File.open("/home/daniel/Pictures/dog-new.jpg", "w") do |file|
-  file.write(SafeNet.get_file("/mydir/dog.jpg"))
+  file.write(my_client.nfs.get_file("/mydir/dog.jpg"))
 end
 ```
 
 *Directory's file list:*
 ```ruby
-SafeNet.get_directory("/mydir")["files"].each do |file|
+my_client.nfs.get_directory("/mydir")["files"].each do |file|
   puts file["name"]
 end
 ```
+
+## 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|
+|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|
+|nfs|get_file|file_path|is_path_shared, offset, length|https://maidsafe.readme.io/docs/nfs-get-file|
+|nfs|update_file_content|file_path, contents|is_path_shared, offset|https://maidsafe.readme.io/docs/nfs-update-file-content|
+|nfs|delete_file|file_path|is_path_shared|https://maidsafe.readme.io/docs/nfs-delete-file|
+|dns|create_long_name|long_name||https://maidsafe.readme.io/docs/dns-create-long-name|
+|dns|register_service|long_name, service_name, service_home_dir_path|is_path_shared, metadata|https://maidsafe.readme.io/docs/dns-register-service|
+|dns|list_long_names||is_path_shared, metadata|https://maidsafe.readme.io/docs/dns-list-long-names|
+|dns|list_services|long_name||https://maidsafe.readme.io/docs/dns-list-services|
+|dns|get_home_dir|long_name, service_name||https://maidsafe.readme.io/docs/dns-get-home-dir|
+|dns|get_file_unauth|long_name, service_name, file_path|offset, length|https://maidsafe.readme.io/docs/dns-get-file-unauth|

data/lib/safenet/version.rb

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

data/lib/safenet.rb

@@ -1,514 +1,569 @@
 require "safenet/version"
-
+require "net/http"
+require "rbnacl"
+require "base64"
+require "json"
+require "cgi" # CGI.escape method
+
+# usage:
+#  my_client = SafeNet::Client.new(name: 'My App')
+#  my_client.nfs.file('x.txt')
+#  my_client.nfs.update_file_content('x.txt', 'Hello World!')
+#  my_client.nfs.get_file('x.txt')
 module SafeNet
-  require "net/http"
-  require "rbnacl"
-  require "base64"
-  require "json"
-  require "cgi" # CGI.escape method
-
-  # default values
-  @@NAME = "Ruby Demo App"
-  @@VERSION = "0.0.1"
-  @@VENDOR = "Vendor's Name"
-  @@ID = "org.thevendor.demo"
-  @@LAUNCHER_SERVER = "http://localhost:8100/"
-  @@CONF_PATH = File.join(File.expand_path('..', __FILE__), "conf.json")
-
-  def self.set_app_info(options)
-    @@NAME = options[:name] if options.has_key?(:name)
-    @@VERSION = options[:version] if options.has_key?(:version)
-    @@VENDOR = options[:vendor] if options.has_key?(:vendor)
-    @@ID = options[:id] if options.has_key?(:id)
-    @@LAUNCHER_SERVER = options[:server] if options.has_key?(:server)
-    @@CONF_PATH = options[:conf_file] if options.has_key?(:conf_file)
-  end
 
-  #
-  # An application exchanges data with the SAFE Launcher using symmetric key
-  #   encryption. The symmetric key is session based and is securely transferred
-  #   from the SAFE Launcher to the application using ECDH Key Exchange.
-  # Applications will generate an asymmetric key pair and a nonce for ECDH Key
-  #   Exchange with the SAFE Launcher.
-  #
-  # The application will initiate the authorisation request with the generated
-  #   nonce and public key, along with information about the application and the
-  #   required permissions.
-  #
-  # The SAFE Launcher will prompt to the user with the application information
-  #   along with the requested permissions. Once the user authorises the
-  #   request, the symmetric keys for encryption are received. If the user
-  #   denies the request then the SAFE Launcher sends an unauthorised error
-  #   response.
-  #
-  # Usage: SafeNet.auth()
-  # Fail: nil
-  # Success: {token: "1222", encryptedKey: "232", "publicKey": "4323", "permissions": []}
-  #
-  # Reference: https://maidsafe.readme.io/docs/auth
-  #
-  def self.auth
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}auth"
-
-    # new random key
-    private_key = RbNaCl::PrivateKey.generate
-    nonce = RbNaCl::Random.random_bytes(24)
-
-    # payload
-    payload = {
-      app: {
-        name: @@NAME,
-        version: @@VERSION,
-        vendor: @@VENDOR,
-        id: @@ID
-      },
-      publicKey: Base64.strict_encode64(private_key.public_key),
-      nonce: Base64.strict_encode64(nonce),
-      permissions: []
-    }
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Post.new(uri.path, {'Content-Type' => 'application/json'})
-    req.body = payload.to_json
-    res = http.request(req)
-
-    # return's parser
-    if res.code == "200"
-      response = JSON.parse(res.body)
-
-      # save it in conf.json
-      conf = response.dup
-      conf["nonce"] = Base64.strict_encode64(nonce)
-      conf["privateKey"] = Base64.strict_encode64(private_key)
-      File.open(@@CONF_PATH, "w") { |f| f << JSON.pretty_generate(conf) }
-
-      # invalidates @@keys
-      @@keys = {}
-    else
-      # puts "ERROR #{res.code}: #{res.message}"
-      response = nil
+  class Client
+    attr_reader :auth, :nfs, :dns, :app_info, :key_helper
+
+    def initialize(options = {})
+      @app_info = defaults()
+      set_app_info(options) if options.any?
+      @key_helper = SafeNet::KeyHelper.new(self)
+      @auth = SafeNet::Auth.new(self)
+      @nfs = SafeNet::NFS.new(self)
+      @dns = SafeNet::DNS.new(self)
     end
 
-    # return
-    response
-  end
+    def set_app_info(options = {})
+      @app_info[:name] = options[:name] if options.has_key?(:name)
+      @app_info[:version] = options[:version] if options.has_key?(:version)
+      @app_info[:vendor] = options[:vendor] if options.has_key?(:vendor)
+      @app_info[:id] = options[:id] if options.has_key?(:id)
+      @app_info[:launcher_server] = options[:server] if options.has_key?(:server)
+      @app_info[:conf_path] = options[:conf_file] if options.has_key?(:conf_file)
+    end
 
+    private
 
-  #
-  # To check whether the authorisation token obtained is valid.
-  # The Authorization header must be present in the request.
-  #
-  # Usage: SafeNet.is_token_valid()
-  # Fail: false
-  # Success: true
-  #
-  # Reference: https://maidsafe.readme.io/docs/is-token-valid
-  #
-  def self.is_token_valid
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}auth"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Get.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_token()}"
-    })
-    res = http.request(req)
-    res.code == "200"
+    # default values
+    def defaults
+      {
+        name: "Ruby Demo App",
+        version: "0.0.1",
+        vendor: "Vendor's Name",
+        id: "org.thevendor.demo",
+        launcher_server: "http://localhost:8100/",
+        conf_path: File.join(File.expand_path('..', __FILE__), "conf.json")
+      }
+    end
   end
 
+  class KeyHelper
 
-  #
-  # Removes the token from the SAFE Launcher.
-  #
-  # Usage: SafeNet.revoke_token()
-  # Fail: false
-  # Success: true
-  #
-  # Reference: https://maidsafe.readme.io/docs/revoke-token
-  #
-  def self.revoke_token
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}auth"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Delete.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}"
-    })
-    res = http.request(req)
-    res.code == "200"
-  end
+    def initialize(client_obj)
+      @client = client_obj
+      @keys = {}
+      @conf = {}
+    end
 
+    def get_token
+      @conf = File.exists?(@client.app_info[:conf_path]) ? JSON.parse(File.read(@client.app_info[:conf_path])) : (@client.auth.auth() || {})
+      @conf["token"]
+    end
 
-  #
-  # Create a directory using the NFS API.
-  # Only authorised requests can create a directory.
-  #
-  # Usage: SafeNet.get_directory("/photos", is_path_shared: false)
-  # Fail: {"errorCode"=>-1502, "description"=>"FfiError::PathNotFound"}
-  # Success: {"info"=> {"name"=> "Ruby Demo App-Root-Dir", ...}, ...}
-  #
-  # Reference: https://maidsafe.readme.io/docs/nfs-create-directory
-  #
-  def self.get_directory(dir_path, options = {})
-    # default values
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}nfs/directory/#{CGI.escape(dir_path)}/#{options[:is_path_shared]}"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Get.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-    })
-    res = http.request(req)
-    JSON.parse(self.decrypt(res.body))
-  end
+    def get_valid_token
+      @last_conf = File.exists?(@client.app_info[:conf_path]) ? JSON.parse(File.read(@client.app_info[:conf_path])) : {}
+      @client.auth.auth() unless File.exists?(@client.app_info[:conf_path]) && @client.auth.is_token_valid()
+      @conf = JSON.parse(File.read(@client.app_info[:conf_path]))
+      @conf["token"]
+    end
 
+    def decrypt(message_base64)
+      keys = get_keys()
+      keys["secret_box"].decrypt(keys["symmetric_nonce"], Base64.strict_decode64(message_base64))
+    end
 
-  #
-  # Create a File using the NFS API.
-  # Only authorised requests can invoke the API.
-  #
-  # Usage: SafeNet.file("/photos/cat.jpg")
-  # Adv.Usage: SafeNet.file("/photos/cat.jpg", is_private: true, metadata: "some meta", is_path_shared: false, is_versioned: false)
-  # Fail: {"errorCode"=>-505, "description"=>"NfsError::FileAlreadyExistsWithSameName"}
-  # Success: true
-  #
-  # Reference: https://maidsafe.readme.io/docs/nfsfile
-  #
-  def self.file(file_path, options = {})
-    url = "#{@@LAUNCHER_SERVER}nfs/file"
+    def encrypt(message)
+      keys = get_keys()
+      res = keys["secret_box"].encrypt(keys["symmetric_nonce"], message)
+      Base64.strict_encode64(res)
+    end
 
-    # default values
-    options[:is_private]     = true  if ! options.has_key?(:is_private)
-    options[:is_versioned]   = false if ! options.has_key?(:is_versioned)
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # payload
-    payload = {
-      filePath: file_path,
-      isPrivate: options[:is_private],
-      isVersioned: options[:is_versioned],
-      isPathShared: options[:is_path_shared]
-    }
-
-    # optional
-    payload["metadata"] = Base64.strict_encode64(options[:metadata]) if options.has_key?(:metadata)
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Post.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-      'Content-Type' => 'text/plain'
-    })
-    req.body = self.encrypt(payload.to_json)
-    res = http.request(req)
-    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
-  end
+    def invalidate
+      @keys = {}
+    end
 
+    private
 
-  #
-  # Create a directory using the NFS API.
-  # Only authorised requests can create a directory.
-  #
-  # Usage: SafeNet.create_directory("/photos")
-  # Adv.Usage: SafeNet.create_directory("/photos", is_private: true, metadata: "some meta", is_path_shared: false, is_versioned: false)
-  # Fail: {"errorCode"=>-505, "description"=>"NfsError::FileAlreadyExistsWithSameName"}
-  # Success: true
-  #
-  # Reference: https://maidsafe.readme.io/docs/nfs-create-directory
-  #
-  def self.create_directory(dir_path, options = {})
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}nfs/directory"
+    def get_keys
+      # not loaded yet?
+      if @keys.empty?
+        get_valid_token() if @conf.empty?
 
-    # default values
-    options[:is_private]     = true  if ! options.has_key?(:is_private)
-    options[:is_versioned]   = false if ! options.has_key?(:is_versioned)
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # payload
-    payload = {
-      dirPath: dir_path,
-      isPrivate: options[:is_private],
-      isVersioned: options[:is_versioned],
-      isPathShared: options[:is_path_shared]
-    }
-
-    # optional
-    payload["metadata"] = Base64.strict_encode64(options[:metadata]) if options.has_key?(:metadata)
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Post.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-      'Content-Type' => 'text/plain'
-    })
-    req.body = self.encrypt(payload.to_json)
-    res = http.request(req)
-    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
-  end
+        # extract keys
+        cipher_text = Base64.strict_decode64(@conf["encryptedKey"])
+        nonce = Base64.strict_decode64(@conf["nonce"])
+        private_key = Base64.strict_decode64(@conf["privateKey"])
+        public_key = Base64.strict_decode64(@conf["publicKey"])
 
+        box = RbNaCl::Box.new(public_key, private_key)
+        data = box.decrypt(nonce, cipher_text)
 
-  # ex.: delete_directory("/photos")
-  def self.delete_directory(dir_path, options = {})
-    # default values
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}nfs/directory/#{CGI.escape(dir_path)}/#{options[:is_path_shared]}"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Delete.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-    })
-    res = http.request(req)
-    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
-  end
+        # The first segment of the data will have the symmetric key
+        @keys["symmetric_key"] = data.slice(0, RbNaCl::SecretBox.key_bytes)
 
-  # options: offset, length, is_path_shared
-  def self.get_file(file_path, options = {})
-    # default values
-    options[:offset]         = 0     if ! options.has_key?(:offset)
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}nfs/file/#{CGI.escape(file_path)}/#{options[:is_path_shared]}?"
-
-    # query params are encrypted
-    query = []
-    query << "offset=#{options[:offset]}"
-    query << "length=#{options[:length]}" if options.has_key?(:length) # length is optional
-    url = "#{url}#{self.encrypt(query.join('&'))}"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Get.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-    })
-    res = http.request(req)
-    res.code == "200" ? self.decrypt(res.body) : JSON.parse(self.decrypt(res.body))
-  end
+        # The second segment of the data will have the nonce to be used
+        @keys["symmetric_nonce"] = data.slice(RbNaCl::SecretBox.key_bytes, RbNaCl::SecretBox.key_bytes)
 
-  def self.update_file_content(file_path, contents, options = {})
-    # default values
-    options[:offset]         = 0     if ! options.has_key?(:offset)
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}nfs/file/#{CGI.escape(file_path)}/#{options[:is_path_shared]}?offset=#{options[:offset]}"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Put.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-      'Content-Type' => 'text/plain'
-    })
-    req.body = self.encrypt(contents)
-    res = http.request(req)
-    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
-  end
+        # keep the box object in cache
+        @keys["secret_box"] = RbNaCl::SecretBox.new(@keys["symmetric_key"])
+      end
+
+      @keys
+    end
 
-  def self.delete_file(file_path, options = {})
-    # default values
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}nfs/file/#{CGI.escape(file_path)}/#{options[:is_path_shared]}"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Delete.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-    })
-    res = http.request(req)
-    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
   end
 
+  class Auth
+    def initialize(client_obj)
+      @client = client_obj
+    end
 
-  def self.create_long_name(long_name)
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}dns/#{CGI.escape(long_name)}"
+    #
+    # An application exchanges data with the SAFE Launcher using symmetric key
+    #   encryption. The symmetric key is session based and is securely transferred
+    #   from the SAFE Launcher to the application using ECDH Key Exchange.
+    # Applications will generate an asymmetric key pair and a nonce for ECDH Key
+    #   Exchange with the SAFE Launcher.
+    #
+    # The application will initiate the authorisation request with the generated
+    #   nonce and public key, along with information about the application and the
+    #   required permissions.
+    #
+    # The SAFE Launcher will prompt to the user with the application information
+    #   along with the requested permissions. Once the user authorises the
+    #   request, the symmetric keys for encryption are received. If the user
+    #   denies the request then the SAFE Launcher sends an unauthorised error
+    #   response.
+    #
+    # Usage: my_client.auth()
+    # Fail: nil
+    # Success: {token: "1222", encryptedKey: "232", "publicKey": "4323", "permissions": []}
+    #
+    # Reference: https://maidsafe.readme.io/docs/auth
+    #
+    def auth
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}auth"
+
+      # new random key
+      private_key = RbNaCl::PrivateKey.generate
+      nonce = RbNaCl::Random.random_bytes(24)
+
+      # payload
+      payload = {
+        app: {
+          name: @client.app_info[:name],
+          version: @client.app_info[:version],
+          vendor: @client.app_info[:vendor],
+          id: @client.app_info[:id]
+        },
+        publicKey: Base64.strict_encode64(private_key.public_key),
+        nonce: Base64.strict_encode64(nonce),
+        permissions: []
+      }
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Post.new(uri.path, {'Content-Type' => 'application/json'})
+      req.body = payload.to_json
+      res = http.request(req)
+
+      # return's parser
+      if res.code == "200"
+        response = JSON.parse(res.body)
+
+        # save it in conf.json
+        conf = response.dup
+        conf["nonce"] = Base64.strict_encode64(nonce)
+        conf["privateKey"] = Base64.strict_encode64(private_key)
+        File.open(@client.app_info[:conf_path], "w") { |f| f << JSON.pretty_generate(conf) }
+
+        # invalidates @keys
+        @client.key_helper.invalidate()
+      else
+        # puts "ERROR #{res.code}: #{res.message}"
+        response = nil
+      end
+
+      # return
+      response
+    end
 
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Post.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-      'Content-Type' => 'text/plain'
-    })
-    res = http.request(req)
-    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
-  end
 
+    #
+    # To check whether the authorisation token obtained is valid.
+    # The Authorization header must be present in the request.
+    #
+    # Usage: SafeNet.is_token_valid()
+    # Fail: false
+    # Success: true
+    #
+    # Reference: https://maidsafe.readme.io/docs/is-token-valid
+    #
+    def is_token_valid
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}auth"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Get.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_token()}"
+      })
+      res = http.request(req)
+      res.code == "200"
+    end
 
-  # ex.: register_service("thegoogle", "www", "/www")
-  def self.register_service(long_name, service_name, service_home_dir_path, options = {})
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}dns"
 
-    # default values
-    options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
-
-    # payload
-    payload = {
-      longName: long_name,
-      serviceName: service_name,
-      serviceHomeDirPath: service_home_dir_path,
-      isPathShared: options[:is_path_shared]
-    }
-
-    # optional
-    payload["metadata"] = options[:metadata] if options.has_key?(:metadata)
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Post.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-      'Content-Type' => 'text/plain'
-    })
-    req.body = self.encrypt(payload.to_json)
-    res = http.request(req)
-    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
+    #
+    # Removes the token from the SAFE Launcher.
+    #
+    # Usage: SafeNet.revoke_token()
+    # Fail: false
+    # Success: true
+    #
+    # Reference: https://maidsafe.readme.io/docs/revoke-token
+    #
+    def revoke_token
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}auth"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Delete.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}"
+      })
+      res = http.request(req)
+      res.code == "200"
+    end
   end
 
 
-  def self.list_long_names
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}dns"
+  class NFS
+    def initialize(client_obj)
+      @client = client_obj
+    end
 
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Get.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-    })
-    res = http.request(req)
-    JSON.parse(self.decrypt(res.body))
-  end
+    #
+    # Create a directory using the NFS API.
+    # Only authorised requests can create a directory.
+    #
+    # Usage: SafeNet.get_directory("/photos", is_path_shared: false)
+    # Fail: {"errorCode"=>-1502, "description"=>"FfiError::PathNotFound"}
+    # Success: {"info"=> {"name"=> "Ruby Demo App-Root-Dir", ...}, ...}
+    #
+    # Reference: https://maidsafe.readme.io/docs/nfs-get-directory
+    #
+    def get_directory(dir_path, options = {})
+      # default values
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
+
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}nfs/directory/#{CGI.escape(dir_path)}/#{options[:is_path_shared]}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Get.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+      })
+      res = http.request(req)
+      JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
 
-  def self.list_services(long_name)
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}dns/#{CGI.escape(long_name)}"
+    #
+    # Create a File using the NFS API.
+    # Only authorised requests can invoke the API.
+    #
+    # Usage: SafeNet.file("/photos/cat.jpg")
+    # Adv.Usage: SafeNet.file("/photos/cat.jpg", is_private: true, metadata: "some meta", is_path_shared: false, is_versioned: false)
+    # Fail: {"errorCode"=>-505, "description"=>"NfsError::FileAlreadyExistsWithSameName"}
+    # Success: true
+    #
+    # Reference: https://maidsafe.readme.io/docs/nfsfile
+    #
+    def file(file_path, options = {})
+      url = "#{@client.app_info[:launcher_server]}nfs/file"
+
+      # default values
+      options[:is_private]     = true  if ! options.has_key?(:is_private)
+      options[:is_versioned]   = false if ! options.has_key?(:is_versioned)
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
+
+      # payload
+      payload = {
+        filePath: file_path,
+        isPrivate: options[:is_private],
+        isVersioned: options[:is_versioned],
+        isPathShared: options[:is_path_shared]
+      }
+
+      # optional
+      payload["metadata"] = Base64.strict_encode64(options[:metadata]) if options.has_key?(:metadata)
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Post.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+        'Content-Type' => 'text/plain'
+      })
+      req.body = @client.key_helper.encrypt(payload.to_json)
+      res = http.request(req)
+      res.code == "200" ? true : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Get.new(uri.path, {
-      'Authorization' => "Bearer #{self.get_valid_token()}",
-    })
-    res = http.request(req)
-    JSON.parse(self.decrypt(res.body))
-  end
 
+    #
+    # Create a directory using the NFS API.
+    # Only authorised requests can create a directory.
+    #
+    # Usage: SafeNet.create_directory("/photos")
+    # Adv.Usage: SafeNet.create_directory("/photos", is_private: true, metadata: "some meta", is_path_shared: false, is_versioned: false)
+    # Fail: {"errorCode"=>-505, "description"=>"NfsError::FileAlreadyExistsWithSameName"}
+    # Success: true
+    #
+    # Reference: https://maidsafe.readme.io/docs/nfs-create-directory
+    #
+    def create_directory(dir_path, options = {})
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}nfs/directory"
+
+      # default values
+      options[:is_private]     = true  if ! options.has_key?(:is_private)
+      options[:is_versioned]   = false if ! options.has_key?(:is_versioned)
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
+
+      # payload
+      payload = {
+        dirPath: dir_path,
+        isPrivate: options[:is_private],
+        isVersioned: options[:is_versioned],
+        isPathShared: options[:is_path_shared]
+      }
+
+      # optional
+      payload["metadata"] = Base64.strict_encode64(options[:metadata]) if options.has_key?(:metadata)
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Post.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+        'Content-Type' => 'text/plain'
+      })
+      req.body = @client.key_helper.encrypt(payload.to_json)
+      res = http.request(req)
+      res.code == "200" ? true : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-  def self.get_home_dir(long_name, service_name)
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}dns/#{CGI.escape(service_name)}/#{CGI.escape(long_name)}"
 
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Get.new(uri.path)
-    res = http.request(req)
-    JSON.parse(res.body)
-  end
+    # ex.: delete_directory("/photos")
+    def delete_directory(dir_path, options = {})
+      # default values
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
 
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}nfs/directory/#{CGI.escape(dir_path)}/#{options[:is_path_shared]}"
 
-  # get_file_unauth("thegoogle", "www", "index.html", offset: 3, length: 5)
-  def self.get_file_unauth(long_name, service_name, file_path, options = {})
-    # default values
-    options[:offset] = 0 if ! options.has_key?(:offset)
-
-    # entry point
-    url = "#{@@LAUNCHER_SERVER}dns/#{CGI.escape(service_name)}/#{CGI.escape(long_name)}/#{CGI.escape(file_path)}?"
-
-    # query params are encrypted
-    query = []
-    query << "offset=#{options[:offset]}"
-    query << "length=#{options[:length]}" if options.has_key?(:length) # length is optional
-    url = "#{url}#{self.encrypt(query.join('&'))}"
-
-    # api call
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    req = Net::HTTP::Get.new(uri.path)
-    res = http.request(req)
-    res.code == "200" ? res.body : JSON.parse(res.body)
-  end
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Delete.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+      })
+      res = http.request(req)
+      res.code == "200" ? true : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-  private
+    # options: offset, length, is_path_shared
+    def get_file(file_path, options = {})
+      # default values
+      options[:offset]         = 0     if ! options.has_key?(:offset)
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
+
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}nfs/file/#{CGI.escape(file_path)}/#{options[:is_path_shared]}?"
+
+      # query params are encrypted
+      query = []
+      query << "offset=#{options[:offset]}"
+      query << "length=#{options[:length]}" if options.has_key?(:length) # length is optional
+      url = "#{url}#{@client.key_helper.encrypt(query.join('&'))}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Get.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+      })
+      res = http.request(req)
+      res.code == "200" ? @client.key_helper.decrypt(res.body) : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-  def self.get_token
-    @@conf = File.exists?(@@CONF_PATH) ? JSON.parse(File.read(@@CONF_PATH)) : (self.auth() || {})
-    @@conf["token"]
-  end
+    def update_file_content(file_path, contents, options = {})
+      # default values
+      options[:offset]         = 0     if ! options.has_key?(:offset)
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
+
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}nfs/file/#{CGI.escape(file_path)}/#{options[:is_path_shared]}?offset=#{options[:offset]}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Put.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+        'Content-Type' => 'text/plain'
+      })
+      req.body = @client.key_helper.encrypt(contents)
+      res = http.request(req)
+      res.code == "200" ? true : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-  def self.get_valid_token
-    @last_conf = File.exists?(@@CONF_PATH) ? JSON.parse(File.read(@@CONF_PATH)) : {}
-    self.auth() unless File.exists?(@@CONF_PATH) && self.is_token_valid()
-    @@conf = JSON.parse(File.read(@@CONF_PATH))
-    @@conf["token"]
+    def delete_file(file_path, options = {})
+      # default values
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
+
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}nfs/file/#{CGI.escape(file_path)}/#{options[:is_path_shared]}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Delete.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+      })
+      res = http.request(req)
+      res.code == "200" ? true : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
   end
 
 
-  def self.get_keys
-    @@keys ||= {}
+  class DNS
+    def initialize(client_obj)
+      @client = client_obj
+    end
+
+    # https://maidsafe.readme.io/docs/dns-create-long-name
+    def create_long_name(long_name)
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}dns/#{CGI.escape(long_name)}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Post.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+        'Content-Type' => 'text/plain'
+      })
+      res = http.request(req)
+      res.code == "200" ? true : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-    # not loaded yet?
-    if @@keys.empty?
-      @@conf ||= {}
-      self.get_valid_token if @@conf.empty?
 
-      # extract keys
-      cipher_text = Base64.strict_decode64(@@conf["encryptedKey"])
-      nonce = Base64.strict_decode64(@@conf["nonce"])
-      private_key = Base64.strict_decode64(@@conf["privateKey"])
-      public_key = Base64.strict_decode64(@@conf["publicKey"])
+    # ex.: register_service("thegoogle", "www", "/www")
+    # https://maidsafe.readme.io/docs/dns-register-service
+    def register_service(long_name, service_name, service_home_dir_path, options = {})
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}dns"
+
+      # default values
+      options[:is_path_shared] = false if ! options.has_key?(:is_path_shared)
+
+      # payload
+      payload = {
+        longName: long_name,
+        serviceName: service_name,
+        serviceHomeDirPath: service_home_dir_path,
+        isPathShared: options[:is_path_shared]
+      }
+
+      # optional
+      payload["metadata"] = options[:metadata] if options.has_key?(:metadata)
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Post.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+        'Content-Type' => 'text/plain'
+      })
+      req.body = @client.key_helper.encrypt(payload.to_json)
+      res = http.request(req)
+      res.code == "200" ? true : JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-      box = RbNaCl::Box.new(public_key, private_key)
-      data = box.decrypt(nonce, cipher_text)
+    # https://maidsafe.readme.io/docs/dns-list-long-names
+    def list_long_names
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}dns"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Get.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+      })
+      res = http.request(req)
+      JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-      # The first segment of the data will have the symmetric key
-      @@keys["symmetric_key"] = data.slice(0, RbNaCl::SecretBox.key_bytes)
+    # https://maidsafe.readme.io/docs/dns-list-services
+    def list_services(long_name)
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}dns/#{CGI.escape(long_name)}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Get.new(uri.path, {
+        'Authorization' => "Bearer #{@client.key_helper.get_valid_token()}",
+      })
+      res = http.request(req)
+      JSON.parse(@client.key_helper.decrypt(res.body))
+    end
 
-      # The second segment of the data will have the nonce to be used
-      @@keys["symmetric_nonce"] = data.slice(RbNaCl::SecretBox.key_bytes, RbNaCl::SecretBox.key_bytes)
 
-      # keep the box object in cache
-      @@keys["secret_box"] = RbNaCl::SecretBox.new(@@keys["symmetric_key"])
+    # https://maidsafe.readme.io/docs/dns-get-home-dir
+    def get_home_dir(long_name, service_name)
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}dns/#{CGI.escape(service_name)}/#{CGI.escape(long_name)}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Get.new(uri.path)
+      res = http.request(req)
+      JSON.parse(res.body)
     end
 
-    @@keys
-  end
 
-  def self.decrypt(message_base64)
-    keys = self.get_keys
-    keys["secret_box"].decrypt(keys["symmetric_nonce"], Base64.strict_decode64(message_base64))
-  end
+    # 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 = {})
+      # default values
+      options[:offset] = 0 if ! options.has_key?(:offset)
 
-  def self.encrypt(message)
-    keys = self.get_keys
-    res = keys["secret_box"].encrypt(keys["symmetric_nonce"], message)
-    Base64.strict_encode64(res)
-  end
+      # entry point
+      url = "#{@client.app_info[:launcher_server]}dns/#{CGI.escape(service_name)}/#{CGI.escape(long_name)}/#{CGI.escape(file_path)}?"
 
+      # query params are encrypted
+      query = []
+      query << "offset=#{options[:offset]}"
+      query << "length=#{options[:length]}" if options.has_key?(:length) # length is optional
+      url = "#{url}#{@client.key_helper.encrypt(query.join('&'))}"
+
+      # api call
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Get.new(uri.path)
+      res = http.request(req)
+      res.code == "200" ? res.body : JSON.parse(res.body)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-safenet
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Loureiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-26 00:00:00.000000000 Z
+date: 2016-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler