{"id":24755255,"url":"https://github.com/katzer/mruby-shelf-deflater","last_synced_at":"2025-03-23T06:14:02.137Z","repository":{"id":42197950,"uuid":"142161572","full_name":"katzer/mruby-shelf-deflater","owner":"katzer","description":"Shelf middleware enables compression of http responses.","archived":false,"fork":false,"pushed_at":"2022-07-06T14:17:38.000Z","size":19,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-28T12:42:02.999Z","etag":null,"topics":["deflate","deflate-response","gzip-compression","mruby-gem","shelf-middleware","zlib"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/katzer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-24T13:21:22.000Z","updated_at":"2022-07-05T07:33:54.000Z","dependencies_parsed_at":"2022-09-18T01:43:38.529Z","dependency_job_id":null,"html_url":"https://github.com/katzer/mruby-shelf-deflater","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fmruby-shelf-deflater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fmruby-shelf-deflater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fmruby-shelf-deflater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fmruby-shelf-deflater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/katzer","download_url":"https://codeload.github.com/katzer/mruby-shelf-deflater/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245061376,"owners_count":20554563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deflate","deflate-response","gzip-compression","mruby-gem","shelf-middleware","zlib"],"created_at":"2025-01-28T12:37:58.661Z","updated_at":"2025-03-23T06:14:02.110Z","avatar_url":"https://github.com/katzer.png","language":"Ruby","readme":"# The [Shelf][shelf] middleware that enables compression \u003cbr\u003e [![Build Status](https://travis-ci.com/katzer/mruby-shelf-deflater.svg?branch=master)](https://travis-ci.com/katzer/mruby-shelf-deflater) [![Build status](https://ci.appveyor.com/api/projects/status/t5r91stl062nl7ya/branch/master?svg=true)](https://ci.appveyor.com/project/katzer/mruby-shelf-deflater/branch/master) [![Maintainability](https://api.codeclimate.com/v1/badges/99432e2a785e24eea5d2/maintainability)](https://codeclimate.com/github/katzer/mruby-shelf-deflater/maintainability)\n\nCode based on [Rack::Deflator][rack]. Currently supported compression algorithms:\n\n* gzip\n* deflate\n* identity (no transformation)\n\n## Usage\n\n```ruby\nShelf::Builder.app do\n  use Deflator, include: 'text/html', if: -\u003e(req, status, headers, body) { headers['Content-Length'] \u003e 512 }\nend\n```\n\n## Installation\n\nAdd the line below to your `build_config.rb`:\n\n```ruby\nMRuby::Build.new do |conf|\n  # ... (snip) ...\n  conf.gem 'mruby-shelf-deflator'\nend\n```\n\nOr add this line to your aplication's `mrbgem.rake`:\n\n```ruby\nMRuby::Gem::Specification.new('your-mrbgem') do |spec|\n  # ... (snip) ...\n  spec.add_dependency 'mruby-shelf-deflator'\nend\n```\n\n__Note:__ Compile file `ZLIB_STATIC` flag if you want to static link with zlib. See the [build_config.rb][build_config] as an example.\n\n## Development\n\nClone the repo:\n    \n    $ git clone https://github.com/katzer/mruby-shelf-deflator.git \u0026\u0026 cd mruby-shelf-deflator/\n\nCompile the source:\n\n    $ rake compile\n\nRun the tests:\n\n    $ rake test\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/katzer/mruby-shelf-deflator.\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## Authors\n\n- Sebastián Katzer, Fa. appPlant GmbH\n\n## License\n\nThe mgem is available as open source under the terms of the [MIT License][license].\n\nMade with :yum: in Leipzig\n\n© 2018 [appPlant GmbH][appplant]\n\n[shelf]: https://github.com/katzer/mruby-shelf\n[rack]: https://github.com/rack/rack/blob/master/lib/rack/deflater.rb\n[build_config]: https://github.com/katzer/mruby-shelf-deflater/blob/master/build_config.rb\n[license]: http://opensource.org/licenses/MIT\n[appplant]: www.appplant.de\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatzer%2Fmruby-shelf-deflater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkatzer%2Fmruby-shelf-deflater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatzer%2Fmruby-shelf-deflater/lists"}