himawari 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62481fb8ecb232de59856604c05dea5b09f65ecc5b799892861548ff02d973dc
+  data.tar.gz: 1572d43032c289465c7af40f119a94fd6e2837394daeff5bdd26d2b5b362401e
+SHA512:
+  metadata.gz: 4a8b27e15225991ee80a77117abc18b04939ee4870cf90b70b11a7160631097e00bfdf4dc4b61d6cc480e5743970f0e70c5d0634a5cce0d6c1cfd1a1ceb027af
+  data.tar.gz: 9b52bad56dfc83a3edb2a5e255d9bd6d009072c607435e21239c53de5c61ae77dfb3568294d553a357b2e3e2e47946d10e4a1549c9c217b607cd1378cd315779

data/.gitignore

@@ -0,0 +1,2 @@
+**/data/*
+*.gem

data/.rubocop.yml

@@ -0,0 +1,52 @@
+AllCops:
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.5
+  Exclude:
+    - data/**/*
+
+Layout/LineLength:
+  Enabled: true
+  Max: 130
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 25
+  Exclude:
+    - spec/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - ./*.gemspec
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+#  Exclude:
+
+Metrics/PerceivedComplexity:
+  Max: 11
+#   Exclude:
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - exe/**/*
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen-string-literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in himawari.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    himawari (0.1.0)
+      httparty (~> 0.17.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    httparty (0.17.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.14.0)
+    multi_xml (0.6.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  himawari!
+  minitest (~> 5.14.0)
+  pry (~> 0.13.1)
+  rake (~> 13.0.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 engura
+
+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,73 @@
+# himawari
+Access images from the [himawari8 weather satellite](https://himawari8.nict.go.jp)] (courtesy of NICT) and compose near real-time desktop backgrounds of Earth or use the high-res images for other personal uses. For example....
+![full globe](doc/img/h_2020-06-01T0100.png)
+![high res section](doc/img/h_2020-11-29T0110.png)
+
+# Installation
+Add this line to your application's Gemfile:
+```
+gem 'himawari'
+```
+And then execute:
+```
+bundle
+```
+Or install it yourself as:
+```
+gem install himawari
+```
+## Install CLI Dependencies
+Mac:
+```
+brew install imagemagick # https://github.com/minimagick/minimagick
+brew install parallel # https://linux.die.net/man/1/parallel
+```
+or Linux: run `bin/setup`
+
+# Usage
+
+You can use it as a CLI executable, or as a library.
+
+*RUN EXAMPLE*: `himawari -w /home/User/himawari -d /home/User/Pictures/live -r 4 -f top -m day -v`
+
+To set cron (with all the supplied arguments):
+`himawari -w /home/User/himawari -d /home/User/Pictures/live -r 4 -f top -m day -v -c set`
+and then to remove it from cron:
+`himawari -w /home/User/himawari -d /home/User/Pictures/live -r 4 -f top -m day -v -c clear`
+
+### Details
+ - Grabs a tiled image from Himawari, (each photo of Earth is split into square tiles of 550x550px) reassembles it into one image, and optionally copies one of the downloaded images into a `destination` folder to use as a desktop background.
+![a tile](doc/img/t_2020-12-01T0410-1_0.png)
+ - Can change the resolution. Default is "2", smallest. Maximum is "20". It will produce an jpg of ~200MB in size for the full planet. The allowed steps are [2, 4, 8, 16, 20]. Resolution of 2 means that the image is composed of *2* tiles across, so the full image becomes 1100px wide/high. An image of resolution *factor 4* is then 550 * 4 = 2200px across. And the maximum one is 20 * 550 = 11000px X 11000px!!!!!
+ - Since the images can be kinda big, we can customize which part of the planet we want to see: `top`, `full` planet, or bottom (`low`).
+ - When using the `autorun` option (it's the method that command line utility uses), we save the last 48hrs in a folder (`working_dir`). We can then have 2 options: either show what is `now` outside, or! cycle the last complete 24 hours with a new background photo every 2 minutes? Because the images are all downloaded at once, and then an incremental download of one photo as needed, the internet traffic is relatively reasonable. Cycling the background photos doesn't need to access internet or download anything.
+
+ - 1. do NOT attempt to fetch data from black listed WiFis
+ - 2. if no internet, just show last available data
+ - 3. keep only 1 day's worth of images (~144 photos)
+ - 4. check for `No Image` images and skip those (until? if?) they become available
+
+# Development
+After checking out the repo, doing the steps in `installation` above and messing around with the code, run `rake test` and `rubocop` to use the tests and make sure everything is ok. To run a specific test, use `rake test TEST=spec/test_base.rb TESTOPTS="--name=test_bad_params --seed=1234"` and as for rubocop: `rubocop lib/himawari/base.rb`
+
+## Building the gem on local machine/from source
+navigate to the gem's directory and...
+Manually:
+```
+gem build himawari.gemspec
+gem install himawari-#.#.#.gem # replace the # with the most recent version
+```
+Semi-manually (the end result is same as above):
+```
+bundle exec rake install
+```
+
+## Releasing a new version of the Gem
+ - Update the version number in `himawari.gemspec`
+ - run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the .gem file to [rubygems.org](https://rubygems.org).
+
+# Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/engura/himawari.
+
+# License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen-string-literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/test_*.rb']
+end
+
+desc 'Run tests'
+task default: :test

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+echo 'Installing CLI Dependencies'
+sudo apt-get install -y parallel imagemagick
+
+bundle install

data/exe/himawari

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'himawari'
+
+params = Himawari::OsUtils.parse_cli_args
+Himawari.autorun(params)

data/himawari.gemspec

@@ -0,0 +1,35 @@
+# frozen-string-literal: true
+
+Gem::Specification.new do |s|
+  s.name          = 'himawari'
+  s.version       = '0.1.0'
+  s.date          = '2020-12-15'
+  s.summary       = 'Grabs latest images from the himawari8 weather satellite'
+  s.description   = 'Makes pretty, high-res backgrounds from the real-time photos of Earth by Himawari8,' \
+                    'or is intended for similar personal usage. Please see the readme for more!'
+  s.authors       = ['engura']
+  s.email         = ['engura@gmail.com']
+  s.homepage      = 'https://github.com/engura/himawari'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(tests|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'httparty', '~> 0.17.3'
+
+  s.add_development_dependency 'bundler', '~> 2.1.4'
+  s.add_development_dependency 'minitest', '~> 5.14.0'
+  s.add_development_dependency 'pry', '~> 0.13.1'
+  s.add_development_dependency 'rake', '~> 13.0.1'
+
+  s.requirements << 'Mac OSX or Linux... Windows `not supported yet` due to the lack of the following:'
+  s.requirements << 'parallel, ~>20161222 (Let\'s download in parallel)'
+  s.requirements << 'ImageMagick, ~>6.9.10-23 (Specifically, the `montage` utility)'
+  s.requirements << 'common utilities: find, touch, crontab, curl, iwgetid, rm, bash'
+
+  s.post_install_message = "Thanks for installing! Have fun with the amazing pics of our Home made\n" \
+                           'accessible to us for FREE by NICT. And please, don\'t break their website!!'
+end

data/lib/himawari.rb

@@ -0,0 +1,33 @@
+# frozen-string-literal: true
+
+require_relative './himawari/base.rb'
+require_relative './himawari/os_utils.rb'
+require_relative './himawari/net_utils.rb'
+require_relative './himawari/process.rb'
+require_relative './himawari/download.rb'
+
+# encapsulates all the functions pertaining to acquiring images from the himawari8 satellite in near real-time
+# from HIMAWARI_URL (defined in the Base Class)
+module Himawari
+  def self.autorun(params = {})
+    h = Download.new(params)
+    h.cron_action ? h.crontab : h.update_backgrnd ^ h.start
+  end
+
+  def self.get_pic(params = {})
+    t = validate(params[:datetime])
+    Download.new(params).pic(t, OsUtils.tenmin(t.min, t.min))
+  end
+
+  def self.get_pics(params = {})
+    Download.new(params).pics(validate(params[:from]), validate(params[:to]))
+  end
+
+  def self.validate(stamp)
+    return stamp if stamp.is_a? Time
+    return Time.parse("#{stamp}+00:00") if stamp.is_a? String
+
+    t = Time.now.utc - 600 # 600secs == 10.minutes ago
+    Time.new(t.year, t.month, t.day, t.hour, t.min / 10 * 10, 0, '+00:00')
+  end
+end

data/lib/himawari/base.rb

@@ -0,0 +1,135 @@
+# frozen-string-literal: true
+
+require 'httparty'
+require 'fileutils'
+require 'pathname'
+require 'optparse'
+# require 'pry'
+
+module Himawari
+  MONITOR_ASPECT = 16.0 / 9
+  UPDATE_RATE = 2 # int; update the pic once every `UPDATE_RATE` minutes
+  HIMAWARI_URL = 'https://himawari8-dl.nict.go.jp/himawari8/img/D531106'
+
+  # Local (JST) midnight happens @14:10 UTC, so we have to use pics in interval of [2.days.ago@14:40 .. 1.day.ago@14:40]
+  LOCAL_MIDNIGHT = '1410'
+
+  # sets up the methods for Himawari that do not have to do with accessing the internet. ie:
+  #   - it sets up all the default and customized params, builds awareness of the locally stored pics
+  #   - implements "setting" the background (copies a downloaded image into a different folder)
+  class Base
+    attr_reader :now, :app_root, :work_path, :data_path, :destination_path, :focus, :mode, :resolution,
+                :latest_local, :latest_remote, :verbose, :by_schedule, :blacklist_wifi, :cron_action
+
+    # relative to the location of the script: Pathname.new(File.expand_path('../', __FILE__))
+    # relative to the current working dir:    Dir.pwd
+    def initialize(params = {})
+      init_paths(params[:workdir])
+      @destination_path = params[:destination]
+
+      @now = Time.now.utc
+      @focus = params[:focus] || :top
+      @mode = params[:mode] || :day
+      @resolution = params[:resolution] || 2
+      @latest_local = find_latest_local
+      @latest_remote = nil
+      @verbose = params[:verbose]
+      @by_schedule = params[:by_schedule]
+      @blacklist_wifi = params[:blacklist] || []
+      @cron_action = params[:cron]
+    end
+
+    def up_to_date?
+      puts "Latest local:    #{latest_local[:timestamp]}" if verbose
+      if now - latest_local[:timestamp] < 10 * 60
+        puts 'Local pic is up to date; no need to go online.' if verbose
+        return true
+      end
+      false
+    end
+
+    def background(img)
+      return false unless img && params_valid?
+
+      cmd = "sleep 5 ; rm -f #{destination_path}/*.png ; cp #{img} #{destination_path}"
+      # "osascript -e 'tell application \"System Events\" to tell DESKTOP to set picture to \"#{img}\"'"
+      puts cmd if verbose
+      system(cmd)
+    end
+
+    def update_backgrnd
+      return false unless mode == :day && params_valid?
+
+      # only rotate the background if we have one complete rotation of the globe saved
+      sexy_pics = full_24hrs_available
+      # puts sexy_pics
+      return false unless sexy_pics
+
+      i = (now.hour * 60 + now.min) / UPDATE_RATE % sexy_pics.count
+      puts "#{i} :: #{(now.hour * 60 + now.min)} % #{sexy_pics.count} switching to #{sexy_pics[i]}" if verbose
+      background(sexy_pics[i])
+    end
+
+    def crontab(action = nil)
+      @cron_action = action if action
+      return false unless cron_action && params_valid?
+
+      cmd = '* * * * * PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin himawari ' \
+            "-s -m #{mode} -f #{focus} -r #{resolution} -d '#{destination_path}' -w '#{work_path}' -b #{blacklist_wifi.join(',')}"
+      OsUtils.crontab(cmd, cron_action)
+      cmd
+    end
+
+    def params_valid?
+      unless %i[full top mid low].include?(focus) && %i[live day].include?(mode) &&
+             [2, 4, 8, 16, 20].include?(resolution) && blacklist_wifi.is_a?(Array) &&
+             (!destination_path || (destination_path && File.directory?(destination_path) && destination_path != '/'))
+        puts 'Invalid params. Please double check them.'
+        return false
+      end
+      true
+    end
+
+    private
+
+    # returns array of pic_names to choose a background from, or false if we do not have enough pictures for a full 24hr rotation
+    def full_24hrs_available
+      prev_pic = ''
+      sexy_pics = []
+
+      Dir["#{data_path}/h_*.png"].sort { |x, y| y <=> x }.each do |pic|
+        pic_time = pic[-8, 4]
+        return sexy_pics if sexy_pics.count.positive? && pic_time < LOCAL_MIDNIGHT && LOCAL_MIDNIGHT <= prev_pic
+
+        sexy_pics.unshift(pic) if sexy_pics.count.positive? || pic_time < LOCAL_MIDNIGHT && LOCAL_MIDNIGHT <= prev_pic
+        prev_pic = pic_time
+      end
+      false
+    end
+
+    def init_paths(workdir)
+      @app_root = workdir && File.directory?(workdir) ? workdir : Dir.pwd
+      @work_path = @app_root
+      @data_path = "#{@app_root}/data"
+
+      @app_root = Pathname.new(File.expand_path(__dir__))
+      Dir.mkdir(@data_path) unless File.exist?(@data_path)
+    end
+
+    def find_latest_local
+      # we can't select by timestamp, because those could be messed up. Instead, just search for "latest" by filename
+      # latest_pic = `ls -t #{data_path}/h_* | head -1`
+      twodays_ago = now - 86_400 * 2
+      latest = { timestamp: nil }
+      failsafe = { filename: nil, timestamp: Time.new(twodays_ago.year, twodays_ago.month, twodays_ago.day, 0, 0, 0, '+00:00') }
+
+      Dir["#{data_path}/h_*.png"].each do |pic|
+        stamp = Time.parse(pic[0..-5].insert(-3, ':') + ':00+00:00')
+        `touch -t #{stamp.strftime('%Y%m%d%H%M.%S')} #{pic}`
+        latest = { filename: pic, timestamp: stamp } if !latest[:timestamp] || latest[:timestamp] < stamp
+      end
+
+      latest[:timestamp] && latest[:timestamp] > twodays_ago ? latest : failsafe
+    end
+  end
+end

data/lib/himawari/download.rb

@@ -0,0 +1,143 @@
+# frozen-string-literal: true
+
+module Himawari
+  # Let's expand our basic Himawari class with the ability to actually download stuff
+  # in addition to the downloading, we will also need to:
+  #   - parse CLI arguments / set crontab (OsUtils)
+  #   - check network status (NetUtils)
+  #   - check and try to fix downloaded picture Tiles (Process)
+  class Download < Base
+    extend OsUtils
+    include NetUtils
+    include Process
+
+    def start
+      return false unless everything_ok && pics_updated?
+
+      set_background(latest_local[:filename], destination_path) if mode == :live
+      # clean up: remove any files that are more than 2 days old
+      `find #{data_path} -name \"*.png\" -type f -mtime +2 -exec rm -f {} \\;`
+    end
+
+    def pics(from_datetime, to_datetime)
+      # returns true if any new pictures were downloaded from the web, false otherwise
+      pic_dwnlded = false
+      from_datetime += 10 * 60 # +10.minutes from our latest pic on local drive
+
+      while from_datetime <= to_datetime
+        tenmin = if last_iter?(from_datetime, to_datetime)
+                   OsUtils.tenmin(from_datetime.min, to_datetime.min)
+                 elsif !pic_dwnlded # i.e. it's while's first iteration. don't update the whole hour, only the remaining minutes
+                   OsUtils.tenmin(from_datetime.min)
+                 else
+                   OsUtils.tenmin
+                 end
+
+        pic_dwnlded = pic(from_datetime, tenmin)
+
+        break if last_iter?(from_datetime, to_datetime) || !pic_dwnlded
+
+        from_datetime = if to_datetime - from_datetime > 3600
+                          from_datetime + 3600
+                        else
+                          Time.new(to_datetime.year, to_datetime.month, to_datetime.day, to_datetime.hour, 0, 0, '+00:00')
+                        end
+      end
+
+      if verbose
+        puts pic_dwnlded ? "Latest Fetched:  #{find_latest_local[:timestamp]}" : 'Nothing downloaded.'
+      end
+      pic_dwnlded
+    end
+
+    # `parallel --header : 'montage -mode concatenate -tile 2x {00,10,01,11}/{year}-{mo}-{dy}T{hr}{tenmin}000-*.png
+    #  full/{year}-{mo}-{dy}T{hr}{tenmin}000.png' ::: year 2015 ::: mo 11 ::: dy {27..28} ::: hr {00..23} ::: tenmin {0..5}`
+    def pic(timestamp, tenmin = '{0..5}')
+      return false unless everything_ok
+
+      if timestamp > latest_remote
+        puts "Can't download #{timestamp} because it is newer than the most recent available (#{latest_remote})"
+        return false
+      end
+
+      yr = timestamp.year.to_s.rjust(2, '0')
+      mo = timestamp.month.to_s.rjust(2, '0')
+      dy = timestamp.day.to_s.rjust(2, '0')
+      hr = timestamp.hour.to_s.rjust(2, '0')
+      x, y = download_region
+
+      command1 = 'parallel -j5 --delay 0.1 --header : '\
+                 "'curl -sC - \"#{HIMAWARI_URL}/"\
+                 "#{resolution}d/550/{year}/{mo}/{dy}/{hr}{tenmin}000_{x}_{y}.png\" > "\
+                 "#{data_path}/t_{year}-{mo}-{dy}T{hr}{tenmin}0-{y}_{x}.png'"\
+                 " ::: year #{yr} ::: mo #{mo} ::: dy #{dy} ::: hr #{hr} ::: tenmin #{tenmin} ::: x #{x} ::: y #{y}"
+      command2 = 'parallel --header : '\
+                 "'montage -mode concatenate -tile #{resolution}x #{data_path}/t_{year}-{mo}-{dy}T{hr}{tenmin}0-*.png "\
+                 "#{data_path}/h_{year}-{mo}-{dy}T{hr}{tenmin}0.png'"\
+                 " ::: year #{yr} ::: mo #{mo} ::: dy #{dy} ::: hr #{hr} ::: tenmin #{tenmin}"
+      # command3 = 'parallel convert -channel R -gamma 1.2 -channel G -gamma 1.1 +channel -sigmoidal-contrast 3,50% {} '\
+      #            "pretty/{/} ::: #{data_path}/*.png"
+
+      # system(command1) # works totally fine on mac...
+      # OOOK>> I have NO idea why linux is not parsing {..} from parallel above and instead sticks it as a literal,
+      # but we need to make it work >> hack it this way for the time being...
+      script = "#{data_path}/script_#{yr}_#{yr}_#{mo}_#{dy}_#{hr}.sh"
+      OsUtils.scriptify_sys(script, command1)
+
+      check_tiles
+
+      # system(command2) # works totally fine on mac...
+      OsUtils.scriptify_sys(script, command2)
+      `rm #{data_path}/t_*`
+      true
+    end
+
+    private
+
+    def everything_ok
+      @everything_ok ||= params_valid? && checks_passed?
+    end
+
+    def checks_passed?
+      if blacklisted_wifi?
+        puts "Blacklisted Network; Won't go online"
+        return false
+      end
+
+      # we don't want to spam himawari's site more than once every 10 minutes while running on a schedule
+      return false if by_schedule && now.min % 10 != 1
+
+      if `find #{data_path} -name \"t_*.png\"`.length.positive?
+        puts 'Another himawari process is still downloading/processing files.\n' \
+             '(There are tiles (t_*.png) in the `data` folder.) Quitting w/o overlapping.'
+        return false
+      end
+
+      unless internet_connection?
+        puts "Not online? Can't reach #{HIMAWARI_URL}"
+        return false
+      end
+      true
+    end
+
+    def last_iter?(from, to)
+      from.day == to.day && from.hour == to.hour
+    end
+
+    def pics_updated?
+      pics(latest_local[:timestamp], latest_remote) unless up_to_date?
+    end
+
+    def download_region
+      x = "{0..#{resolution - 1}}"
+      y = if focus == :top # :full :mid :low
+            "{0..#{(resolution / MONITOR_ASPECT).ceil - 1}}"
+          elsif focus == :low
+            "{#{resolution - (resolution / MONITOR_ASPECT).ceil}..#{resolution - 1}}"
+          else # full / mid
+            "{0..#{resolution - 1}}"
+          end
+      [x, y]
+    end
+  end
+end

data/lib/himawari/net_utils.rb

@@ -0,0 +1,31 @@
+# frozen-string-literal: true
+
+module Himawari
+  # Network-related methods to help establish whether there is network access and
+  # figure out if we are on a possibly "metered" connection (via a hard-coded SSID blacklist)
+  module NetUtils
+    def internet_connection?
+      uid = now.to_i * 1_000
+      r = HTTParty.get("#{HIMAWARI_URL}/latest.json?uid=#{uid}", { timeout: 10 })
+      # puts "#{HIMAWARI_URL}/latest.json?uid=#{uid}" if verbose
+      if r.code == 200
+        puts "Latest Himawari: #{r['date']}" if verbose
+        @latest_remote = Time.parse(r['date'] + '+00:00')
+        return true
+      end
+      false
+    end
+
+    private
+
+    def blacklisted_wifi?
+      current_wifi = if OsUtils.os == :mac
+                       `networksetup -getairportnetwork en0`
+                     elsif OsUtils.os == :linux
+                       `iwgetid -r`
+                     end
+      puts current_wifi if verbose
+      current_wifi && blacklist_wifi.any? { |wifi| current_wifi.include?(wifi) }
+    end
+  end
+end

data/lib/himawari/os_utils.rb

@@ -0,0 +1,128 @@
+# frozen-string-literal: true
+
+module Himawari
+  # all the misc. functions for dealing with CLI and/or OS...
+  module OsUtils
+    def self.os
+      if RUBY_PLATFORM =~ /win32/
+        :win
+      elsif RUBY_PLATFORM =~ /linux/
+        :linux
+      elsif RUBY_PLATFORM =~ /darwin/
+        :mac
+      elsif RUBY_PLATFORM =~ /freebsd/
+        :freebsd
+      else
+        :unknown
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength, Metrics/BlockLength
+    def self.parse_cli_args
+      params = {}
+
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: himawari [params]'
+
+        opts.on('-f', '--focus STRING', String, 'Which section of the planet to focus on? ' \
+                                                'Valid values are `full`, `top`, `mid`, `low`. Default is `top`.') do |o|
+          params[:focus] = o.to_sym if %w[full top mid low].include? o
+        end
+
+        opts.on('-m', '--mode STRING', String, 'Valid values are `day` (cycles pics in the `destination` folder from the' \
+                                               'most recent day) or `live` (copies the latest photo downloaded ' \
+                                               'to `destination`) Default is `day`.') do |o|
+          params[:mode] = :live if o == 'live'
+        end
+
+        opts.on('-r', '--resolution INT', Integer, 'Adjust the resolution of the downloaded image. Valid numbers are ' \
+                                                   '2, 4, 8, 16, 20. 20 is the highest resolution and 2 is the default. ' \
+                                                   'For a 4k-monitor a setting of 4 seems sufficient.') do |o|
+          params[:resolution] = o if o <= 20 && o.positive? && o.even?
+        end
+
+        opts.on('-d', '--destination PATH', String, 'The folder where to copy a background image. If left blank, images will ' \
+                                                    'just be downloaded, but won\'t be copied anywhere afterward.') do |o|
+          params[:destination] = o if File.directory?(o)
+        end
+
+        opts.on('-w', '--workdir PATH', String, 'The folder where to save all the downloaded pics. If left blank, ' \
+                                                'images will be saved to the `./data` directory relative to your ' \
+                                                'current path of working dir.') do |o|
+          params[:workdir] = o if File.directory?(o)
+        end
+
+        opts.on('-b', '--blacklist STRING,STRING...', Array, 'Blacklist SSIDs of networks from which we do not want to go ' \
+                                                             'online to download new images.') do |o|
+          params[:blacklist] = o
+        end
+
+        opts.on('-c', '--cron STRING', String, 'Can `set`/`clear` cron with the specified params, so we can update the images ' \
+                                               'automatically') do |o|
+          params[:cron] = o.to_sym if %w[set clear].include? o
+        end
+
+        opts.on('-v', '--verbose', 'Increase verbosity: mostly for debugging') do |o|
+          params[:verbose] = o
+        end
+
+        opts.on('-s', '--schedule', 'Flag for determining when the script is run by schedule/automatically.') do |o|
+          params[:by_schedule] = o
+        end
+
+        opts.on('-h', '--help', 'Prints this help & exits') do
+          puts opts
+          exit
+        end
+      end.parse! # (into: params)
+
+      params
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/BlockLength
+
+    def self.scriptify_sys(script, command)
+      `echo "#!/bin/bash\n#{command}" > #{script}`
+      `chmod +x #{script} && #{script}`
+      `rm #{script}`
+    end
+
+    def self.tenmin(from = 0, to = 59)
+      "{#{from / 10}..#{to / 10}}"
+    end
+
+    # to force crossfade:
+    # https://apple.stackexchange.com/questions/141834/applescript-to-change-desktop-image-on-all-monitors
+
+    # set picture rotation to 1 -- turn on wallpaper cycling
+    # set change interval to -1 -- force a change to happen right now
+    # delay 1.5 -- wait a bit to allow for the fade transition - you may want to play w/ this #
+    # set picture of item N of theDesktops to POSIX file ("/Users/vladimir/chie/lib/space/data/h_2019-11-06T0220.png")
+    #   -- set wallpaper to wallpaper you want
+    # set picture rotation to 0  -- turn off wallpaper cycling
+
+    # tell application "System Events"
+    #     tell every desktop
+    #     tell desktop 1
+    #         set pictures folder to "/Library/Desktop Pictures"
+    #         set picture rotation to 2 -- using interval
+    #         set change interval to 1800
+    #         set random order to true
+    #     end tell
+    #     tell desktop 2
+    #         set pictures folder to "/Library/Desktop Pictures/Mine"
+    #         set picture rotation to 2 -- using interval
+    #         set change interval to 1800
+    #         set random order to true
+    #     end tell
+    # end tell
+
+    # to silence the status mails, add MAILTO='' at the top of the crontab manually
+    def self.crontab(cmd, action)
+      if action == :set
+        `(crontab -l ; echo \"#{cmd}\") 2>&1 | grep -v \"no crontab\" | sort | uniq | crontab -`
+      else
+        `(crontab -l ; echo \"#{cmd}\") 2>&1 | grep -v \"no crontab\" | grep -v himawari | sort | uniq | crontab -`
+      end
+    end
+  end
+end

data/lib/himawari/process.rb

@@ -0,0 +1,81 @@
+# frozen-string-literal: true
+
+module Himawari
+  # these methods provide checking and (trying to) fix the Tiles that we downloaded from the web.
+  # sometimes, the connection might be bad, and instead of an actual PNG for a Tile, we get a blank empty file.
+  # in other times, we get a special "no_image" png. This one is annoying. It IS a real picture,
+  # but it most CERTAINLY is NOT a picture of the Earth. (These normally come back during 0240 and 1440 timestamps)
+  # -- Himawari does not take photos when the Sun is in the view of the Satellite. Well, we wouldn't be able to see
+  # the Earth at those times anyway due to the Sun's brightness.
+  module Process
+    private
+
+    def check_tiles
+      @control_size ||= File.size("#{app_root}/no_image.png")
+      bad_tiles = {}
+      Dir["#{data_path}/t_*.png"].each do |tile|
+        bad_tiles = process_bad_tiles(bad_tiles, tile) if bad_tile?(tile)
+      end
+      recover_bad_sectors(bad_tiles)
+    end
+
+    def process_bad_tiles(bad_tiles, tile)
+      i = File.basename(tile[0..-9])
+      ending = tile[-7, 3]
+      stamp = Time.parse(i.dup.insert(-3, ':') + ':00+00:00')
+      bad_tiles[i] = [] unless bad_tiles.dig(i)
+      bad_tiles[i] << [
+        himawari_format(stamp, ending),
+        himawari_format(stamp - 600, ending),
+        himawari_format(stamp - 1_200, ending)
+      ]
+      # `cp #{tile} #{tile.gsub('/t_', '/x_')}`
+      # no need to delete individual "bad tiles" because we will try to recover them.
+      # But upon failure, will delete the whole himawari image
+      # File.delete(tile)
+      bad_tiles
+    end
+
+    def himawari_format(stamp, tile_end)
+      "#{stamp.year}/#{stamp.month}/#{stamp.day}/#{stamp.hour}#{stamp.min}00_#{tile_end}"
+    end
+
+    def png?(file)
+      File.size(file).positive? && IO.read(file, 4).force_encoding('utf-8') == "\x89PNG"
+    end
+
+    def bad_tile?(tile)
+      !png?(tile) || File.size(tile) == @control_size && system("cmp #{tile} #{app_root}/no_image.png")
+    end
+
+    # bad_tiles structure:
+    # { "t_2019-11-11T0240": [ [ [tile_url_1, tile_url_2, tile_url_3] ], [array_of_tiles], [array_of_tiles] ] }
+    def recover_bad_sectors(bad_tiles)
+      bad_tiles.each do |bad_pic_name, sectors|
+        pic_not_good = true
+
+        if sectors.count >= resolution # don't try to fix/recover pics that have too many pieces missing
+          puts "#{bad_pic_name} has #{sectors.count} pieces missing. Too many. Can't recover & will delete the whole thing!"
+        else
+          puts "#{bad_pic_name} has #{sectors.count} pieces missing. Will try to recover/fill in with older data."
+          p sectors
+          tile = "#{data_path}/#{bad_pic_name}-#{sectors[0][-3, 3]}.png"
+          sectors.each do |bad_tile|
+            `curl -sC - "#{HIMAWARI_URL}/#{resolution}d/550/#{bad_tile}.png" > #{tile}`
+            if bad_tile?(tile) # yep, it's bad...
+              # File.delete(tile)
+              pic_not_good = true
+            else
+              puts "#{tile} was recovered using #{bad_tile}!"
+              pic_not_good = false
+              break
+            end
+          end
+        end
+        # either too many pieces missing, or couldn't recover the wholes. It will look UGLY after reassembly,
+        # so just bite the bullet and get rid of the whole thing
+        `rm #{data_path}/#{bad_pic_name}*` if pic_not_good
+      end
+    end
+  end
+end

data/spec/test_base.rb

@@ -0,0 +1,54 @@
+# frozen-string-literal: true
+
+require 'test_helper'
+
+class TestBase < HimawariTest
+  # Firstly, let's check our params sanity...
+  def test_bad_params
+    bad_params = [
+      { resolution: 5 },
+      { focus: :bad },
+      { mode: 'live' },
+      { blacklist: 'live' },
+      { destination: '/definitely/a/bad_path' }
+    ]
+    bad_combos = (1..bad_params.count).flat_map { |length| bad_params.combination(length).to_a }
+
+    bad_combos.each do |params|
+      params = (params + [{ workdir: @@workdir }]).reduce({}, :merge)
+
+      # out = \
+      capture_stdout do
+        puts params
+        assert_equal false, @himawari.new(params).params_valid?
+      end
+      # puts out
+    end
+  end
+
+  def test_up_to_date
+    h = @himawari.new({ workdir: @@workdir })
+    assert_equal false, h.up_to_date?
+
+    h.latest_local[:timestamp] = Time.now - 300 # 300 == 5.minutes
+    assert_equal true, h.up_to_date?
+  end
+
+  def test_set_background
+    destination = "#{@@workdir}/data/selected_background"
+    Dir.mkdir(destination) unless File.exist?(destination)
+
+    h = @himawari.new({ workdir: @@workdir, destination: destination })
+    sample = Dir["#{h.data_path}/h_*.png"].sample
+
+    assert_equal !sample.nil?, h.background(sample)
+  end
+
+  def test_cron
+    cmd = @himawari.new({ workdir: @@workdir }).crontab(:set)
+    assert_equal true, `crontab -l | grep \"#{cmd}\"`.size.positive?
+
+    @himawari.new({ workdir: @@workdir }).crontab(:clear)
+    assert_equal true, `crontab -l | grep \"#{cmd}\"`.empty?
+  end
+end

data/spec/test_helper.rb

@@ -0,0 +1,42 @@
+# frozen-string-literal: true
+
+require 'minitest/autorun'
+require_relative '../lib/himawari.rb'
+
+class HimawariTest < Minitest::Test
+  # rubocop:disable Style/ClassVars
+  @@workdir = Pathname.new(File.expand_path(__dir__))
+  # rubocop:enable Style/ClassVars
+
+  def setup
+    @himawari = Himawari::Download
+    date1 = Time.parse('2019-01-01 00:00:00 +00:00')
+    date2 = Time.parse('2020-06-01 00:00:00 +00:00')
+    @timestamp = Time.at((date2.to_f - date1.to_f) * rand + date1.to_f)
+
+    # 1200secs == 20.minutes 02:40 and 14:40 are "bad" timestamps because
+    # we know 100% that himawari does not take photos at those times
+    @timestamp -= 1200 if @timestamp.min == 40 && [2, 14].include?(@timestamp.hour)
+  end
+
+  # def teardown
+  #  puts 'run after each test'
+  # end
+
+  def capture_stdout
+    original_stdout = $stdout  # capture previous value of $stdout
+    $stdout = StringIO.new     # assign a string buffer to $stdout
+    yield                      # perform the body of the user code
+    $stdout.string             # return the contents of the string buffer
+  ensure
+    $stdout = original_stdout  # restore $stdout to its previous value
+  end
+
+  def self.cleanup
+    puts "Cleanup: Removing #{@@workdir}/data"
+    `rm -r #{@@workdir}/data*` if File.directory?("#{@@workdir}/data")
+  end
+end
+
+HimawariTest.cleanup
+Minitest.after_run { HimawariTest.cleanup }

data/spec/test_net.rb

@@ -0,0 +1,28 @@
+# frozen-string-literal: true
+
+require 'test_helper'
+
+class TestNet < HimawariTest
+  # Do the main methods function w/o crashing?
+  def test_get_pic
+    puts "Try to get a pic from #{@timestamp}"
+    assert_equal true, Himawari.get_pic(datetime: @timestamp, workdir: @@workdir)
+  end
+
+  def test_get_pic_blacklisted_wifi
+    current_wifi = if Himawari::OsUtils.os == :mac
+                     `networksetup -getairportnetwork en0`
+                   elsif Himawari::OsUtils.os == :linux
+                     `iwgetid -r`
+                   end
+
+    capture_stdout do
+      assert_equal false, Himawari.get_pic(datetime: @timestamp, workdir: @@workdir, blacklist: [current_wifi])
+    end
+  end
+
+  def test_get_pics
+    puts "Try to get pics in #{@timestamp} ~ #{@timestamp + 3600 * 2}"
+    assert_equal true, Himawari.get_pics(from: @timestamp, to: @timestamp + 3600 * 2, workdir: @@workdir)
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: himawari
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- engura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+description: Makes pretty, high-res backgrounds from the real-time photos of Earth
+  by Himawari8,or is intended for similar personal usage. Please see the readme for
+  more!
+email:
+- engura@gmail.com
+executables:
+- himawari
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/setup
+- doc/img/h_2020-06-01T0100.png
+- doc/img/h_2020-11-29T0110.png
+- doc/img/t_2020-12-01T0410-1_0.png
+- exe/himawari
+- himawari.gemspec
+- lib/himawari.rb
+- lib/himawari/base.rb
+- lib/himawari/download.rb
+- lib/himawari/net_utils.rb
+- lib/himawari/no_image.png
+- lib/himawari/os_utils.rb
+- lib/himawari/process.rb
+- spec/test_base.rb
+- spec/test_helper.rb
+- spec/test_net.rb
+homepage: https://github.com/engura/himawari
+licenses:
+- MIT
+metadata: {}
+post_install_message: |-
+  Thanks for installing! Have fun with the amazing pics of our Home made
+  accessible to us for FREE by NICT. And please, don't break their website!!
+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:
+- 'Mac OSX or Linux... Windows `not supported yet` due to the lack of the following:'
+- parallel, ~>20161222 (Let's download in parallel)
+- ImageMagick, ~>6.9.10-23 (Specifically, the `montage` utility)
+- 'common utilities: find, touch, crontab, curl, iwgetid, rm, bash'
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Grabs latest images from the himawari8 weather satellite
+test_files:
+- spec/test_base.rb
+- spec/test_helper.rb
+- spec/test_net.rb