steem-ruby 0.9.3 → 0.9.4

data/lib/steem/mixins/jsonable.rb

@@ -0,0 +1,37 @@
+module Steem
+  module JSONable
+    module ClassMethods
+      attr_accessor :attributes
+
+      def attr_accessor *attrs
+        self.attributes = Array attrs
+        
+        super
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def as_json options = {}
+      serialized = Hash.new
+      
+      self.class.attributes.each do |attribute|
+        unless (value = self.public_send attribute).nil?
+          serialized[attribute] = if value.respond_to? :strftime
+            value.strftime('%Y-%m-%dT%H:%M:%S')
+          else
+            value
+          end
+        end
+      end
+      
+      serialized
+    end
+
+    def to_json *a
+      as_json.to_json *a
+    end
+  end
+end

data/lib/steem/mixins/serializable.rb

@@ -0,0 +1,45 @@
+module Steem
+  module Serializable
+    NUMERIC_TYPES = %i(unsigned_char uint16 uint32 uint64 signed_char int16 int32
+      int64 varint)
+    
+    KNOWN_TYPES = NUMERIC_TYPES + %i(boolean string raw_bytes point_in_time
+      public_key amount price authority optional_authority
+      comment_options_extensions beneficiaries chain_properties required_auths
+      witness_properties empty_array lambda)
+    
+    module ClassMethods
+      def def_attr key_pair
+        name = key_pair.keys.first.to_sym
+        type = key_pair.values.first.to_sym
+        
+        self.attributes ||= []
+        self.attributes << name
+        
+        attr_accessor *attributes
+        add_type name, type
+      end
+      
+      def add_type name, type
+        name = name.to_sym
+        type = type.to_sym
+        raise "Unknown type: #{type}" unless KNOWN_TYPES.include? type
+        
+        @serializable_types ||= {}
+        @serializable_types[name] = type
+      end
+      
+      def numeric?(name)
+        NUMERIC_TYPES.include? @serializable_types[name.to_sym]
+      end
+      
+      def serializable_types
+        @serializable_types
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/steem/operation.rb

@@ -0,0 +1,141 @@
+module Steem
+  class Operation
+    include JSONable
+    include Serializable
+    include Utils
+    
+    # IDs derrived from:
+    # https://github.com/steemit/steem/blob/127a441fbac2f06804359968bda83b66e602c891/libraries/protocol/include/steem/protocol/operations.hpp
+    
+    IDS = [
+      :vote_operation,
+      :comment_operation,
+      
+      :transfer_operation,
+      :transfer_to_vesting_operation,
+      :withdraw_vesting_operation,
+      
+      :limit_order_create_operation,
+      :limit_order_cancel_operation,
+      
+      :feed_publish_operation,
+      :convert_operation,
+      
+      :account_create_operation,
+      :account_update_operation,
+      
+      :witness_update_operation,
+      :account_witness_vote_operation,
+      :account_witness_proxy_operation,
+      
+      :pow_operation,
+      
+      :custom_operation,
+      
+      :report_over_production_operation,
+      
+      :delete_comment_operation,
+      :custom_json_operation,
+      :comment_options_operation,
+      :set_withdraw_vesting_route_operation,
+      :limit_order_create2_operation,
+      :claim_account_operation,
+      :create_claimed_account_operation,
+      :request_account_recovery_operation,
+      :recover_account_operation,
+      :change_recovery_account_operation,
+      :escrow_transfer_operation,
+      :escrow_dispute_operation,
+      :escrow_release_operation,
+      :pow2_operation,
+      :escrow_approve_operation,
+      :transfer_to_savings_operation,
+      :transfer_from_savings_operation,
+      :cancel_transfer_from_savings_operation,
+      :custom_binary_operation,
+      :decline_voting_rights_operation,
+      :reset_account_operation,
+      :set_reset_account_operation,
+      :claim_reward_balance_operation,
+      :delegate_vesting_shares_operation,
+      :account_create_with_delegation_operation,
+      :witness_set_properties_operation,
+      
+      # SMT operations
+      :claim_reward_balance2_operation,
+      
+      :smt_setup_operation,
+      :smt_cap_reveal_operation,
+      :smt_refund_operation,
+      :smt_setup_emissions_operation,
+      :smt_set_setup_parameters_operation,
+      :smt_set_runtime_parameters_operation,
+      :smt_create_operation,
+      
+      # virtual operations below this point
+      :fill_convert_request_operation,
+      :author_reward_operation,
+      :curation_reward_operation,
+      :comment_reward_operation,
+      :liquidity_reward_operation,
+      :interest_operation,
+      :fill_vesting_withdraw_operation,
+      :fill_order_operation,
+      :shutdown_witness_operation,
+      :fill_transfer_from_savings_operation,
+      :hardfork_operation,
+      :comment_payout_update_operation,
+      :return_vesting_delegation_operation,
+      :comment_benefactor_reward_operation,
+      :producer_reward_operation,
+      :clear_null_account_balance_operation
+    ]
+    
+    def self.op_id(op)
+      IDS.find_index op
+    end
+
+    def inspect
+      properties = self.class.attributes.map do |prop|
+        unless (v = instance_variable_get("@#{prop}")).nil?
+          v = if v.respond_to? :strftime
+            v.strftime('%Y-%m-%dT%H:%M:%S')
+          else
+            v
+          end
+          
+          "@#{prop}=#{v}"
+        end
+      end.compact.join(', ')
+      
+      "#<#{self.class.name} [#{properties}]>"
+    end
+    
+    def [](key)
+      key = key.to_sym
+      send(key) if self.class.attributes.include?(key)
+    end
+
+    def []=(key, value)
+      key = key.to_sym
+      
+      if self.class.attributes.include?(key)
+        if self.class.numeric? key
+          send("#{key}=", value.to_i)
+        else
+          send("#{key}=", value)
+        end
+      end
+    end
+    
+    def ==(other_op)
+      return false if self.class != other_op.class
+      
+      self.class.attributes.each do |prop|
+        return false if self[prop] != other_op[prop]
+      end
+      
+      true
+    end
+  end
+end

data/lib/steem/operation/account_create.rb

@@ -0,0 +1,10 @@
+class Steem::Operation::AccountCreate < Steem::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/steem/operation/account_create_with_delegation.rb

@@ -0,0 +1,12 @@
+class Steem::Operation::AccountCreateWithDelegation < Steem::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/steem/operation/account_update.rb

@@ -0,0 +1,8 @@
+class Steem::Operation::AccountUpdate < Steem::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/steem/operation/account_witness_proxy.rb

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

data/lib/steem/operation/account_witness_vote.rb

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

data/lib/steem/operation/cancel_transfer_from_savings.rb

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

data/lib/steem/operation/challenge_authority.rb

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

data/lib/steem/operation/change_recovery_account.rb

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

data/lib/steem/operation/claim_account.rb

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

data/lib/steem/operation/claim_reward_balance.rb

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

data/lib/steem/operation/comment.rb

@@ -0,0 +1,9 @@
+class Steem::Operation::Comment < Steem::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/steem/operation/comment_options.rb

@@ -0,0 +1,10 @@
+class Steem::Operation::CommentOptions < Steem::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/steem/operation/convert.rb

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

data/lib/steem/operation/create_claimed_account.rb

@@ -0,0 +1,10 @@
+class Steem::Operation::CreateClaimedAccount < Steem::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/steem/operation/custom.rb

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

data/lib/steem/operation/custom_binary.rb

@@ -0,0 +1,8 @@
+class Steem::Operation::CustomBinary < Steem::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/steem/operation/custom_json.rb

@@ -0,0 +1,6 @@
+class Steem::Operation::CustomJson < Steem::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/steem/operation/decline_voting_rights.rb

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

data/lib/steem/operation/delegate_vesting_shares.rb

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

data/lib/steem/operation/delete_comment.rb

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

data/lib/steem/operation/escrow_approve.rb

@@ -0,0 +1,8 @@
+class Steem::Operation::EscrowApprove < Steem::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/steem/operation/escrow_dispute.rb

@@ -0,0 +1,7 @@
+class Steem::Operation::EscrowDispute < Steem::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/steem/operation/escrow_release.rb

@@ -0,0 +1,10 @@
+class Steem::Operation::EscrowRelease < Steem::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/steem/operation/escrow_transfer.rb

@@ -0,0 +1,12 @@
+class Steem::Operation::EscrowTransfer < Steem::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/steem/operation/feed_publish.rb

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

data/lib/steem/operation/limit_order_cancel.rb

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