blockfrost-ruby 0.1.0

data/lib/blockfrostruby/endpoints/cardano/pools_endpoints.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Example pool_id: pool1g3vqq9cj30cmp4e57y3jpqzuj2hl72twp5qdlh2v89ejk4vnazs
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module PoolsEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/pools.
+  #
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pools(params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/pools", @project_id, params)
+  end
+
+  # Calls get request on (@url)/pools/retired.
+  #
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_list_of_retired_pools(params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/pools/retired", @project_id, params)
+  end
+
+  # Calls get request on (@url)/pools/retiring.
+  #
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_list_of_retiring_pools(params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/pools/retiring", @project_id, params)
+  end
+
+  # Calls get request on (@url)/pools/(pool_id).
+  #
+  # @param pool_id [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pool(pool_id)
+    Request.get_response("#{@url}/pools/#{pool_id}", @project_id)
+  end
+
+  # Calls get request on (@url)/pools/(pool_id)/history.
+  #
+  # @param pool_id [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pool_history(pool_id, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/pools/#{pool_id}/history", @project_id, params)
+  end
+
+  # Calls get request on (@url)/pools/(pool_id)/metadata.
+  #
+  # @param pool_id [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pool_metadata(pool_id)
+    Request.get_response("#{@url}/pools/#{pool_id}/metadata", @project_id)
+  end
+
+  # Calls get request on (@url)/pools/(pool_id)/relays.
+  #
+  # @param pool_id [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pool_relays(pool_id)
+    Request.get_response("#{@url}/pools/#{pool_id}/relays", @project_id)
+  end
+
+  # Calls get request on (@url)/pools/(pool_id)/delegators.
+  #
+  # @param pool_id [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pool_delegators(pool_id, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/pools/#{pool_id}/delegators", @project_id, params)
+  end
+
+  # Calls get request on (@url)/pools/(pool_id)/blocks.
+  #
+  # @param pool_id [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pool_blocks(pool_id, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/pools/#{pool_id}/blocks", @project_id, params)
+  end
+
+  # Calls get request on (@url)/pools/(pool_id)/updates.
+  #
+  # @param pool_id [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_pool_updates(pool_id, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/pools/#{pool_id}/updates", @project_id, params)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/transactions_endpoints.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Example hash: f6780212de5df00d10d929d0ca33dc2ff60cc57f38bd2b3cb3b2dea36f0c20b6
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module TransactionsEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/txs/(hash).
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction(hash)
+    Request.get_response("#{@url}/txs/#{hash}", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/utxos.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_utxos(hash)
+    Request.get_response("#{@url}/txs/#{hash}/utxos", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/stakes.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_stakes(hash)
+    Request.get_response("#{@url}/txs/#{hash}/stakes", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/delegations.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_delegations(hash)
+    Request.get_response("#{@url}/txs/#{hash}/delegations", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/withdrawals.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_withdrawals(hash)
+    Request.get_response("#{@url}/txs/#{hash}/withdrawals", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/mirs.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_mirs(hash)
+    Request.get_response("#{@url}/txs/#{hash}/mirs", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/pool_updates.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_pool_updates(hash)
+    Request.get_response("#{@url}/txs/#{hash}/pool_updates", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/pool_retires.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_pool_retires(hash)
+    Request.get_response("#{@url}/txs/#{hash}/pool_retires", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/metadata.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_metadata(hash)
+    Request.get_response("#{@url}/txs/#{hash}/metadata", @project_id)
+  end
+
+  # Calls get request on (@url)/txs/(hash)/metadata/cbor.
+  #
+  # @param hash [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_metadata_in_cbor(hash)
+    Request.get_response("#{@url}/txs/#{hash}/metadata/cbor", @project_id)
+  end
+
+  # Calls post request on (@url)/txs/submit.
+  #
+  # @param transaction_data [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def submit_transaction(transaction_data)
+    Request.post_request_cbor("#{@url}/tx/submit", @project_id, transaction_data)
+  end
+end

data/lib/blockfrostruby/endpoints/custom_endpoints.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../../blockfrostruby/request'
+require_relative '../../blockfrostruby/params'
+
+module CustomEndpoints
+  extend Request
+  extend Params
+
+  # Add url from object and calls get request on specified url.
+  #
+  # @param custom_url [string] url to request. Url from object will be added before this param.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_custom_url(custom_url, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/#{custom_url}", @project_id, params)
+  end
+
+  # Return a string with a link to documentation.
+  #
+  # @return [String] link to documentation.
+  def get_help_info
+    'See the documentation here - https://github.com/blockfrost/blockfrost-ruby'
+  end
+end

data/lib/blockfrostruby/endpoints/ipfs/ipfs_endpoints.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module IPFSEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/ipfs/pin/list
+  #
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_localstorage_pinned_objects_list(params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/ipfs/pin/list", @project_id, params)
+  end
+
+  # Calls get request on (@url)/ipfs/pin/list/(ipfs_path)
+  #
+  # @param ipfs_path [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_localstorage_pinned_object(ipfs_path)
+    Request.get_response("#{@url}/ipfs/pin/list/#{ipfs_path}", @project_id)
+  end
+
+  # Calls get request on (@url)/ipfs/gateway/(ipfs_path)
+  #
+  # @param ipfs_path [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_relay_to_ipfs_gateway(ipfs_path)
+    Request.get_response("#{@url}/ipfs/gateway/#{ipfs_path}", @project_id)
+  end
+
+  # Calls post request on (@url)/ipfs/add
+  #
+  # @param filepath [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def add_a_file(filepath)
+    Request.post_file("#{@url}/ipfs/add", @project_id, filepath)
+  end
+
+  # Calls post request on (@url)/ipfs/pin/add/(ipfs_path)
+  #
+  # @param ipfs_path [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def pin_an_object(ipfs_path)
+    Request.post_request_raw("#{@url}/ipfs/pin/add/#{ipfs_path}", @project_id)
+  end
+
+  # Calls post request on (@url)/ipfs//pin/remove/(ipfs_path)
+  #
+  # @param ipfs_path [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def remove_pinned_object(ipfs_path)
+    Request.post_request_raw("#{@url}/ipfs/pin/remove/#{ipfs_path}", @project_id)
+  end
+end

data/lib/blockfrostruby/params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'configuration'
+require_relative 'validator'
+
+module Params
+  include Configuration
+  include Validator
+
+  class << self
+    # Calling from endpoints to define params which should be passed to Request class.
+    # It exctracts only permitted params, validates them, compares with params defined in config.
+    # If param = default API param (ex. count = 100 ) and it shouldn't be added to the url, the method cut this param.
+    # Also if there is no parallel_requests passing, it adds the parallel_requests value from object config.
+    #
+    # @param params [Hash] includes passed hash to constructor.
+    # @return [Hash] hash with valid params.
+    def define_params(params, config)
+      result = extract_params(params)
+      Validator.validate_params(result)
+      result[:order] = define_order(result[:order], config)
+      result[:count] = define_count(result[:count], config)
+      result[:parallel_requests] = define_parallel_requests(result[:parallel_requests], config)
+      result[:sleep_between_retries_ms] = define_sleep_between_retries(result[:sleep_between_retries_ms], config)
+      result.compact
+    end
+
+    private
+
+    def extract_params(params)
+      params.transform_keys(&:to_sym).slice(:order, :page, :count, :from, :to, :from_page, :to_page,
+                                            :parallel_requests, :sleep_between_retries_ms)
+    end
+
+    def define_order(order_param, object_config)
+      default_config = Configuration.default_config
+      order_in_default_config = default_config[:use_asc_order_as_default] == true ? 'asc' : 'desc'
+      order_in_object_config = object_config[:use_asc_order_as_default] == true ? 'asc' : 'desc'
+      define_value(order_in_default_config, order_in_object_config, order_param)
+    end
+
+    def define_count(count_param, object_config)
+      default_config = Configuration.default_config
+      count_in_default_config = default_config[:default_count_per_page]
+      count_in_object_config = object_config[:default_count_per_page]
+      define_value(count_in_default_config, count_in_object_config, count_param)
+    end
+
+    def define_value(default_config_value, object_config_value, params_value)
+      result = params_value || object_config_value
+      # Need to do this to avoid adding ?param=value to request if it is default as in the API
+      result = nil if result == default_config_value
+      result
+    end
+
+    def define_parallel_requests(params_value, object_config)
+      object_config_value = object_config[:parallel_requests]
+      params_value.nil? ? object_config_value : params_value
+    end
+
+    def define_sleep_between_retries(params_value, object_config)
+      object_config_value = object_config[:sleep_between_retries_ms]
+      params_value.nil? ? object_config_value : params_value
+    end
+  end
+end

data/lib/blockfrostruby/request.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+require_relative './version'
+require_relative './constants'
+
+module Request
+  include Blockfrostruby
+
+  class << self
+    # Get response from passed URL, add params to request, add specific headers and format the response.
+    # If [:from_page] specified, calls the concurrent fetching process, else get response from single page.
+    #
+    # @param url [String] the url to request.
+    # @param project_id [String] the project_id to pass to url in headers.
+    # @param params [Hash] params to add to request, allowed :order, :page, :count, :from, :to.
+    # @return [Hash] formatted result with status and body keys.
+    def get_response(url, project_id, params = {})
+      params[:from_page] ? get_pages_multi(url, project_id, params) : get_response_from_url(url, project_id, params)
+    end
+
+    # Post raw request to url, with no body or params.
+    #
+    # @param url [String] the url to request.
+    # @param project_id [String] the project_id to pass to url in headers.
+    # @return [Hash] formatted result with status and body keys.
+    def post_request_raw(url, project_id)
+      uri = URI(url)
+      request = create_post_request(uri, project_id)
+      request['Content-Type'] = 'text/plain'
+      response = send_request(uri, request)
+      format_response(response)
+    end
+
+    # Post request to url, in application/cbor format with body.
+    #
+    # @param url [String] the url to request.
+    # @param project_id [String] the project_id to pass to url in headers.
+    # @param body [String] for pass to url.
+    # @return [Hash] formatted result with status and body keys.
+    def post_request_cbor(url, project_id, body)
+      uri = URI(url)
+      request = create_post_request(uri, project_id)
+      request['Content-Type'] = 'application/cbor'
+      request.body = body
+      response = send_request(uri, request)
+      format_response(response)
+    end
+
+    # Post file to url, in multipart/form-data.
+    #
+    # @param url [String] the url to request.
+    # @param project_id [String] the project_id to pass to url in headers.
+    # @param filepath [String] path to file for uploading.
+    # @return [Hash] formatted result with status and body keys.
+    def post_file(url, project_id, filepath)
+      uri = URI(url)
+      file = [['upload', File.open(filepath)]]
+      request = create_post_request(uri, project_id)
+      request.set_form file, 'multipart/form-data'
+      response = send_request(uri, request)
+      format_response(response)
+    end
+
+    private
+
+    def format_response(response)
+      content_type = response.header.content_type
+      able_to_parse = ['application/json', 'application/octet-stream'].include?(content_type)
+      body = able_to_parse ? JSON.parse(response.body) : response.body
+      body = format_keys_to_symbols(body)
+      { status: response.code.to_i, body: body }
+    end
+
+    def format_keys_to_symbols(body)
+      return body unless body.is_a?(Array) || body.is_a?(Hash)
+
+      if body.is_a?(Array)
+        result = body.map do |element|
+          element = element.transform_keys(&:to_sym) if element.is_a?(Hash)
+          element
+        end
+      end
+      result = body.transform_keys(&:to_sym) if body.is_a?(Hash)
+      result
+    end
+
+    def add_params_to_url(url, params)
+      sliced_params = params.slice(:order, :page, :count, :from, :to).compact
+      return url if sliced_params.empty?
+
+      request_params = sliced_params.map { |k, v| "#{k}=#{v}" }.join('&')
+      "#{url}?#{request_params}"
+    end
+
+    def sdk_identificator
+      "Blockfrost-Ruby, version: #{Blockfrostruby::VERSION}"
+    end
+
+    def create_get_request(uri, project_id)
+      req = Net::HTTP::Get.new(uri)
+      req['project_id'] = project_id
+      req['User-Agent'] = sdk_identificator
+      req
+    end
+
+    def create_post_request(uri, project_id)
+      req = Net::HTTP::Post.new(uri)
+      req['project_id'] = project_id
+      req['User-Agent'] = sdk_identificator
+      req
+    end
+
+    def send_request(uri, req)
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(req) }
+    end
+
+    def get_response_from_url(url, project_id, params = {})
+      uri = URI(add_params_to_url(url, params))
+      request = create_get_request(uri, project_id)
+      response = send_request(uri, request)
+      format_response(response)
+    end
+
+    def get_pages(url, project_id, params = {})
+      responses = []
+      page_number = params[:from_page]
+
+      loop do
+        break if params[:to_page] && (page_number > params[:to_page])
+
+        response = get_response_from_page(url, project_id, page_number, params)
+
+        break if response.nil?
+
+        responses << response
+        page_number += 1
+      end
+      format_pages_results(responses)
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def get_pages_multi(url, project_id, params = {})
+      parallel_requests = params[:parallel_requests]
+      sleep_retries = params[:sleep_between_retries_ms]
+      responses = []
+      numbers = []
+      page_number = params[:from_page]
+      threads = []
+      stops = false
+      loop do
+        parallel_requests.times do |i|
+          threads << Thread.new(page_number) do
+            local_page_number = page_number + i
+
+            stops = true if params[:to_page] && (local_page_number > params[:to_page])
+            next if params[:to_page] && (local_page_number > params[:to_page])
+
+            response = get_response_from_page(url, project_id, local_page_number, params)
+
+            stops = true if response.nil?
+            next if response.nil?
+
+            raise ScriptError, "You've been reached your daily limit" if response[:status].to_i == 402
+
+            if response[:status].to_i == 418
+              raise ScriptError,
+                    "You've been temporary banned for too many requests"
+            end
+
+            if response[:status].to_i == 429
+              (1..MAX_RETRIES_IN_PARALLEL_REQUESTS).each do
+                sleep sleep_retries / 1000.0
+                response = get_response_from_page(url, project_id, local_page_number, params)
+                break if response[:status].to_i == 200
+              end
+            end
+            raise ScriptError, 'Please, try again later' if response[:status].to_i == 429
+
+            responses << { page_number: local_page_number, response: response }
+            numbers << local_page_number
+            page_number += 1
+          end
+        end
+
+        threads.each(&:join)
+        break if params[:to_page] && (page_number > params[:to_page])
+        break if stops == true
+
+        numbers.sort!
+        raise 'The response includes duplicated results, reduce the number of parallel_requests and try again' if numbers != numbers.uniq
+      end
+      responses.sort! { |el1, el2| el1[:page_number] <=> el2[:page_number] }.map! { |el| el[:response] }
+      format_pages_results(responses)
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
+    def get_response_from_page(url, project_id, page_number, params = {})
+      params_to_pass = params.slice(:order, :count).merge(page: page_number)
+      response = get_response_from_url(url, project_id, params_to_pass)
+      return if response[:body].empty?
+
+      response
+    end
+
+    def format_pages_results(responses)
+      result = { status: nil, body: [] }
+      result[:body] = responses.map { |r| r[:body] }.flatten
+      result[:status] = responses.flatten.map { |r| r[:status] }[-1]
+      result[:status] = result[:status].to_i if result[:status]
+      result
+    end
+  end
+end