twitter_cards 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 909669852c47f4c7104881b7f7f525ca52850e00
+  data.tar.gz: a8b9b40b949bc7425b048f2c6dd6f7f8f153e126
+SHA512:
+  metadata.gz: c3f6abb0dc6843b75cbad7467e502e946b1ee556709c0ed419e7c798f27dc1f1e3ff38de704291a2fccb2ab6ee25bfddff201fed20b29c40f7fa8ed60b1be995
+  data.tar.gz: aa57da079dbc380207438edcfb8e3cb8fa071b8f2b65e4d6c4e207eb16f76ab3d25dc0dd14ed5636568dd90709b038033ef18ec3f8fff9c54d8cefb9950b11f3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+install:
+  - gem uninstall bundler
+  - gem install bundler
+before_script: bin/setup
+script: rspec
+rvm:
+  - 2.2.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3  
+  - rbx-2
+  - rbx-2.5.2 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twitter_cards.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dimitris Klisiaris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# TwitterCards
+
+A very simple Ruby library for parsing Twitter Cards information from websites.
+See https://dev.twitter.com/cards/types for more information.
+
+[![Dependency Status](https://gemnasium.com/dklisiaris/twitter_cards.svg)](https://gemnasium.com/dklisiaris/twitter_cards)
+[![Build Status](https://travis-ci.org/dklisiaris/twitter_cards.svg?branch=master)](https://travis-ci.org/dklisiaris/twitter_cards)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twitter_cards', '~> 0.1'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install twitter_cards
+
+
+## Usage
+
+```ruby
+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:
+
+```ruby
+article.keys # => ["card", "site", "title", "description", "creator", "image_src", "domain"] 
+```
+
+If you have some html already downloaded you can use `parse` method.
+```ruby
+article = TwitterCards.parse(html)
+```
+
+If you already have parsed html with nokogiri you can use `extract` method.
+```ruby
+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.
+```ruby
+article = TwitterCards.fetch('http://www.bbc.com/news/technology-32422193', strict: true)
+```
+
+__Note:__ Both `image` and `image_src` attributes can be accessed with `.image` method.
+
+__Note 2:__ Attributes like `app:id:googleplay` are converted to `app_id_googleplay`
+
+__Note 3:__ This library supports only one card per page.
+
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/dklisiaris/twitter_cards/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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twitter_cards"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twitter_cards.rb

@@ -0,0 +1,106 @@
+require "twitter_cards/version"
+require 'nokogiri'
+require 'restclient'
+require 'hashie'
+
+module TwitterCards
+  
+  # Fetch Twitter Cards data from the specified URI with a HTTP GET request.
+  #
+  # @param uri [String] the uri to fetch and extract cards from.
+  # @param opts [Hash] options to customize functionality
+  # @option :strict [Boolean] If set true, the object is retured only if the data are valid (i.e. not missing required attributes).
+  # @return [Hashie Object, false] a TwitterCards::Object if there is data to be found or false otherwise.
+  #
+  def self.fetch(uri, opts = {})
+    parse(RestClient.get(uri).body, opts)
+  rescue RestClient::Exception, SocketError
+    false
+  end
+  
+  # Parses HTML and extracts Twitter Cards data.
+  #
+  # @param uri [String] the html text to parse and extract cards from.
+  # @param opts [Hash] options to customize functionality
+  # @option :strict [Boolean] If set true, the object is retured only if the data are valid (i.e. not missing required attributes) 
+  # @return [Hashie Object, false] a TwitterCards::Object if there is data to be found or false otherwise.
+  #  
+  def self.parse(html, opts = {})
+    doc = Nokogiri::HTML.parse(html)
+    extract(doc, opts)
+  end
+
+  # Extracts Twitter Cards data from a parsed document.
+  #
+  # @param uri [Nokogiri::HTML::Document] the nokogiri parsed document extract cards from.
+  # @param opts [Hash] options to customize functionality
+  # @option :strict [Boolean] If set true, the object is retured only if the data are valid (i.e. not missing required attributes) 
+  # @return [Hashie Object, false] a TwitterCards::Object if there is data to be found or false otherwise.
+  #  
+  def self.extract(doc, opts = {})
+    opts[:strict] ||= false
+
+    page = TwitterCards::Object.new
+    doc.css('meta').each do |m|
+      if m.attribute('name') and m.attribute('name').to_s.match(/^twitter:(.+)$/i)
+        property = $1        
+      elsif m.attribute('property') and m.attribute('property').to_s.match(/^twitter:(.+)$/i) 
+        property = $1                       
+      end
+
+      if property
+        property.gsub!(/[-:]/,'_')
+        page[property] = m.attribute('content').to_s unless page[property]
+      end
+    end
+
+    return false if page.keys.empty?
+    return false unless page.valid? if opts[:strict]
+    page
+  end
+  
+  
+  # The TwitterCards::Object is a Hash with method accessors for all detected Twitter Cards attributes.
+  #  
+  class Object < Hashie::Mash
+    MANDATORY_ATTRIBUTES = {
+      'summary'             => %w(card site title description),
+      'summary_large_image' => %w(site title description),
+      'photo'               => %w(card site image description),
+      'gallery'             => %w(card site title image0 image1 image2 image3),
+      'app'                 => %w(card site app:id:iphone app:id:ipad app:id:googleplay),
+      'player'              => %w(card site title player player:width player:height image data1 label1 data2 label2),
+      'product'             => %w(card site title description image data1 label1 data2 label2),
+    }
+    
+    # The object type, summary if no card property found.
+    def type
+      self['card'] || 'summary'
+    end
+
+    # Quick way to fetch image
+    def image
+      self['image'] || self['image_src']
+    end
+
+    # Check if image property exists
+    def image?
+      image ? true : false
+    end
+
+    MANDATORY_ATTRIBUTES.keys.each do |card_type|
+      define_method "#{card_type}?" do
+        self.type == card_type
+      end
+    end
+
+    
+    # If the Twitter Cards information for this object doesn't contain
+    # the mandatory attributes, this will be false.
+    def valid?
+      MANDATORY_ATTRIBUTES[type].each{|a| return false unless self[a]}
+      true
+    end
+  end
+
+end

data/lib/twitter_cards/version.rb

@@ -0,0 +1,6 @@
+#!/bin/env ruby
+# encoding: utf-8
+
+module TwitterCards
+  VERSION = "0.1.0"
+end

data/twitter_cards.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twitter_cards/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "twitter_cards"
+  spec.version       = TwitterCards::VERSION
+  spec.authors       = ["Dimitris Klisiaris"]
+  spec.email         = ["dklisiaris@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for Twitter Cards.}
+  spec.description   = %q{A very simple Ruby library for parsing Twitter Cards information from websites. See https://dev.twitter.com/cards/types for more information.}
+  spec.homepage      = "https://github.com/dklisiaris/twitter_cards"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 1.8"
+  spec.add_dependency "nokogiri", "~> 1.6", ">= 1.6.6"
+  spec.add_dependency "hashie", "~> 3.4"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: twitter_cards
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dimitris Klisiaris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: A very simple Ruby library for parsing Twitter Cards information from
+  websites. See https://dev.twitter.com/cards/types for more information.
+email:
+- dklisiaris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twitter_cards.rb
+- lib/twitter_cards/version.rb
+- twitter_cards.gemspec
+homepage: https://github.com/dklisiaris/twitter_cards
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Twitter Cards.
+test_files: []