fidget 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce823012d9505a1ffb01dc781c1481df5e507532
+  data.tar.gz: d328d92527cbeba4a359a0a270c8cb9d0de36c09
+SHA512:
+  metadata.gz: 63bad66d8091d5a84099ae4b64e8d8bc230da6f4ca852bc7b7f6bca9d7184cc1fdadf9216404e1d22cc7fb31c59f58bb6e99ee64c5605ef72bb89779fffe0621
+  data.tar.gz: 941ff8d08cffa1cc6792f0a74b4808c5ea969271213936369e486c74f5cb1d3f30bc6534f76ebffabe0b0314801434775742f5928dd427711f0b1c7a8c75c7f5

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,112 @@
+# Fidget
+A cross platform tool to prevent your computer from sleeping.
+
+## Overview
+
+Usage : `fidget [-o <options>] [command]`
+
+Sleep options may very between platforms. Each platform will include at least
+the following core options:
+
+  * `display` will prevent the display from sleeping.
+  * `sleep` prevent the system from sleeping.
+  * `all` to declare all known options.
+
+Additional OS X options:
+
+  * `idle` will prevent the system from idle sleeping.
+  * `disk` will prevent the disk from sleeping.
+
+Additional Windows options:
+
+  * `away` enables a low-power, but not sleeping, mode on Windows.
+
+Additional Linux options:
+
+  * `blanking` disables terminal blanking on Linux.
+
+If you pass the a command, then Fidget will execute that command and prevent
+the system from sleeping until that command terminates. If you do not provide a
+command, then Fidget will prevent sleeping until you press Ctrl-C to terminate.
+
+## Library Usage
+
+There are three methods you may use in your programs. The `options` parameter
+should be either an array or just a list of options and can be passed as strings
+or symbols.
+
+* `Fidget.prevent_sleep(options)`
+    * Stops the computer from sleeping.
+    * Can accept a block, in which case sleep will be inhibited during the execution
+    of the block and resumed after.
+* `Fidget.allow_sleep`
+    * Resume any previously inhibited sleep.
+* `Fidget.current_process(options)`
+    * Shortcut method to inhibit sleep during the execution of the current process.
+
+### Example usages:
+
+Default options, with a block:
+
+    #! /usr/bin/env ruby
+    require 'fidget'
+    
+    Fidget.prevent_sleep do
+      100.times do
+        print '.'
+        sleep 1
+      end
+    end
+
+Define sleep options to inhibit, with a block:
+
+    #! /usr/bin/env ruby
+    require 'fidget'
+
+    Fidget.prevent_sleep(:display, :sleep) do
+      100.times do
+        print '.'
+        sleep 1
+      end
+    end
+
+No block, just calling methods:
+
+    #! /usr/bin/env ruby
+    require 'fidget'
+
+    Fidget.prevent_sleep(:display, :sleep)
+    
+    100.times do
+      print '.'
+      sleep 1
+    end
+    
+    Fidget.allow_sleep
+
+Simply prevent the computer from sleeping while the current process is running:
+
+    #! /usr/bin/env ruby
+    require 'fidget'
+
+    Fidget.current_process
+    
+    100.times do
+      print '.'
+      sleep 1
+    end
+   
+
+## Limitations
+
+This is super early in development and has not yet been battle tested.
+
+## Disclaimer
+
+I take no liability for the use of this tool.
+
+Contact
+-------
+
+binford2k@gmail.com
+

data/bin/fidget

@@ -0,0 +1,68 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'fidget'
+
+options  = []
+optparse = OptionParser.new { |opts|
+    opts.banner = "Usage : fidget [-o <options>] [command]
+
+Cross platform utility to prevent your system from sleeping.
+
+Sleep options may very between platforms. Each platform will include at least
+the following core options:
+  * 'display' will prevent the display from sleeping.
+  * 'sleep' prevent the system from sleeping.
+  * 'all' to declare all known options.
+
+Additional OS X options:
+  * 'idle' will prevent the system from idle sleeping.
+  * 'disk' will prevent the disk from sleeping.
+
+Additional Windows options:
+  * 'away' enables a low-power, but not sleeping, mode on Windows.
+
+Additional Linux options:
+  * 'blanking' disables terminal blanking on Linux.
+
+If you pass the a command, then Fidget will execute that command and prevent
+the system from sleeping until that command terminates. If you do not provide a
+command, then Fidget will prevent sleeping until you press Ctrl-C to terminate.
+
+"
+    opts.on("-o OPTIONS", "--options OPTIONS", "Comma separated list of sleep options.") do |arg|
+        options = arg.split(',').map{ |e| e.to_sym }
+    end
+
+    opts.on("-d", "--debug", "Display or log debugging messages") do
+        loglevel = Logger::DEBUG
+    end
+
+    opts.separator('')
+
+    opts.on("-h", "--help", "Displays this help") do
+        puts
+        puts opts
+        puts
+        exit
+    end
+}
+optparse.parse!
+
+begin
+  if ARGV.size > 0
+    command = ARGV.join ' '
+
+    Fidget.prevent_sleep(options) do
+      system(command)
+    end
+  else
+    Fidget.current_process(options)
+    puts 'System has been prevented from sleeping.'
+    print '- Press Ctrl-C to resume normal power management.'
+    sleep
+  end
+rescue Interrupt => e
+  puts "Normal power management resumed."
+end

data/lib/fidget.rb

@@ -0,0 +1,38 @@
+class Fidget
+  case Gem::Platform.local.os
+  when /darwin/
+    require 'fidget/platform/darwin'
+
+  when /linux/
+    require 'fidget/platform/linux'
+
+  when /cygwin|mswin|mingw|bccwin|wince|emx/
+    require 'fidget/platform/windows'
+
+  when 'java'
+    STDERR.puts 'When running under jRuby, we cannot reliably manage power settings.'
+    require 'fidget/platform/null'
+
+  else
+    raise "Unknown platform: #{Gem::Platform.local.os}"
+  end
+
+  def self.current_process(options = nil)
+    Fidget::Platform.current_process(options)
+  end
+
+  def self.prevent_sleep(options = nil)
+    if block_given?
+      Fidget::Platform.prevent_sleep(options) do
+        yield
+      end
+    else
+      Fidget::Platform.prevent_sleep(options)
+    end
+  end
+
+  def self.allow_sleep(handle)
+    Fidget::Platform.allow_sleep(handle)
+  end
+
+end

data/lib/fidget/platform/darwin.rb

@@ -0,0 +1,53 @@
+class Fidget::Platform
+  def self.current_process(options)
+    pid = spawn("caffeinate #{arguments(options)}")
+
+    at_exit do
+      Process.kill('TERM', pid)
+    end
+  end
+
+  def self.prevent_sleep(options)
+    pid = spawn("caffeinate #{arguments(options)}")
+
+    if block_given?
+      yield
+      Process.kill('TERM', pid)
+    else
+      @@pids ||= []
+      @@pids << pid
+    end
+  end
+
+  def self.allow_sleep
+    return unless @@pids
+
+    @@pids.each do |pid|
+      Process.kill('TERM', pid)
+    end
+
+    @@pids = nil
+  end
+
+  def self.arguments(*options)
+    options.flatten!
+    options.compact!
+    return '-dism' if options == [:all]
+
+    terms = {
+      :display => 'd',
+      :idle    => 'i',
+      :disk    => 'm',
+      :sleep   => 's',
+    }
+    options.each do |opt|
+      STDERR.puts "Fidget: option #{opt} is not supported on OS X" unless terms.include? opt
+    end
+
+    args = options.map { |element| terms[element] }.compact.join
+
+    return "-#{args}" unless args.empty?
+  end
+  private_class_method :arguments
+
+end

data/lib/fidget/platform/linux.rb

@@ -0,0 +1,75 @@
+class Fidget::Platform
+  def self.current_process(options)
+    options = munge(options)
+    suspend(options)
+
+    at_exit do
+      resume(options)
+    end
+  end
+
+  def self.prevent_sleep(options)
+    options = munge(options)
+    suspend(options)
+
+    if block_given?
+      yield
+      resume(options)
+    end
+
+    pid
+  end
+
+  def self.allow_sleep(handle)
+    options = munge(options)
+    resume(options)
+  end
+
+  def self.munge(*options)
+    options.flatten!
+    options.compact!
+    options = [:display] if options.empty?
+    options = [:display, :blanking] if options == [:all]
+    options.each do |opt|
+      STDERR.puts "Fidget: option {opt} is not supported on Linux" unless [:display, :blanking].include? opt
+    end
+    options
+  end
+  #private_class_method :munge
+
+  def self.root_win
+    ids = `xwininfo -root`.each_line.collect do |line|
+      next unless line =~ /Window id: (0x\d+)/
+      $1
+    end.compact
+    raise "Parsing xwininfo failed" unless ids.size == 1
+    ids.first
+  end
+  #private_class_method :root_win
+
+  def self.suspend(options)
+    if options.include? :display
+      system("xdg-screensaver suspend #{root_win}")
+      system('xset -dpms')
+    end
+
+    if options.include? :blanking
+      @@blanking ||= File.read('/sys/module/kernel/parameters/consoleblank').strip
+      system('setterm -blank 0 -powerdown 0')
+    end
+  end
+  private_class_method :suspend
+
+  def self.resume(options)
+    if options.include? :display
+      system("xdg-screensaver resume #{root_win}")
+      system('xset dpms')
+    end
+
+    if options.include? :blanking
+      system("setterm -blank #{@@blanking} -powerdown #{@@blanking}")
+    end
+  end
+  private_class_method :resume
+
+end

data/lib/fidget/platform/windows.rb

@@ -0,0 +1,77 @@
+require 'Win32API'
+
+class Fidget::Platform
+  ES_CONTINUOUS        = 0x80000000
+  ES_SYSTEM_REQUIRED   = 0x00000001
+  ES_DISPLAY_REQUIRED  = 0x00000002
+  ES_AWAYMODE_REQUIRED = 0x00000040
+
+  KB_EVENT_KEYPRESS = 0
+  KB_EVENT_KEYUP    = 2
+  KB_KEY_F24        = 0x87
+
+  def self.current_process(options)
+    set_state(options)
+
+    at_exit do
+      set_state(nil)
+    end
+  end
+
+  def self.prevent_sleep(options)
+    set_state(options)
+
+    if block_given?
+      yield
+      set_state(nil)
+    end
+
+    pid
+  end
+
+  def self.allow_sleep(handle)
+    set_state(nil)
+  end
+
+  # Set thread execution state, using information from
+  # https://msdn.microsoft.com/en-us/library/aa373208(VS.85).aspx
+  # http://stackoverflow.com/questions/4126136/stop-a-windows-7-pc-from-going-to-sleep-while-a-ruby-program-executes
+  def self.set_state(*options)
+    options.flatten!
+    options.compact!
+    options = [:display, :sleep] if options.empty?
+    options = [:display, :sleep, :away] if options == [:all]
+
+    terms = {
+      :display => ES_DISPLAY_REQUIRED,
+      :sleep   => ES_SYSTEM_REQUIRED,
+      :away    => ES_AWAYMODE_REQUIRED,
+    }
+    options.each do |opt|
+      STDERR.puts "Fidget: option #{opt} is not supported on Windows" unless terms.include? opt
+    end
+
+    # translate options to constants, then OR them all together
+    mode = options.map { |element| terms[element] }.reduce { |memo, element| memo|element } || 0
+
+    state = Win32API.new('kernel32','SetThreadExecutionState','L')
+    state.call(ES_CONTINUOUS|mode)
+
+    if options.include? :display
+      @@kb_poker = Thread.new do
+        kb = Win32API.new('user32.dll', 'keybd_event', 'nnnn', 'v')
+        loop do
+          kb.call(KB_KEY_F24, 0, KB_EVENT_KEYPRESS, nil)
+          kb.call(KB_KEY_F24, 0, KB_EVENT_KEYUP, nil)
+          sleep 30
+        end
+      end
+    end
+
+    if options.nil?
+      Thread.kill @@kb_poker if @@kb_poker
+    end
+  end
+  private_class_method :set_state
+
+end

data/lib/fidget/version.rb

@@ -0,0 +1,3 @@
+class Fidget
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: fidget
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Ford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-08 00:00:00.000000000 Z
+dependencies: []
+description: |2
+    Fidget was inspired by the OS X commandline `caffeinate` tool, which in turn
+    was inspired by the Caffeine menubar tool. However, this tool is cross platform
+    and can be used as a Ruby library.
+
+    This will work on:
+      * Modern OS X
+      * Linux with xdg-screensaver (Xorg)
+      * Windows
+email: binford2k@gmail.com
+executables:
+- fidget
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- bin/fidget
+- lib/fidget/platform/darwin.rb
+- lib/fidget/platform/linux.rb
+- lib/fidget/platform/windows.rb
+- lib/fidget/version.rb
+- lib/fidget.rb
+homepage: https://github.com/binford2k/fidget
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Cross platform tool to prevent your computer from sleeping.
+test_files: []