awtrix_control 0.0.1

data/lib/spec/awtrix_control/device_spec.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe AwtrixControl::Device do
+  before do
+    @device = AwtrixControl::Device.new(DEFAULT_HOST)
+  end
+
+  describe '#initialize' do
+    it 'initializes instance variables' do
+      expect(@device.host).to eq(DEFAULT_HOST)
+      expect(@device.apps).to eq({})
+    end
+  end
+
+  describe '#<<' do
+    it 'adds an app instance to the device' do
+      app = AwtrixControl::App.new(:test_app)
+      @device << app
+      actual = @device.apps[:test_app]
+      expect(actual).to eq(app)
+      expect(app.device).to eq(@device)
+    end
+  end
+
+  describe '#[]' do
+    it 'returns an app instance' do
+      @device.new_app(:test_app)
+      app = @device[:test_app]
+      expect(app.name).to eq(:test_app)
+    end
+
+    it 'returns nil if the app does not exist' do
+      app = @device[:test_app]
+      expect(app).to be_nil
+    end
+  end
+
+  describe '#effects' do
+    it 'makes a call to the effects endpoint of the device' do
+      actual = JSON.parse(@device.effects)
+      expect(actual.first).to eq('Fade')
+      expect_request(method: :get, path: 'effects')
+    end
+  end
+
+  describe '#indicator' do
+    it 'renders a white indicator by default' do
+      @device.indicator(:top)
+      expect_request(method: :post, path: 'indicator1', body: { color: '#ffffff' })
+    end
+
+    it 'tells the device to show a given indicator in a given color' do
+      @device.indicator(:bottom, '#00FF00')
+      expect_request(method: :post, path: 'indicator3', body: { color: '#00FF00' })
+    end
+
+    it 'works with shorthand color symbols' do
+      @device.indicator(:top, :red)
+      expect_request(method: :post, path: 'indicator1', body: { color: '#ff0000' })
+    end
+  end
+
+  context 'with effects' do
+    it 'renders a blinking indicator' do
+      @device.indicator(:center, :red, effect: :blink)
+      expect_request(method: :post, path: 'indicator2', body: { color: '#ff0000', blink: 500 })
+    end
+
+    it 'renders a pulsing indicator' do
+      @device.indicator(:center, :red, effect: :pulse)
+      expect_request(method: :post, path: 'indicator2', body: { color: '#ff0000', fade: 2000 })
+    end
+
+    it 'renders a blinking indicator with a custom frequency' do
+      @device.indicator(:center, :red, effect: :blink, frequency: 1000)
+      expect_request(method: :post, path: 'indicator2', body: { color: '#ff0000', blink: 1000 })
+    end
+
+    it 'renders a pulsing indicator with a custom frequency' do
+      @device.indicator(:center, :red, effect: :pulse, frequency: 5000)
+      expect_request(method: :post, path: 'indicator2', body: { color: '#ff0000', fade: 5000 })
+    end
+  end
+
+  describe '#loop' do
+    it 'makes a call to the loop endpoint of the device' do
+      actual = @device.loop
+      expect(actual).to eq({ "Hello" => 1, "Time" => 0, "World" => 2 })
+      expect_request(method: :get, path: 'loop')
+    end
+  end
+
+  describe '#new_app' do
+    it 'instantiates a new app and adds it to the device' do
+      @device.new_app('test_app')
+      actual = @device.apps['test_app']
+      expect(actual.name).to eq('test_app')
+      expect(actual.payload).to eq(AwtrixControl::App.new('test_app').default_payload)
+    end
+
+    it 'overwrites an existing app' do
+      @device.new_app('test_app')
+      second_app = @device.new_app('test_app')
+      actual = @device.apps['test_app']
+      expect(actual).to eq(second_app)
+    end
+  end
+
+  describe '#notify' do
+    it 'makes a call to the notify endpoint of the device' do
+      @device.notify('test_notification', color: :red)
+      expect_request(method: :post, path: 'notify', body: { text: 'test_notification', color: "#ff0000" })
+    end
+  end
+
+  describe '#power' do
+    it 'makes a call to the power endpoint of the device' do
+      @device.power(true)
+      expect_request(method: :post, path: 'power', body: { power: true })
+    end
+  end
+
+  describe '#remove_indicator' do
+    it 'removes an indicator from the device' do
+      @device.remove_indicator(:top)
+      expect_request(method: :post, path: 'indicator1', body: { color: '#000000' })
+    end
+  end
+
+  describe '#remove_indicators' do
+    it 'removes all indicators from the device' do
+      @device.remove_indicators
+      expect_request(method: :post, path: 'indicator1', body: { color: '#000000' })
+      expect_request(method: :post, path: 'indicator2', body: { color: '#000000' })
+      expect_request(method: :post, path: 'indicator3', body: { color: '#000000' })
+    end
+  end
+
+  describe '#reset' do
+    it 'makes the device sleep for 1 second' do
+      @device.reset
+      expect_request(method: :post, path: 'sleep', body: { sleep: 1 })
+    end
+  end
+
+  describe '#rtttl' do
+    it 'makes a call to the rtttl endpoint of the device' do
+      @device.rtttl('test_rtttl')
+      expect_request(method: :post, path: 'rtttl', body: '"test_rtttl"')
+    end
+  end
+
+  describe '#screen' do
+    it 'makes a call to the screen endpoint of the device' do
+      actual = JSON.parse(@device.screen)
+      expect(actual).to start_with(0, 0, 0, 0, 0)
+      expect_request(method: :get, path: 'screen')
+    end
+  end
+
+  describe '#sleep' do
+    it 'makes the device sleep for a number of seconds' do
+      @device.sleep(5)
+      expect_request(method: :post, path: 'sleep', body: { sleep: 5 })
+    end
+
+    it 'makes the device sleep indefinitely when no seconds are provided' do
+      @device.sleep
+      expect_request(method: :post, path: 'sleep', body: {})
+    end
+  end
+
+  describe '#sound' do
+    it 'makes a call to the sound endpoint of the device' do
+      @device.sound('test_sound')
+      expect_request(method: :post, path: 'sound', body: { sound: 'test_sound' })
+    end
+  end
+
+  describe '#stats' do
+    it 'makes a call to the status endpoint of the device' do
+      actual = JSON.parse(@device.stats)["version"]
+      expect(actual).to eq('0.96')
+      expect_request(method: :get, path: 'stats')
+    end
+  end
+
+  describe '#transitions' do
+    it 'makes a call to the transitions endpoint of the device' do
+      actual = JSON.parse(@device.transitions).first
+      expect(actual).to eq('Random')
+      expect_request(method: :get, path: 'transitions')
+    end
+  end
+
+  describe '#delete_app' do
+    it 'deletes an app by name' do
+      app = AwtrixControl::App.new('test_app')
+      @device << app
+      @device.delete_app('test_app')
+      expect(@device.apps).to eq({})
+      expect_request(method: :post, path: 'custom?name=test_app', body: {})
+    end
+  end
+
+  describe '#delete_all_apps' do
+    it 'deletes all apps from the device and device, even if they do not match' do
+      app1 = AwtrixControl::App.new('test_app1')
+      @device << app1
+      @device.delete_all_apps
+      expect_request(method: :get, path: 'loop')
+      # The loop endpoint is mocked with the following apps:
+      expect_request(method: :post, path: 'custom?name=Time')
+      expect_request(method: :post, path: 'custom?name=Hello')
+      expect_request(method: :post, path: 'custom?name=World')
+      expect(@device.apps).to eq({})
+    end
+  end
+
+  def expect_request(method:, path:, host: DEFAULT_HOST, body: {})
+    expect(WebMock)
+      .to have_requested(method, "http://#{host}/api/#{path}")
+            .with(body: body)
+  end
+
+  describe '#push_app' do
+    it 'pushes an app to the device by name' do
+      app = @device.new_app(:test_app)
+      @device.push_app(:test_app)
+      expect_request(method: :post,
+                     path: 'custom?name=test_app',
+                     body: { "name": "test_app" }.merge(app.default_payload))
+
+    end
+
+    it 'does not push apps from other devices' do
+      other_device = AwtrixControl::Device.new('192.168.0.2')
+      app = other_device.new_app(:test_app)
+        @device.push_app(:test_app)
+
+      expect(WebMock).not_to have_requested(:post, "http://#{DEFAULT_HOST}/api/custom")
+    end
+  end
+end

data/lib/spec/awtrix_control_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'AwtrixControl' do
+end

data/lib/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'awtrix_control'
+require 'webmock/rspec'
+
+# Disable external requests
+WebMock.disable_net_connect!(allow_localhost: true)
+
+DEFAULT_HOST = '1.1.1.1'
+
+# Global stubs
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:get, %r{http://#{DEFAULT_HOST}/api/.*})
+      .to_return do |request|
+      path = request.uri.path.split('/').last
+      file_path = File.join('spec', 'fixtures', "get_#{path}.json")
+      {
+        status: 200,
+        body: File.read(file_path),
+        headers: { 'Content-Type' => 'application/json' }
+      }
+    end
+
+    stub_request(:post, %r{http://#{DEFAULT_HOST}/api/.*})
+      .to_return(
+        status: 200,
+        body: "OK",
+        headers: { 'Content-Type' => 'application/json' }
+      )
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: awtrix_control
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Francois Gaspard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-26 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: A gem to control AWTRIX 3 devices from Ruby
+email:
+- fr@ncois.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/awtrix_control.rb
+- lib/awtrix_control/app.rb
+- lib/awtrix_control/device.rb
+- lib/awtrix_control/request.rb
+- lib/spec/awtrix_control/app_spec.rb
+- lib/spec/awtrix_control/device_spec.rb
+- lib/spec/awtrix_control_spec.rb
+- lib/spec/spec_helper.rb
+homepage: https://github.com/Francois-gaspard/awtrix
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: Control AWTRIX 3 devices
+test_files: []