pexels 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659313ec19604a9af5e891f33464f00e417f7e30578b7a926b6911bd03140c2f
-  data.tar.gz: 2366d7b62d237e92066faf3616ce3a654f94212334e55926979f68609dd084b7
+  metadata.gz: 7f9609676bbaebe34889f5c6483f15f41831439eced062f91a7a1eb8fb0c1d8e
+  data.tar.gz: a7be0c896cacd8e3bf02aaf5a87eaee7c0a7c3a17d1118b87f114da208972e0f
 SHA512:
-  metadata.gz: 1e20e097cd5e45e82397386cb91f831d7dfce398d53ecaeecd67d3c0cb7c02ec7d3b4ba37ee349174fce076497d73299401b7a0556db33a94b868de63b070651
-  data.tar.gz: 297a760a1638110b75173c50231076174fa85972e4f7e2ff0e8d0ec0dd53c9de710dada38c09ce0b68f4710950a2ad678bf508fc5cfe29d2f108dde367575649
+  metadata.gz: 506d3d399c0cc6655daead44255597131d162808b6b206e32aa7fd60022883703330f2527fb6d092b944ba31a9067b813f6e27f355f7dbc87dcbb3ab95984f2c
+  data.tar.gz: c72ebaa5715f520f74a05941f384bcd1e6db62d45662f07f9a8afbc5236b85c6aa4527a1ccf6f2a74b9d95f36e42fe56c12333ee12411076a8cb6b0170c75105

data/.gitignore

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

data/CHANGES.md

@@ -0,0 +1,11 @@
+# Change log
+
+## 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/lib/pexels.rb

@@ -1,19 +1,41 @@
 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/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

@@ -4,7 +4,6 @@ class Pexels::Client
   attr_reader :api_key,
               :ratelimit_remaining
 
-
   def initialize(api_key = ENV['PEXELS_API_KEY'])
     @api_key = api_key
   end
@@ -17,17 +16,26 @@ class Pexels::Client
     @videos ||= Pexels::Client::Videos.new(self)
   end
 
+  def collections
+    @collections ||= Pexels::Client::Collections.new(self)
+  end
+
   def request(path, method: 'GET', params: {})
+    url = File.join(Pexels.api_base_url, path)
+    headers = {
+      'Authorization' => api_key
+    }.merge(Pexels.local_headers)
+
+    puts "Requesting #{url} with #{headers}" if ENV['DEBUG']
+
     results = Requests.request(
       method,
-      "#{Pexels.api_base_url}#{path}",
+      url,
       params: params,
-      headers: {
-        'Authorization' => api_key
-      }
+      headers: headers
     )
 
-    @ratelimit_remaining = results.headers['x-ratelimit-remaining'].first.to_i
+    @ratelimit_remaining = results.headers['x-ratelimit-remaining']&.first&.to_i
 
     return JSON.parse(results.body)
   rescue StandardError => exception

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(
+      '/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(
+      "/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

@@ -5,14 +5,14 @@ class Pexels::Client::Photos
   end
 
   def [](id)
-    response = @client.request("/v1/photos/#{id}")
+    response = @client.request("#{Pexels.api_version}/photos/#{id}")
     Pexels::Photo.new(response)
   end
   alias_method :find, :[]
 
   def search(query, per_page: 15, page: 1, locale: 'en-US')
     response = @client.request(
-      '/v1/search',
+      "#{Pexels.api_version}/search",
       params: {
         query: query,
         per_page: per_page,
@@ -21,18 +21,18 @@ class Pexels::Client::Photos
       }
     )
 
-    Pexels::Response.new(response)
+    Pexels::PhotoSet.new(response)
   end
 
   def curated(per_page: 15, page: 1)
     response = @client.request(
-      '/v1/curated',
+      "#{Pexels.api_version}/curated",
       params: {
         per_page: per_page,
         page: page,
       }
     )
 
-    Pexels::Response.new(response)
+    Pexels::PhotoSet.new(response)
   end
 end

data/lib/pexels/client/videos.rb

@@ -20,7 +20,7 @@ class Pexels::Client::Videos
       }
     )
 
-    Pexels::Response.new(response)
+    Pexels::VideoSet.new(response)
   end
 
   def popular(per_page: 15, page: 1)
@@ -32,6 +32,6 @@ class Pexels::Client::Videos
       }
     )
 
-    Pexels::Response.new(response)
+    Pexels::VideoSet.new(response)
   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(attrs)
+      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(attrs)
+      super
+      @data = attrs.fetch('collections', []).map { |attrs| Pexels::Collection.new(attrs) }
+    end
+  end
+end

data/lib/pexels/paginated_response.rb

@@ -0,0 +1,28 @@
+module Pexels
+  class PaginatedResponse
+    include Enumerable
+
+    attr_reader :total_results,
+      :page,
+      :per_page,
+      :next_page,
+      :data
+
+    private :data
+
+    def initialize(attrs)
+      @total_results = attrs.fetch('total_results', nil)
+      @page = attrs.fetch('page')
+      @per_page = attrs.fetch('per_page')
+      @next_page = attrs.fetch('next_page', nil)
+    end
+
+    def each(&block)
+      if block_given?
+        data.each(&block)
+      else
+        to_enum(:each)
+      end
+    end
+  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(attrs)
+      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.4'
+  VERSION = '0.1.0'
 end

data/lib/pexels/video_set.rb

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

data/test/collection_test.rb

@@ -0,0 +1,81 @@
+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
+    search_result = @client.collections.all
+
+    assert search_result.is_a? Pexels::CollectionSet
+    assert_equal search_result.per_page, 15
+    assert_equal search_result.page, 1
+
+    assert search_result.collections.is_a? Array
+    assert search_result.collections.any?
+    assert search_result.first.is_a? Pexels::Collection
+
+    search_result_with_params = @client.collections.all(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.collections.length, 1
+  end
+
+  def test_get_collection_media
+    collection = @client.collections[@collection.id]
+    assert collection.is_a? Pexels::CollectionMediaSet
+    assert_equal collection.id, @collection.id
+
+    assert collection.media.is_a? Array
+    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 collection.is_a? Pexels::CollectionMediaSet
+    assert collection.media.is_a? Array
+    assert collection.media.all? { |m| m.is_a?(Pexels::Photo) }
+  end
+
+  def test_get_collection_videos
+    collection = @client.collections[@collection.id, type: 'videos']
+    assert collection.is_a? Pexels::CollectionMediaSet
+    assert collection.media.is_a? Array
+    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 collection.is_a? Pexels::CollectionMediaSet
+    assert collection.media.is_a? Array
+    assert collection.any?
+  end
+
+  def test_get_collection_pagination
+    collection = @client.collections[@collection.id, per_page: 1, page: 1]
+    assert collection.is_a? Pexels::CollectionMediaSet
+    assert collection.media.is_a? Array
+    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
+    @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'
+  end
+end

data/test/photo_test.rb

@@ -5,13 +5,13 @@ 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.is_a? Pexels::PhotoSet
     assert search_result.next_page.is_a? String
     assert search_result.total_results.is_a? Integer
     assert_equal search_result.per_page, 15
@@ -19,7 +19,7 @@ class TestPhoto < Minitest::Test
 
     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
@@ -30,14 +30,14 @@ class TestPhoto < Minitest::Test
   def test_curated_photos
     search_result = @client.photos.curated
 
-    assert search_result.is_a? Pexels::Response
+    assert search_result.is_a? Pexels::PhotoSet
     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
+    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

data/test/video_test.rb

@@ -5,20 +5,20 @@ 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.is_a? Pexels::VideoSet
     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
+    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
@@ -29,13 +29,13 @@ class TestVideo < Minitest::Test
   def test_popular_videos
     search_result = @client.videos.popular
 
-    assert search_result.is_a? Pexels::Response
+    assert search_result.is_a? Pexels::VideoSet
     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
@@ -70,10 +70,6 @@ class TestVideo < Minitest::Test
     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'
+      assert_equal exception.message, 'Not Found'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pexels
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Pexels dev team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: requests
@@ -34,23 +34,31 @@ 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/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

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