A library to fetch and parse OpenGraph properties from an URL or a given string.
MIT License
A library to fetch and parse OpenGraph properties from an URL or a given string.
Ruby 2.5 and later are supported.
Add this line to your application's Gemfile:
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:
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
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)