jiffy_bag 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d88b1fdc8c138de155d7fecad20d87ca467e29d
+  data.tar.gz: 88d808e95333162bfc3c6523b261be5f8c68e9d1
+SHA512:
+  metadata.gz: 3f5a50de1459c9008d7fd120ec7363f5947f6894a3af3ad574c59319c4dcbbe54a0558215379c34f936dea92c82c5488cce8cf59bb12182c9b882b98612e4c7d
+  data.tar.gz: '08dc85d6138c8d5ce172e6810a6f5fa857c4da2d60d3ff2c043cea8f9d52874d15fed2fd2fc6d81276beb2e52ab5ff1bd2eacccc6ae716fc2713b2583831cec5'

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+jiffy_bag-*.gem
+.ruby-version
+.ruby-gemset
+.rvmrc

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at james@thisishatch.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James McCarthy
+
+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.md

@@ -0,0 +1,78 @@
+# JiffyBag
+
+A tiny gem to take an object, serialize, zip and Base64 encode it for sending to another system where it can be re-constructed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jiffy_bag'
+```
+
+And then execute:
+
+    $ bundle
+
+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;
+
+  JiffyBag.serialize(payload)
+    Takes an object and serializes it to YAML.
+
+  JiffyBag.deflate(payload)
+    Takes an object, serializes it to YAML and Zips it up.
+
+  JiffyBag.encode(payload)
+    Takes an object, serializes it to YAML, Zips it up and encodes it in Base64 for safe sending through the ether.
+
+  JiffyBag.deserialize(payload)
+    Exactly the inverse of serialize_payload, takes the YAML and de-serializes it back into an instance of the original class if that class exists.
+
+  JiffyBag.inflate(payload)
+    Exactly the inverse of deflate_payload, unzips the payload and de-serializes the YAML back into an instance of the original serialized class.
+
+  JiffyBag.decode(payload)
+    Exactly the inverse of encode_payload, decodes the Base64 payload, unzips it and de-serializes the YAML back into an instance of the original class.
+
+  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
+
+      payload = JiffyBag.encode(my: 'cheeky', payload: 'in a nice little package')
+
+      => "eJzT1dVVUCwqTarULy4pKk0u4cqttFJIzkhNza7kKkiszMlPTLFSyMxTSFTI\ny0xOVShOTEtVKEhMzk5MT+UCAF+4FDw=\n"
+
+  Do whatever you got to to 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">
+
+## Development
+
+After checking out the repo, run `bin/setup` to install depencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/james2m/jiffy_bag. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+If you want to contribute, a good place to start is filling in that empty test file!
+
+Bug reports are welcome with clear instructions on how to re-create. If it's a feature request, then package them up as pull requests :).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jiffy_bag"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+extend JiffyBag
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jiffy_bag.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jiffy_bag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jiffy_bag"
+  spec.version       = JiffyBag::VERSION
+  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.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) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/jiffy_bag/version.rb

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

data/lib/jiffy_bag.rb

@@ -0,0 +1,36 @@
+require 'base64'
+require 'yaml'
+require 'zlib'
+require "jiffy_bag/version"
+
+module JiffyBag
+  def self.encode(payload)
+    Base64.encode64 deflate(payload)
+  end
+
+  def self.deflate(payload)
+    Zlib::Deflate.deflate serialize(payload)
+  end
+
+  def self.serialize(payload)
+    YAML.dump(payload)
+  end
+
+  def self.deserialize(payload)
+    YAML.load(payload)
+  end
+
+  def self.inflate(payload)
+    deserialize Zlib::Inflate.inflate(payload)
+  end
+
+  def self.decode(payload)
+    inflate Base64.decode64(payload)
+  end
+
+  def self.decode_as_struct(payload)
+    object = decode(payload)
+    return object unless object.is_a?(Hash)
+    Struct.new(*object.keys).new(*object.values)
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: jiffy_bag
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- James McCarthy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Takes a hash and zips it up into a portable struct to send between services.
+email:
+- james2mccarthy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jiffy_bag.gemspec
+- lib/jiffy_bag.rb
+- lib/jiffy_bag/version.rb
+homepage: http://github.com/james2m/jiffy_bag
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Package up structs into neat little packages for sending between services.
+test_files: []