light_me_up 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0265f93a138b0f04533c48e8ee0db2ad960b0d9940d84030e40209af938bd9
-  data.tar.gz: 57293c8bff4f7a51e1abdd959645dad756c7b2dc02b6d096211081620bdbe33e
+  metadata.gz: 500a673faf1257f9237ad66eb5c47cc852e3304f0aa458b137368afd720a9354
+  data.tar.gz: e9bd47febd94eb07be90b4914ad8cf5c2ad9b252751e98ab1fa989a64f77984b
 SHA512:
-  metadata.gz: ad82872d763c4971ed34fd6eee722534de858ac2a98137ecef3625a5b516c118455c9f71c81350dc8e1d5ca69711ab9a6e32190781d1ce9c1e9c2fac3015814d
-  data.tar.gz: ace52c60a228ef88631d6abc0f85b01df21b241b975d3c4fc277982810531147d4ed26691c988caa254ab0ac854c51b839030ee28c66e4ea57d7fe9c6896bd6a
+  metadata.gz: 39f34213c145f83d0dc2db551514599d5b66d0d1db5ea5275e64440b5273e7620c7de8d0d31fa67290a1621cf86c1d976e92ba710145629ad673d6004abaf9d2
+  data.tar.gz: e7b88500d35fe156b9c1fc22e9b9c19ce3cd58cf7b2a7ffdf8fed9a3200f149a306440492768a20f33d5a26755bbdd190c812e64608ff587d882634a2ec7592b

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +12,12 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: same_line

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.17"
+gem "rubocop-rake", "~> 0.6"

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    light_me_up (0.1.0)
+    light_me_up (0.2.0)
+      optimist (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     minitest (5.15.0)
+    optimist (3.0.1)
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
@@ -26,6 +28,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
+    rubocop-minitest (0.17.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)
 
@@ -37,6 +43,8 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)
+  rubocop-minitest (~> 0.17)
+  rubocop-rake (~> 0.6)
 
 BUNDLED WITH
    2.2.32

data/bin/light-me-up

@@ -1,19 +1,50 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative "../lib/light_me_up"
+require "optimist"
 
-parser = LightMeUp::OptionParser.new(
-  program_name: File.basename(__FILE__),
-  starting_options: {
-    ip_address: ENV["ELGATO_IP_ADDRESS"],
-  },
-  default_settings: {
-    brightness: ENV["ELGATO_DEFAULT_BRIGHTNESS"].to_i,
-    temperature: ENV["ELGATO_DEFAULT_TEMPERATURE"].to_i,
-  }
+brightness_help = format(
+  "Set the brightness (%<min>d to %<max>d)",
+  min: LightMeUp::Light.min_brightness,
+  max: LightMeUp::Light.max_brightness
+)
+temperature_help = format(
+  "Set the temperature (%<min>d to %<max>d)",
+  min: LightMeUp::Light.min_temperature,
+  max: LightMeUp::Light.max_temperature
 )
 
-options = parser.parse(ARGV)
+options = Optimist.options do
+  banner "Usage: #{$PROGRAM_NAME} [options]"
+
+  opt :toggle, "Toggle whether the lights are on or off", short: "T"
+  opt :on, "Turn the light on"
+  opt :off, "Turn the light off", short: "O"
+  opt :ip_address, "Specify the IP address", type: :string, default: ENV["ELGATO_IP_ADDRESS"]
+  opt :defaults, "Set to default values"
+  opt :brightness, brightness_help, type: :integer
+  opt :temperature, temperature_help, type: :integer
+end
+
+options = options.select { |_k, v| v }
+options[:on] = false if options.delete(:off)
+if options.delete(:defaults)
+  options.reverse_merge!(
+    brightness: ENV["ELGATO_DEFAULT_BRIGHTNESS"].to_i,
+    temperature: ENV["ELGATO_DEFAULT_TEMPERATURE"].to_i
+  )
+end
+
 api_client = LightMeUp::ApiClient.new(ip_address: options[:ip_address])
-success = LightMeUp::SettingsUpdate.new(api_client, options, parser.help_message).perform
-exit 1 unless success
+
+begin
+  LightMeUp::SettingsUpdate.new(api_client, options).perform
+rescue LightMeUp::SettingsUpdate::ToggleIncompatible => e
+  Optimist.die :toggle, e.message
+rescue LightMeUp::NoOptionsGiven
+  Optimist.educate
+rescue LightMeUp::Error => e
+  warn e.message
+  exit 1
+end

data/lib/light_me_up/api_client.rb

@@ -1,8 +1,10 @@
-require 'net/http'
-require 'json'
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
 
 module LightMeUp
-  class ApiClient
+  class ApiClient # rubocop:disable Metrics/ClassLength
     DEFAULT_PORT = 9123
     LIGHTS_PATH = "/elgato/lights"
     OPEN_TIMEOUT = 2 # seconds
@@ -10,6 +12,7 @@ module LightMeUp
 
     def initialize(ip_address:, port: DEFAULT_PORT)
       raise Error, "No ip_address specified." unless ip_address && ip_address != ""
+
       @ip_address = ip_address
       @port = port
     end
@@ -20,7 +23,7 @@ module LightMeUp
     end
 
     def toggle
-      with_connection do |http|
+      with_connection do |_http|
         current_status = status
 
         if current_status.on
@@ -31,24 +34,24 @@ module LightMeUp
       end
     end
 
-    def set(on: nil, brightness: nil, temperature: nil)
+    def update(on: nil, brightness: nil, temperature: nil)
       update_light(Light.new(on: on, brightness: brightness, temperature: temperature))
     end
 
     def turn_light_on
-      set(on: true)
+      update(on: true)
     end
 
     def turn_light_off
-      set(on: false)
+      update(on: false)
     end
 
-    def set_brightness(brightness)
-      set(brightness: brightness)
+    def update_brightness(brightness)
+      update(brightness: brightness)
     end
 
-    def set_temperature(temperature)
-      set(temperature: temperature)
+    def update_temperature(temperature)
+      update(temperature: temperature)
     end
 
     private
@@ -67,7 +70,7 @@ module LightMeUp
     def build_light_configuration_data(lights)
       {
         numberOfLights: lights.size,
-        lights: lights.map { |l| LightSerializer.serialize(l) }
+        lights: lights.map { |l| LightSerializer.serialize(l) },
       }
     end
 
@@ -108,7 +111,7 @@ module LightMeUp
 
     def perform_request_with_connection(method, uri, &block)
       request = build_request(method, uri)
-      request['Content-Type'] = "application/json"
+      request["Content-Type"] = "application/json"
       block.call(request) if block_given?
       response = connection.request(request)
 
@@ -118,7 +121,6 @@ module LightMeUp
       else
         raise Error, response.body
       end
-
     end
 
     def build_request(method, uri)

data/lib/light_me_up/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightMeUp
   class Error < StandardError
   end

data/lib/light_me_up/light.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module LightMeUp
   class Light
     attr_reader :on, :brightness, :temperature
 
-    BRIGHTNESS_RANGE = (0..100)
-    TEMPERATURE_RANGE = (143..344)
+    BRIGHTNESS_RANGE = (0..100).freeze
+    TEMPERATURE_RANGE = (143..344).freeze
 
     class << self
       def max_brightness
@@ -45,6 +47,7 @@ module LightMeUp
     def validate_range(value, range, name)
       return if value.nil?
       return if range.include?(value)
+
       raise Error, "#{name} must be between #{range.first} and #{range.last}"
     end
   end

data/lib/light_me_up/light_serializer.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module LightMeUp
   class LightSerializer
     class << self
       def serialize(light)
         on_as_int = if light.on.nil?
-          nil
-        else
-          light.on ? 1 : 0
-        end
+                      nil
+                    else
+                      light.on ? 1 : 0
+                    end
 
         {
           on: on_as_int,
@@ -20,7 +22,7 @@ module LightMeUp
           Light.new(
             on: light["on"] == 1,
             brightness: light["brightness"],
-            temperature: light["temperature"],
+            temperature: light["temperature"]
           )
         end
       end

data/lib/light_me_up/settings_update.rb

@@ -1,42 +1,27 @@
+# frozen_string_literal: true
+
 module LightMeUp
   class SettingsUpdate
-    attr_reader :api_client, :options, :help_message, :output_stream, :error_output_stream
+    attr_reader :api_client, :options
+
+    class ToggleIncompatible < Error; end
+    class NoOptionsGiven < Error; end
 
-    def initialize(api_client, options, help_message, output_stream=STDOUT, error_output_stream=STDERR)
+    def initialize(api_client, options)
       @api_client = api_client
       @options = options
-      @help_message = help_message
-      @output_stream = output_stream
-      @error_output_stream = error_output_stream
     end
 
     def perform
-      if options[:help]
-        puts parser.help_message
-        return true
-      end
-
       if options[:toggle]
-        if settings_options.any?
-          error_output_stream.puts "Toggle is not compatible with setting other options."
-          output_stream.puts help_message
-          return false
-        end
+        raise ToggleIncompatible, "is not compatible with setting other options" if settings_options.any?
 
         api_client.toggle
-        return true
       end
 
-      if settings_options.any?
-        api_client.set(**settings_options)
-        return true
-      end
+      api_client.set(**settings_options) if settings_options.any?
 
-      output_stream.puts help_message
-      return false
-    rescue LightMeUp::Error => e
-      error_output_stream.puts e.message
-      return false
+      raise NoOptionsGiven, "provide at least one option"
     end
 
     private

data/lib/light_me_up/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LightMeUp
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/light_me_up.rb

@@ -4,6 +4,5 @@ require_relative "light_me_up/version"
 require_relative "light_me_up/error"
 require_relative "light_me_up/light"
 require_relative "light_me_up/light_serializer"
-require_relative "light_me_up/option_parser"
 require_relative "light_me_up/settings_update"
 require_relative "light_me_up/api_client"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: light_me_up
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter McCracken
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
-dependencies: []
+date: 2022-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Provides the ability to turn on and off, and adjust brightness and temperature,
   on a key light.
 email:
@@ -35,7 +49,6 @@ files:
 - lib/light_me_up/error.rb
 - lib/light_me_up/light.rb
 - lib/light_me_up/light_serializer.rb
-- lib/light_me_up/option_parser.rb
 - lib/light_me_up/settings_update.rb
 - lib/light_me_up/version.rb
 homepage: https://github.com/peterjm/light_me_up
@@ -45,6 +58,7 @@ metadata:
   homepage_uri: https://github.com/peterjm/light_me_up
   source_code_uri: https://github.com/peterjm/light_me_up
   changelog_uri: https://github.com/peterjm/light_me_up/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/light_me_up/option_parser.rb

@@ -1,75 +0,0 @@
-require 'optparse'
-
-module LightMeUp
-  class OptionParser
-    MESSAGES = {
-      help: "Prints this help message",
-      toggle: "Toggle whether the lights are on or off",
-      on: "Turn the light on",
-      off: "Turn the light off",
-      ip_address: "Specify the IP address",
-      defaults: "Set to default values",
-      brightness: "Set the brightness (%d to %d)" %
-        [LightMeUp::Light.min_brightness, LightMeUp::Light.max_brightness],
-      temperature: "Set the temperature (%d to %d)" %
-        [LightMeUp::Light.min_temperature, LightMeUp::Light.max_temperature],
-    }
-
-    attr_reader :program_name, :options, :default_settings
-
-    def initialize(program_name:, starting_options:, default_settings:)
-      @program_name = program_name
-      @options = starting_options.dup
-      @default_settings = default_settings.dup
-    end
-
-    def parse(input_options)
-      parser.parse!(input_options)
-      options
-    end
-
-    def help_message
-      parser.to_s
-    end
-
-    private
-
-    def parser
-      @parser ||= ::OptionParser.new do |opts|
-        opts.banner = "Usage: #{program_name} [options]"
-
-        opts.on("-h", "--help", MESSAGES[:help]) do
-          options[:help] = true
-        end
-
-        opts.on("-T", "--toggle", MESSAGES[:toggle]) do
-          options[:toggle] = true
-        end
-
-        opts.on("-o", "--on", MESSAGES[:on]) do
-          options[:on] = true
-        end
-
-        opts.on("-O", "--off", MESSAGES[:off]) do
-          options[:on] = false
-        end
-
-        opts.on("-i", "--ip-address=IP_ADDRESS", MESSAGES[:ip_address]) do |ip_address|
-          options[:ip_address] = ip_address
-        end
-
-        opts.on("-d", "--defaults", MESSAGES[:defaults]) do
-          options.merge!(default_settings)
-        end
-
-        opts.on("-bBRIGHTNESS", "--brightness=BRIGHTNESS", MESSAGES[:brightness]) do |brightness|
-          options[:brightness] = brightness.to_i
-        end
-
-        opts.on("-tTEMPERATURE", "--temperature=TEMPERATURE", MESSAGES[:temperature]) do |temperature|
-          options[:temperature] = temperature.to_i
-        end
-      end
-    end
-  end
-end