sbds-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23dc7fa810edb6ba037e54bf4a7ecddf838e23c5
+  data.tar.gz: 41f8d63b235b3e99c75d6de68d05fd591556666b
+SHA512:
+  metadata.gz: 6af87d0dc81087f817c60085051a2cb3ed6e2d77ecfc694d49027110e8f5dcb5a5b83230e867d52a7df84a757a56b506bdf942cf99d8fa26a728a449cb25af56
+  data.tar.gz: bba59ae091bc69edcec35154eb2202ae8bf3d56906a6f3b40ddd20d88e8e70c9204ac6a541494a77bbebb72e88b812c3099ac7f3c9243f35eda878cd8f55e523

data/README.md

@@ -0,0 +1,63 @@
+# Steem Blockchain Data Service Rails Engine
+
+Ruby on Rails Engine for accessing Steem Blockchain Data Service.
+
+The [sbds](https://github.com/steemit/sbds) project is the official database layer for accessing a local, read-only version of the Steem blockchain.  It is developed and maintained by Steemit, Inc. and can be confugured to use SQLite, Postgres, and MySQL.
+
+This `gem` allows you to access an `sdbs` instance with `ActiveRecord`.
+
+## Installation
+
+### For Existing Rails Projects
+
+Assuming you already have an existing rails project,
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sbds-rails'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Edit `database.yml` and use your own `sbds` database or try out @furion's:
+
+```yaml
+default: &default
+  adapter: mysql2
+  encoding: utf8
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  username: steemit
+  password: steemit
+  host: sbds-mysql.steemdata.com
+  database: sbds
+```
+
+### For New Projects
+
+Have a look at this article on setting up a new rails project, then use the
+steps above to enable this plug-in.
+
+[How to Write a Ruby on Rails App for STEEM](https://steemit.com/radiator/@inertia/how-to-write-a-ruby-on-rails-app-for-steem)
+
+## Tests
+
+* Basic tests can be invoked as follows:
+  * `rake`
+* To run tests with parallelization and local code coverage:
+  * `HELL_ENABLED=true rake`
+  
+![](http://i.imgur.com/0STlATl.png)
+
+## Get in touch!
+
+If you're using sbds-rails, I'd love to hear from you.  Drop me a line and tell
+me what you think!  I'm @inertia on STEEM.
+  
+## License
+
+I don't believe in intellectual "property".  If you do, consider sbds-rails as
+licensed under a Creative Commons [![CC0](http://i.creativecommons.org/p/zero/1.0/80x15.png)](http://creativecommons.org/publicdomain/zero/1.0/) License.

data/Rakefile

@@ -0,0 +1,47 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sbds'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+task :build do
+  exec 'gem build sbds-rails.gemspec'
+end
+
+task :push do
+  exec "gem push sbds-rails-#{Sbd::VERSION}.gem"
+end
+
+# We're not going to yank on a regular basis, but this is how it's done if you
+# really want a task for that for some reason.
+
+# task :yank do
+#   exec "gem yank sbds-rails -v #{Sbds::VERSION}"
+# end

data/app/models/sbds/account_create.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class AccountCreate < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/account_create_with_delegation.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class AccountCreateWithDelegation < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/account_update.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class AccountUpdate < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/account_witness_proxy.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class AccountWitnessProxy < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/account_witness_vote.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class AccountWitnessVote < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/acts_as_transaction.rb

@@ -0,0 +1,41 @@
+module Sbds
+  module ActsAsTransaction
+    def self.included(base)
+      def base.table_name_prefix; 'sbds_tx_'; end
+      
+      def base.default_scope
+        order(timestamp: :asc)
+      end
+      
+      base.scope :block, lambda { |block_num|
+        where(block_num: block_num)
+      }
+      
+      base.scope :starting, lambda { |with, field = :timestamp, not_inverted = true|
+        r = where(field => with..Time.now.utc)
+        
+        not_inverted ? r : where.not(r)
+      }
+
+      base.scope :ending, lambda { |with, field = :timestamp, not_inverted = true|
+        r = where(field => Time.at(0)..with)
+        
+        not_inverted ? r : where.not(r)
+      }
+
+      base.scope :betwixt, lambda { |starting, ending, field = :timestamp, not_inverted = true|
+        r = where(field => starting..ending)
+        
+        not_inverted ? r : where.not(r)
+      }
+
+      base.scope :today, lambda { |field = :timestamp|
+        starting(1.day.ago.utc, field)
+      }
+
+      base.scope :yesterday, lambda { |field = :timestamp|
+        betwixt(2.days.ago.utc, 1.day.ago.utc, field)
+      }
+    end
+  end
+end

data/app/models/sbds/cancel_transfer_from_savings.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class CancelTransferFromSavings < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/change_recovery_account.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class ChangeRecoveryAccount < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/claim_reward_balance.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class ClaimRewardBalance < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/comment.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class Comment < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/comment_options.rb

@@ -0,0 +1,6 @@
+module Sbds
+  class CommentOptions < ActiveRecord::Base
+    include ActsAsTransaction
+    def self.table_name; 'sbds_tx_comments_options'; end
+  end
+end

data/app/models/sbds/convert.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class Convert < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/core_block.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class CoreBlock < ActiveRecord::Base
+    def self.table_name_prefix; 'sbds_'; end
+  end
+end

data/app/models/sbds/custom.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class Custom < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/custom_json.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class CustomJson < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/decline_voting_rights.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class DeclineVotingRights < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/delegate_vesting_share.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class DelegateVestingShare < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/delete_comment.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class DeleteComment < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/escrow_approve.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class EscrowApprove < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/escrow_dispute.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class EscrowDispute < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/escrow_release.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class EscrowRelease < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/escrow_transfer.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class EscrowTransfer < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/feed_publish.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class FeedPublish < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/limit_order_cancel.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class LimitOrderCancel < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/limit_order_create.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class LimitOrderCreate < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/pow.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class Pow < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/pow2.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class Pow2 < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/recover_account.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class RecoverAccount < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/request_account_recovery.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class RequestAccountRecovery < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/transfer.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class Transfer < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/transfer_from_savings.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class TransferFromSavings < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/transfer_to_savings.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class TransferToSavings < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/transfer_to_vesting.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class TransferToVesting < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/vote.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class Vote < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/withdraw_vesting.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class WithdrawVesting < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/withdraw_vesting_route.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class WithdrawVestingRoute < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/app/models/sbds/witness_update.rb

@@ -0,0 +1,5 @@
+module Sbds
+  class WitnessUpdate < ActiveRecord::Base
+    include ActsAsTransaction
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/sbds/engine.rb

@@ -0,0 +1,4 @@
+module Sbds
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/sbds/version.rb

@@ -0,0 +1,3 @@
+module Sbds
+  VERSION = '0.1.0'
+end

data/lib/sbds.rb

@@ -0,0 +1,4 @@
+require "sbds/engine"
+
+module Sbds
+end

data/lib/tasks/sbds_tasks.rake

@@ -0,0 +1,19 @@
+# desc "Explaining what the task does"
+# task :sbds do
+#   # Task goes here
+# end
+
+Rake.application.instance_variable_get('@tasks').delete('db:test:purge')
+Rake.application.instance_variable_get('@tasks').delete('db:test:load_schema')
+
+namespace 'db' do
+  namespace 'test' do
+    task 'purge' do
+      # noop
+    end
+    
+    task 'load_schema' do
+      # noop
+    end
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: sbds-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anthony Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+description: Ruby on Rails Engine for accessing Steem Blockchain Data Service.
+email:
+- github@martin-studio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/sbds_manifest.js
+- app/models/sbds/account_create.rb
+- app/models/sbds/account_create_with_delegation.rb
+- app/models/sbds/account_update.rb
+- app/models/sbds/account_witness_proxy.rb
+- app/models/sbds/account_witness_vote.rb
+- app/models/sbds/acts_as_transaction.rb
+- app/models/sbds/cancel_transfer_from_savings.rb
+- app/models/sbds/change_recovery_account.rb
+- app/models/sbds/claim_reward_balance.rb
+- app/models/sbds/comment.rb
+- app/models/sbds/comment_options.rb
+- app/models/sbds/convert.rb
+- app/models/sbds/core_block.rb
+- app/models/sbds/custom.rb
+- app/models/sbds/custom_json.rb
+- app/models/sbds/decline_voting_rights.rb
+- app/models/sbds/delegate_vesting_share.rb
+- app/models/sbds/delete_comment.rb
+- app/models/sbds/escrow_approve.rb
+- app/models/sbds/escrow_dispute.rb
+- app/models/sbds/escrow_release.rb
+- app/models/sbds/escrow_transfer.rb
+- app/models/sbds/feed_publish.rb
+- app/models/sbds/limit_order_cancel.rb
+- app/models/sbds/limit_order_create.rb
+- app/models/sbds/pow.rb
+- app/models/sbds/pow2.rb
+- app/models/sbds/recover_account.rb
+- app/models/sbds/request_account_recovery.rb
+- app/models/sbds/transfer.rb
+- app/models/sbds/transfer_from_savings.rb
+- app/models/sbds/transfer_to_savings.rb
+- app/models/sbds/transfer_to_vesting.rb
+- app/models/sbds/vote.rb
+- app/models/sbds/withdraw_vesting.rb
+- app/models/sbds/withdraw_vesting_route.rb
+- app/models/sbds/witness_update.rb
+- config/routes.rb
+- lib/sbds.rb
+- lib/sbds/engine.rb
+- lib/sbds/version.rb
+- lib/tasks/sbds_tasks.rake
+homepage: http://github.com/inertia186/sbds-rails
+licenses:
+- CC0-1.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Steem Blockchain Data Service Rails Engine
+test_files: []