ruby-libstorj 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da0c169cee3689352622405ff4cf677cfa800487
-  data.tar.gz: e5cb152afd2618c23dacb2bd0a1b2469d82ae5b9
+  metadata.gz: d6fe0bf8d40e520d210d6dce512a1c767b4eb3df
+  data.tar.gz: 7409289788a7ccb6915364c29a2593901597a76c
 SHA512:
-  metadata.gz: ddc31eb2a14fd3cd997ea1cc465fa2e08028911fc2aaa017bd9485fa455f63c8329dd91aed844e593871d4e3e8bca2a9bd07b78030cbc47f5e98139a92c1d511
-  data.tar.gz: 9e5e35acf4530e58c351b46bb0e4dc9e8871d7ff81e6a6bc7209477eed0e232eda8808a9d78739a91367d39d0f7e508f8f73fe64f456fc0cb182f7a20894a356
+  metadata.gz: e69068e9392da1589dc68a710b7a6841bc07aea6b7d13006a7da4c015cedd7c665fbafbde2a27ac39ed3c1a274e50f1028038d6a8fafa746f76b36753d5dbdfa
+  data.tar.gz: 13fec483fc292a4aa73c28aa4e20d6982dcfcaa06bb4e35ac8febc70f26646be9beb11c6692eb546ba411b6833c86402b014141bd00ca90da7890bcbe0c50bb4

data/.gitignore

@@ -5,6 +5,6 @@
 *.a
 *.log
 tmp/*
-spec/helpers/options.yml
+options.yml
 Makefile
 coverage

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-libstorj (1.0.2)
+    ruby-libstorj (2.0.0)
       ffi (~> 1.9)
       libuv (~> 3.2)
       rake (~> 12.0)

data/README.md

@@ -28,7 +28,7 @@ Ruby library for encrypted file transfer on the Storj network via bindings to [l
     cd ruby-libstorj && \
     rake install
     ```
-    (see [installing for development](#wip) if you have issues with `rake install`)
+    (see [installing for development](#install-gem-1) if you have issues with `rake install`)
 
 ### Usage:
 Until more thorough documentation is available, please see the tests:
@@ -39,6 +39,7 @@ Until more thorough documentation is available, please see the tests:
         - `.mnemonic_check`
         - `.mnemonic_generate`
 + [`LibStorj::Env`](./spec/ruby-libstorj/env_spec.rb) _[(source)](./lib/ruby-libstorj/env.rb)_
+    - `.new`
     - `#get_info`
     - `#get_buckets`
     - `#create_bucket`
@@ -79,17 +80,15 @@ rake compile
 ```
 (see [`rake-compiler`](https://github.com/rake-compiler/rake-compiler))
 
-### Build gem:
-```bash
-rake
-
-# OR
-# rake build
-# rake build[no-test]   # build without requiring tests to pass
-```
-
-### Install gem:
+### Build and install gem:
 + with `rake`:
+    ```bash
+    rake
+
+    # OR
+    # rake build
+    # rake build[no-test]   # build without requiring tests to pass
+    ```
     ```bash
     rake install
     
@@ -99,22 +98,25 @@ rake
 
 + with `gem`:
 
-    Maybe you need/want to pass args to `gem`, or maybe `rake install` doesn't work on your system:
+    Maybe you need/want to pass args to `gem`, or maybe `rake install` doesn't work in your environment:
     
     ```bash
-    gem install --local ./ruby-libstorj-*.gem  --no-ri --no-rdoc  
+    gem build ./ruby-libstorj.gemspec
+    ```
+    ```bash
+    gem install --local ./ruby-libstorj-<version>.gem  --no-ri --no-rdoc  
     ```
 
 ### Testing:
 #### First create spec/helpers/options.yml !
 For the moment, the test suite doesn't start it's own mock backend but it does parse whatever's in the `spec/helpsers/options.yml` file to initialize `LibStorj::Ext::Storj::Env` to connect via http/https.
 
-You can copy [`spec/helpers/options.yml.example`](spec/helpers/options.example.yml) and modify it for your use:
+You can copy [`spec/helpers/options.yml.example`](options.example.yml) and modify it for your use:
 ```bash
 cp spec/helpers/options.yml.example spec/helpers/options.yml && \
 vim spec/helpers/options.yml   # or whatever
 ```
-`spec/helpers/options.yml` should be in the [`.gitignore`](./.gitignore) so you shouldn't have to worry about accidentally committing it.
+Ensure that `spec/helpers/options.yml` is in the [`.gitignore`](./.gitignore) so you don't have to worry about accidentally committing it.
 
 #### A quick note on rspec formatters:
 The "progress" formatter is the default.
@@ -187,109 +189,3 @@ For example usages see "with `rake`" below.
     # rspec spec/ruby-libstorj/env_spec.rb:15   # run test(s) containing line 15
     ```
     (see `rspec --help | less`)
-    
-### Gotchas:
-+ `libuv` (see http://docs.libuv.org/en/v1.x/)
-   
-   #### The problem
-   The C library [`libuv`](http://docs.libuv.org/en/v1.x/) is used by [`libstorj`](https://github.com/storj/libstorj) for concurrency;
-   however, ruby's C API is not thread-safe so this is currently resolved by using the ruby gem [`libuv`](https://rubygems.org/gems/libuv) in tandem with the C-`libuv` calls in `libstorj`
-   
-   Specifically, `libstorj` makes calls to the C-`libuv` function [`uv_queue_work`](http://docs.libuv.org/en/v1.x/threadpool.html), which queues work to be run in another thread.
-   In standard C-`libuv` usage, you would call [`uv_run(...)`](http://docs.libuv.org/en/v1.x/loop.html#c.uv_run):
-   
-   ```c
-   #include <uv.h>
-   ...
-   // Queue work to be run in another thread
-   uv_queue_work(...);
-   ...
-   // Run the event loop
-   uv_run(...);
-   ```
-   
-   After calling a function which queues work using the C `uv_queue_work` function, simply calling `uv_run` from ruby does **not work**:
-   ```c
-   /* example.c */
-   #include <uv.h>
-   ...
-   // implemented elsewhere
-   uv_work_t* my_work_factory(void* handle);
-   ...
-   handle_wrapper
-   ...
-   extern "C"
-   int example_queue_work(void* handle, uv_after_work_cb cb)
-   {
-       uv_loop_t* loop = uv_default_loop();
-       uv_work_t *work = my_work_factory(handle);
-   
-       return uv_queue_work(loop, work, my_worker, cb);
-   }
-   ```
-    
-   ```ruby
-   # example.rb
-   # NOTE: THIS IS AN EXAMPLE OF WHAT DOES NOT WORK
-   ####################################### === ####
-   require 'ffi'
-
-   module Example
-     extend FFI::Library
-     # load built shared object from C/C++ using ruby ffi
-     ffi_lib '/path/to/libexample.so'
-   
-     # NB: if `libexample` is installed in the usual system location*
-     # ffi_lib 'example'
-   
-     # expose C functions as members of the `Example` module
-     attach_function('queue_work', 'example_queue_work', [:pointer, :int], :int)
-     attach_function('run', 'uv_run', [:pointer, :int], :int)
-   end
- 
-   handle = FFI::Function.new(...) {...}
-   cb     = FFI::Function.new(...) {...}
- 
-   Example.queue_work handle, cb
-   Example.run  #=> segmentation fault
-   ```
-   _*`ffi_lib` automatically adds the conventional "lib" prefix to args which are not absolute paths_
-   
-   
-   It seems to be the case that calls to `uv_default_loop()` made from within C-libstorj point to a different location than the default loop from ruby-livub.
-   It may be the case that C-libuv is being loaded twice, one linked through C-libstorj and the other through ruby-libuv bindings or something; more digging required.
-   
-   #### The solution
-   Instead of calling `uv_run` directly, if we let the ruby `libuv` gem do it for us, we can call `uv_queue_work` in C as much as we want.
-   
-   Using ruby-`libuv`'s `reactor` block to wrap calls to C functions that call `uv_queue_work`, we let ruby-`libuv` do the heavy concurrency lifting and C-`libuv` integration:
-   
-   ```ruby
-   # example.rb
-   require 'libuv'
-   require 'ffi'
- 
-   module Example
-     extend FFI::Library
-     # load built shared object from C/C++ using ruby ffi
-     ffi_lib '/path/to/libexample.so'
-  
-     # NB: if `libexample` is installed in the usual system location*
-     # ffi_lib 'example'
-  
-     # expose C functions as members of the `Example` module
-    attach_function('queue_work', 'example_queue_work', [:pointer, :int], :int)
-   end
- 
-   handle = FFI::Function.new(...) {...}
-   cb     = FFI::Function.new(...) {...}
- 
-   reactor do |reactor|
-     reactor.work do
-       Example.queue_work handle, cb
-     end
-   end
-   ```
-   (see https://github.com/cotag/libuv)
-   
-_NB: the understanding presented here comes from reading the docs and source of the various C and ruby libraries involved_

data/Rakefile

@@ -2,6 +2,8 @@
 # i.e. `require 'ruby-libstorj/...'`
 require_relative './lib/ruby-libstorj/arg_forwarding_task'
 
+TEMP_PATH = File.join(%W(#{__dir__} tmp))
+
 # NB: using begin/rescue so that you can use your
 #     Rakefile in an environment where RSpec is
 #     unavailable (e.g. production)
@@ -52,14 +54,12 @@ Rake::ExtensionTask.new 'ruby-libstorj'
 
 # TODO: everything that follows... but better
 LibStorj::ArgForwardingTask.new(:build, args_deps_hash: {
-    %i[no-test] => []
+    %i[no-test] => [TEMP_PATH.to_sym]
 }) do |t, args, deps|
   Rake::Task[:spec].invoke if args.to_hash[:'no-test'].nil?
 
-  directory 'tmp'
-
-  sh 'gem build ./ruby-libstorj.gemspec'
-  sh 'mv ./ruby-libstorj-*.gem ./tmp/'
+  sh 'gem build ruby-libstorj.gemspec'
+  sh "mv ruby-libstorj-*.gem #{TEMP_PATH}#{File::SEPARATOR}"
 end
 
 LibStorj::ArgForwardingTask.new(:install, args_deps_hash: {
@@ -72,5 +72,7 @@ LibStorj::ArgForwardingTask.new(:install, args_deps_hash: {
                         --no-rdoc'
 end
 
+directory TEMP_PATH
+
 # Build (and test) when you run `rake`
 task default: %i[build]

data/dockerfiles/example.dockerfile

@@ -21,6 +21,6 @@ RUN make install
 RUN gem install ruby-libstorj
 
 WORKDIR /storj
-COPY ./spec/helpers/storj_options.rb ./test.rb ./
-COPY ./spec/helpers/options.example.yml ./options.yml
-CMD /bin/bash
+COPY ./dockerfiles/test.rb ./test.rb
+COPY ./options.example.yml ./options.yml
+CMD bash -c 'echo "### Edit ./options.yml & edit/run ruby ./test.rb ###" && /bin/bash'

data/dockerfiles/setup-user/activate_user.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+
+const MongoClient = require('mongodb').MongoClient;
+const assert = require('assert');
+
+// Connection URL
+const url = 'mongodb://localhost:27017';
+
+// Database Name
+const dbName = 'storj-sandbox';
+
+// Use connect method to connect to the server
+MongoClient.connect(url, function(err, client) {
+  assert.equal(null, err);
+  console.log("Successfully connected to mongo...");
+
+  const db = client.db(dbName);
+
+  // find and update all users to be activated
+  db.collection('users').updateMany({activated: false}, {$set:
+    {
+      activated: true,
+      activator: null
+    }
+  }, function(err, result) {
+      if (err) {
+          return console.error(err);
+      }
+
+      console.log("...done!");
+      // console.log(result);
+      client.close();
+  });
+});

data/dockerfiles/setup-user/create_user.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/expect
+
+set email "$env(STORJ_EMAIL)\n"
+set pass "$env(STORJ_PASS)\n"
+set keypass "$env(STORJ_KEYPASS)\n"
+set strength "128\n"
+set timeout 3
+
+spawn storj register
+
+expect "Bridge username"
+send $email
+
+expect "Bridge password:"
+send $pass
+
+expect "Strength:"
+send $strength
+
+# expect "overwrite"
+# send "y\n"
+
+expect "Unlock passphrase:"
+send $keypass
+
+expect "Again to verify:"
+send $keypass
+
+expect "EOF"
+
+exit

data/dockerfiles/setup-user/import_keys.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/expect
+
+set email "$env(STORJ_EMAIL)\n"
+set pass "$env(STORJ_PASS)\n"
+set keypass "$env(STORJ_KEYPASS)\n"
+set mnemonic "$env(STORJ_MNEMONIC)\n"
+set timeout 3
+
+spawn storj import-keys
+
+expect "Would you like to overwrite"
+send "y\n"
+
+expect "Bridge username"
+send $email
+
+expect "Bridge password:"
+send $pass
+
+expect "Encryption key:"
+send $mnemonic
+
+expect "Unlock passphrase:"
+send $keypass
+
+expect "Again to verify:"
+send $keypass
+
+expect "EOF"
+
+exit

data/dockerfiles/setup-user/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "setup-user",
+  "version": "1.0.0",
+  "description": "",
+  "main": "activate_user.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "mongodb": "^3.0.4"
+  }
+}

data/dockerfiles/setup-user/setup_user.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+. ~/.nvm/nvm.sh
+
+root_dir="/root"
+
+#redis
+service redis-server start
+
+#mongodb
+service mongod start
+
+#storjbridge
+pm2 start -n bridge $root_dir/bin/storj-bridge -- -c $root_dir/config/storj-bridge/config.json -d $root_dir/config/storj-bridge
+
+#wait for things to come up
+echo "Sleeping for 5..."
+sleep 5
+
+./create_user.sh
+./import_keys.sh
+npm install
+node ./activate_user.js
+
+service redis-server stop
+service mongod stop
+pm2 delete all

data/dockerfiles/test.rb

@@ -0,0 +1,9 @@
+require 'ruby-libstorj'
+
+options_path = File.join %W(#{__dir__} options.yml)
+storj = LibStorj::Env.new(path: options_path)
+
+storj.get_buckets do |error, buckets|
+  puts "error: #{error}"
+  puts "buckets: #{buckets}"
+end

data/lib/ruby-libstorj/env.rb

@@ -6,8 +6,17 @@ module LibStorj
 
     C_ANALOGUE = ::LibStorj::Ext::Storj::Env
 
-    def initialize(*options)
-      @storj_env = ::LibStorj::Ext::Storj.method(:init_env).call(*options)
+    def initialize(path:, **options)
+      # NB: ensure all options are pointers before passing them directly
+      options = {} unless options.all? {|_, o| o.is_a? ::FFI::Pointer}
+
+      if !path.nil? && File.exists?(path)
+        options = ::LibStorj.load_yaml_options(path).merge options
+      end
+
+      # puts options
+      @storj_env = ::LibStorj::Ext::Storj.method(:init_env).call(*options.values)
+
       # use ruby libuv's default_loop
       @storj_env[:loop] = ::Libuv::Ext.default_loop
     end

data/lib/ruby-libstorj/libstorj.rb

@@ -15,8 +15,10 @@ module LibStorj
   require 'ruby-libstorj/ext/upload_options'
   require 'ruby-libstorj/ext/file'
 
-  require 'ruby-libstorj/env'
   require 'ruby-libstorj/mixins/storj'
 
+  extend ::LibStorj::Storj::Mixins
   extend ::LibStorj::Ext::Storj::Mixins
+
+  require 'ruby-libstorj/env'
 end

data/lib/ruby-libstorj/mixins/storj.rb

@@ -1,4 +1,62 @@
 module LibStorj
+  module Storj
+    module Mixins
+      require 'yaml'
+
+      def load_yaml_options(path)
+        throw(:ENOENT) unless File.exist?(path)
+
+        options_yml = YAML.load_file path
+        build_options(default_type_map, options_yml.to_hash)
+      end
+
+      def default_type_map
+        {
+            bridge: ::LibStorj::Ext::Storj::BridgeOptions,
+            encrypt: ::LibStorj::Ext::Storj::EncryptOptions,
+            http: ::LibStorj::Ext::Storj::HttpOptions,
+            log: ::LibStorj::Ext::Storj::LogOptions
+        }
+      end
+
+      def build_options(type_map, option_groups)
+        Hash[option_groups.map do |group_name, options|
+
+          option_type = type_map[group_name.to_sym]
+          member_field_hash = Hash[option_type.members.zip option_type.layout.fields]
+          option_instance = option_type.new
+
+          options.map do |name, value|
+            name = name.to_sym
+
+            if name == :logger
+              option_instance[:logger] = ::LibStorj::Ext::Storj.const_get value
+
+              next
+            end
+
+            option_field = member_field_hash[name]
+
+            # TODO: check types and/or error handle
+            if option_field.nil?
+              option_instance = FFI::MemoryPointer::NULL
+            elsif option_field.is_a?(FFI::StructLayout::Pointer)
+              # Assuming pointers are strings
+              #
+              pointer = FFI::MemoryPointer.from_string(value.nil? ? '' : value)
+              option_instance[name] = pointer
+            else
+              option_instance[name] = value
+            end
+
+          end
+
+          [group_name, option_instance]
+        end]
+      end
+    end
+  end
+
   module Ext
     module Storj
       module Mixins

data/ruby-libstorj.gemspec

@@ -4,7 +4,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'ruby-libstorj'
-  gem.version       = '1.0.2' #LibStorj::VERSION
+  gem.version       = '2.0.0' #LibStorj::VERSION
   gem.license       = 'AGPL-3.0'
   gem.authors       = ['Bryan White']
   gem.email         = ['bryanchriswhite@gmail.com', 'bryan@storj.io']

data/spec/helpers/storj_options.rb

@@ -1,52 +1,6 @@
 module LibStorjTest
-  require 'yaml'
   require 'ruby-libstorj'
 
-  def build_options(type_map)
-    options_yml = YAML.load_file "#{__dir__}/options.yml"
-    options_yml.to_a.map do |option_group|
-      group_name, options = option_group
-
-      option_type = type_map[group_name.to_sym]
-      member_field_hash = Hash[option_type.members.zip option_type.layout.fields]
-      option_instance = option_type.new
-
-      options.each do |option|
-        name, value = [option[0].to_sym, option[1]]
-
-        if name == :logger
-          option_instance[:logger] = ::LibStorj::Ext::Storj.const_get value
-
-          next
-        end
-
-        option_field = member_field_hash[name]
-
-        # TODO: check types and/or error handle
-        if option_field.nil?
-          option_instance = FFI::MemoryPointer::NULL
-        elsif option_field.is_a?(FFI::StructLayout::Pointer)
-          # Assuming pointers are strings
-          #
-          pointer = FFI::MemoryPointer.from_string(value.nil? ? '' : value)
-          option_instance[name] = pointer
-        else
-          option_instance[name] = value
-        end
-
-      end
-
-      option_instance
-    end
-  end
-
-  def default_options
-    build_options bridge: ::LibStorj::Ext::Storj::BridgeOptions,
-                  encrypt: ::LibStorj::Ext::Storj::EncryptOptions,
-                  http: ::LibStorj::Ext::Storj::HttpOptions,
-                  log: ::LibStorj::Ext::Storj::LogOptions
-  end
-
   def get_test_bucket_id(&block)
     instance.get_buckets do |error, buckets|
       throw(:no_bucket) if buckets.nil?

data/spec/ruby-libstorj/env_spec.rb

@@ -5,8 +5,9 @@ include LibStorjTest
 RSpec.describe LibStorj::Env do
   let(:bucket_class) {::LibStorj::Ext::Storj::Bucket}
   let(:file_class) {::LibStorj::Ext::Storj::File}
+  let(:default_path) {File.join %W(#{__dir__} .. .. options.yml)}
   let(:instance) do
-    described_class.new(*default_options)
+    described_class.new(path: default_path)
   end
 
   after :each do
@@ -69,7 +70,7 @@ RSpec.describe LibStorj::Env do
       end
 
       it 'yields a nil error and an array of buckets' do
-        expect do |block| #{|block| instance.get_bucekts(&block)}.to yield_with_args
+        expect do |block|
           instance.get_buckets do |error, buckets|
             expect(error).to be(nil)
             expect(buckets.length).to be(bucket_names.length)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-libstorj
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Bryan White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -86,6 +86,12 @@ files:
 - Rakefile
 - dockerfiles/example.dockerfile
 - dockerfiles/ruby-libstorj.dockerfile
+- dockerfiles/setup-user/activate_user.js
+- dockerfiles/setup-user/create_user.sh
+- dockerfiles/setup-user/import_keys.sh
+- dockerfiles/setup-user/package.json
+- dockerfiles/setup-user/setup_user.sh
+- dockerfiles/test.rb
 - ext/libstorj/.gitignore
 - ext/libstorj/.travis.yml
 - ext/libstorj/CONTRIBUTING.md
@@ -157,8 +163,8 @@ files:
 - lib/ruby-libstorj/libstorj.rb
 - lib/ruby-libstorj/mixins/storj.rb
 - lib/ruby-libstorj/struct.rb
+- options.example.yml
 - ruby-libstorj.gemspec
-- spec/helpers/options.example.yml
 - spec/helpers/shared_rake_examples.rb
 - spec/helpers/storj_options.rb
 - spec/helpers/upload.data