zlib_base64_urlsafe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52015d5b0ac22e9aacf1452402e83bd5f814d4fd
+  data.tar.gz: 255534a836c5118b5b17d74b767be32cb096796d
+SHA512:
+  metadata.gz: 988131b3c5aa0888299b7958507393453fd598ceb953c36d2c05e4b9286fd09727980c2d4337937a883e8a4d66e9a5f3b3b58f361102fb30d0e5d6b5cd72bcfc
+  data.tar.gz: 953df186ecdbf3b45c81666eec06ae12b61e31dd669126723e990e36264160909f1efcddc2d2074f114469ed286ad644e8c0a8f6fac5f6d44f3c5bcec5555019

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Arron Mabrey
+
+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,49 @@
+# ZlibBase64Urlsafe
+
+Easily compress/decompress data for use in a query parameter.
+
+This takes Base64 / Url Escaping a step further by compressing the payload before encoding the data.
+
+These compression savings can make a big difference when sending larger pieces of data in a query parameter.
+
+This gem has no dependencies outside of the ruby stdlib. Internally is uses inflate and deflate the same compression algorithm found in gzip.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "zlib_base64_urlsafe"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zlib_base64_urlsafe
+
+## Usage
+
+```ruby
+require "zlib_base64_urlsafe"
+
+ZlibBase64Urlsafe.encode("Hello, World!") # => "eNrzSM3JyddRCM8vyklRBAAfngRq"
+ZlibBase64Urlsafe.decode("eNrzSM3JyddRCM8vyklRBAAfngRq") # => "Hello, World!"
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/arronmabrey/zlib_base64_urlsafe/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zlib_base64_urlsafe"
+
+# 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"
+IRB.start

data/bin/setup

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

data/lib/zlib_base64_urlsafe/version.rb

@@ -0,0 +1,3 @@
+module ZlibBase64Urlsafe
+  VERSION = "0.1.0"
+end

data/lib/zlib_base64_urlsafe.rb

@@ -0,0 +1,16 @@
+require "base64"
+require "zlib"
+
+require "zlib_base64_urlsafe/version"
+
+module ZlibBase64Urlsafe
+  module_function
+
+  def encode(string)
+    Base64.urlsafe_encode64 Zlib.deflate(string, Zlib::BEST_COMPRESSION)
+  end
+
+  def decode(string)
+    Zlib.inflate Base64.urlsafe_decode64(string)
+  end
+end

data/zlib_base64_urlsafe.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zlib_base64_urlsafe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zlib_base64_urlsafe"
+  spec.version       = ZlibBase64Urlsafe::VERSION
+  spec.authors       = ["Arron Mabrey"]
+  spec.email         = ["arron@mabreys.com"]
+
+  spec.summary       = %q{Easily compress/decompress data for use in a query parameter.}
+  spec.description   = %q{Easily compress/decompress data for use in a query parameter.}
+  spec.homepage      = "https://github.com/arronmabrey/zlib_base64_urlsafe"
+  spec.license       = "MIT"
+
+  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"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: zlib_base64_urlsafe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arron Mabrey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Easily compress/decompress data for use in a query parameter.
+email:
+- arron@mabreys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zlib_base64_urlsafe.rb
+- lib/zlib_base64_urlsafe/version.rb
+- zlib_base64_urlsafe.gemspec
+homepage: https://github.com/arronmabrey/zlib_base64_urlsafe
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Easily compress/decompress data for use in a query parameter.
+test_files: []