Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fabianfrz/icaprb-server

An implementation of the ICAP server part in pure Ruby
https://github.com/fabianfrz/icaprb-server

content-adaptation icap icap-server proxy ruby security server

Last synced: 3 days ago
JSON representation

An implementation of the ICAP server part in pure Ruby

Awesome Lists containing this project

README

        

# ICAPrb::Server

Welcome to my projekt. I tried to implement the server part of the ICAP communication in [Ruby](https://www.ruby-lang.org/de/),
so the server configuration can load different things and the code may be changed at runtime (for example if you want a high uptime).

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'icaprb-server'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install icaprb-server

## Usage

Getting your server running is really easy:

```ruby
# require it
require "icaprb/server"

# create an instance of a server
s = ICAPrb::Server::ICAPServer.new

# add your services
s.services['echo'] = ICAPrb::Server::Services::EchoService.new

# and run it
s.run

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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

Bug reports and pull requests are welcome on GitHub at https://github.com/fabianfrz/ICAPrb-Server, however I may not have enough time to provide fixes soon.