stellar_client 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91de0c4d8378e702695f0286e276b4087b7007c4fc879512f10de11ae671491e
-  data.tar.gz: 8b1f83a70ae9d5639ef73915814596ff6c42f7fac5a4a1a98a435e9031939b71
+  metadata.gz: 7c64e163442358a81e7496c34c82538ec6b4fcbe6c6d4a4deb655628c887e6fa
+  data.tar.gz: 3e8f55da4581a8b9cff5c3fe4aa2b38025cdcc3209811851968710661f9d30e9
 SHA512:
-  metadata.gz: 340f252a75dcae22c752326199052c3457366912c4a8b8ced3138df91899b87d8ea09f8e0511023a3ae6aeb01ba22510435658d87e110eecece45ca1eeda1bff
-  data.tar.gz: 98c5f7b564d4299f556736e59b1e900f8eb5601a1650c80578070f11ea7925a287b46c5178d5b7f973e90ff7324f2959ff9bc514222d2039b737fcfbbb148a60
+  metadata.gz: 4badf4deac3a8395355cd7a203806cbf039a4fdaf5bee766be4d48140e594140cc449b50931264107dc67bb403a0c5917409ba3a839a563f6a1828974f68e1c0
+  data.tar.gz: 33b9f1f81b1590bfc01a0f704241f463713d48f6502e3bc8eb397b970a1efffb6eb079d0f2aeb4691aa8eb83ecc400062ed1f61a6155233dd8e8bf38d7567969

data/.rubocop.yml

@@ -0,0 +1,191 @@
+Rails:
+  Enabled: true
+
+AllCops:
+  Excludes:
+    - "db/schema.rb"
+
+# Bloom: Exclude RSpec and db/schema
+Metrics/BlockLength:
+  Exclude:
+    - "Gemfile"
+    - "Rakefile"
+    - "db/migrate/*.rb"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+
+# Bloom: Exclude RSpec and db/schema
+Metrics/ModuleLength:
+  Exclude:
+    - "Gemfile"
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+
+# Bloom prefers empty lines on classes
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+# Bloom prefers the literal -> () call
+Style/Lambda:
+  EnforcedStyle: literal
+
+# Bloom prefers space in the literal -> () call
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+
+# Bloom prefers the () call
+Style/LambdaCall:
+  Enabled: false
+
+# Bloom: hashes/arrays look more readable if indented on the same as the hash literal
+Layout/IndentHash:
+  EnforcedStyle: consistent
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Bloom: Prefer leaving trailing commas, lessens git commits
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# Bloom: Frozen literals don't offer that much improvement for the amount of changes
+# we'll need to benefit
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Bloom: Too explicit
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+# Bloom: Most methods, like factory_bot factory methods, look more readable
+# when supplying attributes via a hash
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 80
+
+Metrics/AbcSize:
+  Max: 20
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 25
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/HandleExceptions:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  # The space here provides no real gain in readability while consuming
+  # horizontal space that could be used for a better parameter name.
+  # Also {| differentiates better from a hash than { | does.
+  SpaceBeforeBlockParameters: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.6.0] - 2018-09-27
+### Added
+- Add `StellarClient::Client.deposit`
+
 ## [0.5.2] - 2018-09-11
 ### Added
 - Add `WithdrawResponse#max_amount`

data/README.md

@@ -53,7 +53,9 @@ See `spec/acceptance` for detailed examples and what is supported.
 cd spec/stellar_app
 bundle
 yarn install
-rails db:create db:migrate
+rails db:create
+rails stellar_base:install:migrations
+rails db:migrate
 rails s
 ```
 - Make your changes

data/lib/stellar_client.rb

@@ -19,10 +19,12 @@ end
 
 require "stellar_client/client"
 require "stellar_client/coercers/indifferent_hash"
+require "stellar_client/requests/deposit_request"
 require "stellar_client/requests/get_toml_request"
 require "stellar_client/requests/send_payment_request"
 require "stellar_client/requests/withdraw_request"
 require "stellar_client/responses/base_response"
+require "stellar_client/responses/deposit_response"
 require "stellar_client/responses/get_toml_response"
 require "stellar_client/responses/send_payment_response"
 require "stellar_client/responses/withdraw_response"

data/lib/stellar_client/client.rb

@@ -12,6 +12,13 @@ module StellarClient
       WithdrawResponse.new(raw_response: raw_response)
     end
 
+    def deposit(opts = {})
+      transfer_host = get_toml.toml["TRANSFER_SERVER"]
+      request = DepositRequest.new(opts.merge(host: transfer_host))
+      raw_response = request.()
+      DepositResponse.new(raw_response: raw_response)
+    end
+
     attribute :bridge_host, String
 
     private

data/lib/stellar_client/requests/deposit_request.rb

@@ -0,0 +1,34 @@
+module StellarClient
+  class DepositRequest
+
+    include APIClientBase::Request.module
+
+    BODY_ATTRS = %i[
+      account
+      asset_code
+      memo
+      memo_type
+      email_address
+      type
+    ]
+    attribute :account, String
+    attribute :asset_code, String
+    attribute :memo, String
+    attribute :memo_type, String
+    attribute :email_address, String
+    attribute :type, String
+
+    private
+
+    def path
+      [Addressable::URI.parse(host).path, "/deposit"].join
+    end
+
+    def params
+      BODY_ATTRS.each_with_object({}) do |attr, hash|
+        hash[attr] = send(attr)
+      end
+    end
+
+  end
+end

data/lib/stellar_client/responses/deposit_response.rb

@@ -0,0 +1,45 @@
+module StellarClient
+  class DepositResponse < BaseResponse
+
+    BODY_ATTRS = %i[
+      how
+      eta
+      min_amount
+      max_amount
+      fee_fixed
+      fee_percent
+      extra_info
+    ].freeze
+
+    attribute(:body, Coercers::IndifferentHash, {
+      lazy: true,
+      default: :default_body,
+    })
+    attribute :how, String, lazy: true, default: :default_how
+    attribute :eta, String, lazy: true, default: :default_eta
+    attribute :min_amount, BigDecimal, lazy: true, default: :default_min_amount
+    attribute :max_amount, BigDecimal, lazy: true, default: :default_max_amount
+    attribute :fee_fixed, BigDecimal, lazy: true, default: :default_fee_fixed
+    attribute(:fee_percent, BigDecimal, {
+      lazy: true,
+      default: :default_fee_percent,
+    })
+    attribute(:extra_info, Hash, {
+      lazy: true,
+      default: :default_extra_info,
+    })
+
+    private
+
+    def default_body
+      JSON.parse(raw_response.body)
+    end
+
+    BODY_ATTRS.each do |attr|
+      define_method("default_#{attr}".to_sym) do
+        body[attr]
+      end
+    end
+
+  end
+end

data/lib/stellar_client/version.rb

@@ -1,3 +1,3 @@
 module StellarClient
-  VERSION = "0.5.2".freeze
+  VERSION = "0.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar_client
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-11 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
@@ -201,6 +201,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
@@ -215,10 +216,12 @@ files:
 - lib/stellar_client.rb
 - lib/stellar_client/client.rb
 - lib/stellar_client/coercers/indifferent_hash.rb
+- lib/stellar_client/requests/deposit_request.rb
 - lib/stellar_client/requests/get_toml_request.rb
 - lib/stellar_client/requests/send_payment_request.rb
 - lib/stellar_client/requests/withdraw_request.rb
 - lib/stellar_client/responses/base_response.rb
+- lib/stellar_client/responses/deposit_response.rb
 - lib/stellar_client/responses/get_toml_response.rb
 - lib/stellar_client/responses/send_payment_response.rb
 - lib/stellar_client/responses/withdraw_response.rb