bucket_client 0.1.0

data/lib/bucket_client/digital_ocean/digital_ocean_http_client.rb

@@ -0,0 +1,31 @@
+module BucketClient
+	class DigitalOceanHttpClient
+		# @param [Client::AWS4RequestSigner] signer aws4 signer
+		# @param [String] region region of the service
+		# @param [KirinHttp::Client] http Http client to send http Message
+		def initialize(signer, region, http)
+			@signer = signer
+			@region = region
+			@http = http
+		end
+
+		# @param [Symbol] method
+		# @param [String] endpoint
+		# @param [Object] content
+		# @param [String] type
+		# @param [String] accept
+		# @param [Hash] headers
+		# @return [KirinHttp::Response]
+		def query(method, endpoint, content = nil, type = "application/xml", accept = nil, headers = {})
+			accept = type if accept.nil?
+			header = {
+				"Content-Type": type,
+				"Accept": accept
+			}.merge(headers)
+			message = KirinHttp::Message.new(endpoint, method, content, header)
+			message = @signer.sign message, "s3", @region
+			@http.send message
+		end
+	end
+end
+

data/lib/bucket_client/gcp/gcp_bucket.rb

@@ -0,0 +1,79 @@
+module BucketClient
+	class GCPBucket < Bucket
+		attr_reader :key
+
+		# @param [GCPClient] parent
+		# @param [String] key
+		def initialize(parent, key)
+			@bucket_client = parent
+			@key = key
+		end
+
+		def get_uri(key)
+			"https://storage.googleapis.com/#{@key}/#{key}"
+		end
+
+		def get_blob_with_uri(uri)
+			@bucket_client.get_blob uri
+		end
+
+		def exist_blob_with_uri(uri)
+			@bucket_client.exist_blob(uri)
+		end
+
+		def put_blob_with_uri(payload, uri)
+			@bucket_client.put_blob payload, uri
+		end
+
+		def update_blob_with_uri(payload, uri)
+			exist = exist_blob_with_uri uri
+			if exist
+				put_blob_with_uri payload, uri
+			else
+				OperationResult.new false, "Blob does not exist", nil, 400
+			end
+		end
+
+		def delete_blob_with_uri(uri)
+			@bucket_client.delete_blob(uri)
+		end
+
+		def delete_blob_if_exist_with_uri(uri)
+			@bucket_client.delete_blob_if_exist(uri)
+		end
+
+		def get_blob(key)
+			get_blob_with_uri(get_uri key)
+		end
+
+		def exist_blob(key)
+			exist_blob_with_uri(get_uri key)
+		end
+
+		def put_blob(payload, key)
+			put_blob_with_uri(payload, get_uri(key))
+		end
+
+		def create_blob(payload, key)
+			exist = exist_blob key
+			if exist
+				OperationResult.new false, "Blob already exist", nil, 400
+			else
+				put_blob payload, key
+			end
+		end
+
+		def update_blob(payload, key)
+			update_blob_with_uri(payload, get_uri(key))
+		end
+
+		def delete_blob(key)
+			delete_blob_with_uri(get_uri key)
+		end
+
+		def delete_blob_if_exist(key)
+			delete_blob_if_exist_with_uri(get_uri key)
+		end
+
+	end
+end

data/lib/bucket_client/gcp/gcp_client.rb

@@ -0,0 +1,171 @@
+require "google/cloud/storage"
+require "mimemagic"
+require "bucket_client/operation_result"
+require "bucket_client/gcp/gcp_bucket"
+
+module BucketClient
+	class GCPClient < Client
+		def initialize(project_id, secret)
+			@client = Google::Cloud::Storage.new(project_id: project_id, keyfile: secret)
+		end
+
+		def exist_bucket(key)
+			!@client.bucket(key).nil?
+		end
+
+		def get_bucket!(key)
+			GCPBucket.new(self, key)
+		end
+
+		def put_bucket(key)
+			exist = exist_bucket key
+			if exist
+				bucket = get_bucket! key
+				OperationResult.new(true, "OK", bucket, 200)
+			else
+				create_bucket key
+			end
+		end
+
+		def create_bucket(key)
+			begin
+				@client.create_bucket key
+				bucket = get_bucket! key
+				OperationResult.new(true, "OK", bucket, 200)
+			rescue StandardError => e
+				OperationResult.new(false, e.message, nil, 400)
+			end
+		end
+
+		def delete_bucket(key)
+			exist = exist_bucket key
+			if exist
+				bucket = @client.bucket(key)
+				success = bucket.delete
+				message = success ? "Deleted" : "Failed to delete"
+				code = success ? 204 : 400
+				OperationResult.new(success, message, nil, code)
+			else
+				OperationResult.new(false, "Bucket does not exist", nil, 404)
+			end
+		end
+
+		def delete_bucket_if_exist(key)
+			exist = exist_bucket key
+			if exist
+				delete_bucket key
+			else
+				OperationResult.new(true, "Bucket already deleted", nil, 200)
+			end
+		end
+
+		def set_read_policy(key, access)
+			raise ArgumentError.new("Read Policy not accepted") if access != :public && access != :private
+			begin
+				bucket = @client.bucket key
+				modify_acl bucket, access
+				bucket.files.each do |file|
+					modify_acl file, access
+				end
+				OperationResult.new(true, "OK", nil, 200)
+			rescue StandardError => e
+				OperationResult.new(false, e.message, nil, 400)
+			end
+		end
+
+		def set_get_cors(key, cors)
+			begin
+
+				bucket = @client.bucket key
+				bucket.cors(&:clear)
+				bucket.cors {|rules| rules.add_rule cors, "GET"}
+				OperationResult.new(true, "OK", nil, 200)
+			rescue StandardError => e
+				OperationResult.new(false, e.message, nil, 400)
+			end
+		end
+
+		def get_blob(uri)
+			data = break_uri uri
+			begin
+				bucket = @client.bucket data[:bucket]
+				blob = bucket.file data[:blob]
+				bin = blob.download.read
+				OperationResult.new(true, "OK", bin, 200)
+			rescue StandardError => e
+				OperationResult.new(false, e.message, nil, 400)
+			end
+		end
+
+		def exist_blob(uri)
+			data = break_uri uri
+			bucket = @client.bucket data[:bucket]
+			bucket.file(data[:blob], skip_lookup: true).exists?
+		end
+
+		def put_blob(payload, uri)
+			mime = MimeMagic.by_magic payload
+			data = break_uri uri
+			begin
+				# @type [Google::Cloud::Storage::Bucket]
+				bucket = @client.bucket data[:bucket]
+				f = StringIO.new
+				f << payload
+				file = bucket.create_file f, data[:blob], cache_control: "no-cache", content_type: mime.type
+				OperationResult.new(true, "OK", file.public_url, 200)
+			rescue StandardError => e
+				OperationResult.new(false, e.message, nil, 400)
+			end
+		end
+
+		def update_blob(payload, uri)
+			exist = exist_blob uri
+			if exist
+				put_blob payload, uri
+			else
+				OperationResult.new(false, "Blob does not exist", nil, 404)
+			end
+		end
+
+		def delete_blob_if_exist(uri)
+			exist = exist_blob uri
+			if exist
+				delete_blob uri
+			else
+				OperationResult.new(true, "Blob already deleted", nil, 204)
+			end
+		end
+
+		def delete_blob(uri)
+			data = break_uri uri
+			begin
+				bucket = @client.bucket data[:bucket]
+				bucket.file(data[:blob], skip_lookup: true).delete
+				OperationResult.new(true, "Deleted Blob", nil, 204)
+			rescue StandardError => e
+				OperationResult.new(false, e.message, nil, 400)
+			end
+		end
+
+		private
+
+			def break_uri(uri)
+				url = Addressable::URI.parse uri
+				fragments = url.path.split("/").select {|x| !x.nil? && !x.empty?}
+				bucket = fragments[0]
+				blob = fragments.drop(1).join "/"
+				{bucket: bucket, blob: blob}
+			end
+
+			def modify_acl(principal, access)
+				if access == :private
+					principal.acl.private!
+					principal.default_acl.private!
+				else
+					principal.acl.public!
+					principal.default_acl.public!
+				end
+			end
+
+	end
+end

data/lib/bucket_client/operation_result.rb

@@ -0,0 +1,33 @@
+class OperationResult
+
+	def initialize(success, message, value, code)
+		@success = success
+		@message = message
+		@value = value
+		@code = code
+	end
+
+	# Message from the server of the operation. Failure message will be here too
+	# @return [String]
+	def message
+		@message
+	end
+
+	# HTTP Status code of the operation.
+	# @return [Integer]
+	def code
+		@code
+	end
+
+	# Whether the operation was successful
+	# @return [Boolean]
+	def success
+		@success
+	end
+
+	# Value of the operation result if it has a value.
+	# Can be uri or byte array
+	def value
+		@value
+	end
+end

data/lib/bucket_client/version.rb

@@ -0,0 +1,3 @@
+module BucketClient
+	VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: bucket_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kirinnee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kirin_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: azure-storage-blob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  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).
+email:
+- kirinnee97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".idea/bucket_client.iml"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/runConfigurations/Integration_Test.xml"
+- ".idea/runConfigurations/Unit_Test.xml"
+- ".idea/vcs.xml"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bucket_client.gemspec
+- integration/aws_blob_spec.rb
+- integration/aws_bucket_spec.rb
+- integration/azure_blob_spec.rb
+- integration/azure_bucket_spec.rb
+- integration/dev_blob_spec.rb
+- integration/dev_bucket_spec.rb
+- integration/do_blob_spec.rb
+- integration/do_bucket_spec.rb
+- integration/gcp_blob_spec.rb
+- integration/gcp_bucket_spec.rb
+- integration/img.jpg
+- lib/bucket_client.rb
+- lib/bucket_client/aws/aws_bucket.rb
+- lib/bucket_client/aws/aws_client.rb
+- lib/bucket_client/aws/aws_http_client.rb
+- lib/bucket_client/aws/aws_policy_factory.rb
+- lib/bucket_client/aws4_request_signer.rb
+- lib/bucket_client/azure/azure_bucket.rb
+- lib/bucket_client/azure/azure_client.rb
+- lib/bucket_client/bucket.rb
+- lib/bucket_client/bucket_operation_exception.rb
+- lib/bucket_client/client.rb
+- lib/bucket_client/dev/local_bucket.rb
+- lib/bucket_client/dev/local_client.rb
+- lib/bucket_client/digital_ocean/digital_ocean_acl_factory.rb
+- lib/bucket_client/digital_ocean/digital_ocean_bucket.rb
+- lib/bucket_client/digital_ocean/digital_ocean_client.rb
+- lib/bucket_client/digital_ocean/digital_ocean_http_client.rb
+- lib/bucket_client/gcp/gcp_bucket.rb
+- lib/bucket_client/gcp/gcp_client.rb
+- lib/bucket_client/operation_result.rb
+- lib/bucket_client/version.rb
+homepage: https://gitlab.com/ruby-gem/bucket_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A gem that allows for ruby code to interact with cloud blob storage such
+  as AWS S3, GCP Cloud Storage and Azure Blob Storage
+test_files: []