LowEndInsight

View Source AnalyzerModule (LowEndInsight v0.8.1)

Analyzer takes in a valid repo URL and coordinates the analysis, returning a simple JSON report. The URL can be one of "https", "http", or "file". Note, that the latter scheme will only work an existing clone and won't remove the directory structure upon completion of analysis.

Link to this section Summary

Functions

analyze(url, source, options)
analyze(urls, source \\ "lei", start_time \\ DateTime.utc_now(), options \\ %{})

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).

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

create_empty_report/3: takes in a uuid, list of urls, and a start time and produces the repo report object to be returned immediately by asynchronous requestors (e.g. LowEndInsight-Get HTTP endpoint)

determine_risk_counts(report)

determine_risk_counts/1: takes in a full report of n-repo reports, and calculates the number or risk ratings, given the number of repos. It returns a new report with the risk_counts object populated with the count table. Have to accommodate both the atom and string elements, because the JSON gets parsed into the string format - so caching can be supported (as reports are stored in JSON).

determine_toplevel_risk(report)

determine_toplevel_risk/1: takes in a report and determines the highest criticality, and assigns it to the "risk" element for the repo report.

Link to this section Functions

Link to this function

analyze(url, source, options)

View Source 
@spec analyze(binary() | maybe_improper_list(), any(), any()) :: {:ok, map()}
Link to this function

analyze(urls, source \\ "lei", start_time \\ DateTime.utc_now(), options \\ %{})

View Source 
@spec analyze([binary()], any(), any(), any()) :: {:ok, map()}

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

 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 
@spec create_empty_report(String.t(), [String.t()], any()) :: map()

create_empty_report/3: takes in a uuid, list of urls, and a start time and produces the repo report object to be returned immediately by asynchronous requestors (e.g. LowEndInsight-Get HTTP endpoint)

Link to this function

determine_risk_counts(report)

View Source 
@spec determine_risk_counts(RepoReport.t()) :: map()

determine_risk_counts/1: takes in a full report of n-repo reports, and calculates the number or risk ratings, given the number of repos. It returns a new report with the risk_counts object populated with the count table. Have to accommodate both the atom and string elements, because the JSON gets parsed into the string format - so caching can be supported (as reports are stored in JSON).

Link to this function

determine_toplevel_risk(report)

View Source 
@spec determine_toplevel_risk(RepoReport.t()) :: map()

determine_toplevel_risk/1: takes in a report and determines the highest criticality, and assigns it to the "risk" element for the repo report.