binance_client-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 518c2a65034f8e4daba550421bc085d04680b2fdb00b39eb6609ceff27bee547
+  data.tar.gz: b9d7638fef93303019696f2c8d4da1a45307d95fdf7461887fa71602fc113756
+SHA512:
+  metadata.gz: 1f69f63a8618283b016548e9d50b47e5b66e6bc2614f9f406beceeafb3839a76b082627a5f447a32e496b9c6283e9d92b6051f2251b0ed136241fdb33dbc530c
+  data.tar.gz: 9c73bd76dc3b88d31114967ecd3a1dcb1033ce9003b9870891ed323f5bb6598f6536dd47cf74bc172b0b6bf481ee04acf30f7b324be89a6324dda7a1484d431b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/config.yml
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hi@ajvillalobos.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in binance_client.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    binance_client-ruby (0.1.0)
+      activesupport
+      api_client_base
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    api_client_base (1.9.0)
+      activesupport (>= 3.0)
+      gem_config (>= 0.3.1)
+      virtus (>= 1.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    coderay (1.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.7)
+    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)
+    gem_config (0.3.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binance_client-ruby!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 AJ Villalobos
+
+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,58 @@
+# BinanceClient
+
+This is a ruby api wrapper for [Binance API](https://binance-docs.github.io/apidocs/spot/en/#change-log)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'binance_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install binance_client
+
+## Authenticate
+```
+client = BinanceClient.new(
+    api_key: "your-api-key",
+    api_secret: "your-api-secret"
+)
+```
+
+## Requests
+We provide one method per API endpoint.
+
+### Current methods/endpoints
+
+```
+client.system_status
+client.account_snapshot
+client.get_all
+```
+
+## Responses
+The default representation of response data is a JSON hash
+
+
+## Development
+Edit the `config.yml.sample` with your own credentials for testing
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iamajvillalobos/binance_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/iamajvillalobos/binance_client/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BinanceClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iamajvillalobos/binance_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "binance_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/binance_client.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/binance_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "binance_client-ruby"
+  spec.version       = BinanceClient::VERSION
+  spec.authors       = ["AJ Villalobos"]
+  spec.email         = ["hi@ajvillalobos.com"]
+
+  spec.summary       = "Ruby wrapper for Binance API"
+  spec.description   = "Ruby wrapper for Binance API"
+  spec.homepage      = "https://github.com/iamajvillalobos/binance_client-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/iamajvillalobos/binance_client-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/iamajvillalobos/binance_client-ruby/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "api_client_base"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "typhoeus"
+  
+  spec.add_development_dependency "pry"
+end

data/lib/binance_client.rb

@@ -0,0 +1,31 @@
+require "binance_client/version"
+require "api_client_base"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/to_query"
+require "json"
+require "openssl"
+
+require "binance_client/client"
+
+require "binance_client/requests/base_request"
+require "binance_client/responses/base_response"
+require "binance_client/requests/system_status_request"
+require "binance_client/requests/account_snapshot_request"
+require "binance_client/requests/get_all_request"
+require "binance_client/responses/system_status_response"
+require "binance_client/responses/account_snapshot_response"
+require "binance_client/responses/get_all_response"
+
+module BinanceClient
+  class Error < StandardError; end
+
+  include APIClientBase::Base.module
+
+  DEFAULT_HOST = "https://api.binance.com"
+
+  with_configuration do
+    has :host, classes: String, default: DEFAULT_HOST
+    has :api_key, classes: String
+    has :api_secret, classes: String
+  end
+end

data/lib/binance_client/client.rb

@@ -0,0 +1,19 @@
+module BinanceClient
+  class Client
+    include APIClientBase::Client.module(default_opts: :default_opts)
+
+    api_action :system_status
+    api_action :account_snapshot
+    api_action :get_all
+
+    attribute :host
+    attribute :api_key
+    attribute :api_secret
+
+    private
+
+    def default_opts
+      {host: host, api_key: api_key, api_secret: api_secret}
+    end
+  end
+end

data/lib/binance_client/requests/account_snapshot_request.rb

@@ -0,0 +1,28 @@
+module BinanceClient
+  class AccountSnapshotRequest < BaseRequest
+    private
+
+    def path
+      "/sapi/v1/accountSnapshot"
+    end
+
+    def params
+      type = "SPOT"
+      limit = 30
+      query = query(type: type, limit: limit)
+
+      [
+        query,
+        "signature=#{signature(query)}"
+      ].join("&")
+    end
+
+    def query(options={})
+      [
+        "type=#{options[:type]}",
+        "timestamp=#{timestamp}",
+        "limit=#{options[:limit]}",
+      ].join("&")
+    end
+  end
+end

data/lib/binance_client/requests/base_request.rb

@@ -0,0 +1,27 @@
+module BinanceClient
+  class BaseRequest
+    include APIClientBase::Request.module
+
+    attribute :api_key, String
+    attribute :api_secret, String
+
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "X-MBX-APIKEY" => api_key
+      }
+    end
+
+    def signature(query)
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new("sha256"),
+        api_secret,
+        query,
+      )
+    end
+
+    def timestamp
+      DateTime.now.strftime("%Q")
+    end
+  end
+end

data/lib/binance_client/requests/get_all_request.rb

@@ -0,0 +1,20 @@
+module BinanceClient
+  class GetAllRequest < BaseRequest
+    private
+
+    def path
+      "/sapi/v1/capital/config/getall"
+    end
+
+    def query
+      "timestamp=#{timestamp}"
+    end
+
+    def params
+      [
+        query,
+        "signature=#{signature(query)}"
+      ].join("&")
+    end
+  end
+end

data/lib/binance_client/requests/system_status_request.rb

@@ -0,0 +1,7 @@
+module BinanceClient
+  class SystemStatusRequest < BaseRequest
+    def path
+      "/wapi/v3/systemStatus.html"
+    end
+  end
+end

data/lib/binance_client/responses/account_snapshot_response.rb

@@ -0,0 +1,4 @@
+module BinanceClient
+  class AccountSnapshotResponse < BaseResponse
+  end
+end

data/lib/binance_client/responses/base_response.rb

@@ -0,0 +1,13 @@
+module BinanceClient
+  class BaseResponse
+    include APIClientBase::Response.module
+
+    attribute :body, Object, default: :default_body
+
+    private
+
+    def default_body
+      JSON.parse(raw_response.body)
+    end
+  end
+end

data/lib/binance_client/responses/get_all_response.rb

@@ -0,0 +1,18 @@
+module BinanceClient
+  class GetAllResponse < BaseResponse
+    attribute :body, Object, default: :default_body
+
+    private
+
+    def default_body
+      payload = {}
+      parsed_body = JSON.parse(raw_response.body)
+
+      parsed_body.map do |coin_details|
+        payload[coin_details["coin"]] = coin_details
+      end
+
+      payload
+    end
+  end
+end

data/lib/binance_client/responses/system_status_response.rb

@@ -0,0 +1,21 @@
+module BinanceClient
+  class SystemStatusResponse < BaseResponse
+    attribute :body, Object, default: :default_body
+    attribute :msg, String, lazy: true, default: :default_msg
+    attribute :status, String, lazy: true, default: :default_status
+
+    private
+
+    def default_body
+      JSON.parse(raw_response.body).with_indifferent_access
+    end
+
+    def default_msg
+      body[:msg]
+    end
+
+    def default_status
+      body[:status]
+    end
+  end
+end

data/lib/binance_client/version.rb

@@ -0,0 +1,3 @@
+module BinanceClient
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: binance_client-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AJ Villalobos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: api_client_base
+  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: activesupport
+  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: typhoeus
+  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: 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'
+description: Ruby wrapper for Binance API
+email:
+- hi@ajvillalobos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- binance_client.gemspec
+- lib/binance_client.rb
+- lib/binance_client/client.rb
+- lib/binance_client/requests/account_snapshot_request.rb
+- lib/binance_client/requests/base_request.rb
+- lib/binance_client/requests/get_all_request.rb
+- lib/binance_client/requests/system_status_request.rb
+- lib/binance_client/responses/account_snapshot_response.rb
+- lib/binance_client/responses/base_response.rb
+- lib/binance_client/responses/get_all_response.rb
+- lib/binance_client/responses/system_status_response.rb
+- lib/binance_client/version.rb
+homepage: https://github.com/iamajvillalobos/binance_client-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/iamajvillalobos/binance_client-ruby
+  source_code_uri: https://github.com/iamajvillalobos/binance_client-ruby
+  changelog_uri: https://github.com/iamajvillalobos/binance_client-ruby/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Binance API
+test_files: []