oembed_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 956cb22dbe2035e94f2b5f3847559b595ff322f64d4fbf162a7b680c3b76c9e0
+  data.tar.gz: af361ad48515fb78f564505e922970ca477eb1cf4542c88c7f545e65b7fdaa76
+SHA512:
+  metadata.gz: a8b16de65cd28d1af9afd4c7be2e3ec52df3acaa093d56a1c635ddc854dda94eb0030b4efdf171bec88716f366737a875aeeff7833b1748f236f0184c5d1e1e9
+  data.tar.gz: 2d1071f20224c557ec04ff41024ff28c1a65653d53ffa6bd67b8b45aa9c349a3a53ac15cbffeb3e6c9b3f4a53edaea8005597ea76a65ae269d870a1fb95ed445

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/*'
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/RescueStandardError:
+  EnforcedStyle: implicit

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+before_install: gem install bundler -v 1.16.0
+script:
+  - 'bin/rspec'
+  - 'bin/rubocop'

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+group :development do
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'webmock'
+end
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-byebug'
+end
+
+# Specify your gem's dependencies in oembed_proxy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 William Johnston
+
+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,106 @@
+# OembedProxy
+
+[![Build Status](https://travis-ci.org/APMG/oembed_proxy.svg?branch=master)](https://travis-ci.org/APMG/oembed_proxy)
+
+Library to manage multiple oEmbed providers, including officially supported oEmbeds, custom implemented "fauxembeds", and Embed.ly providers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oembed_proxy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install oembed_proxy
+
+## Short Example
+
+```ruby
+require 'oembed_proxy'
+
+my_url = 'https://www.youtube.com/watch?v=yxMxQrX6dOQ'
+handler = OembedProxy::Handler.new(
+  OembedProxy::FirstParty.new,
+  OembedProxy::AssociatedPress.new,
+  OembedProxy::FusiontableMap.new,
+  OembedProxy::GoogleDocument.new,
+  OembedProxy::GoogleMapsengine.new,
+  OembedProxy::GoogleSpreadsheet.new,
+  OembedProxy::Tableau.new,
+  OembedProxy::Embedly.new('myembedlykey'),
+)
+handler.handles_url?(my_url) # => true
+handler.get_data(my_url) # =>
+# {
+#   "type" => "video",
+#   "thumbnail_height" => 360,
+#   "thumbnail_url" => "https://i.ytimg.com/vi/yxMxQrX6dOQ/hqdefault.jpg",
+#   "provider_url" => "https://www.youtube.com/",
+#   "thumbnail_width" => 480,
+#   "title" => "Inside MPR News",
+#   "author_url" => "https://www.youtube.com/user/AmericanPublicMedia",
+#   "provider_name" => "YouTube",
+#   "width" => 480,
+#   "author_name" => "AmericanPublicMedia",
+#   "height" => 270,
+#   "version" => "1.0",
+#   "html" => "<iframe width=\"480\" height=\"270\" src=\"https://www.youtube.com/embed/yxMxQrX6dOQ?feature=oembed\" frameborder=\"0\" allow=\"autoplay; encrypted-media\" allowfullscreen></iframe>"
+# }
+```
+
+## Architecture
+
+Each provider and the handler implement the following API:
+
+* `#handles_url?(url)`
+* `#get_data(url, other_params)`
+
+The `#handles_url?(url)` method takes a URL and returns a boolean describing whether a given provider (or the composition of the registered providers in the case of the handler) supports the given URL.
+
+The `#get_data(url, other_params)` method takes a URL and optional additional hash params (like `width:` and `height:`), and then returns a hash containing the oembed response.
+
+### Handler
+
+In addition to the two methods above, the handler also allows registration of provider classes. This can be done by providing a list of providers to the constructor:
+
+```ruby
+handler = OembedProxy::Handler.new([
+  OembedProxy::FirstParty.new,
+  OembedProxy::AssociatedPress.new,
+])
+```
+
+Or this can be done by calling `#register(provider)`:
+
+```ruby
+handler = OembedProxy::Handler.new
+handler.register OembedProxy::FirstParty.new
+handler.register OembedProxy::AssociatedPress.new
+```
+
+Once providers have been registered, calling `#handles_url?` and `#get_data`  on the handler will operate on the composition of the registered providers.
+
+### Implementing your own providers
+
+You are able to easily implement additional providers by creating an object which implements the `#handles_url?(url)` and `#get_data(url, other_params)` methods. Take a look at the existing provider classes for examples.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Before sending a pull request, you will want to run `bin/rubocop` to lint your work.
+
+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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/APMG/oembed_proxy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'oembed_proxy'
+
+# 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(__FILE__)

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

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

data/lib/oembed_proxy/associated_press.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  # Associated Press Interactives Fauxembed
+  class AssociatedPress
+    AP_REGEX = %r{\Ahttps?:\/\/(?:hosted\.ap\.org\/interactives|interactives\.ap\.org)\/.+}
+
+    def handles_url?(url)
+      !AP_REGEX.match(url).nil?
+    end
+
+    def get_data(url, _other_params = {})
+      return nil unless handles_url? url
+
+      oembed = {}
+
+      oembed['type'] = 'rich'
+      oembed['version'] = '1.0'
+
+      oembed['provider_name'] = 'Associated Press'
+      oembed['provider_url'] = 'http://www.ap.org/'
+
+      oembed['html'] = '<iframe class="ap-embed" width="100%" height="600" frameborder="0" scrolling="yes" marginheight="0" marginwidth="0" src="' + url + '"></iframe>'
+      oembed['width'] = 600
+      oembed['height'] = 600
+
+      oembed
+    end
+  end
+end

data/lib/oembed_proxy/embedly.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'oembed_proxy/first_party'
+require 'oembed_proxy/utility'
+
+module OembedProxy
+  # Embedly provider
+  class Embedly < FirstParty
+    EMBEDLY_URL = 'https://api.embed.ly/1/oembed'
+
+    def initialize(embedly_key)
+      # Import the expected embed.ly providers.
+      @pattern_hash = {}
+      @embedly_key = embedly_key
+
+      File.open('lib/providers/embedly_patterns.def', 'r') do |f|
+        f.each do |line|
+          regex = Utility.clean_pattern(line)
+          @pattern_hash[regex] = EMBEDLY_URL
+        end
+      end
+    end
+
+    def get_data(url, other_params = {})
+      other_params[:key] = @embedly_key
+      super
+    end
+  end
+end

data/lib/oembed_proxy/first_party.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'cgi'
+require 'net/http'
+require 'json'
+
+require 'oembed_proxy/utility'
+require 'oembed_proxy/oembed_exception'
+
+module OembedProxy
+  # Handles all sites with officially supported oEmbed providers
+  class FirstParty
+    USER_AGENT = 'Ruby oEmbed Proxy'
+
+    def initialize
+      # Import the expected first party providers.
+      @pattern_hash = {}
+
+      yaml_hash = YAML.load_file('lib/providers/first_party.yml')
+      yaml_hash.each_value do |hsh|
+        hsh['pattern_list'].each do |pattern|
+          regex = Utility.clean_pattern(pattern)
+          @pattern_hash[regex] = hsh['endpoint']
+        end
+      end
+    end
+
+    def handles_url?(url)
+      !find_endpoint(url).nil?
+    end
+
+    def get_data(url, other_params = {})
+      endpoint = find_endpoint(url)
+      return nil if endpoint.nil?
+
+      uri = URI(endpoint)
+      new_params = { url: url, format: 'json' }
+      new_params.merge! other_params
+      # Merge in existing params.
+      new_params.merge! CGI.parse(uri.query) if uri.query
+      uri.query = URI.encode_www_form(new_params)
+
+      fetch(uri)
+    end
+
+    private
+
+    ERROR_CLASS_MAPPING = {
+      Net::HTTPBadRequest => '400 Bad Request',
+      Net::HTTPUnauthorized => '401 Unauthorized',
+      Net::HTTPForbidden => '403 Forbidden',
+      Net::HTTPNotFound => '404 Not Found',
+      Net::HTTPInternalServerError => '500 Internal Server Error',
+      Net::HTTPNotImplemented => '501 Not Implemented',
+      Net::HTTPServiceUnavailable => '503 Service Unavailable',
+    }.freeze
+
+    MAX_REDIRECTS = 10
+
+    def fetch(uri, times_recursed: 0) # rubocop:disable Metrics/MethodLength
+      raise OembedException, '500 Internal Server Error' if times_recursed > MAX_REDIRECTS
+
+      res = request_builder(uri)
+
+      case res
+      when Net::HTTPSuccess
+        JSON[res.body]
+      when Net::HTTPMovedPermanently, Net::HTTPFound
+        fetch(URI(res['location']), times_recursed: (times_recursed + 1))
+      else
+        raise OembedException, (ERROR_CLASS_MAPPING[res.class] || "Unknown response: #{res.class}")
+      end
+    rescue JSON::ParserError
+      return nil
+    end
+
+    def request_builder(uri)
+      req = Net::HTTP::Get.new(uri)
+      req['User-Agent'] = USER_AGENT
+
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: (uri.scheme == 'https')) do |http|
+        http.request(req)
+      end
+    end
+
+    def find_endpoint(url)
+      @pattern_hash.each_key do |p|
+        return @pattern_hash[p] if url.to_s.match(p)
+      end
+
+      # If all else fails, return nil.
+      nil
+    end
+  end
+end

data/lib/oembed_proxy/fusiontable_map.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  # Google Apps Fusiontable Map Fauxembeds
+  class FusiontableMap
+    FUSIONTABLE_REGEX = %r{\Ahttps://www\.google\.com/fusiontables.+}
+
+    def handles_url?(url)
+      !(url =~ FUSIONTABLE_REGEX).nil?
+    end
+
+    def get_data(url, _other_params = {})
+      return nil unless handles_url? url
+
+      oembed = {}
+
+      oembed['type'] = 'rich'
+      oembed['version'] = '1.0'
+
+      oembed['provider_name'] = 'Google Apps Fusion Tables'
+      oembed['provider_url'] = 'https://www.google.com/drive/apps.html#fusiontables'
+
+      oembed['html'] = '<iframe class="google-map" width="100%" height="500" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="' + url + '"></iframe>'
+      oembed['width'] = 500
+      oembed['height'] = 500
+
+      oembed
+    end
+  end
+end

data/lib/oembed_proxy/google_document.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  # Google Docs Fauxembed
+  class GoogleDocument
+    GOOGLE_DOCUMENT_REGEX = %r{\Ahttps://docs\.google\.com/document.+}
+
+    def handles_url?(url)
+      !(url =~ GOOGLE_DOCUMENT_REGEX).nil?
+    end
+
+    def get_data(url, _other_params = {})
+      return nil unless handles_url? url
+
+      oembed = {}
+
+      oembed['type'] = 'rich'
+      oembed['version'] = '1.0'
+
+      oembed['provider_name'] = 'Google Apps Documents'
+      oembed['provider_url'] = 'https://docs.google.com/document/‎'
+
+      oembed['html'] = '<iframe class="google-docs document" width="100%" height="500" frameborder="0" scrolling="yes" marginheight="0" marginwidth="0" src="' + url + '"></iframe>'
+      oembed['width'] = 500
+      oembed['height'] = 500
+
+      oembed
+    end
+  end
+end

data/lib/oembed_proxy/google_mapsengine.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  # Google Maps Engine Fauxembed
+  class GoogleMapsengine
+    MAPSENGINE_REGEXES = [
+      %r{\Ahttps://mapsengine\.google\.com/map/(?:edit|view)\?mid=(.+)},
+      %r{\Ahttps://www\.google\.com/maps/d/edit\?mid=(.+)},
+    ].freeze
+
+    def handles_url?(url)
+      !get_matching_regex(url).nil?
+    end
+
+    def get_data(url, _other_params = {})
+      return nil unless handles_url? url
+
+      {
+        'type' => 'rich',
+        'version' => '1.0',
+        'provider_name' => 'Google Maps Engine',
+        'provider_url' => 'https://mapsengine.google.com/',
+        'html' => "<iframe class=\"google-map\" width=\"640\" height=\"480\" frameborder=\"0\" scrolling=\"no\" marginheight=\"0\" marginwidth=\"0\" src=\"https://mapsengine.google.com/map/embed?mid=#{url.match(get_matching_regex(url))[1]}\"></iframe>",
+        'width' => 500,
+        'height' => 500,
+      }
+    end
+
+    private
+
+    def get_matching_regex(str)
+      MAPSENGINE_REGEXES.each do |regex|
+        return regex unless (str =~ regex).nil?
+      end
+
+      nil
+    end
+  end
+end

data/lib/oembed_proxy/google_spreadsheet.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  # Google Spreadsheet Fauxembed
+  class GoogleSpreadsheet
+    GOOGLE_SPREADSHEET_REGEX = %r{\Ahttps://docs\.google\.com/spreadsheet.+}
+
+    def handles_url?(url)
+      !(url =~ GOOGLE_SPREADSHEET_REGEX).nil?
+    end
+
+    def get_data(url, _other_params = {})
+      return nil unless handles_url? url
+
+      oembed = {}
+
+      oembed['type'] = 'rich'
+      oembed['version'] = '1.0'
+
+      oembed['provider_name'] = 'Google Apps Spreadsheets'
+      oembed['provider_url'] = 'https://docs.google.com/spreadsheet/‎'
+
+      oembed['html'] = '<iframe class="google-docs spreadsheet" width="100%" height="500" frameborder="0" scrolling="yes" marginheight="0" marginwidth="0" src="' + url + '&amp;output=html"></iframe>'
+      oembed['width'] = 500
+      oembed['height'] = 500
+
+      oembed
+    end
+  end
+end

data/lib/oembed_proxy/handler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  # Generic composing handler
+  class Handler
+    def initialize(*providers)
+      @registered_providers = providers
+    end
+
+    def register(provider)
+      @registered_providers << provider
+    end
+
+    def handles_url?(url)
+      !provider_for_url(url).nil?
+    end
+
+    def get_data(url, other_params = {})
+      provider = provider_for_url(url)
+      return provider.get_data(url, other_params) unless provider.nil?
+    end
+
+    private
+
+    def provider_for_url(url)
+      # TODO: Switch to #find
+      @registered_providers.select { |p| p.handles_url? url }.first
+    end
+  end
+end

data/lib/oembed_proxy/inactive_support.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  # A couple of things pulled in from ActiveSupport, but using refinements
+  # instead of monkeypatching.
+  module InactiveSupport
+    refine String do
+      def parameterize(sep = '-')
+        parameterized_string = dup.downcase
+        # Turn unwanted chars into the separator
+        parameterized_string.gsub!(/[^a-z0-9\-_]+/, sep)
+        unless sep.nil? || sep.empty?
+          re_sep = Regexp.escape(sep)
+          # No more than one of the separator in a row.
+          parameterized_string.gsub!(/#{re_sep}{2,}/, sep)
+          # Remove leading/trailing separator.
+          parameterized_string.gsub!(/^#{re_sep}|#{re_sep}$/, '')
+        end
+        parameterized_string.downcase
+      end
+    end
+  end
+end

data/lib/oembed_proxy/oembed_exception.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OembedProxy
+  class OembedException < StandardError; end
+end