osbc 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0959a1f1814a23d86916f914b28842a0f009ddd8e22bdd8fecf14d2d0d29f659'
-  data.tar.gz: a8473f6072c95c8af77a9d402ab6988ace065ce177e688a35828275910c9d1b5
+  metadata.gz: 34b4e07aede46460687f931e6c170bfa6cd32b96eec1022db4dc0edd20c8b4f4
+  data.tar.gz: e15914a8d36c5c60561109915cc2acdd9fe0517d2f767f02e5a118e7684f0f08
 SHA512:
-  metadata.gz: 6a76df0d7eeb1f18f9ec34eee953a5fb1df36dab4375d514cd59a67e8ba3960486eb28dd9bf86ebba7755f666caa61b76d163f7a08fdfa33ba4b2fbb762b9d30
-  data.tar.gz: f778bf73d3de0a3d51f7f69e7e11796b5305756552681f4e82d39487ec932a13b87fe293842f75d1f160db8d64c77847259f5e1d6c9bc9faf13d2daa461b6210
+  metadata.gz: 4db75d9e4e3dbc1889e205ffe3e802e7956be058b7f93519d064297ad46d6bc0ab2fad3b27fb95a309bc3e7abd77aa9689f304fd34b6240eca9430ab0dec1568
+  data.tar.gz: b1f5afc4c7016ed067b8520d5e7d81324dc393eda418e3a0fbef8a87257f78ab5883daeb601aed694fe05b414028020cb1c13546da59e962c613670ed2ac63eb

data/.env

@@ -3,3 +3,4 @@ FIRST_CHAIN_MAINTAINER=YOUR_NAME
 CONTRACTS_LIMIT=2
 SIGNATURES_LIMIT=5
 REDIS_URL=redis://redis:6379
+ENV_MACHINE=docker

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-10-18
-
-- Initial release
+## [0.1.5]
+### Added
+- Initial Version
+## [0.1.6]
+### Added
+- Docker Compose Installation Recognition
+- Refactored some tests
+- Added lib tasks helper to created rake tasks for blockchain

data/README.md

@@ -12,6 +12,22 @@
 
 #### Rspec is used to test the blockchain.
 
+## Build Version: 0.1.7
+### Last Update:
+#### Added Open Ticket Api Methods
+#### Reafactored some methods and tests
+#### Removed coverage folder github repo
+##### TODO
+###### Add more tests
+###### Add more features
+###### Include pagination
+###### Create Queries Folder
+###### Test in kubernetes
+###### Add more documentation
+###### Add NFT Generator
+###### Increase the environment variables for autoconfig
+###### Add features to autogeneration of blockchain for better configuration
+
 ## System dependencies
     1. Docker
     2. Postgresql
@@ -159,18 +175,16 @@ The mine will depend of the contract signatures that will be formed by the serve
 2. The server will send a message to the user to start mining if the POOL is open
 3. The users will load the RANDOM WORD LIST provided by the server API
 4. The user have to use 1 common word, 1 symbol sequence and 1 number sequence, randomize the characters
-5. Transform the chartacters in a SHA256 hash
-6. Transform the block info in before ticket opened in a SHA256 hash
-5. Transform (Chars SHA256 hash + block info hash) in a SHA256 hash
-6. If the hash is valid, the user will send the hash to the server
-7. The server will check if the hash is valid
-8. If the hash is valid, check if the same transactions have the same block state confirmation
-9. If this transactions was not confirmed at this point at block history the server will add the user signature to the transaction contract
+5. Transform the shuffled chartacters in a SHA256 hash
+6. The user will send the hash to the server
+7. The server will validate the hash and will send a message to the user if the hash is valid
+8. If the hash is valid, check if the same transactions have the same block state confirmation, if yes, the user will have to mine again in a new state of the transactions timeline
+9. If this transactions was not confirmed at this point at block history the server will add the user signature to the transactions contracts included in the users ticket timeline range
 10. The block only can be hashed when the minimum number of contracts valids with minimum number of signatures is reached
 11. The server will use the signature timeline to determine what transactions will be added to the block
 12. The server will calculate the master hash after confirm all valid contracts signatures
-13. The server will add the block to the blockchain and create a new one with last block unconfirmed transactions but completely unsigned
-13. The server will start a open/closed pool cycle
+13. Assignmaster hash to the block, create new block and add to the blockchain with previous block hash
+13. The server will start a open/closed pool cycle ( pool is open only if has a minimun of transactions to mine )
 14. The server will send a message to the user to start mining when the POOL is open and user has a ticket
 <p>
 The timestamps of the signatures will be usefull to version the block, checking it as a timeline
@@ -178,7 +192,7 @@ The timestamps of the signatures will be usefull to version the block, checking
 
 **The miners will be rewarded with the block reward distributed by the number of signatures**
 ## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/outerspace-coding/outerspace-blockchain
+Bug reports and pull requests are welcome on GitHub at https://github.com/JesusGautamah/outerspace-blockchain
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/api/v1/application_controller.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class Api::V1::ApplicationController < ActionController::API
+  def unauthorized?
+    return unauthorized_response unless find_user_by_header
+  end
+
+  def ticket_founded?
+    @ticket = Ticket.find_by(user_id: @user.id, status: :active)
+    return ticket_not_found_response unless @ticket.present?
+  end
+
+  private
+    attr_accessor :user
+
+    def find_user_by_header
+      return unless request.headers["X-API-KEY"].present?
+      api_key = request.headers["X-API-KEY"]
+      @user = User.find_by(api_key: api_key)
+      return unless @user.present?
+      @user.api_secret == request.headers["X-API-SECRET"]
+    end
+
+    def confirmation_hash_founded?
+      return confirmation_hash_not_found_response unless confirmation_hash.present?
+    end
+
+    def confirmation_hash
+      @confirmation_hash ||= block_confirmation_params[:user_confirmation_hash]
+    end
+
+    def confirmation_hash_not_found_response
+      render json: { error: "Confirmation hash not found" }, status: :not_found
+    end
+
+    def ticket_not_found_response
+      render json: { error: "Ticket not found" }, status: :not_found
+    end
+
+    def unauthorized_response
+      render json: { error: "Unauthorized" }, status: :unauthorized
+    end
+
+    def current_block
+      @current_block = Block.find_by(master_hash: nil)
+    end
+
+    def current_pool
+      @current_pool = Pool.find_by(block_id: current_block.id)
+    end
+
+    def ticket
+      @ticket = Ticket.find_by(user_id: user.id, status: :active)
+    end
+
+    def block_transactions
+      @block_transactions = Transaction.where(block_id: current_block.id)
+    end
+
+    def block_transactions_empty?
+      return no_transactions_response unless block_transactions.present?
+    end
+
+    def no_transactions_response
+      render json: { error: "No transactions in the block" }, status: :not_found
+    end
+end

data/app/controllers/api/v1/block_confirmations_controller.rb

@@ -1,62 +1,43 @@
 # frozen_string_literal: true
 
-class Api::V1::BlockConfirmationsController < ActionController::API
+class Api::V1::BlockConfirmationsController < Api::V1::ApplicationController
+  before_action :unauthorized?
+  before_action :ticket_founded?, only: [:confirm_block]
+  before_action :confirmation_hash_founded?, only: [:confirm_block]
+
   def confirm_block
-    return unauthorized_response unless find_user_by_header
-    @ticket = Ticket.find_by(user_id: @user.id, status: :active)
-    return ticket_not_found_response unless @ticket.present?
-    confirmation_hash = block_confirmation_params[:user_confirmation_hash]
-    return confirmation_hash_not_found_response unless confirmation_hash.present?
-    return not_valid_confirmation_hash_response unless @ticket.user_acceptable_hash == confirmation_hash
+    return not_valid_confirmation_hash_response unless hash_confirmed?
     assign_contract
   end
 
-  def transactions_to_mine
-    return unauthorized_response unless find_user_by_header
-    ticket = Ticket.find_by(user_id: @user.id)
-    return ticket_not_found_response unless ticket.present?
-    transactions_ids = ticket.transaction_id_list
-    transactions = Transaction.where(id: transactions_ids)
-    transactions_json = transactions.to_json
-    render json: transactions_json, status: :ok
-  end
-
   def info_to_mine
-    return unauthorized_response unless find_user_by_header
-    words = @user.acceptable_words
-    number_sequences = @user.acceptable_number_sequences
-    symbol_sequences = @user.acceptable_symbol_sequences
     render json: { words: words, number_sequences: number_sequences, symbol_sequences: symbol_sequences }, status: :ok
   end
 
   private
-    def find_user_by_header
-      return unless request.headers["X-Api-Key"].present?
-      api_key = request.headers["X-Api-Key"]
-      @user = User.find_by(api_key: api_key)
-      return unless @user.present?
-      @user.api_secret == request.headers["X-Api-Secret"]
+    def hash_confirmed?
+      @ticket.user_acceptable_hash == confirmation_hash
     end
 
-    def unauthorized_response
-      render json: { error: "Unauthorized" }, status: :unauthorized
+    def assign_contract
+      AssignContractWorker.perform_async(@ticket.id)
+      render json: { message: "Contract assigned" }, status: :ok
     end
 
-    def ticket_not_found_response
-      render json: { error: "Ticket not found" }, status: :not_found
+    def not_valid_confirmation_hash_response
+      render json: { error: "Not valid confirmation hash" }, status: :not_found
     end
 
-    def confirmation_hash_not_found_response
-      render json: { error: "Confirmation hash not found" }, status: :not_found
+    def words
+      @words = @user.acceptable_words
     end
 
-    def assign_contract
-      AssignContractWorker.perform_async(@ticket.id)
-      render json: { message: "Contract assigned" }, status: :ok
+    def number_sequences
+      @number_sequences = @user.acceptable_number_sequences
     end
 
-    def not_valid_confirmation_hash_response
-      render json: { error: "Not valid confirmation hash" }, status: :not_found
+    def symbol_sequences
+      @symbol_sequences = @user.acceptable_symbol_sequences
     end
 
     def block_confirmation_params

data/app/controllers/api/v1/ticket_manager_controller.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+class Api::V1::TicketManagerController < Api::V1::ApplicationController
+  before_action :unauthorized?
+  before_action :block_transactions_empty?, only: [:open_ticket]
+
+  def open_ticket
+    return ticket_already_opened_response unless ticket_nil?
+    return ticket_already_opened_response if ticket_active?
+    return terms_not_confirmed_response unless ticket_params_confirmed?
+    create_ticket if acceptable_create?
+    ticket_opened_response
+  end
+
+
+  private
+    def ticket_nil?
+      ticket.nil?
+    end
+
+    def ticket_active?
+      return false if ticket_nil?
+      ticket.status == "active"
+    end
+
+    def acceptable_create?
+      ticket_nil? && ticket_params_confirmed? || ticket_params_confirmed? && ticket_active? == false
+    end
+
+    def ticket_params_confirmed?
+      open_ticket_params[:ticket_terms] == "confirmed"
+    end
+
+    def ticket_already_opened_response
+      render json: { error: "Ticket already opened" }, status: :not_found
+    end
+
+    def ticket_opened_response
+      render json: { message: "Ticket opened" }, status: :ok
+    end
+
+    def terms_not_confirmed_response
+      render json: { error: "Ticket terms not confirmed" }, status: :not_found
+    end
+
+    def open_ticket_params
+      params.permit(:ticket_terms)
+    end
+
+    def time_ref
+      @time_ref = block_transactions.first.created_at.to_s
+    end
+
+    def user_id
+      @user_id = user.id.to_s
+    end
+
+    def current_pool_id
+      @current_pool_id = current_pool.id.to_s
+    end
+
+    def create_ticket
+      CreateTicketWorker.perform_async(user_id, current_pool_id, time_ref)
+    end
+end

data/app/controllers/contracts_controller.rb

@@ -17,9 +17,4 @@ class ContractsController < ApplicationController
     def set_contract
       @contract = Contract.find(params[:id])
     end
-
-    # Only allow a list of trusted parameters through.
-    def contract_params
-      params.require(:contract).permit(:first_sig, :second_sig, :third_sig, :fourth_sig, :status, :transaction_id)
-    end
 end

data/app/controllers/pools_controller.rb

@@ -13,61 +13,9 @@ class PoolsController < ApplicationController
   def show
   end
 
-  # GET /pools/new
-  def new
-    @pool = Pool.new
-  end
-
-  # GET /pools/1/edit
-  def edit
-  end
-
-  # POST /pools or /pools.json
-  def create
-    @pool = Pool.new(pool_params)
-
-    respond_to do |format|
-      if @pool.save
-        format.html { redirect_to pool_url(@pool), notice: "Pool was successfully created." }
-        format.json { render :show, status: :created, location: @pool }
-      else
-        format.html { render :new, status: :unprocessable_entity }
-        format.json { render json: @pool.errors, status: :unprocessable_entity }
-      end
-    end
-  end
-
-  # PATCH/PUT /pools/1 or /pools/1.json
-  def update
-    respond_to do |format|
-      if @pool.update(pool_params)
-        format.html { redirect_to pool_url(@pool), notice: "Pool was successfully updated." }
-        format.json { render :show, status: :ok, location: @pool }
-      else
-        format.html { render :edit, status: :unprocessable_entity }
-        format.json { render json: @pool.errors, status: :unprocessable_entity }
-      end
-    end
-  end
-
-  # DELETE /pools/1 or /pools/1.json
-  def destroy
-    @pool.destroy
-
-    respond_to do |format|
-      format.html { redirect_to pools_url, notice: "Pool was successfully destroyed." }
-      format.json { head :no_content }
-    end
-  end
-
   private
     # Use callbacks to share common setup or constraints between actions.
     def set_pool
       @pool = Pool.find(params[:id])
     end
-
-    # Only allow a list of trusted parameters through.
-    def pool_params
-      params.require(:pool).permit(:block_id, :users_count, :signatures_count, :amount, :stage)
-    end
 end

data/app/controllers/signatures_controller.rb

@@ -17,9 +17,4 @@ class SignaturesController < ApplicationController
     def set_signature
       @signature = Signature.find(params[:id])
     end
-
-    # Only allow a list of trusted parameters through.
-    def signature_params
-      params.require(:signature).permit(:signature, :time_ref, :contract_id, :common_word, :symbol_sequence, :number_sequence, :verify_sig, :block_hash, :signature_hash)
-    end
 end

data/app/controllers/tickets_controller.rb

@@ -18,10 +18,6 @@ class TicketsController < ApplicationController
     @ticket = Ticket.new
   end
 
-  # GET /tickets/1/edit
-  def edit
-  end
-
   # POST /tickets or /tickets.json
   def create
     return no_transactions_response if block_transactions.empty?
@@ -29,29 +25,6 @@ class TicketsController < ApplicationController
     redirect_to tickets_path, notice: "Processing ticket, please wait, wait a minute and refresh the page"
   end
 
-  # PATCH/PUT /tickets/1 or /tickets/1.json
-  def update
-    respond_to do |format|
-      if @ticket.update(ticket_params)
-        format.html { redirect_to ticket_url(@ticket), notice: "Ticket was successfully updated." }
-        format.json { render :show, status: :ok, location: @ticket }
-      else
-        format.html { render :edit, status: :unprocessable_entity }
-        format.json { render json: @ticket.errors, status: :unprocessable_entity }
-      end
-    end
-  end
-
-  # DELETE /tickets/1 or /tickets/1.json
-  def destroy
-    @ticket.destroy
-
-    respond_to do |format|
-      format.html { redirect_to tickets_url, notice: "Ticket was successfully destroyed." }
-      format.json { head :no_content }
-    end
-  end
-
   private
     def create_ticket
       CreateTicketWorker.perform_async(current_user.id, current_pool.id, time_ref)

data/app/views/transactions/_transaction.html.slim

@@ -3,9 +3,8 @@ div id="#{dom_id transaction}"
     strong Sended by:
     =< transaction.sender
   p
-    strong Receiver By:
+    strong Receiver By: 
     =< transaction.receiver
-  / only show the information below if the Show page is being rendered
   - if action_name == "show"
     p
       strong Amount:

data/app/views/users/registrations/new.html.erb

@@ -5,7 +5,7 @@
   <%= render "users/shared/error_messages", resource: resource %>
   <div class="field text-black">
     <%= f.label :username, class: "text-white" %><br />
-    <em class="text-white">(10 characters minimum)</em>
+    <em class="text-white">(10 characters minimum)</em><br />
     <%= f.text_field :username, autofocus: true, autocomplete: "username",class: "px-4 py-2 rounded text-black border-2 border-purple-300 focus_border-purple-900" %>
   </div>
 

data/app/workers/create_ticket_worker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 class CreateTicketWorker < ApplicationWorker
+  include Sidekiq::Worker
   sidekiq_options retry: false
 
   def perform(user_id, pool_id, time_ref)

data/config/initializers/sidekiq.rb

@@ -0,0 +1 @@
+Sidekiq.strict_args!

data/config/routes/api.rb

@@ -3,7 +3,7 @@
 namespace :api do
   namespace :v1 do
     post "confirm_block", to: "block_confirmations#confirm_block"
-    get "tr_to_mine", to: "block_confirmations#transactions_to_mine"
+    post "open_ticket", to: "ticket_manager#open_ticket"
     get "info_to_mine", to: "block_confirmations#info_to_mine"
   end
 end

data/lib/osbc/osbc.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Osbc
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
   class Osbc
   end
 

data/lib/tasks/compose.rake

@@ -1,19 +1,29 @@
 # frozen_string_literal: true
 
 require "rake"
+require_relative "task_helpers/compose_taskhelper"
+
+
+def task_helper
+  @task_helper ||= TaskHelpers::ComposeTaskhelper.new
+end
+
+def compose_command
+  @compose_command ||= task_helper.compose_command
+end
 
 namespace :compose do
   task :install do
     puts "Installing Blockchain and Database Containers"
-    system "sudo docker compose build"
+    system "sudo #{compose_command} build"
     puts "Creating Database"
-    system "sudo docker compose run --rm web rails db:create"
+    system "sudo #{compose_command}  run --rm web rails db:create"
     puts "Migrating Database"
-    system "sudo docker compose run --rm web rails db:migrate"
+    system "sudo #{compose_command}  run --rm web rails db:migrate"
     puts "Seeding Database"
-    system "sudo docker compose run --rm web rails db:seed"
+    system "sudo #{compose_command}  run --rm web rails db:seed"
     puts "Stopping Containers"
-    system "sudo docker compose down"
+    system "sudo #{compose_command}  down"
     puts "Installing Blockchain and Database Containers... Done!"
     puts "This already setup your database with some initial values"
     puts "Start the containers with command: rake compose:up"
@@ -32,57 +42,58 @@ namespace :compose do
 
   task :build do
     puts "Building Compose..."
-    system "sudo docker compose build"
+    system "sudo #{compose_command}  build"
     puts "Building Compose... Done!"
   end
 
   task :up do
+    puts compose_command
     puts "Running Compose..."
-    system "sudo docker compose up -d --remove-orphans"
+    system "sudo #{compose_command} up -d --remove-orphans"
     puts "Running Compose... Done!"
   end
 
   task :down do
     puts "Stopping Compose..."
-    system "sudo docker compose down"
+    system "sudo #{compose_command}  down"
     puts "Stopping Compose... Done!"
   end
 
   task :db_detach do
     puts "Running Database Detached..."
-    system "sudo docker compose up -d db"
+    system "sudo #{compose_command}  up -d db"
     puts "Running Database Detached... Done!"
   end
 
   task :redis_detach do
     puts "Running Redis Detached..."
-    system "sudo docker compose up -d redis"
+    system "sudo #{compose_command}  up -d redis"
     puts "Running Redis Detached... Done!"
   end
 
   task :back_detach do
     puts "Running Backend Detached..."
-    system "sudo docker compose up -d --remove-orphans db redis sidekiq"
+    system "sudo #{compose_command}  up -d --remove-orphans db redis sidekiq"
     puts "Running Backend Detached... Done!"
   end
 
   task :restart do
     puts "Restarting Compose..."
     puts "Stopping Compose..."
-    system "sudo docker compose down"
+    system "sudo #{compose_command}  down"
     puts "Stopping Compose... Done!"
     puts "Running Compose..."
-    system "sudo docker compose up -d --remove-orphans"
+    system "sudo #{compose_command}  up -d --remove-orphans"
     puts "Restarting Compose... Done!"
   end
 
   task :clean_all do
     puts "Cleaning Images..."
     puts "Stopping Compose..."
-    system "sudo docker compose down"
+    system "sudo #{compose_command}  down"
     puts "Stopping Compose... Done!"
     puts "Removing Compose..."
-    system "sudo docker compose rm -v"
+    system "sudo #{compose_command}  rm -v"
     puts "Removing Compose... Done!"
     puts "Removing Containers..."
     system "sudo docker rm -f $(sudo docker ps -a -q)"