proto-convert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8dbe2b80d8695940e2103d5739243437284cf4f3ebebff33f101a0381a8ac364
+  data.tar.gz: de4f6515ec0ccc6249887969dd5e75f5045c93bf6ad4121426e2058aca91fc06
+SHA512:
+  metadata.gz: 5ebe5839f579e94d492137a599060aa05607a9c8166b57126a78dbbd397cb460b260aa19ea0c02697cf8a1d2786377a606c5b76de01dfc81b0561c5bf73bb5ee
+  data.tar.gz: e6c4f8a87eff97289c0d4583544c6cbd57b616b9a548a4617e53a60b84394e42c3880ed34bdd68bffc65c8ca7484949224b83955c8b337af7214c2e5d227e816

data/bin/proto-convert

@@ -0,0 +1,193 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2020 Azeem Sajid
+#
+# 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.
+
+# proto-convert
+# A command-line tool to convert protobuf messages from binary to JSON and vice versa
+# GitHub: https://github.com/iamAzeem/proto-convert
+#
+# Developed by Azeem Sajid <azeem.sajid@gmail.com>
+
+require 'optparse'
+require 'English'
+
+VERSION = "#{$PROGRAM_NAME} 0.1.0"
+AUTHOR_NAME = 'Azeem Sajid'
+AUTHOR_EMAIL = 'azeem.sajid@gmail.com'
+AUTHOR_INFO = "Developed by #{AUTHOR_NAME} <#{AUTHOR_EMAIL}>"
+REPO_URL = 'https://github.com/iamAzeem/proto-convert'
+
+def compile_proto(filename)
+  file_path = File.expand_path(filename)
+  file_dir = File.dirname(file_path)
+
+  `protoc --ruby_out.=#{file_dir} --proto_path=#{file_dir} #{file_path}`
+  raise StandardError, "Invalid schema! [#{filename}] Resolve error(s)." unless $CHILD_STATUS.success?
+
+  compiled_proto = file_dir + '/' + File.basename(file_path, '.proto') + '_pb.rb'
+  raise StandardError, "Compiled schema not found! [#{compiled_proto}]" unless File.file?(compiled_proto)
+
+  compiled_proto
+end
+
+def valid_msgtype?(compiled_proto, msg_type)
+  msg_types = []
+  File.foreach(compiled_proto) do |line|
+    if line.lstrip.start_with?('add_message')
+      extracted_msg_type = line[/"([^"]*)"/, 1].freeze # regex: <add_message> 'msg_type' <do>
+      msg_types.push(extracted_msg_type) unless extracted_msg_type.nil?
+    end
+  end
+
+  msg_types.include?(msg_type)
+end
+
+def msg_class(compiled_proto, msg_type)
+  require compiled_proto
+  msg = Google::Protobuf::DescriptorPool.generated_pool.lookup(msg_type)
+  msg.msgclass
+end
+
+def convert(compiled_proto, msg_type, conversion_mode, input_file, output_file)
+  pb_msg_class = msg_class(compiled_proto, msg_type)
+  raise StandardError, "Message type ['#{msg_type}'] not registered!'" if pb_msg_class.nil?
+
+  begin
+    case conversion_mode
+    when :binary2json
+      input_msg = File.open(input_file, 'rb').read
+      puts ">> [B] #{input_file} (#{input_msg.length} bytes)"
+
+      decoded_msg = pb_msg_class.decode(input_msg)
+      output_msg = pb_msg_class.encode_json(decoded_msg)
+
+      File.open(output_file, 'w').write(output_msg)
+      puts "<< [J] #{output_file} (#{output_msg.length} bytes)"
+    when :json2binary
+      input_msg = File.open(input_file, 'r').read
+      puts ">> [J] #{input_file} (#{input_msg.length} bytes)"
+
+      decoded_msg = pb_msg_class.decode_json(input_msg)
+      output_msg = pb_msg_class.encode(decoded_msg)
+
+      File.open(output_file, 'wb').write(output_msg)
+      puts "<< [B] #{output_file} (#{output_msg.length} bytes)"
+    end
+  rescue Google::Protobuf::ParseError
+    raise StandardError, "Incompatible input message! [msgtype: #{msg_type}] #{$ERROR_INFO}"
+  rescue StandardError
+    raise StandardError, "Conversion failed! #{$ERROR_INFO}"
+  end
+end
+
+def start
+  mandatory_args = %i[mode proto msgtype input output].freeze
+
+  options = {}
+  mandatory_args.each { |arg| options[arg] = nil }
+
+  parser = OptionParser.new do |opts|
+    opts.banner = "Usage: #{$PROGRAM_NAME} -m [mode] -p [proto] -t [msgtype] -i [input] -o [output]"
+    opts.separator ''
+
+    modes = %i[binary2json b2j json2binary j2b].freeze
+    opts.on('-m', '--mode [MODE]', modes, "conversion mode #{modes.map(&:to_s)}") do |mode|
+      raise OptionParser::InvalidArgument unless modes.include?(mode)
+
+      if mode == :b2j
+        mode = :binary2json
+      elsif mode == :j2b
+        mode = :json2binary
+      end
+
+      options[:mode] = mode
+    end
+
+    opts.on('-p', '--proto [FILENAME]', 'protobuf schema (.proto)') do |filename|
+      raise StandardError, "Protobuf schema not found! [#{filename}]" unless File.file?(filename)
+
+      options[:proto] = filename
+    end
+
+    opts.on('-t', '--msgtype [TYPE]', 'fully-qualified message type') do |msgtype|
+      options[:msgtype] = msgtype
+    end
+
+    opts.on('-i', '--input [FILENAME]', 'source file (JSON/binary)') do |filename|
+      raise StandardError, "Source/input file not found! [#{filename}]" unless File.file?(filename)
+
+      options[:input] = filename
+    end
+
+    opts.on('-o', '--output [FILENAME]', 'destination file (binary/JSON)') do |filename|
+      options[:output] = filename
+    end
+
+    opts.on('-v', '--version', 'prints version information') do
+      puts "#{VERSION}\n#{AUTHOR_INFO}"
+      puts "GitHub URL: #{REPO_URL}"
+      exit
+    end
+
+    opts.on('-h', '--help', 'prints help') do
+      puts "#{VERSION}\n\n#{opts}\n#{AUTHOR_INFO}"
+      puts "GitHub URL: #{REPO_URL}"
+      exit
+    end
+  end
+
+  begin
+    parser.parse!
+
+    # Validate missing mandatory arguments
+    missing_args = mandatory_args.select { |arg| options[arg].nil? }
+    raise OptionParser::MissingArgument, 'No arguments provided!' if missing_args.length == mandatory_args.length
+    raise OptionParser::MissingArgument, "--#{missing_args.join(', --')}" unless missing_args.empty?
+
+    # Compile and validate proto and msgtype
+    compiled_proto = compile_proto(options[:proto])
+    msg_type = options[:msgtype]
+    raise OptionParser::InvalidArgument, "--msgtype #{msg_type}" unless valid_msgtype?(compiled_proto, msg_type)
+
+    # Convert and write to output file
+    conversion_mode = options[:mode]
+    input_file = options[:input]
+    output_file = options[:output]
+    convert(compiled_proto, msg_type, conversion_mode, input_file, output_file)
+  rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, OptionParser::MissingArgument
+    puts $ERROR_INFO
+    puts "\n#{VERSION}\n\n#{parser}\n#{AUTHOR_INFO}"
+    exit 1
+  rescue LoadError
+    puts "Possible 'import' issue! Use a single self-contianed .proto file! #{$ERROR_INFO}"
+    exit 1
+  rescue StandardError
+    puts "ERROR: #{$ERROR_INFO}"
+    exit 1
+  ensure
+    File.delete(compiled_proto) if !compiled_proto.nil? && File.file?(compiled_proto)
+  end
+end
+
+start

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: proto-convert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Azeem Sajid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+description: A command line tool to convert protobuf messages from binary to JSON
+  and vice versa
+email:
+- azeem.sajid@gmail.com
+executables:
+- proto-convert
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/proto-convert
+homepage: https://github.com/iamAzeem/proto-convert
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Protobuf Message Converter [Binary <-> JSON]
+test_files: []