unsplash_image 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27977f3506d7d69b51a21fe2d1cc0a521fc5fa5d6b90ffa37bbdda9d001e8774
+  data.tar.gz: dae359ff65d6f3edec2534581a1db3f97a2f951f9101359fec2a4066d19f1c95
+SHA512:
+  metadata.gz: adddf72e64434d5825eeec312dcbcf6e21131420b348ae36f026d3b2ba054d160d834640e6c67bceb05f993074183fef2b524fb77a796ef23fedc03854104292
+  data.tar.gz: 60a6289114199d9f7eb89d25866500f328307fb590162f82afba1f9aa528708f95563a3d1d0631cc657c6b1a7b999fa8149b747e6ba61bd8ad9839970629d1cb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Unsplash Image Downloader & Helpers
+
+[![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
+
+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
+```
+
+## Contributing
+
+You are welcome to contribute. See list of `TODO's` below.
+
+## 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).
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=unsplash_image)

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/bin/unsplash_image

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'unsplash_image/cli'
+
+UnsplashImage::CLI.start

data/lib/tasks/unsplash_image_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :unsplash_image do
+#   # Task goes here
+# end

data/lib/unsplash_image/cli.rb

@@ -0,0 +1,89 @@
+require "thor"
+
+require "unsplash_image"
+require "pathname"
+
+module UnsplashImage
+  class CLI < Thor
+    package_name "UnsplashImage"
+
+    map "-d" => :download
+    map "--download" => :download
+
+    default_task :info
+
+    desc :info, "Print info about cli"
+
+    method_option :version, type: :boolean, default: false, aliases: [:v], banner: "Print UnsplashImage version"
+    def info
+      if options[:version]
+        puts "UnsplashImage #{UnsplashImage::VERSION}"
+      else
+        info = [
+          "UnsplashImage #{UnsplashImage::VERSION}",
+          "",
+          "Usage example: ",
+          "    unsplash_image download --path spec/files -n 10",
+          "    unsplash_image download --path images/cats -s 400x400 --tags cat -n 20",
+          "    unsplash_image download --path files/ -s 300x300 --tags cat dogs birds -n 20",
+          "",
+          "run 'unsplash_image download' to see awailable options"
+        ]
+        puts info.join("\n")
+      end
+    end
+
+    desc "download [OPTIONS]", "Download Unsplash images"
+
+    long_desc <<-LONGDESC
+      `unsplash_image download` will download random unsplash images on your PC
+
+      Example:
+
+      > $ unsplash_image download --path images/cats -s 400x400 --tags cat -n 20
+    LONGDESC
+
+    DEFAULT_COUNT = 10
+    DEFAULT_PATH = "."
+
+    method_option :size, type: :string, aliases: [:s], banner: "Specify image size. Example: -s 640x480"
+    method_option :count, type: :numeric, aliases: [:n], banner: "Specify images count. Example: -n 10"
+    method_option :path, type: :string, banner: "Specify folder. Example: --path images/cats"
+    method_option :tags, type: :array, aliases: [:t], banner: "Specify tags. Example: -t cats"
+    method_option :prefix, type: :string, banner: "Specify file name prefix. Example: --prefix cat_image"
+    def download
+      if options.keys.empty?
+        invoke :help, ["download"]
+      else
+        prefix = if !!options[:prefix]
+          options[:prefix]
+        else
+          !(options[:tags].nil? || options[:tags].empty?) ? options[:tags].join("_") : "image"
+        end
+        tags = options[:tags]&.join(" ").to_s
+
+        base_path = Pathname.new(options[:path] || DEFAULT_PATH)
+        FileUtils.mkdir_p(base_path)
+
+        puts "Downloading images to #{base_path.absolute? ? base_path : base_path.realpath.relative_path_from(Dir.pwd)}"
+        count = (options[:count] || DEFAULT_COUNT).to_i
+        count.times do |i|
+          filename = count == 1 ? "#{prefix}.jpeg" : "#{prefix}_#{i + 1}.jpeg"
+          filename = filename.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "�").strip.tr("\u{202E}%$|:;/\t\r\n\\", "-")
+          path = File.expand_path(filename, base_path)
+          puts "Downloading #{filename}"
+          UnsplashImage.tempfile(size: options[:size], filename: filename, tags: tags + (" " * i)) do |tempfile|
+            File.write(path, tempfile.read)
+          end
+        end
+        puts "Done!"
+      end
+    end
+
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/unsplash_image/download.rb

@@ -0,0 +1,26 @@
+require "open-uri"
+require "tempfile"
+
+module UnsplashImage
+  module Download
+    def tempfile(size: nil, filename: "image.jpeg", tags: nil)
+      file = Tempfile.new(filename)
+      begin
+        file.write(URI.parse(UnsplashImage::Helper.unsplash_image_url(size: size, tags: tags)).read)
+        file.rewind
+        if block_given?
+          yield file
+        else
+          file
+        end
+      ensure
+        if block_given?
+          file.close
+          file.unlink
+        end
+      end
+    end
+  end
+
+  extend Download
+end

data/lib/unsplash_image/helper.rb

@@ -0,0 +1,16 @@
+module UnsplashImage
+  module Helper
+    extend self
+
+    BASE = "https://source.unsplash.com/random".freeze
+
+    def unsplash_image_url(size:, tags: nil)
+      options = [BASE]
+
+      options << size
+      options << "?#{tags}" if tags
+
+      options.join("/")
+    end
+  end
+end

data/lib/unsplash_image/railtie.rb

@@ -0,0 +1,9 @@
+module UnsplashImage
+  class Railtie < ::Rails::Railtie
+    initializer "unsplash_image.helpers", before: :load_config_initializers do
+      ActiveSupport.on_load :action_view do
+        include UnsplashImage::Helper
+      end
+    end
+  end
+end

data/lib/unsplash_image/version.rb

@@ -0,0 +1,3 @@
+module UnsplashImage
+  VERSION = "0.1.0"
+end

data/lib/unsplash_image.rb

@@ -0,0 +1,7 @@
+require "unsplash_image/version"
+require "unsplash_image/helper"
+require "unsplash_image/download"
+require "unsplash_image/railtie" if defined?(::Rails)
+
+module UnsplashImage
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: unsplash_image
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+- Liubomyr Manastyretskyi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Show the random images in your Rails app or download them to use for
+  seeding a DB
+email:
+- igorkasyanchuk@gmail.com
+- manastyretskyi@gmail.com
+executables:
+- unsplash_image
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/unsplash_image
+- lib/tasks/unsplash_image_tasks.rake
+- lib/unsplash_image.rb
+- lib/unsplash_image/cli.rb
+- lib/unsplash_image/download.rb
+- lib/unsplash_image/helper.rb
+- lib/unsplash_image/railtie.rb
+- lib/unsplash_image/version.rb
+homepage: https://github.com/railsjazz/unsplash_image
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Show the random images in your Rails app or download them to use for seeding
+  a DB
+test_files: []