bridgetown-ib-ruby 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b1a4dcf5b93c877b42a689cc199cf4bcd46cdc7fe79dc1d7d39cb77671e9ce0
+  data.tar.gz: 5066cb22b59f38c87875a114a62297b6d3d3e89ed282f77cca32a5d952b2cdd3
+SHA512:
+  metadata.gz: 232d45f1e452b2c0520db7d83c3cc18f12dd245b0171aad478d76f4c9d789ac78eb74f7de30affbb93df8438fcf4930b7c91a4816f5082e994ae27c299d45670
+  data.tar.gz: a213a3bd5fa50333c1d62585c5e25d8826dca36a2c269bdb1e7d5e6728bc95f4b7f6409ce8c78416f1c2f70ba23f34685e7d7b093fe337da30015021daced9f5

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+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).
+
+## 0.2 - 2023-01-16  
+
+Clarify Readme and push Gem to RubyGems
+
+## 0.1 - 2023-01-11
+
+- First version

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Hartmut Bischoff
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Jared White and Bridgetown Contributors
+
+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,75 @@
+# Bridgetown IB-Ruby  plugin
+
+This plugin enables the interaction with the TWS-API of Interactive Brokers
+
+## Installation
+
+```
+$ bundle add bridgetown-ib-ruby
+```
+
+Then add a file `tws.yml` to the config directory. This is an example:
+
+```
+# TWS/Gateway
+#
+# Its assumed, that the TWS/IbGateway is running on localhost.
+# Enter Port values 
+#  4001/7696  for active accounts
+#  4002/7697 for demo accounts
+---
+get_account_data:  true
+serial_array: false
+port: 4002
+watchlists: 
+ - :Spreads
+ - :Stillhalter
+ - :BuyAndHold 
+:client_id: 2001
+
+```
+
+## Include in the Initializer
+
+The Bridgetown-Initializer parses `config/initializers` for each environment. If the console (`bin/bt c`) is run,
+the file is parsed once. If the development-server is used (`bin/bt s`) the initializer is parsed to render static pages
+and once again in server-mode. We have to prevent the first run:
+
+```ruby 
+# in config/initialisers.rb
+only :server, :console do
+    init :"bridgetown-ib-ruby"
+end
+```
+
+If IB-Ruby-Objects should be present in `server` and `static` mode, **omit the setting of client_id**. Then `IB::Connection`
+connects with an arbitrary client-id and `Bridgetown` runs two instances of the software.
+
+## Access ib-ruby-Objects
+
+`IB::Gateway`-methods are present via `IB::Gateway.current`.  
+To rely on [ib-api](https://github.com/ib-ruby/ib-api) the `IB::Connection`-object is present via `IB::Connection.current`. 
+
+IB::Contracts (IB::Stock,  IB::Option, IB::Future, IB::Forex, ...) and IB::Spreads (IB::Strangle, IB::Straddle, IB::Calendar ...)
+are available.
+IB::Symbols and  Watchlists are present as well as enhanced order-types ( IB::Limit.order, IB::Stop.order ...)
+
+## Limitations
+
+Bridgetown depends on the outdated `terminal-table` Version 1.8. IB-Ruby uses features of 
+the actual version in the `.as_table`-method. This is not available for now. Just use the 
+fallback `.to_human`.
+
+## Additional Infos
+There is a blog entry on [topofocus.de](https://topofocus.de) (in german):  https://topofocus.de/blog/bridgtown-plugin/
+
+
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/bridgetown-activerecord/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown-ib-ruby.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-ib-ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-ib-ruby"
+  spec.version       = BridgetownIbRuby::VERSION
+  spec.author        = "Dr. Hartmut Bischoff"
+  spec.email         = "topofocus@gmail.com"
+  spec.summary       = "Plugin to access the Interactive Brokers TWS-API from Bridgetown"
+  spec.homepage      = "https://github.com/topofocus/bridgetown-ib-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+ # spec.required_ruby_version = ">= 3.1.2"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0.beta4", "< 2.0"
+  spec.add_dependency "ib-api"
+  spec.add_dependency "ib-symbols"
+  spec.add_dependency "ib-extensions"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+end

data/lib/bridgetown-ib-ruby/initializer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'ib-gateway'
+require 'ib/market-price'
+require 'ib/option-chain'
+require 'ib/eod'
+require 'ib/symbols'
+
+module BridgetownIbRuby
+
+  def self.gateway_configuration(config)
+    # Reads a YAML configuration file, evaluating any ERB, then parsing the resulting YAML.
+    ActiveSupport::ConfigurationFile.parse(File.join(config.root_dir, "config", "tws.yml")).merge( logger: log_writer )
+  end
+
+  def self.the_gateway config
+    IB::Gateway.new **BridgetownIbRuby.gateway_configuration(config) do |gw|
+      gw.logger.level =  Logger::INFO
+    end
+  end
+
+  def self.log_writer
+    Bridgetown::LogWriter.new.tap(&:enable_prefix)
+  end
+end
+
+Bridgetown.initializer :"bridgetown-ib-ruby" do | config |
+   begin
+     BridgetownIbRuby.the_gateway( config ) 
+   rescue IB::TransmissionError, Errno::ECONNRESET => e
+     puts "END Through Error"
+   end
+end

data/lib/bridgetown-ib-ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownIbRuby
+  VERSION = "0.2"
+end

data/lib/bridgetown-ib-ruby.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown-ib-ruby/initializer"

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-ib-ruby
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Dr. Hartmut Bischoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0.beta4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0.beta4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ib-api
+  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: ib-symbols
+  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: ib-extensions
+  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: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 
+email: topofocus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-ib-ruby.gemspec
+- lib/bridgetown-ib-ruby.rb
+- lib/bridgetown-ib-ruby/initializer.rb
+- lib/bridgetown-ib-ruby/version.rb
+homepage: https://github.com/topofocus/bridgetown-ib-ruby
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Plugin to access the Interactive Brokers TWS-API from Bridgetown
+test_files: []