phantasma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83bf85cda436001142acb8223d80acb2d0946a3ebfbad523f540ef0e372f201c
+  data.tar.gz: 85b0d08826d43b51100cdb730991938101b34437d753504389c262fa182c3b22
+SHA512:
+  metadata.gz: e98803654fe40fef3c0a992d4827b8a0ba704ff26a6dfce519fb454690aaf54ef9eeb78822312e186f02ed4db2455f330b9c0e8b7a736497dd0b51b92dc8e151
+  data.tar.gz: 9f2b8078f207b3917fc34a5262c3f54d17adf4a147fc0359f3173e385add057720ce9873968ede62418298a153aece3a1cf80387074fecb3868fc418c5fca28f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Henry Maestu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Phantasma Ruby SDK
+[Phantasma](https://phantasma.io/) - A Smart NFT Carbon Negative Blockchain for Gaming, dApp
+
+This gem is community edition of Phantasma Blockchain SDK in Ruby.
+
+## Install
+```
+gem "phantasma", :git => "https://github.com/MysteriousNothing/phantasma.git"
+# or RubyGems
+gem "phantasma" 
+```
+
+#### Test API URL
+https://testnet.phantasma.info
+## Live API URL
+https://phantasma.gitbook.io/developers/overview/quick-start
+
+The Ruby version does not use different classes, we use Ruby metaprogramming.
+This means adding new endpoint means updating `ALLOWED_METHOD` const in [lib/phantasma/API/api.rb](lib/phantasma/API/request.rb)
+
+#### Examples how to use API:
+```
+api = Phantasma::API::Request.new(url: 'https://testnet.phantasma.info')
+api.get_account({account: '1231313'})
+api.get_accounts({accounts: ['1231313']})
+api.get_addresses_by_symbol({symbol: 'SOUL', extended: false})
+api.look_up_name({name: 'SOUL'})
+```
+
+#### Examples how to use RPC call with API:
+```
+api = Phantasma::API::Request.new(url: 'https://testnet.phantasma.info')
+api.rpc({"jsonrpc": "2.0", "method": "health", "id": "1", "params": [] })
+```
+
+## Full API documentation is here:
+[docs/api_documentation.md](docs/api_documentation.md)
+
+### Generate documentation after API update:
+
+```
+ruby lib/phantasma/documentation.rb
+```
+
+## Phantasma Documentation for API Endpoints with responses
+https://testnet.phantasma.info/swagger/index.html
+
+## Helpers
+Find missing or deprecated API endpoints by calling
+
+```
+Phantasma::API.find_missing_endpoints
+Phantasma::API.find_deprecated_endpoints
+```
+
+## Running tests
+
+```
+# All tests
+rspec spec/
+# Specific
+rspec spec/API/api_spec.rb
+```
+
+## Todo
+- [ ] Finish tests - 233 examples, 5 failures, 228 passed
+
+- [ ] RPC or eRPC(Google RPC, http2)
+
+- [ ] Phantasma VM in Ruby
+
+- [ ] Add API command line support
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MysteriousNothing/phantasma.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/docs/api_documentation.md

@@ -0,0 +1,556 @@
+### Account - get_account
+- **Endpoint**: `/api/v1/GetAccount`
+- **Method**: `GET`
+- **Parameters**:
+  - `account`: string
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_account({account: 'string', extended: true})
+```
+
+### Account - get_accounts
+- **Endpoint**: `/api/v1/GetAccounts`
+- **Method**: `GET`
+- **Parameters**:
+  - `accounts`: string
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_accounts({accounts: 'string', extended: true})
+```
+
+### Account - look_up_name
+- **Endpoint**: `/api/v1/LookUpName`
+- **Method**: `GET`
+- **Parameters**:
+  - `name`: string
+- **Ruby Example**:
+```ruby
+api.look_up_name({name: 'string'})
+```
+
+### Account - get_addresses_by_symbol
+- **Endpoint**: `/api/v1/GetAddressesBySymbol`
+- **Method**: `GET`
+- **Parameters**:
+  - `symbol`: string
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_addresses_by_symbol({symbol: 'string', extended: true})
+```
+
+### Auction - get_auctions_count
+- **Endpoint**: `/api/v1/GetAuctionsCount`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `symbol`: string
+- **Ruby Example**:
+```ruby
+api.get_auctions_count({chainAddressOrName: 'string', symbol: 'string'})
+```
+
+### Auction - get_auctions
+- **Endpoint**: `/api/v1/GetAuctions`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `symbol`: string
+  - `page`: integer, `default`: 1
+  - `pageSize`: integer
+- **Ruby Example**:
+```ruby
+api.get_auctions({chainAddressOrName: 'string', symbol: 'string', page: 1, pageSize: 'integer'})
+```
+
+### Auction - get_auction
+- **Endpoint**: `/api/v1/GetAuction`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `symbol`: string
+  - `IDtext`: string
+- **Ruby Example**:
+```ruby
+api.get_auction({chainAddressOrName: 'string', symbol: 'string', IDtext: 'string'})
+```
+
+### Block - get_block_height
+- **Endpoint**: `/api/v1/GetBlockHeight`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainInput`: string
+- **Ruby Example**:
+```ruby
+api.get_block_height({chainInput: 'string'})
+```
+
+### Block - get_block_transaction_count_by_hash
+- **Endpoint**: `/api/v1/GetBlockTransactionCountByHash`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `blockHash`: string
+- **Ruby Example**:
+```ruby
+api.get_block_transaction_count_by_hash({chainAddressOrName: 'string', blockHash: 'string'})
+```
+
+### Block - get_block_by_hash
+- **Endpoint**: `/api/v1/GetBlockByHash`
+- **Method**: `GET`
+- **Parameters**:
+  - `blockHash`: string
+- **Ruby Example**:
+```ruby
+api.get_block_by_hash({blockHash: 'string'})
+```
+
+### Block - get_raw_block_by_hash
+- **Endpoint**: `/api/v1/GetRawBlockByHash`
+- **Method**: `GET`
+- **Parameters**:
+  - `blockHash`: string
+- **Ruby Example**:
+```ruby
+api.get_raw_block_by_hash({blockHash: 'string'})
+```
+
+### Block - get_block_by_height
+- **Endpoint**: `/api/v1/GetBlockByHeight`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainInput`: string
+  - `height`: string
+- **Ruby Example**:
+```ruby
+api.get_block_by_height({chainInput: 'string', height: 'string'})
+```
+
+### Block - get_raw_block_by_height
+- **Endpoint**: `/api/v1/GetRawBlockByHeight`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainInput`: string
+  - `height`: string
+- **Ruby Example**:
+```ruby
+api.get_raw_block_by_height({chainInput: 'string', height: 'string'})
+```
+
+### Block - get_latest_block
+- **Endpoint**: `/api/v1/GetLatestBlock`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainInput`: string
+- **Ruby Example**:
+```ruby
+api.get_latest_block({chainInput: 'string'})
+```
+
+### Block - get_raw_latest_block
+- **Endpoint**: `/api/v1/GetRawLatestBlock`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainInput`: string
+- **Ruby Example**:
+```ruby
+api.get_raw_latest_block({chainInput: 'string'})
+```
+
+### Chain - get_chains
+- **Endpoint**: `/api/v1/GetChains`
+- **Method**: `GET`
+- **Parameters**:
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_chains({extended: true})
+```
+
+### Chain - get_chain
+- **Endpoint**: `/api/v1/GetChain`
+- **Method**: `GET`
+- **Parameters**:
+  - `name`: string, `default`: main
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_chain({name: 'main', extended: true})
+```
+
+### Connection - abci_query
+- **Endpoint**: `/api/v1/abci_query`
+- **Method**: `GET`
+- **Parameters**:
+  - `path`: string
+  - `data`: string
+  - `height`: integer, `default`: 0
+  - `prove`: boolean, `default`: false
+- **Ruby Example**:
+```ruby
+api.abci_query({path: 'string', data: 'string', height: 0, prove: false})
+```
+
+### Connection - health
+- **Endpoint**: `/api/v1/health`
+- **Method**: `GET`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.health
+```
+
+### Connection - status
+- **Endpoint**: `/api/v1/status`
+- **Method**: `GET`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.status
+```
+
+### Connection - net_info
+- **Endpoint**: `/api/v1/net_info`
+- **Method**: `GET`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.net_info
+```
+
+### Connection - request_block
+- **Endpoint**: `/api/v1/request_block`
+- **Method**: `GET`
+- **Parameters**:
+  - `height`: integer, `default`: 0
+- **Ruby Example**:
+```ruby
+api.request_block({height: 0})
+```
+
+### Connection - get_validators_settings
+- **Endpoint**: `/api/v1/GetValidatorsSettings`
+- **Method**: `GET`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.get_validators_settings
+```
+
+### Contract - get_contracts
+- **Endpoint**: `/api/v1/GetContracts`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_contracts({chainAddressOrName: 'string', extended: true})
+```
+
+### Contract - get_contract
+- **Endpoint**: `/api/v1/GetContract`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `contractName`: string
+- **Ruby Example**:
+```ruby
+api.get_contract({chainAddressOrName: 'string', contractName: 'string'})
+```
+
+### Contract - get_contract_by_address
+- **Endpoint**: `/api/v1/GetContractByAddress`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `contractAddress`: string
+- **Ruby Example**:
+```ruby
+api.get_contract_by_address({chainAddressOrName: 'string', contractAddress: 'string'})
+```
+
+### Leaderboard - get_leaderboard
+- **Endpoint**: `/api/v1/GetLeaderboard`
+- **Method**: `GET`
+- **Parameters**:
+  - `name`: string
+- **Ruby Example**:
+```ruby
+api.get_leaderboard({name: 'string'})
+```
+
+### Nexus - get_nexus
+- **Endpoint**: `/api/v1/GetNexus`
+- **Method**: `GET`
+- **Parameters**:
+  - `extended`: boolean, `default`: false
+- **Ruby Example**:
+```ruby
+api.get_nexus({extended: false})
+```
+
+### Organization - get_organization
+- **Endpoint**: `/api/v1/GetOrganization`
+- **Method**: `GET`
+- **Parameters**:
+  - `id`: string
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_organization({id: 'string', extended: true})
+```
+
+### Organization - get_organization_by_name
+- **Endpoint**: `/api/v1/GetOrganizationByName`
+- **Method**: `GET`
+- **Parameters**:
+  - `name`: string
+  - `extended`: boolean, `default`: true
+- **Ruby Example**:
+```ruby
+api.get_organization_by_name({name: 'string', extended: true})
+```
+
+### Organization - get_organizations
+- **Endpoint**: `/api/v1/GetOrganizations`
+- **Method**: `GET`
+- **Parameters**:
+  - `extended`: boolean, `default`: false
+- **Ruby Example**:
+```ruby
+api.get_organizations({extended: false})
+```
+
+### Platform - get_platforms
+- **Endpoint**: `/api/v1/GetPlatforms`
+- **Method**: `GET`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.get_platforms
+```
+
+### Platform - get_platform
+- **Endpoint**: `/api/v1/GetPlatform`
+- **Method**: `GET`
+- **Parameters**:
+  - `platform`: string
+- **Ruby Example**:
+```ruby
+api.get_platform({platform: 'string'})
+```
+
+### Platform - get_interop
+- **Endpoint**: `/api/v1/GetInterop`
+- **Method**: `GET`
+- **Parameters**:
+  - `platform`: string
+- **Ruby Example**:
+```ruby
+api.get_interop({platform: 'string'})
+```
+
+### Rpc - rpc
+- **Endpoint**: `/rpc`
+- **Method**: `POST`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.rpc
+```
+
+### Sale - get_latest_sale_hash
+- **Endpoint**: `/api/v1/GetLatestSaleHash`
+- **Method**: `GET`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.get_latest_sale_hash
+```
+
+### Sale - get_sale
+- **Endpoint**: `/api/v1/GetSale`
+- **Method**: `GET`
+- **Parameters**:
+  - `hashText`: string
+- **Ruby Example**:
+```ruby
+api.get_sale({hashText: 'string'})
+```
+
+### Storage - read_image
+- **Endpoint**: `/api/v1/ReadImage`
+- **Method**: `GET`
+- **Parameters**:
+  - `hashText`: string
+  - `format`: string, `default`: png
+- **Ruby Example**:
+```ruby
+api.read_image({hashText: 'string', format: 'png'})
+```
+
+### Token - get_tokens
+- **Endpoint**: `/api/v1/GetTokens`
+- **Method**: `GET`
+- **Parameters**:
+  - `extended`: boolean, `default`: false
+- **Ruby Example**:
+```ruby
+api.get_tokens({extended: false})
+```
+
+### Token - get_token
+- **Endpoint**: `/api/v1/GetToken`
+- **Method**: `GET`
+- **Parameters**:
+  - `symbol`: string
+  - `extended`: boolean
+- **Ruby Example**:
+```ruby
+api.get_token({symbol: 'string', extended: 'boolean'})
+```
+
+### Token - get_token_data
+- **Endpoint**: `/api/v1/GetTokenData`
+- **Method**: `GET`
+- **Parameters**:
+  - `symbol`: string
+  - `IDtext`: string
+- **Ruby Example**:
+```ruby
+api.get_token_data({symbol: 'string', IDtext: 'string'})
+```
+
+### Token - get_nft
+- **Endpoint**: `/api/v1/GetNFT`
+- **Method**: `GET`
+- **Parameters**:
+  - `symbol`: string
+  - `IDtext`: string
+  - `extended`: boolean, `default`: false
+- **Ruby Example**:
+```ruby
+api.get_nft({symbol: 'string', IDtext: 'string', extended: false})
+```
+
+### Token - get_nfts
+- **Endpoint**: `/api/v1/GetNFTs`
+- **Method**: `GET`
+- **Parameters**:
+  - `symbol`: string
+  - `IDText`: string
+  - `extended`: boolean, `default`: false
+- **Ruby Example**:
+```ruby
+api.get_nfts({symbol: 'string', IDText: 'string', extended: false})
+```
+
+### Token - get_token_balance
+- **Endpoint**: `/api/v1/GetTokenBalance`
+- **Method**: `GET`
+- **Parameters**:
+  - `account`: string
+  - `tokenSymbol`: string
+  - `chainInput`: string
+- **Ruby Example**:
+```ruby
+api.get_token_balance({account: 'string', tokenSymbol: 'string', chainInput: 'string'})
+```
+
+### Transaction - get_transaction_by_block_hash_and_index
+- **Endpoint**: `/api/v1/GetTransactionByBlockHashAndIndex`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainAddressOrName`: string
+  - `blockHash`: string
+  - `index`: integer
+- **Ruby Example**:
+```ruby
+api.get_transaction_by_block_hash_and_index({chainAddressOrName: 'string', blockHash: 'string', index: 'integer'})
+```
+
+### Transaction - get_address_transactions
+- **Endpoint**: `/api/v1/GetAddressTransactions`
+- **Method**: `GET`
+- **Parameters**:
+  - `account`: string
+  - `page`: integer, `default`: 1
+  - `pageSize`: integer, `default`: 99999
+- **Ruby Example**:
+```ruby
+api.get_address_transactions({account: 'string', page: 1, pageSize: 99999})
+```
+
+### Transaction - get_address_transaction_count
+- **Endpoint**: `/api/v1/GetAddressTransactionCount`
+- **Method**: `GET`
+- **Parameters**:
+  - `account`: string
+  - `chainInput`: string, `default`: main
+- **Ruby Example**:
+```ruby
+api.get_address_transaction_count({account: 'string', chainInput: 'main'})
+```
+
+### Transaction - send_raw_transaction
+- **Endpoint**: `/api/v1/SendRawTransaction`
+- **Method**: `GET`
+- **Parameters**:
+  - `txData`: string
+- **Ruby Example**:
+```ruby
+api.send_raw_transaction({txData: 'string'})
+```
+
+### Transaction - invoke_raw_script
+- **Endpoint**: `/api/v1/InvokeRawScript`
+- **Method**: `GET`
+- **Parameters**:
+  - `chainInput`: string
+  - `scriptData`: string
+- **Ruby Example**:
+```ruby
+api.invoke_raw_script({chainInput: 'string', scriptData: 'string'})
+```
+
+### Transaction - get_transaction
+- **Endpoint**: `/api/v1/GetTransaction`
+- **Method**: `GET`
+- **Parameters**:
+  - `hashText`: string
+- **Ruby Example**:
+```ruby
+api.get_transaction({hashText: 'string'})
+```
+
+### Validator - get_validators
+- **Endpoint**: `/api/v1/GetValidators`
+- **Method**: `GET`
+- **Parameters**:
+  - None
+- **Ruby Example**:
+```ruby
+api.get_validators
+```
+
+### Validator - get_validator_by_type
+- **Endpoint**: `/api/v1/GetValidators/{type}`
+- **Method**: `GET`
+- **Parameters**:
+  - `type`: string
+- **Ruby Example**:
+```ruby
+api.get_validator_by_type({type: 'string'})
+```
+

data/lib/phantasma/API/api.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require_relative '../helpers'
+require 'uri'
+require 'net/http'
+require 'json'
+
+module Phantasma
+  module API
+
+    # API endpoints are autogenerated now Phantasma::Helpers.test_api_endpoints
+    # Special case is GetValidators/{type} => GetValidatorByType
+    ALLOWED_METHODS = %w[GetAccount GetAccounts GetAddressesBySymbol LookUpName GetAuction GetAuctionsCount GetAuctions
+GetBlockByHash GetBlockByHeight GetBlockHeight GetBlockTransactionCountByHash GetLatestBlock GetRawBlockByHash GetRawBlockByHeight
+GetRawLatestBlock GetChains GetChain abci_query GetValidatorsSettings health net_info request_block status GetContractByAddress GetContract GetContracts
+GetLeaderboard GetNexus GetOrganizationByName GetOrganization GetOrganizations GetInterop GetPlatform GetPlatforms rpc
+GetLatestSaleHash GetSale ReadImage GetNFT GetNFTs GetTokenBalance GetTokenData GetToken GetTokens GetAddressTransactionCount
+GetAddressTransactions GetTransactionByBlockHashAndIndex GetTransaction InvokeRawScript SendRawTransaction GetValidators GetValidatorByType].freeze
+
+    def self.allowed_methods_hash
+      hash = {}
+      ALLOWED_METHODS.each { |value| hash["#{Phantasma::Helpers.camel_to_snake(value.strip)}"] = "#{value}" }
+      hash
+    end
+
+    def self.find_missing_endpoints
+      endpoints = (Phantasma::Helpers.test_api_endpoints - ALLOWED_METHODS)
+      # Special case, defined as GetValidatorByType int this gem
+      endpoints.delete('GetValidators/{type}')
+      endpoints
+    end
+
+    def self.find_deprecated_endpoints
+      endpoints = []
+      test_endpoints = Phantasma::Helpers.test_api_endpoints
+      ALLOWED_METHODS.each do |endpoint|
+        next if endpoint == 'GetValidatorByType'
+        unless test_endpoints.include?(endpoint.to_s)
+          endpoints << endpoint
+        end
+      end
+      endpoints
+    end
+
+  end
+end

data/lib/phantasma/API/request.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+require_relative 'api'
+require 'uri'
+require 'net/http'
+require 'json'
+require 'openssl'
+
+module Phantasma
+  module API
+    class Request
+      attr_accessor :url, :api_version, :debug
+
+      def initialize(url:, api_version: 'v1', debug: false)
+        @url = url
+        @api_version = api_version
+        @debug = debug
+        @allowed_methods_hash = Phantasma::API.allowed_methods_hash
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @allowed_methods_hash.include?(method_name.to_s) || super
+      end
+
+      def method_missing(method_name, *args, &block)
+        return super(method_name, *args, &block) unless @allowed_methods_hash.include?(method_name.to_s)
+        self.class.send(:define_method, method_name) do |*method_args|
+          build_request(method_name, method_args)
+        end
+        self.send(method_name, *args, &block)
+      end
+
+      private
+
+      def build_request(method_name, method_args)
+        uri, get_method = construct_uri(method_name, method_args)
+        request = create_request(uri, method_args, get_method)
+        response = execute_request(request, uri)
+        parse_response(response)
+      rescue PhantasmaResponseError => e
+        e
+      end
+
+      def construct_uri(method_name, method_args)
+        base_uri = "#{@url}/api/#{@api_version}/"
+        case method_name.to_s
+        when 'get_validator_by_type' && !method_args.empty?
+          raise PhantasmaResponseError, 'GetValidator type not specified' if method_args.first[:type].nil?
+          [URI("#{base_uri}GetValidators/#{method_args.first[:type]}"), true]
+        when 'rpc'
+          [URI("#{@url}/#{method_name.to_s}"), false]
+        else
+          [URI("#{base_uri}#{@allowed_methods_hash[method_name.to_s]}"), true]
+        end
+      end
+
+      def create_request(uri, method_args, get_method)
+        if get_method
+          uri.query = URI.encode_www_form(method_args.first) unless method_args.empty?
+          request = Net::HTTP::Get.new(uri)
+        else
+          request = Net::HTTP::Post.new(uri)
+          request.body = JSON.dump(method_args.first)
+        end
+        request['Content-Type'] = 'application/json'
+        request['Accept'] = 'application/json'
+        request
+      end
+
+      def execute_request(request, uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          # http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http.request(request)
+      end
+
+      def parse_response(response)
+        if response.is_a?(Net::HTTPSuccess)
+          JSON.parse(response.body)
+        else
+          raise PhantasmaResponseError, "{message: '#{response.message}', body: '#{response.body}', error: '#{response.class}'}"
+        end
+      end
+    end
+  end
+end

data/lib/phantasma/documentation.rb

@@ -0,0 +1,89 @@
+require_relative 'helpers'
+require 'uri'
+require 'net/http'
+require 'json'
+
+module Phantasma
+  class Documentation
+    # Based on test swagger json generate documentation
+    # https://testnet.phantasma.info/swagger/v1/swagger.json
+    SWAGGER_URL = 'https://testnet.phantasma.info/swagger/v1/swagger.json'
+
+    def self.generate_documentation
+      api_data = http_request
+      # Start generating the documentation
+      File.open(documentation_dir, 'w') do |file|
+        api_data['paths'].each do |path, methods|
+          methods.each do |method, details|
+            endpoint = path.gsub('/api/v1/', '')
+            if endpoint == 'GetValidators/{type}'
+              # special case
+              endpoint = 'GetValidatorByType'
+            end
+            ruby_method_name = Phantasma::Helpers.camel_to_snake(endpoint.split('/').last)
+            parameters = details['parameters'] || []
+
+            file.puts "### #{details['tags'].first} - #{ruby_method_name}"
+            file.puts "- **Endpoint**: `#{path}`"
+            file.puts "- **Method**: `#{method.upcase}`"
+            file.puts '- **Parameters**:'
+            if parameters.empty?
+              file.puts '  - None'
+            else
+              parameters.each do |param|
+                if param.dig('schema', 'default').nil?
+                  file.puts "  - `#{param['name']}`: #{param.dig('schema', 'type')}"
+                else
+                  file.puts "  - `#{param['name']}`: #{param.dig('schema',
+                                                                 'type')}, `default`: #{param.dig('schema', 'default')}"
+                end
+              end
+            end
+            file.puts '- **Ruby Example**:'
+            file.puts '```ruby'
+            if parameters.empty?
+              file.puts "api.#{ruby_method_name}"
+            else
+              file.puts "api.#{ruby_method_name}(#{generate_ruby_hash(parameters) unless parameters.empty?})"
+            end
+            file.puts '```'
+            file.puts ''
+          end
+        end
+      end
+
+      puts "Documentation generated in #{documentation_dir}"
+    end
+
+    def self.http_request
+      url = URI(SWAGGER_URL)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Get.new(url)
+      response = https.request(request)
+      json_data = response.read_body
+      JSON.parse(json_data)
+    end
+
+    def self.documentation_dir
+      "#{Dir.pwd.gsub('lib/phantasma', 'docs')}/api_documentation.md"
+    end
+
+    def self.generate_ruby_hash(parameters)
+      params = parameters.map do |param|
+        if param.dig('schema', 'default').nil?
+          "#{param['name']}: '#{param.dig('schema', 'type')}'"
+        else
+          if %w(boolean integer).include?(param.dig('schema', 'type'))
+            "#{param['name']}: #{param.dig('schema', 'default')}"
+          else
+            "#{param['name']}: '#{param.dig('schema', 'default')}'"
+          end
+        end
+      end
+      "{#{params.join(', ')}}"
+    end
+  end
+end
+
+Phantasma::Documentation.generate_documentation

data/lib/phantasma/helpers.rb

@@ -0,0 +1,24 @@
+module Phantasma
+  class Helpers
+    def self.camel_to_snake(str)
+      if str.to_s.match(/NFT/)
+        return str.to_s.gsub(/^([A-Z]{1}[a-z]+)([A-Z]+[a-z]?)$/, '\1_\2')
+            .tr('-', '_')
+            .downcase
+      end
+      str.to_s.gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+    end
+
+    # this is for linux system to check if any new endpoints vs ALLOWED_ENDPOINTS
+    def self.test_api_endpoints
+      cmd = `curl -v --silent https://testnet.phantasma.info/swagger/v1/swagger.json 2>&1 |  grep -oP '(?<=\/api\/v1/)(.+)(?=\".+$)'`
+      endpoints = cmd&.gsub(/\n/, ' ').strip.split(' ')
+      endpoints&.push('rpc')
+    end
+
+  end
+end

data/lib/phantasma/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Phantasma
+  VERSION = "0.1.0"
+end

data/lib/phantasma.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'phantasma/API/request'
+require_relative 'phantasma/helpers'
+require_relative "phantasma/version"
+
+module Phantasma
+  class Error < StandardError; end
+  class PhantasmaResponseError < StandardError; end
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: phantasma
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phantasma Community
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-24 00:00:00.000000000 Z
+dependencies: []
+description: Ruby Phantasma API library
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/api_documentation.md
+- lib/phantasma.rb
+- lib/phantasma/API/api.rb
+- lib/phantasma/API/request.rb
+- lib/phantasma/documentation.rb
+- lib/phantasma/helpers.rb
+- lib/phantasma/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/MysteriousNothing/phantasma
+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: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Community ediction of Phantasma API gem
+test_files: []