proto-MPS7 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 539138dfb892f130d887e3a887348fe200ec25de
+  data.tar.gz: 94cc084c6ee9aac724773e6ae174f2490a788874
+SHA512:
+  metadata.gz: ab5de42a351f85e10cd8c9decaeda3e1ccf18382a269ba85894c0d4dbd1b5edec64261fecd93c67e95277785617a67338af692a7db8ead4f82462abee5e58f95
+  data.tar.gz: b2391a6e43811484c8c082d9ecafb4366ea34942ebce6d3823720b7919bfa510368b8e572f9e72d0088f8f150c16e266ab57dc4ea370687e0227bd3f64a61330

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.17.1

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 arbonap@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in proto-MPS7.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    proto-MPS7 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    artii (2.1.2)
+    awesome_print (1.8.0)
+    byebug (11.0.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  artii
+  awesome_print
+  bundler (~> 1.17)
+  byebug
+  proto-MPS7!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  thor (= 0.20.0)
+
+BUNDLED WITH
+   1.17.1

data/HOMEWORK.md

@@ -0,0 +1,59 @@
+# Parse a custom protocol format
+
+Your payment processing application must interface with an old-school mainframe format that we've named "MPS7".
+This means consuming a proprietary binary protocol format that no one on your team is familiar with yet.
+
+## Task
+
+You must read in a transaction log, `txnlog.dat`, and parse it according to the
+specification in Notes below.
+
+You must answer the following questions:
+
+* What is the total amount in dollars of debits?
+* What is the total amount in dollars of credits?
+* How many autopays were started?
+* How many autopays were ended?
+* What is balance of user ID 2456938384156277127?
+
+You must supply your source code as part of your answer. Write your code in your
+best programming language.
+
+We will want to compile your code from source and run it, so please include the
+complete instructions for doing so in a COMMENTS file.
+
+## Notes
+
+Because `txnlog.dat` is a binary file, it can't be read by a normal text editor like sublime or vim.
+Instead, you'll need to read it programatically and parse the data you read in from there.
+
+This is how the transaction log is structured:
+
+Header:
+
+| 4 byte magic string "MPS7" | 1 byte version | 4 byte (uint32) # of records |
+
+The header contains the canonical information about how the records should be processed.
+Note: there are fewer than 100 records in `txnlog.dat`.
+
+Record:
+
+| 1 byte record type enum | 4 byte (uint32) Unix timestamp | 8 byte (uint64) user ID |
+
+Record type enum:
+
+* 0x00: Debit
+* 0x01: Credit
+* 0x02: StartAutopay
+* 0x03: EndAutopay
+
+For Debit and Credit record types, there is an additional field, an 8 byte
+(float64) amount in dollars, at the end of the record.
+
+All multi-byte fields are encoded in network byte order.
+
+The first record in the file, when fully parsed, will look something like this:
+
+| Record type | Unix timestamp | user ID             | amount in dollars |
+|-------------|----------------|---------------------|-------------------|
+| 'Debit'     | 1393108945     | 4136353673894269217 | 604.274335557087  |

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Patricia Arbona
+
+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,31 @@
+# Proto::MPS7
+
+Put your Ruby code in the file `lib/proto/MPS7`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+Or install it yourself as:
+
+    $ gem install proto-MPS7
+    $ bin/setup
+
+## Usage
+
+    $ proto_MPS7 txnlog.dat
+
+## 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).
+
+
+
+## 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 Proto::MPS7 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

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 "proto/MPS7"
+
+# 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/exe/proto_MPS7

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "proto/MPS7/version"
+require "proto/MPS7/cli"

data/lib/proto/MPS7.rb

@@ -0,0 +1,2 @@
+require "proto/MPS7/version"
+require "proto/MPS7/cli"

data/lib/proto/MPS7/cli.rb

@@ -0,0 +1,10 @@
+require "byebug"
+require_relative "parser"
+
+  class Cli
+    extend Parser
+
+    puts Parser::BinaryProtocol.ascii
+    @protocol = Parser::BinaryProtocol.new(ARGV)
+    @protocol.open
+  end

data/lib/proto/MPS7/parser.rb

@@ -0,0 +1,76 @@
+require 'csv'
+require "active_support/all"
+require 'active_support/time_with_zone'
+require 'awesome_print'
+
+module Parser
+  class BinaryProtocol
+    attr_accessor :binary_file
+
+    def initialize(argv)
+      @binary_file = argv[0]
+    end
+
+    def self.ascii
+      # the artii gem creates ascii text
+      # this method shells it out
+      `artii proto-MPS7 Parser`
+    end
+
+    # byte_data = contents.bytes.slice(9..-1)
+    # header = ["MPS7", 1, 1191182336]
+    def open
+      contents = File.open("#{binary_file}", 'rb') { |f| f.read }
+      header = contents.unpack("a4CL>")
+
+      data = contents.bytes.slice!(9..-1).pack("C*")
+      index = 0
+      calculations = { :debit => 0,
+                       :credit => 0,
+                       :started_count => 0,
+                       :ended_count => 0,
+                       '2456938384156277127' => 0 }
+
+      while data[index].present?
+        # debit
+        if data[index].unpack("C")[0]  == 0
+          record = data[index..index + 21].unpack("CL>Q>G")
+          puts record
+          # total amount in dollars of debits
+          calculations[:debit] += record[3].to_f
+          # for user ID 2456938384156277127,
+          if record[2] == 2456938384156277127
+            # sum the dollars of debits from the user's total balance
+            calculations['2456938384156277127'] += record[3].to_f
+          end
+          index += 21
+        # credit
+        elsif data[index].unpack("C")[0] == 1
+          record = data[index..index + 21].unpack("CL>Q>G")
+          puts record
+          # total amount in dollars of credits
+          calculations[:credit] += record[3].to_f
+          # for user ID 2456938384156277127,
+          if record[2] == 2456938384156277127
+            # subtract the dollars of credits from the user's total balance
+            calculations['2456938384156277127'] -= record[3].to_f
+          end
+          index += 21
+          # StartAutopay
+        elsif data[index].unpack("C")[0] == 2
+          puts data[index..index + 13].unpack("CL>Q>")
+          # increase the total count of how many times Autopay has been started
+          calculations[:started_count] += 1
+          index += 13
+          # EndAutopay
+        elsif data[index].unpack("C")[0] == 3
+          puts data[index..index + 13].unpack("CL>Q>")
+          # increase the total count of how many times Autopay has been started
+          calculations[:ended_count] += 1
+          index += 13
+        end
+      end
+      calculations
+    end
+  end
+end

data/lib/proto/MPS7/version.rb

@@ -0,0 +1,5 @@
+module Proto
+  module MPS7
+    VERSION = "0.1.0"
+  end
+end

data/proto-MPS7.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "proto/MPS7/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "proto-MPS7"
+  spec.version       = Proto::MPS7::VERSION
+  spec.authors       = ["Patricia Arbona"]
+  spec.email         = ["arbonap@gmail.com"]
+
+  spec.summary       = %q{This gem is a payment processing application that consumes a proprietary binary protocol format named "MPS7", an old-school mainframe format 💻 }
+  spec.description   = %q{Reads in and parses binary transaction log, txnlog.dat, according to the specifications in HOMEWORK.md }
+  spec.homepage      = "https://github.com/arbonap/proto-MPS7"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/arbonap/proto-MPS7"
+    spec.metadata["changelog_uri"] = "https://www.github.com/arbonap/proto-MPS7/changelog"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "artii"
+  spec.add_development_dependency "thor", "0.20.0"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: proto-MPS7
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patricia Arbona
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: byebug
+  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: awesome_print
+  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: artii
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+description: 'Reads in and parses binary transaction log, txnlog.dat, according to
+  the specifications in HOMEWORK.md '
+email:
+- arbonap@gmail.com
+executables:
+- proto_MPS7
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- HOMEWORK.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/proto_MPS7
+- lib/proto/MPS7.rb
+- lib/proto/MPS7/cli.rb
+- lib/proto/MPS7/parser.rb
+- lib/proto/MPS7/version.rb
+- proto-MPS7.gemspec
+- txnlog.dat
+homepage: https://github.com/arbonap/proto-MPS7
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/arbonap/proto-MPS7
+  source_code_uri: https://github.com/arbonap/proto-MPS7
+  changelog_uri: https://www.github.com/arbonap/proto-MPS7/changelog
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: "This gem is a payment processing application that consumes a proprietary
+  binary protocol format named \"MPS7\", an old-school mainframe format \U0001F4BB"
+test_files: []