crea-ruby 0.0.1

data/lib/crea/operation/recover_account.rb

@@ -0,0 +1,6 @@
+class Crea::Operation::RecoverAccount < Crea::Operation
+  def_attr account_to_recover: :string
+  def_attr new_owner_authority: :authority
+  def_attr recent_owner_authority: :authority
+  def_attr extensions: :empty_array
+end

data/lib/crea/operation/report_over_production.rb

@@ -0,0 +1,5 @@
+class Crea::Operation::ReportOverProduction < Crea::Operation
+  def_attr reporter: :string
+  def_attr first_block: :string # FIXME signed_block_header
+  def_attr second_block: :string # FIXME signed_block_header
+end

data/lib/crea/operation/request_account_recovery.rb

@@ -0,0 +1,6 @@
+class Crea::Operation::RequestAccountRecovery < Crea::Operation
+  def_attr recovery_account: :string
+  def_attr account_to_recover: :string
+  def_attr new_owner_authority: :authority
+  def_attr extensions: :empty_array
+end

data/lib/crea/operation/reset_account.rb

@@ -0,0 +1,5 @@
+class Crea::Operation::ResetAccount < Crea::Operation
+  def_attr reset_account: :string
+  def_attr account_to_reset: :string
+  def_attr new_owner_authority: :authority
+end

data/lib/crea/operation/set_reset_account.rb

@@ -0,0 +1,5 @@
+class Crea::Operation::SetResetAccount < Crea::Operation
+  def_attr account: :string
+  def_attr current_reset_account: :string
+  def_attr reset_account: :string
+end

data/lib/crea/operation/set_withdraw_vesting_route.rb

@@ -0,0 +1,6 @@
+class Crea::Operation::SetWithdrawVestingRoute < Crea::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr percent: :uint16
+  def_attr auto_vest: :boolean
+end

data/lib/crea/operation/transfer.rb

@@ -0,0 +1,6 @@
+class Crea::Operation::Transfer < Crea::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr amount: :amount
+  def_attr memo: :string
+end

data/lib/crea/operation/transfer_from_savings.rb

@@ -0,0 +1,7 @@
+class Crea::Operation::TransferFromSavings < Crea::Operation
+  def_attr from: :string
+  def_attr request_id: :uint32
+  def_attr to: :string
+  def_attr amount: :amount
+  def_attr memo: :string
+end

data/lib/crea/operation/transfer_to_savings.rb

@@ -0,0 +1,6 @@
+class Crea::Operation::TransferToSavings < Crea::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr amount: :amount
+  def_attr memo: :string
+end

data/lib/crea/operation/transfer_to_vesting.rb

@@ -0,0 +1,5 @@
+class Crea::Operation::TransferToVesting < Crea::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr amount: :amount
+end

data/lib/crea/operation/vote.rb

@@ -0,0 +1,6 @@
+class Crea::Operation::Vote < Crea::Operation
+  def_attr voter: :string
+  def_attr author: :string
+  def_attr permlink: :string
+  def_attr weight: :int16
+end

data/lib/crea/operation/withdraw_vesting.rb

@@ -0,0 +1,4 @@
+class Crea::Operation::WithdrawVesting < Crea::Operation
+  def_attr account: :string
+  def_attr vesting_shares: :amount
+end

data/lib/crea/operation/witness_set_properties.rb

@@ -0,0 +1,5 @@
+class Crea::Operation::WitnessSetProperties < Crea::Operation
+  def_attr owner: :string
+  def_attr props: :witness_properties
+  def_attr extensions: :empty_array
+end

data/lib/crea/operation/witness_update.rb

@@ -0,0 +1,7 @@
+class Crea::Operation::WitnessUpdate < Crea::Operation
+  def_attr owner: :string
+  def_attr url: :string
+  def_attr block_signing_key: :public_key
+  def_attr props: :chain_properties
+  def_attr fee: :amount
+end

data/lib/crea/rpc/base_client.rb

@@ -0,0 +1,179 @@
+module Crea
+  module RPC
+    class BaseClient
+      include ChainConfig
+      
+      attr_accessor :url, :chain, :error_pipe
+      
+      # @private
+      MAX_TIMEOUT_RETRY_COUNT = 100
+      
+      # @private
+      MAX_TIMEOUT_BACKOFF = 30
+      
+      # @private
+      TIMEOUT_ERRORS = [Net::ReadTimeout, Errno::EBADF, IOError]
+      
+      def initialize(options = {})
+        @chain = options[:chain] || :crea
+        @error_pipe = options[:error_pipe] || STDERR
+        @api_name = options[:api_name]
+        @url = case @chain
+        when :crea then options[:url] || NETWORKS_CREA_DEFAULT_NODE
+        when :test then options[:url] || NETWORKS_TEST_DEFAULT_NODE
+        else; raise UnsupportedChainError, "Unsupported chain: #{@chain}"
+        end
+      end
+      
+      def uri
+        @uri ||= URI.parse(url)
+      end
+      
+      # Adds a request object to the stack.  Usually, this method is called
+      # internally by {BaseClient#rpc_execute}.  If you want to create a batched
+      # request, use this method to add to the batch then execute {BaseClient#rpc_batch_execute}.
+      def put(api_name = @api_name, api_method = nil, options = {})
+        current_rpc_id = rpc_id
+        rpc_method_name = "#{api_name}.#{api_method}"
+        options ||= {}
+        request_object = defined?(options.delete) ? options.delete(:request_object) : []
+        request_object ||= []
+        
+        request_object << {
+          jsonrpc: '2.0',
+          id: current_rpc_id,
+          method: rpc_method_name,
+          params: options
+        }
+        
+        request_object
+      end
+      
+      # @abstract Subclass is expected to implement #rpc_execute.
+      # @!method rpc_execute
+      
+      # @abstract Subclass is expected to implement #rpc_batch_execute.
+      # @!method rpc_batch_execute
+      
+      # To be called by {BaseClient#rpc_execute} and {BaseClient#rpc_batch_execute}
+      # when a response has been consructed.
+      def yield_response(response, &block)
+        if !!block
+          case response
+          when Hashie::Mash then yield response.result, response.error, response.id
+          when Hashie::Array
+            response.each do |r|
+              r = Hashie::Mash.new(r)
+              block.call r.result, r.error, r.id
+            end
+          else; block.call response
+          end
+        end
+        
+        response
+      end
+      
+      # Checks json-rpc request/response for corrilated id.  If they do not
+      # match, {IncorrectResponseIdError} is thrown.  This is usually caused by
+      # the client, involving thread safety.  It can also be caused by the node
+      # responding without an id.
+      # 
+      # To avoid {IncorrectResponseIdError}, make sure you implement your client
+      # correctly.
+      # 
+      # Setting DEBUG=true in the envrionment will cause this method to output
+      # both the request and response json.
+      # 
+      # @param options [Hash] options
+      # @option options [Boolean] :debug Enable or disable debug output.
+      # @option options [Hash] :request to compare id
+      # @option options [Hash] :response to compare id
+      # @option options [String] :api_method
+      # @see {ThreadSafeHttpClient}
+      def evaluate_id(options = {})
+        debug = options[:debug] || ENV['DEBUG'] == 'true'
+        request = options[:request]
+        response = options[:response]
+        api_method = options[:api_method]
+        req_id = request[:id].to_i
+        res_id = !!response['id'] ? response['id'].to_i : nil
+        method = [@api_name, api_method].join('.')
+        
+        if debug
+          req = JSON.pretty_generate(request)
+          res = JSON.parse(response) rescue response
+          res = JSON.pretty_generate(response) rescue response
+          
+          error_pipe.puts '=' * 80
+          error_pipe.puts "Request:"
+          error_pipe.puts req
+          error_pipe.puts '=' * 80
+          error_pipe.puts "Response:"
+          error_pipe.puts res
+          error_pipe.puts '=' * 80
+          error_pipe.puts Thread.current.backtrace.join("\n")
+        end
+        
+        error = response['error'].to_json if !!response['error']
+              
+        if req_id != res_id
+          raise IncorrectResponseIdError, "#{method}: The json-rpc id did not match.  Request was: #{req_id}, got: #{res_id.inspect}", BaseError.send(:build_backtrace, error)
+        end
+      end
+      
+      # Current json-rpc id used for a request.  This version auto-increments
+      # for each call.  Subclasses can use their own strategy.
+      def rpc_id
+        @rpc_id ||= 0
+        @rpc_id += 1
+      end
+    private
+      # @private
+      def reset_timeout
+        @timeout_retry_count = 0
+        @back_off = 0.1
+      end
+      
+      # @private
+      def retry_timeout(context, cause = nil)
+        @timeout_retry_count += 1
+        
+        if @timeout_retry_count > MAX_TIMEOUT_RETRY_COUNT
+          raise TooManyTimeoutsError.new("Too many timeouts for: #{context}", cause)
+        elsif @timeout_retry_count % 10 == 0
+          msg = "#{@timeout_retry_count} retry attempts for: #{context}"
+          msg += "; cause: #{cause}" if !!cause
+          error_pipe.puts msg
+        end
+        
+        backoff_timeout
+        
+        context
+      end
+      
+      # Expontential backoff.
+      #
+      # @private
+      def backoff_timeout
+        @backoff ||= 0.1
+        @backoff *= 2
+        @backoff = 0.1 if @backoff > MAX_TIMEOUT_BACKOFF
+        
+        sleep @backoff
+      end
+      
+      # @private
+      def raise_error_response(rpc_method_name, rpc_args, response)
+        raise UnknownError, "#{rpc_method_name}: #{response}" if response.error.nil?
+        
+        error = response.error
+        
+        if error.message == 'Invalid Request'
+          raise Crea::ArgumentError, "Unexpected arguments: #{rpc_args.inspect}.  Expected: #{rpc_method_name} (#{args_keys_to_s(rpc_method_name)})"
+        end
+        
+        BaseError.build_error(error, rpc_method_name)
+      end
+    end
+  end
+end

data/lib/crea/rpc/http_client.rb

@@ -0,0 +1,143 @@
+module Crea
+  module RPC
+    # {HttpClient} is intended for single-threaded applications.  For
+    # multi-threaded apps, use {ThreadSafeHttpClient}.
+    class HttpClient < BaseClient
+      # Timeouts are lower level errors, related in that retrying them is
+      # trivial, unlike, for example TransactionExpiredError, that *requires*
+      # the client to do something before retrying.
+      # 
+      # These situations are hopefully momentary interruptions or rate limiting
+      # but they might indicate a bigger problem with the node, so they are not
+      # retried forever, only up to MAX_TIMEOUT_RETRY_COUNT and then we give up.
+      # 
+      # *Note:* {JSON::ParserError} is included in this list because under
+      # certain timeout conditions, a web server may respond with a generic
+      # http status code of 200 and HTML page.
+      # 
+      # @private
+      TIMEOUT_ERRORS = [Net::OpenTimeout, JSON::ParserError, Net::ReadTimeout,
+        Errno::EBADF, IOError, Errno::ENETDOWN, Crea::RemoteDatabaseLockError]
+      
+      # @private
+      POST_HEADERS = {
+        'Content-Type' => 'application/json; charset=utf-8',
+        'User-Agent' => Crea::AGENT_ID
+      }
+      
+      JSON_RPC_BATCH_SIZE_MAXIMUM = 50
+      
+      def http
+        @http ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true if uri.to_s =~ /^https/i
+          http.keep_alive_timeout = 150 # seconds
+          
+          # WARNING This method opens a serious security hole. Never use this
+          # method in production code.
+          # http.set_debug_output(STDOUT) if !!ENV['DEBUG']
+        end
+      end
+      
+      def http_post
+        @http_post ||= Net::HTTP::Post.new(uri.request_uri, POST_HEADERS)
+      end
+      
+      def http_request(request)
+        http.request(request)
+      end
+      
+      # This is the main method used by API instances to actually fetch data
+      # from the remote node.  It abstracts the api namespace, method name, and
+      # parameters so that the API instance can be decoupled from the protocol.
+      # 
+      # @param api_name [String] API namespace of the method being called.
+      # @param api_method [String] API method name being called.
+      # @param options [Hash] options
+      # @option options [Object] :request_object Hash or Array to become json in request body.
+      def rpc_execute(api_name = @api_name, api_method = nil, options = {}, &block)
+        reset_timeout
+        
+        catch :tota_cera_pila do; begin
+          request = http_post
+          
+          request_object = if !!api_name && !!api_method
+            put(api_name, api_method, options)
+          elsif !!options && defined?(options.delete)
+            options.delete(:request_object)
+          end
+          
+          if request_object.size > JSON_RPC_BATCH_SIZE_MAXIMUM
+            raise JsonRpcBatchMaximumSizeExceededError, "Maximum json-rpc-batch is #{JSON_RPC_BATCH_SIZE_MAXIMUM} elements."
+          end
+          
+          request.body = if request_object.class == Hash
+            request_object
+          elsif request_object.size == 1
+            request_object.first
+          else
+            request_object
+          end.to_json
+          
+          response = catch :http_request do; begin; http_request(request)
+          rescue *TIMEOUT_ERRORS => e
+            throw retry_timeout(:http_request, e)
+          end; end
+          
+          if response.nil?
+            throw retry_timeout(:tota_cera_pila, 'response was nil')
+          end
+          
+          case response.code
+          when '200'
+            response = catch :parse_json do; begin; JSON[response.body]
+            rescue *TIMEOUT_ERRORS => e
+              throw retry_timeout(:parse_json, e)
+            end; end
+            
+            response = case response
+            when Hash
+              Hashie::Mash.new(response).tap do |r|
+                evaluate_id(request: request_object.first, response: r, api_method: api_method)
+              end
+            when Array
+              Hashie::Array.new(response).tap do |r|
+                request_object.each_with_index do |req, index|
+                  evaluate_id(request: req, response: r[index], api_method: api_method)
+                end
+              end
+            else; response
+            end
+            
+            [response].flatten.each_with_index do |r, i|
+              if defined?(r.error) && !!r.error
+                if !!r.error.message
+                  begin
+                    rpc_method_name = "#{api_name}.#{api_method}"
+                    rpc_args = [request_object].flatten[i]
+                    raise_error_response rpc_method_name, rpc_args, r
+                  rescue *TIMEOUT_ERRORS => e
+                    throw retry_timeout(:tota_cera_pila, e)
+                  end
+                else
+                  raise Crea::ArgumentError, r.error.inspect
+                end
+              end
+            end
+            
+            yield_response response, &block
+          when '504' # Gateway Timeout
+            throw retry_timeout(:tota_cera_pila, response.body)
+          when '502' # Bad Gateway
+            throw retry_timeout(:tota_cera_pila, response.body)
+          else
+            raise UnknownError, "#{api_name}.#{api_method}: #{response.body}"
+          end
+        end; end
+      end
+      
+      def rpc_batch_execute(options = {}, &block)
+        yield_response rpc_execute(nil, nil, options), &block
+      end
+    end
+  end
+end

data/lib/crea/rpc/thread_safe_http_client.rb

@@ -0,0 +1,35 @@
+module Crea
+  module RPC
+    # {ThreadSafeHttpClient} is the default RPC Client used by `crea-ruby.`
+    # It's perfect for simple requests.  But for higher performance, it's better
+    # to override {HttpClient} and implement something other than {Net::HTTP}.
+    # 
+    # It performs http requests in a {Mutex} critical section because {Net::HTTP}
+    # is not thread safe.  This is the very minimum level thread safety
+    # available.
+    class ThreadSafeHttpClient < HttpClient
+      SEMAPHORE = Mutex.new.freeze
+      
+      # Same as #{HttpClient#http_post}, but scoped to each thread so it is
+      # thread safe.
+      def http_post
+        thread = Thread.current
+        http_post = thread.thread_variable_get(:http_post)
+        http_post ||= Net::HTTP::Post.new(uri.request_uri, POST_HEADERS)
+        thread.thread_variable_set(:http_post, http_post)
+      end
+      
+      def http_request(request); SEMAPHORE.synchronize{super}; end
+      
+      # Same as #{BaseClient#rpc_id}, auto-increment, but scoped to each thread
+      # so it is thread safe.
+      def rpc_id
+        thread = Thread.current
+        rpc_id = thread.thread_variable_get(:rpc_id)
+        rpc_id ||= 0
+        rpc_id += 1
+        thread.thread_variable_set(:rpc_id, rpc_id)
+      end
+    end
+  end
+end