Bin finalization and bin-related API #41
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
September 1, 2016 20:40
Since bin will be finalized in an instant, thre's no time difference between 'open' and 'close'. This patch removes the 'closed' timestamp column. The new semantic is that 'bins' are basically snapshots of the candidate list at the time of finalizing. Signed-off-by: Branko Vukelic <branko@outernet.is>
This commit factors the code that builds the WHERE clause for binless item lookup so that it can be used in other places where it may be required (pun intentional). Signed-off-by: Branko Vukelic <branko@outernet.is>
Signed-off-by: Branko Vukelic <branko@outernet.is>
This commit adds a new command, 'apiuser', and APIMixin route mixin. Both rely on the newly introduced app.api_acl option, which points to a (not necessarily existing) JSON file that would contain the ACL for API calls. The API endpoints are expected to use APIMixin as part of the class definition. The authentication is, therefore, completely separate from the normal user database. Credentials for API calls is created using the 'apiuser' command. The command takes only username as its argument, and will generate a random 32-digit hex number as the access token / password. Signed-off-by: Branko Vukelic <branko@outernet.is>
This commit adds a to_dict() method to the Model class, which allows returning the instance data as a dict, combining the data and extras dicts into one. The new dict is created by copying the data dict. Signed-off-by: Branko Vukelic <branko@outernet.is>
This commit modifies the ContentItem and Bin models to support bin finalization and features required for retrieval of bin data. 4 API endpoints are also added via the broadcast.routes.api module, which allow finalizing the bin, retrieval of bin list, retrieval of item lists for bins (by ID or the last one), and retrieval of file data for individual items. Signed-off-by: Branko Vukelic <branko@outernet.is>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The bin finalization works by tagging the current set of candidates with bin ID. By tagging the candidates, they automatically disappear from the candidate list since the candidate list only considers items that are not tagged yet. This is a change from the previous version where candidates could be tagged with a unfinalized bin. The finalization is performed by the
ContentItem.finalize_candidates(bin_id)class method.API endpoints are added to facilitate remote management of bin finalization and retrieval of bin information. Access control for the API is separate from the normal authentication mechanism, and has no relation to the user accounts. HTTP basic authentication is used to simplify scripting. Because of this, the calls are expected to be performed over SSL.
The ACL for the API calls is stored in a JSON file, and the file is read on every request to verify the identity of the caller. This file can be modified using the newly added
apiusercommand.To generate a new user:
The command will print out the API token, which is a randomly generated 32-digit hex number. The command is also used to update the password.
API endpoints can be tested using curl.
To finalize the bin:
To retrieve a list of bins:
To retrieve full information for last bin:
Files can be downloaded using the following command:
NOTE: API endpoints are using JSON. During serialization, big lists of items are created. While this works reasonably well in test scenario on the development machine, using XML and similar formats that can be streamed might prove more efficient in production. Whether we should switch or not is still TBD.