lirc 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f48efe7d977a6031e1408e0871541883aa0ed929f2479f7962e4870aff22ec6a
+  data.tar.gz: 6f5746e35b5828d76f8422b66140f672c2b2c2f880159fc2f800a498a9d06fd5
+SHA512:
+  metadata.gz: aaf93ac913656b7255e14b52b972950ed9309d941fe41aa0bec65c4c278cf0444b210445c47b100d950e5ba905780096600e7e9dfb308917d932598c5dad3400
+  data.tar.gz: 0c6d9f2d0b7b126d476e234823affa52b2feb472f04483bd2343edb3b05475b52ab3810415c9abb688cf557fefc944f2d6b270d144c811789dcf7a8e41188aa4

data/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+on:
+  push:
+    tags:
+      - 'v*'
+
+name: Build & release gem
+jobs:
+  release:
+    name: Build & release gem
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+      - run: bundle exec bin/release-check
+      - run: bundle exec bin/extract-changelog > release.md
+      - run: gem build lirc.gemspec
+      - uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          draft: false
+          prerelease: false
+          body_path: release.md
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p "$HOME/.gem"
+          printf -- "---\n:rubygems_api_key: $RUBYGEMS_API_KEY\n" > "$HOME/.gem/credentials"
+          chmod 0600 "$HOME/.gem/credentials"
+          gem push *.gem
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+---
+
+name: Run tests
+on:
+  - push
+  - pull_request
+
+jobs:
+  rspec:
+    name: RSpec
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - ruby-2.5
+          - ruby-2.6
+          - ruby-2.7
+        os:
+          - macos-latest
+          - ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec
+  test-build:
+    name: Test building the gem
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        ruby:
+          - ruby-2.5
+          - ruby-2.6
+          - ruby-2.7
+        os:
+          - macos-latest
+          - ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec gem build lirc.gemspec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+# rspec failure tracking
+.rspec_status

data/.mutant.yml

@@ -0,0 +1,5 @@
+integration: rspec
+includes:
+ - lib
+requires:
+  - lirc

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+#
+
+AllCops:
+  TargetRubyVersion: "2.4"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: trailing_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: trailing_comma
+
+Metrics/LineLength:
+  Max: 80

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.0] - 2021-01-17
+
+### Added
+- Finally got round to writing a changelog.
+- Released to rubygems.org
+- First version released to Github releases
+- 100% mutation coverage
+- Note: Versions prior to 0.3.0 were never tagged, built, nor released.
+
+### Changed
+- Correctly specified rubies supported for the first time.
+- Dropped support for Ruby 2.4
+
+### Fixed
+- Fixed issue where `LIRC::Messages::ResponseParser#parse_line` could return
+  `ArgumentError` instead of `ParseError` in rare circumstances.
+
+
+## [0.2.0] - 2020-ish [YANKED]
+
+### Added
+
+- `irsend` executable in `bin` dir, as an example for usage
+- `LIRC::Protocol`, including response parsing and command-sending.
+  `#send_command` returns an `EM::Deferrable` that succeeds/fails after the LIRC
+  server responds.
+
+
+## [0.1.0] - 2020-ish [YANKED]
+
+### Added
+
+- Sketch of project structure
+- Note: A 0.1.0 release was never made (nor a tag) - so it has been marked as
+  [YANKED] above.
+
+
+[0.3.0]: https://github.com/telyn/ruby-lirc/releases/v0.3.0

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+hey! Thanks for considering contributing. I'm happy to receive any issues you
+have, or even better any PRs for features you may want.
+
+For issues please try to describe as comprehensively as you can what you were
+doing / what you want to do so I can reproduce the bug or design in the feature
+you want. Even better if you could add in code snippets, and for bugs you're
+raising due to unexpected errors, please include the full error message and all
+backtrace :-)
+
+Some guidelines for PRs:
+
+Please use RuboCop. It doesn't have to be perfect, but do try to match the
+general style I've got going on.
+
+Tests are mandatory for any new stuff! Please fix any tests you break. If you
+break any tests inside a `describe "internals"` block, just change it to an
+`xdescribe` block.
+
+IMO the ResponseParser is only in charge of splitting the command, success &
+data sections of a response. If you're adding additional parsing (e.g. parsing a
+`LIST <remote>` response to get remote names) - that parser should be separate
+and called manually on the `Response`. I'm happy for `Response` to grow a
+`#parse` method which chooses the parser based on the command though :)
+
+Have fun!

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+source 'https://oss:N16UPtnejBEApoTDzs7SZsJyjsXSINhZ@gem.mutant.dev' do
+   gem 'mutant-license', require: false
+ end
+
+# Specify your gem's dependencies in lirc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    lirc (0.3.0)
+      eventmachine (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://oss:N16UPtnejBEApoTDzs7SZsJyjsXSINhZ@gem.mutant.dev/
+  specs:
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    eventmachine (1.2.7)
+    faker (2.15.1)
+      i18n (>= 1.6, < 2)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    fuubar (2.5.1)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mutant (0.10.26)
+      diff-lcs (~> 1.3)
+      parser (~> 3.0.0)
+      regexp_parser (~> 2.0, >= 2.0.3)
+      unparser (~> 0.6.0)
+    mutant-license (0.1.1.2.2047963385231461769331476801441011296942.1)
+    mutant-rspec (0.10.26)
+      mutant (= 0.10.26)
+      rspec-core (>= 3.8.0, < 4.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    thor (1.0.1)
+    unicode-display_width (2.0.0)
+    unparser (0.6.0)
+      diff-lcs (~> 1.3)
+      parser (>= 3.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.14)
+  fuubar (~> 2.5)
+  guard-rspec (~> 4.7)
+  lirc!
+  mutant-license!
+  mutant-rspec (~> 0.10.21)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.2)
+
+BUNDLED WITH
+   2.1.2

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Telyn Z.
+
+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,42 @@
+# Lirc
+
+I promise I'll write proper instructions on usage eventually, but for now I'm
+using it in
+[ps2bootlink](https://github.com/telyn/ps2client-rb/blob/master/bin/ps2bootlink)
+from my [ps2client-rb](https://github.com/telyn/ps2client-rb) repo - so take a
+look there for how I'm using it
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lirc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lirc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then 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/[USERNAME]/lirc.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lirc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/extract-changelog

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lirc"
+
+version_number = LIRC::VERSION.gsub('.', '\\.')
+
+state = :waiting_for_version
+File.open('CHANGELOG.md', 'r').each_line do |line|
+  case state
+  when :waiting_for_version
+    if line =~ /\A## \[(.+?)\]/
+      latest_version = Regexp.last_match[1]
+      if latest_version == LIRC::VERSION
+        puts line
+        state = :reading_changelog
+      else
+        raise "Expected latest version in changelog to be '#{LIRC::VERSION}', was '#{latest_version}'"
+      end
+    end
+  when :reading_changelog
+    if line =~ /\A## /
+      state = :done
+    else
+      puts line
+    end
+  end
+  break if state == :done
+end
+if state != :done
+  raise "Got to end of file in #{state} state?"
+end

data/bin/irsend

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "eventmachine"
+require "lirc/protocol"
+require "lirc/commands"
+
+server = ENV["LIRCD_SERVER"]
+port = ENV["LIRCD_PORT"].to_i || 8765
+if server.nil? || port == 0
+  puts "LIRCD_SERVER or LIRCD_PORT env var missing"
+end
+
+unless ARGV.size == 3
+  puts "Usage: irsend <remote> <button> <repeat count>"
+  exit 1
+end
+
+remote, button, repeats = ARGV[0,3]
+repeats = repeats.to_i
+
+command_to_send = LIRC::Commands::SendOnce.new(remote, button, repeats)
+
+exit_code = 0;
+
+class IRSendConn < EventMachine::Connection
+  include LIRC::Protocol
+
+  def initialize(command_to_send, *args)
+    @awaiting_response_for = command_to_send.serialize
+    super(*args)
+  end
+
+  def receive_message(message)
+    return unless message.is_a? LIRC::Messages::Response
+
+    if message.command == @awaiting_response_for
+      if message.success
+        puts "#{@awaiting_response_for.split(" ").first} succeeded!"
+        exit
+      else
+        puts "Command failed!"
+        exit(1)
+      end
+    else
+      puts "got an irrelevant message"
+      puts message.inspect
+    end
+  end
+
+  def exit(code = 0)
+    exit_code = code
+    EventMachine.stop
+  end
+end
+
+puts "attempting to connect to #{server}:#{port}"
+EventMachine.run do
+  EventMachine.connect(server, port, IRSendConn, command_to_send) do |connection|
+    connection.send_command(command_to_send)
+  end
+end
+
+exit(exit_code)

data/bin/release-check

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+tag = `git describe --tag`.chomp
+unless $?.success?
+  raise "git tag could not run - release check fails"
+end
+
+unless tag =~ /\Av([\d\.]+)\z/
+  raise "git tag (#{tag}) is not a valid version tag - release check fails"
+  exit 1
+end
+
+
+tag_version = Regexp.last_match[1]
+
+require "bundler/setup"
+unless tag_version.eql?(LIRC::VERSION)
+  raise "version from git tag (#{tag}) does not match LIRC::VERSION (#{LIRC::VERSION}) - release check fails"
+end
+
+puts "version from git tag (#{tag_version}) matches LIRC::VERSION"
+puts "release check succeeds - proceed with building gem"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/faker/lirc.rb

@@ -0,0 +1,52 @@
+module Faker
+  # LIRC-related faker stuff
+  class LIRC < Base
+    class << self
+      ##
+      # Produces a random LIRC response type
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::LIRC.button_name #=> "KEY_GREEN"
+      def button_name
+        fetch('lirc.button_name')
+      end
+
+      ##
+      # Produces a random LIRC response type
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::LIRC.remote_name #=> "RMT-V189-KARAOKE"
+      def remote_name
+        fetch('lirc.remote_name')
+      end
+
+      ##
+      # Produces a random LIRC response type
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::LIRC.reply_type #=> "SEND_ONCE"
+      def reply_type
+        fetch('lirc.reply_type')
+      end
+
+      ##
+      # Produces a random LIRC response success
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::LIRC.reply_type #=> "SUCCESS"
+      def reply_success
+        fetch('lirc.reply_success')
+      end
+    end
+  end
+end
+
+I18n.load_path += ::Dir[::File.join(__dir__, '*.yml')]

data/lib/faker/lirc.yml

@@ -0,0 +1,103 @@
+en:
+  faker:
+    lirc:
+      reply_success:
+        - SUCCESS
+        - ERROR
+      reply_type:
+        - SEND_ONCE
+        - SEND_START
+        - SEND_STOP
+        - LIST
+        - SET_INPUTLOG
+        - DRV_OPTION
+        - SIMULATE
+        - SET_TRANSMITTERS
+        - VERSION
+      button_name:
+        - KEY_POWER
+        - KEY_BACK
+        - KEY_MENU
+        - KEY_LEFT
+        - KEY_RIGHT
+        - KEY_UP
+        - KEY_DOWN
+        - KEY_OK
+        - KEY_F11
+        - KEY_SEARCH
+        - KEY_GREEN
+        - KEY_BLUE
+        - KEY_YELLOW
+        - X_KEY_ORANGE
+        - X_KEY_PURPLE
+        - KEY_PLAY
+        - KEY_VOLUMEUP
+        - KEY_VOLUMEDOWN
+        - KEY_HOME
+      remote_name:
+        - SONY-TV
+        - Sharp
+        - RMT-V189-KARAOKE
+        - nVidia_UR88A
+        - CDP-790
+        - ComPro_VideoMate-K300
+        - Panasonic_VSQS1480
+        - Motorola_IRC442-2
+        - Akai_RC-C79
+        - Viewsonic_N3200w
+        - rm
+        - Cambridge_Audio_RC-340AC/540AC/640AC_RC5
+        - Daas_Color_RCS_9085
+        - RC2000
+        - Robot_Kit
+        - ONKYO_RC-50
+        - MAXY1708
+        - Tevion_MD81302
+        - Toshiba_RM-614Q
+        - Elite_9361-3EL
+        - DM_7000
+        - Xoro_DVB_210_T
+        - RT111_101
+        - Foxtel_Digital_Cable_STB
+        - SHARP_G1014BMSA
+        - Schneider_RC-193
+        - DLink_DSM-10
+        - Tivo_S2_VOL
+        - Toshiba_SE-R0031
+        - Onkyo_RC-146T
+        - rc-c003
+        - iMON-PAD
+        - Asus_RC1974502_00
+        - RM-SE7AV
+        - SVEN_HT-475
+        - Kaon_KTF-100CO
+        - Philips_PM335_0324
+        - VI77760
+        - RC-6051
+        - RMT-D157P-VOL-BUTTONS
+        - rm-d29m
+        - Samsung_SV-411X
+        - YAMAHA_VM70300
+        - RM-RXUA4
+        - TV
+        - vcr
+        - Sony_RM-SV236_12
+        - Lenco
+        - Samsung_BN59-00869A
+        - RP_35
+        - Kenwood_RC-R0614
+        - NokiaVC620
+        - HUMAX
+        - SkyDigital
+        - Sony_RMT-V501A
+        - toshiba
+        - Sony_RMT-V181N
+        - Sony-RMT-256A-VCR
+        - Now_Broadband_TV
+        - DAV-309
+        - EUR643804
+        - Hauppauge_MVP
+        - universum-0000
+        - JVC_RM-RK60
+        - DAT
+        - RMT2

data/lib/lirc/commands.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module LIRC
+  module Commands
+    def self.all_commands
+      constants.keep_if do |x|
+        const_get(x).instance_of?(Class)
+      end.map(&public_method(:serialize_command_name))
+    end
+
+    def self.serialize_command_name(klass)
+      klass = klass.to_s.split(":").fetch(-1)
+      rest = klass[1..-1].gsub(/[A-Z]/) do |chr|
+        "_#{chr}"
+      end
+      "#{klass[0]}#{rest.upcase}"
+    end
+
+    module Base
+      def serialize
+        return serialize_type unless respond_to?(:members)
+
+        "#{serialize_type} #{serialize_args}"
+      end
+
+      private
+
+      def serialize_type
+        Commands.serialize_command_name(self.class)
+      end
+
+      def serialize_args
+        members.map(&public_method(:send)).compact.join(" ")
+      end
+    end
+
+    SendOnce = Struct.new(:remote, :button, :repeats) { include Base }
+    SendStart = Struct.new(:remote, :button) { include Base }
+    SendStop = Struct.new(:remote, :button) { include Base }
+    List = Struct.new(:remote) { include Base }
+    SetInputlog = Struct.new(:path) { include Base }
+    DrvOption = Struct.new(:key, :value) { include Base }
+    Simulate = Struct.new(:key, :data) { include Base }
+    SetTransmitters = Struct.new(:transmitter, :mask) { include Base }
+    Version = Class.new { include Base }
+  end
+end

data/lib/lirc/messages/response_parser.rb

@@ -0,0 +1,130 @@
+require "lirc/messages"
+require "lirc/commands"
+
+module LIRC
+  module Messages
+    class ResponseParser
+      STATES = %i[waiting_begin
+                  waiting_command
+                  waiting_success
+                  waiting_data
+                  waiting_data_length
+                  reading_data
+                  valid].freeze
+
+      PARSER_METHOD_FOR = {
+        waiting_begin: :parse_begin,
+        waiting_command: :parse_command,
+        waiting_success: :parse_success,
+        waiting_data: :parse_data,
+        waiting_data_length: :parse_data_length,
+        reading_data: :read_data,
+        waiting_end: :parse_end,
+        valid: :raise_already_valid,
+      }.freeze
+
+      attr_reader :message
+
+      def initialize(state = :waiting_begin)
+        @state = state
+        @message = Response.new
+      end
+
+      # returns true when #message is ready
+      def valid?
+        @state.equal?(:valid)
+      end
+
+      def parse_line(line)
+        line = line.chomp
+
+        __send__(PARSER_METHOD_FOR.fetch(@state), line)
+      end
+
+      private
+
+      def parse_begin(line)
+        unless line.eql?("BEGIN")
+          raise ParseError, "unexpected line, expecting BEGIN, got #{line}"
+        end
+
+        @state = :waiting_command
+      end
+
+      def parse_command(line)
+        if Commands.all_commands.include?(line.split.first)
+          message.command = line
+          @state = :waiting_success
+        elsif line.eql?("SIGHUP")
+          message.command = line
+          @state = :waiting_end
+        else
+          raise ParseError,
+            "invalid command #{line}, expecting first word to be one of " \
+            "LIRC::Commands.all_commands, or SIGHUP"
+        end
+      end
+
+      def parse_success(line)
+        unless %w[SUCCESS ERROR].include?(line)
+          raise ParseError, "Expecting SUCCESS or ERROR, got #{line}"
+        end
+
+        message.success = line.eql?("SUCCESS")
+        @state = :waiting_data
+      end
+
+      def parse_data(line)
+        case line
+        when "DATA"
+          @state = :waiting_data_length
+        when "END"
+          @state = :valid
+        else
+          raise ParseError, "Expecting DATA or END, got #{line}"
+        end
+      end
+
+      def parse_data_length(line)
+        if line =~ /[^0-9]/
+          raise ParseError, "Expecting a number, got #{line}"
+        end
+
+        @data_lines_to_read = Integer(line)
+        message.data = []
+        @state = :reading_data
+      end
+
+      def parse_end(line)
+        unless line.eql?("END")
+          raise ParseError, "Expecting END, got #{line}"
+        end
+
+        @state = :valid
+      end
+
+      def read_data(line)
+        if @data_lines_to_read.zero?
+          unless line.eql?("END")
+            raise ParseError, "Expecting END, got more data: '#{line}'"
+          end
+
+          message.data = message.data&.join("\n").freeze
+          @state = :valid
+          return
+        end
+
+        message.data ||= []
+
+        @data_lines_to_read -= 1
+        message.data << line
+      end
+
+      def raise_already_valid(line)
+        raise ParseError,
+          "Response was successfully parsed, " \
+          "but #parse was called again with #{line}"
+      end
+    end
+  end
+end

data/lib/lirc/messages.rb

@@ -0,0 +1,43 @@
+module LIRC
+  # LIRC has three kinds of messages.
+  #
+  # ButtonPresses are sent by LIRCD to a LIRC client - these notify the client
+  #   that LIRCD has received an IR button press from some remote.
+  #
+  # Commands are sent by a LIRC client to LIRCD to get it to do something (e.g.
+  #   transmit an IR button press, or send back a Response containing a list of
+  #   remotes it supports)
+  #
+  # Responses are sent by LIRCD to a LIRC client - usually in response to a
+  #   Command (hence the name), but there is a special type - SIGHUP - which is
+  #   sent whenever the LIRCD process receives a SIGHUP
+  #
+  # To make life easier (if not the conceptual model of this library) - the
+  # Messages module deals with ButtonPresses and Responses (things received from
+  # LIRCD), but Commands live in their own LIRC::Commands module
+  module Messages
+    class ParseError < StandardError; end
+
+    # Responses are received over the socket in response to Commands
+    Response = Struct.new(:command, :success, :data)
+
+    # code is the hex code sent by the remote
+    # button is the name of the button (if found in lircd.conf)
+    # remote is the name of the remote (if found)
+    ButtonPress = Struct.new(:code, :repeat_count, :button, :remote) do
+      def self.parse(line)
+        bits = line.split(" ")
+        if bits[0] =~ /[^0-9a-fA-F]/ || bits[1] =~ /[^0-9]/
+          raise ParseError, "invalid button press message '#{line}'"
+        end
+
+        # convert hex chars to an integer
+        bits[0] = bits[0].to_i(16)
+        bits[1] = bits[1].to_i
+        new(*bits)
+      end
+    end
+  end
+end
+
+require "lirc/messages/response_parser"

data/lib/lirc/protocol.rb

@@ -0,0 +1,74 @@
+require "lirc/messages/response_parser"
+require "logger"
+require "eventmachine"
+
+module LIRC
+  DEFAULT_PORT = 8765
+  # EventMachine Protocol for LIRC.
+  #
+  # Internally relies on Messages for parsing.
+  # Can send Commands to LIRC with send_command.
+  module Protocol
+    include EventMachine::Protocols::LineProtocol
+
+    def self.connect!(server:, port: DEFAULT_PORT, &block)
+      EventMachine.connect(server, port, self, &block)
+    end
+
+    def initialize(*args, logger: Logger.new(STDERR), **kwargs)
+      @logger = logger
+
+      super(*args, **kwargs)
+    end
+
+    def send_command(command)
+      send_data "#{command.serialize}\n"
+      response_deferrables[command.serialize] ||= EM::DefaultDeferrable.new
+    end
+
+    def receive_line(line)
+      line = line.chomp
+      if @response_parser
+        parse_message_line(line)
+      elsif line.eql?("BEGIN")
+        parse_message_line(line)
+      elsif line =~ /^[0-9a-f]/
+        receive_message(Messages::ButtonPress.parse(line))
+      else
+        logger.warn "Received unknown line from lirc: #{line}"
+      end
+    end
+
+    private
+
+    def parse_message_line(line)
+      @response_parser ||= Messages::ResponseParser.new
+      @response_parser.parse_line(line)
+      if @response_parser.valid?
+        msg = @response_parser.message
+        resolve_response(msg)
+        receive_message(msg) if respond_to?(:receive_message)
+        @response_parser = nil
+      end
+    end
+
+    # resolve here means like Promises - Deferrables are pretty much promises
+    def resolve_response(response)
+      deferrable = response_deferrables[response.command]
+      return if deferrable.nil?
+
+      if response.success
+        deferrable.succeed(response)
+      else
+        deferrable.fail(response)
+      end
+      response_deferrables.delete(response.command)
+    end
+
+    def response_deferrables
+      @response_deferrables ||= {}
+    end
+
+    attr_reader :logger
+  end
+end

data/lib/lirc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LIRC
+  VERSION = "0.3.0"
+end

data/lib/lirc.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "lirc/version"
+require "lirc/protocol"
+require "lirc/commands"
+
+module LIRC
+  # Your code goes here...
+end

data/lirc.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/lirc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lirc"
+  spec.version       = LIRC::VERSION
+  spec.authors       = ["Telyn Z."]
+  spec.email         = ["175827+telyn@users.noreply.github.com"]
+
+  spec.summary       = "lirc client library (focused on sending ir signals"
+  spec.homepage      = "https://github.com/telyn/ruby-lirc"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CONTRIBUTING.md"
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["source_code_uri"] = "https://github.com/telyn/ruby-lirc"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "eventmachine", "~> 1.2"
+
+  spec.add_development_dependency "faker", "~> 2.14"
+  spec.add_development_dependency "fuubar", "~> 2.5"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "mutant-rspec", "~> 0.10.21"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.2"
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: lirc
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Telyn Z.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.21
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- 175827+telyn@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".mutant.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/extract-changelog
+- bin/irsend
+- bin/release-check
+- bin/setup
+- lib/faker/lirc.rb
+- lib/faker/lirc.yml
+- lib/lirc.rb
+- lib/lirc/commands.rb
+- lib/lirc/messages.rb
+- lib/lirc/messages/response_parser.rb
+- lib/lirc/protocol.rb
+- lib/lirc/version.rb
+- lirc.gemspec
+homepage: https://github.com/telyn/ruby-lirc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/telyn/ruby-lirc
+  changelog_uri: https://github.com/telyn/ruby-lirc/blob/master/CONTRIBUTING.md
+  bug_tracker_uri: https://github.com/telyn/ruby-lirc/issues
+  source_code_uri: https://github.com/telyn/ruby-lirc
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: lirc client library (focused on sending ir signals
+test_files: []