hive-ruby 1.0.0.pre.1

data/lib/hive/operation/account_create.rb

@@ -0,0 +1,10 @@
+class Hive::Operation::AccountCreate < Hive::Operation
+  def_attr fee: :amount
+  def_attr creator: :string
+  def_attr new_account_name: :string
+  def_attr owner: :authority
+  def_attr active: :authority
+  def_attr posting: :authority
+  def_attr memo_key: :public_key
+  def_attr json_metadata: :string
+end

data/lib/hive/operation/account_create_with_delegation.rb

@@ -0,0 +1,12 @@
+class Hive::Operation::AccountCreateWithDelegation < Hive::Operation
+  def_attr fee: :amount
+  def_attr delegation: :amount
+  def_attr creator: :string
+  def_attr new_account_name: :string
+  def_attr owner: :authority
+  def_attr active: :authority
+  def_attr posting: :authority
+  def_attr memo_key: :public_key
+  def_attr json_metadata: :string
+  def_attr extensions: :empty_array
+end

data/lib/hive/operation/account_update.rb

@@ -0,0 +1,8 @@
+class Hive::Operation::AccountUpdate < Hive::Operation
+  def_attr account: :string
+  def_attr owner: :optional_authority
+  def_attr active: :optional_authority
+  def_attr posting: :optional_authority
+  def_attr memo_key: :public_key
+  def_attr json_metadata: :string
+end

data/lib/hive/operation/account_witness_proxy.rb

@@ -0,0 +1,4 @@
+class Hive::Operation::AccountWitnessProxy < Hive::Operation
+  def_attr account: :string
+  def_attr proxy: :string
+end

data/lib/hive/operation/account_witness_vote.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::AccountWitnessVote < Hive::Operation
+  def_attr account: :string
+  def_attr witness: :string
+  def_attr approve: :boolean
+end

data/lib/hive/operation/cancel_transfer_from_savings.rb

@@ -0,0 +1,4 @@
+class Hive::Operation::CancelTransferFromSavings < Hive::Operation
+  def_attr from: :string
+  def_attr request_id: :uint32
+end

data/lib/hive/operation/challenge_authority.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::ChallengeAuthority < Hive::Operation
+  def_attr challenger: :string
+  def_attr challenged: :string
+  def_attr require_owner: :boolean
+end

data/lib/hive/operation/change_recovery_account.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::ChangeRecoveryAccount < Hive::Operation
+  def_attr account_to_recover: :string
+  def_attr new_recovery_account: :string
+  def_attr extensions: :empty_array
+end

data/lib/hive/operation/claim_account.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::ClaimAccount < Hive::Operation
+  def_attr creator: :string
+  def_attr fee: :amount
+  def_attr extensions: :empty_array
+end

data/lib/hive/operation/claim_reward_balance.rb

@@ -0,0 +1,6 @@
+class Hive::Operation::ClaimRewardBalance < Hive::Operation
+  def_attr account: :string
+  def_attr reward_steem: :amount
+  def_attr reward_sbd: :amount
+  def_attr reward_vests: :amount
+end

data/lib/hive/operation/comment.rb

@@ -0,0 +1,9 @@
+class Hive::Operation::Comment < Hive::Operation
+  def_attr parent_author: :string
+  def_attr parent_permlink: :string
+  def_attr author: :string
+  def_attr permlink: :string
+  def_attr title: :string
+  def_attr body: :string
+  def_attr json_metadata: :string
+end

data/lib/hive/operation/comment_options.rb

@@ -0,0 +1,10 @@
+class Hive::Operation::CommentOptions < Hive::Operation
+  def_attr author: :string
+  def_attr permlink: :string
+  def_attr max_accepted_payout: :amount
+  def_attr percent_steem_dollars: :uint32
+  # def_attr allow_replies: :boolean
+  def_attr allow_votes: :boolean
+  def_attr allow_curation_rewards: :boolean
+  def_attr extensions: :comment_options_extensions
+end

data/lib/hive/operation/convert.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::Convert < Hive::Operation
+  def_attr owner: :string
+  def_attr requestid: :uint32
+  def_attr amount: :amount
+end

data/lib/hive/operation/create_claimed_account.rb

@@ -0,0 +1,10 @@
+class Hive::Operation::CreateClaimedAccount < Hive::Operation
+  def_attr creator: :string
+  def_attr new_account_name: :string
+  def_attr owner: :authority
+  def_attr active: :authority
+  def_attr posting: :authority
+  def_attr memo_key: :public_key
+  def_attr json_metadata: :string
+  def_attr extensions: :empty_array
+end

data/lib/hive/operation/custom.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::Custom < Hive::Operation
+  def_attr required_auths: :required_auths
+  def_attr id: :uint32
+  def_attr data: :raw_bytes
+end

data/lib/hive/operation/custom_binary.rb

@@ -0,0 +1,8 @@
+class Hive::Operation::CustomBinary < Hive::Operation
+  def_attr required_owner_auths: :required_auths
+  def_attr required_active_auths: :required_auths
+  def_attr required_posting_auths: :required_auths
+  def_attr required_auths: :required_auths
+  def_attr id: :string
+  def_attr data: :raw_bytes
+end

data/lib/hive/operation/custom_json.rb

@@ -0,0 +1,6 @@
+class Hive::Operation::CustomJson < Hive::Operation
+  def_attr required_auths: :required_auths
+  def_attr required_posting_auths: :required_auths
+  def_attr id: :string
+  def_attr json: :string
+end

data/lib/hive/operation/decline_voting_rights.rb

@@ -0,0 +1,4 @@
+class Hive::Operation::DeclineVotingRights < Hive::Operation
+  def_attr account: :string
+  def_attr decline: :boolean
+end

data/lib/hive/operation/delegate_vesting_shares.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::DelegateVestingShares < Hive::Operation
+  def_attr delegator: :string
+  def_attr delegatee: :string
+  def_attr vesting_shares: :amount
+end

data/lib/hive/operation/delete_comment.rb

@@ -0,0 +1,4 @@
+class Hive::Operation::DeleteComment < Hive::Operation
+  def_attr author: :string
+  def_attr permlink: :string
+end

data/lib/hive/operation/escrow_approve.rb

@@ -0,0 +1,8 @@
+class Hive::Operation::EscrowApprove < Hive::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr agent: :string
+  def_attr who: :string
+  def_attr escrow_id: :uint32
+  def_attr approve: :boolean
+end

data/lib/hive/operation/escrow_dispute.rb

@@ -0,0 +1,7 @@
+class Hive::Operation::EscrowDispute < Hive::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr agent: :string
+  def_attr who: :string
+  def_attr escrow_id: :uint32
+end

data/lib/hive/operation/escrow_release.rb

@@ -0,0 +1,10 @@
+class Hive::Operation::EscrowRelease < Hive::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr agent: :string
+  def_attr who: :string
+  def_attr receiver: :string
+  def_attr escrow_id: :uint32
+  def_attr sbd_amount: :amount
+  def_attr steem_amount: :amount
+end

data/lib/hive/operation/escrow_transfer.rb

@@ -0,0 +1,12 @@
+class Hive::Operation::EscrowTransfer < Hive::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr sbd_amount: :amount
+  def_attr steem_amount: :amount
+  def_attr escrow_id: :uint32
+  def_attr agent: :string
+  def_attr fee: :amount
+  def_attr json_metadata: :string
+  def_attr ratification_deadline: :point_in_time
+  def_attr escrow_expiration: :point_in_time
+end

data/lib/hive/operation/feed_publish.rb

@@ -0,0 +1,4 @@
+class Hive::Operation::FeedPublish < Hive::Operation
+  def_attr publisher: :string
+  def_attr exchange_rate: :price
+end

data/lib/hive/operation/limit_order_cancel.rb

@@ -0,0 +1,4 @@
+class Hive::Operation::LimitOrderCancel < Hive::Operation
+  def_attr owner: :string
+  def_attr orderid: :uint32
+end

data/lib/hive/operation/limit_order_create.rb

@@ -0,0 +1,8 @@
+class Hive::Operation::LimitOrderCreate < Hive::Operation
+  def_attr owner: :string
+  def_attr orderid: :uint32
+  def_attr amount_to_sell: :amount
+  def_attr min_to_receive: :amount
+  def_attr fill_or_kill: :boolean
+  def_attr expiration: :point_in_time
+end

data/lib/hive/operation/limit_order_create2.rb

@@ -0,0 +1,8 @@
+class Hive::Operation::LimitOrderCreate2 < Hive::Operation
+  def_attr owner: :string
+  def_attr orderid: :uint32
+  def_attr amount_to_sell: :amount
+  def_attr fill_or_kill: :boolean
+  def_attr exchange_rate: :price
+  def_attr expiration: :point_in_time
+end

data/lib/hive/operation/prove_authority.rb

@@ -0,0 +1,4 @@
+class Hive::Operation::ProveAuthority < Hive::Operation
+  def_attr challenged: :string
+  def_attr require_owner: :boolean
+end

data/lib/hive/operation/recover_account.rb

@@ -0,0 +1,6 @@
+class Hive::Operation::RecoverAccount < Hive::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/hive/operation/report_over_production.rb

@@ -0,0 +1,5 @@
+class Hive::Operation::ReportOverProduction < Hive::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/hive/operation/request_account_recovery.rb

@@ -0,0 +1,6 @@
+class Hive::Operation::RequestAccountRecovery < Hive::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/hive/operation/reset_account.rb

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

data/lib/hive/operation/set_reset_account.rb

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

data/lib/hive/operation/set_withdraw_vesting_route.rb

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

data/lib/hive/operation/transfer.rb

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

data/lib/hive/operation/transfer_from_savings.rb

@@ -0,0 +1,7 @@
+class Hive::Operation::TransferFromSavings < Hive::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/hive/operation/transfer_to_savings.rb

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

data/lib/hive/operation/transfer_to_vesting.rb

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

data/lib/hive/operation/vote.rb

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

data/lib/hive/operation/withdraw_vesting.rb

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

data/lib/hive/operation/witness_set_properties.rb

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

data/lib/hive/operation/witness_update.rb

@@ -0,0 +1,7 @@
+class Hive::Operation::WitnessUpdate < Hive::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/hive/rpc/base_client.rb

@@ -0,0 +1,179 @@
+module Hive
+  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] || :hive
+        @error_pipe = options[:error_pipe] || STDERR
+        @api_name = options[:api_name]
+        @url = case @chain
+        when :hive then options[:url] || NETWORKS_HIVE_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 Hive::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