paxful_client 0.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 254db880129744b08cde6919bfc46602d477b2a3157cf4b3b5cfa5c915d073fe
-  data.tar.gz: 8d779a7267a67da361b314491c60256a0f5ce13744d3cb20ba3e7cfcc2b5f29d
+  metadata.gz: e31445632e6df99df0ecdec87a56d68eeeb475287b881d53eb3a75a9d3292f35
+  data.tar.gz: 63ec0e3c38e12fe71ac6b41880e4008e4a51fd658464172de59cb628d4038ebe
 SHA512:
-  metadata.gz: 7add11eb46dd431527e2b796e206ffa2308a17277736b4944a343b6c03d765e6134f23f483f7da3e018a3fb045ece8ee4e772f6af0b558fb265b0ce4d56e7421
-  data.tar.gz: 6e2b95a8c2ef5b291764d8f9292e1d145c0e76df509b33a9edc4e54af3a07be6c5808281ef7f40c4f1b7dca935fd084dd09ae5366573c92bb2855215da9252f8
+  metadata.gz: 0a521e88fb719f7376433db827da71458d46309e3ac61e61f8af72dd910bcda757ff63c1d03c078f98140bf76f73c34803423fbc42091d01613010da37508061
+  data.tar.gz: 7326e16e3bdebb80b3c5fab4c2a806d9bc75a2dba5a57319d5eb8a5f783c1465c35a58bdebdc51303f26a0835e0c7e587208440b6198b33f46b1705c782ec213

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+    - name: Install dependencies
+      run: bundle install
+    - name: Copy config.yml
+      run: cp spec/config.yml{.sample,}
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -4,7 +4,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.3.0] - 2021-01-06
+### Changed
+- `get_balance#success?` now checks if the response body has a `data` element. Sometimes Paxful returns 200, but has an empty body
+
+## [1.2.0] - 2020-12-15
+### Changed
+- Only consider success for `get_completed_trades` if it meets certain criteria
+
+## [1.1.0] - 2020-11-25
+### Added
+- Add support for passing in `page` for completed trades
+
+## [1.0.0] - 2020-11-19
+### Added
+- Ensure that `key` and `secret` are present; raise exception otherwise
+
+## [0.3.0] - 2020-10-12
+### Added
+- add `trade/completed` endpoint
+- add `PaxfulClient::OrderBook` model
+- add `PaxfulClient::Trade` model
+
+## [0.2.0] - 2020-09-12
 ### Changed
 - refactor `get_balance` request
 

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    paxful_client (0.2.0)
+    paxful_client (1.3.0)
       activesupport
       api_client_base
+      dry-validation (~> 0.13)
       typhoeus
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.3)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     api_client_base (1.9.0)
@@ -34,17 +35,45 @@ GEM
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.4.4)
+    dry-configurable (0.12.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (0.6.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.14.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 0.5, >= 0.5)
+    dry-validation (0.13.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.5, >= 0.5.0)
+      dry-types (~> 0.14.0)
     equalizer (0.0.11)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.13.1)
+    ffi (1.14.2)
     gem_config (0.3.2)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     method_source (1.0.0)
-    minitest (5.14.2)
+    minitest (5.14.3)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -67,8 +96,8 @@ GEM
     thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     vcr (3.0.3)
     virtus (1.0.5)
       axiom-types (~> 0.1)
@@ -79,7 +108,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -22,18 +22,29 @@ Or install it yourself as:
 
 ```ruby
 client = PaxfulClient.new(host: "host", key: "key", secret: "secret")
+
+# Get balance
 response = client.get_balance
 wallet = response.wallet
-
-# get the balance
 wallet.balance
+
+# Get completed trades (page = 1 by default)
+response = client.get_completed_trades
+
+# Get completed trades by page
+response = client.get_completed_trades(page: page)
+
+# Get response
+order_book = response.order_book
+order_book.trades
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+cp spec/config.yml{.sample,}
+rspec
+```
 
 ## Contributing
 

data/lib/paxful_client.rb

@@ -1,14 +1,24 @@
 require "paxful_client/version"
 require "api_client_base"
+require "dry-validation"
 
 require "json"
 require "active_support/core_ext/hash/indifferent_access"
 require "openssl"
 
 require "paxful_client/client"
+require "paxful_client/models/order_book"
+require "paxful_client/models/trade"
 require "paxful_client/models/wallet"
+require "paxful_client/requests/base_request"
 require "paxful_client/requests/get_balance_request"
+require "paxful_client/requests/get_completed_trades_request"
+require "paxful_client/responses/base_response"
 require "paxful_client/responses/get_balance_response"
+require "paxful_client/responses/get_completed_trades_response"
+require "paxful_client/schemas/base_request_schema"
+require "paxful_client/schemas/get_balance_request_schema"
+require "paxful_client/schemas/get_completed_trades_request_schema"
 
 module PaxfulClient
   include APIClientBase::Base.module

data/lib/paxful_client/client.rb

@@ -4,6 +4,7 @@ module PaxfulClient
     include APIClientBase::Client.module(default_opts: :default_opts)
 
     api_action :get_balance
+    api_action :get_completed_trades
 
     attribute :host, String
     attribute :key, String

data/lib/paxful_client/models/order_book.rb

@@ -0,0 +1,13 @@
+module PaxfulClient
+  class OrderBook
+
+    include Virtus.model
+
+    attribute :status, String
+    attribute :timestamp, Integer
+    attribute :count, Integer
+    attribute :page, Integer
+    attribute :trades, Array
+
+  end
+end

data/lib/paxful_client/models/trade.rb

@@ -0,0 +1,22 @@
+module PaxfulClient
+  class Trade
+
+    include Virtus.model
+
+    attribute :status, String
+    attribute :trade_hash, String
+    attribute :offer_hash, String
+    attribute :offer_type, String
+    attribute :fiat_currency_code, String
+    attribute :crypto_currency_code, String
+    attribute :fiat_amount_requested, BigDecimal
+    attribute :crypto_amount_requested, BigDecimal
+    attribute :payment_method_name, String
+    attribute :started_at, String
+    attribute :ended_at, String
+    attribute :completed_at, String
+    attribute :seller, String
+    attribute :buyer, String
+
+  end
+end

data/lib/paxful_client/requests/base_request.rb

@@ -0,0 +1,29 @@
+module PaxfulClient
+  class BaseRequest
+
+    include APIClientBase::Request
+
+    attribute :key,    String
+    attribute :secret, String
+    attribute :page, Integer, default: 1
+
+    private
+
+    def body
+      nonce = Time.now.to_i
+      apiseal = OpenSSL::HMAC.hexdigest(
+        "SHA256",
+        secret,
+        "apikey=#{key}&nonce=#{nonce}&page=#{page}",
+      )
+
+      [
+        "apikey=#{key}",
+        "nonce=#{nonce}",
+        "page=#{page}",
+        "apiseal=#{apiseal}",
+      ].join("&")
+    end
+
+  end
+end

data/lib/paxful_client/requests/get_balance_request.rb

@@ -1,10 +1,5 @@
 module PaxfulClient
-  class GetBalanceRequest
-
-    include APIClientBase::Request.module(action: :post)
-
-    attribute :key,    String
-    attribute :secret, String
+  class GetBalanceRequest < BaseRequest
 
     private
 
@@ -19,19 +14,8 @@ module PaxfulClient
       }
     end
 
-    def body
-      nonce = Time.now.to_i
-      apiseal = OpenSSL::HMAC.hexdigest(
-        "SHA256", 
-        secret, 
-        "apikey=#{key}&nonce=#{nonce}",
-      )
-
-      [
-        "apikey=#{key}",
-        "nonce=#{nonce}",
-        "apiseal=#{apiseal}",
-      ].join("&")
+    def default_action
+      :post
     end
 
   end

data/lib/paxful_client/requests/get_completed_trades_request.rb

@@ -0,0 +1,22 @@
+module PaxfulClient
+  class GetCompletedTradesRequest < BaseRequest
+
+    private
+
+    def path
+      "/trade/completed"
+    end
+
+    def headers
+      {
+        "Accept" => "application/json",
+        "Content-Type" => "text/plain",
+      }
+    end
+
+    def default_action
+      :post
+    end
+
+  end
+end

data/lib/paxful_client/responses/base_response.rb

@@ -0,0 +1,21 @@
+module PaxfulClient
+  class BaseResponse
+
+    include APIClientBase::Response.module
+
+    attribute :body, Object, lazy: true, default: :default_body
+    attribute :parsed_body, String, lazy: true, default: :default_parsed_body
+    attribute :error_message, String, lazy: true
+
+    private
+
+    def default_body
+      raw_response.body
+    end
+
+    def default_parsed_body
+      JSON.parse(body).with_indifferent_access
+    end
+
+  end
+end

data/lib/paxful_client/responses/get_balance_response.rb

@@ -1,7 +1,5 @@
 module PaxfulClient
-  class GetBalanceResponse
-
-    include APIClientBase::Response.module
+  class GetBalanceResponse < BaseResponse
 
     attribute :wallet, PaxfulClient::Wallet, lazy: true, default: :default_wallet
     attribute :body, Object, lazy: true, default: :default_body
@@ -9,6 +7,14 @@ module PaxfulClient
 
     private
 
+    def default_success
+      unless parsed_body['data'].present?
+        self.error_message = 'GetBalanceResponse: data not present'
+        return false
+      end
+      raw_response.success?
+    end
+
     def default_wallet
       args = parsed_body["data"].each_with_object({}) do |(attr, val), hash|
         hash[attr.underscore] = val

data/lib/paxful_client/responses/get_completed_trades_response.rb

@@ -0,0 +1,36 @@
+module PaxfulClient
+  class GetCompletedTradesResponse < BaseResponse
+
+    attribute :order_book, PaxfulClient::OrderBook, lazy: true, default: :default_order_book
+
+    private
+
+    def default_order_book
+      status = parsed_body["status"]
+      timestamp = parsed_body["timestamp"]
+      args = parsed_body["data"]
+
+      order_book = OrderBook.new
+      order_book.status = status
+      order_book.timestamp = timestamp
+      order_book.count = args["count"]
+      order_book.page = args["page"]
+      order_book.trades = args["trades"].map do |trade_hash|
+        Trade.new(trade_hash)
+      end
+
+      order_book
+    end
+
+    def default_success
+      code == 200 && present_parsed_body?
+    end
+
+    def present_parsed_body?
+      !parsed_body.nil? &&
+        !parsed_body["data"].nil? &&
+        !parsed_body["data"]["trades"].nil?
+    end
+
+  end
+end

data/lib/paxful_client/schemas/base_request_schema.rb

@@ -0,0 +1,8 @@
+module PaxfulClient
+  BaseRequestSchema = Dry::Validation.Schema do
+
+    required(:key).filled(:str?)
+    required(:secret).filled(:str?)
+
+  end
+end

data/lib/paxful_client/schemas/get_balance_request_schema.rb

@@ -0,0 +1,3 @@
+module PaxfulClient
+  GetBalanceRequestSchema = BaseRequestSchema
+end

data/lib/paxful_client/schemas/get_completed_trades_request_schema.rb

@@ -0,0 +1,3 @@
+module PaxfulClient
+  GetCompletedTradesRequestSchema = BaseRequestSchema
+end

data/lib/paxful_client/version.rb

@@ -1,3 +1,3 @@
 module PaxfulClient
-  VERSION = "0.2.0"
+  VERSION = "1.3.0"
 end

data/paxful_client.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "api_client_base"
   spec.add_dependency "typhoeus"
   spec.add_dependency "activesupport"
+  spec.add_dependency "dry-validation", "~> 0.13"
 
   spec.add_development_dependency "pry"
   spec.add_development_dependency "vcr", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paxful_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mark Chavez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -101,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -115,9 +129,18 @@ files:
 - bin/setup
 - lib/paxful_client.rb
 - lib/paxful_client/client.rb
+- lib/paxful_client/models/order_book.rb
+- lib/paxful_client/models/trade.rb
 - lib/paxful_client/models/wallet.rb
+- lib/paxful_client/requests/base_request.rb
 - lib/paxful_client/requests/get_balance_request.rb
+- lib/paxful_client/requests/get_completed_trades_request.rb
+- lib/paxful_client/responses/base_response.rb
 - lib/paxful_client/responses/get_balance_response.rb
+- lib/paxful_client/responses/get_completed_trades_response.rb
+- lib/paxful_client/schemas/base_request_schema.rb
+- lib/paxful_client/schemas/get_balance_request_schema.rb
+- lib/paxful_client/schemas/get_completed_trades_request_schema.rb
 - lib/paxful_client/version.rb
 - paxful_client.gemspec
 homepage: https://github.com/MarkFChavez/paxful_client-ruby
@@ -142,8 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: API wrapper for Paxful

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-before_install: gem install bundler -v 2.1.4