A very simple Ruby library for parsing Twitter Cards information from websites. See https://dev.twitter.com/cards/types for more information.
Add this line to your application's Gemfile:
gem 'twitter_cards', '~> 0.1'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install twitter_cards
require 'twitter_cards' article = TwitterCards.fetch('http://www.bbc.com/news/technology-32422193') article.title # => "Google launches Project Fi mobile phone network - BBC News" article.description # => "Google announces Project Fi, a mobile network that will piggyback existing services in the US but offer different terms." article.image # => "http://ichef.bbci.co.uk/news/560/media/images/82498000/jpg/_82498457_82498453.jpg" # Check if cards belongs to a specific type article.summary_large_image? # => true article.gallery? # => false # Get card's type article.type # => "summary_large_image" # Check if attribute is present by using attribute? article.domain? # => true article.domain # => "www.bbc.com" # Check if all required (as specified by twitter) attributes are present article.valid?
If you try to fetch Twitter Cards information for a URL that doesn't have any, the fetch method will return false. The TwitterCards::Object that is returned is just a Hash with accessors built into it, so you can examine what properties you've retrieved like so:
article.keys # => ["card", "site", "title", "description", "creator", "image_src", "domain"]
If you have some html already downloaded you can use
article = TwitterCards.parse(html)
If you already have parsed html with nokogiri you can use
article = TwitterCards.extract(doc)
By default, every attribute is extracted from page. If you want to extract cards only when they have all required attributes you can pass :strict option set to true.
article = TwitterCards.fetch('http://www.bbc.com/news/technology-32422193', strict: true)
image_src attributes can be accessed with
Note 2: Attributes like
app:id:googleplay are converted to
Note 3: This library supports only one card per page.
After forking/checking out the repo, run
bin/setup to install dependencies. Then, run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release to create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
- Fork it ( https://github.com/dklisiaris/twitter_cards/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request