Skip to content
This repository has been archived by the owner on Jul 15, 2020. It is now read-only.

tlaw: generic HTTP API wrapper #8

Open
zverok opened this issue Feb 23, 2018 · 2 comments
Open

tlaw: generic HTTP API wrapper #8

zverok opened this issue Feb 23, 2018 · 2 comments
Labels
active Active project gem Ruby gem

Comments

@zverok
Copy link
Owner

zverok commented Feb 23, 2018

Project

tlaw is a somewhat experimental library/DSL for creating fast, thin and reliable wrappers for HTTP APIs. Currently, it supports only GET APIs and lacks some deeper HTTP features (like headers passing or authorization), yet already proven to be a promising way to the "right" thickness balance.

The idea is to develop several generally useful TLAW-based wrappers for common APIs, adding new TLAW features on the way, when necessary.

Plan

  1. Go through lists of public APIs (like this one) and select those of general importance or interesting to you personally.
  2. Create TLAW-based wrappers for them and commit those to tlaws repo.
  3. Good wrapper should include:
    • Wrapper itself, with inline docs and proper hierarchical structure
    • Sanity tests for the wrapper (that it works and does what it is expected to do)
    • README/offline docs for it.

It is expected, that alongside the wrappers themselves, participants of the project also will/should:

  1. Develop some generic good ways of testing and describing small API wrappers;
  2. Enhance TLAW library with (no particular order):
    • Headers support
    • Authorization support
    • Non-GET requests support

Importance

Good abstractions layer for "thin" API wrappers, which can be developed by one person in a few hours and still be robust and useful, seems of general importance for the entire Ruby ecosystem. Also, some regular, small, well-documented wrappers for common APIs, working in the same manner on small yet solid foundation could become a project of huge popularity.

Skills and domains

This task will require a lot of experimenting with API and architecture, and serious intent to write less code, and rewrite a lot, and document a lot.

@zverok zverok added active Active project gem Ruby gem labels Feb 23, 2018
@ryanzidago
Copy link

First things first, thank you @zverok for offering some of your time !

Are you still looking for someone to contribute to the tlaw gem ? I'm pretty new to the software development world. Just started programming this year and went to a bootcamp too and have a couple of projects under my belt. Please, let me know if you'd like me to contribute.

Best,
Ryan

@zverok
Copy link
Owner Author

zverok commented Sep 15, 2019

@ryanzidago sorry for not responding, first I was on Internet-less vacation, and then just forgot :(
If you are still interested, then yes, I'd be glad to work with you!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
active Active project gem Ruby gem
Projects
None yet
Development

No branches or pull requests

2 participants