ruby-libstorj 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8de9d6c135ae3b5e58a34ce91f1ac731bc2e887a
-  data.tar.gz: f581db0c00bfcbbec33081df8034bcb17c8d7e18
+  metadata.gz: be875e27acd221845d705984e330a4c2a347e770
+  data.tar.gz: f756fb923dbb524c284f599912b9b8565d8f5eba
 SHA512:
-  metadata.gz: d7d9eef9134284db52495f95e1fbf73f7827380e180e6da2ffff75ae8ff6db1a204f3f3e646670ca7c664c74613dbd2e3e028ef945abf531a940c670fd842f29
-  data.tar.gz: 0a58c196a68386fc3ca0fc8bf3caf0156f38d2526c374a551b4a7eb194121f733e22943fbf06e171cfd2283195e6cbb2f0581cbdf4b3ea8b76a7c47dbafbc1b1
+  metadata.gz: b98b1270ed1d934d49dc874669db279098fef16f6ddbded3f3eaac7fbfb4934b8ce1e417406e63027597a0629c7b01aaa21b37b3fe290d6852afc9384ed2a8d7
+  data.tar.gz: a97463b8af6037225bde317c45b7091847b5cb9066539902d39330ee4a6cfd2735d3faaf78d236ac2afaa2815aadfd172da227e342bbf0b62eb1cf7cf680e338

data/Dockerfile

@@ -0,0 +1,48 @@
+FROM storjlabs/storj-integration:swig-python-libstorj
+
+RUN apt update -yqq
+RUN apt install -yqq ruby-dev rubygems-integration
+
+# copy scripts and source
+RUN mkdir -p /storj/ruby-libstorj
+COPY Gemfile Gemfile.lock ruby-libstorj.gemspec Rakefile Guardfile /storj/ruby-libstorj/
+COPY ./dockerfiles/setup-user /storj/ruby-libstorj/setup-user
+COPY ./lib /storj/ruby-libstorj/lib
+COPY ./spec /storj/ruby-libstorj/spec
+COPY ./ext /storj/ruby-libstorj/ext
+
+# modify file permissions
+RUN chmod 655 /storj/ruby-libstorj/setup-user/*.{js,sh}
+WORKDIR /storj/ruby-libstorj/setup-user
+
+# setup env variables
+ARG STORJ_EMAIL='username@example.com'
+ARG STORJ_PASS='password'
+ARG STORJ_KEYPASS=''
+ARG STORJ_MNEMONIC='abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
+ARG STORJ_BRIDGE='http://127.0.0.1:6382'
+ARG LIBSTORJ_INCLUDE='/storj/ruby-libstorj/ext/libstorj/src'
+ENV STORJ_EMAIL=$STORJ_EMAIL
+ENV STORJ_KEYPASS=$STORJ_KEYPASS
+ENV STORJ_PASS=$STORJ_PASS
+ENV STORJ_MNEMONIC=$STORJ_MNEMONIC
+ENV STORJ_BRIDGE=$STORJ_BRIDGE
+ENV LIBSTORJ_INCLUDE=$LIBSTORJ_INCLUDE
+
+# remove STORJ_BRIDGE export in .bashrc
+RUN sed -i '/export STORJ_BRIDGE.*/d' /root/.bashrc
+
+RUN ./setup_user.sh
+
+# useful if you want to interact with mongo from
+# a "linked" container (e.g. python_libstorj)
+# or from your host (if using just docker - don't forget `-p`)
+EXPOSE 27017
+
+WORKDIR /storj/ruby-libstorj
+RUN gem install bundler
+RUN bundle install
+#RUN bundle exec rake install[no-test]
+
+CMD /bin/bash
+#CMD ["bundle", "exec", "rake"]

data/Gemfile

@@ -1,10 +1,10 @@
 source 'https://rubygems.org' do
-  gem 'rake'
   gem 'ffi' # Ruby FFI lib
   gem 'libuv' # libuv FFI bindings for ruby (https://github.com/cotag/libuv)
   ### libuv documentation -- http://docs.libuv.org/en/v1.x/
 
   group :test do
+    gem 'rake'
     gem 'rspec'
     gem 'rspec-wait'
     gem 'simplecov'
@@ -14,6 +14,7 @@ source 'https://rubygems.org' do
   group :development do
     gem 'pry' # debugging tools / REPL
     gem 'pry-byebug' # moar debugging tools
+    gem 'rake'
     gem 'rake-compiler'
     gem 'guard'
     gem 'guard-rake'

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    ruby-libstorj (1.0.0)
+    ruby-libstorj (1.0.1)
+      ffi (~> 1.9)
+      libuv (~> 3.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,9 +1,14 @@
-ruby-libstorj: Ruby bindings for libstorj
+ruby-libstorj
 ===
+[![Storj.io](https://storj.io/img/storj-badge.svg)](https://storj.io)
 [![Gem Version](https://badge.fury.io/rb/ruby-libstorj.svg)](https://badge.fury.io/rb/ruby-libstorj)
 
+Ruby library for encrypted file transfer on the Storj network via bindings to [libstorj](https://github.com/Storj/libstorj).
+
 ## Using ruby-libstorj
 
+### First, install [`libstorj`](https://github.com/storj/libstorj)
+
 ### Install gem:
 + using bundler:
     ```
@@ -25,13 +30,29 @@ ruby-libstorj: Ruby bindings for libstorj
     ```
     (see [installing for development](#wip) if you have issues with `rake install`)
 
-
+### Usage:
+Until more thorough documentation is available, please see the tests:
++ [`LibStorj`](./spec/ruby-libstorj/libstorj_spec.rb) _[(source)](./lib/ruby-libstorj/libstorj.rb)_
+    - `LibStorj::Ext::Storj::Mixins`  _[(source)](./lib/ruby-libstorj/mixins/storj.rb)_
+        - `.util_timestamp`
+        - `.util_datetime`
+        - `.mnemonic_check`
+        - `.mnemonic_generate`
++ [`LibStorj::Env`](./spec/ruby-libstorj/env_spec.rb) _[(source)](./lib/ruby-libstorj/env.rb)_
+    - `#get_info`
+    - `#get_buckets`
+    - `#create_bucket`
+    - `#delete_bucket`
+    - `#store_file`
+    - `#resolve_file`
+    - `#list_files`
+    - `#delete_file`
 
 ## Developing ruby-libstorj
 
 This project primarily uses the ruby [`ffi`](https://rubygems.org/gems/ffi) (foreign function interface) gem api to bind to C/C++ libraries and plain old ruby for logic.
 
-If the ffi api becomes insufficient the ruby gem [`rice`](https://rubygems.org/gems/rice) has proven extremely useful for doing rub things in C/C++.
+If the ffi api becomes insufficient the ruby gem [`rice`](https://rubygems.org/gems/rice) has proven extremely useful for doing ruby things in C/C++.
 Otherwise, you're going to want to read up on [ruby's C API](https://silverhammermba.github.io/emberb/c/)
 
 This project strives to conform to the ruby  and rubygems standards and conventions. See [rubygems.org guide on "Make Your Own Gem"](http://guides.rubygems.org/make-your-own-gem/) for more.

data/ruby-libstorj.gemspec

@@ -4,7 +4,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'ruby-libstorj'
-  gem.version       = '1.0.0' #LibStorj::VERSION
+  gem.version       = '1.0.1' #LibStorj::VERSION
   gem.license       = 'AGPL-3.0'
   gem.authors       = ['Bryan White']
   gem.email         = ['bryanchriswhite@gmail.com', 'bryan@storj.io']
@@ -19,10 +19,11 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.0.0'
   gem.require_paths = ['lib']
 
-  # TODO: is this necessary?
-  # gem.add_runtime_dependency     '<gem name>', '~> <version>'
-  #
-  # gem.add_development_dependency '<gem name', '~> <version>'
+  gem.add_runtime_dependency     'ffi', '~> 1.9'
+  gem.add_runtime_dependency     'libuv', '~> 3.2'
+
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rake-compiler', '~> 1.0'
 
   gem.files         = `git ls-files`.split("\n").reject {|f| f =~ /^test/}
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-libstorj
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bryan White
@@ -9,7 +9,63 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2018-03-20 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: libuv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Ruby bindings to the libstorj C Storj API library
 email:
 - bryanchriswhite@gmail.com
@@ -22,6 +78,7 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - Guardfile