ruby-libstorj 0.0.0

data/spec/helpers/upload.data

@@ -0,0 +1,3 @@
+### THIS FILE IS USED AS TEST UPLOAD DATA ###
+
+437BCEF6073012E7BB6C23D88F9BE07FF070AADBCEF5681CD2F7CB87C19F0EFF3C4A015169E090820DB22FF30CF9EF316A1685822E2F59BEFF7C04322919107FFC2CC4AF5FF94CA7D453BF0CA3156CF1407AA92994ED4F57B068C8652578C889615A9F703C87F5508AAD40C856363BF3BC31F4E875D7F7BD9DB3CFFD06808168E70AEFAFBBAAC5F6D41907513FEBF1ED0FB33A5FD53B50655F2428330FE15C19DE8CF1CC456D5D60B92E71F19BCE2880DA79373B5B75F3B06BA542A269B3DEEABD1D9094AD493576DA4B555ADCE3E63FC888097744D89B1362B1D906D0497DBA368A1BBCD88450620F6BBA2DDC2EB16F6D5538B5C39D1B542184CD515AB4557645983C98AD33797B07D523B6904916A9E3657EAEC3C94B18FADDD700CC5CCAB541CED98EAA765AD57D9C330D00E095AB9405C5181BED57777A5AC1D8FAD65CA770B8C94B1798A475274248381CAFD4761C98D4A7BE85B4761B225BA951FDFCEA45D6FE6C208BC7AE7668196520F1A8933E606A2FEC8F0DADBC17DC3FAC20D426068A0DDE6C38749A7989D544638786B84B64FC50C4C13A7DB2791815CC16D5410561DFFC433F1D1B2403C6284DDD50B2F584BB501239C3D992D4C418F5A670B79A79E8C11045D9C45D373AB31D751EC03B217624D8475BAF1142EBDA1DC633B981E5A602CA575DDDD51BEA56F3AC8B3A17CE54FC46BAE93F885CBCB3C5813718BDEC53DAC6E6300341272B61F8F96945B9F2096F3EDFF89F0E0B23A13880AFC4BAD83A08DC660C04C6013C152F04E8C62C3FF29AB2D9E666207E3822FDE1646FD090E90AEDA012ADC79521C98EF78819E52068B807AE5F108B3DAED9417B5AD57BEED4FBF0D2A421E435EDFBF4C3DAF0F2598317B25CCD933F93832616ED9F97436629760926C99A392E8AB31B4913F6812CC511E08F46834A1B2094159A45198954C7A3A19DD2679795FB799F8FCE6D81DFDE63E354189A6A2CB35551399D7A0E7E23D536D88A14EAEB7772749E891AB8495388F8A537C7A1DEE1628892BB05D6CE6EE3DA6F97F755D8CC6C96A7A62F09CE9D41328F71BB50ACD1363F7CDB33BAC2593511AE02933FC83011117CC87030DE1284677BE2DC3345A0DEB10AA3C3C49C85314414255ACA573E192E38BC0B8EC5ADC99676E732B43A179A8C9314BD5E78C14BED915E367F7B5276C7C05547F3DF98BBBE69C5BDF6BAFBEBC2AB8BCD3B559029AE171576B9469B28BF400D0573E3E65E289BE8AFA53F48B16378DB52EC47FE13DF4C648DED9AD23A62BC51D5000E838961222285E5043E6A78EEB76715ECB0928E1E40E997114478DC5ECE8E78CC585449972E6A413E9FF19523CD57D82553F29C36F698C55B5A0B4C5DD9AD8DABA7CDC0452D99EECF2EA7BAFC7CF61A50E8CC9787E94B8F8B2187233F4534AFB0143811F2C3F7964CD1BE7301D990

data/spec/helpers/upload.data.sha256

@@ -0,0 +1 @@
+ddf547ddef6cacefe9c05879118fe423e67decae872723babde64550378c732f

data/spec/ruby-libstorj/arg_forwarding_task_spec.rb

@@ -0,0 +1,311 @@
+require 'rake'
+require_relative '../helpers/shared_rake_examples'
+require_relative '../../lib/ruby-libstorj/arg_forwarding_task'
+
+RSpec.describe LibStorj::ArgForwardingTask do
+  let(:instantiate) do
+    described_class.new task_name,
+                        alias_names: alias_names,
+                        args_deps_hash: {args => deps},
+                        &task_block
+  end
+
+  describe 'example_task' do
+    let(:task_name) {:example_task}
+
+    context 'without block' do
+      let(:task_block) {nil}
+
+      context 'without aliases' do
+        let(:alias_names) {[]}
+
+        context 'with args' do
+          let(:args) {%i[first_arg second_arg third_arg]}
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'raises `ArgumentError`'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+
+            include_examples 'raises `ArgumentError`'
+          end
+        end
+
+        context 'without args' do
+          let(:args) {[]}
+          let(:expected_args) {{}}
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'raises `ArgumentError`'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'raises `ArgumentError`'
+          end
+        end
+      end
+
+      context 'with aliases' do
+        let(:alias_names) {%i[first_alias second_alias third_alias]}
+
+        context 'without args' do
+          let(:args) {[]}
+          let(:expected_args) {{}}
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'gets invoked via any alias'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            before do
+              deps.each do |dep_name|
+                Rake::Task.define_task dep_name
+              end
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'gets invoked via any alias'
+            include_examples 'invokes all dependencies when invoked'
+            include_examples 'invokes all dependencies when invoked via any alias'
+          end
+        end
+
+        context 'with args' do
+          let(:args) {%i[first_arg second_arg third_arg]}
+          let(:expected_args) do
+            ### #=> {:first_arg => :first_value, ...}
+            Hash[args.zip(%i[first_value second_value third_value])]
+          end
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'defines the target task'
+            # include_examples 'gets invoked with args via any alias'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            before do
+              deps.each do |dep_name|
+                Rake::Task.define_task dep_name
+              end
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'gets invoked with args via any alias'
+            include_examples 'invokes all dependencies when invoked'
+            include_examples 'invokes all dependencies when invoked via any alias'
+          end
+        end
+      end
+    end
+
+    context 'with block' do
+      let(:task_block) do
+        Proc.new do
+          #-- noop
+        end
+      end
+
+      context 'without aliases' do
+        let(:alias_names) {[]}
+
+        context 'without args' do
+          let(:args) {[]}
+          let(:expected_args) {{}}
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'yields to the block'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            before do
+              deps.each do |dep_name|
+                Rake::Task.define_task dep_name
+              end
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'yields to the block'
+            include_examples 'invokes all dependencies when invoked'
+          end
+        end
+
+        context 'with args' do
+          let(:args) {%i[first_arg second_arg third_arg]}
+          let(:expected_args) do
+            ### #=> {:first_arg => :first_value, ...}
+            Hash[args.zip(%i[first_value second_value third_value])]
+          end
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'yields to the block'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            before do
+              deps.each do |dep_name|
+                Rake::Task.define_task dep_name
+              end
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'yields to the block'
+            include_examples 'invokes all dependencies when invoked'
+          end
+        end
+      end
+
+      context 'with aliases' do
+        let(:alias_names) {%i[first_alias second_alias third_alias]}
+
+        context 'without args' do
+          let(:args) {[]}
+          let(:expected_args) {{}}
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'gets invoked via any alias'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            before do
+              deps.each do |dep_name|
+                Rake::Task.define_task dep_name
+              end
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'gets invoked via any alias'
+            include_examples 'invokes all dependencies when invoked'
+            include_examples 'invokes all dependencies when invoked via any alias'
+          end
+        end
+
+        context 'with args' do
+          let(:args) {%i[first_arg second_arg third_arg]}
+          let(:expected_args) do
+            ### #=> {:first_arg => :first_value, ...}
+            Hash[args.zip(%i[first_value second_value third_value])]
+          end
+
+          context 'without deps' do
+            let(:deps) {[]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'gets invoked with args via any alias'
+          end
+
+          context 'with deps' do
+            let(:deps) {%i[first_dep second_dep third_dep]}
+
+            before :all do
+              Rake.application = Rake::Application.new
+            end
+
+            before do
+              deps.each do |dep_name|
+                Rake::Task.define_task dep_name
+              end
+            end
+
+            include_examples 'defines the target task'
+            include_examples 'gets invoked with args via any alias'
+            include_examples 'invokes all dependencies when invoked'
+            include_examples 'invokes all dependencies when invoked via any alias'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/ruby-libstorj/env_spec.rb

@@ -0,0 +1,353 @@
+require 'openssl'
+require_relative '../helpers/storj_options'
+include LibStorjTest
+
+RSpec.describe LibStorj::Env do
+  let(:bucket_class) {::LibStorj::Ext::Storj::Bucket}
+  let(:file_class) {::LibStorj::Ext::Storj::File}
+  let(:instance) do
+    described_class.new(*default_options)
+  end
+
+  after :each do
+    # (see https://github.com/Storj/ruby-libstorj/issues/2)
+    # Process.RLIMIT_MEMLOCK #=> 8
+    instance.destroy
+  end
+
+  describe 'new' do
+    it 'returns an instance of the described class' do
+      expect(instance).to be_an_instance_of(described_class)
+    end
+  end
+
+  describe '@storj_env' do
+    it 'does not point to NULL' do
+      expect(instance.storj_env.to_ptr).not_to equal(FFI::Pointer::NULL)
+    end
+
+    it 'is an instance of the struct wrapper corresponding to its C analogue' do
+      expect(instance.storj_env).to be_an_instance_of(described_class::C_ANALOGUE)
+    end
+  end
+
+  describe '#get_info' do
+    context 'without error' do
+      it 'yields with an nil error and hash response' do
+        yielded = false
+        instance.get_info do |error, info|
+          expect(error).to be(nil)
+          expect(info).to be_an_instance_of(Hash)
+          yielded = true
+        end
+
+        wait_for(yielded).to be_truthy
+      end
+    end
+
+    context 'with error' do
+      it 'yields with an error and nil response' do
+        instance.storj_env[:bridge_options][:host].write_string 'a.nonexistant.example'
+
+        expect do |block|
+          instance.get_info(&block)
+        end.to yield_with_args(/couldn't resolve host name/i, nil)
+      end
+    end
+  end
+
+  describe '#get_buckets' do
+    context 'without error' do
+      let(:bucket_names) {%w[bucket1 bucket2 bucket3]}
+
+      before do
+        bucket_names.each &instance.method(:create_bucket)
+      end
+
+      after do
+        bucket_names.each &instance.method(:delete_bucket)
+      end
+
+      it 'yields a nil error and an array of buckets' do
+        expect do |block| #{|block| instance.get_bucekts(&block)}.to yield_with_args
+          instance.get_buckets do |error, buckets|
+            expect(error).to be(nil)
+            expect(buckets.length).to be(bucket_names.length)
+            expect(buckets).to satisfy do |buckets|
+              bucket_names = buckets.map(&:name)
+              names_match = bucket_names.all? &bucket_names.method(:include?)
+              are_all_buckets = buckets.all? do |bucket|
+                bucket.is_a? bucket_class
+              end
+
+              names_match && are_all_buckets
+            end
+          end
+        end
+      end
+    end
+
+    context 'with error' do
+      it 'yields with a non-nil error value and nil response' do
+        # (see https://tools.ietf.org/html/rfc2606)
+        instance.storj_env[:bridge_options][:host].write_string 'a.nonexistant.example'
+
+        expect do |block|
+          instance.get_buckets(&block)
+        end.to yield_with_args(/couldn't resolve host name/i, nil)
+      end
+    end
+  end
+
+  describe '#create_bucket' do
+    let(:test_bucket_name) {'test'}
+
+    # TODO: refactor error contexts into shared example group 'api request'
+    context 'without error' do
+      let(:bucket_class) {::LibStorj::Ext::Storj::Bucket}
+
+      def clean_buckets(&block)
+        catch(:no_bucket) do
+          return get_test_bucket_id do |id|
+            instance.delete_bucket(id, &block)
+          end
+        end
+
+        yield if block_given?
+      end
+
+      after do
+        clean_buckets
+      end
+
+      it 'yields with nil error and the new bucket' do
+        clean_buckets do
+          instance.create_bucket(test_bucket_name) do |error, bucket|
+            expect(error).to be(nil)
+            expect(bucket).to be_an_instance_of(bucket_class)
+          end
+          sleep 3
+        end
+      end
+    end
+
+    context 'with error' do
+      describe 'external error' do
+        it 'yields with a non-nil error value and nil response' do
+          # (see https://tools.ietf.org/html/rfc2606)
+          instance.storj_env[:bridge_options][:host].write_string 'a.nonexistant.example'
+
+          expect do |block|
+            instance.create_bucket(test_bucket_name, &block)
+          end.to yield_with_args(/couldn't resolve host name/i, nil)
+        end
+      end
+
+      describe 'bucket name in use' do
+        before do
+          instance.create_bucket(test_bucket_name)
+        end
+
+        it 'yields with a bucket name in use error' do
+          # (see https://tools.ietf.org/html/rfc2606)
+          expect do |block|
+            instance.create_bucket(test_bucket_name, &block)
+          end.to yield_with_args(/name already used by another bucket/i, nil)
+        end
+      end
+    end
+  end
+
+  describe '#delete_bucket' do
+    let(:test_bucket_name) {'test'}
+
+    before :each do
+      instance.create_bucket(test_bucket_name)
+    end
+
+    # TODO: refactor error contexts into shared example group 'api request'
+    context 'without error' do
+      let(:bucket_class) {::LibStorj::Ext::Storj::Bucket}
+
+      it 'yields with nil error' do
+        get_test_bucket_id do |id|
+          instance.delete_bucket(id) do |error|
+            expect(error).to be(nil)
+          end
+        end
+      end
+    end
+
+    context 'with error' do
+      describe 'external error' do
+        it 'yields with a non-nil error value and nil response' do
+          # (see https://tools.ietf.org/html/rfc2606)
+          instance.storj_env[:bridge_options][:host].write_string 'a.nonexistant.example'
+
+          expect do |block|
+            instance.delete_bucket(test_bucket_name, &block)
+          end.to yield_with_args(/couldn't resolve host name/i)
+        end
+      end
+
+      xdescribe 'malformed id error' do
+        let(:malformed_bucket_id) {'this is not what a bucket id looks like'}
+
+        it 'yields with a malformed id error' do
+          instance.delete_bucket(malformed_bucket_id) do |error|
+            expect(error).to match(/bucket id is malformed/i)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#store_file' do
+    let(:test_bucket_name) {'test'}
+    let(:test_file_name) {'test.data'}
+    let(:test_file_path) {File.join %W(#{__dir__} .. helpers upload.data)}
+    let(:options) {{
+        file_name: test_file_name
+    }}
+    let(:progress_proc) {Proc.new do
+      # ensure this block is called
+    end}
+
+    before do
+      done = nil
+      instance.create_bucket test_bucket_name do
+        done = true
+      end
+
+      wait_for(done).to be_truthy
+    end
+
+    context 'without error' do
+      it 'uploads a file of the same size to the the specified bucket' do
+        get_test_bucket_id do |test_bucket_id|
+          state = instance.store_file bucket_id: test_bucket_id,
+                              file_path: test_file_path,
+                              options: options,
+                              progress_proc: progress_proc do |file_id|
+            if file_id.nil?
+              fail %q(Please ensure the test file doesn't already exist; TODO: automate this)
+            end
+
+            expect(file_id).to match(/\w+/i)
+            # ensure this block is called
+          end
+        end
+      end
+    end
+  end
+
+  describe '#resolve_file' do
+    let(:test_bucket_name) {'test'}
+    let(:test_file_name) {'test.data'}
+    let(:test_file_path) {File.join %W(#{__dir__} .. helpers download.data)}
+    let(:expected_hash) {File.read test_file_path}
+    let(:test_file_hash) {
+      data = File.read test_file_path
+      OpenSSL::Digest::SHA256.hexdigest data
+    }
+    let(:progress_proc) {Proc.new do
+      # ensure this block gets called
+    end}
+
+    after :each do
+      if File.exists? test_file_path
+        File.unlink test_file_path
+      end
+    end
+
+    context 'without error' do
+      it 'downloads a file with the same sha256sum as the uploaded test data' do
+        get_test_file_id do |test_bucket_id, test_file_id|
+          instance.resolve_file bucket_id: test_bucket_id,
+                                file_id: test_file_id,
+                                file_path: test_file_path,
+                                progress_proc: progress_proc do |*args|
+            # ensure this block is called
+            expect(expected_hash).to equal(test_file_hash)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#list_files' do
+    #NB: `#list_files` test requires files be added to the `test` bucket;
+    #TODO: automate this'
+    let(:test_bucket_name) {'test'}
+
+    context 'without error' do
+      it 'yields with a nil error and an array of files' do
+        get_test_bucket_id do |test_bucket_id|
+          instance.list_files(test_bucket_id) do |error, files|
+            expect(error).to be(nil)
+            expect(files).to be_an_instance_of(Array)
+            expect(files).to satisfy do |files|
+              files.all? {|file| file.is_a? file_class}
+            end
+          end
+        end
+      end
+    end
+
+    context 'with error' do
+      describe 'external error' do
+        it 'yields with a non-nil error value and nil response' do
+          # (see https://tools.ietf.org/html/rfc2606)
+          instance.storj_env[:bridge_options][:host].write_string 'a.nonexistant.example'
+
+          expect do |block|
+            instance.list_files(test_bucket_name, &block)
+          end.to yield_with_args(/couldn't resolve host name/i, nil)
+        end
+      end
+
+      xdescribe 'malformed id error' do
+        let(:malformed_bucket_id) {'this is not what a bucket id looks like'}
+
+        it 'yields with a malformed id error' do
+          instance.list_files(malformed_bucket_id) do |error|
+            expect(error).to match(/bucket id is malformed/i)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#delete_file' do
+    let(:test_bucket_name) {'test'}
+    let(:test_file_name) {'test.data'}
+    let(:test_file_path) {File.join %W(#{__dir__} .. helpers upload.data)}
+
+    context 'without error' do
+      it 'yields with nil error and the new bucket' do
+        get_test_file_id do |test_file_id, test_bucket_id|
+          instance.delete_file test_bucket_id, test_file_id do |error|
+            expect(error).to be_nil
+            instance.list_files test_bucket_id do |error, files|
+              file_was_deleted = files.nil? || files.any {|file| file.name == test_file_name}
+              expect(file_was_deleted).to be_truthy
+            end
+          end
+        end
+      end
+    end
+
+    context 'with error' do
+      describe 'external error' do
+        it 'yields with a non-nil error value and nil response' do
+          # (see https://tools.ietf.org/html/rfc2606)
+          instance.storj_env[:bridge_options][:host].write_string 'a.nonexistant.example'
+
+          expect do |block|
+            instance.create_bucket(test_bucket_name, &block)
+          end.to yield_with_args(/couldn't resolve host name/i, nil)
+        end
+      end
+    end
+  end
+end