pexels 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fa972e637620e24f2466be1fa4dea4c68f54e0deae50a40b86adfd6148f6a23
-  data.tar.gz: b9892dde37db133e3d1e94113a9f00b7a74c21e4a6ac760bd226fcb1160b9d69
+  metadata.gz: 640a858dfa54cf40bfa1b9130913504974db246d4725330534f1a332eb8031b5
+  data.tar.gz: c45f2aedd96b3a9cdee7b61fb284be1de7bb3f7210fab6673eedb5260e7ee507
 SHA512:
-  metadata.gz: c823ada102ccde2f46e9fc8c3d1f82cc8c8914423558ac17f3bcd4168ba1008d83c8f49a479389cd2f1eea2f19b3096eac92cd6d2262c4507439cff5d7450088
-  data.tar.gz: 29c54e8c7413658efd570604ffe08a024c4af08865d9c3bf3002dcf74c9474d7c4e025924ab239974ce3c2e8ceb3b917ab68ce52084c95f5222b0bbadcdaf023
+  metadata.gz: a118ea1244d6232d6737ec4fcfc9e7dbe342042bad0ffd1319a1174a920837c6a499c7f62f0138c6b29e494c49873cd503ca0722eecc218f27ec8c8db7964751
+  data.tar.gz: 8a75b15f26dde2b2146877c5b55471798985ea3caba5db14d5702e6fe14410366af2da7d808eecf26136f878627f8a156b54e41e5dcf64eed81256fa42c43b43

data/CHANGES.md

@@ -1,5 +1,12 @@
 # Change log
 
+## 0.4.0
+* Add support for returning featured collections.
+
+## 0.3.0
+* Add support for photo and video search with filters.
+* Added `avg_color` attribute to `Photo` object.
+
 ## 0.2.1
 * Added `type`, `photo?` and `video?` helper methods to `Photo` and `Video` classes.
 

data/README.md

@@ -30,6 +30,12 @@ client = Pexels::Client.new('your-access-key')
 client.photos.search('Cloud')
 ```
 
+### Search for photos with filters
+
+```ruby
+client.photos.search('Dog', color: :yellow, size: :large, orientation: :square)
+```
+
 ### Find a specific photo
 
 ```ruby
@@ -50,6 +56,12 @@ client.photos.curated
 client.videos.search('waves')
 ```
 
+### Search for videos with filters
+
+```ruby
+client.videos.search('Beach', size: :medium, orientation: :landscape)
+```
+
 ### Find a specific photo
 
 ```ruby
@@ -71,6 +83,11 @@ Note: this is limited to collections belonging to the API user.
 ```ruby
 client.collections.all
 ```
+### List all featured collections.
+
+```ruby
+client.collections.featured.all
+```
 
 ### Get all media for a collection
 

data/lib/pexels/client/collections.rb

@@ -3,24 +3,47 @@ class Pexels::Client::Collections
     @client = client
   end
 
-  def all(per_page: 15, page: 1)
+  def all(per_page: 15, page: 1, timeout: { open: nil, read: nil })
     response = @client.request(
       "#{Pexels.api_version}/collections",
       params: {
         per_page: per_page,
         page: page
+      },
+      options: {
+        open_timeout: timeout[:open],
+        read_timeout: timeout[:read]
       })
 
     Pexels::CollectionSet.new(response)
   end
 
-  def [](id, type: nil, per_page: 15, page: 1)
+  def featured(per_page: 15, page: 1, timeout: { open: nil, read: nil })
+    response = @client.request(
+      "#{Pexels.api_version}/collections/featured",
+      params: {
+        per_page: per_page,
+        page: page
+      },
+      options: {
+        open_timeout: timeout[:open],
+        read_timeout: timeout[:read]
+      })
+
+    Pexels::CollectionSet.new(response)
+  end
+
+  def [](id, type: nil, per_page: 15, page: 1, timeout: { open: nil, read: nil })
     response = @client.request(
       "#{Pexels.api_version}/collections/#{id}",
       params: {
         per_page: per_page,
         page: page,
         type: type
+      },
+      options: {
+        open_timeout: timeout[:open],
+        read_timeout: timeout[:read]
       })
 
     Pexels::CollectionMediaSet.new(response)

data/lib/pexels/client/photos.rb

@@ -1,38 +1,67 @@
-class Pexels::Client::Photos
+module Pexels
+  class Client
+    class Photos
+      include SearchFilters
 
-  def initialize(client)
-    @client = client
-  end
+      def initialize(client)
+        @client = client
+      end
 
-  def [](id)
-    response = @client.request("#{Pexels.api_version}/photos/#{id}")
-    Pexels::Photo.new(response.body)
-  end
-  alias_method :find, :[]
-
-  def search(query, per_page: 15, page: 1, locale: 'en-US')
-    response = @client.request(
-      "#{Pexels.api_version}/search",
-      params: {
-        query: query,
-        per_page: per_page,
-        page: page,
-        locale: locale
-      }
-    )
-
-    Pexels::PhotoSet.new(response)
-  end
+      def [](id, timeout: { open: nil, read: nil })
+        response = @client.request(
+          "#{Pexels.api_version}/photos/#{id}",
+          options: { open_timeout: timeout[:open], read_timeout: timeout[:read] }
+        )
+        Pexels::Photo.new(response.body)
+      end
+      alias_method :find, :[]
+
+      def search(query, per_page: 15, page: 1, locale: 'en-US', orientation: nil, size: nil, color: nil, timeout: { open: nil, read: nil })
+        validate_search_params(orientation, size, color)
+
+        response = @client.request(
+          "#{Pexels.api_version}/search",
+          params: {
+            query: query,
+            per_page: per_page,
+            page: page,
+            locale: locale,
+            orientation: orientation,
+            size: size,
+            color: color
+          }.compact,
+          options: {
+            open_timeout: timeout[:open],
+            read_timeout: timeout[:read]
+          }
+        )
+
+        Pexels::PhotoSet.new(response)
+      end
+
+      def curated(per_page: 15, page: 1, timeout: { open: nil, read: nil })
+        response = @client.request(
+          "#{Pexels.api_version}/curated",
+          params: {
+            per_page: per_page,
+            page: page
+          },
+          options: {
+            open_timeout: timeout[:open],
+            read_timeout: timeout[:read]
+          }
+        )
+
+        Pexels::PhotoSet.new(response)
+      end
 
-  def curated(per_page: 15, page: 1)
-    response = @client.request(
-      "#{Pexels.api_version}/curated",
-      params: {
-        per_page: per_page,
-        page: page,
-      }
-    )
+      private
 
-    Pexels::PhotoSet.new(response)
+      def validate_search_params(orientation, size, color)
+        validate_orientation(orientation) &&
+          validate_size(size) &&
+          validate_color(color)
+      end
+    end
   end
 end

data/lib/pexels/client/request.rb

@@ -3,13 +3,14 @@ require 'requests'
 module Pexels
   class Client
     class Request
-      attr_reader :api_key, :path, :method, :params
+      attr_reader :api_key, :path, :method, :params, :options
 
-      def initialize(api_key, path, method, params)
+      def initialize(api_key, path, method, params, options)
         @api_key = api_key
         @path = path
         @method = method
         @params = params
+        @options = options
       end
 
       def call
@@ -28,7 +29,8 @@ module Pexels
           method,
           url,
           params: params,
-          headers: headers
+          headers: headers,
+          options: options
         )
       end
 

data/lib/pexels/client/search_filters.rb

@@ -0,0 +1,31 @@
+module Pexels
+  class Client
+    module SearchFilters
+      ORIENTATIONS = %w(portrait landscape square).freeze
+      SIZES = %w(small medium large).freeze
+      COLORS = %w(red orange yellow green turquoise blue violet pink brown black gray white).freeze
+
+      def validate_orientation(orientation)
+        return true unless orientation
+        return true if ORIENTATIONS.include?(orientation.to_s)
+
+        raise ArgumentError, "`orientation` must be one of #{ORIENTATIONS.join(', ')}."
+      end
+
+      def validate_size(size)
+        return true unless size
+        return true if SIZES.include?(size.to_s)
+
+        raise ArgumentError, "`size` must be one of #{SIZES.join(', ')}."
+      end
+
+      def validate_color(color)
+        return true unless color
+        return true if COLORS.include?(color.to_s)
+        return true if color.to_s =~ /\A#?(?:[0-9a-f]{3}){1,2}\z/i
+
+        raise ArgumentError, "`color` must be one of #{COLORS.join(', ')} or a valid hex code."
+      end
+    end
+  end
+end

data/lib/pexels/client/videos.rb

@@ -1,37 +1,67 @@
-class Pexels::Client::Videos
+module Pexels
+  class Client
+    class Videos
+      include SearchFilters
 
-  def initialize(client)
-    @client = client
-  end
+      def initialize(client)
+        @client = client
+      end
 
-  def [](id)
-    response = @client.request("/videos/videos/#{id}")
-    Pexels::Video.new(response.body)
-  end
-  alias_method :find, :[]
-
-  def search(query, per_page: 15, page: 1)
-    response = @client.request(
-      '/videos/search',
-      params: {
-        query: query,
-        per_page: per_page,
-        page: page,
-      }
-    )
-
-    Pexels::VideoSet.new(response)
-  end
+      def [](id, timeout: { open: nil, read: nil })
+        response = @client.request(
+          "/videos/videos/#{id}",
+          options: {
+            open_timeout: timeout[:open],
+            read_timeout: timeout[:read]
+          }
+        )
+        Pexels::Video.new(response.body)
+      end
+      alias_method :find, :[]
+
+      def search(query, per_page: 15, page: 1, orientation: nil, size: nil, timeout: { open: nil, read: nil })
+        validate_search_params(orientation, size)
+
+        response = @client.request(
+          '/videos/search',
+          params: {
+            query: query,
+            per_page: per_page,
+            page: page,
+            orientation: orientation,
+            size: size
+          }.compact,
+          options: {
+            open_timeout: timeout[:open],
+            read_timeout: timeout[:read]
+          }
+        )
+
+        Pexels::VideoSet.new(response)
+      end
+
+      def popular(per_page: 15, page: 1, timeout: { open: nil, read: nil })
+        response = @client.request(
+          '/videos/popular',
+          params: {
+            per_page: per_page,
+            page: page
+          },
+          options: {
+            open_timeout: timeout[:open],
+            read_timeout: timeout[:read]
+          }
+        )
+
+        Pexels::VideoSet.new(response)
+      end
 
-  def popular(per_page: 15, page: 1)
-    response = @client.request(
-      '/videos/popular',
-      params: {
-        per_page: per_page,
-        page: page,
-      }
-    )
+      private
 
-    Pexels::VideoSet.new(response)
+      def validate_search_params(orientation, size)
+        validate_orientation(orientation) &&
+          validate_size(size)
+      end
+    end
   end
 end

data/lib/pexels/client.rb

@@ -19,8 +19,8 @@ module Pexels
       @collections ||= Pexels::Client::Collections.new(self)
     end
 
-    def request(path, method: 'GET', params: {})
-      request = Request.new(api_key, path, method, params)
+    def request(path, method: 'GET', params: {}, options: {})
+      request = Request.new(api_key, path, method, params, options)
       request.call.tap do |response|
         @ratelimit_remaining = response.ratelimit_remaining
       end

data/lib/pexels/photo.rb

@@ -4,8 +4,8 @@ class Pexels::Photo
               :height,
               :url,
               :user,
-              :src
-
+              :src,
+              :avg_color
 
   def initialize(attrs)
     @id = attrs.fetch('id')
@@ -18,6 +18,7 @@ class Pexels::Photo
       url: attrs.fetch('photographer_url')
     )
     @src = attrs.fetch('src')
+    @avg_color = attrs.fetch('avg_color')
 
   rescue KeyError => exception
     raise Pexels::MalformedAPIResponseError.new(exception)

data/lib/pexels/version.rb

@@ -1,3 +1,3 @@
 module Pexels
-  VERSION = '0.2.1'
+  VERSION = '0.5.0'
 end

data/lib/pexels.rb

@@ -25,6 +25,7 @@ end
 require_relative 'pexels/client'
 require_relative 'pexels/client/request'
 require_relative 'pexels/client/response'
+require_relative 'pexels/client/search_filters'
 require_relative 'pexels/client/collections'
 require_relative 'pexels/client/photos'
 require_relative 'pexels/client/videos'

data/test/collection_test.rb

@@ -27,6 +27,25 @@ class TestCollections < Minitest::Test
     assert_kind_of Pexels::CollectionSet, collection_with_params.prev_page
   end
 
+  def test_featured
+    collection = @client.collections.featured
+
+    assert_kind_of Pexels::CollectionSet, collection
+    assert_equal collection.per_page, 15
+    assert_equal collection.page, 1
+
+    assert collection.collections.is_a? Array
+    assert collection.collections.any?
+    assert collection.first.is_a? Pexels::Collection
+
+    collection_with_params = @client.collections.featured(per_page: 1, page: 2)
+    assert_equal collection_with_params.per_page, 1
+    assert_equal collection_with_params.page, 2
+    assert_equal collection_with_params.collections.length, 1
+    assert_kind_of Pexels::CollectionSet, collection_with_params.next_page
+    assert_kind_of Pexels::CollectionSet, collection_with_params.prev_page
+  end
+
   def test_get_collection_media
     collection = @client.collections[@collection.id]
     assert_kind_of Pexels::CollectionMediaSet, collection
@@ -74,10 +93,57 @@ class TestCollections < Minitest::Test
   end
 
   def test_invalid_get_collection
-    @client.collections['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'
+    error = assert_raises(Pexels::APIError) do
+      @client.collections['this-is-not-a-valid-id']
+    end
+    assert error.message, 'Not Found'
+  end
+
+  def test_get_collection_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.collections[@collection.id, timeout: { open: 0.0000001 }]
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_get_collection_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.collections[@collection.id, timeout: { read: 0.0000001 }]
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
+  end
+
+  def test_all_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.collections.all(timeout: { open: 0.0000001 })
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_all_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.collections.all(timeout: { read: 0.0000001 })
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
+  end
+
+  def test_featured_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.collections.featured(timeout: { open: 0.0000001 })
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_featured_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.collections.featured(timeout: { read: 0.0000001 })
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
   end
 end

data/test/photo_test.rb

@@ -60,6 +60,7 @@ class TestPhoto < Minitest::Test
     assert_equal photo.user.url, @photo.user.url
     assert_equal photo.user.id, @photo.user.id
     assert_equal photo.src, @photo.src
+    assert_equal photo.avg_color, @photo.avg_color
 
     assert photo.photo?
     assert_equal photo.type, 'Photo'
@@ -67,10 +68,91 @@ class TestPhoto < Minitest::Test
   end
 
   def test_invalid_get_photo
-    photo = @client.photos['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'
+    error = assert_raises(Pexels::APIError) do
+      @client.photos['this-is-not-a-valid-id']
+    end
+    assert_equal 'Not Found', error.message
+  end
+
+  def test_invalid_orientation
+    error = assert_raises(ArgumentError) do
+      @client.photos.search('dog', orientation: 'foo')
+    end
+    assert_match '`orientation` must be one of', error.message
+  end
+
+  def test_invalid_size
+    error = assert_raises(ArgumentError) do
+      @client.photos.search('dog', size: 'foo')
+    end
+    assert_match '`size` must be one of', error.message
+  end
+
+  def test_invalid_color
+    error = assert_raises(ArgumentError) do
+      @client.photos.search('dog', color: 'foo')
+    end
+    assert_match '`color` must be one of', error.message
+  end
+
+  def test_invalid_color_hex
+    error = assert_raises(ArgumentError) do
+      @client.photos.search('dog', color: '#gggggg')
+    end
+    assert_match '`color` must be one of', error.message
+  end
+
+  def test_search_filters
+    search_result = @client.photos.search('dog', color: '#FF0000', size: :large, orientation: :square)
+    assert_kind_of Pexels::PhotoSet, search_result
+    assert search_result.photos.any?
+  end
+
+  def test_get_photo_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.photos[@photo.id, timeout: { open: 0.0000001 }]
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_get_photo_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.photos[@photo.id, timeout: { read: 0.0000001 }]
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
+  end
+
+  def test_search_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.photos.search('test', timeout: { open: 0.0000001 })
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_search_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.photos.search('test', timeout: { read: 0.0000001 })
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
+  end
+
+  def test_curated_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.photos.curated(timeout: { open: 0.0000001 })
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_curated_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.photos.curated(timeout: { read: 0.0000001 })
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
   end
 end

data/test/video_test.rb

@@ -74,10 +74,77 @@ class TestVideo < Minitest::Test
   end
 
   def test_invalid_get_video
-    video = @client.videos['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'
+    error = assert_raises(Pexels::APIError) do
+      @client.videos['this-is-not-a-valid-id']
+    end
+    assert_equal 'Not Found', error.message
+  end
+
+  def test_invalid_orientation
+    error = assert_raises(ArgumentError) do
+      @client.photos.search('dog', orientation: 'foo')
+    end
+    assert_match '`orientation` must be one of', error.message
+  end
+
+  def test_invalid_size
+    error = assert_raises(ArgumentError) do
+      @client.photos.search('dog', size: 'foo')
+    end
+    assert_match '`size` must be one of', error.message
+  end
+
+  def test_search_filters
+    search_result = @client.videos.search('cat', size: :medium, orientation: :square)
+    assert_kind_of Pexels::VideoSet, search_result
+    assert search_result.videos.any?
+  end
+
+  def test_get_video_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.videos[@video.id, timeout: { open: 0.0000001 }]
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_get_video_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.videos[@video.id, timeout: { read: 0.0000001 }]
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
+  end
+
+  def test_search_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.videos.search('cat', timeout: { open: 0.0000001 })
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_search_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.videos.search('cat', timeout: { read: 0.0000001 })
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
+  end
+
+  def test_featured_open_timeout
+    error = assert_raises Pexels::APIError do
+      @client.videos.popular(timeout: { open: 0.0000001 })
+    end
+
+    assert_equal 'execution expired', error.message
+  end
+
+  def test_featured_read_timeout
+    error = assert_raises Pexels::APIError do
+      @client.videos.popular(timeout: { read: 0.0000001 })
+    end
+
+    assert_equal 'Net::ReadTimeout', error.message
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pexels
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Pexels dev team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: requests
@@ -44,6 +44,7 @@ files:
 - lib/pexels/client/photos.rb
 - lib/pexels/client/request.rb
 - lib/pexels/client/response.rb
+- lib/pexels/client/search_filters.rb
 - lib/pexels/client/videos.rb
 - lib/pexels/collection.rb
 - lib/pexels/collection_media_set.rb
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A simple Ruby wrapper for the Pexels API