stellar_base-rails 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3148ee962db068aa1a50ba957044611996c6e0462e68662d77881e3a2af71d26
-  data.tar.gz: 6e4dd4193b3d808549cc45240f944c74753243c93890287120a2aa51c9fd5416
+  metadata.gz: 86c1a220ccc8dec7052bd575a4fbdc8b477ef714a8e99c0ba0f1d08ccd8e92ff
+  data.tar.gz: eb4b64fe63c1d8602ff823496d24da6793acbdb2e540665c0d4097e0e0267947
 SHA512:
-  metadata.gz: ee9563139a43b42ffd370d49a1d5d77e93fc8d82451b3669ec0eea4fd92196ed567bad0bf5877345b9b1fe3255051c19793f4efead14cb7a999db7164859aef7
-  data.tar.gz: 8b8580584eec84ac4d87f12f5712880fa5b4e74c4f98f88712750004a2f7bc5a78f26483e873f85a62ed9b8bddebdd126ba31005dd8fa670e816ce6b6f60487d
+  metadata.gz: be387cda44d420b25fc46f98f0e786cb1a74f38ae15020d658f86979575cd78ba3be480a785813f625cc930d176a72b21c29a1aa33cc3ab44c2f32f1e422ea48
+  data.tar.gz: 84ea52aea9cb4e759e1236f18909af28972e9d163c5c6dc03f0790308ce75e7b0cb8369690a5e12d7e2b96a27f06254fe38c24aafd46d287a7a1327f9fb56d4d

data/README.md

@@ -19,18 +19,39 @@ Create an initializer in your rails application:
 
 StellarBase.configure do |c|
   c.modules = %i(bridge_callbacks)
+  c.horizon_url = "https://horizon.stellar.org"
+
+  c.check_bridge_callbacks_authenticity = true
   c.on_bridge_callback = "StellarBridgeReceive::SaveTxn"
 end
 ```
 
+
 #### c.modules
+- Value(s): array of symbols
+  - bridge_callbacks - when supplied this will mount the `/bridge_callbacks` endpoint
+- Default: `%i(bridge_callbacks)`
 - You can supply what endpoints you want to activate with the gem
 - `bridge_callbacks` - this will mount a HTTP/S POST endpoint that acts as callback receiver for bridge server payments on the path. It will call your `.on_bridge_callback` class.
 
 #### c.on_bridge_callback
+- Value(s): Class
+- Default: None
 - Once the bridge_receive endpoint receives a callback, the class will be called with .call
 - The class will be passed with the bridge server callback payload contained in a `StellarBase::BridgeCallback` object.
 - The class will be expected to return a boolean, return true if the callback was processed properly
+- Warning: The bridge server will may post multiple callbacks with the same ID, make sure you handle these correctly. https://github.com/stellar/bridge-server/blob/master/readme_bridge.md#callbacksreceive
+
+
+#### c.check_bridge_callbacks_authenticity
+- Value(s): `true` or `false`
+- Default: `false`
+- This secures the `/bridge_callbacks` endpoint from fake transactions by checking the transaction ID and it's contents against the Stellar Blockchain. If it doesn't add up, `/bridge_callbacks` endpoint will respond with a 422
+
+#### c.horizon_url
+- Value(s): String, url to horizon
+- Default: https://horizon.stellar.org
+- This is where the engine will check bridge callbacks if `c.cross_reference_bridge_callback` is turned on
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/concepts/stellar_base/bridge_callbacks/contracts/process.rb

@@ -14,6 +14,33 @@ module StellarBase
         property :data
         property :transaction_id
 
+        validate :check_callback_authenticity
+
+        def check_callback_authenticity
+          if !StellarBase.configuration.check_bridge_callbacks_authenticity
+            return
+          end
+
+          result = BridgeCallbacks::Check.({
+            operation_id: id,
+            transaction_id: transaction_id,
+            params: {
+              id: id,
+              from: from,
+              route: route,
+              amount: amount,
+              asset_code: asset_code,
+              asset_issuer: asset_issuer,
+              memo: memo,
+              memo_type: memo_type,
+              data: data,
+              transaction_id: transaction_id,
+            },
+          })
+
+          errors.add(:base, result.message) if result.failure?
+        end
+
       end
     end
   end

data/app/models/stellar_base/bridge_callback.rb

@@ -1,27 +1,17 @@
 module StellarBase
-  class BridgeCallback < ApplicationDataModel
+  class BridgeCallback
+    include Virtus.model
     # Attributes and params from
     # https://github.com/stellar/bridge-server/blob/master/readme_bridge.md#callbacksreceive
-    attribute :id, DryTypes::String.optional
-    attribute :from, DryTypes::String.optional
-    attribute :route, DryTypes::String.optional
-    attribute :amount, DryTypes::Decimal.optional
-    attribute :asset_code, DryTypes::String.optional
-    attribute :asset_issuer, DryTypes::String.optional
-    attribute :memo_type, DryTypes::String.optional
-    attribute :memo, DryTypes::String.optional
-    attribute :data, DryTypes::String.optional
-    attribute :transaction_id, DryTypes::String.optional
-
-    attr_writer :id
-    attr_writer :from
-    attr_writer :route
-    attr_writer :amount
-    attr_writer :asset_code
-    attr_writer :asset_issuer
-    attr_writer :memo_type
-    attr_writer :memo
-    attr_writer :data
-    attr_writer :transaction_id
+    attribute :id, String
+    attribute :from, String
+    attribute :route, String
+    attribute :amount, Float
+    attribute :asset_code, String
+    attribute :asset_issuer, String
+    attribute :memo_type, String
+    attribute :memo, String
+    attribute :data, String
+    attribute :transaction_id, String
   end
 end

data/app/services/stellar_base/bridge_callbacks/check.rb

@@ -0,0 +1,16 @@
+module StellarBase
+  module BridgeCallbacks
+    class Check
+      extend LightService::Organizer
+
+      def self.call(opts = {})
+        with(opts).reduce(
+          InitializeHorizonClient,
+          GetOperation,
+          GetTransaction,
+        )
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/bridge_callbacks/get_operation.rb

@@ -0,0 +1,18 @@
+module StellarBase
+  module BridgeCallbacks
+    class GetOperation
+      extend LightService::Action
+      expects :operation_id, :client
+      promises :operation_response
+
+      executed do |c|
+        id = c.operation_id
+        response = c.client.get_operation(id)
+
+        c.fail_and_return! "Operation ##{id} doesn't exist" if !response.present?
+
+        c.operation_response = response
+      end
+    end
+  end
+end

data/app/services/stellar_base/bridge_callbacks/get_transaction.rb

@@ -0,0 +1,21 @@
+module StellarBase
+  module BridgeCallbacks
+    class GetTransaction
+      extend LightService::Action
+      expects :client, :transaction_id
+      promises :transaction_response
+
+      executed do |c|
+        id = c.transaction_id
+        response = c.client.get_transaction(id)
+
+        if !response.present?
+          c.fail_and_return! "Transaction ##{id} doesn't exist"
+        end
+
+        c.transaction_response = response
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/bridge_callbacks/initialize_horizon_client.rb

@@ -0,0 +1,13 @@
+module StellarBase
+  module BridgeCallbacks
+    class InitializeHorizonClient
+      extend LightService::Action
+
+      promises :client
+
+      executed do |c|
+        c.client = HorizonClient.new
+      end
+    end
+  end
+end

data/lib/stellar_base.rb

@@ -1,17 +1,21 @@
 require "gem_config"
 require "light-service"
-require "dry-struct"
+require "virtus"
+require "httparty"
 require "trailblazer-rails"
 require "disposable"
 require "reform"
 require "reform/form/coercion"
+
 require "stellar_base/engine"
 
 module StellarBase
   include GemConfig::Base
 
   with_configuration do
+    has :horizon_url, default: "https://horizon.stellar.org"
     has :modules, default: [:bridge_callbacks]
+    has :check_bridge_callbacks_authenticity, default: false
     has :on_bridge_callback
   end
 
@@ -20,4 +24,4 @@ module StellarBase
   end
 end
 
-
+require "stellar_base/horizon_client"

data/lib/stellar_base/horizon_client.rb

@@ -0,0 +1,29 @@
+module StellarBase
+  class HorizonClient
+    def get_operation(operation_id)
+      response = HTTParty.get(horizon_operations_path(operation_id))
+
+      JSON.parse(response.body) if response.code == 200
+    end
+
+    def get_transaction(transaction_id)
+      response = HTTParty.get(horizon_transactions_path(transaction_id))
+
+      JSON.parse(response.body) if response.code == 200
+    end
+
+    private
+
+    def horizon_transactions_path(transaction_id)
+      "#{base_url}/transactions/#{transaction_id}"
+    end
+
+    def horizon_operations_path(operation_id)
+      "#{base_url}/operations/#{operation_id}"
+    end
+
+    def base_url
+      StellarBase.configuration.horizon_url
+    end
+  end
+end

data/lib/stellar_base/version.rb

@@ -1,3 +1,3 @@
 module StellarBase
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: stellar_base-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ace Subido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-struct
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: trailblazer
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: API Endpoints for the Stellar Protocol
 email:
 - ace.subido@gmail.com
@@ -144,15 +200,19 @@ files:
 - app/helpers/stellar_base/application_helper.rb
 - app/jobs/stellar_base/application_job.rb
 - app/mailers/stellar_base/application_mailer.rb
-- app/models/stellar_base/application_data_model.rb
 - app/models/stellar_base/application_record.rb
 - app/models/stellar_base/bridge_callback.rb
+- app/services/stellar_base/bridge_callbacks/check.rb
+- app/services/stellar_base/bridge_callbacks/get_operation.rb
+- app/services/stellar_base/bridge_callbacks/get_transaction.rb
+- app/services/stellar_base/bridge_callbacks/initialize_horizon_client.rb
 - app/services/stellar_base/bridge_callbacks/process.rb
 - app/views/layouts/stellar_base/application.html.erb
 - config/routes.rb
 - lib/stellar_base-rails.rb
 - lib/stellar_base.rb
 - lib/stellar_base/engine.rb
+- lib/stellar_base/horizon_client.rb
 - lib/stellar_base/version.rb
 - lib/tasks/stellar_base_tasks.rake
 homepage: https://github.com/bloom-solutions/stellar_base-rails

data/app/models/stellar_base/application_data_model.rb

@@ -1,9 +0,0 @@
-module StellarBase
-  module DryTypes
-    include Dry::Types.module
-  end
-
-  class ApplicationDataModel < Dry::Struct
-    constructor_type :schema
-  end
-end