com-http-client

HTTP abstractions and implementations for client libraries based on HTTP protocol.


License
GPL-3.0-only
Install
gem install com-http-client -v 0.1.2

Documentation

::Com::Http, ::Com::Http::Client

Micro framework to build clients for HTTP based APIs.

Overview

The library(gem) contains abstractions and implementation of client's interfaces from com-client gem which will be useful in building clients to concrete HTTP based APIs.

Dependencies

Runtime

Development

  • Bundler version 1.12.5 or higher
  • Other dependencies will be installed automatically by running bundle install from library's root directory.

Installation

Production

You can install this library manually with

gem install com-http-client

with resolving all of their dependencies manually.

The preffered way to install it is to rely on Bundler in your application.

Assuming that, add follow to your Gemfile.

gem "com-http-client", ">= 0.1.0"

And then execute from the directory with Gemfile (likely it should be your application's root directory):

$ bundle

Adding this library(gem) as a runtime dependency to other libraries(gems)

This is the most common use case of that library. Likely you already know how to do that, but for clarity sake here is some tips and links.

Add follow line to your library's gemspec file:

spec.add_runtime_dependency 'com-http-client', '>= 0.1'

See also official documentation on rubygems about adding runtime dependencies.

Development

While developming new library which depends on changes to com-http-client you likely want to test you changes to com-http-client with your own library.

To do this add runtime dependency in your library's gemspec file like described in previous section.

Then add gem definition for com-http-client to your library's Gemfile with :path parameter which points to root directory of your local copy of com-http-client.

If we assume that you have follow directory structure of git repositories:

~
|- projects
   |- com-http-client
   |- your-library

Then you have to add to your Gemfile something like follows:

gem "com-http-client",
  path: "../com-http-client"

After all run bundle install to let your changes to make affect.

Usage

Library's interactive prompt

To experiment with that code, run bin/console for an interactive prompt from project's root directory.

Documentation

Exceptions modules and classes hierarchy

Introduced namespace modules:

Introduced error tagging modules:

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. Run bundle exec com-http-client to use the code located in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in lib/com/http/client/version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags.

Testing

There are different ways to run tests. You can use the one which you used to.

$ rake # uses default rake task which is spec

or

$ rspec

or

$ rake spec

or

$ rspec spec/

Contributing

  1. Clone it: git clone git@github.com:com-rb/com-http-client.git
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Ensure all tests pass successfully
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request