stellar-base 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96d6651ecee2afbc20de1481ef0c8fddab885693
-  data.tar.gz: e6653fa80f1e8ae7936b3a51d0ccbcc6a7392c2a
+  metadata.gz: edf391f6f810bd73ec555ce1c91258206098d527
+  data.tar.gz: afba8f6e5f53d4f63033fa0f25a25cfffcc183cd
 SHA512:
-  metadata.gz: 5a05f0fe07b39b3aa79fb0f1b82490faeb7bd875987da88d0fa84fac237f28e63a3421d2022468e7c5ad49862b889a6514eb0e7701d17e0b1bd3b9eea17dde84
-  data.tar.gz: cf88daa32fac7bfab7aa920d7595b3717e30de4e03a7ba4172acfdb5b8d5566d722d5d8f4fe58de0bda5955dc2727aa51227e448d085c3e55943d71f5675696f
+  metadata.gz: 551e1d62b63cbdf5856a90a95a040987f87442f3c93d4d79ecde59e8e42386ca3fb610e0cbcb4355128cfde624ba3e98927c18fa9b8c0ec35616ff43c8c41e79
+  data.tar.gz: 92163ef24f44cc2ad53631561893b630de04feff9b000ce186fe61ab8e426c0ffab63fdca6541c8523f51d06ab71ddb30b0946cb75eba254d6a731363f860759

data/README.md

@@ -68,6 +68,10 @@ b58.check_decode(:seed, encoded) # => throws ArgumentError: Unexpected version:
 
 ```
 
+## Updating Generated Code
+
+The generated code of this library must be refreshed each time the Stellar network's protocol is updated.  To perform this task, run `rake xdr:update`, which will download the latest `.x` files into the `xdr` folder and will run `xdrgen` to regenerate the built ruby code.
+
 ## Caveats
 
 The current integration of user-written code with auto-generated classes is to put it nicely, weird.  We intend to segregate the auto-generated code into its own namespace and refrain from monkey patching them.  This will happen before 1.0, and hopefully will happen soon.
@@ -75,4 +79,3 @@ The current integration of user-written code with auto-generated classes is to p
 ## Contributing
 
 Please [see CONTRIBUTING.md for details](CONTRIBUTING.md).
-

data/lib/stellar-base.rb

@@ -21,6 +21,7 @@ require_relative './stellar/account_flags'
 require_relative './stellar/currency'
 require_relative './stellar/key_pair'
 require_relative './stellar/operation'
+require_relative './stellar/path_payment_result'
 require_relative './stellar/price'
 require_relative './stellar/thresholds'
 require_relative './stellar/transaction'

data/lib/stellar/base/version.rb

@@ -1,5 +1,5 @@
 module Stellar
   module Base
-    VERSION = "0.0.16"
+    VERSION = "0.0.17"
   end
 end

data/lib/stellar/path_payment_result.rb

@@ -0,0 +1,17 @@
+module Stellar
+  class PathPaymentResult
+    # send_amount returns the actual amount paid for the corresponding
+    # PathPaymentOp to this result.
+    #
+    def send_amount
+      s = success!
+      return s.last.amount if s.offers.blank?
+
+      source_currency = s.offers.first.currency_send
+      source_offers = s.offers.take_while{|o| o.currency_send == source_currency}
+
+      source_offers.map(&:amount_send).sum
+    end
+
+  end
+end

data/ruby-stellar-base.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["generated", "lib"]
 
-  spec.add_dependency "xdr", "~> 0.0.2"
+  spec.add_dependency "xdr", "~> 0.0.3"
   spec.add_dependency "rbnacl"
   spec.add_dependency "rbnacl-libsodium", "~> 1.0.3"
   spec.add_dependency "activesupport", "~> 4"

data/spec/lib/stellar/path_payment_result_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+
+describe Stellar::PathPaymentResult, "#send_amount" do
+
+
+  context "when the result is not successful" do
+    subject{ Stellar::PathPaymentResult.new(:path_payment_malformed) }
+
+    it "raises an exception if the result is not successful" do
+      expect{ subject.send_amount }.to raise_error(XDR::ArmNotSetError)
+    end
+  end
+
+  context "when the result has no claimed offers" do
+    let(:simple_success){ Stellar::SimplePaymentResult.new(amount: 100) }
+    let(:path_success){ Stellar::PathPaymentResult::Success.new(last: simple_success) }
+
+    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+
+    it "returns the amount from the 'last' component" do
+      expect(subject.send_amount).to eql(100)
+    end
+  end
+
+
+  context "with simple 1-hop result" do
+    let(:simple_success){ Stellar::SimplePaymentResult.new(amount: 100) }
+    let(:offers) do
+      [Stellar::ClaimOfferAtom.new(currency_send: Stellar::Currency.native, amount_send: 200)]
+    end
+
+    let(:path_success) do
+      Stellar::PathPaymentResult::Success.new({
+        offers: offers,
+        last:   simple_success,
+      })
+    end
+
+    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+
+    it "returns the amount from the ClaimOfferAtom" do
+      expect(subject.send_amount).to eql(200)
+    end
+  end
+
+  context "with 1-hop result that claimed multiple offers" do
+    let(:simple_success){ Stellar::SimplePaymentResult.new(amount: 100) }
+    let(:offers) do
+      [
+        Stellar::ClaimOfferAtom.new(currency_send: Stellar::Currency.native, amount_send: 200),
+        Stellar::ClaimOfferAtom.new(currency_send: Stellar::Currency.native, amount_send: 200),
+      ]
+    end
+
+    let(:path_success) do
+      Stellar::PathPaymentResult::Success.new({
+        offers: offers,
+        last:   simple_success,
+      })
+    end
+
+    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+
+    it "returns the summed amount from the ClaimOfferAtoms" do
+      expect(subject.send_amount).to eql(400)
+    end
+  end
+
+
+  context "with multi-hop result that claimed multiple offers" do
+    let(:simple_success){ Stellar::SimplePaymentResult.new(amount: 100) }
+    let(:otherCurrency){ Stellar::Currency.alphanum("USD", Stellar::KeyPair.random) }
+    let(:offers) do
+      [
+        Stellar::ClaimOfferAtom.new(currency_send: Stellar::Currency.native, amount_send: 200),
+        Stellar::ClaimOfferAtom.new(currency_send: Stellar::Currency.native, amount_send: 200),
+        Stellar::ClaimOfferAtom.new(currency_send: otherCurrency, amount_send: 200),
+      ]
+    end
+
+    let(:path_success) do
+      Stellar::PathPaymentResult::Success.new({
+        offers: offers,
+        last:   simple_success,
+      })
+    end
+
+    subject{ Stellar::PathPaymentResult.new(:path_payment_success, path_success) }
+
+    it "returns the summed amount from the ClaimOfferAtoms" do
+      expect(subject.send_amount).to eql(400)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar-base
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Scott Fleckenstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xdr
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -316,6 +316,7 @@ files:
 - lib/stellar/currency.rb
 - lib/stellar/key_pair.rb
 - lib/stellar/operation.rb
+- lib/stellar/path_payment_result.rb
 - lib/stellar/price.rb
 - lib/stellar/thresholds.rb
 - lib/stellar/transaction.rb
@@ -326,6 +327,7 @@ files:
 - spec/lib/stellar/account_flags_spec.rb
 - spec/lib/stellar/convert_spec.rb
 - spec/lib/stellar/key_pair_spec.rb
+- spec/lib/stellar/path_payment_result_spec.rb
 - spec/lib/stellar/price_spec.rb
 - spec/lib/stellar/thresholds_spec.rb
 - spec/lib/stellar/transaction_envelope_spec.rb
@@ -374,6 +376,7 @@ test_files:
 - spec/lib/stellar/account_flags_spec.rb
 - spec/lib/stellar/convert_spec.rb
 - spec/lib/stellar/key_pair_spec.rb
+- spec/lib/stellar/path_payment_result_spec.rb
 - spec/lib/stellar/price_spec.rb
 - spec/lib/stellar/thresholds_spec.rb
 - spec/lib/stellar/transaction_envelope_spec.rb