xdr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d7c88a7dd30a60720917002c7a238a0d1781cc9
+  data.tar.gz: 69c5a15f083799ec2fee989147db3850d9793d9f
+SHA512:
+  metadata.gz: c774093fd14082490eaba91816cc15be1f4682746af971a93ea2325e85190c4b016d6b54965daccc2952967d62801f777139e843f29ec468796e2ecb83370a64
+  data.tar.gz: 6fa471950b0d18e20a7df376e8e0ff478d4000e3e0ff10db78c16c6c7a4ddd9f912ff0172d152d2af1f9beb9dac3f5b7b90fac31f8ad35697e42ae714268ea8b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/generated
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.2.0
+- 2.1.5
+- 2.0.0
+- 1.9.3
+- jruby-1.7.9
+- jruby-head
+notifications:
+  slack:
+    secure: yW9cyABKLeihw2KNiI7h0la2ghnj4aH06md8q1rqXuLZmOz2u2wiThF92vaWVA6xE3MBjEKWMS/qpQAvK7YJBQYZQxUVnLZWGzzt6k2VkMqqmy8gtZR5DhuThrvdVR8r4zOeoBe6NxhQP8lkC/efTip9eTMdquM7FIvRofQGdtI=

data/.yardopts

@@ -0,0 +1,7 @@
+--output-dir doc/generated
+--protected
+--no-private
+--embed-mixin ClassMethods
+lib/**/*.rb
+-
+doc/*.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xdr.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2015 Stellar Development Foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,105 @@
+# XDR, for Ruby
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xdr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xdr
+
+## Usage
+
+```ruby
+# Reading/writing a primitive values
+XDR::Bool.to_xdr(false)                # => "\x00\x00\x00\x00"
+XDR::Bool.from_xdr("\x00\x00\x00\x01") # => true
+
+# Reading/writing arrays
+XDR::Array[XDR::Int,2].to_xdr([1,2]) # => "\x00\x00\x00\x01\x00\x00\x00\x02"
+XDR::Array[XDR::Int,2].from_xdr("\x00\x00\x00\x03\x00\x00\x00\x04") # => [3,4]
+
+# Defining an enum
+
+class ResultType < XDR::Enum
+  member :ok,       0
+  member :error,    1
+  seal
+end
+
+# Using enums
+
+ResultType.ok == ResultType.error # => false
+ResultType.to_xdr(ResultType.error) # => "\x00\x00\x00\x01"
+ResultType.from_xdr("\x00\x00\x00\x00") # => ResultType.ok(0)
+
+# Defining structs
+
+class MessageWithHash < XDR::Struct
+  attribute :message, XDR::String[]
+  attribute :hash, XDR::Opaque[20]
+end
+
+# Using structs
+
+s = MessageWithHash.new
+s.message = "Hello world"
+s.hash = Digest::SHA1.digest(s.message)
+xdr = s.to_xdr # => "..."
+
+s2 = MessageWithHash.from_xdr(xdr)
+
+# Defining unions
+
+class Result < XDR::Union
+  switch_on ResultType, :type
+
+  switch :ok
+  switch :error, :message
+
+  attribute :message, XDR::String[]
+end
+
+# Constructing unions
+Result.ok
+Result.error("You didn't say please")
+
+# Using unions
+
+Result.ok.to_xdr # => "\x00\x00\x00\x00"
+Result.error("boom").to_xdr # => "\x00\x00\x00\x00\x00\x00\x00\x04boom"
+
+Result.from_xdr("\x00\x00\x00\x00") # => #<Result ...>
+
+```
+
+## Thread safety
+
+Code generated by `xdrgen`, which targets this library, uses autoload extensively.
+Since autoloading is not thread-safe, neither is code generated from xdrgen. To
+work around this, any module including `XDR::Namespace` can be forced to load
+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.
+
+See [ruby-stellar-base](http://github.com/stellar/ruby-stellar-base) for an example (check out the generated directory)
+
+## Contributing
+
+1. Fork it ( https://github.com/stellar/ruby-xdr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+end
+

data/examples/enum.rb

@@ -0,0 +1,30 @@
+require 'xdr'
+
+class Color < XDR::Enum
+  member :red, 0
+  member :green, 1
+  member :blue, 2
+
+  seal
+end
+
+class ResultType < XDR::Enum
+  member :ok, 0
+  member :error, 1
+  seal
+end
+
+Color.members           # => {:red => 0, :green => 1, :blue => 2}
+Color.members.keys      # => [:red, :green, :blue]
+
+# string and symbol work
+# any casing that can be underscored to the correct value will work
+Color.from_name(:RED)   # => #<Color:... @name="red", @value=0>
+Color.from_name("RED")  # => #<Color:... @name="red", @value=0>
+Color.from_name("red")  # => #<Color:... @name="red", @value=0>
+Color.from_name(:red)  # => #<Color:... @name="red", @value=0>
+
+Color.from_xdr("\x00\x00\x00\x00") # => #<Color:... @name="red", @value=0>
+Color.to_xdr(Color.green) # => "\x00\x00\x00\x01"
+
+Color.red == ResultType.ok # => false

data/examples/struct.rb

@@ -0,0 +1,24 @@
+require 'xdr'
+
+class Signature < XDR::Struct
+  attribute :public_key, XDR::Opaque[32]
+  attribute :data, XDR::Opaque[32]
+end
+
+class Envelope < XDR::Struct
+  attribute :body,      XDR::VarOpaque[]
+  attribute :timestamp, XDR::Int
+  attribute :signature, Signature
+end
+
+sig            = Signature.new()
+sig.public_key = "\x01" * 32
+sig.data       = "\x00" * 32
+
+env = Envelope.new({
+  signature: sig,
+  body: "hello",
+  timestamp: Time.now.to_i
+})
+
+env.to_xdr

data/examples/union.rb

@@ -0,0 +1,36 @@
+require 'xdr'
+
+class ResultType < XDR::Enum
+  member :ok,       0
+  member :error,    1
+  member :nonsense, 2
+  seal
+end
+
+class Result < XDR::Union
+  switch_on ResultType, :type
+
+  switch :ok
+  switch :error, :message
+  switch :default
+
+  attribute :message, XDR::String[]
+end
+
+r = Result.new()
+r.set(:error, "hello")
+r.message! # => "hello"
+r.get # => "hello"
+
+r.set(:ok)
+r.get # => nil
+
+r.set(:nonsense)
+r.get # => nil
+
+
+# TODO
+case r
+when ResultType::OK ; puts "i'm ok!"
+when ResultType::ERROR ; puts "broken!"
+end