blsk_ruby_core_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b721ef1d8a5eaef37b577d5a7a427fb3dfe87b642121a7579fd58017efb8a78d
+  data.tar.gz: 1f30040cc47ca66a9bfe9a659c8368c0117413ff53fa065e497566ba179520a7
+SHA512:
+  metadata.gz: 3f645661d54265e9048a044e043d4a10f31a247bab81e0ca4d87d87fd440ef23a20f6f07a1e56a495e03b8996fe4ed641e8a42a1ec335fd2d5434babdc473a28
+  data.tar.gz: 76b5a3f77fb9b8233f1883bdf19b799bf3d262a993921e5d248472f85b58f236233cb968ec810abc973f0aa70a38c203160775acd7c669595ed535c30a0fb18b

data/lib/app_service.rb

@@ -0,0 +1,20 @@
+require_relative 'consul/consul_service'
+require_relative 'cassandra/cassandra_service'
+
+class AppService
+  include Inject['consul_service', 'cassandra_service']
+
+  injector
+
+  def start
+    puts 'start app_service'
+    consul_service.start
+    cassandra_service.start
+  end
+
+  def stop
+    puts 'stop app_service'
+    consul_service.stop
+    cassandra_service.stop
+  end
+end

data/lib/application_configuration.rb

@@ -0,0 +1,46 @@
+require 'securerandom'
+
+module ApplicationConfiguration
+  def config
+    {
+      rest: config_rest,
+      consul: config_consul
+    }
+  end
+
+  def config_consul
+    config_consul = {
+      port: 8500,
+      path: "http://localhost",
+      consul_service_data: {
+        name: "Service-1",
+        id: "Service1",
+        port: 9292,
+        check: {
+          id: "bluesky-api",
+          name: "HTTP Health Check API on port 9292",
+          http: "http://localhost:9292/health-check-new",
+          tls_skip_verify: false,
+          method: "GET",
+          interval: "10s",
+          timeout: "1s"
+        }
+      }
+    }
+    config_consul[:consul_service_data][:port] = config_rest[:port]
+    config_consul[:consul_service_data][:check][:http] = "http://#{config_rest[:host]}:#{config_rest[:port].to_s}/#{random_name}"
+    config_consul
+  end
+
+  def config_rest
+    config_rest = {
+      host: 'localhost',
+      port: 9292,
+      path: '/api/v1'
+    }
+  end
+
+  def random_name
+    "health-check-#{SecureRandom.urlsafe_base64(8)}"
+  end
+end

data/lib/blsk_ruby_core_api.rb

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'request_store'
+
+require_relative 'application_configuration'
+require_relative 'app_service'
+require_relative 'rest/rest_service'
+require_relative 'decoractors/authenticate'
+require_relative 'decoractors/valid'
+# Dir["#{File.dirname(__FILE__)}/**/*.rb"].each {|file| require file }
+
+
+class Application
+  extend ApplicationConfiguration
+
+  def initialize(rests=[], config={})
+    @config = config
+    @rests = rests
+  end
+
+  def init_rest_service
+    rests = @rests
+    return Sinatra.new {
+      rests.each {|a| use a}
+      not_found do
+        JSON RestService.error_response('EntityNotFound')
+      end
+    }
+  end
+
+  def start
+    puts 'start'
+    Container['app_service'].start
+    init_rest_service
+  end
+
+  def stop
+    Container['app_service'].stop
+  end
+end

data/lib/cassandra/abstracted_cassandra_repository.rb

@@ -0,0 +1,52 @@
+module AbstractedCassandraRepository
+	def find_by_id(id=nil, keyspace_name=nil, table_name=nil)
+		puts 'find_by_id'
+		if keyspace_name && table_name
+			session = cassandra_cluster.connect(keyspace_name)
+			result = session.execute("SELECT * FROM #{table_name} WHERE id = ?", arguments: [id])
+		end
+	end
+
+	def find_all(keyspace_name=nil, table_name=nil)
+		puts 'find_all'
+		if keyspace_name && table_name
+			session = cassandra_cluster.connect(keyspace_name)
+			result = session.execute("SELECT * FROM #{table_name}")
+		end
+	end
+
+	def create(value_hashes={}, keyspace_name=nil, table_name=nil)
+		puts 'create'
+		if keyspace_name && table_name
+			session = cassandra_cluster.connect(keyspace_name)
+			cql = '' # Building the cql using 'INSERT INTO' with 'IF NOT EXISTS'
+			result = session.execute(cql)
+		end
+	end
+
+	def update(id=nil, value_hashes={}, keyspace_name=nil, table_name=nil)
+		puts 'update'
+		if keyspace_name && table_name
+			session = cassandra_cluster.connect(keyspace_name)
+			cql = '' # Building the cql using UPDATE
+			result = session.execute(cql)
+		end
+	end
+
+	def save(value_hashes={}, keyspace_name=nil, table_name=nil)
+		puts 'save'
+		if keyspace_name && table_name
+			session = cassandra_cluster.connect(keyspace_name)
+			cql = '' # Building the cql using 'INSERT INTO' without 'IF NOT EXISTS'
+			result = session.execute(cql)
+		end
+	end
+
+	def delete(id=nil, keyspace_name=nil, table_name=nil)
+		puts 'delete'
+		if keyspace_name && table_name
+			session = cassandra_cluster.connect(keyspace_name)
+			result = session.execute("DELETE FROM #{table_name} WHERE id = ?", arguments: [id])
+		end
+	end
+end

data/lib/cassandra/cassandra_service.rb

@@ -0,0 +1,32 @@
+require 'cassandra'
+require_relative '../ioc/injector'
+require_relative 'abstracted_cassandra_repository'
+
+class CassandraService
+  include ::AbstractedCassandraRepository
+
+  injector
+
+	attr_accessor :cassandra_cluster
+
+	def initialize
+		puts 'init cassandra'
+    self.cassandra_cluster = Cassandra.cluster
+	end
+
+	def start
+		puts 'start cassandra, create cluster'
+		if !cassandra_cluster
+    	cassandra_cluster = Cassandra.cluster
+    end
+    cassandra_cluster
+	end
+
+	def stop
+		puts 'stop cassandra'
+		if cassandra_cluster
+			puts 'closing'
+    	cassandra_cluster.close
+    end
+	end
+end

data/lib/consul/consul_configuration.rb

@@ -0,0 +1,39 @@
+require 'diplomat'
+
+module ConsulConfiguration
+	extend ApplicationConfiguration
+
+	CONFIG = {
+		port: 8500,
+		path: "http://localhost",
+		consul_service_data: {
+			name: "Service-1",
+			id: "Service1",
+			port: 9292,
+			check: {
+			  id: "bluesky-api",
+			  name: "HTTP Health Check API on port 9292",
+			  http: "http://localhost:9292/health-check",
+			  tls_skip_verify: false,
+			  method: "GET",
+			  interval: "10s",
+			  timeout: "1s"
+			}
+		}
+	}.merge( ConsulConfiguration.config_consul )
+
+	def configure
+		Diplomat.configure do |config|
+		  # Set up a custom Consul URL
+		  config.url = "#{CONFIG[:path]}:#{CONFIG[:port].to_s}"
+		  # Set up a custom Faraday Middleware
+		  # config.middleware = MyCustomMiddleware
+		  # Connect into consul with custom access token (ACL)
+		  # config.acl_token = "qwertyui-asdf-zxcv-1234-123456789012"
+		  # Set extra Faraday configuration options
+		  # config.options = {ssl: { version: :TLSv1_2 }}
+		end
+
+		CONFIG[:consul_service_data]
+	end
+end

data/lib/consul/consul_service.rb

@@ -0,0 +1,33 @@
+require 'diplomat'
+require_relative '../ioc/injector'
+require_relative 'consul_configuration'
+require_relative '../rest/rest_service'
+
+class ConsulService
+	extend ConsulConfiguration
+
+	injector
+
+	attr_accessor :consul_service_data
+
+	def initialize(option=nil)
+		puts 'init consul'
+		self.consul_service_data = ConsulService.configure
+  end
+
+	def start
+		puts 'start consul'
+		consul_service_data = ConsulConfiguration::CONFIG[:consul_service_data] if consul_service_data.nil?
+		Diplomat::Service.register(consul_service_data)
+
+		# start url for consul to check health
+		consul_check_route = "/" + consul_service_data[:check][:http].split('/').last
+		RestService.start_consul_check_http(consul_check_route)
+	end
+
+	def stop
+		puts 'stop consul'
+		consul_service_id = self.consul_service_data.try(:id) || ConsulConfiguration::CONFIG[:consul_service_data][:id]
+    Diplomat::Service.deregister(consul_service_id)
+	end
+end

data/lib/decoractors/authenticate.rb

@@ -0,0 +1,28 @@
+require_relative '../rest/rest_service'
+require_relative '../security/security_context_holder'
+
+module Authenticator
+  def has_roles roles
+    lambda {|*args, &blk|
+      puts 'has_roles'
+      check_role = true # check role here and return true/false
+      if check_role
+        true
+      else
+        false
+      end
+    }
+  end
+
+  def authenticate isAuthorized
+    lambda {|self_model, *args, &blk|
+      puts "isAuthorized"
+      # check authentication and authorization here, then return true/false
+      if isAuthorized.call(*args, &blk)
+        true
+      else
+        raise CommonError::PermissionDenied
+      end
+    }
+  end
+end

data/lib/decoractors/valid.rb

@@ -0,0 +1,23 @@
+require_relative '../rest/rest_service'
+
+module Validator
+	def validate params={}
+	  lambda {|self_model, *args, &blk|
+	    puts "Validate"
+	    check_validate = self_model.check_validate(*args, &blk) # check validation and return [true]/[false, errors]
+	    if check_validate[0]
+	    	true
+	    else
+	    	check_validate[2].response_with_error(CommonError::InvalidData, check_validate[1])
+	    end
+	  }
+	end
+
+	def convert_errors_response(error_list)
+		errors = []
+		error_list.each do |key, value|
+			errors << {field: key, message: value}
+		end
+		errors
+	end
+end

data/lib/ioc/container.rb

@@ -0,0 +1,5 @@
+require "dry-container"
+require "dry-auto_inject"
+
+Container = Dry::Container.new
+Inject = Dry::AutoInject(Container)

data/lib/ioc/injector.rb

@@ -0,0 +1,54 @@
+require_relative "container"
+require "dry/inflector"
+
+Inflector = Dry::Inflector.new
+
+def injector name = nil
+  name = name.nil? ? self.name[0, 1].downcase + self.name[1..-1] : name
+  Container.register(Inflector.underscore(name), self.extend(Injector).new)
+end
+
+module Injector
+  @@decorators = Hash.new
+
+  def decorators
+    @@decorators
+  end
+
+  def decorate name, decorators
+    if @@decorators[name].nil?
+      @@decorators[name] = []
+    end
+    @@decorators[name] = {:is_processed => false, :decorators => decorators}
+  end
+
+  def method_added(name)
+    super
+    orig_method = instance_method(name)
+    decorators = self.decorators[name]
+    return if decorators.nil? || decorators[:is_processed] == true
+
+    if private_method_defined?(name);
+      visibility = :private
+    elsif protected_method_defined?(name);
+      visibility = :protected
+    else
+      visibility = :public
+    end
+
+    decorators[:is_processed] = true
+    define_method(name) do |*args, &blk|
+      decorators[:decorators].each do |decor|
+        decor.call(self, *args, &blk)
+      end
+      orig_method.bind(self).call(*args, &blk)
+    end
+
+    case visibility
+    when :protected;
+      protected name
+    when :private;
+      private name
+    end
+  end
+end

data/lib/rest/rest_common_error.rb

@@ -0,0 +1,25 @@
+module CommonError
+  class InvalidToken < Exception
+    def initialize(msg = 'InvalidToken')
+      super
+    end
+  end
+
+  class PermissionDenied < Exception
+    def initialize(msg = 'PermissionDenied')
+      super
+    end
+  end
+
+  class EntityNotFound < Exception
+    def initialize(msg = 'EntityNotFound')
+      super
+    end
+  end
+
+  class InvalidData < Exception
+    def initialize(msg = 'InvalidData')
+      super
+    end
+  end
+end

data/lib/rest/rest_configuration.rb

@@ -0,0 +1,10 @@
+module RestConfiguration
+  extend ApplicationConfiguration
+
+  CONFIG = {
+    host: 'localhost',
+    port: 9292,
+    path: '/api/v1'
+  }.merge( RestConfiguration.config_rest )
+
+end

data/lib/rest/rest_error_handler.rb

@@ -0,0 +1,33 @@
+require 'sinatra/base'
+require_relative 'rest_common_error'
+require_relative 'rest_response_model'
+
+
+class RestApplication < Sinatra::Base
+	extend ::RestResponseModel
+
+	error CommonError::InvalidToken do
+	  status 401
+	  JSON RestApplication.error_response('InvalidToken')
+	end
+
+	error CommonError::PermissionDenied do
+	  status 403
+	  JSON RestApplication.error_response('PermissionDenied')
+	end
+
+	error CommonError::EntityNotFound do
+	  status 404
+	  JSON RestApplication.error_response('EntityNotFound')
+	end
+
+	error CommonError::InvalidData do
+	  status 422
+	  JSON RestApplication.error_response('InvalidData', @errors)
+	end
+
+	def response_with_error(exception_class, errors=[])
+		@errors = errors if !errors.empty?
+		raise exception_class
+	end
+end

data/lib/rest/rest_response_model.rb

@@ -0,0 +1,17 @@
+module RestResponseModel
+  def success_response(data=nil)
+    response = {
+      status: 'OK'
+    }
+    response[:data] = data if data
+    response
+  end
+
+  def error_response(error_code='FAILED', errors=[])
+    response = {
+      status: error_code
+    }
+    response[:errors] = errors if !errors.nil? && errors.any?
+    response
+  end
+end

data/lib/rest/rest_service.rb

@@ -0,0 +1,64 @@
+require 'sinatra/base'
+require "sinatra/namespace"
+require_relative 'rest_configuration'
+require_relative 'rest_error_handler'
+require_relative 'rest_common_error'
+require_relative 'rest_response_model'
+
+
+class RestApplication < Sinatra::Base
+  set :server, :puma
+  disable  :raise_errors
+  disable  :show_exceptions
+
+  set :dump_errors, true
+  set :show_exceptions, :after_handler
+
+  register Sinatra::Namespace
+
+  configure :production do
+    # ...
+  end
+
+  configure :development do
+    # ...
+  end
+end
+
+class RestService < RestApplication
+  extend ::RestConfiguration
+  extend ::RestResponseModel
+
+  before '/*' do
+    puts 'before any route ...'
+    RequestStore.store[:user] = "Nhuan Lai"
+  end
+
+  # Health Check for Consul, run when start Consul
+  def self.start_consul_check_http(url)
+    get url do
+      'The service is healthy!'
+    end
+  end
+  # # API route
+  # namespace RestConfiguration::CONFIG[:path] do
+  #   get '/seed_1' do
+  #     'Seed 1 API'
+  #   end
+  #   get '/seed_2' do
+  #     'Seed 2 API'
+  #   end
+  # end
+
+  # # Example for handling error
+  # get '/health' do
+  #   errors = [
+  #     {
+  #       field: 'error field',
+  #       code: 'error code',
+  #       message: 'error message'
+  #     }
+  #   ]
+  #   response_with_error(CommonError::InvalidData, errors)
+  # end
+end

data/lib/security/security_context_holder.rb

@@ -0,0 +1,5 @@
+class SecurityContextHolder
+  def self.get_user
+  	RequestStore.store[:user]
+  end
+end

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: blsk_ruby_core_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fusin Thang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-system
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.4
+- !ruby/object:Gem::Dependency
+  name: cassandra-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+- !ruby/object:Gem::Dependency
+  name: rake-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+description: Sample Core API gem
+email: fusinthang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/app_service.rb
+- lib/application_configuration.rb
+- lib/blsk_ruby_core_api.rb
+- lib/cassandra/abstracted_cassandra_repository.rb
+- lib/cassandra/cassandra_service.rb
+- lib/consul/consul_configuration.rb
+- lib/consul/consul_service.rb
+- lib/decoractors/authenticate.rb
+- lib/decoractors/valid.rb
+- lib/ioc/container.rb
+- lib/ioc/injector.rb
+- lib/rest/rest_common_error.rb
+- lib/rest/rest_configuration.rb
+- lib/rest/rest_error_handler.rb
+- lib/rest/rest_response_model.rb
+- lib/rest/rest_service.rb
+- lib/security/security_context_holder.rb
+homepage: http://rubygems.org/gems/blsk_ruby_core_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Sample Core Api
+test_files: []