byteman 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f97c79daebb65b447178abe2eb39be01d98583d0f813cd60a92cd2b6172d4f31
+  data.tar.gz: a700e4f59a8621fb2c6b9289e42db7ce4715cf897ae487dc2b0ca9021be0d3f5
+SHA512:
+  metadata.gz: 11117098c87ef66779236692bb2c8dcda4e2225fffe56afbdb606a6467a943e3fab2d77f53cceec083e10878b4913c1b649ef619b2f605d7a1d16f9865e37f9c
+  data.tar.gz: 054cda5e6c527b0ef81032eedb80efd68c50636ffab2fbe68b9153838585b33c55c938fe94cb6e16458d367aa44b2a16302674e30932db55b33c83a670bbc01a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# 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 micah.shute@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 [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,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in byteman.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "pry", "~> 0.13.1", group: :development

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    byteman (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.2)
+    method_source (1.0.0)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byteman!
+  pry (~> 0.13.1)
+  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 micahshute
+
+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,72 @@
+# Byteman
+
+Simple gem to allow manipulation of data into other forms. Specifically, transform data between byte buffers (integer arrays with every number representing a byte ie an integer from 0-255), hexdigest strings, hex strings, and integers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'byteman'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install byteman
+
+## Usage
+
+See spec for most examples. Usage is relatively simple. For example, the `.hex` method can transform hexdigest strings, byte arrays, and integers into its corresponding hex string. For example: 
+
+```ruby
+Byteman.hex(123456) #=> "\x01\xE2@"
+Byteman.hex([92, 123, 1, 209]) #=> "\\{\x01\xD1"
+```
+
+You can pad your numbers to a specific byte length or bit length using the `.pad` method: 
+
+```ruby
+Byteman.pad(num: [43,223], len: 4) #=> [0,0,43, 223]
+Byteman.pad(num: 1234, len: 4) #=> "\x00\x00\x04\xD2"
+Byteman.pad(num: "\xE3\x09", len: 8) #=> "\x00\x00\x00\x00\x00\x00\xE3\x09"
+Byteman.pad(num: 42, len: 8, type: :bits) #=> "00101010"
+Byteman.pad(num: "11001", len: 16, type: :bits) #=> "0000000000011001"
+```
+And there are more methods to facilitate easy manipulation of bytestreams. All are documented with rdoc and are tested in the spec folder. Some of these methods are:
+
+`.digest2buf`, which turns a hexdigest string into a byte buffer:
+```ruby
+Byteman.digest2buf("68656c6c6f20776f726c64") #=> [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]
+```
+
+`.digest2int`, which turns a hexdigest string into an integer:
+```ruby
+Byteman.digest2int("168656c6c6f20776f726c64") #=> 435692254137895873546447972
+
+```
+
+And similar methods such as `.hexdigest`, `.buf2int`, etc. 
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/byteman. 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/[USERNAME]/byteman/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 Byteman project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/byteman/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "opens interactive console for this program"
+task :console do 
+    require 'pry'
+    require_relative('./lib/byteman')
+    Pry.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "byteman"
+
+# 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/byteman.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/byteman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "byteman"
+  spec.version       = Byteman::VERSION
+  spec.authors       = ["micahshute"]
+  spec.email         = ["micah.shute@gmail.com"]
+
+  spec.summary       = %q{Easily manipulate and transform data into different forms (e.g. byte strings, byte array buffers, hexdigests)}
+  spec.description   = %q{Allows simple transformation of data into hex strings, hexdigest strings, integer byte arrays, etc. as well as padding your data to a certain byte length}
+  spec.homepage      = "https://github.com/micahshute/byteman"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/micahshute/byteman"
+  spec.metadata["changelog_uri"] = "https://github.com/micahshute/byteman"
+
+  # 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"]
+end

data/lib/byteman.rb

@@ -0,0 +1,196 @@
+require "byteman/version"
+
+## 
+# A simple module with methods that allow easy manipulation of data into other forms.
+# Specifically focused on bytes, digests, and integer byte arrays (buffers)
+
+
+module Byteman
+  ##
+  # A simple module with methods to allow you to easily manipulate
+  # data into different forms, such as strings and numbers to their hex digests,
+  # and back again, digests, numbers, and byte buffers into their bytes,
+  # padding 
+    
+
+  # pad args
+  #
+  # num: (named) [Array or Integer or String] Accepts an array of integers representing bytes (0-255), or an integer of any size (less than the pad size), or a byte string
+  #
+  # len: (named) [Integer] The number of bytes you want to pad this number to 
+  #
+  # type: (named) [Symbol] (default: :bytes) Determines if you are padding bytes or bits. Defaults to :bytes, also accepts :bits
+  # 
+  # Note that this pads 0s to the front of the number, and returns a byte string if an integer or string is the input arg, and returns an array buffer if an array buffer is entered
+  #
+  # Unexpected results will occur if the number is greater than the number of total padded byte length
+  def self.pad(num: nil, len: , type: :bytes, lsb: false)
+    raise ArgumentError.new("Type must be :bytes or :bits") if type != :bytes && type != :bits
+    if type == :bytes
+      if num.is_a?(Array)
+        overflow = len - num.length
+        if overflow == 0
+          return num
+        elsif overflow < 0
+          return num[(num.length - len)..-1]
+        else
+          if lsb
+            return num + ([0] * overflow)
+          else
+            return [0] * overflow + num
+          end
+        end
+      elsif num.is_a?(Integer)
+        hex(pad(num: int2buf(num), len: len, lsb: lsb))
+      elsif num.is_a?(String)
+        pad(num: num.unpack("C*"), len: len, lsb: lsb).pack("C*")
+      else
+        raise ArgumentError.new("Num must be a Array, Integer, or ByteString")
+      end
+    else
+      if num.is_a?(Integer)
+        bin_num = num.to_s(2)
+      elsif num.is_a?(String) && num.split('').all?{ |n| n == "0" || n == "1"}
+        bin_num = num
+      else
+        raise ArgumentError("If performing bit padding, the input must be an Integer or a string of bits")
+      end
+      overflow = len - bin_num.length 
+      if overflow == 0
+        return bin_num
+      elsif overflow < 0
+        return bin_num[(bin_num.length - len)..-1]
+      else
+        if lsb
+          padded = bin_num + "0" * overflow 
+          return padded
+        else
+          padded = "0" * overflow + bin_num
+          return padded
+        end
+      end
+    end
+  end
+
+
+  # str2digest args
+  #
+  # str: [String] the string whose bytes will be turned into a hexdigest representation of the data
+  #
+  # Returns a hexdigest string
+  def self.str2digest(str)
+    str.bytes.map do |b| 
+      hexdigest(b)
+    end.join('')
+  end
+
+  # digest2buf args
+  # 
+  # dig: [String] a string hexdigest that will be turned into an array of the represented bytes (the array will be half the length of the number of characters in the digest)
+  # 
+  # Returns an integer array representing the bytes of the hexdigest
+  def self.digest2buf(dig)
+    hex2buf(hex(dig))
+  end
+
+  # hex2buf args
+  #
+  # hex: [String] hex string
+  #
+  # Returns an array of Integers, each representing a byte of data
+  def self.hex2buf(hex)
+    hex.unpack("C*")
+  end
+
+  # digest2int args
+  # 
+  # dig: [String] hexdigest string
+  # 
+  # Returns a byte String half the length of the hexdigest
+  def self.digest2int(dig)
+    dig.to_i(16)
+  end
+
+  # hex args
+  # 
+  # input: [Integer or String or Array] accepts any Integer, or a hexdigest String or an integer array (byte buffer) with all numbers between 0-255 inclusive
+  # 
+  # Returns a byte String. 
+  # 
+  # Note -> Automatically pads a 0 nibble to the front of any odd-lengthed hexdigest
+  def self.hex(input)
+    if input.is_a?(Integer)
+      hex(hexdigest(input))
+    elsif input.is_a?(String)
+      hd = input.length.odd? ? "0#{input}" : input
+      [hd].pack("H*")
+    elsif input.is_a?(Array)
+      input.pack("C*")
+    else
+      raise ArgumentError.new("Input must be a string, number, or byte array buffer")
+    end
+  end
+
+  # hexdigest args
+  # 
+  # arg: [Integer or String or Array] accepts any Integer or String or Array of Integers from 0-255 
+  # 
+  # Returns a hexdigest string
+  def self.hexdigest(arg)
+    if arg.is_a?(Integer)
+      dig = arg.to_s(16)
+      dig.length.odd? ? "0#{dig}" : dig
+    elsif arg.is_a?(Array) && arg.all?{|a| a.between?(0,255)}
+      buf2digest(arg)
+    elsif arg.is_a?(String)
+      arg.unpack("H*").first
+    else
+      raise ArgumentError.new("Input must be an integer, Array of integers between 0-255, or String")
+    end
+  end
+
+  # buf2digest args
+  # 
+  # barr: [Array] accepts an integer array (ints between 0-255 inclusive)
+  # 
+  # Returns a hexdigest string
+  def self.buf2digest(barr)
+    barr.pack("C*").unpack("H*").first
+  end
+
+  # buf2hex args
+  # 
+  # barr: [Array] accepts an integer array (ints between 0-255 inclusive)
+  # 
+  # Returns a byte String 
+  def self.buf2hex(barr)
+    barr.pack("C*")
+  end
+
+  # buf2int args
+  # 
+  # barr: [Array] accepts an integer array (ints between 0-255 inclusive)
+  # 
+  # Returns the Integer represeted by the byte array buffer
+  def self.buf2int(barr)
+    buf2digest(barr).to_i(16)
+  end
+
+  # int2buf args
+  # 
+  # num: [Integer] any integer
+  # 
+  # Returns an array of Integers between 0-255 inclusive, representing the byte buffer array
+  def self.int2buf(num)
+    hex(num).bytes
+  end
+
+  # hex2int args
+  # 
+  # hex: [String] 
+  # 
+  # Returns the integer represented by the inputted hex string
+  def self.hex2int(hex)
+    hex.unpack("H*").first.to_i(16)
+  end
+end

data/lib/byteman/version.rb

@@ -0,0 +1,3 @@
+module Byteman
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: byteman
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- micahshute
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies: []
+description: Allows simple transformation of data into hex strings, hexdigest strings,
+  integer byte arrays, etc. as well as padding your data to a certain byte length
+email:
+- micah.shute@gmail.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
+- byteman.gemspec
+- lib/byteman.rb
+- lib/byteman/version.rb
+homepage: https://github.com/micahshute/byteman
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/micahshute/byteman
+  source_code_uri: https://github.com/micahshute/byteman
+  changelog_uri: https://github.com/micahshute/byteman
+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: Easily manipulate and transform data into different forms (e.g. byte strings,
+  byte array buffers, hexdigests)
+test_files: []