pedrouid / gatsby-source-vimeo Goto Github PK

View Code? Open in Web Editor NEW

5.0 3.0 8.0 139 KB

Gatsby source plugin for fetching video information from Vimeo as a data source

Home Page: https://npmjs.com/package/gatsby-source-vimeo

JavaScript 100.00%

gatsby source plugin vimeo graphql gatsbyjs gatsby-plugin gatsby-source

gatsby-source-vimeo's Introduction

gatsby-source-vimeo

Source plugin for pulling data into Gatsby from Vimeo user videos endpoint.

Pre-requirements

You will need to register on Vimeo to get API keys to use this plugin: https://developer.vimeo.com/apps/new

Install

npm install --save gatsby-source-vimeo

How to use

// In your gatsby-config.js
plugins: [
  {
    resolve: `gatsby-source-vimeo`,
    options: {
      clientID: 'INSERT_YOUR_CLIENT_IDENTIFIER',
      clientSecret: 'INSERT_YOUR_CLIENT_SECRET',
      userID: 'INSERT_VIMEO_USER_ID_TO_FETCH_VIDEOS',
      searchQuery: 'INSERT_SEARCH_QUERY',               // Optional
      transformer(video) {                              // Optional
        video.newField = 'value';
        return video;
      },
    },
  },
];

Plugin Options

clientID

REQUIRED

Client identifier from Vimeo Developer dashboard

clientSecret

REQUIRED

Client secret from Vimeo Developer dashboard

userID

REQUIRED

User ID that you want to fetch videos from
(visit Vimeo profile and run window.vimeo.config.profile.app_config.user.id
on browser console to get the userID)

searchQuery

OPTIONAL

Keywords to filter videos to be fetched
(comma separated)

transformer

OPTIONAL

Transformer function to add or alter existing fields

Note

Remember you are only fetching video information, so this will provide you with Video titles, descriptions, embedded iframes and thumbnails.

gatsby-source-vimeo's People

Contributors

Stargazers

Watchers

Forkers

tresky rezof niyasrahman lordoffreaks teropa acuthbert aaronbentley ftpaul

gatsby-source-vimeo's Issues

Vimeo API Returns Incomplete Results when `searchQuery` is included, but unspecified

The current implementation of the plugin uses the following query URL:

const _url = url || `https://api.vimeo.com/users/${userID}/videos?per_page=100&query=${_searchQuery}`;

This has the searchQuery always being included in the API query, but if it was unspecified in the plugin settings, it will be an empty string to the Vimeo API. This causes the Vimeo API to return incomplete results.

Will submit a PR that fixes this issue.

Feature request: Video tags

Hi, it will be pretty awesome to be able to also query video tags, that will open new possibilities for building gatsby sites with this source plugin.

Feature: Add the ability to pass a transformer function into the options

This feature request would add the ability to pass a transformer function into the config options for the plugin. This allows the user to add derived fields to the data that gets stored in GraphQL.

plugins: [
  {
    resolve: `gatsby-source-vimeo`,
    options: {
      clientID: 'INSERT_YOUR_CLIENT_IDENTIFIER',
      clientSecret: 'INSERT_YOUR_CLIENT_SECRET',
      userID: 'INSERT_VIMEO_USER_ID_TO_FETCH_VIDEOS',
      searchQuery: 'INSERT_SEARCH_QUERY [OPTIONAL]',
      transformer (video) {
        // Transform the video data [OPTIONAL]
        // i.e. Add extra fields or alter existing field
        video.newField = 'value'
        return video
      },
    },
  },
];

Will submit a PR.

source and transform nodesTypeError: Cannot read property 'match' of null

Hi Pedro

Getting following error. Googled but no solution yet. Thank you..

success open and validate gatsby-configs — 0.012 s
success load plugins — 0.472 s
success onPreInit — 5.735 s
success delete html and css files from previous builds — 0.043 s
info One or more of your plugins have changed since the last time you ran Gatsby. As
a precaution, we're deleting your site's cache to ensure there's not any stale
data
success initialize cache — 0.463 s
success copy gatsby files — 0.686 s
success onPreBootstrap — 0.008 s
⠂ source and transform nodesStarting to fetch data from Drupal
⠐ source and transform nodesTypeError: Cannot read property 'match' of null
    at parseVideos (/home/vide/node_modules/gatsby-source-vimeo/gatsby-node.js:50:6)
    at videos.forEach.video (/home/vide/node_modules/gatsby-source-vimeo/gatsby-node.js:117:40)
    at Array.forEach (<anonymous>)
    at Object.exports.sourceNodes (/home/vide/node_modules/gatsby-source-vimeo/gatsby-node.js:117:12)

config.js

{
      resolve: `gatsby-source-vimeo`,
      options: {
        clientID: `66d177164e9fcd0fe6f524fd397fb78c5e8`,
        clientSecret: `3eM1xdwse80YeYnYLqRPN4CMzyd/7bdvXnYrB0HOtlJbV36LQKOuCdsaREVx+YRgbTK6JNLa4d1A67vKk+1NXTCHIB5O
082uavu1PQ0t5isUlKNLyu3lY4Y`,
        userID: `92043621`,
        //searchQuery: 'INSERT_SEARCH_QUERY [OPTIONAL]',
        transformer (video) {
        // Transform the video data [OPTIONAL]
        // i.e. Add extra fields or alter existing field
          video.newField = 'value'
          return video
        }

pedrouid / gatsby-source-vimeo Goto Github PK

gatsby-source-vimeo's Introduction

gatsby-source-vimeo

Pre-requirements

Install

How to use

Plugin Options

clientID

REQUIRED

clientSecret

REQUIRED

userID

REQUIRED

searchQuery

OPTIONAL

transformer

OPTIONAL

Note

gatsby-source-vimeo's People

Contributors

Stargazers

Watchers

Forkers

gatsby-source-vimeo's Issues

Recommend Projects

Recommend Topics

Recommend Org