interop 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '084751018d90a52509edf5a1c67f864ee9990b95970ef3a5018617c21406fe8f'
-  data.tar.gz: 31de67481b086a640eb322088cd06d908813ba1e495de10fbbf122e8596ee59a
+  metadata.gz: 3354d110f9c8fd23ec9681841e3403ec92b57d1d8247b2b856795f52344cc387
+  data.tar.gz: a9ecc3aaa1428509a120c7cfba1582ff28a237abbe86898ab0a31b034e8dfd76
 SHA512:
-  metadata.gz: ae2e8597f69cc61b6a341f95ddcff5547fd99055070ed8ae991975a71f8ebdc555e37a7f4f6503572dfd8840fdad101d44f3739da57ed5c288e7d272b576862e
-  data.tar.gz: fbb8c6666a20fed2de479ed56b7db5885a526117c6ba2801c3cdff2d89e30c861ae735d6f0bed0b5c8285bbeedec26fe321388305ee7a6f646c8e2404a956450
+  metadata.gz: 238204d49f14974ee72c8ece083866204a187788e55f3f3ad9047bf697f085480561d6f632cd183914c923605ca190cbdd6ac31b51d5cc0e9179bec149c556a3
+  data.tar.gz: 1aa9d43425c0f37a5671947a88448289c9d9bf3775a261e7d8fbf0bca99e34909c0364bb1148fcbf47b3d6643abe75dc7558bde358be6f4906973f0b4a579cff

data/lib/interop.rb

@@ -8,6 +8,7 @@ require 'interop/interceptor'
 require 'interop/middleware'
 require 'interop/rpc/client'
 require 'interop/rpc/server'
+require 'interop/content_type'
 
 module Hx
   module Interop

data/lib/interop/content_type.rb

@@ -0,0 +1,53 @@
+require 'json'
+require 'interop/marshaler'
+require 'interop/content_types'
+
+module Hx
+  module Interop
+    # A marshaler that corresponds to a content-type string.
+    class ContentType
+      attr_reader :name
+
+      def initialize(name, marshaler)
+        name.is_a? String or
+          raise ArgumentError, 'Expected name to be a string'
+
+        %i[load dump].all?(&marshaler.method(:respond_to?)) or
+          raise ArgumentError, 'Expected marshaler to respond to :load and :dump'
+
+        @name = -name
+        @marshaler = marshaler
+      end
+
+      def load(str)
+        @marshaler.load str
+      end
+
+      def dump(obj)
+        @marshaler.dump obj
+      end
+
+      def decode(message)
+        load message.body
+      end
+
+      def encode(obj)
+        Message.new.tap { |m| encode_to obj, m }
+      end
+
+      def encode_to(obj, message)
+        body         = dump(obj)
+        message.body = body
+        message.headers.merge!(
+          Headers::CONTENT_TYPE   => name,
+          Headers::CONTENT_LENGTH => body.bytesize
+        )
+      end
+
+      STANDARD = ContentTypes.new
+      JSON     = STANDARD.register('application/json', ::JSON)
+      BINARY   = STANDARD.register('application/octet-stream', Marshaler::NULL)
+      STANDARD.freeze
+    end
+  end
+end

data/lib/interop/content_types.rb

@@ -0,0 +1,47 @@
+module Hx
+  module Interop
+    # A collection of marshalers, with content-type strings, for decoding messages by content type.
+    class ContentTypes < Hash
+      def register(content_type, marshaler = nil)
+        content_type = ContentType.new(content_type, marshaler) unless content_type.is_a? ContentType
+        self << content_type
+        content_type
+      end
+
+      def <<(content_type)
+        content_type.is_a? ContentType or
+          raise ArgumentError, "Expected an instance of #{ContentType}"
+        key? content_type.name and
+          raise ArgumentError, "Content type #{content_type.name} is already registered"
+        self[content_type.name] = content_type
+        self
+      end
+
+      def decode(message)
+        delegate message[Headers::CONTENT_TYPE], :decode, message
+      end
+
+      # @!method load(content_type, str)
+      # @!method dump(content_type, obj)
+      # @!method encode(content_type, obj)
+      # @!method encode_to(content_type, obj, message)
+      %i[load dump encode encode_to].each do |name|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}(content_type, *args)          # def load(content_type, *args)
+            delegate content_type, :#{name}, *args  #   delegate content_type, :load, *args
+          end                                       # end
+        RUBY
+      end
+
+      def to_s
+        keys.join ', '
+      end
+
+      private
+
+      def delegate(content_type, *args)
+        fetch(content_type) { raise Error::UnrecognisedContentType, 'Unrecognised content type' }.__send__ *args
+      end
+    end
+  end
+end

data/lib/interop/error.rb

@@ -10,7 +10,7 @@ module Hx
       class Unexpected < Fatal
       end
 
-      class NotDecodable < self
+      class UnrecognisedContentType < self
       end
     end
   end

data/lib/interop/marshaler.rb

@@ -0,0 +1,16 @@
+module Hx
+  module Interop
+    # Base class for message content marshalers.
+    class Marshaler
+      NULL = new
+
+      def load(str)
+        str
+      end
+
+      def dump(str)
+        str
+      end
+    end
+  end
+end

data/lib/interop/message.rb

@@ -1,21 +1,10 @@
-require 'json'
-
 require 'interop/headers'
 
 module Hx
   module Interop
     # Represents a single interop message, with headers and a body.
     class Message
-      module Types
-        JSON   = 'application/json'.freeze
-        BINARY = 'application/octet-stream'.freeze
-      end
-
       class << self
-        def json_parse_options
-          @json_parse_options ||= {}
-        end
-
         def build(*args)
           return args.first if args.one? && args.first.is_a?(Message)
 
@@ -26,10 +15,6 @@ module Hx
           end
         end
 
-        def json(object, *args)
-          build JSON.generate(object) << "\n", {Headers::CONTENT_TYPE => Types::JSON}, *args
-        end
-
         private
 
         def assign_build_arg(message, arg)
@@ -67,12 +52,9 @@ module Hx
         @body = value.to_s
       end
 
-      def decode
-        case @headers[Headers::CONTENT_TYPE]
-        when Types::JSON
-          return JSON.parse @body, self.class.json_parse_options
-        end
-        raise Error::NotDecodable, 'Message is not in a decodable format'
+      # @param [ContentType, ContentTypes] decoder
+      def decode(decoder)
+        decoder.decode self
       end
 
       def dup

data/lib/interop/rpc/base.rb

@@ -11,7 +11,7 @@ module Hx
           @connection = Connection.build(reader, writer)
           @dispatcher = Dispatcher.new
           yield self if block_given?
-          @io_thread  = Thread.new do
+          @io_thread = Thread.new do
             run
           rescue StandardError => e
             @error = e

data/lib/interop/rpc/client.rb

@@ -37,10 +37,6 @@ module Hx
 
         alias [] call
 
-        def call_json(message_class, unencoded_body, *args)
-          call message_class, Message.json(unencoded_body, *args)
-        end
-
         def magic(&block)
           Magic.new self, :call, &block
         end

data/lib/interop/version.rb

@@ -1,5 +1,5 @@
 module Hx
   module Interop
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Neil E. Pearson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies: []
 description: Ruby implementation of hx/interop cross-language interop abstraction
 email:
@@ -20,12 +20,15 @@ files:
 - lib/interop.rb
 - lib/interop/channel.rb
 - lib/interop/connection.rb
+- lib/interop/content_type.rb
+- lib/interop/content_types.rb
 - lib/interop/error.rb
 - lib/interop/headers.rb
 - lib/interop/interceptor.rb
 - lib/interop/interceptor/base.rb
 - lib/interop/interceptor/read.rb
 - lib/interop/interceptor/write.rb
+- lib/interop/marshaler.rb
 - lib/interop/message.rb
 - lib/interop/middleware.rb
 - lib/interop/pipe.rb