peatio 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25f7358d1288e7c007202f1035d577a9dcd33b61b7f23bddf6d5b8c057bb5607
-  data.tar.gz: 24fab553870452be347d1fe1fc1067556e485a5856767e4306e5548758135b24
+  metadata.gz: 19e4587348d9e3ef0967a19ca63089397f8a3acc49b5b565eae0a23cc071bc23
+  data.tar.gz: 2ce821a3fd697ab8afa53161d197e601961b14d3f9314d778757894e8c0f75b0
 SHA512:
-  metadata.gz: ff767337bec9e7b6dfb2993bbe94535138502f9faf761ac70b2e7b30d26bb76df89130aa7cffb1ebab342bad51c512b79034d4f72f42b40a92f7e18240d3eb11
-  data.tar.gz: 4b3602e261f5d09480d2c72e6db5c45617bbf257ebbbf7f3637dd20bb39497569f45f0d189868f437e88c2e0c8bdf6cf44408386714f82d3dacde060cb4a6d5a
+  metadata.gz: d7c9015c4cc3eb3c6cf0b67ab9925ebff6a968c3a6a3f05a5ad947e602c11859460e74eb626d4ac304bd7bf622bbfbb0ae1e1538aabfa555099586bf89dfabcd
+  data.tar.gz: a671c3f89623f0f74d8ba80363ab5c9d856c30ebf295a1a2e823b48f58a12cf2f28184a138bd92d11e214fcb08d2eff3109efe36909f5d4c62658221e04b5103

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    peatio (0.4.5)
+    peatio (0.5.0)
       activemodel (~> 5.2.3)
       amqp
       bunny

data/lib/peatio/block.rb

@@ -1,10 +1,25 @@
-module Peatio
+module Peatio #:nodoc:
+
+  # This class represents blockchain block which contains transactions.
+  #
+  # Using instant of this class in return for Peatio::Blockchain#fetch_block!
+  # @see Peatio::Blockchain#fetch_block! example implementation
+  #     (inside peatio source https://github.com/rubykube/peatio)
+  #
+  # @author
+  #   Maksym Naichuk <naichuk.maks@gmail.com> (https://github.com/mnaichuk)
   class Block
     include Enumerable
 
     delegate :each, to: :@transactions
 
-    attr_reader :number, :transactions
+    # @!attribute [r] number
+    # return [String] block number
+    attr_reader :number
+
+    # @!attribute [r] transactions
+    # return [Array<Peatio::Transaction>]
+    attr_reader :transactions
 
     def initialize(number, transactions)
       @number = number

data/lib/peatio/blockchain/abstract.rb

@@ -5,7 +5,7 @@ module Peatio #:nodoc:
     #
     # Subclass and override abstract methods to implement
     # a peatio plugable blockchain.
-    # Than you need to register your blockchain implementation.
+    # Then you need to register your blockchain implementation.
     #
     # @see Bitcoin::Blockchain Bitcoin as example of Abstract imlementation
     #     (inside peatio source https://github.com/rubykube/peatio).
@@ -100,6 +100,10 @@ module Peatio #:nodoc:
       #   Custom keys could be added by defining them in Currency #options.
       #
       # @return [Hash] merged settings.
+      #
+      # @note Be careful with your blockchain state after configure.
+      #       Clean everything what could be related to other blockchain configuration.
+      #       E.g. client state.
       def configure(settings = {})
         abstract_method
       end

data/lib/peatio/blockchain/registry.rb

@@ -3,7 +3,7 @@ require "peatio/adapter_registry"
 module Peatio
   module Blockchain
 
-    VERSION = "1.0".freeze
+    VERSION = "1.0.0".freeze
 
     class << self
       def registry

data/lib/peatio/transaction.rb

@@ -1,18 +1,74 @@
 require 'active_support/concern'
 require 'active_model'
 
-module Peatio
+module Peatio #:nodoc:
+
+  # This class represents blockchain transaction.
+  #
+  # Using the instant of this class the peatio application will send/recieve
+  # income/outcome transactions from a peatio pluggable blockchain.
+  #
+  # @example
+  #
+  #   Peatio::Transaction.new(
+  #     {
+  #       hash: '0x5d0ef9697a2f3ea561c9fbefb48e380a4cf3d26ad2be253177c472fdd0e8b486',
+  #       txout: 1,
+  #       to_address: '0x9af4f143cd5ecfba0fcdd863c5ef52d5ccb4f3e5',
+  #       amount: 0.01,
+  #       block_number: 7732274,
+  #       currency_id: 'eth',
+  #       status: 'success'
+  #     }
+  #   )
+  #
+  # @author
+  #   Maksym Naichuk <naichuk.maks@gmail.com> (https://github.com/mnaichuk)
   class Transaction
     include ActiveModel::Model
 
-    STATUSES = %i[success pending fail].freeze
+    # List of statuses supported by peatio.
+    #
+    # @note Statuses list:
+    #
+    #   pending - the transaction is unconfirmed in the blockchain.
+    #
+    #   success - the transaction is a successfull,
+    #   the transaction amount has been successfully transferred
+    #
+    #   failed - the transaction is failed in the blockchain.
+
+    STATUSES = %i[success pending failed].freeze
+
+    # @!attribute [rw] hash
+    # return [String] transaction hash
+    attr_accessor :hash
+
+    # @!attribute [rw] txout
+    # return [Integer] transaction number in send-to-many request
+    attr_accessor :txout
+
+    # @!attribute [rw] to_address
+    # return [String] transaction recepient address
+    attr_accessor :to_address
+
+    # @!attribute [rw] amount
+    # return [Decimal] amount of the transaction
+    attr_accessor :amount
+
+    # @!attribute [rw] block_number
+    # return [Integer] transaction block number
+    attr_accessor :block_number
 
-    attr_accessor :hash, :txout,
-                  :to_address,
-                  :amount,
-                  :block_number,
-                  :currency_id
+    # @!attribute [rw] currency_id
+    # return [String] transaction currency id
+    attr_accessor :currency_id
 
+    # @!attribute [w] status
+    #
+    # @see Peatio::Transaction::STATUSES for list of statuses by peatio
+    #
+    # return [String] transaction status
     attr_writer :status
 
     validates :hash, :txout,
@@ -31,9 +87,16 @@ module Peatio
 
     validates :status, inclusion: { in: STATUSES }
 
-    # TODO: rewrite this method
+    # Status for specific transaction.
+    #
+    # @!method status
+    #
+    # @example
+    #
+    #   status.failed? # true if transaction status 'failed'
+    #   status.success? # true if transaction status 'success'
     def status
-      @status.to_sym
+      @status&.inquiry
     end
   end
 end

data/lib/peatio/version.rb

@@ -1,3 +1,3 @@
 module Peatio
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/lib/peatio/wallet/abstract.rb

@@ -72,6 +72,10 @@ module Peatio
       #   Custom keys could be added by defining them in Currency #options.
       #
       # @return [Hash] merged settings.
+      #
+      # @note Be careful with your wallet state after configure.
+      #       Clean everything what could be related to other wallet configuration.
+      #       E.g. client state.
       def configure(settings = {})
         abstract_method
       end

data/lib/peatio/wallet/registry.rb

@@ -3,7 +3,7 @@ require "peatio/adapter_registry"
 module Peatio
   module Wallet
 
-    VERSION = "1.0".freeze
+    VERSION = "1.0.0".freeze
 
     class << self
       def registry

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peatio
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Louis B.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel