ruby-safenet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4557bfe89264b253153460ccc8c69ddc7326bacd
+  data.tar.gz: 0fac6e8ff9d6290792e5f78bc93367e5e5d8ed5a
+SHA512:
+  metadata.gz: 2eb2c81e7041b0519caf8519915d184c7b1e93e6c3a916c34a93754b1bb22147f9c7bd186b19cc152a3ab5b0520f8642bda9d33f8989d80e4f85f378598bd3a3
+  data.tar.gz: 3dcf2664123244491c1adc5c089162172159029d5ed318c13cfa2b7b3a6d8e68a7708a6e2bdc5912e0b301960f61675706ac64870d56a3509be4227283a06aab

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safenet.gemspec
+gemspec

data/README.md

@@ -0,0 +1,26 @@
+# Ruby-Safenet
+
+A Ruby library for accessing the SAFE network
+
+## Installation
+
+  $ gem install safenet
+
+## Usage
+
+```ruby
+require "safenet"
+
+SafeNet.set_app_info({
+  name:      "Demo App",
+  version:   "0.0.1",
+  vendor:    "maidsafe",
+  id:        "org.maidsafe.demo",
+})
+
+SafeNet.create_directory("/mydir")
+SafeNet.file("/mydir/index.html")
+SafeNet.update_file_content("/mydir/index.html", "Hello world!<br>I'm a webpage :D")
+SafeNet.register_service("mywonderfulapp", "www", "/mydir")
+SafeNet.get_file("/mydir/index.html")
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safenet"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/safenet/version.rb

@@ -0,0 +1,3 @@
+module Safenet
+  VERSION = "0.0.1"
+end

data/lib/safenet.rb

@@ -0,0 +1,423 @@
+require "safenet/version"
+
+module SafeNet
+  require "net/http"
+  require "rbnacl"
+  require "base64"
+  require "json"
+  require "cgi" # CGI.escape method
+
+  # default values
+  @@NAME = "Demo App"
+  @@VERSION = "0.0.1"
+  @@VENDOR = "maidsafe"
+  @@ID = "org.maidsafe.demo"
+  @@LAUCHER_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)
+    @@LAUCHER_SERVER = options[:server] if options.has_key?(:server)
+    @@CONF_PATH = options[:conf_file] if options.has_key?(:conf_file)
+  end
+
+  def self.auth
+    url = "#{@@LAUCHER_SERVER}auth"
+
+    private_key = RbNaCl::PrivateKey.generate
+    nonce = RbNaCl::Random.random_bytes(24)
+
+    payload = {
+      app: {
+        name: @@NAME,
+        version: @@VERSION,
+        vendor: @@VENDOR,
+        id: @@ID
+      },
+      publicKey: Base64.strict_encode64(private_key.public_key),
+      nonce: Base64.strict_encode64(nonce),
+      permissions: []
+    }
+
+    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)
+
+    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) }
+
+    else
+      # puts "ERROR #{res.code}: #{res.message}"
+      response = nil
+    end
+
+    response
+  end
+
+
+  def self.is_token_valid
+    url = "#{@@LAUCHER_SERVER}auth"
+
+    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"
+  end
+
+
+  def self.revoke_token
+    url = "#{@@LAUCHER_SERVER}auth"
+
+    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 self.get_directory(dir_path, options = {})
+    # default values
+    options[:is_path_shared] ||= false
+
+    # entry point
+    url = "#{@@LAUCHER_SERVER}nfs/directory/#{CGI.escape(dir_path)}/#{options[:is_path_shared]}"
+
+    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
+
+
+  # options = is_private, metadata, is_versioned, is_path_shared
+  def self.file(file_path, options = {})
+    url = "#{@@LAUCHER_SERVER}nfs/file"
+
+    # default values
+    options[:is_private]     ||= true
+    options[:is_versioned]   ||= false
+    options[:is_path_shared] ||= false
+
+    # payload
+    payload = {
+      filePath: file_path,
+      isPrivate: options[:is_private],
+      isVersioned: options[:is_versioned],
+      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))
+  end
+
+
+  # options = is_private, metadata, is_versioned, is_path_shared
+  # ex.: create_directory("/photos")
+  def self.create_directory(dir_path, options = {})
+    url = "#{@@LAUCHER_SERVER}nfs/directory"
+
+    # default values
+    options[:is_private]     ||= true
+    options[:is_versioned]   ||= false
+    options[:is_path_shared] ||= false
+
+    # payload
+    payload = {
+      dirPath: dir_path,
+      isPrivate: options[:is_private],
+      isVersioned: options[:is_versioned],
+      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))
+  end
+
+
+  # ex.: delete_directory("/photos")
+  def self.delete_directory(dir_path, options = {})
+    # default values
+    options[:is_path_shared] ||= false
+
+    # entry point
+    url = "#{@@LAUCHER_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
+
+  # options: offset, length, is_path_shared
+  def self.get_file(file_path, options = {})
+    # default values
+    options[:offset]         ||= 0
+    options[:is_path_shared] ||= false
+
+    # entry point
+    url = "#{@@LAUCHER_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
+
+  def self.update_file_content(file_path, contents, options = {})
+    # default values
+    options[:offset]         ||= 0
+    options[:is_path_shared] ||= false
+
+    # entry point
+    url = "#{@@LAUCHER_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
+
+  def self.delete_file(file_path, options = {})
+    # default values
+    options[:is_path_shared] ||= false
+
+    # entry point
+    url = "#{@@LAUCHER_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
+
+
+  def self.create_long_name(long_name)
+    url = "#{@@LAUCHER_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 #{self.get_valid_token()}",
+      'Content-Type' => 'text/plain'
+    })
+    res = http.request(req)
+    res.code == "200" ? true : JSON.parse(self.decrypt(res.body))
+  end
+
+
+  # ex.: register_service("thegoogle", "www", "/www")
+  def self.register_service(long_name, service_name, service_home_dir_path, options = {})
+    url = "#{@@LAUCHER_SERVER}dns"
+
+    # default values
+    options[:is_path_shared] ||= false
+
+    # 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))
+  end
+
+
+  def self.list_long_names
+    url = "#{@@LAUCHER_SERVER}dns"
+
+    # 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 self.list_services(long_name)
+    url = "#{@@LAUCHER_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 #{self.get_valid_token()}",
+    })
+    res = http.request(req)
+    JSON.parse(self.decrypt(res.body))
+  end
+
+
+  def self.get_home_dir(long_name, service_name)
+    url = "#{@@LAUCHER_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
+
+
+  # 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
+
+    # entry point
+    url = "#{@@LAUCHER_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
+
+  private
+
+  def self.get_token
+    @@conf = File.exists?(@@CONF_PATH) ? JSON.parse(File.read(@@CONF_PATH)) : (self.auth() || {})
+    @@conf["token"]
+  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"]
+  end
+
+
+  def self.get_keys
+    @@keys ||= {}
+
+    # 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"])
+
+      box = RbNaCl::Box.new(public_key, private_key)
+      data = box.decrypt(nonce, cipher_text)
+
+      # The first segment of the data will have the symmetric key
+      @@keys["symmetric_key"] = data.slice(0, RbNaCl::SecretBox.key_bytes)
+
+      # 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"])
+    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
+
+  def self.encrypt(message)
+    keys = self.get_keys
+    res = keys["secret_box"].encrypt(keys["symmetric_nonce"], message)
+    Base64.strict_encode64(res)
+  end
+
+end

data/ruby-safenet.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safenet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-safenet"
+  spec.version       = Safenet::VERSION
+  spec.authors       = ["Daniel Loureiro"]
+  spec.email         = ["loureirorg@gmail.com"]
+
+  spec.summary       = %q{Ruby library for accessing the SAFE network}
+  spec.description   = %q{Ruby library for accessing the SAFE network}
+  spec.homepage      = "https://github.com/loureirorg/ruby-safenet"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "rbnacl", "~> 3.3"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ruby-safenet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Loureiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Ruby library for accessing the SAFE network
+email:
+- loureirorg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safenet.rb
+- lib/safenet/version.rb
+- ruby-safenet.gemspec
+homepage: https://github.com/loureirorg/ruby-safenet
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby library for accessing the SAFE network
+test_files: []
+has_rdoc: