xdr 0.0.4 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bc2054a14c8b40897a81b9758fe8f7d48fa5be07
-  data.tar.gz: 3bddeb7f3628cb88feae1800467e060080b8b942
+SHA256:
+  metadata.gz: cf995b29e360c1ebdc82ee5c94ea470d7d8e87a577263f2faeb8fd3d7fce4a62
+  data.tar.gz: ad232ebcb97bef9e00e9fd1103a37cf87941171e5d6fdb89a38addef8ea1afa6
 SHA512:
-  metadata.gz: b22b70f5094869e0f09d9819b63746eab3416416eb4a7c2128043888e587dc4e7a5e7a7452e9df925d302d9f771883ca72b76615c9588059c15d9fec793ff59d
-  data.tar.gz: 6d8bdbafec1e37e2a6a9ade6d139ebd94cf297277e9ff25b676560d6f1d85f70fd8e7e71123d01170e5fcc09a285253a9ce56c303b1fb4f2d84f08e52082c329
+  metadata.gz: 7026fd132281c4955332ae9acbd4757c1e0d61e29b900139cc24475e8e347381da3c77f04896ea3841a81b790972fc8bc4fa0c79c36922315283921b6c456836
+  data.tar.gz: 9db16c2e581691273a475f6044fcff536accc8a9531c195571b784aaee2534f47409593b54d2c9102072ba9eea8a7871348dbafb789a99eee34e17b3b958d28b

data/.travis.yml

@@ -1,14 +1,9 @@
 language: ruby
 rvm:
-- 2.2.0
-- 2.1.5
-- 2.0.0
-- 1.9.3
-- jruby-1.7.9
-- jruby-head
+- 2.2.6
+- 2.3.3
+- 2.4.0
+- jruby
 notifications:
   slack:
     secure: fXYggrDRoLB/4yvyW0kWwyrV5yWa/GC0btPyGu7Hx6ZOaXDC+ejiXSfx7nRyY+uZBs5UF12O4gkUXwBbnWDT5JtQRxzZd5s0cyeGQfAakALexI+FuR2jDcV1prCCaYI4IYoUt61MlfDmuCYVm8hGZ3qsgk/GPHHPnZ8a1FBd2ls=
-matrix:
-  allow_failures:
-    - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this
+file.  This project adheres to [Semantic Versioning](http://semver.org/).
+
+As this project is pre 1.0, breaking changes may happen for minor version
+bumps.  A breaking change will get clearly notified in this log.
+
+## [Unreleased](https://github.com/stellar/ruby-xdr/compare/v3.0.1...master)
+
+## [3.0.1](https://github.com/stellar/ruby-xdr/compare/v3.0.0...v3.0.1)
+
+
+### Added
+- Add encoding parameter to Union#to_xdr ((#7)[https://github.com/stellar/ruby-xdr/pull/7]).
+
+### Fixed
+- Padding bytes are now properly validated when reading xdr values.  According to the XDR spec, padding must be zeros.
+
+## [1.0.0](https://github.com/stellar/ruby-xdr/compare/v0.1.0...v1.0.0)
+
+### Added
+- the `to_xdr` helpers can take a second parameter that will encode the resulting output to hex or base64 when requested.
+- the `from_xdr` helpers can take a second parameter that will trigger a decode from hex or base64 of the provided string before decoding from xdr.
+
+### Changed
+
+- `from_xdr` raises an ArgumentError when the input data is not fully consumed

data/README.md

@@ -1,5 +1,8 @@
 # XDR, for Ruby
 
+[![Build Status](https://travis-ci.org/stellar/ruby-xdr.svg?branch=master)](https://travis-ci.org/stellar/ruby-xdr)
+[![Code Climate](https://codeclimate.com/github/stellar/ruby-xdr/badges/gpa.svg)](https://codeclimate.com/github/stellar/ruby-xdr)
+
 XDR is an open data format, specified in [RFC 4506](http://tools.ietf.org/html/rfc4506.html).  This library provides a way to read and write XDR data from ruby.  It can read/write all of the primitive XDR types and also provides facilities to define readers for the compound XDR types (enums, structs and unions)
 
 ## Installation

data/lib/xdr.rb

@@ -10,7 +10,6 @@ require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/string/inflections"
 require "active_support/logger"
 require "active_support/ordered_hash"
-require "backports/2.1.0"
 
 module XDR
   extend ActiveSupport::Autoload

data/lib/xdr/concerns/converts_to_xdr.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module XDR::Concerns::ConvertsToXDR
   include XDR::Concerns::ReadsBytes
 
@@ -37,11 +39,19 @@ module XDR::Concerns::ConvertsToXDR
   # @param val [Object] the value to serialize
   # 
   # @return [String] the produced bytes
-  def to_xdr(val)
-    StringIO.
+  def to_xdr(val, encoding='raw')
+    raw = StringIO.
       new.
       tap{|io| write(val, io)}.
       string.force_encoding("ASCII-8BIT")
+
+    case encoding.to_s
+    when 'raw' ; raw
+    when 'base64' ; Base64.strict_encode64(raw)
+    when 'hex' ; raw.unpack("H*").first
+    else
+      raise  ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
+    end
   end
   
   # 
@@ -50,9 +60,23 @@ module XDR::Concerns::ConvertsToXDR
   # @param string [String] the bytes to read from
   # 
   # @return [Object] the deserialized value
-  def from_xdr(string)
-    io = StringIO.new(string)
-    read(io)
+  def from_xdr(string, encoding='raw')
+    raw = case encoding
+          when 'raw' ; string
+          when 'base64' ; Base64.strict_decode64(string)
+          when 'hex' ; [string].pack("H*")
+          else
+            raise  ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
+          end
+
+    io = StringIO.new(raw)
+    result = read(io)
+
+    if io.pos != io.length
+      raise  ArgumentError, "Input string not fully consumed! are you decoding the right xdr type?"
+    end
+
+    result
   end
 
   private
@@ -64,4 +88,4 @@ module XDR::Concerns::ConvertsToXDR
     when 3 ; 1
     end
   end
-end
+end

data/lib/xdr/concerns/reads_bytes.rb

@@ -5,4 +5,12 @@ module XDR::Concerns::ReadsBytes
       raise EOFError if bytes.nil? || bytes.length != length
     end
   end
+
+  def read_zeros(io, length)
+    read_bytes(io, length).each_byte do |byte|
+      raise XDR::ReadError unless byte == 0
+    end
+
+    nil
+  end
 end

data/lib/xdr/dsl/enum.rb

@@ -2,7 +2,7 @@ module XDR::DSL::Enum
 
   def member(name, value)
     raise ArgumentError, "#{self} is sealed" if self.sealed
-    raise ArgumentError, "#{value} is not Fixnum" unless value.is_a?(Fixnum)
+    raise ArgumentError, "#{value} is not Integer" unless value.is_a?(Integer)
     raise ArgumentError, "#{value} is already used" unless 
 
     name = name.to_s.underscore

data/lib/xdr/opaque.rb

@@ -12,7 +12,7 @@ class XDR::Opaque
   def read(io)
     # read and return @length bytes
     # throw away @padding bytes
-    read_bytes(io, @length).tap{ read_bytes(io, @padding) }
+    read_bytes(io, @length).tap{ read_zeros(io, @padding) }
   end
 
   def write(val,io)

data/lib/xdr/string.rb

@@ -31,6 +31,6 @@ class XDR::String
 
     # read and return length bytes
     # throw away padding bytes
-    read_bytes(io, length).tap{ read_bytes(io, padding) }
+    read_bytes(io, length).tap{ read_zeros(io, padding) }
   end
 end

data/lib/xdr/struct.rb

@@ -9,7 +9,7 @@ class XDR::Struct
 
   attribute_method_prefix 'read_'
   attribute_method_suffix 'write_'
-  
+
   class_attribute :fields
   self.fields = ActiveSupport::OrderedHash.new
 
@@ -68,6 +68,14 @@ class XDR::Struct
     other.attributes == self.attributes
   end
 
+  def eql? (other)
+    return false unless other.is_a?(self.class)
+    other.attributes.eql? self.attributes
+  end
+
+  def hash
+    [self.class, self.attributes].hash
+  end
 
   def read_attribute(attr)
     @attributes[attr]

data/lib/xdr/union.rb

@@ -75,8 +75,14 @@ class XDR::Union
     set(switch, value) unless switch == :__unset__
   end
 
-  def to_xdr
-    self.class.to_xdr self
+  #
+  # Serializes struct to xdr, return a string of bytes
+  #
+  # @param format=:raw [Symbol] The encoding used for the bytes produces, one of (:raw, :hex, :base64)
+  #
+  # @return [String] The encoded bytes of this struct
+  def to_xdr(format=:raw)
+    self.class.to_xdr(self, format)
   end
 
   def set(switch, value=:void)
@@ -114,6 +120,16 @@ class XDR::Union
     other.value == self.value
   end
 
+  def eql?(other)
+    return false unless other.is_a?(self.class)
+    return false unless other.switch.eql? self.switch
+    other.value.eql? self.value
+  end
+  
+  def hash
+    [self.class, self.switch, self.value].hash
+  end
+
   private
   def valid_for_arm_type(value, arm)
     arm_type = arms[@arm]

data/lib/xdr/var_opaque.rb

@@ -31,6 +31,6 @@ class XDR::VarOpaque
 
     # read and return length bytes
     # throw away padding bytes
-    read_bytes(io, length).tap{ read_bytes(io, padding) }
+    read_bytes(io, length).tap{ read_zeros(io, padding) }
   end
 end

data/lib/xdr/version.rb

@@ -1,3 +1,3 @@
 module XDR
-  VERSION = "0.0.4"
+  VERSION = "3.0.1"
 end

data/spec/lib/xdr/concerns/converts_to_xdr_spec.rb

@@ -23,14 +23,47 @@ describe XDR::Concerns::ConvertsToXDR, "#to_xdr" do
     expect(subject).to receive(:write).with("hiya", kind_of(StringIO))
     subject.to_xdr("hiya")
   end
+
+  context "using an actual xdr type" do
+    subject{ XDR::Opaque.new(4) }
+
+    it "encodes to hex" do
+      r = subject.to_xdr("\x00\x01\x02\x03", "hex")
+      expect(r).to eql("00010203")
+    end
+
+    it "encodes to base64" do
+      r = subject.to_xdr("\x00\x01\x02\x03", "base64")
+      expect(r).to eql("AAECAw==")
+    end
+  end
 end
 
 describe XDR::Concerns::ConvertsToXDR, "#from_xdr" do
   subject{ ImplementedConvertible.new }
 
-  it "calls through to write" do
-    expect(subject).to receive(:read).with(kind_of(StringIO))
+  it "calls through to read" do
+    allow(subject).to receive(:read).and_call_original
     subject.from_xdr("hiya")
+    expect(subject).to have_received(:read).with(kind_of(StringIO))
+  end
+
+  context "using an actual xdr type" do
+    subject{ XDR::Opaque.new(4) }
+
+    it "decodes from hex" do
+      r = subject.from_xdr("00010203", "hex")
+      expect(r).to eql("\x00\x01\x02\x03")
+    end
+
+    it "decodes from base64" do
+      r = subject.from_xdr("AAECAw==", "base64")
+      expect(r).to eql("\x00\x01\x02\x03")
+    end
+
+    it "raises an ArgumentError if the input is not fully consumed" do
+      expect{ subject.from_xdr("\x00\x00\x00\x00\x00") }.to raise_error(ArgumentError)
+    end
   end
 end
 
@@ -42,7 +75,7 @@ class ImplementedConvertible
   include XDR::Concerns::ConvertsToXDR
 
   def read(io)
-    read_bytes(4)
+    read_bytes(io, 4)
   end
 
   def write(val, io)
@@ -52,4 +85,4 @@ class ImplementedConvertible
   def valid?(val)
     true
   end
-end
+end

data/spec/lib/xdr/concerns/reads_bytes_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 class TestReader
   include XDR::Concerns::ReadsBytes
   public :read_bytes
+  public :read_zeros
 end
 
 
@@ -28,4 +29,29 @@ describe XDR::Concerns::ReadsBytes, "#read_bytes"  do
     io = StringIO.new(str)
     subject.read_bytes(io, length)
   end
+end
+
+
+describe XDR::Concerns::ReadsBytes, "#read_zeros"  do
+  subject{ TestReader.new }
+
+  it "raises XDR::ReadError when the bytes read do not equal zero" do
+    expect{ read("\x01", 1) }.to raise_error(XDR::ReadError)
+  end
+
+  it "succeeds when all the bytes read are zero" do
+    expect{ read("\x00\x00\x00\x00", 1) }.to_not raise_error
+    expect{ read("\x00\x00\x00\x00", 2) }.to_not raise_error
+    expect{ read("\x00\x00\x00\x00", 3) }.to_not raise_error
+    expect{ read("\x00\x00\x00\x00", 4) }.to_not raise_error
+  end
+
+  it "raises EOFError when the requested length goes beyond the length of the stream" do
+    expect{ read("\x00\x00\x00\x00", 5) }.to raise_error(EOFError)
+  end
+
+  def read(str, length)
+    io = StringIO.new(str)
+    subject.read_zeros(io, length)
+  end
 end

data/spec/lib/xdr/dsl/enum_spec.rb

@@ -15,7 +15,7 @@ describe XDR::DSL::Enum, "#member" do
     expect(subject.members[:two]).to eq(subject.two)
   end
 
-  it "raises ArgumentError if a non-fixnum value is used" do
+  it "raises ArgumentError if a non-integer value is used" do
     expect {
       Class.new(XDR::Enum) do
         member :one, "hi!"

data/spec/lib/xdr/opaque_spec.rb

@@ -9,6 +9,10 @@ describe XDR::Opaque, "#read" do
     expect(read("\x00\x01\x00\x00")).to eq("\x00\x01\x00")
   end
 
+  it "raises a ReadError when the padding isn't zeros" do
+    expect{ read "\x00\x00\x01\x01" }.to raise_error(XDR::ReadError)
+  end
+
   def read(str)
     io = StringIO.new(str)
     subject.read(io)

data/spec/lib/xdr/string_spec.rb

@@ -14,6 +14,12 @@ describe XDR::String, "#read" do
     expect{ read "\x00\x00\x00\x04hiya" }.to raise_error(XDR::ReadError)
   end
 
+  it "raises a ReadError when the padding isn't zeros" do
+    expect{ read "\x00\x00\x00\x01h\x00\x00\x01" }.to raise_error(XDR::ReadError)
+    expect{ read "\x00\x00\x00\x01h\x00\x01\x00" }.to raise_error(XDR::ReadError)
+    expect{ read "\x00\x00\x00\x01h\x01\x00\x00" }.to raise_error(XDR::ReadError)
+  end
+
   def read(str)
     io = StringIO.new(str)
     subject.read(io)

data/spec/lib/xdr/union_spec.rb

@@ -186,6 +186,16 @@ describe XDR::Union, "#switch" do
   end
 end
 
+describe XDR::Union, "#to_xdr" do
+  subject { UnionSpec::Result.new(:error, "spec error") }
+
+  context "with base64 encoding" do
+    it "returns base64 encoding of union's XDR" do
+      expect(subject.to_xdr(:base64)).to eq("AAAAAQAAAApzcGVjIGVycm9yAAA=")
+    end
+  end
+end
+
 module UnionSpec
   class ResultType < XDR::Enum
     member :ok, 0

data/spec/lib/xdr/var_opaque_spec.rb

@@ -15,6 +15,13 @@ describe XDR::VarOpaque, "#read" do
     expect{ read "\x00\x00\x00\x03\x00\x00\x00\x00" }.to raise_error(XDR::ReadError)
   end
 
+
+  it "raises a ReadError when the padding isn't zeros" do
+    expect{ read "\x00\x00\x00\x01\x01\x00\x00\x01" }.to raise_error(XDR::ReadError)
+    expect{ read "\x00\x00\x00\x01\x01\x00\x01\x00" }.to raise_error(XDR::ReadError)
+    expect{ read "\x00\x00\x00\x01\x01\x01\x00\x00" }.to raise_error(XDR::ReadError)
+  end
+
   def read(str)
     io = StringIO.new(str)
     subject.read(io)

data/xdr.gemspec

@@ -11,17 +11,16 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{XDR Helper Library}
   spec.homepage      = "https://github.com/stellar/ruby-xdr"
   spec.license       = "Apache 2.0"
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.add_dependency "activesupport", ">= 5.2.0"
+  spec.add_dependency "activemodel",  ">= 5.2.0"
 
-  spec.add_dependency "activesupport", "~> 4"
-  spec.add_dependency "activemodel", "~> 4"
-  spec.add_dependency "backports", "~> 3.6"
-
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "guard-rspec"

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: xdr
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 3.0.1
 platform: ruby
 authors:
 - Scott Fleckenstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-- !ruby/object:Gem::Dependency
-  name: backports
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +118,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -215,15 +202,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: XDR Helper Library
@@ -254,4 +240,3 @@ test_files:
 - spec/lib/xdr/void_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers/eq_bytes.rb
-has_rdoc: