Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/railsjazz/unsplash_image
Unsplash random image generator and downloader
https://github.com/railsjazz/unsplash_image
rails ruby unsplash
Last synced: 4 months ago
JSON representation
Unsplash random image generator and downloader
- Host: GitHub
- URL: https://github.com/railsjazz/unsplash_image
- Owner: railsjazz
- License: mit
- Created: 2022-06-07T20:16:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-13T09:06:44.000Z (over 1 year ago)
- Last Synced: 2024-09-30T09:41:18.456Z (4 months ago)
- Topics: rails, ruby, unsplash
- Language: Ruby
- Homepage: https://railsjazz.com/
- Size: 65.4 KB
- Stars: 36
- Watchers: 3
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Unsplash Image Downloader & Helpers
[](https://www.railsjazz.com)
[](https://opensource-heroes.com/r/railsjazz/unsplash_image)
A CLI and a set of Rails helpers to get free images from [Unsplash](https://unsplash.com/).
This is the easiest way to fill your Rails app with real photos.
## Usage
1. as Rails helper to generate dummy images:
```ruby
<%= image_tag unsplash_image_url(size: '300x200', tags: 'cat, dog') %>
<%= image_tag unsplash_image_url(size: '800x600', tags: 'building') %>
<%= image_tag unsplash_image_url(tags: 'nature') %>
```
2. as a tool to download images from Unsplash.com and use them for your seeds or specs.
```bash
unsplash_image download --path images/cats --tags cat -n 20
```
3. If you need to have a `File` object with a random image.
```ruby
file = UnsplashImage.tempfile(size: '500x500', tags: 'cat')
```
### CLI
By default `unsplash_image download --path ./files` will download 10 random images into a `./files` folder.
You can see list of all available options by running:
```bash
unsplash_image --help download
```
With additional options you can specify a destination folder, tags, resolution of the images.
### In your Rails app
You can get random image url inside your views using `unsplash_image_url`.
Example:
```erb
<%= image_tag unsplash_image_url(size: '300x200', tags: 'cat, dog') %>
```
Also you can get it as a file with `UnsplashImage.tempfile`.
Example:
```ruby
file = UnsplashImage.tempfile(size: '500x500', tags: 'cat')
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem "unsplash_image"
```
And then execute:
```bash
$ bundle
```
To use CLI anywhere in the system you can install gem globally:
```bash
gem install unsplash_image
```
## Unit Tests
We have simple tests, just run: `ruby test/unsplash_image_test.rb`.
## Contributing
You are welcome to contribute. See list of `TODO's` below.
[
](https://opensource-heroes.com/r/railsjazz/unsplash_image)
## TODO
- allow caching downloaded files for performance improvement (eg using in factories)
- check with older Rails versions
- tests or specs
- make stand-alone executable installable via `brew`, `apt get`, etc?
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
[
](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=unsplash_image)