paxful_engine-rails 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d817baab866145e535dc28f7cc9a8031448e08ba21f4a9acfc36e0c179106cf9
-  data.tar.gz: eb31ac85370223ea2d1236587209da31decd596ade63fb85f9e4d292a34b4be6
+  metadata.gz: 0a8eb298ea0c209e4536008d41eaea8d8f8290ebe238bf4c4788d2fcb79dc81a
+  data.tar.gz: d1875e3a006fed12babdc0c60d1bd88601de09358067def092511f2853beb7a1
 SHA512:
-  metadata.gz: 804eea2db930ac5c49c68c8c874543c15330423f3465b0cd94542d57e3ad64fbc7d044ec88e3c62b7d128d02369bd5a719d488ed18d86a0e8550efc48c262baf
-  data.tar.gz: 7e0b5ce157c1a3f0c0e39946af73e71c8606327ade9c8760f11f6e8fdf7eebfd3c0ad78cddeb24754d7e8f762d022886027207fa6abb8354f4257631754f20f6
+  metadata.gz: 4300ebed063c0ea02f589c79014dcab945eb0b626b307a375c5c7579661f6824ebdd9f4dea60b6bd457342018e9bd2ca0ccdb90a7a3d0410971c2e29b18d2ab5
+  data.tar.gz: ed060a7c6d0ef44422186eb219bba05ba8c2abd605d3511205caea16add0b7c5ba9bc9c9da76e1b280cdde969f791bbe3b0cbfb8cf37b25d46230aec761e4929

data/README.md

@@ -34,7 +34,8 @@ Create an initializer in your Rails application:
 PaxfulEngine.configure do |c|
   c.paxful_key = "your paxful key"
   c.paxful_secret = "your paxful secret"
-  c.on_sync_callback = "YourCallback"
+  c.on_sync_callback = "SyncCallback"
+  c.on_failure_callback = "FailureCallback"
 end
 ```
 
@@ -45,7 +46,7 @@ It accepts a `Trade` as its only argument.
 
 ```
 # example
-class YourCallback
+class SyncCallback
 
   def self.call(trade)
     # do anything you want with this record
@@ -54,10 +55,28 @@ class YourCallback
 end
 ```
 
+#### c.on_failure_callback
+
+An object that responds to `call` that gets executed when a trade cannot be created.
+
+It accepts two arguments:
+- exception
+- payload
+
+```
+# example
+class FailureCallback
+
+  def self.call(e, payload)
+    # log somewhere...
+  end
+
+end
+```
+
 ### Usage
 
 Add this to your scheduler somewhere:
-
 ```
 # sidekiq_cron.yml
 refresh_paxful_order_book:
@@ -65,6 +84,10 @@ refresh_paxful_order_book:
   class: "PaxfulEngine::SyncOrderBookJob"
 ```
 
+From the host app:
+- Check list of trades at `/paxful_engine/trades`.
+- Details per trade at `/paxful_engine/trades/:id`.
+
 ### Development
 
 ```

data/app/helpers/paxful_engine/application_helper.rb

@@ -1,4 +1,10 @@
 module PaxfulEngine
   module ApplicationHelper
+
+    def highlight_status(trade)
+      status = trade.status.downcase
+      status == "successful" ? "text-success" : "text-danger"
+    end
+
   end
 end

data/app/models/paxful_engine/trade.rb

@@ -17,5 +17,17 @@ module PaxfulEngine
       presence: true
     )
 
+    def successful?
+      status.downcase == "successful"
+    end
+
+    def buy?
+      offer_type.downcase == "buy"
+    end
+
+    def sell?
+      offer_type.downcase == "sell"
+    end
+
   end
 end

data/app/services/paxful_engine/create_trade.rb

@@ -24,6 +24,12 @@ module PaxfulEngine
       end
 
       trade
+
+    rescue => exception
+      if PaxfulEngine.configuration.on_failure_callback.present?
+        callback = PaxfulEngine.configuration.on_failure_callback
+        callback.constantize.(exception, payload)
+      end
     end
 
   end

data/app/views/paxful_engine/trades/index.html.erb

@@ -1,3 +1,6 @@
+<span class="font-weight-bold"> Found <%= pluralize(@trades.count, "trade") %></span>
+<hr />
+
 <div class="table-responsive">
   <table class="table table-striped table-bordered">
     <thead>
@@ -12,12 +15,20 @@
       </tr>
     </thead>
     <tbody>
+      <% if @trades.empty? %>
+        <tr>
+          <td colspan="7"> No trades found </td>
+        </tr>
+      <% end %>
+
       <% @trades.each do |trade| %>
         <tr scope="row">
           <td> <%= trade.created_at.strftime("%m/%d/%Y %I:%M%p") %> </td>
           <td> <%= trade.trade_hash %> </td>
           <td> <%= trade.offer_type.upcase %> </td>
-          <td> <%= trade.status.upcase %> </td>
+          <td> 
+            <span class="<%= highlight_status(trade) %>"> <%= trade.status.upcase %> </span> 
+          </td>
           <td> <%= trade.seller %> </td>
           <td> <%= trade.buyer %> </td>
           <td> <%= link_to "Check trade details", paxful_engine.trade_path(trade) %> </td>

data/app/views/paxful_engine/trades/show.html.erb

@@ -35,7 +35,10 @@
       
         <hr />
 
-        <div> <strong>Status:</strong> <%= @trade.status.upcase %> </div>
+        <div> 
+          <strong>Status:</strong> 
+          <span class="<%= highlight_status(@trade) %>"> <%= @trade.status.upcase %> </span> 
+        </div>
         <div> <strong>Payment Method:</strong> <%= @trade.payment_method_name %> </div>
       </div>
     </div>

data/lib/paxful_engine.rb

@@ -12,6 +12,7 @@ module PaxfulEngine
     has :paxful_key, classes: [NilClass, String]
     has :paxful_secret, classes: [NilClass, String]
     has :on_sync_callback
+    has :on_failure_callback
   end
 
 end

data/lib/paxful_engine/factories.rb

@@ -0,0 +1,16 @@
+FactoryBot.define do
+
+  factory :paxful_engine_trade, class: "PaxfulEngine::Trade" do
+    trade_hash { "trade-hash" }
+    offer_hash { "offer-hash" }
+    offer_type { "buy" }
+    crypto_amount_requested { 0.05 }
+    crypto_currency_code { "BTC" }
+    fiat_amount_requested { 1_000 }
+    fiat_currency_code { "PHP" }
+    started_at { Time.current }
+    ended_at { Time.current + 2.days }
+    status { "successful" }
+  end
+
+end

data/lib/paxful_engine/version.rb

@@ -1,3 +1,3 @@
 module PaxfulEngine
-  VERSION = '0.2.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paxful_engine-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mark Chavez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +194,7 @@ files:
 - lib/paxful_engine-rails.rb
 - lib/paxful_engine.rb
 - lib/paxful_engine/engine.rb
+- lib/paxful_engine/factories.rb
 - lib/paxful_engine/version.rb
 - lib/tasks/paxful_engine_tasks.rake
 homepage: https://github.com/bloom-solutions/paxful_engine-rails