Liking cljdoc? Tell your friends :D

oEmbed / open-graph info fetcher

Clojars Project

The goal of this project is to fetch oEmbed, open-graph and basic HTML information stored at given URL.

Entire API comes down to:

(require '[embodie.core :as core]
         '[embodie.oembed :as oembed])

(core/fetch url)
(core/fetch url providers & opts)

(oembed/init-oembed-providers)
(oembed/init-oembed-providers location)

(oembed/with-oembed-providers providers)

providers is by vector of defined providers, [:oembed :open-graph :html] by default, and can be adjusted, eg. to limit amount of data gathered or simply to fetch data from one particular provider.

The opts map is a way to pass additional options, used currently only by :html provider to limit number of returned images (3 by default):

{:max-images 3}

Additionally:

init-oembed-providers initializes a map of defined oembed providers and defaults to json stored at http://oembed.com/providers.json if no alternative location was provided.

with-oembed-providers is a convenience macro which (re)binds variable with oembed providers initialized before.

Fetching in action

Typical use of API functions:


;; initialize oembed providers from default list
(def providers (oembed/init-oembed-providers))

;; fetch info using :oembed, :open-graph and :html providers
(oembed/with-oembed-providers providers
  (core/fetch "https://www.instagram.com/p/BoRz3GpAhsg/"))

;; only :html provider and max 1 image 
(core/fetch "https://www.instagram.com/p/BoRz3GpAhsg/" [:html] {:max-images 1})

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close