Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor 'con' in prep for next big push #4

Open
zanerock opened this issue Aug 4, 2014 · 0 comments
Open

Refactor 'con' in prep for next big push #4

zanerock opened this issue Aug 4, 2014 · 0 comments

Comments

@zanerock
Copy link
Member

zanerock commented Aug 4, 2014

We need to rework the 'con' to be more in line with REST and modular. The main goals are:

  • The con CLI script needs to be modular. Currently, the known resources are hard coded and the resource discovery logic is poor. The script should dynamically discover resources.
  • We need to be able to use the same scripts for requests received through HTTP-REST and CLI. In practice, this means moving all the actual resource logic into PHP (though we should design to make handlers implemented in other languages trivial).
  • We will need to add a 'text' accept into the data processing in order to maintain the current level of usability. In other words, we do NOT want to force users to slavishly work in REST, though we will parallel closely. The majority of the simplification will be on he results which will give short command line like responses. If the user wants to see json, they can add 'result-format=json' (aliased to 'f=json') to any command.
  • We want to support referencing the script documentation with 'GET /documentation/resources/ and meta-descriptions '/GET /resources/'. For now the meta-information can just reference the documentation.
  • Before returning to master, the work branch will support the current workflow unit tests (allowing for updates to the CLI commands and responses).
  • We will be able to access /projects and /projects/ from the Dog Food and Liquid Labs sites.
  • Release 0.1 for projects Liquid Labs/gnu-trainer, Liquid Labs/company-manual, DFS/conveyor-core, DFS/conveyor-documentation, DFS/conveyor-requests, DFS/conveyor-repositories, DFS/conveyor-hosts.
  • Files 100% up to testable conveyor-documentation standards and reviewed for non-tested standards.
  • Decent test coverage for 50% of the projects.

Non-Goals:

  • We're not going to worry about the final REST API. Request parameters and response data are entirely fluid at this point. You should probably not develop anything against the REST or CLI APIs at this point unless you're okay with radical changes.
@zanerock zanerock changed the title Refactor 'cons' in prep for next big push Refactor 'con' in prep for next big push Aug 4, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant