jiffy_bag 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 1d88b1fdc8c138de155d7fecad20d87ca467e29d
4
+ data.tar.gz: 88d808e95333162bfc3c6523b261be5f8c68e9d1
5
+ SHA512:
6
+ metadata.gz: 3f5a50de1459c9008d7fd120ec7363f5947f6894a3af3ad574c59319c4dcbbe54a0558215379c34f936dea92c82c5488cce8cf59bb12182c9b882b98612e4c7d
7
+ data.tar.gz: '08dc85d6138c8d5ce172e6810a6f5fa857c4da2d60d3ff2c043cea8f9d52874d15fed2fd2fc6d81276beb2e52ab5ff1bd2eacccc6ae716fc2713b2583831cec5'
data/.gitignore ADDED
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ jiffy_bag-*.gem
11
+ .ruby-version
12
+ .ruby-gemset
13
+ .rvmrc
data/.travis.yml ADDED
@@ -0,0 +1,8 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.0
5
+ - 2.1
6
+ - 2.2
7
+ - 2.3.1
8
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at james@thisishatch.co.uk. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in jiffy_bag.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 James McCarthy
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # JiffyBag
2
+
3
+ A tiny gem to take an object, serialize, zip and Base64 encode it for sending to another system where it can be re-constructed.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'jiffy_bag'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install jiffy_bag
20
+
21
+ ## Usage
22
+ Either include or extend JiffyBag in your class depending on whether you want Instance or Class methods. The you get 6 simple methods;
23
+
24
+ JiffyBag.serialize(payload)
25
+ Takes an object and serializes it to YAML.
26
+
27
+ JiffyBag.deflate(payload)
28
+ Takes an object, serializes it to YAML and Zips it up.
29
+
30
+ JiffyBag.encode(payload)
31
+ Takes an object, serializes it to YAML, Zips it up and encodes it in Base64 for safe sending through the ether.
32
+
33
+ JiffyBag.deserialize(payload)
34
+ 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.
35
+
36
+ JiffyBag.inflate(payload)
37
+ Exactly the inverse of deflate_payload, unzips the payload and de-serializes the YAML back into an instance of the original serialized class.
38
+
39
+ JiffyBag.decode(payload)
40
+ 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.
41
+
42
+ JiffyBag.decode_as_struct(payload)
43
+ 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
44
+
45
+ for the most part the you really only need encode_payload
46
+
47
+ payload = JiffyBag.encode(my: 'cheeky', payload: 'in a nice little package')
48
+
49
+ => "eJzT1dVVUCwqTarULy4pKk0u4cqttFJIzkhNza7kKkiszMlPTLFSyMxTSFTI\ny0xOVShOTEtVKEhMzk5MT+UCAF+4FDw=\n"
50
+
51
+ Do whatever you got to to get it to the other end and decode it thus;
52
+
53
+ hash = JiffyBag.decode(payload)
54
+
55
+ => {my: 'cheeky', payload: 'in a nice little package'}
56
+
57
+ struct = JiffyBag.decode_as_struct(payload)
58
+
59
+ => #<struct my="cheeky", payload="in a nice littke package">
60
+
61
+ ## Development
62
+
63
+ 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.
64
+
65
+ 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).
66
+
67
+ ## Contributing
68
+
69
+ 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.
70
+
71
+ If you want to contribute, a good place to start is filling in that empty test file!
72
+
73
+ 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 :).
74
+
75
+ ## License
76
+
77
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
78
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "jiffy_bag"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ extend JiffyBag
15
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/jiffy_bag.gemspec ADDED
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'jiffy_bag/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "jiffy_bag"
8
+ spec.version = JiffyBag::VERSION
9
+ spec.authors = ["James McCarthy"]
10
+ spec.email = ["james2mccarthy@gmail.com"]
11
+
12
+ spec.summary = %q{Package up structs into neat little packages for sending between services.}
13
+ spec.description = %q{Takes a hash and zips it up into a portable struct to send between services.}
14
+ spec.homepage = 'http://github.com/james2m/jiffy_bag'
15
+ spec.license = 'MIT'
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ # if spec.respond_to?(:metadata)
20
+ # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
21
+ # else
22
+ # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ # end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.12"
31
+ spec.add_development_dependency "rake", ">= 10.0"
32
+ spec.add_development_dependency "minitest", "~> 5.0"
33
+ end
@@ -0,0 +1,3 @@
1
+ module JiffyBag
2
+ VERSION = "1.0.0"
3
+ end
data/lib/jiffy_bag.rb ADDED
@@ -0,0 +1,36 @@
1
+ require 'base64'
2
+ require 'yaml'
3
+ require 'zlib'
4
+ require "jiffy_bag/version"
5
+
6
+ module JiffyBag
7
+ def self.encode(payload)
8
+ Base64.encode64 deflate(payload)
9
+ end
10
+
11
+ def self.deflate(payload)
12
+ Zlib::Deflate.deflate serialize(payload)
13
+ end
14
+
15
+ def self.serialize(payload)
16
+ YAML.dump(payload)
17
+ end
18
+
19
+ def self.deserialize(payload)
20
+ YAML.load(payload)
21
+ end
22
+
23
+ def self.inflate(payload)
24
+ deserialize Zlib::Inflate.inflate(payload)
25
+ end
26
+
27
+ def self.decode(payload)
28
+ inflate Base64.decode64(payload)
29
+ end
30
+
31
+ def self.decode_as_struct(payload)
32
+ object = decode(payload)
33
+ return object unless object.is_a?(Hash)
34
+ Struct.new(*object.keys).new(*object.values)
35
+ end
36
+ end
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jiffy_bag
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - James McCarthy
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-07-31 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ description: Takes a hash and zips it up into a portable struct to send between services.
56
+ email:
57
+ - james2mccarthy@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".travis.yml"
64
+ - CODE_OF_CONDUCT.md
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - bin/console
70
+ - bin/setup
71
+ - jiffy_bag.gemspec
72
+ - lib/jiffy_bag.rb
73
+ - lib/jiffy_bag/version.rb
74
+ homepage: http://github.com/james2m/jiffy_bag
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.6.10
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: Package up structs into neat little packages for sending between services.
98
+ test_files: []