jiffy_bag 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d88b1fdc8c138de155d7fecad20d87ca467e29d
-  data.tar.gz: 88d808e95333162bfc3c6523b261be5f8c68e9d1
+  metadata.gz: 1796e1b602f7071931335317ed742cfc9cccdd04
+  data.tar.gz: 50816d1a785efbfbeb820c2cdc8846b286c89b39
 SHA512:
-  metadata.gz: 3f5a50de1459c9008d7fd120ec7363f5947f6894a3af3ad574c59319c4dcbbe54a0558215379c34f936dea92c82c5488cce8cf59bb12182c9b882b98612e4c7d
-  data.tar.gz: '08dc85d6138c8d5ce172e6810a6f5fa857c4da2d60d3ff2c043cea8f9d52874d15fed2fd2fc6d81276beb2e52ab5ff1bd2eacccc6ae716fc2713b2583831cec5'
+  metadata.gz: 484e98c0c713a6a6bb6c57380cb8c3e3235d782e3f67025d0e0fa03947e7157a7d7872589fe2ce70e64eb2b9b1ea04b467577f3fe2258266753633f53f81faee
+  data.tar.gz: 0ec408633ee77f47680c9b23b3c47482cc5550dae68ec2580b9f2f36a9446c4b96cf83479f96f70890c9a6cb09df3077ce69c8d38dbec0d8753c79ae77b4d80d

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
     $ gem install jiffy_bag
 
 ## Usage
-Either include or extend JiffyBag in your class depending on whether you want Instance or Class methods. The you get 6 simple methods;
+Either include or extend JiffyBag in your class depending on whether you want Instance or Class methods. The you get 7 simple methods;
 
   JiffyBag.serialize(payload)
     Takes an object and serializes it to YAML.
@@ -42,7 +42,7 @@ Either include or extend JiffyBag in your class depending on whether you want In
   JiffyBag.decode_as_struct(payload)
     Decodes the Base64 payload, unzips it and de-serializes the YAML and if it contains a Hash it instantiates an anonymous Struct from it. This is
 
-  for the most part the you really only need encode_payload
+  for the most part the you really only need JiffyBag.encode
 
       payload = JiffyBag.encode(my: 'cheeky', payload: 'in a nice little package')
 

data/jiffy_bag.gemspec

@@ -9,19 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["James McCarthy"]
   spec.email         = ["james2mccarthy@gmail.com"]
 
-  spec.summary       = %q{Package up structs into neat little packages for sending between services.}
-  spec.description   = %q{Takes a hash and zips it up into a portable struct to send between services.}
+  spec.summary       = %q{Package up Ruby objects into neat little packages for sending between services.}
+  spec.description   = %q{Takes an object zips it up into a serialized, zipped, Base64 encoded string to send between services.}
   spec.homepage      = 'http://github.com/james2m/jiffy_bag'
   spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  # end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/jiffy_bag.rb

@@ -3,31 +3,98 @@ require 'yaml'
 require 'zlib'
 require "jiffy_bag/version"
 
+# == JiffyBag
+# Lets you serialize, zip and encode small Ruby objects for sending between services. The content is not
+# encrypted so this is best used for internal app communication between peer services. e.g. over Sidekiq
+# or using a private API.
+#
+# === Example
+# You will usually only need JiffyBag.encode and JiffyBag.decode. To send package up a Hash to send to
+# another service.
+#
+#     payload = JiffyBag.encode(my: 'cheeky', payload: 'in a nice little package')
+#
+#     => "eJzT1dVVUCwqTarULy4pKk0u4cqttFJIzkhNza7kKkiszMlPTLFSyMxTSFTI\ny0xOVShOTEtVKEhMzk5MT+UCAF+4FDw=\n"
+#
+# Do whatever you got to do get it to the other end and decode it thus;
+#
+#     hash = JiffyBag.decode(payload)
+#
+#     => {my: 'cheeky', payload: 'in a nice little package'}
+#
+#     struct = JiffyBag.decode_as_struct(payload)
+#
+#     => #<struct my="cheeky", payload="in a nice littke package">
+#
 module JiffyBag
+  # Serialize, Zip and Base64 encode a payload.
+  #
+  # ==== Parameters
+  #
+  # * +payload+ The object you want to send. This is
+  #   any object that can be serialized with YAML.dump.
   def self.encode(payload)
     Base64.encode64 deflate(payload)
   end
 
+  # Serialize and Zip a payload.
+  #
+  # ==== Parameters
+  #
+  # * +payload+ The object you want to send. This is any object that can be
+  #   serialized with YAML.dump.
   def self.deflate(payload)
     Zlib::Deflate.deflate serialize(payload)
   end
 
+  # Serialize a payload.
+  #
+  # ==== Parameters
+  #
+  # * +payload+ The object you want to send. This is
+  #   any object that can be serialized with YAML.dump.
   def self.serialize(payload)
     YAML.dump(payload)
   end
 
+  # De-serialize a payload. The opposite of JiffyBag.serialize.
+  #
+  # ==== Parameters
+  #
+  # * +payload+ The received payload you want to de-serialize.
+  #   This can any string returned from YAML.dump.
   def self.deserialize(payload)
     YAML.load(payload)
   end
 
+  # De-serialize and unzip a payload. The opposite of JiffyBag.deflate.
+  #
+  # ==== Parameters
+  #
+  # * +payload+ The received payload you want to de-serialize and unzip.
   def self.inflate(payload)
     deserialize Zlib::Inflate.inflate(payload)
   end
 
+  # De-serialize and unzip and decode a Base64 encoded payload. The opposite
+  # of JiffyBag.encode.
+  #
+  # ==== Parameters
+  #
+  # * +payload+ The received payload you want to de-serialize, unzip and decode.
   def self.decode(payload)
     inflate Base64.decode64(payload)
   end
 
+  # De-serialize and unzip and decode a Base64 encoded payload into an anonymous
+  # Struct. This is a convenience method for sending a Hash and re-building it
+  # into a Struct. Nested Hashes are not returned as Structs.
+  #
+  # ==== Parameters
+  #
+  # * +payload+ The received payload you want to de-serialize, unzip and decode.
+  #   The original JiffyBag.encoded object needs to be a Hash for a Struct to be
+  #   returned, any other class of object will be treated like JiffyBag.decode.
   def self.decode_as_struct(payload)
     object = decode(payload)
     return object unless object.is_a?(Hash)

data/lib/jiffy_bag/version.rb

@@ -1,3 +1,3 @@
 module JiffyBag
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jiffy_bag
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - James McCarthy
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Takes a hash and zips it up into a portable struct to send between services.
+description: Takes an object zips it up into a serialized, zipped, Base64 encoded
+  string to send between services.
 email:
 - james2mccarthy@gmail.com
 executables: []
@@ -94,5 +95,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Package up structs into neat little packages for sending between services.
+summary: Package up Ruby objects into neat little packages for sending between services.
 test_files: []