bucket_client 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bucket_client"
+
+# 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(__FILE__)

data/bin/setup

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

data/bucket_client.gemspec

@@ -0,0 +1,46 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bucket_client/version"
+
+Gem::Specification.new do |spec|
+	spec.name = "bucket_client"
+	spec.version = BucketClient::VERSION
+	spec.authors = ["kirinnee"]
+	spec.email = ["kirinnee97@gmail.com"]
+
+	spec.summary = %q{A gem that allows for ruby code to interact with cloud blob storage such as AWS S3, GCP Cloud
+Storage and Azure Blob Storage}
+	spec.description = %q{Bucket Client is a ruby gem that allows programmers to interact with popular Blob Storage cloud
+services. This intends to act as a layer of abstraction, much like ORM is to databases.
+
+With this, you may easily change the blob storage provider or even defer them.
+
+The supported cloud storage include:
+- Google Cloud Platform Cloud Storage
+- Amazon Web Service S3 Bucket
+- Digital Ocean Spaces
+- Azure Blob Storage (Microsoft).}
+	spec.homepage = "https://gitlab.com/ruby-gem/bucket_client"
+	spec.license = "MIT"
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+		`git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/})}
+	end
+	spec.bindir = "exe"
+	spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
+	spec.require_paths = ["lib"]
+
+	spec.add_dependency "kirin_http"
+	spec.add_dependency "mimemagic"
+	spec.add_dependency "ox"
+	spec.add_dependency "azure-storage-blob"
+	spec.add_dependency 'addressable', '~> 2.5'
+	spec.add_dependency 'google-cloud-storage', '~> 1.17'
+
+	spec.add_development_dependency "bundler", "~> 1.17"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
+	spec.add_development_dependency "dotenv"
+end

data/integration/aws_blob_spec.rb

@@ -0,0 +1,134 @@
+require "bucket_client/aws/aws_bucket"
+require "bucket_client/aws/aws_client"
+require "kirin_http"
+
+describe BucketClient::AWSBucket do
+	http = KirinHttp::BasicClient.new
+	id = ENV["AWS_ID"]
+	secret = ENV["AWS_SECRET"]
+	region = ENV["AWS_REGION"]
+	client = BucketClient::AWSClient.new(http, id, secret, region)
+	key = "kirin.bucket.client.bucket.integration"
+	file = "img.jpg"
+	bin = IO.binread "./integration/#{file}"
+	before(:all) {client.put_bucket key}
+	after(:all) {
+		bucket = client.get_bucket key
+		bucket.delete_blob_if_exist file
+		client.delete_bucket_if_exist key
+	}
+
+
+	describe 'Blob Behaviour' do
+		bucket = client.get_bucket! key
+		describe 'exist_blob' do
+			it 'should return false as blob does not exist' do
+				expect(bucket.exist_blob file).to be_falsey
+			end
+		end
+
+		describe 'delete_blob_if_exist' do
+			it 'should succeed' do
+				result = bucket.delete_blob_if_exist file
+				expect(result.code).to eq 204
+				expect(result.success).to be_truthy
+			end
+		end
+
+		describe 'delete_blob' do
+			it 'should fail as blob does not exist' do
+				result = bucket.delete_blob file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe 'update_blob' do
+			it 'should fail as blob does not exist' do
+				result = bucket.update_blob bin, file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe 'get_blob' do
+			it 'should fail as blob does not exist' do
+				result = bucket.get_blob file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe "put_blob" do
+			it 'should succeed' do
+				result = bucket.put_blob bin, file
+				expect(result).to be_truthy
+				expect(result.value).to eq "https://s3-#{region}.amazonaws.com/#{key}/#{file}"
+			end
+		end
+
+		describe 'exist_blob' do
+			it 'should exist' do
+				expect(bucket.exist_blob file).to be_truthy
+			end
+		end
+
+		describe "create_blob" do
+			it 'should fail as blob already exist' do
+				result = bucket.create_blob bin, file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe "get_blob" do
+			it 'should obtain the binary of the blob' do
+				result = bucket.get_blob file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq bin
+			end
+		end
+
+		describe "delete_blob" do
+			it 'should pass as blob exist' do
+				result = bucket.delete_blob file
+				expect(result.success).to be_truthy
+			end
+		end
+
+		describe "create_blob" do
+			it 'should work as blob does not exist' do
+				result = bucket.create_blob bin, file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq "https://s3-#{region}.amazonaws.com/#{key}/#{file}"
+			end
+		end
+
+		describe "update_blob" do
+			it 'should work as blob exist' do
+				result = bucket.update_blob bin, file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq "https://s3-#{region}.amazonaws.com/#{key}/#{file}"
+			end
+		end
+
+		describe "put_blob" do
+			it 'should work as blob exist' do
+				result = bucket.put_blob bin, file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq "https://s3-#{region}.amazonaws.com/#{key}/#{file}"
+			end
+		end
+
+		describe "delete_blob_if_exist" do
+			it 'should delete blob' do
+				result = bucket.delete_blob_if_exist file
+				expect(result.success).to be_truthy
+			end
+		end
+
+		describe "exist_blob" do
+			it 'should no longer exist' do
+				expect(bucket.exist_blob file).to be_falsey
+			end
+		end
+
+	end
+
+end

data/integration/aws_bucket_spec.rb

@@ -0,0 +1,145 @@
+require "bucket_client/aws/aws_bucket"
+require "bucket_client/aws/aws_client"
+require "kirin_http"
+
+describe BucketClient::AWSClient do
+
+	http = KirinHttp::BasicClient.new
+	id = ENV["AWS_ID"]
+	secret = ENV["AWS_SECRET"]
+	region = ENV["AWS_REGION"]
+	client = BucketClient::AWSClient.new(http, id, secret, region)
+	key = "kirin.bucket.client.client.integration"
+
+
+	before(:all) {client.delete_bucket_if_exist key}
+	after(:all) {client.delete_bucket_if_exist key}
+
+	describe 'exist_bucket' do
+		it 'should return false' do
+			expect(client.exist_bucket key).to be_falsey
+		end
+	end
+
+	describe 'delete_bucket_if_exist' do
+		it 'should be successful' do
+			result = client.delete_bucket_if_exist key
+			expect(result.code).to eq 204
+			expect(result.success).to be_truthy
+			expect(result.message).to eq "Bucket already deleted"
+		end
+	end
+
+	describe 'delete_bucket' do
+		it 'should fail as bucket does not exist' do
+			result = client.delete_bucket key
+			expect(result.code).to eq 404
+			expect(result.success).to be_falsey
+			expect(result.value).to be_nil
+		end
+	end
+
+	describe "set_read_policy" do
+		it 'should fail as bucket does not exist' do
+			result = client.set_read_policy key, :public
+			expect(result.code).to eq 404
+			expect(result.success).to be_falsey
+			expect(result.value).to be_nil
+		end
+	end
+
+	describe "set_get_cors" do
+		it 'should fail as bucket does notexist' do
+			result = client.set_get_cors key, ["*"]
+			expect(result.code).to eq 404
+			expect(result.success).to be_falsey
+			expect(result.value).to be_nil
+		end
+	end
+
+	describe "get_bucket!" do
+		it 'should generate unsafe bucket with correct key' do
+			bucket = client.get_bucket! key
+			expect(bucket.key).to eq key
+		end
+	end
+
+	describe "put_bucket" do
+		it 'should create new bucket' do
+			result = client.put_bucket key
+			expect(result.code).to eq 200
+			expect(result.success).to be_truthy
+			expect(result.value.key).to eq key
+			sleep(10)
+		end
+	end
+
+	describe 'create_bucket' do
+		it 'should fail creating a new bucket because it already exist' do
+
+			expect(client.exist_bucket key).to be_truthy
+			result = client.create_bucket key
+			expect(result.code).to eq 409
+			expect(result.success).to be_falsey
+			expect(result.value).to be_nil
+		end
+	end
+
+	describe 'delete_bucket' do
+		it 'should succeed deleting a new bucket' do
+			result = client.delete_bucket key
+			expect(result.code).to eq 204
+			expect(result.success).to be_truthy
+		end
+	end
+
+	describe "create_bucket" do
+		it 'should succeed at creating a new bucket' do
+			result = client.create_bucket key
+			expect(result.code).to eq 200
+			expect(result.success).to be_truthy
+			expect(result.value.key).to eq key
+		end
+	end
+
+	describe 'put_bucket' do
+		it 'should not fail even if bucket already exist' do
+			result = client.put_bucket key
+			expect(result.code).to eq 200
+			expect(result.success).to be_truthy
+			expect(result.value.key).to eq key
+		end
+	end
+
+	describe "set_read_policy" do
+		it 'should fail if access is neither :public or :private' do
+			expect {client.set_read_policy key, :protected}.to raise_error(ArgumentError, "Read Policy not accepted")
+		end
+		it 'should succeed' do
+			result = client.set_read_policy key, :public
+			expect(result.code).to eq 204
+			expect(result.success).to be_truthy
+			expect(result.value).to be_nil
+		end
+	end
+
+	describe "set_get_cors" do
+		it 'should should succeed' do
+			result = client.set_get_cors key, ["*"]
+			expect(result.code).to eq 200
+			expect(result.success).to be_truthy
+			expect(result.value).to be_nil
+		end
+	end
+
+	describe "delete_bucket_if_exist" do
+		it 'should remove existing bucket' do
+			result = client.delete_bucket_if_exist key
+			expect(result.code).to eq 204
+			expect(result.success).to be_truthy
+			expect(result.value).to be_nil
+			expect(client.exist_bucket key).to be_falsey
+		end
+	end
+
+end

data/integration/azure_blob_spec.rb

@@ -0,0 +1,132 @@
+require "bucket_client/azure/azure_bucket"
+require "bucket_client/azure/azure_client"
+
+describe BucketClient::AzureBucket do
+	id = ENV["AZURE_ACC_ID"]
+	secret = ENV["AZURE_KEY"]
+	client = BucketClient::AzureClient.new(id, secret)
+	key = "kirin-bucket-client-bucket-integration"
+	file = "img.jpg"
+	bin = IO.binread "./integration/#{file}"
+
+	before(:all) {client.put_bucket key}
+	after(:all) {
+		bucket = client.get_bucket key
+		bucket.delete_blob_if_exist file
+		client.delete_bucket_if_exist key
+	}
+
+
+	describe 'Blob Behaviour' do
+		bucket = client.get_bucket! key
+		describe 'exist_blob' do
+			it 'should return false as blob does not exist' do
+				expect(bucket.exist_blob file).to be_falsey
+			end
+		end
+
+		describe 'delete_blob_if_exist' do
+			it 'should succeed' do
+				result = bucket.delete_blob_if_exist file
+				expect(result.code).to eq 204
+				expect(result.success).to be_truthy
+			end
+		end
+
+		describe 'delete_blob' do
+			it 'should fail as blob does not exist' do
+				result = bucket.delete_blob file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe 'update_blob' do
+			it 'should fail as blob does not exist' do
+				result = bucket.update_blob bin, file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe 'get_blob' do
+			it 'should fail as blob does not exist' do
+				result = bucket.get_blob file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe "put_blob" do
+			it 'should succeed' do
+				result = bucket.put_blob bin, file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq "https://#{id}.blob.core.windows.net/#{key}/#{file}"
+			end
+		end
+
+		describe 'exist_blob' do
+			it 'should exist' do
+				expect(bucket.exist_blob file).to be_truthy
+			end
+		end
+
+		describe "create_blob" do
+			it 'should fail as blob already exist' do
+				result = bucket.create_blob bin, file
+				expect(result.success).to be_falsey
+			end
+		end
+
+		describe "get_blob" do
+			it 'should obtain the binary of the blob' do
+				result = bucket.get_blob file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq bin
+			end
+		end
+
+		describe "delete_blob" do
+			it 'should pass as blob exist' do
+				result = bucket.delete_blob file
+				expect(result.success).to be_truthy
+			end
+		end
+
+		describe "create_blob" do
+			it 'should work as blob does not exist' do
+				result = bucket.create_blob bin, file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq "https://#{id}.blob.core.windows.net/#{key}/#{file}"
+			end
+		end
+
+		describe "update_blob" do
+			it 'should work as blob exist' do
+				result = bucket.update_blob bin, file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq "https://#{id}.blob.core.windows.net/#{key}/#{file}"
+			end
+		end
+
+		describe "put_blob" do
+			it 'should work as blob exist' do
+				result = bucket.put_blob bin, file
+				expect(result.success).to be_truthy
+				expect(result.value).to eq "https://#{id}.blob.core.windows.net/#{key}/#{file}"
+			end
+		end
+
+		describe "delete_blob_if_exist" do
+			it 'should delete blob' do
+				result = bucket.delete_blob_if_exist file
+				expect(result.success).to be_truthy
+			end
+		end
+
+		describe "exist_blob" do
+			it 'should no longer exist' do
+				expect(bucket.exist_blob file).to be_falsey
+			end
+		end
+
+	end
+
+end