metadata-v2 0.8.5.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae51ffa35b0e4db9971328dda85b2c551e6595e48e4086fdeca07d2358f967dd
+  data.tar.gz: f1f3e0db7bdc0be7da9a7b50cac9cc1d0a940897eab83fc044f684adb0471f24
+SHA512:
+  metadata.gz: '0086c81a9f53ae2baa2f8b5bbb74faf2c14e8fa4e21a775139e383ef3e877149defc120937879a19d5c4db3ee98c768648c2f0424f3c6c65e1752775c13fd642'
+  data.tar.gz: e2761a48c6d61e0369ecc3471f792dd63d3804f648dc9954aef71cfba93e62f2a79315adbec7a452d1a2280b8ce0937aa55b8b3ccc77c328bed4be3161398eea

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+Copyright © 2018 Chris Olstrom <chris@olstrom.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.org

@@ -0,0 +1,29 @@
+#+TITLE: metadata-v2 - A Ruby Interface to the Joyent Metadata Protocol
+#+LATEX: \pagebreak
+
+* Overview
+  
+  ~metadata-v2~ provides protocol and socket abstractions to simplify
+  interactions with any metadata service that conforms to Version 2 of the
+  [[https://eng.joyent.com/mdata/protocol.html][Joyent Metadata Protocol Specification]].
+
+  Included are drop-in replacements for the [[https://github.com/joyent/mdata-client/][mdata-client]] tools:
+    - mdata-list
+    - mdata-get
+    - mdata-put
+    - mdata-delete
+
+* Why does this exist?
+
+  The [[https://github.com/joyent/mdata-client/][mdata-client]] tools are both portable and well-documented. You should use
+  them when available! ~metadata-v2~ only really becomes useful once you want to
+  do non-trivial things with your metadata service.
+
+* License
+
+  ~metadata-v2~ is available under the [[https://tldrlegal.com/license/mit-license][MIT License]]. See ~LICENSE.txt~ for the
+  full text.
+
+* Contributors
+
+  - [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]

data/bin/mdata-delete

@@ -0,0 +1,20 @@
+#! /usr/bin/env ruby
+# -*- ruby -*-
+
+require_relative '../lib/metadata/v2'
+
+unless key = ARGV.first
+  STDERR.puts 'mdata-delete: Usage: mdata-delete <keyname>'
+  exit 3
+end
+
+metadata = Metadata::V2::Client.new
+response = metadata.delete key
+
+case response.code
+when 'SUCCESS'
+  exit 0
+else
+  STDERR.puts "Error deleting metadata key '#{key}': #{response.decode}"
+  exit 2
+end

data/bin/mdata-get

@@ -0,0 +1,24 @@
+#! /usr/bin/env ruby
+# -*- ruby -*-
+
+require_relative '../lib/metadata/v2'
+
+unless key = ARGV.first
+  STDERR.puts 'mdata-get: Usage: mdata-get <keyname>'
+  exit 3
+end
+
+metadata = Metadata::V2::Client.new
+response = metadata.get key
+
+case response.code
+when 'SUCCESS'
+  STDOUT.puts response.decode
+  exit 0
+when 'NOTFOUND'
+  STDERR.puts "No metadata for '#{ARGV.first}'"
+  exit 1
+else
+  STDERR.puts "Error getting metadata for key '#{key}': #{response.decode}"
+  exit 2
+end

data/bin/mdata-list

@@ -0,0 +1,15 @@
+#! /usr/bin/env ruby
+# -*- ruby -*-
+
+require_relative '../lib/metadata/v2'
+
+metadata = Metadata::V2::Client.new
+response = metadata.keys
+
+case response.code
+when 'SUCCESS'
+  STDOUT.puts response.decode
+  exit 0
+else
+  exit 2
+end

data/bin/mdata-put

@@ -0,0 +1,25 @@
+#! /usr/bin/env ruby
+# -*- ruby -*-
+
+require_relative '../lib/metadata/v2'
+
+unless key = ARGV.shift
+  STDERR.puts 'mdata-put: Usage: mdata-put <keyname> [ <value> ]'
+  exit 3
+end
+
+unless value = ARGV.shift || (STDIN.read unless STDIN.tty?)
+  STDERR.puts 'ERROR: either specify the metadata value as the second command-line argument, or pipe content to stdin.'
+  exit 2
+end
+
+metadata = Metadata::V2::Client.new
+response = metadata.put key, value
+
+case response.code
+when 'SUCCESS'
+  exit 0
+else
+  STDERR.puts "Error putting metadata for key '#{key}': #{response.decode}"
+  exit 2
+end

data/lib/metadata-v2.rb

@@ -0,0 +1,4 @@
+
+# -*- ruby -*-
+
+require_relative 'metadata/v2'

data/lib/metadata/v2.rb

@@ -0,0 +1,7 @@
+
+# -*- ruby -*-
+
+require_relative 'v2/client'
+require_relative 'v2/request'
+require_relative 'v2/response'
+require_relative 'v2/socket_paths'

data/lib/metadata/v2/client.rb

@@ -0,0 +1,71 @@
+
+# -*- ruby -*-
+
+require 'socket' # Ruby Standard Library
+
+require_relative 'request'
+require_relative 'response'
+require_relative 'socket_paths'
+
+module Metadata
+  module V2
+    class Client
+      def initialize(path = nil)
+        @socket = UNIXSocket.new path || ENV.fetch('METADATA_SOCKET') { discover }
+        self
+      end
+
+      def keys
+        request! 'KEYS'
+        block_given? ? yield(response!) : response!
+      end
+
+      def get(key)
+        request! 'GET', key.to_s
+        block_given? ? yield(response!) : response!
+      end
+
+      def put(key, value)
+        request! 'PUT', key.to_s, value.to_s
+        block_given? ? yield(response!) : response!
+      end
+
+      def delete(key)
+        request! 'DELETE', key.to_s
+        block_given? ? yield(response!) : response!
+      end
+
+      private
+
+      def discover
+        SOCKET_PATHS.find { |path| File.socket? path } or raise Errno::ENOENT
+      end
+
+      def raw_request!(message)
+        @socket.sendmsg message.to_s
+      end
+
+      def raw_response!
+        @socket.readline
+      end
+
+      def flush!
+        raw_request! "\n"
+        "invalid command\n" == raw_response!
+      end
+
+      def negotiate!
+        raw_request! "NEGOTIATE V2\n"
+        "V2_OK\n" == raw_response!
+      end
+
+      def request!(*args)
+        raw_request! Request.new(*args)
+      end
+
+      def response!
+        Response.new raw_response!
+      end
+    end
+  end
+end

data/lib/metadata/v2/request.rb

@@ -0,0 +1,44 @@
+
+# -*- ruby -*-
+
+require 'base64' # Ruby Standard Library
+require 'zlib'   # Ruby Standard Library
+
+module Metadata
+  module V2
+    class Request
+      def initialize(operation, *args)
+        @operation = operation
+        @args      = args
+        self
+      end
+
+      attr_reader :operation, :args
+
+      def id
+        @id ||= 8.times.map { rand (0..15) }.map { |n| n.to_s(16) }.reduce(:+)
+      end
+
+      def payload
+        case args.size
+        when 1
+          Base64.encode64(*args).chomp
+        when 2
+          Base64.encode64(args.map { |arg| Base64.encode64(arg).chomp }.join(' ')).chomp
+        end
+      end
+
+      def body
+        @body ||= [id, operation, payload].compact.reject(&:empty?).join(' ')
+      end
+
+      def checksum
+        @checksum ||= Zlib.crc32(body).to_s(16)
+      end
+
+      def to_s
+        ['V2', body.length, checksum, body].join(' ') + "\n"
+      end
+    end
+  end
+end

data/lib/metadata/v2/response.rb

@@ -0,0 +1,53 @@
+
+# -*- ruby -*-
+
+require 'base64' # Ruby Standard Library
+
+module Metadata
+  module V2
+    class Response
+      def initialize(frame)
+        @frame = frame
+        self
+      end
+
+      attr_reader :frame
+
+      def to_s
+        frame + "\n"
+      end
+
+      def protocol
+        @protocol ||= frame.split(' ')[0]
+      end
+
+      def length
+        @length ||= frame.split(' ')[1].to_i
+      end
+
+      def checksum
+        @checksum ||= frame.split(' ')[2]
+      end
+
+      def body
+        @body ||= frame.split(' ').drop(3).join(' ')
+      end
+
+      def id
+        @id ||= body.split(' ')[0]
+      end
+
+      def code
+        @code ||= body.split(' ')[1]
+      end
+
+      def payload
+        @payload ||= body.split(' ')[2]
+      end
+
+      def decode
+        Base64.decode64 payload if payload
+      end
+    end
+  end
+end

data/lib/metadata/v2/socket_paths.rb

@@ -0,0 +1,12 @@
+
+# -*- ruby -*-
+
+module Metadata
+  module V2
+    SOCKET_PATHS = [
+      "/.zonecontrol/metadata.sock",
+	    "/native/.zonecontrol/metadata.sock",
+	    "/var/run/smartdc/metadata.sock"
+    ].freeze
+  end
+end

data/metadata-v2.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'metadata-v2'
+  gem.version     = `git describe --tags --abbrev=0`.chomp + '.pre'
+  gem.licenses    = 'MIT'
+  gem.authors     = ['Chris Olstrom']
+  gem.email       = 'chris@olstrom.com'
+  gem.homepage    = 'https://github.com/colstrom/metadata-v2'
+  gem.summary     = 'A Ruby Interface to the Joyent Metadata Protocol (Version 2)'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: metadata-v2
+version: !ruby/object:Gem::Version
+  version: 0.8.5.pre
+platform: ruby
+authors:
+- Chris Olstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: chris@olstrom.com
+executables:
+- mdata-delete
+- mdata-get
+- mdata-list
+- mdata-put
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.org
+- bin/mdata-delete
+- bin/mdata-get
+- bin/mdata-list
+- bin/mdata-put
+- lib/metadata-v2.rb
+- lib/metadata/v2.rb
+- lib/metadata/v2/client.rb
+- lib/metadata/v2/request.rb
+- lib/metadata/v2/response.rb
+- lib/metadata/v2/socket_paths.rb
+- metadata-v2.gemspec
+homepage: https://github.com/colstrom/metadata-v2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A Ruby Interface to the Joyent Metadata Protocol (Version 2)
+test_files: []