fix_spec 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- jruby-18mode
+- jruby-19mode
+- jruby-head
+env:
+- JAVA_OPTS=-XX:MaxPermSize=2048m
+
+matrix:
+  allow_failures:
+    - rvm: jruby-18mode

data/CONTRIBUTION_GUIDELINES.md

@@ -0,0 +1,22 @@
+If you come across any issues, please [tell us](https://github.com/connamara/fix_spec/issues).
+Pull requests (with tests) are appreciated. No pull request is too small. Please help with:
+
+* Reporting bugs
+* Suggesting features
+* Writing or improving documentation
+* Fixing typos
+* Cleaning whitespace
+* Refactoring code
+* Adding tests
+* Closing [issues](https://github.com/connamara/fix_spec/issues)
+
+Contributing to fix\_spec:
+
+1. Fork the [official repository](https://github.com/connamara/fix_spec/tree/master).
+2. Make your changes in a topic branch.
+3. Send a pull request.
+
+Notes:
+* If you report a bug and don't include a fix, please include a failing test.
+* Contributions without tests won't be accepted.
+* Please don't update the Gem version

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "json_spec", "~> 1.1.1"
+gem "quickfix-jruby", "~>1.5.3"
+gem "cuke_mem", "~> 0.1.1"
+
+group :development do
+  gem "rspec", "~> 2.14"
+  gem "jeweler", "~> 1.8"
+  gem "cucumber", "~> 1.3"
+  gem "rake", "~> 10.1"
+end

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    cucumber (1.3.6)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    cuke_mem (0.1.1)
+      cucumber (~> 1.3)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    gherkin (2.12.1-java)
+      multi_json (~> 1.3)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0-java)
+    json_spec (1.1.1)
+      multi_json (~> 1.0)
+      rspec (~> 2.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.9)
+    multi_test (0.0.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10-java)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    quickfix-jruby (1.5.3-java)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  cucumber (~> 1.3)
+  cuke_mem (~> 0.1.1)
+  jeweler (~> 1.8)
+  json_spec (~> 1.1.1)
+  quickfix-jruby (~> 1.5.3)
+  rake (~> 10.1)
+  rspec (~> 2.14)

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (C) 2013 Connamara Systems, llc
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/QUICKFIX_LICENSE.txt

@@ -0,0 +1,46 @@
+The QuickFIX Software License, Version 1.0
+ 
+Copyright (c) 2001-2010 quickfixengine.org  All rights
+reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+ 
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in
+   the documentation and/or other materials provided with the
+   distribution.
+
+3. The end-user documentation included with the redistribution,
+   if any, must include the following acknowledgment:
+      "This product includes software developed by
+       quickfixengine.org (http://www.quickfixengine.org/)."
+   Alternately, this acknowledgment may appear in the software itself,
+   if and wherever such third-party acknowledgments normally appear.
+ 
+4. The names "QuickFIX" and "quickfixengine.org" must
+   not be used to endorse or promote products derived from this
+   software without prior written permission. For written
+   permission, please contact ask@quickfixengine.org
+ 
+5. Products derived from this software may not be called "QuickFIX",
+   nor may "QuickFIX" appear in their name, without prior written
+   permission of quickfixengine.org
+ 
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.  IN NO EVENT SHALL QUICKFIXENGINE.ORG OR
+ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,181 @@
+fix\_spec [![Build Status](https://travis-ci.org/connamara/fix_spec.png)](https://travis-ci.org/connamara/fix_spec)
+=========
+
+RSpec matchers and Cucumber step definitions for testing FIX Messages using [json_spec](https://github.com/collectiveidea/json_spec) and [quickfix-jruby](https://github.com/connamara/quickfix-jruby)
+
+Usage
+-----
+
+### RSpec
+
+fix\_spec currently defines two matchers:
+
+* ```be_fix_eql```
+* ```have_fix_path```
+
+The matchers can be used as their counterparts are used in json\_spec
+
+### Cucumber
+
+fix_spec provides Cucumber steps that utilize its RSpec matchers.
+
+In order to us ethe Cucumber steps, in your `env.rb` you must:
+
+```ruby
+require "fix_spec/cucumber"
+```
+
+#### "Should" Assertions
+
+In order to test the contents of a FIX message, you will need to define a `last_fix` method.  This method will be called by fix_spec to grab the FIX message to test. For example, suppose a step aquires a fix message and assigns it to `@my_fix_message`.  In your `env.rb` you could then have
+
+```ruby
+def last_fix
+  @my_fix_message
+end
+```
+
+See [features/support/env.rb](features/support/env.rb) and [features/step_definitions/steps.rb](features/step_definitions/steps.rb) for a very simple implementation.
+
+Now you can use fix_spec steps in your features:
+
+```cucumber
+Feature: New Order
+
+Background:
+
+Given some order message
+
+Scenario: A Market Order is valid
+Then the FIX message type should be "NewOrderSingle"
+Then the FIX should have tag "OrderQty"
+And the FIX message should not have tag "Price"
+And the FIX at "SenderCompID" should be "MY_SENDER"
+
+And the FIX messsage should have the following:
+|SenderCompID | "MY_SENDER" |
+|TargetCompID | "MY_TARGET" |
+|OrderQty     | 123         |
+|OrdType      | "MARKET"    |
+
+And the FIX message should be:
+"""
+{
+  "BeginString":"FIX.4.2",
+  "BodyLength":81,
+  "MsgType":"NewOrderSingle",
+  "SenderCompID":"MY_SENDER",
+  "TargetCompID":"MY_TARGET",
+  "OrdType": "MARKET",
+  "OrderQty": 123,
+  "CheckSum":"083"
+}
+"""
+
+And the FIX message should be:
+"""
+8=FIX.4.2
9-81
35=D
49=MY_SENDER
56=MY_TARGET
40=1
38=123
10=083

+"""
+```
+
+The background step isn't provided by fix_spec.  The remaining steps fix_spec provides. See [features](features/) for more examples.
+
+
+#### Building FIX Messages
+
+In order to use the Cucumber steps for building FIX messages, in your `env.rb` you must:
+
+```ruby
+require "fix_spec/builder"
+```
+Now you can use fix_spec builder steps in your features:
+
+```cucumber
+Feature: Order Adapter accepts Orders
+
+Scenario: It accepts Market Orders
+
+Given I create a FIX.4.2 message of type "NewOrderSingle" 
+And I set the FIX message at "SenderCompID" to "MY_SENDER"
+And I set the FIX message at "TargetCompID" to "MY_TARGET"
+And I set the FIX message at "OrdType" to "MARKET"
+And I set the FIX message at "OrderQty" to 123
+Then I send the message
+```
+
+The built FIX message can be accessed through the `message` function in the ```FIXSpec::Builder``` module.
+
+### Configuration
+
+#### DataDictionary
+
+FIXSpec works best when a DataDictionary is provided.  With a DataDictionary loaded, you can inspect a message with named tags, enumeration, and type specific tag values.
+
+The DataDictionary is globally set:
+
+```ruby
+FIXSpec::data_dictionary = quickfix.DataDictionary.new "config/FIX42.xml"
+```
+
+#### Exclusion
+
+When checking for fix message equality, you may wish to ignore some common fields that are mostly session level.  For example, at an application level, BodyLength and CheckSum can be assumed to be set correctly. Tag exclusion is configured globally via JsonSpec:
+
+```ruby
+JsonSpec.configure do
+  exclude_keys "BodyLength", "CheckSum", "MsgSeqNum"
+end
+```
+
+### More
+
+Check out [specs](spec/) and [features](features/) to see all the ways you can use fix_spec.
+
+Install
+-------
+
+```shell
+gem install fix_spec
+```
+
+or add the following to Gemfile:
+```ruby
+gem 'fix_spec'
+```
+and run `bundle install` from your shell.
+
+More Information
+----------------
+
+* [Rubygems](https://rubygems.org/gems/fix_spec)
+* [Issues](https://github.com/connamara/fix_spec/issues)
+* [Connamara Systems](http://connamara.com)
+
+Contributing
+------------
+
+Please see the [contribution guidelines](CONTRIBUTION_GUIDELINES.md).
+
+Credits
+-------
+
+Contributers:
+
+* Chris Busbey
+* Matt Lane
+* Ben Gura
+
+![Connamara Systems](http://www.connamara.com/images/home-connamara-logo-lg.png)
+
+fix_spec is maintained and funded by [Connamara Systems, llc](http://connamara.com).
+
+The names and logos for Connamara Systems are trademarks of Connamara Systems, llc.
+
+Licensing
+---------
+
+fix_spec is Copyright © 2013 Connamara Systems, llc. 
+
+This software is available under the GPL and a commercial license.  Please see the [LICENSE](LICENSE.txt) file for the terms specified by the GPL license.  The commercial license offers more flexible licensing terms compared to the GPL, and includes support services.  [Contact us](mailto:info@connamara.com) for more information on the Connamara commercial license, what it enables, and how you can start commercial development with it.
+
+This product includes software developed by quickfixengine.org ([http://www.quickfixengine.org/](http://www.quickfixengine.org/)). Please see the [QuickFIX Software LICENSE](QUICKFIX_LICENSE.txt) for the terms specified by the QuickFIX Software License.

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require "rspec/core/rake_task"
+require 'cucumber/rake/task'
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = %w{--color --format pretty}
+end
+
+task :test => [:spec,:cucumber]
+task :default => :test
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "fix_spec"
+  gem.homepage = "http://github.com/connamara/fix_spec"
+  gem.license = "GPL"
+  gem.summary = %Q{Build and Inspect FIX Messages}
+  gem.description = %Q{Build and Inspect FIX Messages with RSpec and Cucumber steps}
+  gem.email = "info@connamara.com"
+  gem.authors = ["Chris Busbey"]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/features/builder.feature

@@ -0,0 +1,148 @@
+@with_data_dictionary
+Feature: Building Fix Messages
+
+@ignore_length_and_checksum
+Scenario: Building via raw fix
+Given the following unvalidated fix message: 
+"""
+8=FIX.4.2
35=8
49=ITG
56=SILO
205=4
315=8
6=100.25
410=50.25
424=23.45
411=Y
43=N
40=1
5=N

+"""
+When I get the fix message
+
+Then the FIX message should be:
+"""
+{
+  "BeginString":"FIX.4.2",
+  "MsgType":"ExecutionReport",
+  "SenderCompID":"ITG",
+  "TargetCompID":"SILO",
+  "MaturityDay":4,
+  "DayOrderQty": 23.45,
+  "ExchangeForPhysical": true,
+  "AvgPx": 100.25,
+  "OrdType": "MARKET",
+  "PossDupFlag": false,
+  "AdvTransType": "NEW",
+  "UnderlyingPutOrCall": 8,
+  "WtAverageLiquidity":50.25
+}
+"""
+
+Scenario: Building from scratch
+
+Given I create a fix message
+And I set the FIX message at "BeginString" to "FIX.4.2" 
+And I set the FIX message at "MsgType" to "ExecutionReport"
+And I set the FIX message at "SenderCompID" to "ITG"
+And I set the FIX message at "TargetCompID" to "SILO"
+And I set the FIX message at "MaturityDay" to 4
+And I set the FIX message at "DayOrderQty" to 23.45
+And I set the FIX message at "ExchangeForPhysical" to true
+And I set the FIX message at "AvgPx" to 100.25
+And I set the FIX message at "OrdType" to "MARKET"
+And I set the FIX message at "PossDupFlag" to false
+
+When I get the fix message
+Then the fix message should be:
+"""
+{
+  "BeginString":"FIX.4.2",
+  "MsgType":"ExecutionReport",
+  "SenderCompID":"ITG",
+  "TargetCompID":"SILO",
+  "MaturityDay":4,
+  "DayOrderQty": 23.45,
+  "ExchangeForPhysical": true,
+  "AvgPx": 100.25,
+  "OrdType": "MARKET",
+  "PossDupFlag": false
+}
+"""
+
+Scenario: Building a message of some type
+Given I create a fix message of type "ExecutionReport"
+And I set the FIX message at "BeginString" to "FIX.4.2" 
+And I set the FIX message at "SenderCompID" to "ITG"
+And I set the FIX message at "TargetCompID" to "SILO"
+And I set the FIX message at "MaturityDay" to 4
+And I set the FIX message at "DayOrderQty" to 23.45
+And I set the FIX message at "ExchangeForPhysical" to true
+And I set the FIX message at "AvgPx" to 100.25
+And I set the FIX message at "OrdType" to "MARKET"
+And I set the FIX message at "PossDupFlag" to false
+
+When I get the fix message
+Then the fix message should be:
+"""
+{
+  "BeginString":"FIX.4.2",
+  "MsgType":"ExecutionReport",
+  "SenderCompID":"ITG",
+  "TargetCompID":"SILO",
+  "MaturityDay":4,
+  "DayOrderQty": 23.45,
+  "ExchangeForPhysical": true,
+  "AvgPx": 100.25,
+  "OrdType": "MARKET",
+  "PossDupFlag": false
+}
+"""
+
+
+Scenario: Building a message of some type and version
+
+Given I create a FIX.4.2 message of type "ExecutionReport" 
+And I set the FIX message at "SenderCompID" to "ITG"
+And I set the FIX message at "TargetCompID" to "SILO"
+And I set the FIX message at "MaturityDay" to 4
+And I set the FIX message at "DayOrderQty" to 23.45
+And I set the FIX message at "ExchangeForPhysical" to true
+And I set the FIX message at "AvgPx" to 100.25
+And I set the FIX message at "OrdType" to "MARKET"
+And I set the FIX message at "PossDupFlag" to false
+
+When I get the fix message
+Then the fix message should be:
+"""
+{
+  "BeginString":"FIX.4.2",
+  "MsgType":"ExecutionReport",
+  "SenderCompID":"ITG",
+  "TargetCompID":"SILO",
+  "MaturityDay":4,
+  "DayOrderQty": 23.45,
+  "ExchangeForPhysical": true,
+  "AvgPx": 100.25,
+  "OrdType": "MARKET",
+  "PossDupFlag": false
+}
+"""
+
+
+Scenario: Setting message fields via table
+Given I create the following FIX.4.2 message of type "ExecutionReport": 
+|SenderCompID         | "ITG"     |
+|TargetCompID         | "SILO"    |
+|MaturityDay          | 4         |
+|DayOrderQty          | 23.45     |
+|ExchangeForPhysical  | true      |
+|AvgPx                | 100.25    |
+|OrdType              | "MARKET"  |
+|PossDupFlag          | false     |
+
+When I get the fix message
+Then the fix message should be:
+"""
+{
+  "BeginString":"FIX.4.2",
+  "MsgType":"ExecutionReport",
+  "SenderCompID":"ITG",
+  "TargetCompID":"SILO",
+  "MaturityDay":4,
+  "DayOrderQty": 23.45,
+  "ExchangeForPhysical": true,
+  "AvgPx": 100.25,
+  "OrdType": "MARKET",
+  "PossDupFlag": false
+}
+"""

data/features/equivalence.feature

@@ -0,0 +1,52 @@
+Feature: Equivalence
+
+Background:
+Given the following unvalidated fix message: 
+"""
+8=FIX.4.2
35=8
49=ITG
56=SILO
205=4

+"""
+And I get the fix message
+
+Scenario: Identical Fix as JSON
+Then the FIX message should be:
+"""
+{
+  "8":"FIX.4.2",
+  "9":"26",
+  "35":"8",
+  "49":"ITG",
+  "56":"SILO",
+  "205":"4",
+  "10":"084"
+}
+"""
+
+Scenario: Identical Fix as raw FIX
+Then the FIX message should be:
+"""
+8=FIX.4.2
9=26
35=8
49=ITG
56=SILO
205=4
10=084

+"""
+
+#check sum and msg length are optional when using raw fix
+Then the FIX message should be:
+"""
+8=FIX.4.2
35=8
49=ITG
56=SILO
205=4

+"""
+
+
+Scenario: String
+Then the FIX at "49" should be "ITG"
+
+And the fix message at tag "49" should be:
+"""
+"ITG"
+"""
+And the FIX at "49" should not be "blah"
+
+#everything is a string w/o a data dictionary
+And the FIX at tag "205" should be "4"
+
+Scenario: Table format
+Then the fix should have the following:
+| 35  | "8"       |
+| 8   | "FIX.4.2" |