Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhass/open_graph_reader
A library to fetch and parse OpenGraph properties from an URL or a given string.
https://github.com/jhass/open_graph_reader
Last synced: about 2 hours ago
JSON representation
A library to fetch and parse OpenGraph properties from an URL or a given string.
- Host: GitHub
- URL: https://github.com/jhass/open_graph_reader
- Owner: jhass
- License: mit
- Created: 2014-12-06T16:15:51.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2022-04-10T12:21:09.000Z (over 2 years ago)
- Last Synced: 2024-09-07T16:37:06.094Z (26 days ago)
- Language: Ruby
- Homepage:
- Size: 363 KB
- Stars: 22
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OpenGraphReader [](http://badge.fury.io/rb/open_graph_reader) [](https://travis-ci.org/jhass/open_graph_reader)
A library to fetch and parse OpenGraph properties from an URL or a given string.
## Features
* Strives to be robust and complete.
* Intuitive method based API.
* Supports custom prefixes.
* Validates properties according to their type.
## Anti-features
* Can ignore the complete object if anything is invalid.
* Does not fall back to guess the basic attributes from regular tags.
* Only supports the latest OpenGraph protocol as defined at http://ogp.me out of the box.
* Objects and their properties are defined in code, not by parsing the response at the namespace identifier.
Ruby 2.5 and later are supported.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'open_graph_reader'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install open_graph_reader
Install the following gems the same way for a higher success rate at fetching websites:
* [faraday_middleware](https://github.com/lostisland/faraday_middleware)
* [faraday-cookie_jar](https://github.com/miyagawa/faraday-cookie_jar)
## Usage
```ruby
require 'open_graph_reader'
# Returns nil if anything on the object is invalid
object = OpenGraphReader.fetch("http://examples.opengraphprotocol.us/article.html")
# Raises if anything on the object is invalid
object = OpenGraphReader.fetch!("http://examples.opengraphprotocol.us/article.html")
# Read from string
object = OpenGraphReader.parse(html)
object = OpenGraphReader.parse!(html)
# Access by full property name
object.og.title #=> "5 Held in Plot to Bug Office"
# Optional properties can return nil
object.og.description #=> nil
# Supports properties that are objects themselves
object.og.image.to_s #=> "http://examples.opengraphprotocol.us/media/images/50.png"
object.og.image.content #=> "http://examples.opengraphprotocol.us/media/images/50.png"
object.og.image.url #=> "https://examples.opengraphprotocol.us/media/images/50.png"
object.og.image.width #=> 50
# Supports arrays
object.og.images.first == object.og.image #=> true
object.article.tags #=> ["Watergate"]
# Custom namespace
class MyNamespace
include OpenGraphReader::Object
namespace :my, :namespace # my:namespace
string :name, required: true # my:namespace:name
url :url, default: "http://example.org/my_namespace"
integer :pages, collection: true
# See the shipped definitions for more examples
end
```
[Documentation](http://rubydoc.info/gems/open_graph_reader)
## Contributing
1. Fork it ( https://github.com/jhass/open_graph_reader/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request