payshares-xdr 0.0.2

data/spec/lib/xdr/hyper_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+
+describe XDR::Hyper, ".read" do
+
+  it "decodes values correctly" do
+    expect(read("\x00\x00\x00\x00\x00\x00\x00\x00")).to eq(0)
+    expect(read("\x00\x00\x00\x00\x00\x00\x00\x01")).to eq(1)
+    expect(read("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF")).to eq(-1)
+    expect(read("\x7F\xFF\xFF\xFF\xFF\xFF\xFF\xFF")).to eq(2**63 - 1)
+    expect(read("\x80\x00\x00\x00\x00\x00\x00\x00")).to eq(-(2**63))
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end
+
+describe XDR::Hyper, ".write" do
+
+  it "decodes values correctly" do
+    expect(write 0).to eq_bytes("\x00\x00\x00\x00\x00\x00\x00\x00")
+    expect(write 1).to eq_bytes("\x00\x00\x00\x00\x00\x00\x00\x01")
+    expect(write -1).to eq_bytes("\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF")
+    expect(write 2**63 - 1).to eq_bytes("\x7F\xFF\xFF\xFF\xFF\xFF\xFF\xFF")
+    expect(write -(2**63)).to eq_bytes("\x80\x00\x00\x00\x00\x00\x00\x00")
+  end
+
+  it "raises WriteError when an Integer isn't passed" do
+    expect{ write 1.0 }.to raise_error(XDR::WriteError)
+    expect{ write "hi" }.to raise_error(XDR::WriteError)
+  end
+
+  def write(val)
+    io = StringIO.new()
+    subject.write(val, io)
+    io.string
+  end
+end

data/spec/lib/xdr/int_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+
+describe XDR::Int, ".read" do
+
+  it "decodes values correctly" do
+    expect(read("\x00\x00\x00\x00")).to eq(0)
+    expect(read("\x00\x00\x00\x01")).to eq(1)
+    expect(read("\xFF\xFF\xFF\xFF")).to eq(-1)
+    expect(read("\x7F\xFF\xFF\xFF")).to eq(2**31 - 1)
+    expect(read("\x80\x00\x00\x00")).to eq(-(2**31))
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end
+
+describe XDR::Int, ".write" do
+
+  it "decodes values correctly" do
+    expect(write 0).to eq_bytes("\x00\x00\x00\x00")
+    expect(write 1).to eq_bytes("\x00\x00\x00\x01")
+    expect(write -1).to eq_bytes("\xFF\xFF\xFF\xFF")
+    expect(write 2**31 - 1).to eq_bytes("\x7F\xFF\xFF\xFF")
+    expect(write -(2**31)).to eq_bytes("\x80\x00\x00\x00")
+  end
+
+  it "raises WriteError when an Integer isn't passed" do
+    expect{ write 1.0 }.to raise_error(XDR::WriteError)
+    expect{ write "hi" }.to raise_error(XDR::WriteError)
+  end
+
+  def write(val)
+    io = StringIO.new()
+    subject.write(val, io)
+    io.string
+  end
+end

data/spec/lib/xdr/opaque_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+
+describe XDR::Opaque, "#read" do
+  subject{ XDR::Opaque.new(3) }
+
+  it "decodes values correctly" do
+    expect(read("\x00\x00\x00\x00")).to eq("\x00\x00\x00")
+    expect(read("\x00\x01\x00\x00")).to eq("\x00\x01\x00")
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end
+
+describe XDR::Opaque, "#write" do
+  subject{ XDR::Opaque.new(3) }
+
+  it "encodes values correctly" do
+    expect(write("123")).to eq("123\x00")
+    expect(write("124")).to eq("124\x00")
+  end
+
+  it "raises a WriteError if the value is not the correct length" do
+    expect{ write("1234") }.to raise_error(XDR::WriteError)
+    expect{ write("12") }.to raise_error(XDR::WriteError)
+  end
+
+  def write(val)
+    io = StringIO.new()
+    subject.write(val, io)
+    io.string
+  end
+end

data/spec/lib/xdr/option_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+
+describe XDR::Option, ".read" do
+  subject{ XDR::Option[XDR::Int] }
+
+  it "decodes values correctly" do
+    expect(read "\x00\x00\x00\x01\x00\x00\x00\x00" ).to eq(0)
+    expect(read "\x00\x00\x00\x00" ).to eq(nil)
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end
+
+describe XDR::Option, ".write" do
+  subject{ XDR::Option[XDR::Int] }
+
+  it "decodes values correctly" do
+    expect(write 0).to eq_bytes("\x00\x00\x00\x01\x00\x00\x00\x00")
+    expect(write nil).to eq_bytes("\x00\x00\x00\x00")
+  end
+
+  it "raises WriteError when the provided value is non-nil bust invalid for the child type" do
+    expect{ write 1.0 }.to raise_error(XDR::WriteError)
+    expect{ write "hi" }.to raise_error(XDR::WriteError)
+  end
+
+  def write(val)
+    io = StringIO.new()
+    subject.write(val, io)
+    io.string
+  end
+end

data/spec/lib/xdr/quadruple_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+
+describe XDR::Quadruple, ".read" do
+  let(:zero){ "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" }
+  it "cannot decode values yet" do
+    expect{ read zero }.to raise_error(NotImplementedError)
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end

data/spec/lib/xdr/rpc/record_reader_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe XDR::RPC::RecordReader, "#read" do
+
+  it "decodes values correctly" do
+    empty_record = read "\x00\x00\x00\x00"
+    last_record  = read "\x80\x00\x00\x02\x00\x00"
+
+    expect(empty_record).to_not be_last
+    expect(empty_record.length).to eq(0)
+    expect(empty_record.content.string).to eq("")
+
+    expect(last_record).to be_last
+    expect(last_record.length).to eq(2)
+    expect(last_record.content.string).to eq("\x00\x00")
+  end
+
+  it "raises EOFError the byte stream isn't large enough" do
+    expect{ read "\x00\x00\x00\x01" }.to raise_error(EOFError)
+    expect{ read "\x00\x00\x00\x08\x00\x00\x00\x01" }.to raise_error(EOFError)
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end

data/spec/lib/xdr/string_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+
+describe XDR::String, "#read" do
+  subject{ XDR::String.new(3) }
+
+  it "decodes values correctly" do
+    expect(read("\x00\x00\x00\x00")).to eq("")
+    expect(read("\x00\x00\x00\x01h\x00\x00\x00")).to eq("h")
+    expect(read("\x00\x00\x00\x02hi\x00\x00")).to eq("hi")
+  end
+
+  it "raises a ReadError when the encoded length is greater than the allowed max" do
+    expect{ read "\x00\x00\x00\x04hiya" }.to raise_error(XDR::ReadError)
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end
+
+describe XDR::String, "#write" do
+  subject{ XDR::String[2] }
+
+  it "encodes values correctly" do
+    expect(write("")).to eq("\x00\x00\x00\x00")
+    expect(write("h")).to eq("\x00\x00\x00\x01h\x00\x00\x00")
+    expect(write("hi")).to eq("\x00\x00\x00\x02hi\x00\x00")
+  end
+
+  it "raises a WriteError when the provided string is too long" do
+    expect{ write "123" }.to raise_error(XDR::WriteError)
+  end
+
+  def write(val)
+    io = StringIO.new()
+    subject.write(val, io)
+    io.string
+  end
+end

data/spec/lib/xdr/struct_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+module StructSpec
+  class SampleError < XDR::Struct
+    attribute :code, XDR::Int
+    attribute :msg,  XDR::String[100]
+  end
+
+
+  # class SampleEnvelope < XDR::Struct
+  #   attribute :body,  XDR::VarOpaque[]
+  #   attribute :sigs,  XDR::VarArray[XDR::Opaque[32]]
+  # end
+
+  # class SampleOptions < XDR::Struct
+  #   attribute :limit,       XDR::Option[XDR::Int]
+  #   attribute :subscribed,  XDR::Option[XDR::Bool]
+  # end
+end
+
+
+describe XDR::Struct, "creation" do
+  let(:args){ {} }
+  subject{ StructSpec::SampleError.new(args) }
+
+  context "with no args" do
+    it "creates an instance" do
+      expect(subject).to be_a(StructSpec::SampleError)
+    end
+  end
+
+  context "with valid args" do
+    let(:args){{code: 3, msg: "It broke!"}}
+
+    it "assigns values correctly" do
+      expect(subject.code).to eq(3)
+      expect(subject.msg).to eq("It broke!")
+    end
+  end
+end
+
+describe XDR::Struct, "attribute assignment" do
+  subject{ StructSpec::SampleError.new }
+
+  it "roundtrips correctly" do
+    expect(subject.code).to be_nil
+    expect(subject.msg).to be_nil
+
+    subject.code = 10
+    subject.msg = "busted"
+
+    expect(subject.code).to eq(10)
+    expect(subject.msg).to eq("busted")
+  end
+end
+
+
+describe XDR::Struct, "valid?"
+describe XDR::Struct, "optional members"
+
+describe XDR::Struct, "#to_xdr" do
+  subject{ StructSpec::SampleError.new({code: 3, msg: "It broke!"}) }
+  let(:result){ subject.to_xdr }
+
+  it "serialized each field in order" do
+    expect(result[0...4]).to eq("\x00\x00\x00\x03")
+    expect(result[4...8]).to eq([9].pack("l>"))
+    expect(result[8..-1]).to eq("It broke!\x00\x00\x00")
+  end
+
+  it "raises an exception if the struct is not valid" do
+    subject.code = nil
+    expect{ result }.to raise_error(XDR::WriteError)
+  end
+
+  it "produces hex" do
+    result = subject.to_xdr(:hex)
+    expect(result).to eq("000000030000000949742062726f6b6521000000")
+  end
+
+  it "produces base64" do
+    result = subject.to_xdr(:base64)
+    expect(result).to eq("AAAAAwAAAAlJdCBicm9rZSEAAAA=")
+  end
+end
+
+
+describe XDR::Struct, ".read" do
+  subject{ StructSpec::SampleError }
+  let(:result){ read "\x00\x00\x00\x01\x00\x00\x00\x0812345678" }
+  it "decodes values correctly" do
+    expect( result ).to be_a(subject)
+    expect( result.code  ).to eq(1)
+    expect( result.msg  ).to eq("12345678")
+  end
+
+  def read(str)
+    io = StringIO.new(str)
+    subject.read(io)
+  end
+end

data/spec/lib/xdr/union_spec.rb

@@ -0,0 +1,248 @@
+require 'spec_helper'
+
+describe XDR::Union, ".read" do
+  
+  subject{ UnionSpec::Result }
+  let(:result){ subject.read(bytes) }
+
+  context "with a void arm encoded" do
+    let(:bytes){ StringIO.new "\x00\x00\x00\x00" }
+
+    it "decodes correctly" do
+      expect(result).to be_a(UnionSpec::Result)
+      expect(result.switch).to eq(UnionSpec::ResultType.ok)
+      expect(result.arm).to be_nil
+      expect(result.get).to be_nil
+    end
+  end
+
+  context "with a non-void arm encoded" do
+    let(:bytes){ StringIO.new "\x00\x00\x00\x01\x00\x00\x00\x0812345678" }
+
+    it "decodes correctly" do
+      expect(result).to be_a(UnionSpec::Result)
+      expect(result.switch).to eq(UnionSpec::ResultType.error)
+      expect(result.arm).to eq(:message)
+      expect(result.get).to eq("12345678")
+      expect(result.message!).to eq("12345678")
+    end
+  end
+
+  context "with a default arm encoded" do
+    let(:bytes){ StringIO.new "\x00\x00\x00\x02" }
+
+    it "decodes correctly" do
+      expect(result).to be_a(UnionSpec::Result)
+      expect(result.switch).to eq(UnionSpec::ResultType.nonsense)
+      expect(result.arm).to be_nil
+      expect(result.get).to be_nil
+    end
+  end
+
+  context "with a switch that is not a member of the switch_type" do
+    let(:bytes){ StringIO.new "\x00\x00\x00\x10" }
+
+    it "raises EnumValueError" do
+      expect{ result }.to raise_error XDR::EnumValueError
+    end
+  end
+
+  context "with a invalid arm encoded" do
+    let(:bytes){ StringIO.new "\x00\x00\x00\x02" }
+    subject{ UnionSpec::UnforfivingResult }
+
+    it "raises InvalidSwitchError" do
+      expect{ result }.to raise_error XDR::InvalidSwitchError
+    end
+  end
+
+end
+
+describe XDR::Union, "#attribute!" do
+  subject{ UnionSpec::Result.new(:ok) }
+
+  it "raises an ArmNotSetError when the attribute requested has not been populated" do
+    expect{ subject.message! }.to raise_error XDR::ArmNotSetError
+  end
+
+  it "returns the underyling value when the arm is populated" do
+    subject.set(:error, "it all went bad")
+    expect(subject.message!).to eq("it all went bad")
+  end
+end
+
+describe XDR::Union, "#set" do
+  subject{ UnionSpec::ManyTypes.new }
+
+  it "sets the underlying member variables correctly" do
+    subject.set(:fixnum, 3)
+    expect(subject.switch).to eq(UnionSpec::Types.fixnum)
+    expect(subject.arm).to eq(:fixnum)
+    expect(subject.value).to eq(3)
+
+    subject.set(:float, 1.0)
+    expect(subject.switch).to eq(UnionSpec::Types.float)
+    expect(subject.arm).to eq(:float)
+    expect(subject.value).to eq(1.0)
+
+    subject.set(:array, [1,2])
+    expect(subject.switch).to eq(UnionSpec::Types.array)
+    expect(subject.arm).to eq(:array)
+    expect(subject.value).to eq([1,2])
+
+    subject.set(:bool, true)
+    expect(subject.switch).to eq(UnionSpec::Types.bool)
+    expect(subject.arm).to eq(:bool)
+    expect(subject.value).to eq(true)
+
+    subject.set(:optional, nil)
+    expect(subject.switch).to eq(UnionSpec::Types.optional)
+    expect(subject.arm).to eq(:optional)
+    expect(subject.value).to eq(nil)
+
+    subject.set(:optional, 3)
+    expect(subject.switch).to eq(UnionSpec::Types.optional)
+    expect(subject.arm).to eq(:optional)
+    expect(subject.value).to eq(3)
+
+    subject.set(:complex, UnionSpec::Result.new(:ok))
+    expect(subject.switch).to eq(UnionSpec::Types.complex)
+    expect(subject.arm).to eq(:complex)
+    expect(subject.value).to be_a(UnionSpec::Result)
+
+    subject.set(:void)
+    expect(subject.switch).to eq(UnionSpec::Types.void)
+    expect(subject.arm).to eq(nil)
+    expect(subject.value).to eq(nil)
+  end
+
+  it "raises InvalidValueError if the value provided is not compatible with the selected arm" do
+    expect{ subject.set(:fixnum, 3.0)   }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:fixnum, "hi")  }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:fixnum, [])    }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:fixnum, true)  }.to raise_error(XDR::InvalidValueError)
+
+    expect{ subject.set(:float, 3)    }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:float, "hi") }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:float, [])   }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:float, true) }.to raise_error(XDR::InvalidValueError)
+
+    expect{ subject.set(:array, 3)    }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:array, "hi") }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:array, 3.0)  }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:array, true) }.to raise_error(XDR::InvalidValueError)
+
+    expect{ subject.set(:bool, 3)    }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:bool, "hi") }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:bool, 3.0)  }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:bool, [])   }.to raise_error(XDR::InvalidValueError)
+
+    expect{ subject.set(:optional, "hi") }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:optional, 3.0)  }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:optional, [])   }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:optional, true) }.to raise_error(XDR::InvalidValueError)
+
+    expect{ subject.set(:complex, 3)    }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:complex, "hi") }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:complex, 3.0)  }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:complex, [])   }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:complex, true) }.to raise_error(XDR::InvalidValueError)
+
+    expect{ subject.set(:void, 3)    }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:void, "hi") }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:void, 3.0)  }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:void, [])   }.to raise_error(XDR::InvalidValueError)
+    expect{ subject.set(:void, true) }.to raise_error(XDR::InvalidValueError)
+  end
+
+  it "raises InvalidSwitchError if the provided switch is not compatible with the switch_type" do
+    expect{ subject.set 4 }.to raise_error(XDR::InvalidSwitchError)
+    expect{ subject.set "hi" }.to raise_error(XDR::InvalidSwitchError)
+    expect{ subject.set UnionSpec::ResultType.ok }.to raise_error(XDR::InvalidSwitchError)
+  end
+
+  context "when the union does not have a default switch" do
+    subject{ UnionSpec::UnforfivingResult.new }
+
+    #TODO
+  end
+end
+
+describe XDR::Union, "#switch" do
+  subject{ UnionSpec::Result.new }
+
+  it "reflects the set switch" do
+    subject.set :ok
+    expect( subject.switch ).to eq(UnionSpec::ResultType.ok)
+    subject.set :error, "broke"
+    expect( subject.switch ).to eq(UnionSpec::ResultType.error)
+    subject.set :nonsense
+    expect( subject.switch ).to eq(UnionSpec::ResultType.nonsense)
+  end
+
+  it "is aliased to the union's switch_name" do
+    subject.set :ok
+    expect( subject.type ).to eq(subject.switch)
+  end
+end
+
+module UnionSpec
+  class ResultType < XDR::Enum
+    member :ok, 0
+    member :error, 1
+    member :nonsense, 2
+
+    seal
+  end
+
+  class Types < XDR::Enum
+    member :fixnum, 0
+    member :float, 1
+    member :array, 2
+    member :bool, 3
+    member :optional, 4
+    member :complex, 5
+    member :void, 6
+
+    seal
+  end
+
+  class Result < XDR::Union
+    switch_on ResultType, :type
+
+    switch ResultType.ok
+    switch ResultType.error, :message
+    switch :default
+
+    attribute :message, XDR::String[]
+  end
+
+  class UnforfivingResult < XDR::Union
+    switch_on ResultType, :type
+
+    switch :ok
+    switch :error, :message
+
+    attribute :message, XDR::String[]
+  end
+
+  class ManyTypes < XDR::Union
+    switch_on Types, :type
+
+    switch Types.fixnum,   :fixnum
+    switch Types.float,    :float
+    switch Types.array,    :array
+    switch Types.bool,     :bool
+    switch Types.optional, :optional
+    switch Types.complex,  :complex
+    switch Types.void
+
+
+    attribute :fixnum,    XDR::Hyper
+    attribute :float,     XDR::Double
+    attribute :array,     XDR::Array[XDR::Int, 2] 
+    attribute :bool,      XDR::Bool
+    attribute :optional,  XDR::Option[XDR::Int]
+    attribute :complex,   Result
+  end
+end