pexels 0.0.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd0b9df9874a218b1f0553181a9fafe4f78719c7323acd8b74015ed8c472f99c
-  data.tar.gz: 327f7cbd27a846c8a05cc1cb89061ec31e4aee6e885a2e6776b1c802ef3cc104
+  metadata.gz: fbc208fe2d27e3dca7c1b94e0e2a3901334d06b9cf3460d952a44aea437bd82e
+  data.tar.gz: f4796400297cf53c41b0740eb57ae9b70efd697018d20c17c0e91f92c9030dc6
 SHA512:
-  metadata.gz: 3a0d3dacb30401f4d1e0de8322ec47f0e8949dbfe53b216832aa0a79361666f5cbb5c9838ab8ac904333537040d6a9639152b6ad7de5098325e1488619971116
-  data.tar.gz: 30d628a14aa5d60094501448caae6747deb8e4ea56f5b6e5cfa4c59da65bda750a3d3247c4f09b6bb47dec3a996335dca346d85470db0b65f07aee7c7c70a2b9
+  metadata.gz: e050b1e25f4f66b370f1acd2695af58305cd221e7c7d9a67cf4f989bdc3959af172aaebc65b545507992af0a6d24594e19601f316f5b1e2145ebbbc59eae46ce
+  data.tar.gz: 5a334832f860fcbb21dde178bdd871491d70efdeccfa5515309186596fcd1884b4ca3884bd6a6574343daa40623524ce20137366096460a015372a09365020aa

data/.gitignore

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

data/CHANGES.md

@@ -0,0 +1,25 @@
+# Change log
+
+## 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.
+
+## 0.2.0
+* Fixed incorrect URL for collections endpoints.
+* Added pagination methods `next_page` and `prev_page` to `PaginatedResponse`.
+* Added `total_pages` to `PaginatedResponse`.
+* Extracted `Request` and `Response` objects for reusability.
+* Added `Pexels/Ruby` `User-Agent` header to requests.
+
+## 0.1.0
+* Add support for returning collections belonging to the API user.
+* Add support for returning media from a collection.
+
+## 0.0.4
+* Add `find` as an alias for `photos[]` and `videos[]`.
+
+## 0.0.3
+* Initial release.

data/README.md

@@ -12,7 +12,7 @@ Or add it to your `Gemfile` and run `bundle install`.
 
 ## Documentation
 
-See the API docs [here](https://www.pexels.com/api/documentation/?language=js)
+See the API docs [here](https://www.pexels.com/api/documentation/?language=rb)
 
 
 ## Basic usage
@@ -34,6 +34,8 @@ client.photos.search('Cloud')
 
 ```ruby
 client.photos[2014422]
+# or
+client.photos.find(2014422)
 ```
 
 ### Browse curated photos
@@ -52,6 +54,8 @@ client.videos.search('waves')
 
 ```ruby
 client.videos[2014422]
+# or
+client.videos.find(2014422)
 ```
 
 ### Browse popular videos
@@ -60,6 +64,57 @@ client.videos[2014422]
 client.videos.popular
 ```
 
+### List all collections
+
+Note: this is limited to collections belonging to the API user.
+
+```ruby
+client.collections.all
+```
+
+### Get all media for a collection
+
+```ruby
+client.collections['collection-id'].media
+# or
+client.collections.find('collection-id').media
+```
+
+You can also filter for only `photos` or `videos`.
+
+```ruby
+client.collections['collection-id', type: 'photos'].media
+client.collections['collection-id', type: 'videos'].media
+```
+
+## Rate Limiting
+
+After performing a request, you can access your remaining rate limit via the client.
+
+```ruby
+client.ratelimit_remaining
+```
+
+## Pagination
+
+Requests that return multiple objects are paginated. You can pass in `page` and `per_page` options to these requests to get a specific page. You can also access the total number of results by accessing `total_results` on the response. 
+
+Note: The Pexels API returns a maximum of 80 records for one request.
+
+```ruby
+response = client.photos.search('dog', page: 2, per_page: 50)
+response.total_results #=> 1000
+response.total_pages #= 20
+```
+
+If there are further pages, you can also paginate through the API client:
+
+```ruby
+response = client.photos.search('dog', page: 2, per_page: 50)
+response.prev_page # queries page 1
+response.next_page # queries page 3
+```
+
 ## 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/)

data/lib/pexels.rb

@@ -1,19 +1,44 @@
 module Pexels
-  @api_base_url = 'https://api.pexels.com'
+  @api_base_url = ENV['PEXELS_API_BASE_URL'] || 'https://api.pexels.com'
+  @api_version = ENV['PEXELS_API_VERSION'] || 'v1'
 
   class << self
-    attr_reader :api_base_url
+    attr_reader :api_base_url, :api_version
+
+    # Local headers can be defined inside a `.headers` file at the project root,
+    # with the following format:
+    #
+    # header1=value
+    # header2=value
+    # etc.
+    #
+    def local_headers
+      @local_headers ||= if File.exist?('.headers')
+          File.read('.headers').split.to_h { |header| header.split('=') }
+        else
+          {}
+        end
+    end
   end
 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'
 require_relative 'pexels/version'
 require_relative 'pexels/errors'
+require_relative 'pexels/collection'
 require_relative 'pexels/photo'
 require_relative 'pexels/video'
 require_relative 'pexels/video/file'
 require_relative 'pexels/video/picture'
 require_relative 'pexels/user'
-require_relative 'pexels/response'
+require_relative 'pexels/paginated_response'
+require_relative 'pexels/collection_set'
+require_relative 'pexels/collection_media_set'
+require_relative 'pexels/photo_set'
+require_relative 'pexels/video_set'

data/lib/pexels/client.rb

@@ -1,39 +1,29 @@
-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)
+module Pexels
+  class 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 collections
+      @collections ||= Pexels::Client::Collections.new(self)
+    end
+
+    def request(path, method: 'GET', params: {})
+      request = Request.new(api_key, path, method, params)
+      request.call.tap do |response|
+        @ratelimit_remaining = response.ratelimit_remaining
+      end
+    end
   end
 end
-
-require 'pexels/client/photos'
-require 'pexels/client/videos'

data/lib/pexels/client/collections.rb

@@ -0,0 +1,29 @@
+class Pexels::Client::Collections
+  def initialize(client)
+    @client = client
+  end
+
+  def all(per_page: 15, page: 1)
+    response = @client.request(
+      "#{Pexels.api_version}/collections",
+      params: {
+        per_page: per_page,
+        page: page
+      })
+
+    Pexels::CollectionSet.new(response)
+  end
+
+  def [](id, type: nil, per_page: 15, page: 1)
+    response = @client.request(
+      "#{Pexels.api_version}/collections/#{id}",
+      params: {
+        per_page: per_page,
+        page: page,
+        type: type
+      })
+
+    Pexels::CollectionMediaSet.new(response)
+  end
+  alias_method :find, :[]
+end

data/lib/pexels/client/photos.rb

@@ -1,37 +1,56 @@
-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("/v1/photos/#{id}")
-    Pexels::Photo.new(response)
-  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(
-      '/v1/search',
-      params: {
-        query: query,
-        per_page: per_page,
-        page: page,
-        locale: locale
-      }
-    )
-
-    Pexels::Response.new(response)
-  end
+      def search(query, per_page: 15, page: 1, locale: 'en-US', orientation: nil, size: nil, color: 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
+        )
+
+        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
+          }
+        )
+
+        Pexels::PhotoSet.new(response)
+      end
 
-  def curated(per_page: 15, page: 1)
-    response = @client.request(
-      '/v1/curated',
-      params: {
-        per_page: per_page,
-        page: page,
-      }
-    )
+      private
 
-    Pexels::Response.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

@@ -0,0 +1,53 @@
+require 'requests'
+
+module Pexels
+  class Client
+    class Request
+      attr_reader :api_key, :path, :method, :params
+
+      def initialize(api_key, path, method, params)
+        @api_key = api_key
+        @path = path
+        @method = method
+        @params = params
+      end
+
+      def call
+        log_request if ENV['DEBUG']
+
+        Response.new(self, execute)
+
+      rescue StandardError => exception
+        raise Pexels::APIError.new(exception)
+      end
+
+      private
+
+      def execute
+        Requests.request(
+          method,
+          url,
+          params: params,
+          headers: headers
+        )
+      end
+
+      def url
+        @url ||= File.join(Pexels.api_base_url, path)
+      end
+
+      def headers
+        @headers = {
+          'Authorization' => api_key,
+          'User-Agent' => "Pexels/Ruby (#{Pexels::VERSION})"
+        }.merge(Pexels.local_headers)
+      end
+
+      def log_request
+        puts "Requesting #{url}"
+        puts " → params: #{params}"
+        puts " → headers: #{headers}"
+      end
+    end
+  end
+end

data/lib/pexels/client/response.rb

@@ -0,0 +1,29 @@
+require 'requests'
+
+module Pexels
+  class Client
+    class Response
+      attr_reader :request, :response
+
+      def initialize(request, response)
+        @request = request
+        @response = response
+      end
+
+      def body
+        JSON.parse(response.body)
+
+      rescue JSON::JSONError => exception
+        raise Pexels::APIError.new(exception)
+      end
+
+      def headers
+        response.headers
+      end
+
+      def ratelimit_remaining
+        headers['x-ratelimit-remaining']&.first&.to_i
+      end
+    end
+  end
+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,36 +1,53 @@
-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)
-  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::Response.new(response)
-  end
+      def search(query, per_page: 15, page: 1, orientation: nil, size: 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
+        )
+
+        Pexels::VideoSet.new(response)
+      end
+
+      def popular(per_page: 15, page: 1)
+        response = @client.request(
+          '/videos/popular',
+          params: {
+            per_page: per_page,
+            page: page,
+          }
+        )
+
+        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::Response.new(response)
+      def validate_search_params(orientation, size)
+        validate_orientation(orientation) &&
+          validate_size(size)
+      end
+    end
   end
 end

data/lib/pexels/collection.rb

@@ -0,0 +1,25 @@
+module Pexels
+  class Collection
+    attr_reader :id,
+                :title,
+                :description,
+                :private,
+                :media_count,
+                :photos_count,
+                :videos_count
+
+
+    def initialize(attrs)
+      @id = attrs.fetch('id')
+      @title = attrs.fetch('title')
+      @description = attrs.fetch('description')
+      @private = attrs.fetch('private')
+      @media_count = attrs.fetch('media_count')
+      @photos_count = attrs.fetch('photos_count')
+      @videos_count = attrs.fetch('videos_count')
+
+    rescue KeyError => exception
+      raise Pexels::MalformedAPIResponseError.new(exception)
+    end
+  end
+end

data/lib/pexels/collection_media_set.rb

@@ -0,0 +1,31 @@
+module Pexels
+  class CollectionMediaSet < PaginatedResponse
+    alias_method :media, :data
+    public :media
+
+    attr_reader :id
+
+    def initialize(response)
+      super
+      @id = attrs.fetch('id')
+      @data = attrs.fetch('media', []).map do |attrs|
+        if attrs['type'] == 'Photo'
+          Pexels::Photo.new(attrs)
+        elsif attrs['type'] == 'Video'
+          Pexels::Video.new(attrs)
+        end
+      end
+
+    rescue KeyError => exception
+      raise Pexels::MalformedAPIResponseError.new(exception)
+    end
+
+    def photos
+      @photos ||= media.select { |m| m.is_a?(Pexels::Photo) }
+    end
+
+    def videos
+      @videos ||= media.select { |m| m.is_a?(Pexels::Video) }
+    end
+  end
+end

data/lib/pexels/collection_set.rb

@@ -0,0 +1,11 @@
+module Pexels
+  class CollectionSet < PaginatedResponse
+    alias_method :collections, :data
+    public :collections
+
+    def initialize(response)
+      super
+      @data = attrs.fetch('collections', []).map { |attrs| Pexels::Collection.new(attrs) }
+    end
+  end
+end

data/lib/pexels/paginated_response.rb

@@ -0,0 +1,63 @@
+require 'cgi'
+
+module Pexels
+  class PaginatedResponse
+    include Enumerable
+
+    attr_reader :total_results,
+      :page,
+      :per_page,
+      :data
+
+    private :data
+
+    def initialize(response)
+      @response = response
+      @attrs = @response.body
+
+      @total_results = attrs.fetch('total_results', nil)
+      @page = attrs.fetch('page')
+      @per_page = attrs.fetch('per_page')
+      @prev_page = attrs.fetch('prev_page', nil)
+      @next_page = attrs.fetch('next_page', nil)
+    end
+
+    def total_pages
+      total_results.fdiv(per_page).ceil
+    end
+
+    def each(&block)
+      if block_given?
+        data.each(&block)
+      else
+        to_enum(:each)
+      end
+    end
+
+    def next_page
+      return unless @next_page
+
+      request.params[:page] = extract_page(@next_page)
+      self.class.new(request.call)
+    end
+
+    def prev_page
+      return unless @prev_page
+
+      request.params[:page] = extract_page(@next_page)
+      self.class.new(request.call)
+    end
+
+    private
+
+    attr_reader :response, :attrs
+
+    def request
+      response.request
+    end
+
+    def extract_page(url)
+      CGI.parse(URI.parse(url).query)['page'].first
+    end
+  end
+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,8 +18,21 @@ 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)
   end
+
+  def type
+    'Photo'
+  end
+
+  def photo?
+    true
+  end
+
+  def video?
+    false
+  end
 end

data/lib/pexels/photo_set.rb

@@ -0,0 +1,14 @@
+module Pexels
+  class PhotoSet < PaginatedResponse
+    alias_method :photos, :data
+    public :photos
+
+    def initialize(response)
+      super
+      @data = attrs.fetch('photos', []).map { |attrs| Pexels::Photo.new(attrs) }
+
+    rescue KeyError => exception
+      raise Pexels::MalformedAPIResponseError.new(exception)
+    end
+  end
+end

data/lib/pexels/version.rb

@@ -1,3 +1,3 @@
 module Pexels
-  VERSION = '0.0.3'
+  VERSION = '0.3.0'
 end

data/lib/pexels/video.rb

@@ -31,4 +31,16 @@ class Pexels::Video
   rescue KeyError => exception
     raise Pexels::MalformedAPIResponseError.new(exception)
   end
+
+  def type
+    'Video'
+  end
+
+  def photo?
+    false
+  end
+
+  def video?
+    true
+  end
 end

data/lib/pexels/video_set.rb

@@ -0,0 +1,14 @@
+module Pexels
+  class VideoSet < PaginatedResponse
+    alias_method :videos, :data
+    public :videos
+
+    def initialize(response)
+      super
+      @data = attrs.fetch('videos', []).map { |attrs| Pexels::Video.new(attrs) }
+
+    rescue KeyError => exception
+      raise Pexels::MalformedAPIResponseError.new(exception)
+    end
+  end
+end

data/pexels.gemspec

@@ -11,5 +11,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.files       = `git ls-files`.split("\n")
 
+  s.required_ruby_version = '>= 2.4.0'
+
   s.add_dependency('requests', '~> 1.0.2')
 end

data/test/client_test.rb

@@ -15,7 +15,7 @@ class TestClient < Minitest::Test
     assert remaining >= 0
 
     @client.photos.search('test')
-    assert_equal remaining, @client.ratelimit_remaining + 1
+    assert_equal @client.ratelimit_remaining, remaining - 1
   end
 
   def test_exceptions
@@ -26,7 +26,7 @@ class TestClient < Minitest::Test
         @client.photos.search('test')
         raise 'this shouldnt happen'
       rescue StandardError => exception
-        assert exception.is_a? Pexels::APIError
+        assert_kind_of Pexels::APIError, exception
         assert exception.message != 'this shouldnt happen'
       end
     end

data/test/collection_test.rb

@@ -0,0 +1,82 @@
+require 'minitest/autorun'
+require 'pexels'
+
+class TestCollections < Minitest::Test
+
+  def setup
+    @client = Pexels::Client.new(ENV.fetch('PEXELS_API_KEY'))
+    @collection = @client.collections.all(per_page: 1).first
+  end
+
+  def test_all
+    collection = @client.collections.all
+
+    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.all(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
+    assert_equal collection.id, @collection.id
+
+    assert_kind_of Array, collection.media
+    assert collection.media.any?
+
+    assert_includes([Pexels::Photo, Pexels::Video], collection.media.first.class)
+
+    refute_includes([Pexels::Video], collection.photos.map(&:class))
+    refute_includes([Pexels::Photo], collection.videos.map(&:class))
+  end
+
+  def test_get_collection_photos
+    collection = @client.collections[@collection.id, type: 'photos']
+    assert_kind_of Pexels::CollectionMediaSet, collection
+    assert_kind_of Array, collection.media
+    assert collection.media.all? { |m| m.is_a?(Pexels::Photo) }
+  end
+
+  def test_get_collection_videos
+    collection = @client.collections[@collection.id, type: 'videos']
+    assert_kind_of Pexels::CollectionMediaSet, collection
+    assert_kind_of Array, collection.media
+    assert collection.media.all? { |m| m.is_a?(Pexels::Video) }
+  end
+
+  def test_get_collection_invalid_type
+    collection = @client.collections[@collection.id, type: 'foo']
+    assert_kind_of Pexels::CollectionMediaSet, collection
+    assert_kind_of Array, collection.media
+    assert collection.any?
+  end
+
+  def test_get_collection_pagination
+    collection = @client.collections[@collection.id, per_page: 1, page: 1]
+    assert_kind_of Pexels::CollectionMediaSet, collection
+    assert_kind_of Array, collection.media
+    assert collection.media.any?
+
+    assert_equal collection.per_page, 1
+    assert_equal collection.page, 1
+    assert_equal collection.media.length, 1
+  end
+
+  def test_invalid_get_collection
+    error = assert_raises(Pexels::APIError) do
+      @client.collections['this-is-not-a-valid-id']
+    end
+    assert error.message, 'Not Found'
+  end
+end

data/test/photo_test.rb

@@ -5,44 +5,46 @@ 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
+    @photo = @client.photos.search('test', per_page: 1).first
   end
 
   def test_successful_searches
     search_result = @client.photos.search('test')
 
-    assert search_result.is_a? Pexels::Response
-    assert search_result.next_page.is_a? String
-    assert search_result.total_results.is_a? Integer
+    assert_kind_of Pexels::PhotoSet, search_result
+    assert_kind_of Pexels::PhotoSet, search_result.next_page
+    assert_kind_of Integer, search_result.total_results
     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
+    assert search_result.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
+    assert_kind_of Pexels::PhotoSet, search_result_with_params.prev_page
   end
 
   def test_curated_photos
     search_result = @client.photos.curated
 
-    assert search_result.is_a? Pexels::Response
-    assert search_result.next_page.is_a? String
+    assert_kind_of Pexels::PhotoSet, search_result
+    assert_kind_of Pexels::PhotoSet, search_result.next_page
     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
+    assert search_result.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
+    assert_kind_of Pexels::PhotoSet, search_result_with_params.prev_page
   end
 
   def test_get_photo
@@ -58,13 +60,51 @@ 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'
+    refute photo.video?
   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
 end

data/test/video_test.rb

@@ -5,42 +5,46 @@ 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
+    @video = @client.videos.search('test', per_page: 1).first
   end
 
   def test_successful_searches
     search_result = @client.videos.search('test')
 
-    assert search_result.is_a? Pexels::Response
-    assert search_result.total_results.is_a? Integer
+    assert_kind_of Pexels::VideoSet, search_result
+    assert_kind_of Pexels::VideoSet, search_result.next_page
+    assert_kind_of Integer, search_result.total_results
     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
+    assert search_result.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
+    assert_kind_of Pexels::VideoSet, search_result_with_params.prev_page
   end
 
   def test_popular_videos
     search_result = @client.videos.popular
 
-    assert search_result.is_a? Pexels::Response
+    assert_kind_of Pexels::VideoSet, search_result
+    assert_kind_of Pexels::VideoSet, search_result.next_page
     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
+    assert search_result.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
+    assert_kind_of Pexels::VideoSet, search_result_with_params.prev_page
   end
 
   def test_get_video
@@ -53,6 +57,10 @@ class TestVideo < Minitest::Test
     assert_equal video.height, @video.height
     assert_equal video.url, @video.url
 
+    assert video.video?
+    assert_equal video.type, 'Video'
+    refute video.photo?
+
     assert video.user.is_a?(Pexels::User)
     assert_equal video.user.name, @video.user.name
     assert_equal video.user.url, @video.user.url
@@ -66,14 +74,29 @@ 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'
-      #
-      ## This is incorrect  behavior from the API, which we should change
-      #  once its fixed.
-      assert_equal exception.message, 'Internal Server Error'
+    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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pexels
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Pexels dev team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: requests
@@ -34,23 +34,34 @@ files:
 - ".env.sample"
 - ".gems"
 - ".gitignore"
+- CHANGES.md
 - LICENSE
 - Makefile
 - README.md
 - lib/pexels.rb
 - lib/pexels/client.rb
+- lib/pexels/client/collections.rb
 - 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
+- lib/pexels/collection_set.rb
 - lib/pexels/errors.rb
+- lib/pexels/paginated_response.rb
 - lib/pexels/photo.rb
-- lib/pexels/response.rb
+- lib/pexels/photo_set.rb
 - lib/pexels/user.rb
 - lib/pexels/version.rb
 - lib/pexels/video.rb
 - lib/pexels/video/file.rb
 - lib/pexels/video/picture.rb
+- lib/pexels/video_set.rb
 - pexels.gemspec
 - test/client_test.rb
+- test/collection_test.rb
 - test/photo_test.rb
 - test/video_test.rb
 homepage: https://github.com/pexels/pexels-ruby
@@ -65,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/pexels/response.rb

@@ -1,20 +0,0 @@
-class Pexels::Response
-  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