It would be great to be able to set a http timeout on some of the requests done by the Unsplash SDK, or to have a reasonable default built into the library itself.

Any chance you can add this?

Steps to Reproduce

Install the Unsplash gem

Observed Behaviour

Install will succeed, but with a warning:

You have installed oauth2 version 1.4.10, which is EOL.
No further support is anticipated for the 1.4.x series.

OAuth2 version 2 is released.
There are BREAKING changes, but most will not encounter them, and upgrading should be easy!

Please see:
• https://github.com/oauth-xx/oauth2#what-is-new-for-v20
• https://github.com/oauth-xx/oauth2/blob/master/CHANGELOG.md

Please upgrade, report issues, and support the project! Thanks, |7eter l-|. l3oling

Technical Notes

I can see in the Gemspec that Unsplash is locking the oauth2 gem to v1.x (

A Ruby-universe version of this: unsplash/unsplash-php#58

Add a config option to define a utm_source value to send with every request, so clients aren't breaking this term condition: https://community.unsplash.com/developersblog/unsplash-api-terms-explained#block-yui_3_17_2_1_1490972762425_202608

Steps to Reproduce

Just use category.rb function. And say
'WARN -- : Category endpoints are deprecated. Use Collections instead.'

Observed Behaviour

Use ruby to network.

Expected Behaviour

Remove this code about category, just remain collection.

Add a note about hotlinking/embedding images returned from the Unsplash API directly in applications.

Link to the official API documentation at https://unsplash.com/documentation#hotlinking

In the official documentation I said:

Unlike most APIs, we prefer for the image URLs returned by the API to be directly used or embedded in your applications (generally referred to as hotlinking). By using our CDN and embedding the photo URLs in your application, we can better track photo views and pass those stats on to the photographer, providing them with context for how popular their photo is and how it's being used.

Change to the third person and it should be good.

Is there any easy way to get at the response headers like X-Ratelimit-Remaining? This would be very useful for tracking our rate limiting. Unless I'm missing something (I could be), the only way would be to use the Connection class directly to get the full response rather than just the body.

If you refer to the following document, you will see that the response headers contain a rate limit.
https://unsplash.com/documentation#rate-limiting
However, there doesn't seem to be any way to get it from this official gem.
I'll have to extend the Connection class, but I don't know how to do it.

Steps to Reproduce

get
@photos = Unsplash::Photo.curated()

Observed Behaviour

popular photos are returned
the code in photo.rb is
def curated(page = 1, per_page = 10, order_by = "popular")

Expected Behaviour

latest photos are returned

https://unsplash.com/documentation#list-curated-photos

Technical Notes

alternatively, you could document that the ruby library doesn't follow the defaults

The /photos/search endpoint has been deprecated and replaced by other additional searches (photos, users, collections): https://unsplash.com/documentation#search

The random photo API endpoint now supports a count parameter that allows the client to retrieve a set of photos rather than just one. Add support for that here.

https://unsplash.com/documentation#get-a-random-photo

Steps to Reproduce

Photo.random(query: "trees", content_filter: :high)

Observed Behaviour

Unknown parameter

Expected Behaviour

Passthrough to API per https://unsplash.com/documentation#get-a-random-photo

Technical Notes

Created a fork for a pull request here:

master...hbhanoo:unsplash_rb:master

But can't quite figure out what I need to set the BEARER_TOKEN env variable to for the tests (I'm only making public API requests).

Already depending on oauth2 gem, which in turn already uses faraday.

Steps to Reproduce

• Visit the documentation and read information about the curated method.
• Call Unsplash::Photo.curated

Observed Behaviour

Unsplash::Photo.curated
=> NoMethodError: undefined method `curated' for Unsplash::Photo:Class

Expected Behaviour

• Documentation is updated to reflect that the method has been removed

Technical Notes

• Relevant PR 2b6f72e

All requests should include an Accept-Encoding: gzip header. For bonus points, Accept-Encoding: gzip,br

The Ruby version for this gem is 2.4.0. I will submit a PR to update it to 2.4.5.

Do the maintainers think it should perhaps be updated to the latest version, ie: 2.6.1 ?

Hello guys!

When using classes search method, the gem only retrieves the array of searched entity. As, if you call the Unsplash::Photo.search method, it will retrieve an array of Unsplash::Photo objects. This way, it misses some API response [1] information. As the total number of elements on that query (total), and the total of pages by that query with that number of elements per page (total_pages). Are any plans in mind to solve this behavior or something that I can do? I believe that kind of change will probably release a new major gem version?

Thanks

[1] https://unsplash.com/documentation#search-photos

/search/photos supports an orientation parameter. Accept that in Photo#search (match the Photo#random implementation).

The API's photo-upload endpoint has been deprecated and removed. Change Photo#create to raise an Unsplash::Error rather than try (and fail) to upload something.

Overview

Should help build trust that the library is well maintained and covered since users of the gem know how complete our test coverage is.

Steps to Reproduce

1. Tried: Unsplash::Photo.search("cat", 1, 5, orientation: :landscape)
   Unsplash::Error: orientation is invalid, orientation does not have a valid value
   from /Users/joshledgard/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/unsplash-3.1.1/lib/unsplash/connection.rb:152:in `request'

2. Tried Unsplash::Photo.search("cat", 1, 5, 'landscape')

WARN -- : The tags property in this endpoint is deprecated. https://changelog.unsplash.com/deprecations/2021/07/12/tags-search-deprecation.html

Observed Behaviour

See the error message and the warning above for the two calls.

Expected Behaviour

A way to set an orientation.

Technical Notes

using latest 3.1.1.

Steps to Reproduce

Follow Readme to setup
start rails server

Observed Behaviour

This error occurs undefined method application_access_key=' for #Unsplash::Configuration:0x00007fb668f1aec0 (NoMethodError)`

Apparently looking into the code, gem installed not the latest version. defaulting back to previous code of config.application_id from the suggested config.application_access_key
will make it work again if your unsplash version is not 2.0(unsure which version but def <= 1.4.1)

suggest changing readme gem 'unsplash' to gem 'unsplash', '~> 2.0.0'

The API random photo endpoint now supports an orientation parameter to filter photos by portrait/landscape/square. Add support for that here.

https://unsplash.com/documentation#get-a-random-photo

Steps to Reproduce

• Attempt to make an API call without configuring the utm_source parameter:

Unsplash.configure do |config|
  config.application_access_key = KEY
  config.application_secret = SECRET
end
Unsplash::Photo.search("cats")

Observed Behaviour

• Warning appears in console. The provided link is dead.

W, [2019-05-14T11:35:01.126289]  WARN -- : utm_source is required as part of API Terms: https://community.unsplash.com/developersblog/unsplash-api-guidelines
=> [#<Unsplash::Photo:0x00007faabac32690 ...>]

Expected Behaviour

• The link should go to a real page

Technical Notes

This presumably just needs to be updated with a new value.

Hi! My Q in subj. Thanks ✋

Steps to Reproduce

• Search for any image with ruby library. ie: Unsplash::Photo.search("cats")

Observed Behaviour

• For every result, we have the links either to the images or the the photographer, but those links does not contain the utm params

Image or video please.

Expected Behaviour

• If understood correctly, Unsplash guidelines states that when hotlinking an image or linking to the User public profile, utm params should appear un the url.

Technical Notes

• As the gem already handles utm configuration, it would be really helpful if the links returned by the gem would contain the utm params so we don't need to add them afterwards. I can work on a PR if everyone agree on that change

The Unsplash API supports narrowing search results by category (https://unsplash.com/documentation#search-photos), but there's no category argument accepted by Photo#search.

API now has this (but this gem does not): https://unsplash.com/documentation#get-a-random-photo

running:

Unsplash::Photo.search('dog', per_page: 12, page: 1)

anywhere, rails c, controller, test

will raise exception

Unsplash::Error (page is invalid)

• unsplash (2.1.0)
• ruby 2.6.5p114 (2019-10-01 revision 67812) [x86_64-linux]
• rails 6.0.2

Steps to Reproduce

• Request a random photo using both the collections and query parameters, e.g.

    response = Unsplash::Photo.random(
      collections: [my_collection_id],
      query:       "cats"
    )

Observed Behaviour

• A random photo from the my_collection_id collection is returned, ignoring the query parameter.
• This seemed to be by design as per the API documentation (quote below), but there's no warning for using both parameters; I wonder if it just uses whichever is passed first.

Note: You can’t use the collections and query parameters in the same request

Expected Behaviour

• In an ideal situation, it'd be nice to be able to use both parameters: specifying a list of collections and also searching by keyword within those collections.
• In a more realistic situation, I suppose some kind of "You can't use both of these keys together" warning would help tinkering coders figure out why one parameter or the other is being ignored.

Technical Notes

• I'm just getting into the Unsplash API and figuring out how I can help spread the awesome images you all have to more creatives, and would love to know if there is some alternative suggestion for combining collections with query or if it's just entirely not possible.

• For reference, my use-case is generating personalized writing prompts for authors within the context of pre-built worlds within a worldbuilding app. I'm still exploring the options, but my first prototype was to have a collection for sci-fi images, a collection for modern images, fantasy images, historical images, etc (which works all and well), but I'd also like to give authors a bit more control over what's in the prompts they see, both explicitly (e.g. the author says "I want green landscapes" within a sci-fi world) or implicitly (e.g. the author has a redheaded man they haven't fleshed out, so I might want to append "redhead", "male", etc to some search results to better massage the images returned toward their world).

• I could also make do with just collections or just queries (by having a ton of very specific collections, or by accepting that some queried results across all of Unsplash might not be "writing prompt" material, even if they are great images), but ideally I'm looking for something in the middle.

Thanks for any advice or guidance you can provide!

The Unsplash API now supports Collections: https://unsplash.com/documentation#collections

Let's add it here, too.

API now supports liking photos: https://unsplash.com/documentation#like-a-photo

The dependent library HTTParty is 0.14.0, but this gem has been updated to 0.16.4.

The update included this PR.

I'll submit a PR.

Steps to Reproduce

require 'unsplash'
require 'open-uri'
require 'net/http'

Configure the Unsplash gem

Unsplash.configure do |config|
config.application_access_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
config.application_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
config.utm_source = "Recommendation_Travels"
end

Search for photos with the keyword "Dubai"

search_results = Unsplash::Photo.search("Dubai")

Initialize a counter for file naming

counter = 1

Download the photos and trigger the download tracking

search_results.each do |photo|

Format the counter to have leading zeros, creating a filename like dubai_001.jpg

filename = "dubai_#{format('%03d', counter)}.jpg"

Download the photo with an extended timeout (e.g., 30 seconds)

download_url = photo.urls.full
uri = URI(download_url)
http = Net::HTTP.new(uri.host, uri.port)
http.read_timeout = 30 # Set the timeout to 30 seconds

response = http.request_get(uri)
if response.code.to_i == 200
File.open(filename, 'wb') do |file|
file.write response.body
end
else
puts "Failed to download photo: HTTP response code #{response.code}"
end

Trigger the download tracking for attribution

Unsplash::Photo.find(photo.id).track_download

Increment the counter for the next filename

counter += 1
end

puts "Downloaded and tracked #{search_results.size} photos of Dubai."

Observed Behaviour

Image or video please.

Expected Behaviour

ruby download_photo.rb
W, [2023-11-01T21:32:13.826060 #162007] WARN -- : The tags property in this endpoint is deprecated. https://changelog.unsplash.com/deprecations/2021/07/12/tags-search-deprecation.html
Traceback (most recent call last):
16: from download_photo.rb:56:in <main>' 15: from /home/adesoji/gems/gems/delegate-0.3.0/lib/delegate.rb:87:in method_missing'
14: from /home/adesoji/gems/gems/delegate-0.3.0/lib/delegate.rb:87:in each' 13: from download_photo.rb:66:in block in

Technical Notes

• Rubv version 2.7

Can anyone help me out? i want to download the pictures of Dubai

Steps to Reproduce

Unsplash::Photo.search('test', 1, 100)

Observed Behaviour

API returns error Unsplash::Error - orientation does not have a valid value

Notes

I am a bit confused since the documentation doesn't seem to allow you to pass an orientation option in the search method, I tried it anyway passing Unsplash::Photo.search('test',1, 100, orientation: 'landscape') but it returned the same error.

Currently spec_helper has configuration that points at an instance of Unsplash running on localhost. Obviously that doesn't work for most people. 😅 Update that config and the cassettes so they record from api.unsplash.com. That way contributors can record their own cassettes.