tlapse 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b430e71598aedbebbca7591db61fafc406df196a4f6e052156f45acd570a9775
-  data.tar.gz: 57d8a73fc5d746bed749f51107d7880ea1bdafd67e2175285fa4ad61abc20404
+  metadata.gz: 2f9ba7284d147763881cdb94e11e8bb77369be4eb1c43ec1b290382700f0a004
+  data.tar.gz: 3ba78dd8eec0d82fbae34003c6dd525ca3e6df4ebbc0ea1e70dc2eaea97da50e
 SHA512:
-  metadata.gz: cbe3f73147112a94f2384826d463f0f0b169a6517251919fffc544a0e8b479fe892a154e59e68cdffbf733464c65318a6473bec3f869aad29f8c4918b3b580df
-  data.tar.gz: 241a51427ccd092e73cadbe84b5e6416118a80f3baf2e0cba02213d79a42d59e926c09f2744d020ef5ffb2853ba993c2f001938db3a0647afa1f4039f8eaee4d
+  metadata.gz: bb467169d60beaa2e9f5b3a8bfa88cb0264873ead65fe3254ea19e1780ebd75b48cb095270338e72142c4b0934ecb60b7fcc2b73ec6a38fe72ab471a809f17ea
+  data.tar.gz: edea957cce99cbc196fef32eb3766be708bc8b58d37b4f1269daa4f3104deed929eb56f33be2b98b9a961d12ec8a9c2a03a54a8239ce3e207a795b62bfcc7f76

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 *.gem
 .byebug_history
+coverage

data/README.md

@@ -4,19 +4,27 @@ Automated time lapse photography using gphoto2.
 
 ## Installation
 
-1. Install gphoto2
+1. Install gphoto2 and ffmpeg
 
-  * macOS: `brew install gphoto2`
-  * Debian/Ubuntu: `sudo apt install gphoto2`
+  * macOS: `brew install gphoto2 ffmpeg`
+  * Debian/Ubuntu: `sudo apt install gphoto2 ffmpeg`
 
 2. `gem install tlapse`
 
 ## Example: Integrate with cron
 
-* From 9 AM to sunset, capture one image every 10 minutes
+* From 9 AM to 1 PM, capture one image every 10 minutes
 
 ```
-0 9 * * * cd $HOME && eval "$(tlapse until_sunset --interval 10)" >> capture.log
+0 9 * * * cd $HOME && tlapse alpha capture --until 1pm --interval 10
+```
+
+* From 3 PM to sunset, capture an image every minute. Compile the result into a video.
+  * You should [configure](#configuration) your coordinates to accurately
+    determine sunset in your location
+
+```
+0 15 * * * cd $HOME && tlapse alpha capture --until sunset --interval 10 --compile
 ```
 
 ## CLI
@@ -25,6 +33,14 @@ Find better documentation by running `tlapse help` or `tlapse help SUBCOMMAND`
 
 * `tlapse capture_single` - Capture an image using the tethered camera
 * `tlapse until_sunset` - Generate a gphoto2 command which captures images until sunset
+  * You should [configure](#configuration) your coordinates to accurately
+    determine sunset in your location
+
+#### Alpha CLI
+
+These are early-stage features which are likely to change quite a bit before they're ready for prime time.
+
+* `tlapse alpha capture` - Capture a series of timelapse images (see `tlapse alpha capture --help` for options)
 
 ## API
 
@@ -45,6 +61,22 @@ Mostly useful for cronjobs and the like.
   # => "gphoto2 --capture-image-and-download -I 1800 -F 11 --filename '%Y-%m-%d_%H-%M-%S.jpg'"
   ```
 
+## Configuration <a name="configuration"/>
+
+So sunrise and sunset calculations are correct for your location, it is
+advisable to configure your (approximate) coordintes using the CLI. Defaults are
+for Raleigh, NC, which is probably not where you live.
+
+You can get rough coordinates from https://www.iplocation.net/
+
+```
+tlapse config set lat YOUR_LATITUDE
+tlapse config set lon YOUR_LONGITUDE
+
+# Optionally also configure your timezone to make date formatting nicer
+tlapze config set tz YOUR_TIMEZONE (e.g. America/New_York)
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/tlapse/cli/cli.rb

@@ -2,6 +2,7 @@ require "thor"
 require "active_support/core_ext/numeric/time.rb"
 require "tlapse"
 require "tlapse/cli/alpha"
+require "tlapse/cli/config"
 
 module Tlapse::CLI
   class CLI < Thor
@@ -31,6 +32,9 @@ module Tlapse::CLI
       puts Tlapse::Capture.timelapse_command_while_sun_is_up(interval: interval)
     end
 
+    desc "config", "Read and write config options"
+    subcommand "config", Tlapse::CLI::Config
+
     desc "alpha", "Get early access to in-development (and likely unstable) commands"
     subcommand "alpha", Tlapse::CLI::Alpha
   end

data/lib/tlapse/cli/config.rb

@@ -0,0 +1,67 @@
+require "thor"
+require "tlapse/config"
+
+module Tlapse::CLI
+  class Config < Thor
+    desc "list", "List available configuration options"
+    def list
+      config = Tlapse::Config.list.dup
+      opts = config.keys
+
+      values = Tlapse::Config.get *opts
+
+      config = config.transform_values.with_index do |original, index|
+        default = original[:default]
+        default = default.call if default.respond_to? :call
+        original[:default] = default
+
+        original[:value] = values[index].to_s
+
+        original
+      end
+
+      # Make a simple table.
+      max_name = opts.max_by(&:length).length
+      max_desc = opts.max_by { |opt| config[opt][:desc].length }
+      max_desc = config[max_desc][:desc].length
+      max_value = opts.max_by { |opt| config[opt][:value].length }
+      max_value = config[max_value][:value].length
+
+      config.each_pair do |option, meta|
+        desc, default = meta.values_at :desc, :default
+        name_padded   = option.ljust(max_name, " ")
+        desc_padded   = meta[:desc].ljust(max_desc, " ")
+        #value_padded  = meta[:value].ljust(max_value, " ")
+        value_padded = meta[:value]
+
+        puts "#{name_padded} -> #{desc_padded} -> #{value_padded} (default: #{default})"
+      end
+    end
+
+    desc "get OPTION", "Get the value for the given config option"
+    def get(*options)
+      puts Tlapse::Config.get *options
+    rescue Tlapse::NoSuchConfigOption
+      Tlapse::Logger.error! "The config option \"#{option}\" does not exist. " \
+        "Run tlapse config list for a full list of available options"
+    end
+
+    desc "set OPTION VALUE", "Set the given config option to the given value"
+    def set(option, value)
+      Tlapse::Config.set option, value
+    rescue Tlapse::NoSuchConfigOption
+      Tlapse::Logger.error! "The config option \"#{option}\" does not exist. " \
+        "Run tlapse config list for a full list of available options"
+    rescue Tlapse::ConfigOptionInvalid => invalid
+      Tlapse::Logger.error! invalid.message
+    end
+
+    desc "unset OPTION", "Restore the given option to its default state"
+    def unset(option)
+      Tlapse::Config.unset option
+    rescue Tlapse::NoSuchConfigOption
+      Tlapse::Logger.error! "The config option \"#{option}\" does not exist. " \
+        "Run tlapse config list for a full list of available options"
+    end
+  end
+end

data/lib/tlapse/config.rb

@@ -0,0 +1,136 @@
+require "yaml"
+require "fileutils"
+require "tlapse/errors"
+require "active_support/time_with_zone"
+
+module Tlapse
+  class Config
+    Validation = Struct.new :method, :error
+
+    CONFIG_OPTIONS = {
+      "lat" => {
+        default: 35.779590,
+        desc: "Your current latitude",
+        type: :float
+      },
+      "lon" => {
+        default: -78.638179,
+        desc: "Your current longitude",
+        type: :float
+      },
+      "tz" => {
+        default: -> { Tlapse::Config.current_tz },
+        desc: "Your current timezone",
+        type: :string,
+        validations: [
+          Validation.new(
+            ->(tz) { TZInfo::Timezone.get(tz) },
+            ->(tz) do
+              zones = ActiveSupport::TimeZone.all.map do |tz|
+                tz.tzinfo.name
+              end.uniq.sort.join("\n")
+
+              "#{tz} is not a valid timezone. Valid zones are:\n\n#{zones}"
+            end
+          )
+        ]
+      }
+    }.freeze
+
+    CONFIG_KEYS = CONFIG_OPTIONS.keys.freeze
+
+    CONFIG_PATH = File.expand_path ".config/tlapse/tlapse.yaml", Dir.home
+
+    CONFIG_UNDEFINED = :undefined
+
+    def self.list
+      CONFIG_OPTIONS
+    end
+
+    def self.get(*options)
+      values = Array(options).map do |option|
+        verify_option_exists! option
+
+        value = value_for option
+        value == CONFIG_UNDEFINED ? default_for(option) : value
+      end
+
+      values.length == 1 ? values.first : values
+    end
+
+    def self.set(option, value)
+      verify_option_exists! option
+      validate! option, value
+
+      values = user_values
+
+      if value == default_for(option)
+        values.delete option
+      else
+        values[option] = value
+      end
+
+      save values
+    end
+
+    def self.unset(option)
+      set option, default_for(option)
+    end
+
+    private
+
+    def self.current_tz
+      utc_offset = Time.now.utc_offset
+      tz = ActiveSupport::TimeZone.all.find { |tz| tz.utc_offset == utc_offset }
+      tz&.tzinfo&.name || "America/New_York"
+    end
+
+    def self.cast(option, value)
+      case type_for(option)
+      when :integer then value.to_i
+      when :float   then value.to_f
+      when :string  then value.to_s
+      else value
+      end
+    end
+
+    def self.verify_option_exists!(option)
+      raise Tlapse::NoSuchConfigOption unless CONFIG_KEYS.include? option
+    end
+
+    def self.value_for(option)
+      value = user_values[option]
+      value ? cast(option, value) : CONFIG_UNDEFINED
+    end
+
+    def self.default_for(option)
+      default = CONFIG_OPTIONS.dig option, :default
+      default = default.call if default.respond_to? :call
+      cast option, default
+    end
+
+    def self.type_for(option)
+      CONFIG_OPTIONS.dig option, :type
+    end
+
+    def self.user_values
+      File.exists?(CONFIG_PATH) ? YAML.load_file(CONFIG_PATH) : {}
+    end
+
+    def self.save(user_values)
+      FileUtils.mkdir_p File.dirname CONFIG_PATH
+      File.write CONFIG_PATH, user_values.to_yaml
+    end
+
+    def self.validate!(option, value)
+      Array(CONFIG_OPTIONS.dig(option, :validations)).each do |validation|
+        begin
+          validation.method.call value
+        rescue
+          message = validation.error.call value
+          raise ConfigOptionInvalid, message
+        end
+      end
+    end
+  end
+end

data/lib/tlapse/errors.rb

@@ -0,0 +1,4 @@
+module Tlapse
+  class NoSuchConfigOption < StandardError; end
+  class ConfigOptionInvalid < StandardError; end
+end

data/lib/tlapse/solar_event.rb

@@ -1,26 +1,26 @@
 require "solareventcalculator"
+require "tlapse/config"
 
 module Tlapse
   module SolarEvent
-    LAT  = 35.779590
-    LON  = -78.638179
-    TZ   = "America/New_York"
-
     def self.sunrise
-      s = solar_event.compute_official_sunrise(TZ)
-      n = Time.new
+      tz = Tlapse::Config.get "tz"
+      s  = solar_event.compute_official_sunrise(tz)
+      n  = Time.new
       Time.new(n.year, n.month, n.day, s.hour, s.minute)
     end
 
     def self.sunset
-      s = solar_event.compute_official_sunset(TZ)
-      n = Time.new
+      tz = Tlapse::Config.get "tz"
+      s  = solar_event.compute_official_sunset(tz)
+      n  = Time.new
       Time.new(n.year, n.month, n.day, s.hour, s.minute)
     end
 
     def self.solar_event
       date = Date.new
-      SolarEventCalculator.new date, LAT, LON
+      lat, lon = Tlapse::Config.get "lat", "lon"
+      SolarEventCalculator.new date, lat, lon
     end
   end
 end

data/lib/tlapse/version.rb

@@ -1,3 +1,3 @@
 module Tlapse
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/tlapse.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug", "~> 8.2"
   spec.add_development_dependency "timecop", "~> 0.8"
+  spec.add_development_dependency "simplecov", "~> 0.15"
 
   spec.add_dependency "activesupport", "~> 5"
   spec.add_dependency "RubySunrise", "~> 0.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tlapse
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Justin Toniazzo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-23 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +163,6 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
-- ":w"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -161,7 +174,10 @@ files:
 - lib/tlapse/capture.rb
 - lib/tlapse/cli/alpha.rb
 - lib/tlapse/cli/cli.rb
+- lib/tlapse/cli/config.rb
+- lib/tlapse/config.rb
 - lib/tlapse/doctor.rb
+- lib/tlapse/errors.rb
 - lib/tlapse/logger.rb
 - lib/tlapse/server.rb
 - lib/tlapse/solar_event.rb
@@ -189,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Automated time lapse photography via gphoto2

data/:w

@@ -1,3 +0,0 @@
-module Tlapse
-  VERSION = "0.6.0"
-end