Pexels

An unofficial, open source Ruby wrapper for the Pexels REST API. The source code is available on GitHub at https://github.com/mikeholford/pexels.

N.B. When using this gem you still need to abide to Pexels Guidelines, which are explained on Pexels API page

Installation

Add this line to your application's Gemfile:

gem 'pexels', git: 'https://github.com/mikeholford/pexels'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pexels

Usage

API Access Key

Firstly, you'll need an API Key. Request accesss here

Configuration

Configure the gem in an initializer with you API Key

# app/config/initializers/pexels.rb

Pexels.configure do |config|
  config.access_token = "YOUR_API_KEY"
end

Examples

Below are some examples of what you can currently use the gem for with the Pexels API. If anything is missing or broken please create a Bg report or pull request with a fix.

Photos

You can fetch a photo directly with it's ID, Search a query specifying per_page (max: 80, default: 15) and page (max: 1000, default: 1) or fetch the curated photo collection from Pexels.

# Get a photo with it's ID
photo = Pexels::Photo.get(PHOTO_ID)

# Search photos with a query
search_results = Pexels::Photo.search('The Ocean')
search_results = Pexels::Photo.search('The Ocean', 5, 2) # 5 per page, page 2

# Fetch curated photo collection
search_results = Pexels::Photo.curated
search_results = Pexels::Photo.curated(1, 1) # 1 per page, page 1

# Fetch random curated photo
photo = Pexels::Photo.random

Video

You can either search a query specifying per_page (max: 80, default: 15) and page (max: 1000, default: 1) or fetch the popular video collection by Pexels

# Search video with a query
search_results = Pexels::Video.search('Nature')
search_results = Pexels::Video.search('Nature', 5, 2) # 5 per page, page 2

# Fetch the popular video collection
search_results = Pexels::Video.popular
search_results = Pexels::Video.popular(1, 1) # 1 per page, page 1

Todo

Add errors for rate limiting
Add Photo size variations
Publish gem on RubyGems

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also 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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pexels. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Pexels project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.