steem_api 1.1.0 → 1.1.1rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bb607cdb89e34897fe95f443ef0831880cde0f0
-  data.tar.gz: a8642d4dd208c9f70aa81966e13fca95a7b5da49
+  metadata.gz: 226138e01ea81d5cb0f30c17c61405883d85a3b2
+  data.tar.gz: f6e57a8f7914fe3448c833e2de93baf24e60c10a
 SHA512:
-  metadata.gz: 63fb423252dbad1ac0474e27854bccffe7684a6da263d9d74979d87cfdba45c258639dbbe068131f97d5fc24f5e9d02452c71aae7b009a3daec0be11a197b38e
-  data.tar.gz: 19ae69fa09ae91ea7704788076de0c71ae38e02eca695bd8210235b6054640f51c2e67fa57efc3d0dee32d25cd97ab6194385a609055c9d4ed2709ec9d9602fc
+  metadata.gz: e57af3a0b625088c75bd91004e1603125998ccdd8dc4cfce62635c648a63d48ea9de380367ccfed5089b7402dee1d2ecc716e543e2348a127a410aeb50076d35
+  data.tar.gz: 37c6aa938f78a826ee7f106289b884d002eb2d2335fe3ffb2a23f3403cc15b1bacb889e3563b32bb0b01360be0b6d45447843e9b982e56d7a7c4468613e3499d

data/README.md

@@ -1,13 +1,22 @@
 # SteemApi
 
+[![Gem Version](https://badge.fury.io/rb/steem_api.svg)](https://badge.fury.io/rb/steem_api)
+
 ### How To Use (Rails 4+)
 - Add Gem to Gemfile
-	*	`gem 'steem_api', '~> 1.0'`
+	*	`gem 'steem_api', '~> 1.1'`
 - Bundle Install Gems
 	* `bundle install`
+  
+### How to Subscribe
+
+As of 2018-01-23, [SteemSQL is moving to a monthly subscription model](https://steemit.com/steemsql/@arcange/steemsql-is-moving-to-a-monthly-subscription-model).  To use this gem, you must subscribe to @steemsql and store the credentials as environment variables.
 
 ### How To Use (Standalone)
 - `gem install steem_api`
+- export STEEMSQL_HOST=<your steemsql host>
+- export STEEMSQL_USERNAME=<your steemsql username>
+- export STEEMSQL_PASSWORD=<your steemsql password>
 - `irb`
 - `require 'steem_api'`
 - `SteemApi::Comment.last`
@@ -19,6 +28,41 @@
 - Token
 - Transaction
 
+### Followers
+
+How to query today's followers:
+
+```ruby
+followers = SteemApi::Tx::Custom::Follow
+followers.following(:ned).today.count
+```
+
+### Resteem
+
+How to query today's "resteems":
+
+```ruby
+reblogs = SteemApi::Tx::Custom::Reblog
+reblogs.author(:netuoso).today.count
+```
+
+### Account Witness Proxy
+
+How to query current accounts that are actively using a proxy:
+
+```ruby
+proxied = SteemApi::Tx::AccountWitnessProxy.active('netuoso')
+proxied.pluck(:account)
+```
+
+### Appiations
+
+How to query comments by application:
+
+```ruby
+comments = SteemApi::Comment.app('esteem').where(author: 'good-karma')
+```
+
 ### How To Contribute
 - Fork this repo
 - Branch off Master and make your changes

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require 'steem_api'
+require 'awesome_print'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -8,3 +10,287 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
+
+task :console do
+  exec "irb -r steem_api -I ./lib"
+end
+
+task :build do
+  exec 'gem build steem_api.gemspec'
+end
+
+task :push do
+  exec "gem push steem_api-#{SteemApi::VERSION}.gem"
+end
+
+desc 'Lists sum of transfers grouped by date, from, and to.'
+task :transfers, [:minimum_amount, :symbol, :days_ago] do |t, args|
+  now = Time.now.utc
+  minimum_amount = (args[:minimum_amount] || '1000000').to_f
+  symbol = (args[:symbol] || 'STEEM').upcase
+  after_timestamp = now - ((args[:days_ago] || '30').to_i * 86400)
+  
+  # Only type: transfer; ignore savings, vestings
+  transfers = SteemApi::Tx::Transfer.where(type: 'transfer')
+  transfers = transfers.where('amount > ?', minimum_amount)
+  transfers = transfers.where('amount_symbol = ?', symbol)
+  transfers = transfers.where('timestamp > ?', after_timestamp)
+  transfers = transfers.group('CAST(timestamp AS DATE)', :from, :to)
+  transfers = transfers.order('cast_timestamp_as_date ASC')
+  
+  puts "Daily transfer sum over #{'%.3f' % minimum_amount} #{symbol} since #{after_timestamp} ..."
+  ap transfers.sum(:amount)
+end
+
+desc 'Lists apps grouped by date, app/version.'
+task :apps, [:app, :days_ago] do |t, args|
+  now = Time.now.utc
+  app = args[:app]
+  after_timestamp = now - ((args[:days_ago] || '7').to_i * 86400)
+  
+  comments = SteemApi::Comment.normalized_json
+  comments = comments.app(app) if !!app
+  comments = comments.where('created > ?', after_timestamp)
+  comments = comments.group('CAST(created AS DATE)', "JSON_VALUE(json_metadata, '$.app')")
+  comments = comments.order('cast_created_as_date ASC')
+  
+  matching = " matching \"#{app}\"" if !!app
+  puts "Daily app#{matching} count since #{after_timestamp} ..."
+  ap comments.count(:all)
+end
+
+desc 'Do all crosschecks of given account.'
+task :crosscheck, [:account] do |t, args|
+  account = args[:account]
+    
+  Rake::Task["crosscheck:powerdowns"].invoke(account)
+  Rake::Task["crosscheck:powerups"].invoke(account)
+  Rake::Task["crosscheck:transfers"].invoke(account)
+  Rake::Task["crosscheck:vesting_from"].invoke(account)
+  Rake::Task["crosscheck:vesting_to"].invoke(account)
+end
+  
+namespace :crosscheck do
+  desc 'List of accounts grouped by transfer count crosschecked by memo of given account.'
+  task :transfers, [:account] do |t, args|
+    exchanges = %w(bittrex poloniex openledger blocktrades)
+    account = args[:account]
+    
+    if account.nil? || account == ''
+      puts 'Account name required.'
+      exit
+    elsif exchanges.include? account
+      puts 'That procedure is not recommended.'
+      exit
+    end
+    
+    all = SteemApi::Tx::Transfer.where(type: 'transfer')
+    transfers = all.where(to: exchanges)
+    transfers = if account =~ /%/
+      table = SteemApi::Tx::Transfer.arel_table
+      transfers.where(table[:from].matches(account))
+    else
+      transfers.where(from: account)
+    end
+    crosscheck_transfers = all.where(memo: transfers.select(:memo))
+    
+    if transfers.none?
+      puts "No match."
+    else
+      from = transfers.pluck(:from).uniq.join(', ')
+      puts "Accounts grouped by transfer count using common memos as #{from} on common exchanges ..."
+      ap crosscheck_transfers.group(:from).order('count_all').count(:all)
+    end
+  end
+  
+  desc 'List of accounts grouped by vesting transfers from a given account'
+  task :vesting_from, [:account] do |t, args|
+    account = args[:account]
+    
+    if account.nil? || account == ''
+      puts 'Account name required.'
+      exit
+    end
+    
+    table = SteemApi::Tx::Transfer.arel_table
+    all = SteemApi::Tx::Transfer.where(type: 'transfer_to_vesting')
+    transfers = all.where(table[:from].not_eq(:to))
+    transfers = transfers.where.not(to: '')
+    transfers = if account =~ /%/
+      table = SteemApi::Tx::Transfer.arel_table
+      transfers.where(table[:from].matches(account))
+    else
+      transfers.where(from: account)
+    end
+    
+    if transfers.none?
+      puts "No match."
+    else
+      from = transfers.pluck(:from).uniq.join(', ')
+      puts "Accounts grouped by vesting transfer count from #{from} ..."
+      ap transfers.group(:to).order('count_all').count(:all)
+    end
+  end
+  
+  desc 'List of accounts grouped by vesting transfers to a given account'
+  task :vesting_to, [:account] do |t, args|
+    account = args[:account]
+    
+    if account.nil? || account == ''
+      puts 'Account name required.'
+      exit
+    end
+    
+    table = SteemApi::Tx::Transfer.arel_table
+    all = SteemApi::Tx::Transfer.where(type: 'transfer_to_vesting')
+    transfers = all.where(table[:from].not_eq(table[:to]))
+    transfers = transfers.where.not(to: '')
+    transfers = if account =~ /%/
+      table = SteemApi::Tx::Transfer.arel_table
+      transfers.where(table[:to].matches(account))
+    else
+      transfers.where(to: account)
+    end
+    
+    if transfers.none?
+      puts "No match."
+    else
+      from = transfers.pluck(:to).uniq.join(', ')
+      puts "Accounts grouped by vesting transfer count to #{from} ..."
+      ap transfers.group(:from).order('count_all').count(:all)
+    end
+  end
+  
+  desc 'List of accounts grouped by powerdown sums crosschecked by given account.'
+  task :powerdowns, [:account] do |t, args|
+    account = args[:account]
+    
+    if account.nil? || account == ''
+      puts 'Account name required.'
+      exit
+    end
+    
+    table = SteemApi::Vo::FillVestingWithdraw.arel_table
+    all = SteemApi::Vo::FillVestingWithdraw.where(table[:from_account].not_eq(table[:to_account]))
+    powerdowns = if account =~ /%/
+      all.where(table[:from_account].matches(account))
+    else
+      all.where(from_account: account)
+    end
+    
+    if powerdowns.none?
+      puts "No match."
+    else
+      from = powerdowns.pluck(:from_account).uniq.join(', ')
+      puts "Powerdowns grouped by sum from #{from} ..."
+      ap powerdowns.group(:to_account).
+        order('sum_try_parse_replace_withdrawn_vests_as_float').
+        sum("TRY_PARSE(REPLACE(withdrawn, ' VESTS', '') AS float)")
+    end
+  end
+  
+  desc 'List of accounts grouped by powerup sums crosschecked by given account.'
+  task :powerups, [:account] do |t, args|
+    account = args[:account]
+    
+    if account.nil? || account == ''
+      puts 'Account name required.'
+      exit
+    end
+    
+    table = SteemApi::Vo::FillVestingWithdraw.arel_table
+    all = SteemApi::Vo::FillVestingWithdraw.where(table[:from_account].not_eq(table[:to_account]))
+    powerups = if account =~ /%/
+      all.where(table[:to_account].matches(account))
+    else
+      all.where(to_account: account)
+    end
+    
+    if powerups.none?
+      puts "No match."
+    else
+      to = powerups.pluck(:to_account).uniq.join(', ')
+      puts "Powerups grouped by sum to #{to} ..."
+      ap powerups.group(:from_account).
+        order('sum_try_parse_replace_withdrawn_vests_as_float').
+        sum("TRY_PARSE(REPLACE(withdrawn, ' VESTS', '') AS float)")
+    end
+  end
+end
+
+namespace :rewards do
+  desc 'Lists author rewards grouped by date.'
+  task :author, [:symbol, :days_ago] do |t, args|
+    now = Time.now.utc
+    symbol = (args[:symbol] || 'SBD').upcase
+    after_timestamp = now - ((args[:days_ago] || '7').to_i * 86400)
+    
+    rewards = SteemApi::Vo::AuthorReward
+    rewards = rewards.where('timestamp > ?', after_timestamp)
+    rewards = rewards.group('CAST(timestamp AS DATE)')
+    rewards = rewards.order('cast_timestamp_as_date ASC')
+    
+    puts "Daily author reward #{symbol} sum grouped by date since #{after_timestamp} ..."
+    
+    case symbol
+    when 'SBD' then ap rewards.sum(:sdb_payout)
+    when 'STEEM' then ap rewards.sum(:steem_payout)
+    when 'VESTS' then ap rewards.sum(:vesting_payout)
+    when 'MVESTS'
+      ap rewards.sum('vesting_payout / 1000000')
+    else; puts "Unknown symbol: #{symbol}.  Symbols supported: SBD, STEEM, VESTS, MVESTS"
+    end
+  end
+
+  desc 'Lists curation rewards grouped by date.'
+  task :curation, [:symbol, :days_ago] do |t, args|
+    now = Time.now.utc
+    symbol = (args[:symbol] || 'MVESTS').upcase
+    after_timestamp = now - ((args[:days_ago] || '7').to_i * 86400)
+    
+    rewards = SteemApi::Vo::CurationReward
+    rewards = rewards.where('timestamp > ?', after_timestamp)
+    rewards = rewards.group('CAST(timestamp AS DATE)')
+    rewards = rewards.order('cast_timestamp_as_date ASC')
+    
+    puts "Daily curation reward #{symbol} sum grouped by date since #{after_timestamp} ..."
+    
+    case symbol
+    when 'VESTS'
+      ap rewards.sum("TRY_PARSE(REPLACE(reward, ' VESTS', '') AS float)")
+    when 'MVESTS'
+      ap rewards.sum("TRY_PARSE(REPLACE(reward, ' VESTS', '') AS float) / 1000000")
+    else; puts "Unknown symbol: #{symbol}.  Symbols supported: VESTS, MVESTS"
+    end
+  end
+end
+
+desc 'Lists proxied grouped by month.'
+task :proxied, [:days_ago] do |t, args|
+  now = Time.now.utc
+  after_timestamp = now - ((args[:days_ago] || '7').to_i * 86400)
+  
+  proxied = SteemApi::Tx::AccountWitnessProxy
+  proxied = proxied.where('timestamp > ?', after_timestamp)
+  proxied = proxied.group("FORMAT(timestamp, 'yyyy-MM')", :proxy)
+  proxied = proxied.order('format_timestamp_yyyy_mm ASC')
+  
+  puts "Daily proxied grouped by month since #{after_timestamp} ..."
+  
+  ap proxied.count(:all)
+end
+
+# Doesn't look like this table exists.
+# desc 'List conversion SBD conversion request sums grouped by day.'
+# task :convert, [:days_ago] do |t, args|
+#   now = Time.now.utc
+#   after_timestamp = now - ((args[:days_ago] || '3.5').to_f * 86400)
+# 
+#   converts = SteemApi::Vo::FillConvertRequest
+#   converts = converts.where('timestamp > ?', after_timestamp)
+#   converts = converts.group('CAST(timestamp AS DATE)')
+#   converts = converts.order('cast_timestamp_as_date ASC')
+# 
+#   puts "Daily conversion requests failled sum grouped by date since #{after_timestamp} ..."
+#   ap converts.sum(:amount)
+# end

data/lib/steem_api.rb

@@ -34,6 +34,10 @@ require "steem_api/models/tx/withdraw"
 require "steem_api/models/tx/withdraw_vesting_route"
 require "steem_api/models/tx/witness_update"
 
+require "steem_api/models/tx/custom/follow"
+require "steem_api/models/tx/custom/witness"
+require "steem_api/models/tx/custom/reblog"
+
 require "steem_api/models/vo/author_reward"
 require "steem_api/models/vo/curation_reward"
 require "steem_api/models/vo/fill_convert_request"
@@ -43,15 +47,4 @@ require "steem_api/models/vo/interest"
 require "steem_api/models/vo/shutdown_witness"
 
 module SteemApi
-  module Tx
-    def tx
-      SteemApi::Transaction.find_by(tx_id: self.tx_id)
-    end
-  end
-
-  class Transaction
-    def block
-      SteemApi::Block.find(block_num)
-    end
-  end
 end

data/lib/steem_api/models/account.rb

@@ -3,6 +3,11 @@ module SteemApi
 
     self.table_name = :Accounts
 
+    scope :before, lambda { |before, field = 'created'| where("#{field} < ?", before) }
+    scope :after, lambda { |after, field = 'created'| where("#{field} > ?", after) }
+    scope :today, -> { after(1.day.ago) }
+    scope :yesterday, -> { before(1.day.ago).after(2.days.ago) }
+    
     def witness?
       self.witness_votes != "[]"
     end

data/lib/steem_api/models/comment.rb

@@ -2,7 +2,38 @@ module SteemApi
   class Comment < SteemApi::SqlBase
 
     self.table_name = :Comments
-
+    
+    scope :before, lambda { |before, field = 'created'| where("#{field} < ?", before) }
+    scope :after, lambda { |after, field = 'created'| where("#{field} > ?", after) }
+    scope :today, -> { after(1.day.ago) }
+    scope :yesterday, -> { before(1.day.ago).after(2.days.ago) }
+    
+    scope :normalized_json, -> { where("json_metadata LIKE '{%}'") }
+    
+    scope :app, lambda { |app|
+      normalized_json.where("JSON_VALUE(json_metadata, '$.app') LIKE ?", "#{app}/%")
+    }
+    
+    scope :app_version, lambda { |version|
+      normalized_json.where("JSON_VALUE(json_metadata, '$.app') LIKE ?", "%/#{version}")
+    }
+    
+    scope :decorate_metadata, -> {
+      previous_select = if all.select_values.none?
+        Arel.star
+      else
+        all.select_values
+      end
+      
+      r = normalized_json.select(previous_select)
+      
+      %w(tags image links app format).each do |key|
+        r = r.select("JSON_VALUE(json_metadata, '$.#{key}') AS metadata_#{key}")
+      end
+      
+      r
+    }
+    
     def self.find_by_author(user)
       self.where(author: user)
     end