bucket_client 0.1.0

data/integration/do_bucket_spec.rb

@@ -0,0 +1,144 @@
+require "bucket_client/digital_ocean/digital_ocean_bucket"
+require "bucket_client/digital_ocean/digital_ocean_client"
+require "kirin_http"
+
+describe BucketClient::DigitalOceanClient do
+
+	http = KirinHttp::BasicClient.new
+	id = ENV["DO_ID"]
+	secret = ENV["DO_SECRET"]
+	region = ENV["DO_REGION"]
+	client = BucketClient::DigitalOceanClient.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
+		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 200
+			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/gcp_blob_spec.rb

@@ -0,0 +1,132 @@
+require "bucket_client/digital_ocean/digital_ocean_bucket"
+require "bucket_client/digital_ocean/digital_ocean_client"
+require "kirin_http"
+
+describe BucketClient::GCPBucket do
+	id = ENV["GOOGLE_ID"]
+	secret = JSON.parse(ENV["GOOGLE_KEY"])
+	client = BucketClient::GCPClient.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://storage.googleapis.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://storage.googleapis.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://storage.googleapis.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://storage.googleapis.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/gcp_bucket_spec.rb

@@ -0,0 +1,132 @@
+require "bucket_client/azure/azure_bucket"
+require "bucket_client/azure/azure_client"
+require "json"
+
+describe BucketClient::GCPClient do
+
+	id = ENV["GOOGLE_ID"]
+	secret = JSON.parse(ENV["GOOGLE_KEY"])
+	client = BucketClient::GCPClient.new(id, secret)
+	key = "kirin-bucket-client-client"
+
+	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 200
+			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 400
+			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
+		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 400
+			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 200
+			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/lib/bucket_client.rb

@@ -0,0 +1,66 @@
+require "bucket_client/version"
+require "bucket_client/operation_result"
+require "bucket_client/bucket_operation_exception"
+require "bucket_client/bucket"
+require "bucket_client/client"
+require "bucket_client/aws/aws_client"
+require "bucket_client/digital_ocean/digital_ocean_client"
+require "bucket_client/azure/azure_client"
+require "bucket_client/gcp/gcp_client"
+require "bucket_client/dev/local_client"
+require "kirin_http"
+
+module BucketClient
+
+	# @param [Symbol] type the type of client to generate. Accepts
+	# :local for local,
+	# :aws for AWS S3 Bucket
+	# :azure for Azure Blob Storage
+	# :spaces for DigitalOcean Spaces
+	# :gcp for Google Cloud Platform Storage Account
+	# @param [String] id The id for the client. Only applicable to :aws, :azure, :spaces and :gcp
+	# For GCP, this is your project id
+	# For AWS, this is your access ID
+	# For Digital Ocean spaces, this is your access ID
+	# For Azure, this is your account name for your blob storage account
+	# @param [String or Hash] secret The secret for the client. Only applicable to :aws, :azure, :spaces and :gcp
+	# For GCP, this can either be a path to your secret.json, or it can be the JSON serialized as a hash.
+	# For AWS, this is your secret key
+	# For Digital Ocean spaces, this is your secret key
+	# For Azure, this is your secret key
+	# @param [String] region The region of your bucket. Only applicable to :aws and :spaces
+	# For AWS, this is your region string. eg: ap-southeast-1
+	# For Digital Ocean Spaces, this is your region string. ep: sgp1
+	# @param [String] path The local path for mocking a bucket (using disk). Only applicable to :local
+	# @param [String] principal The public path of the bucket. Will use value of "path" if not provided. Only applicable to :local
+	# @return [BucketClient::Client]
+	def BucketClient.generate(type: :local, id: nil, secret: nil, region: nil, path: nil, principal: nil)
+		http = KirinHttp::BasicClient.new
+		case type
+			when :local
+				raise ArgumentError.new("Path not provided") if path.nil?
+				LocalClient.new(path, principal)
+			when :aws
+				raise ArgumentError.new("id not provided") if id.nil?
+				raise ArgumentError.new("secreted not provided") if secret.nil?
+				raise ArgumentError.new("region not provided") if region.nil?
+				AWSClient.new(http, id, secret, region)
+			when :azure
+				raise ArgumentError.new("account name/id not provided") if id.nil?
+				raise ArgumentError.new("secret not provided") if secret.nil?
+				AzureClient.new(id, secret)
+			when :spaces
+				raise ArgumentError.new("id not provided") if id.nil?
+				raise ArgumentError.new("secreted not provided") if secret.nil?
+				raise ArgumentError.new("region not provided") if region.nil?
+				DigitalOceanClient.new(http, id, secret, region)
+			when :gcp
+				raise ArgumentError.new("project id not provided") if id.nil?
+				raise ArgumentError.new("secret not provided") if secret.nil?
+				GCPClient.new(id, secret)
+			else
+				raise ArgumentError.new("Unknown Client type: " + type.to_s)
+		end
+	end
+
+end