Create a gem for your API

[zaratan]

Why ?

It's cool to have an API but at one point you will want you or other people to be able to use it. Also, we will use it as an opportunity to do integration testing.

Must have

• A gem able to connect to our API and query at least some methods on it;
• A test suite based on VCR that really test our API;
• Documentation in the readme;
• The gem must be available on rubygem;
• CI/CD: circle CI build and if everything is alright send it to rubygem.

Reading list

• Use bundle gem xxx to create a new gem (https://bundler.io/man/bundle-gem.1.html)
• Every gem used should ONLY be specified into the gemspec file: https://guides.rubygems.org/specification-reference/
• To easily create a consumer gem, use faraday and it's middleware cf: auth.rb and client.rb
• Architecture wise, I advise you look at this gem: https://github.com/denispasin/subox_api
• For VCR: https://github.com/denispasin/subox_api/blob/ac6a8388e4d96826f45cbe84394b35c66ed0c16c/spec/spec_helper.rb#L5-L9