arsduo / koalamatic

Automated Facebook test runner based on Koala.
1 stars 0 forks source link

Create API Analyzer framework #4

Open arsduo opened 12 years ago

arsduo commented 12 years ago

Create a basic Analyzer class that allows easy specification of what characteristics go into a given type of call.

Given an ApiInteraction (record of an API call) which matches at least one of a set of specific criteria (String, Regexp, block) for its method, path, host, query string, request body, etc., Analyzer should map the call to a unique description. (For instance, POST /me/photos for Facebook would map to "Posting a photo to a user").

How exactly the analyzer would be structured is TBD -- it could be a DSL with specific files that get loaded and parsed, or a more RSpec like set of Ruby classes (with an internal DSL). Also TBD is how to store the analyzed information -- most likely each unique type of call would be a record in an ApiCalls, each of which would contain Title and other information needed to display the call, with a has_many relationship to data from actual calls (that is, result_status and duration, which are needed for aggregation and graphing).

Additional features:

arsduo commented 12 years ago

See in particular #17 for an example of the type of search that the ApiCall table will need to support.