Sha256: 447fb5bbb8b7f299da8cfd4c775d5de030822d2a43354930310db21b7f6eb12e

Contents?: true

Size: 1.99 KB

Versions: 3

Compression:

Stored size: 1.99 KB

Contents

[![Build Status](https://semaphoreci.com/api/v1/igormalinovskiy/api_proxy/branches/master/shields_badge.svg)](https://semaphoreci.com/igormalinovskiy/api_proxy)
[![Code Climate](https://codeclimate.com/github/psyipm/api_proxy/badges/gpa.svg)](https://codeclimate.com/github/psyipm/api_proxy)
[![Gem Version](https://badge.fury.io/rb/api_proxy.svg)](https://badge.fury.io/rb/api_proxy)

# ApiProxy

This gem is a simple forwarding proxy for api requests

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'api_proxy'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install api_proxy

## Usage

```ruby
# config/initializers/api_proxy.rb

ApiProxy.configure(:my_namespace) do |config|
  config.api_key = ENV['SERVICE_API_KEY']
  config.api_secret = ENV['SERVICE_API_SECRET']

  config.url_scheme = 'http'
  config.api_host = 'localhost'
  config.api_port = 3000

  config.api_prefix = '/api/v1/'

  config.request_starts_with = '/_some_key'
end
```

```ruby
# config/application.rb

config.middleware.use ApiProxy::Middleware, :my_namespace
```

Then all requests, starting with `/_some_key` will be forwarded to your service

`GET localhost:3010/_some_key/orders` => `GET localhost:3000/api/v1/orders`

## 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/[USERNAME]/api_proxy.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
api_proxy-0.1.3 README.md
api_proxy-0.1.2 README.md
api_proxy-0.1.1 README.md