xdr 0.1.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 567cdbd85c15a73c60ecfc68de35a015bf6cfb2d
-  data.tar.gz: c2f57208097a04173a8785c6a77cb5a489afedf0
+SHA256:
+  metadata.gz: 1f0a7d79379430aafb61eed9de69792863eae9f09d6879b9c45a6dfdf4899423
+  data.tar.gz: 4077d91ba3482d12749dfebfd8af588c8ed8a71ed0ffbc84328752f18bc6099c
 SHA512:
-  metadata.gz: 646b2bb208e5b3edfc1ffa47425d4bde171e3745c9ce2a931da47861f41abc110862477baf62c205086f495eee61f27ec9a6053651aa7afc17152cfd6be742e0
-  data.tar.gz: 46e9164a46f9a91d50b770986618c5ebf0796e5611b773a78c8706d24b9012aab09fe6e117bd583cb185484016d4d4a0186d57a2d57c7644745ebca13ec762a9
+  metadata.gz: '087033c3d5e43816556e6265b76892f64c193764af9342eec0e15e1ff615c2f1bed2ef1900d02fc6cd54afb3e158fe081b1a4b966fba019275d48e6c66cb14ac'
+  data.tar.gz: 01b99345355417827e4087075724186082f713c807612a4ac481a9d84bfefeb6bac31abc9819f0c807ce0d31296f2854dd055f03b4b17c1257c27feb0151e442

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://github.com/stellar/ruby-xdr/compare/v3.0.2...master)
+
+## [3.0.2](https://github.com/stellar/ruby-xdr/compare/v3.0.1...v3.0.2) - 2020-10-20
+### Changed
+- Relax lower bound for ActiveSupport dependency to support usage in Rails 4.2 ((#12)[https://github.com/stellar/ruby-xdr/pull/12])
+
+### Fixed
+- Fix non-bang arm accessors for XDR::Union ((#13)[https://github.com/stellar/ruby-xdr/pull/13])
+- Fix .from_xdr encoding param to accept symbols ((#14)[https://github.com/stellar/ruby-xdr/pull/14])
+
+## [3.0.1](https://github.com/stellar/ruby-xdr/compare/v3.0.0...v3.0.1) - 2020-06-10
+### 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) - 2015-10-02
+### 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
@@ -92,9 +95,11 @@ all of it's children by calling `load_all!` on the module.
 
 ## Code generation
 
-ruby-xdr by itself does not have any ability to parse XDR IDL files and produce a parser for your custom data types.  Instead, that is the responsibility of [xdrgen](http://github.com/stellar/xdrgen).  xdrgen will take your .x files and produce a set of ruby files that target this library to allow for your own custom types.
+ruby-xdr by itself does not have any ability to parse XDR IDL files and produce a parser for your custom 
+data types.  Instead, that is the responsibility of [xdrgen](http://github.com/stellar/xdrgen). `xdrgen` will 
+take your `.x` files and produce a set of ruby files that target this library to allow for your own custom types.
 
-See [ruby-stellar-base](http://github.com/stellar/ruby-stellar-base) for an example (check out the generated directory)
+See [ruby-stellar-base](http://github.com/astroband/ruby-stellar-sdk/tree/master/base/generated) for an example.
 
 ## Contributing
 

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,61 +1,84 @@
+require 'base64'
+
 module XDR::Concerns::ConvertsToXDR
   include XDR::Concerns::ReadsBytes
 
   # 
   # Serialized the provided `val` to xdr and writes it to `io`
-  # 
+  #
+  # @abstract
   # @param val [Object] The object to serialize
-  # @param io [IO] an IO object to write to
-  # 
+  # @param io [#write] an IO object to write to
+  # @return [void]
   def write(val, io)
     raise NotImplementedError, "implement in including class"
   end
 
   # 
   # Reads from the provided IO an instance of the implementing class
-  # @param io [IO] the io to read from
-  # 
+  #
+  # @abstract
+  # @param io [#read] the io to read from
   # @return [Object] the deserialized value
   def read(io)
     raise NotImplementedError, "implement in including class"
   end
 
-  # 
   # Returns true if the value provided is compatible with this serializer class
-  # 
+  #
+  # @abstract
   # @param value [Object] the value to test
-  # 
   # @return [Boolean] true if valid, false otherwise
   def valid?(value)
     raise NotImplementedError, "implement in including class"
   end
-  
-  # 
+
   # Serialized the provided val to xdr, returning a string
   # of the serialized data
   # 
   # @param val [Object] the value to serialize
-  # 
+  # @param encoding [:raw|:hex|:base64] encode the result with specified codec
   # @return [String] the produced bytes
-  def to_xdr(val)
-    StringIO.
-      new.
-      tap{|io| write(val, io)}.
-      string.force_encoding("ASCII-8BIT")
+  def to_xdr(val, encoding = "raw")
+    io = StringIO.new
+    write(val, io)
+    raw = io.string.force_encoding("ASCII-8BIT")
+
+    case String(encoding)
+    when "raw" then raw
+    when "hex" then raw.unpack("H*").first
+    when "base64" then Base64.strict_encode64(raw)
+    else
+      raise ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
+    end
   end
-  
-  # 
+
   # Deserializes an object from the provided string of bytes
-  # 
+  #
   # @param string [String] the bytes to read from
-  # 
+  # @param encoding [:raw|:hex|:base64] decode the input before deserialization
   # @return [Object] the deserialized value
-  def from_xdr(string)
-    io = StringIO.new(string)
-    read(io)
+  def from_xdr(string, encoding = "raw")
+    raw = case String(encoding)
+          when "raw" then string
+          when "hex" then [string].pack("H*")
+          when "base64" then Base64.strict_decode64(string)
+          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
+
   def padding_for(length)
     case length % 4
     when 0 ; 0
@@ -64,4 +87,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

@@ -74,7 +74,7 @@ class XDR::Struct
   end
 
   def hash
-    [self.class, self.attribues].hash
+    [self.class, self.attributes].hash
   end
 
   def read_attribute(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)
@@ -96,14 +102,17 @@ class XDR::Union
 
   alias get value
 
-  def attribute!(attr)
-    if @arm.to_s != attr
-      raise XDR::ArmNotSetError, "#{attr} is not the set arm"
-    end
+  def attribute(attr)
+    return nil unless @arm.to_s == attr
 
     get
   end
 
+  def attribute!(attr)
+    raise XDR::ArmNotSetError, "#{attr} is not the set arm" unless @arm.to_s == attr
+
+    get
+  end
 
   #
   # Compares two unions for equality

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.1.0"
+  VERSION = "3.0.2"
 end

metadata

@@ -1,145 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: xdr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Scott Fleckenstein
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '7.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:
-    - - "~>"
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  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'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '0.19'
+description:
 email:
 - scott@stellar.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+- CHANGELOG.md
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- Gemfile
-- Guardfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- examples/enum.rb
-- examples/struct.rb
-- examples/union.rb
 - lib/xdr.rb
 - lib/xdr/array.rb
 - lib/xdr/bool.rb
@@ -176,38 +141,15 @@ files:
 - lib/xdr/var_opaque.rb
 - lib/xdr/version.rb
 - lib/xdr/void.rb
-- spec/lib/xdr/array_spec.rb
-- spec/lib/xdr/bool_spec.rb
-- spec/lib/xdr/concerns/converts_to_xdr_spec.rb
-- spec/lib/xdr/concerns/reads_bytes_spec.rb
-- spec/lib/xdr/double_spec.rb
-- spec/lib/xdr/dsl/enum_spec.rb
-- spec/lib/xdr/dsl/struct_spec.rb
-- spec/lib/xdr/dsl/union_spec.rb
-- spec/lib/xdr/enum_spec.rb
-- spec/lib/xdr/float_spec.rb
-- spec/lib/xdr/hyper_spec.rb
-- spec/lib/xdr/int_spec.rb
-- spec/lib/xdr/opaque_spec.rb
-- spec/lib/xdr/option_spec.rb
-- spec/lib/xdr/quadruple_spec.rb
-- spec/lib/xdr/rpc/record_reader_spec.rb
-- spec/lib/xdr/string_spec.rb
-- spec/lib/xdr/struct_spec.rb
-- spec/lib/xdr/union_spec.rb
-- spec/lib/xdr/unsigned_hyper_spec.rb
-- spec/lib/xdr/unsigned_int_spec.rb
-- spec/lib/xdr/var_array_spec.rb
-- spec/lib/xdr/var_opaque_spec.rb
-- spec/lib/xdr/void_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/eq_bytes.rb
-- xdr.gemspec
 homepage: https://github.com/stellar/ruby-xdr
 licenses:
-- Apache 2.0
-metadata: {}
-post_install_message: 
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/stellar/ruby-xdr/issues
+  changelog_uri: https://github.com/stellar/ruby-xdr/blob/v3.0.2/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/xdr/3.0.2/
+  source_code_uri: https://github.com/stellar/ruby-xdr/tree/v3.0.2
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,43 +157,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: XDR Helper Library
-test_files:
-- spec/lib/xdr/array_spec.rb
-- spec/lib/xdr/bool_spec.rb
-- spec/lib/xdr/concerns/converts_to_xdr_spec.rb
-- spec/lib/xdr/concerns/reads_bytes_spec.rb
-- spec/lib/xdr/double_spec.rb
-- spec/lib/xdr/dsl/enum_spec.rb
-- spec/lib/xdr/dsl/struct_spec.rb
-- spec/lib/xdr/dsl/union_spec.rb
-- spec/lib/xdr/enum_spec.rb
-- spec/lib/xdr/float_spec.rb
-- spec/lib/xdr/hyper_spec.rb
-- spec/lib/xdr/int_spec.rb
-- spec/lib/xdr/opaque_spec.rb
-- spec/lib/xdr/option_spec.rb
-- spec/lib/xdr/quadruple_spec.rb
-- spec/lib/xdr/rpc/record_reader_spec.rb
-- spec/lib/xdr/string_spec.rb
-- spec/lib/xdr/struct_spec.rb
-- spec/lib/xdr/union_spec.rb
-- spec/lib/xdr/unsigned_hyper_spec.rb
-- spec/lib/xdr/unsigned_int_spec.rb
-- spec/lib/xdr/var_array_spec.rb
-- spec/lib/xdr/var_opaque_spec.rb
-- spec/lib/xdr/void_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/eq_bytes.rb
-has_rdoc: 
+test_files: []