LowEndInsight v0.3.2 AnalyzerModule View Source

Analyzer takes in a repo url and coordinates the analysis, returning a simple JSON report.

Link to this section Summary

Functions

analyze/3: returns the LowEndInsight report as JSON for multiple_repos. Takes in a "list" of urls, a source id for the calling client, and the start_time of analysis as an optional way to capture the time actually started at whatever the client is (e.g. an async API).

Link to this section Functions

Link to this function

analyze(url, source)

View Source
analyze(String.t() | list(), String.t()) :: tuple()
Link to this function

analyze(urls, source, start_time \\ DateTime.utc_now())

View Source

analyze/3: returns the LowEndInsight report as JSON for multiple_repos. Takes in a "list" of urls, a source id for the calling client, and the start_time of analysis as an optional way to capture the time actually started at whatever the client is (e.g. an async API).

Returns Map.

Examples

  iex> {:ok, report} = AnalyzerModule.analyze(["https://github.com/kitplummer/xmpp4rails","https://github.com/kitplummer/lita-cron"], "iex")
  iex> _count = report[:metadata][:repo_count]
  2
Link to this function

create_empty_report(uuid, urls, start_time \\ DateTime.utc_now())

View Source