tonton_web 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fb4d6653fbc38244766810bd8773369a64c14b49a5007814829d98decc94af1
+  data.tar.gz: e3ba09e7b332166a9921749f49414cdec5a238e6b1b4416b0b1b88b0bd86c5e7
+SHA512:
+  metadata.gz: c8c7042cfb40609e265fe276690b2400d953453647c3ce6ca4aebd0f0b666b0cad9f5d3cd513f9d9a4d3b8f7dbc47287f5058a9f3ca83a0f9eebd80fbfb016d4
+  data.tar.gz: ea62ef794b1a5f69344247ed5c14c01cca2b2c4d710f3079b072aa40a5c688ba97be2774589053b85799f1be2abbed6a122bd27c6415399fe36ce4af882086da

data/QA.md

@@ -0,0 +1,73 @@
+# Perguntas e respostas
+
+## Qual é a origem do nome TonTon?
+
+É um nome fofo.
+
+## Por que a logo do TonTon é um coelho?
+
+É uma logo fofa.
+
+## Quantas pessoas desenvolvem o TonTon?
+
+Majoritariamente uma: eu.
+
+Prazer, seruna.
+
+Mas o projeto recebeu uma contribuição recente da vanel. Obrigado vanel.
+
+## Como o TonTon é mantido?
+
+TonTon não gera nenhuma renda.
+
+A despesa se dá pela mensalidade do serviço de servidor virtual para hospedar o site e pela anuidade do domínio.
+
+Os custos são cobertos por mim e pela vanel. Obrigado vanel.
+
+## E se eu, por algum motivo, quiser ajudar financeiramente a manter o projeto?
+
+Se você é brasileiro, PIX:
+
+	02196960209
+
+Se você não é brasileiro, [Ko-fi](https://ko-fi.com/seruna1).
+
+Obrigado.
+
+## O TonTon é feito inteiramente em Ruby?
+
+Não, mas a maioria do código relacionado à web é em Ruby.
+
+Espera-se que tenha algumas coisas em C, outra linguagem familiar para o desenvolvedor.
+
+## Por que o TonTon é feito em Ruby?
+
+ - É a linguagem de programação preferida do desenvolvedor.
+
+ - Um excelente ecossistema.
+
+ - Legível, parece natural, ajuda o TonTon a ser simples e extensível. Também ajuda a manter a qualidade de vida do desenvolvedor.
+
+## Ruby não é uma linguagem morta?
+
+Acredito que não seja o caso. Mas certamente não é tão popular quanto Javascript ou Python.
+
+## Posso contribuir com o TonTon sem programar em Ruby?
+
+Pode.
+
+## Quão ativo é o desenvolvimento do TonTon
+
+Desenvolvo em meu tempo livre.
+
+## Por que Sinatra? Por que não Ruby on Rails?
+
+Simplicidade no escopo do projeto.
+
+## O TonTon é para grupos de estudo?
+
+Sim.
+
+## TonTon só seria usado para cursos de computação?
+
+Não necessariamente.

data/bin/tauth

@@ -0,0 +1,88 @@
+#! /usr/bin/ruby
+
+require 'sod'
+
+require_relative '../lib/tonton_web/auth'
+require 'io/console'
+
+class CreateTable < Sod::Action
+	on "--create-table"
+
+	def call(*)
+		context.tauth.create_tables
+	end
+end
+
+class CreateUser < Sod::Command
+	handle "create-user"
+
+	class Username < Sod::Action
+		on "--username", argument: "USERNAME"
+
+		def call(username) = context.input[:username] = username
+	end
+
+	class Name < Sod::Action
+		on "--name", argument: "NAME"
+
+		def call(name) = context.input[:name] = name
+	end
+
+	class Email < Sod::Action
+		on "--email", argument: "EMAIL"
+
+		def call(email) = context.input[:email] = email
+	end
+
+	on Username
+	on Name
+	on Email
+
+	def call
+		context.input[:password] = IO::console.getpass("User password: ")
+
+		context.tauth.create_user(**context.input)
+	end
+end
+
+class DeleteUser < Sod::Action
+	on "--delete-user", argument: "USER_ID"
+
+	def call(user_id)
+		context.tauth.delete_user user_id
+	end
+end
+
+class Info < Sod::Command
+	handle "info"
+
+	description "Information about user."
+
+	class Username < Sod::Action
+		on "--username", argument: "TEXT"
+
+		def call text
+			puts context.tauth.find_user(username: text)
+		end
+	end
+
+	on Username
+end
+
+tauth = TonTonWeb::Auth.new Dir.getwd
+
+context = Sod::Context[tauth: tauth, input: {}]
+
+cli = Sod.new(banner: "Tauth 0.0.0: TonTon Auth") do
+	on(CreateTable, context:)
+
+	on(CreateUser, context:)
+
+	on(DeleteUser, context:)
+
+	on(Info, context:)
+
+	on Sod::Prefabs::Actions::Help, self
+end
+
+cli.call

data/bin/tonton-web

@@ -0,0 +1,35 @@
+#! /usr/bin/ruby
+
+require 'sod'
+
+class New < Sod::Action
+	on "--new", argument: "NAME"
+
+	def call(name)
+		destination_root = Pathname.new name
+
+		destination_root.mkdir
+
+		(destination_root+'modules').mkdir
+
+		gem_root = Pathname.new(__FILE__).parent + '..'
+
+		for source in gem_root.glob('{example/*,*.md}')
+			destination = destination_root + source.basename
+
+			`cp #{source} #{destination}`
+		end
+
+		(destination_root+'views').mkdir
+
+		`cp -r #{gem_root+'views'} #{destination_root}`
+	end
+end
+
+cli = Sod.new(banner: "TonTon Web 0.0.0: TonTon utilitary for web apps") do
+	on(New)
+
+	on Sod::Prefabs::Actions::Help, self
+end
+
+cli.call

data/building.md

@@ -0,0 +1,19 @@
+# Contruindo uma instância do TonTonWeb
+
+Clone o repositório da aplicação princiapal (esse repositório).
+
+Edite o arquivo de configuração Rack [config.ru]. O arquivo exemplo mapeia apenas a rota '/' para a aplicação principal. Adicione aplicações do projeto TonTon e mapeie elas para novas rotas.
+
+Instale as dependências e inicie o servidor.
+
+	bundle install
+
+	bundle exec puma
+
+É necessário que o shell tenha a variável de ambiente SESSION_SECRET definida.
+
+UwU
+
+## Módulos Ruby TonTon
+
+Clone o repositório do módulo dentro da aplicação principal e o inclua no arquivo [config.ru].

data/example/app.rb

@@ -0,0 +1,18 @@
+require 'gollum/app'
+require 'sinatra/flash'
+require "sqlite3"
+require 'tonton_web'
+
+class TonTonWeb::App < Sinatra::Base
+	set :host_authorization, { permitted_hosts: ['localhost', 'mytonton.com.br'] }
+
+	set :sessions, true
+
+	get '/' do
+		redirect "/readme.md"
+	end
+
+	get '/:name' do
+		markdown File.read(params['name']), layout_engine: :erb, layout: true
+	end
+end

data/example/config.ru

@@ -0,0 +1,12 @@
+require_relative 'app'
+
+# Require TonTon modules if you want
+
+use Rack::Session::Cookie, key: 'rack.session', secret: ENV.fetch('SESSION_SECRET')
+
+app = Rack::URLMap.new(
+	'/' => TonTonWeb::App.new
+	# Add TonTon modules here
+)
+
+run app

data/lib/tonton_web/auth.rb

@@ -0,0 +1,73 @@
+require 'pathname'
+require 'sqlite3'
+require 'bcrypt'
+
+module TonTonWeb
+	User = Struct.new(:id, :name, :username, :email, :password_digest)
+
+	class Auth
+		attr_reader :root
+
+		def initialize root_path
+			@root = Pathname.new root_path
+
+			@db = SQLite3::Database.new(@root+ 'database.sqlite')
+		end
+
+		def create_tables
+			@db.execute "create table users (id integer primary key, name text, username text, email text, password_digest text);"
+		end
+
+		def create_user **options
+			name = options.fetch :name
+			username = options.fetch :username
+			email = options.fetch :email
+			password = options.fetch :password
+
+			# Assert user doesn't exists
+
+			hashed_password = BCrypt::Password.create(password)
+
+			@db.execute(
+				"insert into users (name, username, email, password_digest) values (?,?,?,?);",
+				[name, username, email, password]
+			)
+
+			return # Return user
+		end
+
+		def delete_user id
+			@db.execute "delete from users where id = ?;", id
+		end
+
+		def find_user **options
+			name = options[:name]
+			username = options[:username]
+			email = options[:email]
+
+			if not (name or username or email)
+				raise "No options to find user."
+			end
+
+			user = nil
+
+			user_query_template = "select id, name, username, email, password_digest from users where name = ? or username = ? or email = ?"
+
+			@db.execute(user_query_template, [name, username, email]) do |row|
+				user = TonTonWeb::User.new(*row)
+			end
+
+			return user
+		end
+
+		def authenticate username, password
+			user = find_user(username: username)
+
+			if BCrypt::Password.new(user.password_digest) == password
+				return user
+			else
+				return false
+			end
+		end
+	end
+end

data/lib/tonton_web.rb

@@ -0,0 +1 @@
+require_relative 'tonton_web/auth'

data/readme.md

@@ -0,0 +1,83 @@
+# TonTon
+
+TonTon é uma antologia de softwares abertos, modulares e relacionados com tecnologia na educação e com aprendizado colaborativo. Esse repositório contém a aplicação web principal. <(^_^)>
+
+O Ruby on Rails foi substituido pelo Sinatra. (⌐■_■)
+
+As aplicações terão APIs para facilitar interfaces alternativas. Monte o seu TonTon. ( ͡° ᴥ ͡°)
+
+[Building](building.md)
+
+[Q&A](QA.md)
+
+## TonTonWeb
+
+Aplicação web principal, em Ruby, com um mecanismo de controle de usuários.
+
+O gerenciamento é feito via linha de comando (utilitário tauth) e interface web.
+
+O serviços são expostos via:
+
+ - API Ruby via Rack (para ser usada pela interface interna).
+
+ - API web (para ser usada por interfaces que não são escritas em Ruby).
+
+O TonTonWeb tem uma versão [experimental](https://github.com/seruna-1/tonton) em Ruby on Rails, agora arquivada. (◡_◡)
+
+Status: sem mecanismo de autenticação.
+
+## TonTon-Gollum (wiki)
+
+Uma extensão simples da wiki Gollum para suportar autenticação de usuário.
+
+Status: testável.
+
+Funcionalidades esperadas:
+
+ - Subdiretórios dos usuários editáveis apenas pelo próprio usuário.
+
+## Tolls
+
+Tonton Polls.
+
+Aplicação Sinatra para gerenciamento de enquetes.
+
+Status: não iniciado.
+
+## Tofinn
+
+Tokenizable File Interface.
+
+Toffin é um modelo genérico de árvore de arquivos tokenizáveis e com um modelo integrado opcional de versionamento de arquivos.
+
+Status: concepção. Duas implementações esperadas, uma em C (Coffin) e outra em Ruby (Torfinn). Há uma versão [experimental](https://github.com/seruna-1/toffin), em Ruby, abandonada.
+
+## Totoki
+
+Totoki é o plano de wiki futura para o TonTon usando a API do Toffin.
+
+Totoki é inspirada pelo Gollum. Assim como o Gollum lida com frontend e tem a própria API separada (gollum-lib), o Totoki será a aplicação Sinatra com API wiki separada (totoki-lib).
+
+Status: não iniciado.
+
+## Tamire
+
+TonTon Abstract Mathematical Introspective Representation (Tamire).
+
+Tamire é uma biblioteca de para abstração de linguagem matemática em estruturas de objetos.
+
+Teria duas implementações, uma em Ruby e outra em Javascript, cada uma com:
+
+ - Leitura de Asciimath para entrada.
+
+ - Renderização em SVG para saída.
+
+ - Representação em Json para entrada e saída.
+
+Status: não iniciado.
+
+## Tamires
+
+Tamire Speaker (Tamires) é um módulo Javascript e uma aplicação Ruby para análise por pessoas cegas de estrutura matemática gerada pela Tamire.
+
+Status: não iniciado.

data/views/layout.erb

@@ -0,0 +1,25 @@
+<html>
+	<head>
+		<title>TonTon</title>
+	</head>
+
+	<body>
+		<header>
+			<nav>
+				<a href="/readme.md">Readme</a>
+
+				<a href="/building.md">Building</a>
+
+				<a href="/QA.md">Q&A</a>
+			</nav>
+		<header>
+
+		<%= yield %>
+	</body>
+
+	<script>
+		const title = document.querySelector('title');
+
+		title.textContent = document.querySelector('h1').textContent;
+	</script>
+</html>

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: tonton_web
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Mateus Cezário Barreto
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: TonTon Web app main parts
+email: mateus.cezario.barreto@gmail.com
+executables:
+- tauth
+- tonton-web
+extensions: []
+extra_rdoc_files: []
+files:
+- QA.md
+- bin/tauth
+- bin/tonton-web
+- building.md
+- example/app.rb
+- example/config.ru
+- lib/tonton_web.rb
+- lib/tonton_web/auth.rb
+- readme.md
+- views/layout.erb
+homepage: https://mytonton.com.br
+licenses:
+- MIT
+metadata: {}
+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.6.9
+specification_version: 4
+summary: TonTon Web app main parts
+test_files: []