adri 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fc54b8d1ef7e4486a3d5926fc8c28633ceab6709d0a9160d026ae8497e99e65
-  data.tar.gz: ea3895da8d463f866fe4b702f0204a31596dd0047d401fc6cdcf2ff4321d676d
+  metadata.gz: 90377a82643327c5d87bcb74efc72d75f5ada30761b194a518f4755dc6c0068c
+  data.tar.gz: f924d6679ed5e00f4ad8b8fab22f0210602e96c34dfb793bbbd87d9d4af013a7
 SHA512:
-  metadata.gz: 5433f1bafa362f9d04e5c1c6401195941c82ba08aa86ce8f597b23459b58889311ca65e827ad5ebce9c018dea393d1a89274e840adac4926abe41c99ad7756bd
-  data.tar.gz: e9b46b82b46126ba281fd895154093bb339f9c3fb0bcc928acd888251e9ceb87323bd01f483432a8177e78c0dbd11beaa6c245dc828c512b37a96fb5f212d884
+  metadata.gz: d8b94ea5b8b0dcd583283f5b41aa2e670dfd8524bee5931a34ce302be69c7cce7a4e1684cdf781427a2b2f47547ff7e0be0704aa77ab8815e5a2f36580da16a7
+  data.tar.gz: cbfcaf8200e317b1c1d75d48a2d740063f099dc1e016184779538165dd1fe0ba7c72ac8688da7e8c08ebad6db0a8a4ef6dad8957bdf60a70dbf0dcafd1023b32

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][] and this project adheres to
+[Semantic Versioning][].
+
+## [Unreleased][]
+
+## [0.1.0][] - 2020-09-06
+
+### Added
+
+- Make language of geocoding results configurable through the
+  `GEOCODER_LANGUAGE` environment variable (default is `en` for English)
+
+### Changed
+
+- Update README file
+- Update Gem dependencies
+- Improve specificity of extracted location
+- Increase geocoding timeout from 3 to 10 seconds
+- Handle geocoding timeout errors
+
+## [0.0.1][] - 2018-12-06
+
+Initial release.
+
+[Keep a Changelog]: http://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: http://semver.org/spec/v2.0.0.html
+[Unreleased]: https://github.com/agorf/adri/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/agorf/adri/compare/0.0.1...0.1.0
+[0.0.1]: https://github.com/agorf/adri/releases/tag/0.0.1

data/README.md

@@ -1,4 +1,4 @@
-# adri
+# adri [![Gem Version](https://badge.fury.io/rb/adri.svg)](http://badge.fury.io/rb/adri)
 
 adri organizes JPEG/TIFF photographs according to their EXIF date and location
 data into a custom directory structure.
@@ -6,23 +6,25 @@ data into a custom directory structure.
 In other words, it turns this:
 
 ```sh
-$ ls -1 photos/*.jpg
-IMG100001.jpg
-IMG100002.jpg
-IMG100003.jpg
+$ tree photos/
+photos/
+├── IMG100001.jpg
+├── IMG100002.jpg
+└── IMG100003.jpg
 ```
 
 To this:
 
 ```sh
-$ tree photos/2018/
-photos/2018/
-└── 10/
-    └── 14/
-        └── London
-            ├── IMG100001.jpg
-            ├── IMG100002.jpg
-            └── IMG100003.jpg
+$ tree photos/
+photos/
+└── 2018/
+    └── 10/
+        └── 14/
+            └── London
+                ├── IMG100001.jpg
+                ├── IMG100002.jpg
+                └── IMG100003.jpg
 ```
 
 ## Installation
@@ -76,26 +78,33 @@ usage: adri [options] <path>...
     -h, --help         Print help text
 ```
 
-**By default, adri runs in dry run mode.** This means it simply prints out what
-it would do, without actually doing it:
+### Dry run mode (default)
+
+By default, adri runs in dry run mode, printing `(DRY RUN)` at the end of each
+line. This means it simply prints out what it would do, without actually doing
+it:
 
 ```sh
 $ pwd
 /home/agorf/work/adri/
-$ ls -1 photos/*.jpg
-IMG100001.jpg
-IMG100002.jpg
-IMG100003.jpg
+$ tree photos/
+photos/
+├── IMG100001.jpg
+├── IMG100002.jpg
+└── IMG100003.jpg
 $ adri photos/*.jpg
 /home/agorf/work/adri/photos/IMG100001.jpg -> /home/agorf/work/adri/photos/2018/10/14/London/IMG100001.jpg (DRY RUN)
 /home/agorf/work/adri/photos/IMG100002.jpg -> /home/agorf/work/adri/photos/2018/10/14/London/IMG100002.jpg (DRY RUN)
 /home/agorf/work/adri/photos/IMG100003.jpg -> /home/agorf/work/adri/photos/2018/10/14/London/IMG100003.jpg (DRY RUN)
-$ ls -1 photos/
-IMG100001.jpg
-IMG100002.jpg
-IMG100003.jpg
+$ tree photos/
+photos/
+├── IMG100001.jpg
+├── IMG100002.jpg
+└── IMG100003.jpg
 ```
 
+### Run mode
+
 To apply the changes, use the `--run` option:
 
 ```sh
@@ -114,6 +123,8 @@ photos/
                 └── IMG100003.jpg
 ```
 
+### Path prefix
+
 To place everything under a path other than the parent directory of each
 photograph, use the `--prefix` option:
 
@@ -124,8 +135,13 @@ $ adri --prefix . photos/*.jpg
 /home/agorf/work/adri/photos/IMG100003.jpg -> /home/agorf/work/adri/2018/10/14/London/IMG100003.jpg (DRY RUN)
 ```
 
-The default path format is year/month/day/location. It is possible to specify a
-custom one with the `--path-format` option:
+### Path format
+
+The default path format is `%Y/%m/%d/%{location}` which stands for
+_year/month/day/location_. Everything other than `%{location}` is formatted
+according to [strftime(3)][strftime].
+
+It is possible to specify a custom path with the `--path-format` option:
 
 ```sh
 $ adri --path-format '%{location}/%b %Y/%d' photos/*.jpg
@@ -134,7 +150,7 @@ $ adri --path-format '%{location}/%b %Y/%d' photos/*.jpg
 /home/agorf/work/adri/photos/IMG100003.jpg -> /home/agorf/work/adri/photos/London/Oct 2018/14/IMG100003.jpg (DRY RUN)
 ```
 
-The date is formatted according to [strftime(3)][strftime].
+### Processing many photos
 
 It's also possible to process many photos at once by passing space-separated
 file names and directories (in which case adri will [recurse][]):

data/bin/adri

@@ -16,8 +16,18 @@ module Adri
   DEFAULT_PATH_FORMAT = '%Y/%m/%d/%{location}'.freeze
   EXTENSIONS = %w[jpg jpeg JPG JPEG tif tiff TIF TIFF].freeze
   GEOCODE_MAX_DELAY = 60 # Seconds
+  GEOCODER_TIMEOUT = 10 # Seconds
+  GEOCODER_LANGUAGE = ENV.fetch('GEOCODER_LANGUAGE', 'en').freeze
   LOCATION_CACHE_SCALE = 2
-  VERSION = '0.0.1'.freeze
+  LOCATION_ADDRESS_TYPES = %i[
+    locality
+    sublocality
+    administrative_area_level_5
+    administrative_area_level_4
+    administrative_area_level_3
+    administrative_area_level_2
+  ].freeze
+  VERSION = '0.1.0'.freeze
 
   class Photo
     class << self
@@ -172,8 +182,9 @@ module Adri
 
       begin
         geocode_results = Geocoder.search(latlng)
-      rescue Geocoder::OverQueryLimitError
-        puts 'Got OverQueryLimitError' if verbose
+      rescue Geocoder::OverQueryLimitError,
+             Geocoder::LookupTimeout => e
+        puts "Got #{e.class.name}" if verbose
 
         if current_delay > GEOCODE_MAX_DELAY
           puts "Exceeded max delay of #{GEOCODE_MAX_DELAY} seconds" if verbose
@@ -187,7 +198,27 @@ module Adri
         retry
       end
 
-      geocode_results.map(&:city).compact.uniq.first
+      geocode_results.each do |result|
+        location = location_from_geocode_result(result)
+
+        if location
+          return location
+        end
+      end
+
+      nil
+    end
+
+    private def location_from_geocode_result(result)
+      LOCATION_ADDRESS_TYPES.each do |type|
+        entity = result.address_components_of_type(type).first
+
+        if entity
+          return entity['long_name']
+        end
+      end
+
+      nil
     end
 
     private def location_cache_key
@@ -251,6 +282,8 @@ module Adri
     end
   end
 
+  # This is necessary to support both files and directories as paths. It also
+  # performs some basic sanity checks.
   def self.expand_paths(paths, verbose)
     glob_pattern = File.join('**', "*.{#{EXTENSIONS.join(',')}}")
 
@@ -298,7 +331,9 @@ end
 Geocoder.configure(
   always_raise: :all,
   lookup: :google,
-  api_key: options[:api_key]
+  api_key: options[:api_key],
+  timeout: Adri::GEOCODER_TIMEOUT,
+  language: Adri::GEOCODER_LANGUAGE
 )
 
 Adri.expand_paths(args, !options[:quiet]).each do |path|

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: adri
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Angelos Orfanakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2020-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exif
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: geocoder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -74,22 +74,22 @@ dependencies:
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: 
 email: me@agorf.gr
 executables:
@@ -97,6 +97,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - bin/adri
@@ -119,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Organize photos by date and location in a directory structure