pexels 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c35b5ede38be050f349b46e1acfa441306af1ccf5acdf89ec9e442d4474a960d
+  data.tar.gz: ea3bb7174df2b5c135fa272bba90a4a5a42133078d7f52e2944ccf663f800518
+SHA512:
+  metadata.gz: b18c77442467ef348fde20120245d4ba880f8dd4417a2d60aabce80c3b44c876a385c413c925d5348b703984a703c98ac0f5c86e97a6a47ea25fcbedd256c62f
+  data.tar.gz: f7e2e10664aca352d80b7479309e638d6e447b9dd59347eedcbb38ae79626852e7a7463ba9ebb396911d922c9732b4d233322d871e59bfc85f8dfe00c986b93e

data/.env.sample

@@ -0,0 +1,8 @@
+# vim: ft=sh
+export GEM_HOME="$PWD/.dependencies"
+export GEM_PATH="$PWD/.dependencies"
+export RUBYLIB=lib:$RUBYLIB
+export GEM_BIN="$GEM_HOME/bin"
+export PATH="$GEM_BIN":"$PATH"
+
+export PEXELS_API_KEY="foo"

data/.gems

@@ -0,0 +1,2 @@
+requests -v 1.0.2
+minitest -v 5.11.3

data/.gitignore

@@ -0,0 +1,3 @@
+.gems.up.to.date
+.env
+*.gem

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2020 Pexels GmbH <partnerships@pexels.com>
+
+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/Makefile

@@ -0,0 +1,15 @@
+test: .gems.up.to.date
+	ruby -Ilib -e 'ARGV.each { |f| require f }' ./test/*.rb
+
+.gems.up.to.date: .gems
+	(which dep || gem install dep) && dep install && touch $@
+
+console: .gems.up.to.date
+	irb -r pexels
+
+build: .gems.up.to.date
+	gem build pexels.gemspec
+
+all: test
+
+.PHONY: test console build

data/README.md

@@ -0,0 +1,30 @@
+# Pexels Ruby Library
+
+The Pexels Ruby library is a convenient wrapper around the Pexels API that you can use to browse the incredible content uploaded by our talented contributors.
+
+## Installation
+
+```
+gem install pexels
+```
+
+Or add it to your `Gemfile` and run `bundle install`.
+
+## Documentation
+
+See the API docs [here](https://www.pexels.com/api/documentation/?language=js)
+
+
+## Running the test suite
+
+You'll need your own API key to run the test suite, you can get one on the [Pexels API Key management page](https://www.pexels.com/api/new/)
+
+For ease of use, you'll probably want to copy the provided `.env.sample` into your own `.env` file and substitute the `PEXELS_API_KEY` variable with your own.
+
+```
+cp .env.sample .env
+vim .env              #=> Change PEXELS_API_KEY
+source .env           #=> Load the environment
+
+make test
+```

data/lib/pexels/client/photos.rb

@@ -0,0 +1,37 @@
+class Pexels::Client::Photos
+
+  def initialize(client)
+    @client = client
+  end
+
+  def get(id)
+    results = @client.request("/v1/photos/#{id}")
+    Pexels::Photo.new(results)
+  end
+
+  def search(query, per_page: 15, page: 1, locale: 'en-US')
+    results = @client.request(
+      '/v1/search',
+      params: {
+        query: query,
+        per_page: per_page,
+        page: page,
+        locale: locale
+      }
+    )
+
+    Pexels::SearchResult.new(results)
+  end
+
+  def curated(per_page: 15, page: 1)
+    results = @client.request(
+      '/v1/curated',
+      params: {
+        per_page: per_page,
+        page: page,
+      }
+    )
+
+    Pexels::SearchResult.new(results)
+  end
+end

data/lib/pexels/client/videos.rb

@@ -0,0 +1,36 @@
+class Pexels::Client::Videos
+
+  def initialize(client)
+    @client = client
+  end
+
+  def get(id)
+    results = @client.request("/videos/videos/#{id}")
+    Pexels::Video.new(results)
+  end
+
+  def search(query, per_page: 15, page: 1)
+    results = @client.request(
+      '/videos/search',
+      params: {
+        query: query,
+        per_page: per_page,
+        page: page,
+      }
+    )
+
+    Pexels::SearchResult.new(results)
+  end
+
+  def popular(per_page: 15, page: 1)
+    results = @client.request(
+      '/videos/popular',
+      params: {
+        per_page: per_page,
+        page: page,
+      }
+    )
+
+    Pexels::SearchResult.new(results)
+  end
+end

data/lib/pexels/client.rb

@@ -0,0 +1,39 @@
+require 'requests'
+
+class Pexels::Client
+  attr_reader :api_key,
+              :ratelimit_remaining
+
+
+  def initialize(api_key = ENV['PEXELS_API_KEY'])
+    @api_key = api_key
+  end
+
+  def photos
+    @photos ||= Pexels::Client::Photos.new(self)
+  end
+
+  def videos
+    @videos ||= Pexels::Client::Videos.new(self)
+  end
+
+  def request(path, method: 'GET', params: {})
+    results = Requests.request(
+      method,
+      "#{Pexels.api_base_url}#{path}",
+      params: params,
+      headers: {
+        'Authorization' => api_key
+      }
+    )
+
+    @ratelimit_remaining = results.headers['x-ratelimit-remaining'].first.to_i
+
+    return JSON.parse(results.body)
+  rescue StandardError => exception
+    raise Pexels::APIError.new(exception)
+  end
+end
+
+require 'pexels/client/photos'
+require 'pexels/client/videos'

data/lib/pexels/curated_result.rb

@@ -0,0 +1,15 @@
+class Pexels::CuratedResult
+  attr_reader :photos,
+              :page,
+              :per_page,
+              :next_page
+
+  def initialize(attrs)
+    @page = attrs.fetch('page')
+    @per_page = attrs.fetch('per_page')
+    @next_page = attrs.fetch('next_page')
+    @photos = attrs.fetch('photos').map { |attrs| Pexels::Photo.new(attrs) }
+
+    return self
+  end
+end

data/lib/pexels/errors.rb

@@ -0,0 +1,4 @@
+module Pexels
+  class APIError < StandardError; end
+  class MalformedAPIResponseError < APIError; end
+end

data/lib/pexels/photo.rb

@@ -0,0 +1,25 @@
+class Pexels::Photo
+  attr_reader :id,
+              :width,
+              :height,
+              :url,
+              :user,
+              :src
+
+
+  def initialize(attrs)
+    @id = attrs.fetch('id')
+    @height = attrs.fetch('height')
+    @width = attrs.fetch('width')
+    @url = attrs.fetch('url')
+    @user = Pexels::User.new(
+      id: attrs.fetch('photographer_id'),
+      name: attrs.fetch('photographer'),
+      url: attrs.fetch('photographer_url')
+    )
+    @src = attrs.fetch('src')
+
+  rescue KeyError => exception
+    raise Pexels::MalformedAPIResponseError.new(exception)
+  end
+end

data/lib/pexels/search_result.rb

@@ -0,0 +1,20 @@
+class Pexels::SearchResult
+  attr_reader :photos,
+              :videos,
+              :total_results,
+              :page,
+              :per_page,
+              :next_page
+
+  def initialize(attrs, type: :Photo)
+    @total_results = attrs.fetch('total_results', nil)
+    @page = attrs.fetch('page')
+    @per_page = attrs.fetch('per_page')
+    @next_page = attrs.fetch('next_page', nil)
+
+    @photos = attrs.fetch('photos', []).map { |attrs| Pexels::Photo.new(attrs) }
+    @videos = attrs.fetch('videos', []).map { |attrs| Pexels::Video.new(attrs) }
+
+    return self
+  end
+end

data/lib/pexels/user.rb

@@ -0,0 +1,9 @@
+class Pexels::User
+  attr_reader :id, :name, :url
+
+  def initialize(id:, name:, url:)
+    @id = id
+    @name = name
+    @url = url
+  end
+end

data/lib/pexels/version.rb

@@ -0,0 +1,3 @@
+module Pexels
+  VERSION = '0.0.1'
+end

data/lib/pexels/video.rb

@@ -0,0 +1,29 @@
+class Pexels::Video
+  attr_reader :id,
+              :width,
+              :height,
+              :url,
+              :image,
+              :duration,
+              :user,
+              :video_files,
+              :video_pictures
+
+
+  def initialize(attrs)
+    @id = attrs.fetch('id')
+    @height = attrs.fetch('height')
+    @width = attrs.fetch('width')
+    @url = attrs.fetch('url')
+    @image = attrs.fetch('image')
+    @duration = attrs.fetch('duration')
+    @user = Pexels::User.new(
+      id: attrs.fetch('user').fetch('id'),
+      name: attrs.fetch('user').fetch('name'),
+      url: attrs.fetch('user').fetch('url')
+    )
+
+  rescue KeyError => exception
+    raise Pexels::MalformedAPIResponseError.new(exception)
+  end
+end

data/lib/pexels.rb

@@ -0,0 +1,18 @@
+module Pexels
+  @api_base_url = 'https://api.pexels.com'
+
+  class << self
+    attr_reader :api_base_url
+  end
+end
+
+require_relative 'pexels/client'
+require_relative 'pexels/client/photos'
+require_relative 'pexels/client/videos'
+require_relative 'pexels/version'
+require_relative 'pexels/errors'
+require_relative 'pexels/photo'
+require_relative 'pexels/video'
+require_relative 'pexels/user'
+require_relative 'pexels/search_result'
+require_relative 'pexels/curated_result'

data/pexels.gemspec

@@ -0,0 +1,15 @@
+require_relative "lib/pexels/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'pexels'
+  s.version     = Pexels::VERSION
+  s.summary     = 'A simple Ruby wrapper for the Pexels API'
+  s.description = 'See more details at https://www.pexels.com/api/documentation/'
+  s.authors     = ['Pexels dev team']
+  s.email       = ['api@pexels.com']
+  s.homepage    = 'https://github.com/pexels/pexels-ruby'
+  s.license     = 'MIT'
+  s.files       = `git ls-files`.split("\n")
+
+  s.add_dependency('requests', '~> 1.0.2')
+end

data/test/client_test.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require 'pexels'
+
+class TestClient < Minitest::Test
+
+  def setup
+    @client = Pexels::Client.new(ENV.fetch('PEXELS_API_KEY'))
+  end
+
+  def test_ratelimit_remaining
+    @client.photos.search('test')
+
+    remaining = @client.ratelimit_remaining
+    assert remaining.is_a? Integer
+    assert remaining >= 0
+
+    @client.photos.search('test')
+    assert_equal remaining, @client.ratelimit_remaining + 1
+  end
+
+  def test_exceptions
+    fake_request = Requests::Response.new(200, {}, ';')
+
+    ::Requests.stub :request, fake_request do
+      begin
+        @client.photos.search('test')
+        raise 'this shouldnt happen'
+      rescue StandardError => exception
+        assert exception.is_a? Pexels::APIError
+        assert exception.message != 'this shouldnt happen'
+      end
+    end
+  end
+end

data/test/photo_test.rb

@@ -0,0 +1,70 @@
+require 'minitest/autorun'
+require 'pexels'
+
+class TestPhoto < Minitest::Test
+
+  def setup
+    @client = Pexels::Client.new(ENV.fetch('PEXELS_API_KEY'))
+    @photo = @client.photos.search('test', per_page: 1).photos.first
+  end
+
+  def test_successful_searches
+    search_result = @client.photos.search('test')
+
+    assert search_result.is_a? Pexels::SearchResult
+    assert search_result.next_page.is_a? String
+    assert search_result.total_results.is_a? Integer
+    assert_equal search_result.per_page, 15
+    assert_equal search_result.page, 1
+
+    assert search_result.photos.is_a? Array
+    assert search_result.photos.any?
+    assert search_result.photos.first.is_a? Pexels::Photo
+
+    search_result_with_params = @client.photos.search('test', per_page: 1, page: 2)
+    assert_equal search_result_with_params.per_page, 1
+    assert_equal search_result_with_params.page, 2
+    assert_equal search_result_with_params.photos.length, 1
+  end
+
+  def test_curated_photos
+    search_result = @client.photos.curated
+
+    assert search_result.is_a? Pexels::SearchResult
+    assert search_result.next_page.is_a? String
+    assert_equal search_result.per_page, 15
+    assert_equal search_result.page, 1
+
+    assert search_result.photos.is_a? Array
+    assert search_result.photos.any?
+    assert search_result.photos.first.is_a? Pexels::Photo
+
+    search_result_with_params = @client.photos.curated(per_page: 1, page: 2)
+    assert_equal search_result_with_params.per_page, 1
+    assert_equal search_result_with_params.page, 2
+    assert_equal search_result_with_params.photos.length, 1
+  end
+
+  def test_get_photo
+    photo = @client.photos.get(@photo.id)
+
+    assert photo.is_a? Pexels::Photo
+
+    assert_equal photo.id, @photo.id
+    assert_equal photo.width, @photo.width
+    assert_equal photo.height, @photo.height
+    assert_equal photo.url, @photo.url
+    assert_equal photo.user.name, @photo.user.name
+    assert_equal photo.user.url, @photo.user.url
+    assert_equal photo.user.id, @photo.user.id
+    assert_equal photo.src, @photo.src
+  end
+
+  def test_invalid_get_photo
+    photo = @client.photos.get('this-is-not-a-valid-id')
+    raise 'This should not happen'
+    rescue StandardError => exception
+      assert exception.is_a? Pexels::APIError
+      assert_equal exception.message, 'Not Found'
+  end
+end

data/test/video_test.rb

@@ -0,0 +1,73 @@
+require 'minitest/autorun'
+require 'pexels'
+
+class TestVideo < Minitest::Test
+
+  def setup
+    @client = Pexels::Client.new(ENV.fetch('PEXELS_API_KEY'))
+    @video = @client.videos.search('test', per_page: 1).videos.first
+  end
+
+  def test_successful_searches
+    search_result = @client.videos.search('test')
+
+    assert search_result.is_a? Pexels::SearchResult
+    assert search_result.total_results.is_a? Integer
+    assert_equal search_result.per_page, 15
+    assert_equal search_result.page, 1
+
+    assert search_result.videos.is_a? Array
+    assert search_result.videos.any?
+    assert search_result.videos.first.is_a? Pexels::Video
+
+    search_result_with_params = @client.videos.search('test', per_page: 1, page: 2)
+    assert_equal search_result_with_params.per_page, 1
+    assert_equal search_result_with_params.page, 2
+    assert_equal search_result_with_params.videos.length, 1
+  end
+
+  def test_popular_videos
+    search_result = @client.videos.popular
+
+    assert search_result.is_a? Pexels::SearchResult
+    assert_equal search_result.per_page, 15
+    assert_equal search_result.page, 1
+
+    assert search_result.videos.is_a? Array
+    assert search_result.videos.any?
+    assert search_result.videos.first.is_a? Pexels::Video
+
+    search_result_with_params = @client.videos.popular(per_page: 1, page: 2)
+    assert_equal search_result_with_params.per_page, 1
+    assert_equal search_result_with_params.page, 2
+    assert_equal search_result_with_params.videos.length, 1
+  end
+
+  def test_get_video
+    video = @client.videos.get(@video.id)
+
+    assert video.is_a? Pexels::Video
+
+    assert_equal video.id, @video.id
+    assert_equal video.width, @video.width
+    assert_equal video.height, @video.height
+    assert_equal video.url, @video.url
+
+    assert video.user.is_a?(Pexels::User)
+    assert_equal video.user.name, @video.user.name
+    assert_equal video.user.url, @video.user.url
+    assert_equal video.user.id, @video.user.id
+  end
+
+  def test_invalid_get_video
+    video = @client.videos.get('this-is-not-a-valid-id')
+    raise 'This should not happen'
+    rescue StandardError => exception
+      assert exception.is_a? Pexels::APIError
+      #assert_equal exception.message, 'Not Found'
+      #
+      ## This is incorrect  behavior from the API, which we should change
+      #  once its fixed.
+      assert_equal exception.message, 'Internal Server Error'
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: pexels
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pexels dev team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: requests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: See more details at https://www.pexels.com/api/documentation/
+email:
+- api@pexels.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gems"
+- ".gitignore"
+- LICENSE
+- Makefile
+- README.md
+- lib/pexels.rb
+- lib/pexels/client.rb
+- lib/pexels/client/photos.rb
+- lib/pexels/client/videos.rb
+- lib/pexels/curated_result.rb
+- lib/pexels/errors.rb
+- lib/pexels/photo.rb
+- lib/pexels/search_result.rb
+- lib/pexels/user.rb
+- lib/pexels/version.rb
+- lib/pexels/video.rb
+- pexels.gemspec
+- test/client_test.rb
+- test/photo_test.rb
+- test/video_test.rb
+homepage: https://github.com/pexels/pexels-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple Ruby wrapper for the Pexels API
+test_files: []