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.

Sign up for GitHub

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

Jump to bottom

Improve documentation of Website Agent #2066

Merged
merged 1 commit into from
Jul 25, 2017
Merged

Improve documentation of Website Agent #2066

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 additions & 1 deletion app/models/agents/website_agent.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,58 @@ class WebsiteAgent < Agent

# Scraping JSON

When parsing JSON, these sub-hashes specify [JSONPaths](http://goessner.net/articles/JsonPath/) to the values that you care about. For example:
When parsing JSON, these sub-hashes specify [JSONPaths](http://goessner.net/articles/JsonPath/) to the values that you care about.

Sample incoming event:

{ "results": {
"data": [
{
"title": "Lorem ipsum 1",
"description": "Aliquam pharetra leo ipsum."
"price": 8.95
},
{
"title": "Lorem ipsum 2",
"description": "Suspendisse a pulvinar lacus."
"price": 12.99
},
{
"title": "Lorem ipsum 3",
"description": "Praesent ac arcu tellus."
"price": 8.99
}
]
}
}

Sample rule:

"extract": {
"title": { "path": "results.data[*].title" },
"description": { "path": "results.data[*].description" }
}

In this example the `*` wildcard character makes the parser to iterate through all items of the `data` array. Three events will be created as a result.

Sample outgoing events:

[
{
"title": "Lorem ipsum 1",
"description": "Aliquam pharetra leo ipsum."
},
{
"title": "Lorem ipsum 2",
"description": "Suspendisse a pulvinar lacus."
},
{
"title": "Lorem ipsum 3",
"description": "Praesent ac arcu tellus."
}
]


The `extract` option can be skipped for the JSON type, causing the full JSON response to be returned.

# Scraping Text
Expand Down