osbc 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd1d73f028ec3088b5eaeb186edaeaa6cb1251e93c68810e1dffc520ab4a2d37
-  data.tar.gz: 11cd22644ea8bf53f2428b415550e61092214a7c1dd299a47526f5d3dbaaee72
+  metadata.gz: da66396b86c21e9d866ef9e4746f7564a13a11c47284e1e10e6dcacca653a22b
+  data.tar.gz: 2b0a20d56263176ccc5ed33031c28711515c34984e2f23b8b5f98336d85eca0b
 SHA512:
-  metadata.gz: 2de4088d38539c8054ac620b7fbaa8655d8607af1555dec37a4c5b1ca2e8ab002d47fcd0078da39e41203078713d6d92ceedc1a30a01663d87b3aaf62ee0911b
-  data.tar.gz: '0688ddf35ac525fe9a584f12a1831ef35f5967dba4f5eec2686a9430edfe453d218c4c9b3ce9faa7d283d3a56a10b4a5611466a3a72025025a724247a6a7bafd'
+  metadata.gz: ab8de79dae15c91100bbb0bc6af6ddbfcff1e19f9fe8fcbb2f3dfedbd4f28e254785e96ec0659a3cfd9ddc3db025ab33ff71809935f42ff7486b11008825c982
+  data.tar.gz: bdd757b8a908c0499dbdac4d352c421c625dd281c6c365661a285e14acff36f9553b614e2ceeb5502b579e36a9ba2cf5823e6f7919915a23662588fce85b2b34

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [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
+## [0.1.7]

data/Gemfile.lock

@@ -146,7 +146,7 @@ GEM
     net-smtp (0.3.2)
       net-protocol
     nio4r (2.5.8)
-    nokogiri (1.13.8-x86_64-linux)
+    nokogiri (1.13.9-x86_64-linux)
       racc (~> 1.4)
     orm_adapter (0.5.0)
     parallel (1.22.1)

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
+#### Refactored 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/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.6"
+  VERSION = "0.1.8"
   class Osbc
   end
 

data/mining_concept.ipynb

@@ -93,8 +93,8 @@
     "secret = 'a239c12ecc42911ecbc3b23a9539976caaa60f7d40028dea17cb67cc538c21bd'\n",
     "\n",
     "headers = {\n",
-    "    'X-Api-Key': key,\n",
-    "    'X-Api-Secret': secret,\n",
+    "    'X-API-KEY': key,\n",
+    "    'X-API-SECRET': secret,\n",
     "}\n",
     "\n",
     "\n",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osbc
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - jesus_gautamah
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2022-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -290,7 +290,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
-description: Blockchain implementation in Ruby using Rails and Docker
+description: |-
+  Outerspace Web Blockchain Framework implementation in Ruby using Rails and Docker.
+    Please visit https://github.com/JesusGautamah/outerspace-blockchain for more information.
+    If you like the project or ideas, please consider donating to the project ou star it on GitHub.
+    It will be constructed for a long time and will be improved with the help of the community.
+    Thank you for your support.
 email:
 - lima.jesuscc@gmail.com
 executables:
@@ -340,7 +345,9 @@ files:
 - app/assets/stylesheets/home.css
 - app/channels/application_cable/channel.rb
 - app/channels/application_cable/connection.rb
+- app/controllers/api/v1/application_controller.rb
 - app/controllers/api/v1/block_confirmations_controller.rb
+- app/controllers/api/v1/ticket_manager_controller.rb
 - app/controllers/application_controller.rb
 - app/controllers/blocks_controller.rb
 - app/controllers/chains_controller.rb
@@ -520,6 +527,7 @@ files:
 - config/initializers/filter_parameter_logging.rb
 - config/initializers/inflections.rb
 - config/initializers/permissions_policy.rb
+- config/initializers/sidekiq.rb
 - config/locales/devise.en.yml
 - config/locales/en.yml
 - config/puma.rb
@@ -528,39 +536,6 @@ files:
 - config/sidekiq.yml
 - config/storage.yml
 - config/tailwind.config.js
-- coverage/.last_run.json
-- coverage/.resultset.json
-- coverage/.resultset.json.lock
-- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc.png
-- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc_disabled.png
-- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_both.png
-- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc.png
-- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc_disabled.png
-- coverage/assets/0.12.3/application.css
-- coverage/assets/0.12.3/application.js
-- coverage/assets/0.12.3/colorbox/border.png
-- coverage/assets/0.12.3/colorbox/controls.png
-- coverage/assets/0.12.3/colorbox/loading.gif
-- coverage/assets/0.12.3/colorbox/loading_background.png
-- coverage/assets/0.12.3/favicon_green.png
-- coverage/assets/0.12.3/favicon_red.png
-- coverage/assets/0.12.3/favicon_yellow.png
-- coverage/assets/0.12.3/images/ui-bg_flat_0_aaaaaa_40x100.png
-- coverage/assets/0.12.3/images/ui-bg_flat_75_ffffff_40x100.png
-- coverage/assets/0.12.3/images/ui-bg_glass_55_fbf9ee_1x400.png
-- coverage/assets/0.12.3/images/ui-bg_glass_65_ffffff_1x400.png
-- coverage/assets/0.12.3/images/ui-bg_glass_75_dadada_1x400.png
-- coverage/assets/0.12.3/images/ui-bg_glass_75_e6e6e6_1x400.png
-- coverage/assets/0.12.3/images/ui-bg_glass_95_fef1ec_1x400.png
-- coverage/assets/0.12.3/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-- coverage/assets/0.12.3/images/ui-icons_222222_256x240.png
-- coverage/assets/0.12.3/images/ui-icons_2e83ff_256x240.png
-- coverage/assets/0.12.3/images/ui-icons_454545_256x240.png
-- coverage/assets/0.12.3/images/ui-icons_888888_256x240.png
-- coverage/assets/0.12.3/images/ui-icons_cd0a0a_256x240.png
-- coverage/assets/0.12.3/loading.gif
-- coverage/assets/0.12.3/magnify.png
-- coverage/index.html
 - db/migrate/20221018053949_devise_create_users.rb
 - db/migrate/20221019002956_create_chains.rb
 - db/migrate/20221020112137_create_blocks.rb
@@ -615,14 +590,14 @@ files:
 - tmp/storage/.keep
 - vendor/.keep
 - vendor/javascript/.keep
-homepage: https://outerspace-blockchain.herokuapp.com/
+homepage: https://github.com/JesusGautamah/outerspace-blockchain
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://outerspace-blockchain.herokuapp.com/
+  homepage_uri: https://github.com/JesusGautamah/outerspace-blockchain
   source_code_uri: https://github.com/JesusGautamah/outerspace-blockchain
-  changelog_uri: https://github.com/outerspace-coding/outerspace-blockchain/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/JesusGautamah/outerspace-blockchain/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -641,5 +616,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Blockchain implementation in Ruby
+summary: Outerspace Web Blockchain Framework implementation in Ruby
 test_files: []

data/coverage/.last_run.json

@@ -1,5 +0,0 @@
-{
-  "result": {
-    "line": 80.9
-  }
-}