paxful_engine-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e703f7e6fbaf90b7f85cdb26beaf05aa92590fb7f42145c3177870ddffae27c
+  data.tar.gz: e6029b79a03f1acfee4310b6ae788710836c995dfb0a6a9a51bd2c2ebf448174
+SHA512:
+  metadata.gz: 65344157341d2356b8efde3f789a0a2561cbf4283c252888bd826465d7b64df2e92587061913ef2c302ed5d5e0131b9031f9752caa70031b5cce9fc901f22791
+  data.tar.gz: bed2766b448c783a849a78f6fc069c8f1c0d3822981bbf63a0aa7ffad78ed4c179cc84b0a82e6a84ad57c70605aa55fa1cba5ba30110b1191dadb1e1a5ce517f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Mark Chavez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# PaxfulEngine
+
+A mountable Rails engine that saves completed trades from [paxful](https://paxful.com/)
+marketplace and lets you do anything with it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paxful_engine-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+$ rails paxful_engine:install:migrations
+$ rails db:migrate
+```
+
+Or install it yourself as:
+```bash
+$ gem install paxful_engine-rails
+```
+
+### Configuration
+
+Create an initializer in your Rails application:
+
+```
+# config/initializers/paxful_engine-rails.rb
+
+PaxfulEngine.configure do |c|
+  c.paxful_key = "your paxful key"
+  c.paxful_secret = "your paxful secret"
+  c.on_sync_callback = "YourCallback"
+end
+```
+
+#### c.on_sync_callback
+
+An object that responds to `call` that gets executed after a trade is (re)processed.
+It accepts a `Trade` as its only argument.
+
+```
+# example
+class YourCallback
+
+  def self.call(trade)
+    # do anything you want with this record
+  end
+
+end
+```
+
+### Development
+
+```
+$ rails db:migrate
+$ rails db:migrate db:test:prepare
+```
+
+### Testing
+
+```
+$ bundle exec rspec spec
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaxfulEngine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/paxful_engine_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/paxful_engine .css

data/app/assets/stylesheets/paxful_engine/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/paxful_engine/application_controller.rb

@@ -0,0 +1,5 @@
+module PaxfulEngine
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/paxful_engine/application_helper.rb

@@ -0,0 +1,4 @@
+module PaxfulEngine
+  module ApplicationHelper
+  end
+end

data/app/jobs/paxful_engine/application_job.rb

@@ -0,0 +1,7 @@
+module PaxfulEngine
+  class ApplicationJob
+
+    include Sidekiq::Worker
+
+  end
+end

data/app/jobs/paxful_engine/enqueue_create_trade_job.rb

@@ -0,0 +1,11 @@
+module PaxfulEngine
+  class EnqueueCreateTradeJob < ApplicationJob
+
+    sidekiq_options retry: false
+    
+    def perform(payload)
+      CreateTrade.(payload)
+    end
+
+  end
+end

data/app/jobs/paxful_engine/sync_order_book_job.rb

@@ -0,0 +1,24 @@
+module PaxfulEngine
+  class SyncOrderBookJob < ApplicationJob
+
+    HOST = "https://paxful.com/api".freeze
+
+    def perform
+      client = PaxfulClient.new(
+        host: HOST,
+        key: PaxfulEngine.configuration.paxful_key,
+        secret: PaxfulEngine.configuration.paxful_secret,
+      )
+
+      response = client.get_completed_trades
+      return unless response.success?
+
+      trades = response.parsed_body["data"]["trades"]
+
+      trades.each do |payload|
+        EnqueueCreateTradeJob.perform_async(payload)
+      end
+    end
+
+  end
+end

data/app/mailers/paxful_engine/application_mailer.rb

@@ -0,0 +1,6 @@
+module PaxfulEngine
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/paxful_engine/application_record.rb

@@ -0,0 +1,5 @@
+module PaxfulEngine
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/paxful_engine/trade.rb

@@ -0,0 +1,21 @@
+module PaxfulEngine
+  class Trade < ApplicationRecord
+
+    validates(
+      :trade_hash,
+      :offer_hash,
+      :offer_type,
+      :fiat_amount_requested,
+      :fiat_currency_code,
+      :crypto_amount_requested,
+      :crypto_currency_code,
+      :started_at,
+      :ended_at,
+      :seller,
+      :buyer,
+      :status,
+      presence: true
+    )
+
+  end
+end

data/app/services/paxful_engine/create_trade.rb

@@ -0,0 +1,30 @@
+module PaxfulEngine
+  class CreateTrade
+
+    def self.call(payload)
+      trade = Trade.where(trade_hash: payload["trade_hash"]).first_or_create! do |paxful_trade|
+        paxful_trade.offer_hash = payload["offer_hash"]
+        paxful_trade.offer_type = payload["offer_type"]
+        paxful_trade.fiat_amount_requested = BigDecimal(payload["fiat_amount_requested"])
+        paxful_trade.fiat_currency_code = payload["fiat_currency_code"]
+        paxful_trade.crypto_amount_requested = BigDecimal(payload["crypto_amount_requested"])
+        paxful_trade.crypto_currency_code = payload["crypto_currency_code"]
+        paxful_trade.payment_method_name = payload["payment_method_name"]
+        paxful_trade.started_at = payload["started_at"]
+        paxful_trade.ended_at = payload["ended_at"]
+        paxful_trade.seller = payload["seller"]
+        paxful_trade.buyer = payload["buyer"]
+        paxful_trade.completed_at = payload["completed_at"]
+        paxful_trade.status = payload["status"]
+      end
+
+      if PaxfulEngine.configuration.on_sync_callback.present?
+        callback = PaxfulEngine.configuration.on_sync_callback
+        callback.constantize.(trade)
+      end
+
+      trade
+    end
+
+  end
+end

data/app/views/layouts/paxful_engine/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Paxful engine</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "paxful_engine/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+PaxfulEngine::Engine.routes.draw do
+end

data/db/migrate/20201018043517_create_paxful_engine_trades.rb

@@ -0,0 +1,24 @@
+class CreatePaxfulEngineTrades < ActiveRecord::Migration[5.2]
+  def change
+    create_table :paxful_engine_trades do |t|
+      t.column :trade_hash, :string, null: false
+      t.column :offer_hash, :string, null: false
+      t.column :offer_type, :string, null: false
+      t.column :fiat_amount_requested, :decimal, null: false
+      t.column :fiat_currency_code, :string, null: false
+      t.column :crypto_amount_requested, :decimal, null: false
+      t.column :crypto_currency_code, :string, null: false
+      t.column :started_at, :datetime, null: false
+      t.column :ended_at, :datetime, null: false
+      t.column :completed_at, :datetime
+      t.column :seller, :string, null: false
+      t.column :buyer, :string, null: false
+      t.column :status, :string, null: false
+      t.column :payment_method_name, :string
+
+      t.timestamps
+    end
+
+    add_index :paxful_engine_trades, :trade_hash, unique: true
+  end
+end

data/lib/paxful_engine-rails.rb

@@ -0,0 +1 @@
+require "paxful_engine"

data/lib/paxful_engine.rb

@@ -0,0 +1,17 @@
+require "gem_config"
+require "paxful_client"
+require "sidekiq"
+
+require "paxful_engine/engine"
+
+module PaxfulEngine
+
+  include GemConfig::Base
+
+  with_configuration do
+    has :paxful_key, classes: [NilClass, String]
+    has :paxful_secret, classes: [NilClass, String]
+    has :on_sync_callback
+  end
+
+end

data/lib/paxful_engine/engine.rb

@@ -0,0 +1,5 @@
+module PaxfulEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace PaxfulEngine
+  end
+end

data/lib/paxful_engine/version.rb

@@ -0,0 +1,3 @@
+module PaxfulEngine
+  VERSION = '0.1.0'
+end

data/lib/tasks/paxful_engine_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :paxful_engine do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: paxful_engine-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Chavez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: paxful_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec-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: sqlite3
+  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: vcr
+  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: 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: Mountable engine that fetches completed paxful trades.
+email:
+- mjfchavez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/paxful_engine_manifest.js
+- app/assets/stylesheets/paxful_engine/application.css
+- app/controllers/paxful_engine/application_controller.rb
+- app/helpers/paxful_engine/application_helper.rb
+- app/jobs/paxful_engine/application_job.rb
+- app/jobs/paxful_engine/enqueue_create_trade_job.rb
+- app/jobs/paxful_engine/sync_order_book_job.rb
+- app/mailers/paxful_engine/application_mailer.rb
+- app/models/paxful_engine/application_record.rb
+- app/models/paxful_engine/trade.rb
+- app/services/paxful_engine/create_trade.rb
+- app/views/layouts/paxful_engine/application.html.erb
+- config/routes.rb
+- db/migrate/20201018043517_create_paxful_engine_trades.rb
+- lib/paxful_engine-rails.rb
+- lib/paxful_engine.rb
+- lib/paxful_engine/engine.rb
+- lib/paxful_engine/version.rb
+- lib/tasks/paxful_engine_tasks.rake
+homepage: https://github.com/bloom-solutions/paxful_engine-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: Mountable engine that fetches completed paxful trades.
+test_files: []