camiloribeiro/quinoa

View on GitHub
README.md

Summary

Maintainability
Test Coverage
quinoa
=====

[![Gem Version](https://badge.fury.io/rb/quinoa.png)](http://badge.fury.io/rb/quinoa)
[![Build Status](https://travis-ci.org/camiloribeiro/quinoa.png?branch=master)](https://travis-ci.org/camiloribeiro/quinoa)
[![Code Climate](https://codeclimate.com/github/camiloribeiro/quinoa.png)](https://codeclimate.com/github/camiloribeiro/quinoa)
[![Dependency Status](https://gemnasium.com/camiloribeiro/quinoa.png)](https://gemnasium.com/camiloribeiro/quinoa)
[![Test Coverage](https://codeclimate.com/github/camiloribeiro/quinoa/badges/coverage.svg)](https://codeclimate.com/github/camiloribeiro/quinoa/coverage)

![alt tag](http://i.huffpost.com/gen/1821327/images/n-QUINOA-large570.jpg)

Quinoa is a service-object model framework built on top of rest-client (https://github.com/rest-client/rest-client). 
The idea is to define a rest endpoint and some details about it only once, and than reuse it with different payloads or properties.

This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.

For example, if I want to define a rest endpoint for the url http://www.camiloribeiro.com with the content-type application/json and send two different body payloads, I could do it like this:

      test = Quinoa::Service.new "http://camiloribeiro.com"
      test.content_type = "application/json"

      test.body = '{ "foo":"bar"}'
      result1 = test.post!

      test.body = '{ "bar":"foo"}'
      result2 = test.post!

Now if I want to change and use another endpoint in the same url, I can do something like this:

      test.path = /new_endpoint
      result3 = test.get!

To read the response it is as easy as setting the initial data:

      result1.response_content_type
      => "application/json"

      result2.response_body
      => "{ "some":"body"}

To get a report back you can use the function report

      test.report


LICENSE
=======

Copyright 2015 - 2017 Camilo Ribeiro camilo@camiloribeiro.com

This file is part of Quinoa.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.