xdr 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 567cdbd85c15a73c60ecfc68de35a015bf6cfb2d
-  data.tar.gz: c2f57208097a04173a8785c6a77cb5a489afedf0
+  metadata.gz: b24c48ffd27b5c67a69f0d55cc19e95f647c4523
+  data.tar.gz: 3d5d64c5b6282ad0d780413e553f45a3e60a0c89
 SHA512:
-  metadata.gz: 646b2bb208e5b3edfc1ffa47425d4bde171e3745c9ce2a931da47861f41abc110862477baf62c205086f495eee61f27ec9a6053651aa7afc17152cfd6be742e0
-  data.tar.gz: 46e9164a46f9a91d50b770986618c5ebf0796e5611b773a78c8706d24b9012aab09fe6e117bd583cb185484016d4d4a0186d57a2d57c7644745ebca13ec762a9
+  metadata.gz: 6658735971aa0ed6a7bc21290d83ffd88560846e544cab8f734484d79284fa5cf1cdf4b7947d0bc62f1247f02e10b72044e0ade90e5d389e109a66b7a091b5be
+  data.tar.gz: 99be5a4e551ef005438b802103fdf7038b2a9bb021155cba47597c0fcbd0f5f28b87e62f66ec4ba9e464b008f172e547990008b470ba0d25764675f217341731

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# 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.
+
+## [1.0.0](https://github.com/stellar/ruby-stellar-base/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/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
+    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/version.rb

@@ -1,3 +1,3 @@
 module XDR
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xdr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Scott Fleckenstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt