rubypitaya 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 573d0dce81f6383ae631e5bcde6676f45d516ce7a38b51eefa4ebd922d229e4e
+  data.tar.gz: 1b163c885db0a3a532edfd21d07cd9058f7003f2ad44dd40e90429f1311c337e
+SHA512:
+  metadata.gz: b5a39ccf4533c32c285c1e31f0db14131c3a255639693e4c343b4d2f8cd2fda9f4be5d000c7b68a0a7b78fbb9a80d32e26a23792a3e88dbaab27efefd7ceb55c
+  data.tar.gz: bc1c57916f513bac17a22e8b3ad720d725d93fd9369111b6bcb0fd18175063c7a69e84e90cf1aaab474ad215c0658102c10c7355ce075783fa85c53302e98035

data/bin/rubypitaya

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'rubypitaya'
+
+COMMANDS = ['run', 'create']
+
+def main
+  if ARGV.size == 0 || !COMMANDS.include?(ARGV[0])
+    show_help()
+    exit(-1)
+  end
+
+  command = ARGV[0]
+
+  if command == 'run'
+    command_run(ARGV)
+  end
+
+  if command == 'create'
+    command_create(ARGV)
+  end
+end
+
+def command_run(argv)
+  puts 'Starting server...'
+  RubyPitaya::RubyPitaya.run_server
+end
+
+def command_create(argv)
+  if argv.size <= 1
+    show_help_create()
+    exit(-1)
+  end
+
+  project_name = argv[1]
+  folder_path = Dir.pwd
+
+  RubyPitaya::RubyPitaya.create_project(project_name, folder_path)
+
+  puts "Project #{project_name} created!"
+end
+
+def show_help
+  puts 'Usage: $ rubypitaya [COMMAND]'
+  puts 'COMMAND:'
+  puts '  run:    - Run server'
+  puts '  create: - Create project'
+  puts ''
+end
+
+def show_help_create
+  puts 'Usage: $ rubypitaya create [project_name]'
+  puts ''
+end
+
+main

data/lib/rubypitaya/app-template/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem 'rubypitaya', '1.1.0'
+
+group :development do
+  gem 'pry', '0.12.2'
+  gem 'bundler', '1.17.2'
+  gem 'rake', '10.0'
+  gem 'rspec', '3.8.0'
+end

data/lib/rubypitaya/app-template/Gemfile.lock

@@ -0,0 +1,83 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2)
+      activesupport (= 6.0.2)
+    activerecord (6.0.2)
+      activemodel (= 6.0.2)
+      activesupport (= 6.0.2)
+    activesupport (6.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    etcdv3 (0.10.2)
+      grpc (~> 1.17)
+    eventmachine (1.2.7)
+    google-protobuf (3.11.4)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    grpc (1.28.0)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (~> 1.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    middleware (0.1.0)
+    minitest (5.14.0)
+    nats (0.11.0)
+      eventmachine (~> 1.2, >= 1.2)
+    pg (0.21.0)
+    protobuf (3.10.0)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.0.0)
+    redis (4.1.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+    rubypitaya (1.1.0)
+      activerecord (= 6.0.2)
+      etcdv3 (= 0.10.2)
+      eventmachine (= 1.2.7)
+      nats (= 0.11.0)
+      pg (= 0.21.0)
+      protobuf (= 3.10.0)
+      redis (= 4.1.3)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 1.17.2)
+  pry (= 0.12.2)
+  rake (= 10.0)
+  rspec (= 3.8.0)
+  rubypitaya (= 1.0.6)
+
+BUNDLED WITH
+   1.17.2

data/lib/rubypitaya/app-template/Makefile

@@ -0,0 +1,91 @@
+## Run ruby pitaya metagame project
+run:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rubypitaya run
+
+## Build project
+build:
+	@docker-compose build
+
+## Kill all containers
+kill:
+	@docker rm -f $$(docker-compose ps -aq)
+
+## Run tests
+test:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rspec
+
+## Run ruby irb console
+console:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec ruby ./bin/console
+
+## Run bash on container
+bash:
+	@docker-compose run --service-ports --rm rubypitaya bash
+
+## Create database
+db-create:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:create
+
+## Run migrations to database
+db-migrate:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:migrate
+
+## Drop database
+db-drop:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:drop
+
+## Reset database
+db-reset:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:reset
+
+## Generate Gemfile.lock
+generate-gemfilelock:
+	@docker run --rm -v "$(PWD)":/usr/src/app -w /usr/src/app ruby:2.6.6 bundle install
+
+## Build image to production environment
+prod-build-image:
+	@docker build . -f docker/prod/Dockerfile -t registry.gitlab.com/lucianopc/ruby-pitaya-app:latest
+
+.DEFAULT_GOAL := show-help
+
+.PHONY: show-help
+show-help:
+	@echo "$$(tput bold)Commands:$$(tput sgr0)"
+	@echo
+	@sed -n -e "/^## / { \
+		h; \
+		s/.*//; \
+		:doc" \
+		-e "H; \
+		n; \
+		s/^## //; \
+		t doc" \
+		-e "s/:.*//; \
+		G; \
+		s/\\n## /---/; \
+		s/\\n/ /g; \
+		p; \
+	}" ${MAKEFILE_LIST} \
+	| LC_ALL='C' sort --ignore-case \
+	| awk -F '---' \
+		-v ncol=$$(tput cols) \
+		-v indent=22 \
+		-v col_on="$$(tput setaf 6)" \
+		-v col_off="$$(tput sgr0)" \
+	'{ \
+		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
+		n = split($$2, words, " "); \
+		line_length = ncol - indent; \
+		for (i = 1; i <= n; i++) { \
+			line_length -= length(words[i]) + 1; \
+			if (line_length <= 0) { \
+				line_length = ncol - indent - length(words[i]) - 1; \
+				printf "\n%*s ", -indent, " "; \
+			} \
+			printf "%s ", words[i]; \
+		} \
+		printf "\n"; \
+	}'
+
+
+

data/lib/rubypitaya/app-template/Rakefile

@@ -0,0 +1,57 @@
+require 'active_record'
+
+require 'rubypitaya/core/path'
+require 'rubypitaya/core/database_config'
+
+
+namespace :db do
+
+  desc 'Create the database'
+  task :create do
+    environment_name = ENV.fetch("RUBYPITAYA_ENV") { 'development' }
+    database_config = RubyPitaya::DatabaseConfig.new(environment_name, RubyPitaya::Path::DATABASE_CONFIG_PATH)
+    connection_data = database_config.connection_data_without_database
+
+    ActiveRecord::Base.establish_connection(connection_data)
+    ActiveRecord::Base.connection.create_database(database_config.database_name)
+    ActiveRecord::Base.connection.close
+
+    puts 'Database created.'
+  end
+
+  desc 'Migrate the database'
+  task :migrate do
+    environment_name = ENV.fetch("RUBYPITAYA_ENV") { 'development' }
+    database_config = RubyPitaya::DatabaseConfig.new(environment_name, RubyPitaya::Path::DATABASE_CONFIG_PATH)
+    connection_data = database_config.connection_data
+    migrations_path = RubyPitaya::Path::MIGRATIONS_FOLDER_PATH
+
+    ActiveRecord::Base.establish_connection(connection_data)
+    ActiveRecord::Migrator.migrations_paths = [migrations_path]
+    ActiveRecord::Tasks::DatabaseTasks.migrate
+    ActiveRecord::Base.connection.close
+    puts 'Database migrated.'
+  end
+
+  desc 'Drop the database'
+  task :drop do
+    environment_name = ENV.fetch("RUBYPITAYA_ENV") { 'development' }
+    database_config = RubyPitaya::DatabaseConfig.new(environment_name, RubyPitaya::Path::DATABASE_CONFIG_PATH)
+    connection_data = database_config.connection_data_without_database
+
+    ActiveRecord::Base.establish_connection(connection_data)
+    ActiveRecord::Base.connection.drop_database(database_config.database_name)
+    ActiveRecord::Base.connection.close
+
+    puts 'Database deleted.'
+  end
+
+  desc 'Reset the database'
+  task :reset do
+    Rake::Task['db:drop'].invoke
+    Rake::Task['db:create'].invoke
+    Rake::Task['db:migrate'].invoke
+
+    puts 'Database reset finish.'
+  end
+end

data/lib/rubypitaya/app-template/app/app_initializer.rb

@@ -0,0 +1,23 @@
+class AppInitializer < RubyPitaya::InitializerBase
+
+  # method:     run
+  # parameter:  initializer_content
+  # attributes:
+  #  - bll
+  #    - class: InstanceHolder
+  #    - methods:
+  #      - add_instance(key, instance)
+  #        - add any instance to any key
+  #      - [](key)
+  #        - get instance by key
+  #  - redis
+  #    - link: https://github.com/redis/redis-rb/
+
+  def run(initializer_content)
+    bll = initializer_content.bll
+
+    playerBll = PlayerBLL.new
+
+    bll.add_instance(:player, playerBll)
+  end
+end

data/lib/rubypitaya/app-template/app/bll/player_bll.rb

@@ -0,0 +1,10 @@
+class PlayerBLL
+
+  def create_new_player(config)
+    name = config['initial_player']['name']
+
+    player = Player.new(name: name, user: User.new)
+    player.save
+    player
+  end
+end

data/lib/rubypitaya/app-template/app/config/initial_player.json

@@ -0,0 +1,3 @@
+{
+    "name": "Guest"
+}

data/lib/rubypitaya/app-template/app/constants/status_codes.rb

@@ -0,0 +1,15 @@
+class StatusCodes
+  # Success codes
+  CODE_OK = 'RP-200'
+
+  # Error codes
+  CODE_UNKNOWN = 'RP-000'
+  CODE_HANDLER_NOT_FOUNDED = 'RP-001'
+  CODE_ACTION_NOT_FOUNDED = 'RP-002'
+  CODE_NOT_AUTHENTICATED = 'RP-003'
+  CODE_AUTHENTICATION_ERROR = 'RP-004'
+
+  class Connector
+    CODE_UNKNOWN = 'PIT-000'
+  end
+end

data/lib/rubypitaya/app-template/app/handlers/hello_world_handler.rb

@@ -0,0 +1,11 @@
+class HelloWorldHandler < RubyPitaya::HandlerBase
+
+  non_authenticated_actions :sayHello
+
+  def sayHello
+    response = {
+      code: 'RP-200', 
+      msg: 'Hello!'
+    }
+  end
+end

data/lib/rubypitaya/app-template/app/handlers/player_handler.rb

@@ -0,0 +1,79 @@
+class PlayerHandler < RubyPitaya::HandlerBase
+
+  # class:      HandlerBase
+  # attributes:
+  #  - @bll
+  #    - class: InstanceHolder
+  #    - methods:
+  #      - [](key)
+  #        - info: get bll by key
+  #
+  #  - @redis
+  #    - link: https://github.com/redis/redis-rb/
+  #
+  #  - @config
+  #    - info: Hash with config json files inside of 'app/config'
+  #    - example:
+  #               Given you have the following file "app/config/initial_player.json"
+  #               And this json content is {'name': 'Guest'}
+  #               And you can get the initial player name
+  #               Then you can run the following code: @config['initial_player']['name']
+  #
+  #  - @params
+  #    - info: Special hash with the request parameters
+  #    - link: https://api.rubyonrails.org/classes/ActionController/Parameters.html
+  #
+  #  - @session
+  #    - attributes:
+  #      - id          :: session id
+  #      - uid         :: user id
+  #      - data        :: session data
+  #      - metadata    :: session data
+  #      - frontend_id :: connector server id
+  #
+  #  - @postman
+  #    - info: Send messages to server and clients
+  #    - methods:
+  #      - bind_session(session)
+  #        - info:
+  #                Send a session to connector, you can use to set the userId
+  #                of the session, for example you can set an userId on
+  #                @session, like `@session.uid = '123'`, and then you can
+  #                bind this session with `@postman.bind_session(@session)`
+
+  non_authenticated_actions :authenticate
+
+  def authenticate
+    user_id = @params[:userId]
+
+    player = Player.find_by_user_id(user_id)
+    player = @bll[:player].create_new_player(@config) if player.nil?
+
+    @session.uid = player.user_id
+
+    bind_session_response = @postman.bind_session(@session)
+
+    unless bind_session_response.dig(:error, :code).nil?
+      return response = {
+        code: StatusCodes::CODE_AUTHENTICATION_ERROR,
+        msg: 'Error to authenticate',
+      }
+    end
+
+    response = {
+       code: StatusCodes::CODE_OK,
+       player: player.to_hash,
+    }
+  end
+
+  def getInfo
+    user_id = @session.uid
+
+    player = Player.find_by_user_id(user_id)
+
+    response = {
+       code: StatusCodes::CODE_OK,
+       player: player.to_hash,
+    }
+  end
+end

data/lib/rubypitaya/app-template/app/models/player.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+
+class Player < ActiveRecord::Base
+
+  belongs_to :user
+
+  validates_presence_of :name, :user
+
+  def to_hash
+    {
+      name: name,
+      userId: user_id,
+    }
+  end
+end

data/lib/rubypitaya/app-template/app/models/user.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+
+class User < ActiveRecord::Base
+end

data/lib/rubypitaya/app-template/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_record'
+
+require 'rubypitaya'
+require 'rubypitaya/core/database_config'
+
+environment_name = ENV.fetch("RUBYPITAYA_ENV") { 'development' }
+database_config = DatabaseConfig.new(environment_name, Path::DATABASE_CONFIG_PATH)
+ActiveRecord::Base.establish_connection(database_config.connection_data)
+ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT)
+ActiveSupport::LogSubscriber.colorize_logging = true
+
+Gem.find_files('rubypitaya/**/*.rb').each do |path|
+  require path unless path.end_with?('spec.rb') || path.include?('db/migrate')
+end
+
+require 'irb'
+IRB.start(__FILE__)
+
+ActiveRecord::Base.connection.close

data/lib/rubypitaya/app-template/config/database.yml

@@ -0,0 +1,22 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: <%= ENV['RUBYPITAYA_MAX_THREADS'] { 5 } %>
+  host: <%= ENV['DATABASE_HOST'] %>
+  user: <%= ENV['DATABASE_USER'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>
+
+development:
+  <<: *default
+  database: <%= "#{ENV['DATABASE_NAME']}_development" %>
+
+test:
+  <<: *default
+  database: <%= "#{ENV['DATABASE_NAME']}_test" %>
+
+production:
+  <<: *default
+  database: <%= "#{ENV['DATABASE_NAME']}_production" %>
+  # username: rails_project
+  # password: <%= ENV['RAILS_PROJECT_DATABASE_PASSWORD'] %>
+

data/lib/rubypitaya/app-template/db/migrate/001_create_user_migration.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+class CreateUserMigration < ActiveRecord::Migration[5.1]
+
+  enable_extension 'pgcrypto'
+
+  def change
+    create_table :users, id: :uuid do |t|
+      t.timestamps
+    end
+  end
+end

data/lib/rubypitaya/app-template/db/migrate/002_create_player_migration.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+
+class CreatePlayerMigration < ActiveRecord::Migration[5.1]
+
+  enable_extension 'pgcrypto'
+
+  def change
+    create_table :players, id: :uuid do |t|
+      t.belongs_to :user, type: :uuid
+      t.string :name, null: false
+      t.timestamps null: false
+    end
+  end
+end

data/lib/rubypitaya/app-template/docker/dev/Dockerfile

@@ -0,0 +1,19 @@
+FROM ruby:2.6.6
+
+RUN apt update
+RUN apt install -y git vim docker.io postgresql-client --no-install-recommends
+
+WORKDIR /app/rubypitaya/
+
+COPY Gemfile Gemfile.lock ./
+
+RUN bundle install
+
+COPY . .
+
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
+ENTRYPOINT ["./docker/entrypoint.sh"]
+
+CMD ["bundle", "exec", "rubypitaya"]

data/lib/rubypitaya/app-template/docker/entrypoint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+cmd="$@"
+
+echo "=> Waiting for postgres"
+until PGPASSWORD=$DATABASE_PASSWORD psql -h "$DATABASE_HOST" -U "$DATABASE_USER" -c '\q' > /dev/null 2>&1; do
+  echo "=> Waiting for Postgres..."
+  sleep 1
+done
+
+echo "=> Postgres is ready"
+
+exec $cmd

data/lib/rubypitaya/app-template/docker/prod/Dockerfile

@@ -0,0 +1,32 @@
+FROM ruby:2.6.6 as builder
+
+WORKDIR /app/rubypitaya/
+
+COPY Gemfile Gemfile.lock ./
+
+RUN bundle install
+
+COPY . .
+
+FROM ruby:2.6.6-slim
+
+RUN apt update && apt install -y docker.io postgresql-client --no-install-recommends
+RUN rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local/etc /usr/local/etc
+COPY --from=builder /usr/local/bundle /usr/local/bundle
+COPY --from=builder /usr/local/bin/ruby /usr/local/bin/ruby
+COPY --from=builder /usr/local/lib/ruby/gems/2.6.0 /usr/local/lib/ruby/gems/2.6.0
+
+COPY --from=builder /app/rubypitaya /app/rubypitaya
+
+WORKDIR /app/rubypitaya/
+
+RUN rm -rf vendor/
+
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
+ENTRYPOINT ["./docker/entrypoint.sh"]
+
+CMD ["bundle", "exec", "rubypitaya"]

data/lib/rubypitaya/app-template/docker/prod/Makefile

@@ -0,0 +1,67 @@
+## Run ruby pitaya metagame project
+run:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rubypitaya
+
+## Update docker images
+update:
+	@docker-compose pull
+
+## Create database
+db-create:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:create
+
+## Run migrations to database
+db-migrate:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:migrate
+
+## Drop database
+db-drop:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:drop
+
+## Reset database
+db-reset:
+	@docker-compose run --service-ports --rm rubypitaya bundle exec rake db:reset
+
+.DEFAULT_GOAL := show-help
+
+.PHONY: show-help
+show-help:
+	@echo "$$(tput bold)Commands:$$(tput sgr0)"
+	@echo
+	@sed -n -e "/^## / { \
+		h; \
+		s/.*//; \
+		:doc" \
+		-e "H; \
+		n; \
+		s/^## //; \
+		t doc" \
+		-e "s/:.*//; \
+		G; \
+		s/\\n## /---/; \
+		s/\\n/ /g; \
+		p; \
+	}" ${MAKEFILE_LIST} \
+	| LC_ALL='C' sort --ignore-case \
+	| awk -F '---' \
+		-v ncol=$$(tput cols) \
+		-v indent=19 \
+		-v col_on="$$(tput setaf 6)" \
+		-v col_off="$$(tput sgr0)" \
+	'{ \
+		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
+		n = split($$2, words, " "); \
+		line_length = ncol - indent; \
+		for (i = 1; i <= n; i++) { \
+			line_length -= length(words[i]) + 1; \
+			if (line_length <= 0) { \
+				line_length = ncol - indent - length(words[i]) - 1; \
+				printf "\n%*s ", -indent, " "; \
+			} \
+			printf "%s ", words[i]; \
+		} \
+		printf "\n"; \
+	}'
+
+
+