gs_img_fetcher 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbf77d3d6f77afcb8fa99b171c7fa0ea5aa3bcb729c1fc34c281af653b48f0a6
-  data.tar.gz: 1ccc20a72beded5b5699a6a965fa5ce0fd2b0e44ac0bf84bb96237e6b752bda2
+  metadata.gz: a9349da7d358fea7bb7ae7bb75472a396cd6810e3348f1ce09ad199a5e47ad7e
+  data.tar.gz: eeb7ef868ad8f4f7c1dbc5a260880a83c8fd1baca676b1994d05546af5751fe7
 SHA512:
-  metadata.gz: cbeef36cae41f32123c024070984905931920c2cdf0cba6fb29da0ce15f81a13f135861e49607a52cb7a57fd8c3f111531c12c5f78b8a895cb9f0298cb8e3a1e
-  data.tar.gz: 9632ebe62a05cc0c1a931381f7c139d0957d57f4a76b75dcdb992921f52ac23e24e1a093ec2b94b1745615a131949caa4c9aa7efdb6b6efd8e44fd8d7f2625ed
+  metadata.gz: 74dd2fe6d6d39ed3fb9f485c163d28121fcef11baa708d8ed2e0f713ed39d310efdd2db725e468ea7440e8615cad175bc52a20d31cdd60e17d954d06489f4cc1
+  data.tar.gz: 1376fb3f38b62c1cf2e336efa6596af1d29b861368a6ae185a18b706e52cc7e1606b3649d9f04c75d8cb650f5e8bcb08c46c5d1dfd9ffed63967f06e3b7f3838

data/.travis.yml

@@ -1,12 +1,11 @@
----
 language: ruby
 cache: bundler
 env:
-  - NOLOG=true
+  global:
+    - NOLOG=true
 rvm:
   - 2.5.7
   - 2.6.5
 before_install: gem install bundler -v 2.1.4
 script:
   - bundle exec rspec
-  - gem build gs_img_fetcher.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gs_img_fetcher (0.1.0)
+    gs_img_fetcher (0.1.1)
       activesupport (~> 6.0)
       down (~> 5.1)
       dry-cli (~> 0.6)

data/README.md

@@ -1,4 +1,8 @@
-# GsImgFetcher [![Build Status](https://travis-ci.org/AkihikoITOH/gs_img_fetcher.svg?branch=master)](https://travis-ci.org/AkihikoITOH/gs_img_fetcher)
+# 🖼 GsImgFetcher
+
+[![Build Status](https://travis-ci.org/AkihikoITOH/gs_img_fetcher.svg?branch=master)](https://travis-ci.org/AkihikoITOH/gs_img_fetcher)
+[![Gem Version](https://badge.fury.io/rb/gs_img_fetcher.svg)](https://badge.fury.io/rb/gs_img_fetcher)
+[![Maintainability](https://api.codeclimate.com/v1/badges/277255cf51b425a22551/maintainability)](https://codeclimate.com/github/AkihikoITOH/gs_img_fetcher/maintainability)
 
 `gs_img_fetcher` is a tool to download images from remote hosts and save them on your local storage.
 
@@ -20,20 +24,54 @@ Or install it yourself as:
 
 ## Usage
 
+### CLI
 Let's say you have in your current directory a text file named `urls.txt` containing list of image URLs, each line containing one URL.
 
-Running `gs_img_fetcher run urls.txt output` would take URLs from `urls.txt`, downloads the images and save them in the directory `output`.
+```sh
+$ cat urls.txt
+http://example.com/image1.jpg
+http://example.com/image1.png
+http://example.com/image1.svg
+
+$ gs_img_fetcher run urls.txt output
+I, [2020-05-17T13:09:01.420214 #87392]  INFO -- : Processing 3 URLs (3 valid, 0 invalid)
+...
+I, [2020-05-17T13:09:02.709097 #87392]  INFO -- : Fetch complete (3 successful, 0 failed)
+
+$ ls output
+1e8256aa-5cb7-4545-9109-65aaa550deac.jpg  49d4f436-110f-4206-a2d6-07cc6156fc56.png  a5b4ce07-1fc3-49e3-b558-44f8c4afaaab.svg
+```
+
+Running `gs_img_fetcher run urls.txt output` would take URLs from `urls.txt`, downloads the images and saves them in the directory `output`.
 
 Run `gs_img_fetcher --help` to show usage guide.
 
 Set the environment variable `NOLOG` to a truthy value to suppress logs. 
 
-## Components
+### Hooking GsImgFetcher into your own application
 
-`gs_img_fetcher` is designed with concurrency in mind. It can be configured to fetch images either asynchronously or synchronously.
-By default, it runs asynchronously and the maximum number of threads depends on what your machine allows.
-For a relatively small input, it would be better to specify `--no-async` option.
-Check out the options `async` and `max_threads`.
+#### Fetching a single image
+```ruby
+fetcher = GsImgFetcher::Fetcher.new(
+  GsImgFetcher::InputEntry.new('http://example.com/image.png'),
+  'output'
+)
+fetcher.fetch
+fetcher.save
+fetcher.successful?
+```
+
+#### Fetching multiple images
+```ruby
+input = GsImgFetcher::Input.from_file('urls.txt')
+# or
+urls = ['http://example.com/image.png', 'http://example.com/image2.png'] 
+entries = urls.map { |url| GsImgFetcher::InputEntry.new(url) }
+input = GsImgFetcher::Input.new (entries)
+
+manager = GsImgFetcher::Manager.new(input, output_dir: 'output', async: false)
+manager.setup.fetch
+```
 
 - `Manager` is what controls the entire process of handling the input and fetching and saving the images.
 - `Input` is responsible for finding the input file and parsing, sanitizing and validating the list of URLs.

data/lib/gs_img_fetcher/input.rb

@@ -4,15 +4,20 @@ require 'active_support/core_ext/object/blank'
 
 module GsImgFetcher
   class Input
-    def initialize(path)
-      @path = path
+    class << self
+      def from_file(path)
+        entries = File.open(path, 'r') { |f| f.each_line.map(&:strip).map(&:presence) }
+                      .compact
+                      .uniq
+                      .map { |url| InputEntry.new(url) }
+        new(entries)
+      end
     end
 
-    def entries
-      @entries ||= File.open(@path, 'r') { |f| f.each_line.map(&:strip).map(&:presence) }
-                       .compact
-                       .uniq
-                       .map { |url| InputEntry.new(url) }
+    attr_reader :entries
+
+    def initialize(entries)
+      @entries = entries
     end
 
     def valid_entries

data/lib/gs_img_fetcher/manager.rb

@@ -5,17 +5,18 @@ require 'concurrent'
 module GsImgFetcher
   class Manager
     class << self
-      def fetch(*args, **opts)
-        new(*args, **opts).setup.fetch
+      def fetch(input_path, **opts)
+        input = Input.from_file(input_path)
+        new(input, **opts).setup.fetch
       end
     end
 
-    attr_reader :entries, :successful_fetches, :failed_fetches
+    attr_reader :input, :entries, :successful_fetches, :failed_fetches
 
     DEFAULT_MAX_THREADS = Concurrent.processor_count
 
-    def initialize(input_path, output_dir: nil, async: true, max_threads: nil)
-      @input_path = input_path
+    def initialize(input, output_dir: nil, async: true, max_threads: nil)
+      @input = input
       @output_dir = output_dir || Dir.pwd
       @async = async
       @max_threads = max_threads || DEFAULT_MAX_THREADS
@@ -24,10 +25,6 @@ module GsImgFetcher
       @failed_fetches = Queue.new
     end
 
-    def input
-      @input ||= Input.new(@input_path)
-    end
-
     def setup
       tap do
         log_entries
@@ -81,7 +78,7 @@ module GsImgFetcher
     end
 
     def log_entries
-      LOGGER.info("Processing #{input.entries.count} URLs (#{input.valid_entries.count} valid, #{input.invalid_entries.count} invalid) from #{@input_path}")
+      LOGGER.info("Processing #{input.entries.count} URLs (#{input.valid_entries.count} valid, #{input.invalid_entries.count} invalid)")
     end
 
     def log_result

data/lib/gs_img_fetcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GsImgFetcher
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gs_img_fetcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Akihiko Ito