solana_rpc_ruby 1.1.1 → 1.2.0

data/README.md

@@ -1,4 +1,9 @@
 ![specs](https://github.com/Block-Logic/solana-rpc-ruby/actions/workflows/specs.yml/badge.svg)
+![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)
+![Last Commit](https://img.shields.io/github/last-commit/Block-Logic/solana-rpc-ruby)
+![Tag](https://img.shields.io/github/v/tag/Block-Logic/solana-rpc-ruby)
+![Stars](https://img.shields.io/github/stars/Block-Logic/solana-rpc-ruby.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 # solana_rpc_ruby
 A Solana RPC Client for Ruby. This gem provides a wrapper methods for Solana RPC JSON API https://docs.solana.com/developing/clients/jsonrpc-api.
 
@@ -6,7 +11,7 @@ A Solana RPC Client for Ruby. This gem provides a wrapper methods for Solana RPC
 
 ### Requirements
 
-This gem requires Ruby 2.6+ and h Rails 6.0+. It MIGHT work with lower versions, but was not tested againt them.
+This gem requires Ruby 2.6+ and h Rails 6.0+. It MIGHT work with lower versions, but was not tested with them.
 Add the following line to your Gemfile:
 
 ```ruby
@@ -90,7 +95,7 @@ More explanation on Action Cable here: https://www.pluralsight.com/guides/updati
 0. Make sure that you have action_cable and solana_rpc_ruby gems installed properly. Also install redis unless you have it.
 
 1. Mount action_cable in `routes.rb`.
-```
+```ruby
 Rails.application.routes.draw do
   mount ActionCable.server => '/cable'
   ...
@@ -98,25 +103,25 @@ end
 ```
 
 2. Update `config/environments/development.rb`.
-```
+```ruby
 config.action_cable.url = "ws://localhost:3000/cable"
 config.action_cable.allowed_request_origins = [/http:\/\/*/, /https:\/\/*/]
 ```
 
 3. Update adapter in `cable.yml`.
-```
+```ruby
 development:
   adapter: redis
   url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
 ```
 
 4. Create a channel.
-```
+```ruby
 rails g channel wall
 ```
 
 5. Your `wall_channel.rb` should look like this:
-```
+```ruby
 class WallChannel < ApplicationCable::Channel
   def subscribed
     stream_from "wall_channel"
@@ -129,7 +134,7 @@ end
 ```
 
 6. Your `wall_channel.js` should look like this (json keys are configured for `root_subscription` method response):
-```
+```js
 import consumer from "./consumer"
 
 consumer.subscriptions.create("WallChannel", {
@@ -154,14 +159,14 @@ consumer.subscriptions.create("WallChannel", {
 ```
 
 7. Create placeholder somewhere in your view for messages.
-```
+```html
 <div id='wall' style='overflow-y: scroll; height:400px;''>
   <h1>Solana subscription messages</h1>
 </div>
 ```
 
 8. Create a script with a block to run websockets (`script/websockets_solana.rb`).
-```
+```ruby
 require_relative '../config/environment'
 
 ws_method_wrapper = SolanaRpcRuby::WebsocketsMethodsWrapper.new

data/lib/solana_rpc_ruby/api_client.rb

@@ -4,6 +4,9 @@ module SolanaRpcRuby
   # ApiClient class serves as a client for solana JSON RPC API.
   # @see https://docs.solana.com/developing/clients/jsonrpc-api
   class ApiClient
+    OPEN_TIMEOUT = 120
+    READ_TIMEOUT = 120
+
     # Determines which cluster will be used to send requests.
     # @return [String]
     attr_accessor :cluster
@@ -30,27 +33,34 @@ module SolanaRpcRuby
     #
     # @return [Object] Net::HTTPOK
     def call_api(body:, http_method:, params: {})
-      uri = URI(@cluster)
-      rpc_response = Net::HTTP.public_send(
-        http_method,
-        uri,
-        body,
-        default_headers,
-      )
+      uri = URI.parse(@cluster)
+
+      request = Net::HTTP::Post.new(uri, default_headers)
+      request.body = body
 
-      rpc_response
+      Net::HTTP.start(
+        uri.host, 
+        uri.port, 
+        use_ssl: true, 
+        open_timeout: OPEN_TIMEOUT,
+        read_timeout: READ_TIMEOUT
+      ) do |http|
+        http.request(request)
+      end
 
     rescue Timeout::Error,
            Net::HTTPError,
            Net::HTTPNotFound,
            Net::HTTPClientException,
            Net::HTTPFatalError,
-           Net::ReadTimeout => e
-      fail ApiError.new(message: e.message)
-    rescue StandardError => e
+           Net::ReadTimeout,
+           Errno::ECONNREFUSED,
+           SocketError => e
 
+      fail ApiError.new(error_class: e.class, message: e.message)
+    rescue StandardError => e
       message = "#{e.class} #{e.message}\n Backtrace: \n #{e.backtrace}"
-      fail ApiError.new(message: message)
+      fail ApiError.new(error_class: e.class, message: e.message)
     end
 
     private

data/lib/solana_rpc_ruby/api_error.rb

@@ -17,11 +17,22 @@ module SolanaRpcRuby
     # @param message [String]
     #
     # @return [SolanaRpcRuby::ApiError]
-    def initialize(code: nil, message:)
+    def initialize(message:, error_class: nil, code: nil)
       @code = code
       @message = message.to_s
+      @error_class = error_class
 
-      super message
+      additional_info
+
+      super @message
+    end
+
+    private
+    def additional_info
+      wrong_url_errors = [Errno::ECONNREFUSED, SocketError]
+      if wrong_url_errors.include?(@error_class)
+        @message += '. Check if the RPC url you provided is correct.'
+      end
     end
   end
 end