paxful_client 0.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4f2db608ddceb40e4e29da6a0361216a461969a95c8179515f04bd8b975f256
-  data.tar.gz: 2ead2910725c7649bae0015e049e5ea12f40a8ff29cccac24b3fcb25a4a1c403
+  metadata.gz: 36845963975c5db9f0a3184a366c0958283e4eeb18dd583db1987c4c4aac98a8
+  data.tar.gz: 968fb3acba949cb42c2e9425af38655da1ed612ca6a1a9b4793c620bb3b9296e
 SHA512:
-  metadata.gz: cf3ebdf5000d7fe7a3085cfa57166b0fa59174f6427b3d5cc2f3fffa03bf832a9f1f1fb12a420e93c8429032c2fe4d56392b01e3f580372f23ddd80176a99036
-  data.tar.gz: e8f72c926f62c588a1c7c71241d647e7d74823f089b51bcb97fc7a321f306fe28ebdfa2e540a87d5b337126a6ff7ec931d79992cc855765d2fd242f68ae67cb4
+  metadata.gz: 01e726e25a432383ab74b3ccde07c3cff7d1bf1c480afb8f9a4feaf0b52a0ca646f362fa427c2830e13a9996c21fe27112ec9af2d4f0394b99a58936fe8b3c85
+  data.tar.gz: d2b14a64416ba640ba0231c9bd2ea9f75d3d37eb7a41ccb71d40e3e110bb45a8160b7a0adf383da2099d24b3e9957e63c3a3be3e1b318c1441c587347079447b

data/.github/workflows/ruby.yml

@@ -20,14 +20,12 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+    - uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        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,6 +4,26 @@ 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).
 
+## [1.4.0] - 2021-06-15
+### Added
+- Update `dry-validation` to 1.x
+
+## [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

data/Gemfile.lock

@@ -1,23 +1,24 @@
 PATH
   remote: .
   specs:
-    paxful_client (0.3.0)
+    paxful_client (1.4.0)
       activesupport
       api_client_base
+      dry-validation (~> 1.0, < 2)
       typhoeus
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.3.2)
       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)
+    api_client_base (1.10.0)
       activesupport (>= 3.0)
       gem_config (>= 0.3.1)
       virtus (>= 1.0)
@@ -28,23 +29,56 @@ GEM
     coderay (1.1.3)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.4.4)
-    equalizer (0.0.11)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.8.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.6.0)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.4)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.6.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5, >= 1.5.2)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.1)
     gem_config (0.3.2)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     method_source (1.0.0)
-    minitest (5.14.2)
+    minitest (5.14.4)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -67,19 +101,18 @@ 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)
+    virtus (2.0.0)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
     webmock (2.3.2)
       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,5 +1,6 @@
 require "paxful_client/version"
 require "api_client_base"
+require "dry-validation"
 
 require "json"
 require "active_support/core_ext/hash/indifferent_access"
@@ -15,6 +16,9 @@ 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/requests/base_request.rb

@@ -5,20 +5,22 @@ module PaxfulClient
 
     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}",
+        "SHA256",
+        secret,
+        "apikey=#{key}&nonce=#{nonce}&page=#{page}",
       )
 
       [
         "apikey=#{key}",
         "nonce=#{nonce}",
+        "page=#{page}",
         "apiseal=#{apiseal}",
       ].join("&")
     end

data/lib/paxful_client/responses/base_response.rb

@@ -5,6 +5,7 @@ module PaxfulClient
 
     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
 

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

@@ -22,5 +22,15 @@ module PaxfulClient
       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,10 @@
+module PaxfulClient
+  class BaseRequestSchema < Dry::Validation::Contract
+
+    params do
+      required(:key).filled(:string)
+      required(:secret).filled(:string)
+    end
+
+  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.3.0"
+  VERSION = "1.4.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", "~> 1.0", "< 2"
 
   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.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Mark Chavez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
@@ -52,6 +52,26 @@ 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: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +144,9 @@ files:
 - 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
@@ -148,8 +171,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.1.6
 signing_key:
 specification_version: 4
 summary: API wrapper for Paxful