radiator 0.3.15 → 0.4.0pre1

data/lib/radiator/chain.rb

@@ -26,8 +26,12 @@ module Radiator
   #     steem.post!(options)
   # 
   class Chain
+    include Mixins::ActsAsPoster
+    include Mixins::ActsAsVoter
+    include Mixins::ActsAsWallet
+    
     VALID_OPTIONS = %w(
-      chain account_name wif
+      chain account_name wif url failover_urls
     ).map(&:to_sym)
     VALID_OPTIONS.each { |option| attr_accessor option }
     
@@ -44,290 +48,246 @@ module Radiator
       @account_name ||= ENV['ACCOUNT_NAME']
       @wif ||= ENV['WIF']
       
-      raise ChainError, "Required option: chain" if @chain.nil?
-      raise ChainError, "Required option: account_name, wif" if @account_name.nil? || @wif.nil?
-      
       reset
     end
     
-    # Clears out queued operations.
-    def reset
-      @operations = []
-    end
-    
-    # Broadcast queued operations.
+    # Find a specific block by block number.
     #
-    # @param auto_reset [boolean] clears operations no matter what, even if there's an error.
-    def broadcast!(auto_reset = false)
-      begin
-        transaction = Radiator::Transaction.new(build_options)
-        transaction.operations = @operations
-        response = transaction.process(true)
-      rescue => e
-        reset if auto_reset
-        raise e
-      end
-      
-      if !!response.result
-        reset
-        response
-      else
-        reset if auto_reset
-        ErrorParser.new(response)
-      end
-    end
-    
-    # Create a vote operation.
+    # Example:
     #
-    # Examples:
+    #     steem = Steem.new
+    #     block = steem.find_block(12345678)
+    #     transactions = block.transactions
     #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.vote(10000, 'author', 'permlink')
-    #     steem.broadcast!
+    # @param block_number [Fixnum]
+    # @return [Hash]
+    def find_block(block_number)
+      api.get_blocks(block_number).first
+    end
+    
+    # Find a specific account by name.
     #
-    # ... or ...
+    # Example:
     #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.vote(10000, '@author/permlink')
-    #     steem.broadcast!
+    #     steem = Steem.new
+    #     ned = steem.find_account('ned')
+    #     vesting_shares = ned.vesting_shares
     #
-    # @param weight [Integer] value between -10000 and 10000.
-    # @param args [author, permlink || slug] pass either `author` and `permlink` or string containing both like `@author/permlink`.
-    def vote(weight, *args)
-      author, permlink = if args.size == 1
-        author, permlink = parse_slug(args[0])
-      else
-        author, permlink = args
+    # @param account_name [String] Name of the account to find.
+    # @return [Hash]
+    def find_account(account_name)
+      api.get_accounts([account_name]) do |accounts, err|
+        raise ChainError, ErrorParser.new(err) if !!err
+        
+        accounts[0]
       end
-      
-      @operations << {
-        type: :vote,
-        voter: account_name,
-        author: author,
-        permlink: permlink,
-        weight: weight
-      }
-      
-      self
     end
     
-    # Create a vote operation and broadcasts it right away.
+    # Find a specific comment by author and permlink or slug.
     #
-    # Examples:
+    # Example:
     #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.vote!(10000, 'author', 'permlink')
+    #     steem = Steem.new
+    #     comment = steem.find_comment('inertia', 'kinda-spooky') # by account, permlink
+    #     active_votes = comment.active_votes
     #
     # ... or ...
     #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.vote!(10000, '@author/permlink')
+    #     comment = steem.find_comment('@inertia/kinda-spooky') # by slug
     #
-    # @see vote
-    def vote!(weight, *args); vote(weight, *args).broadcast!(true); end
-    
-    # Creates a post operation.
-    #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     options = {
-    #       title: 'This is my fancy post title.',
-    #       body: 'This is my fancy post body.',
-    #       tags: %w(thess are my fancy tags)
-    #     }
-    #     steem.post(options)
-    #     steem.broadcast!
-    #
-    # @param options [Hash] options
-    # @option options [String] :title Title of the post.
-    # @option options [String] :body Body of the post.
-    # @option options [Array<String>] :tags Tags of the post.
-    # @option options [String] :permlink (automatic) Permlink of the post, defaults to formatted title.
-    # @option options [String] :parent_permlink (automatic) Parent permlink of the post, defaults to first tag.
-    # @option options [String] :parent_author (optional) Parent author of the post (only used if reply).
-    # @option options [String] :max_accepted_payout (1000000.000 SBD) Maximum accepted payout, set to '0.000 SBD' to deline payout
-    # @option options [Integer] :percent_steem_dollars (5000) Percent STEEM Dollars is used to set 50/50 or 100% STEEM Power
-    # @option options [Integer] :allow_votes (true) Allow votes for this post.
-    # @option options [Integer] :allow_curation_rewards (true) Allow curation rewards for this post.
-    def post(options = {})
-      tags = [options[:tags] || []].flatten
-      title = options[:title].to_s
-      permlink = options[:permlink] || title.downcase.gsub(/[^a-z0-9\-]+/, '-')
-      parent_permlink = options[:parent_permlink] || tags[0]
-      
-      raise ChainError, 'At least one tag is required or set the parent_permlink directy.' if parent_permlink.nil?
-      
-      body = options[:body]
-      parent_author = options[:parent_author] || ''
-      max_accepted_payout = options[:max_accepted_payout] || default_max_acepted_payout
-      percent_steem_dollars = options[:percent_steem_dollars]
-      allow_votes = options[:allow_votes] || true
-      allow_curation_rewards = options[:allow_curation_rewards] || true
-      self_vote = options[:self_vote]
-      
-      tags.insert(0, parent_permlink)
-      tags = tags.compact.uniq
-      
-      metadata = {
-        app: Radiator::AGENT_ID
-      }
-      metadata[:tags] = tags if tags.any?
+    # @param args [String || Array<String>] Slug or author, permlink of comment.
+    # @return [Hash]
+    def find_comment(*args)
+      author, permlink = normalize_author_permlink(args)
       
-      @operations << {
-        type: :comment,
-        parent_permlink: parent_permlink,
-        author: account_name,
-        permlink: permlink,
-        title: title,
-        body: body,
-        json_metadata: metadata.to_json,
-        parent_author: parent_author
-      }
+      api.get_content(author, permlink) do |comment, err|
+        raise ChainError, ErrorParser.new(err) if !!err
+        
+        comment unless comment.id == 0
+      end
+    end
+    
+    # Current dynamic global properties, cached for 3 seconds.  This is useful
+    # for reading properties without worrying about actually fetching it over
+    # rpc more than needed.
+    def properties
+      @properties ||= nil
       
-      if (!!max_accepted_payout &&
-          max_accepted_payout != default_max_acepted_payout
-        ) || !!percent_steem_dollars || !allow_votes || !allow_curation_rewards
-        @operations << {
-          type: :comment_options,
-          author: account_name,
-          permlink: permlink,
-          max_accepted_payout: max_accepted_payout,
-          percent_steem_dollars: percent_steem_dollars,
-          allow_votes: allow_votes,
-          allow_curation_rewards: allow_curation_rewards,
-          extensions: []
-        }
+      if !!@properties && Time.now.utc - Time.parse(@properties.time + 'Z') > 3
+        @properties = nil
       end
       
-      vote(self_vote, account_name, permlink) if !!self_vote
+      return @properties if !!@properties
       
-      self
+      api.get_dynamic_global_properties do |properties|
+        @properties = properties
+      end
     end
     
-    # Create a vote operation and broadcasts it right away.
-    #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     options = {
-    #       title: 'This is my fancy post title.',
-    #       body: 'This is my fancy post body.',
-    #       tags: %w(thess are my fancy tags)
-    #     }
-    #     steem.post!(options)
-    #
-    # @see post
-    def post!(options = {}); post(options).broadcast!(true); end
+    def block_time
+      Time.parse(properties.time + 'Z')
+    end
     
-    # Create a delete_comment operation.
-    #
-    # Examples:
+    # Returns the current base (e.g. STEEM) price in the vest asset (e.g.
+    # VESTS).
     #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.delete_comment('permlink')
-    #     steem.broadcast!
-    #
-    # @param permlink
-    def delete_comment(permlink)
-      @operations << {
-        type: :delete_comment,
-        author: account_name,
-        permlink: permlink
-      }
-      
-      self
+    def base_per_mvest
+      total_vesting_fund_steem = properties.total_vesting_fund_steem.to_f
+      total_vesting_shares_mvest = properties.total_vesting_shares.to_f / 1e6
+    
+      total_vesting_fund_steem / total_vesting_shares_mvest
     end
     
-    # Create a delete_comment operation and broadcasts it right away.
-    #
-    # Examples:
+    # Returns the current base (e.g. STEEM) price in the debt asset (e.g SBD).
     #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.delete_comment!('permlink')
-    #
-    # @see delete_comment
-    def delete_comment!(permlink); delete_comment(permlink).broadcast!(true); end
+    def base_per_debt
+      api.get_feed_history do |feed_history|
+        current_median_history = feed_history.current_median_history
+        base = current_median_history.base
+        base = base.split(' ').first.to_f
+        quote = current_median_history.quote
+        quote = quote.split(' ').first.to_f
+        
+        (base / quote) * base_per_mvest
+      end
+    end
     
-    # Create a claim_reward_balance operation.
-    #
-    # Examples:
+    # List of accounts followed by account.
     #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.claim_reward_balance(reward_sbd: '100.000 SBD')
-    #     steem.broadcast!
-    #
-    # @param options [Hash] options
-    # @option options [String] :reward_steem The amount of STEEM to claim, like: `100.000 STEEM`
-    # @option options [String] :reward_sbd The amount of SBD to claim, like: `100.000 SBD`
-    # @option options [String] :reward_vests The amount of VESTS to claim, like: `100.000000 VESTS`
-    def claim_reward_balance(options)
-      reward_steem = options[:reward_steem] || '0.000 STEEM'
-      reward_sbd = options[:reward_sbd] || '0.000 SBD'
-      reward_vests = options[:reward_vests] || '0.000000 VESTS'
+    # @param account_name String Name of the account.
+    # @return [Array<String>]
+    def followed_by(account_name)
+      return [] if account_name.nil?
       
-      @operations << {
-        type: :claim_reward_balance,
-        account: account_name,
-        reward_steem: reward_steem,
-        reward_sbd: reward_sbd,
-        reward_vests: reward_vests
-      }
+      followers = []
+      count = -1
+
+      until count == followers.size
+        count = followers.size
+        follow_api.get_followers(account_name, followers.last, 'blog', 1000) do |follows, err|
+          raise ChainError, ErrorParser.new(err) if !!err
+          
+          followers += follows.map(&:follower)
+          followers = followers.uniq
+        end
+      end
       
-      self
+      followers
     end
     
-    # Create a claim_reward_balance operation and broadcasts it right away.
+    # List of accounts following account.
     #
-    # Examples:
-    #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.claim_reward_balance!(reward_sbd: '100.000 SBD')
-    #
-    # @see claim_reward_balance
-    def claim_reward_balance!(permlink); claim_reward_balance(permlink).broadcast!(true); end
+    # @param account_name String Name of the account.
+    # @return [Array<String>]
+    def following(account_name)
+      return [] if account_name.nil?
+      
+      following = []
+      count = -1
+
+      until count == following.size
+        count = following.size
+        follow_api.get_following(account_name, following.last, 'blog', 100) do |follows, err|
+          raise ChainError, ErrorParser.new(err) if !!err
+          
+          following += follows.map(&:following)
+          following = following.uniq
+        end
+      end
+
+      following
+    end
     
-    # Create a transfer operation.
-    #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your active wif')
-    #     steem.transfer(amount: '1.000 SBD', to: 'account name', memo: 'this is a memo')
-    #     steem.broadcast!
-    #
-    # @param options [Hash] options
-    # @option options [String] :amount The amount to transfer, like: `100.000 STEEM`
-    # @option options [String] :to The account receiving the transfer.
-    # @option options [String] :memo ('') The memo for the transfer.
-    def transfer(options = {})
-      @operations << options.merge(type: :transfer, from: account_name)
+    # Clears out queued properties.
+    def reset_properties
+      @properties = nil
+    end
+    
+    # Clears out queued operations.
+    def reset_operations
+      @operations = []
+    end
+    
+    # Clears out all properties and operations.
+    def reset
+      reset_properties
+      reset_operations
       
-      self
+      @api = @block_api = @follow_api = nil
     end
     
-    # Create a transfer operation and broadcasts it right away.
-    #
-    #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
-    #     steem.transfer!(amount: '1.000 SBD', to: 'account name', memo: 'this is a memo')
+    # Broadcast queued operations.
     #
-    # @see transfer
-    def transfer!(options = {}); transfer(options).broadcast!(true); end
+    # @param auto_reset [boolean] clears operations no matter what, even if there's an error.
+    def broadcast!(auto_reset = false)
+      raise ChainError, "Required option: chain" if @chain.nil?
+      raise ChainError, "Required option: account_name, wif" if @account_name.nil? || @wif.nil?
+      
+      begin
+        transaction = Radiator::Transaction.new(build_options)
+        transaction.operations = @operations
+        response = transaction.process(true)
+      rescue => e
+        reset if auto_reset
+        raise e
+      end
+      
+      if !!response.result
+        reset
+        response
+      else
+        reset if auto_reset
+        ErrorParser.new(response)
+      end
+    end
   private
     def build_options
       {
         chain: chain,
-        wif: wif
+        wif: wif,
+        url: url,
+        failover_urls: failover_urls
       }
     end
     
+    def api
+      @api ||= Api.new(build_options)
+    end
+    
+    def block_api
+      @block_api ||= BlockApi.new(build_options)
+    end
+    
+    def follow_api
+      @follow_api ||= FollowApi.new(build_options)
+    end
+    
     def parse_slug(slug)
       slug = slug.split('@').last
       author = slug.split('/')[0]
       [author, slug.split('/')[1..-1].join('/')]
     end
     
+    def normalize_author_permlink(args)
+      if args.size == 1
+        case args[0]
+        when String then parse_slug(args[0])
+        when Hash then [args[0]['author'], args[0]['permlink']]
+        end
+      else
+        args
+      end
+    end
+    
     def default_max_acepted_payout
       "1000000.000 #{default_debt_asset}"
     end
     
     def default_debt_asset
       case chain
-      when :steem then 'SBD'
-      when :golos then 'GBG'
+      when :steem then ChainConfig::NETWORKS_STEEM_DEBT_ASSET
+      when :golos then ChainConfig::NETWORKS_GOLOS_DEBT_ASSET
+      when :test then ChainConfig::NETWORKS_TEST_DEBT_ASSET
       else; raise ChainError, "Unknown chain: #{chain}"
       end
     end

data/lib/radiator/error_parser.rb

@@ -1,3 +1,5 @@
+require 'awesome_print'
+
 module Radiator
   class ErrorParser
     include Utils
@@ -116,11 +118,7 @@ module Radiator
           @can_reprepare = false
         end
       rescue => e
-        if defined? ap
-          ap error_perser_exception: e, original_response: response
-        else
-          puts({error_perser_exception: e, original_response: response}.inspect)
-        end
+        ap error_perser_exception: e, original_response: response
         
         @expiry = false
         @can_retry = false

data/lib/radiator/logger.rb

@@ -5,7 +5,9 @@ module Radiator
   #
   # @return [Logger]
   def self.logger
-    @logger ||= Logger.new(STDOUT)
+    @@logger ||= Logger.new(STDOUT).tap do |logger|
+      logger.progname = 'radiator'
+    end
   end
 
   # Sets the logger that Radiator uses for reporting errors.
@@ -13,6 +15,6 @@ module Radiator
   # @param logger [Logger] The logger to set as Radiator's logger.
   # @return [void]
   def self.logger=(logger)
-    @logger = logger
+    @@logger = logger
   end
 end

data/lib/radiator/mixins/acts_as_poster.rb

@@ -0,0 +1,124 @@
+module Radiator
+  module Mixins
+    module ActsAsPoster
+      # Creates a post operation.
+      #
+      #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
+      #     options = {
+      #       title: 'This is my fancy post title.',
+      #       body: 'This is my fancy post body.',
+      #       tags: %w(thess are my fancy tags)
+      #     }
+      #     steem.post(options)
+      #     steem.broadcast!
+      #
+      # @param options [Hash] options
+      # @option options [String] :title Title of the post.
+      # @option options [String] :body Body of the post.
+      # @option options [Array<String>] :tags Tags of the post.
+      # @option options [String] :permlink (automatic) Permlink of the post, defaults to formatted title.
+      # @option options [String] :parent_permlink (automatic) Parent permlink of the post, defaults to first tag.
+      # @option options [String] :parent_author (optional) Parent author of the post (only used if reply).
+      # @option options [String] :max_accepted_payout (1000000.000 SBD) Maximum accepted payout, set to '0.000 SBD' to deline payout
+      # @option options [Integer] :percent_steem_dollars (5000) Percent STEEM Dollars is used to set 50/50 or 100% STEEM Power
+      # @option options [Integer] :allow_votes (true) Allow votes for this post.
+      # @option options [Integer] :allow_curation_rewards (true) Allow curation rewards for this post.
+      def post(options = {})
+        tags = [options[:tags] || []].flatten
+        title = options[:title].to_s
+        permlink = options[:permlink] || title.downcase.gsub(/[^a-z0-9\-]+/, '-')
+        parent_permlink = options[:parent_permlink] || tags[0]
+        
+        raise ChainError, 'At least one tag is required or set the parent_permlink directy.' if parent_permlink.nil?
+        
+        body = options[:body]
+        parent_author = options[:parent_author] || ''
+        max_accepted_payout = options[:max_accepted_payout] || default_max_acepted_payout
+        percent_steem_dollars = options[:percent_steem_dollars]
+        allow_votes = options[:allow_votes] || true
+        allow_curation_rewards = options[:allow_curation_rewards] || true
+        self_vote = options[:self_vote]
+        
+        tags.insert(0, parent_permlink)
+        tags = tags.compact.uniq
+        
+        metadata = {
+          app: Radiator::AGENT_ID
+        }
+        metadata[:tags] = tags if tags.any?
+        
+        @operations << {
+          type: :comment,
+          parent_permlink: parent_permlink,
+          author: account_name,
+          permlink: permlink,
+          title: title,
+          body: body,
+          json_metadata: metadata.to_json,
+          parent_author: parent_author
+        }
+        
+        if (!!max_accepted_payout &&
+            max_accepted_payout != default_max_acepted_payout
+          ) || !!percent_steem_dollars || !allow_votes || !allow_curation_rewards
+          @operations << {
+            type: :comment_options,
+            author: account_name,
+            permlink: permlink,
+            max_accepted_payout: max_accepted_payout,
+            percent_steem_dollars: percent_steem_dollars,
+            allow_votes: allow_votes,
+            allow_curation_rewards: allow_curation_rewards,
+            extensions: []
+          }
+        end
+        
+        vote(self_vote, account_name, permlink) if !!self_vote
+        
+        self
+      end
+      
+      # Create a vote operation and broadcasts it right away.
+      #
+      #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
+      #     options = {
+      #       title: 'This is my fancy post title.',
+      #       body: 'This is my fancy post body.',
+      #       tags: %w(thess are my fancy tags)
+      #     }
+      #     steem.post!(options)
+      #
+      # @see post
+      def post!(options = {}); post(options).broadcast!(true); end
+      
+      # Create a delete_comment operation.
+      #
+      # Examples:
+      #
+      #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
+      #     steem.delete_comment('permlink')
+      #     steem.broadcast!
+      #
+      # @param permlink
+      def delete_comment(permlink)
+        @operations << {
+          type: :delete_comment,
+          author: account_name,
+          permlink: permlink
+        }
+        
+        self
+      end
+      
+      # Create a delete_comment operation and broadcasts it right away.
+      #
+      # Examples:
+      #
+      #     steem = Steem.new(account_name: 'your account name', wif: 'your wif')
+      #     steem.delete_comment!('permlink')
+      #
+      # @see delete_comment
+      def delete_comment!(permlink); delete_comment(permlink).broadcast!(true); end
+    end
+  end
+end