webull 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d1daa5fda4d5eccdcc7740e87cbef4ce22d7a37a1aca6fcfc12a68f046576fc
+  data.tar.gz: 3b13d4f635149fc836a26817f2afb9dcc0fbbd5fde340ccf9b52786f261a271d
+SHA512:
+  metadata.gz: 67087b23ccd5deedeb63af2566201f3141ca27741be7351bd1f8f6ca886a712a5654f3914d671ea39565c1950e4a4dbec876b284fe7709a47f1516ed46652010
+  data.tar.gz: d842d7f77917590e909f293b9302d0b0b4d022400620879c0c67958287c9afec53044c35bcc5538e4cb9b93e0a64b5029a70270627d0090aa3e37d56943461e7

data/.circle-ruby

@@ -0,0 +1,2 @@
+2.7.2
+2.6.6

data/.github/workflows/build.yml

@@ -0,0 +1,44 @@
+name: Build
+on: [pull_request, push]
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: akerl/action-checkout@v2.0.0
+    - name: Install Ruby
+      uses: akerl/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+    - name: Install deps
+      run: bundle install
+    - name: Rake
+      run: bundle exec rake
+    - name: Log in to Rubygems
+      run: 'mkdir -p ~/.gem && echo ":rubygems_api_key: ${RUBY_TOKEN}" > ~/.gem/credentials && chmod 600 ~/.gem/credentials'
+      if: startsWith(github.ref, 'refs/tags/')
+      env:
+        RUBY_TOKEN: ${{ secrets.RUBY_TOKEN }}
+    - name: Release
+      run: bundle exec rake release
+      if: startsWith(github.ref, 'refs/tags/')
+    - name: Notify on success
+      if: success()
+      env:
+        SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+      uses: akerl/github-action-slack-notify-build@v1.1.1
+      with:
+        channel_id: ${{ secrets.SLACK_BOT_CHANNEL }}
+        status: success
+        color: good
+    - name: Notify on failure
+      if: failure()
+      env:
+        SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+      uses: akerl/github-action-slack-notify-build@v1.1.1
+      with:
+        channel_id: ${{ secrets.SLACK_BOT_CHANNEL }}
+        status: failed
+        color: danger
+

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*.gem
+coverage/
+.coveralls.yml
+.bundle
+Gemfile.lock
+spec/.creds

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  goodcop: .rubocop.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Les Aker
+
+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,20 @@
+webull
+=========
+
+[![Gem Version](https://img.shields.io/gem/v/webull.svg)](https://rubygems.org/gems/webull)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
+
+Access the unofficial [Webull](https://webull.com) API to view data about your account.
+
+The API information is derived from [@tedchou12's Python Webull module](https://github.com/tedchou12/webull/).
+
+## Usage
+
+## Installation
+
+    gem install webull
+
+## License
+
+webull is released under the MIT License. See the bundled LICENSE file for details.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+task default: %i[spec rubocop build install]

data/lib/webull.rb

@@ -0,0 +1,20 @@
+##
+# This module provides an interface to Webull's API
+module Webull
+  class << self
+    ##
+    # Insert a helper .new() method for creating a new Account
+
+    def new(*args)
+      self::Account.new(*args)
+    end
+
+    def generate_tokens(*args)
+      self::Authenticator.new(*args).generate_tokens
+    end
+  end
+end
+
+require 'webull/version'
+require 'webull/account'
+require 'webull/authenticator'

data/lib/webull/account.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+
+module Webull
+  ##
+  # Account defines a user account object for the Webull API
+  class Account
+    def initialize(params = {})
+      @tokens = params[:tokens] || raise('API tokens not provided')
+      @udid = params[:udid] || raise('Device ID (udid) not provided')
+    end
+
+    def refresh
+      resp = HTTParty.post(
+        'https://userapi.webull.com/api/passport/refreshToken',
+        query: { refreshToken: @tokens.refresh },
+        headers: headers
+      )
+      raise("Refresh request failed: #{resp.code}") unless resp.success?
+      @tokens = Tokens.from_resp(resp)
+    end
+
+    def account_id
+      return @account_id if @account_id
+      resp = HTTParty.get(
+        'https://tradeapi.webullbroker.com/api/trade/account/getSecAccountList/v4',
+        headers: headers
+      )
+      raise("Account ID request failed: #{resp.code}") unless resp.success?
+      raise("Account ID error received: #{resp['msg']}") unless resp['success']
+      @account_id = resp['data'].first['secAccountId']
+    end
+
+    def orders(params = {})
+      HTTParty.get(
+        'https://tradeapi.webullbroker.com/api/trade/v2/option/list',
+        query: { secAccountId: account_id }.merge(params),
+        headers: headers
+      )
+    end
+
+    private
+
+    def headers
+      {
+        'did' => @udid,
+        'access_token' => @tokens.access,
+        'Accept' => '*/*',
+        'Accept-Encoding' => 'gzip, deflate',
+        'Content-Type' => 'application/json'
+      }
+    end
+  end
+end

data/lib/webull/authenticator.rb

@@ -0,0 +1,95 @@
+require 'userinput'
+require 'httparty'
+require 'digest'
+
+module Webull
+  ##
+  # Tokens object describes a full set of API tokens
+  class Tokens
+    attr_reader :access, :refresh
+
+    def initialize(params = {})
+      @access = params[:access]
+      @refresh = params[:refresh]
+    end
+
+    def self.from_resp(resp)
+      Tokens.new(
+        access: resp['accessToken'],
+        refresh: resp['refreshToken']
+      )
+    end
+  end
+
+  ##
+  # Authenticator generates access/refresh tokens from a username/password
+  class Authenticator
+    attr_reader :udid
+
+    def initialize(udid)
+      @udid = udid
+    end
+
+    def generate_tokens # rubocop:disable Metrics/MethodLength
+      params = {
+        account: username,
+        accountType: 2,
+        deviceId: udid,
+        regionId: 6,
+        grade: 1,
+        pwd: hashed_password,
+        verificationCode: mfa
+      }
+      resp = HTTParty.post(
+        'https://userapi.webull.com/api/passport/login/v3/account',
+        body: params.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+      raise("Login request failed: #{resp.code}") unless resp.success?
+      Tokens.from_resp(resp)
+    end
+
+    private
+
+    def mfa
+      return @mfa if @mfa
+      generate_mfa!
+      @mfa = UserInput.new(
+        message: 'Webull MFA code',
+        validation: /^\d{6}$/
+      ).ask
+    end
+
+    def generate_mfa!
+      HTTParty.get(
+        'https://userapi.webull.com/api/passport/verificationCode/sendCode',
+        query: {
+          account: username,
+          accountType: 2,
+          deviceId: udid,
+          codeType: 5,
+          regionCode: 1
+        }
+      )
+    end
+
+    def username
+      @username ||= UserInput.new(
+        message: 'Webull username',
+        validation: /^.*@.*$/
+      ).ask
+    end
+
+    def password
+      @password ||= UserInput.new(
+        message: 'Webull password',
+        secret: true,
+        validation: /.*/
+      ).ask
+    end
+
+    def hashed_password
+      @hashed_password ||= Digest::MD5.hexdigest("wl_app-a&b@!423^#{password}")
+    end
+  end
+end

data/lib/webull/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+##
+# Set the version
+module Webull
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'webull'

data/spec/webull_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Webull do
+  describe '#new' do
+    it 'creates Account objects' do
+      expect(
+        Webull.new(tokens: 1, udid: 1)
+      ).to be_an_instance_of Webull::Account
+    end
+  end
+end

data/webull.gemspec

@@ -0,0 +1,28 @@
+require 'English'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'webull/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'webull'
+  s.version     = Webull::VERSION
+  s.date        = Time.now.strftime('%Y-%m-%d')
+
+  s.summary     = 'Access the Webull API'
+  s.description = 'Access the Webull API'
+  s.authors     = ['Les Aker']
+  s.email       = 'me@lesaker.org'
+  s.homepage    = 'https://github.com/akerl/webull'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 2.6.0'
+
+  s.files       = `git ls-files`.split
+  s.test_files  = `git ls-files spec/*`.split
+
+  s.add_dependency 'httparty', '~> 0.18.1'
+  s.add_dependency 'userinput', '~> 1.0.2'
+
+  s.add_development_dependency 'codecov', '~> 0.2.12'
+  s.add_development_dependency 'goodcop', '~> 0.9.2'
+  s.add_development_dependency 'rake', '~> 13.0.0'
+  s.add_development_dependency 'rspec', '~> 3.10.0'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: webull
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Les Aker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: userinput
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+- !ruby/object:Gem::Dependency
+  name: goodcop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: Access the Webull API
+email: me@lesaker.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circle-ruby"
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/webull.rb
+- lib/webull/account.rb
+- lib/webull/authenticator.rb
+- lib/webull/version.rb
+- spec/spec_helper.rb
+- spec/webull_spec.rb
+- webull.gemspec
+homepage: https://github.com/akerl/webull
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Access the Webull API
+test_files:
+- spec/spec_helper.rb
+- spec/webull_spec.rb