animatedledstrip-client 0.6.1 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fca5e042206c2c7fe45a3ea6c83b1345d88b34d54d5fee12a6177ceb8dc2d0d4
-  data.tar.gz: e0f5367687ab1291b2ef73d7423179099d06ca54e320ca450eb1d7cd1a42b087
+  metadata.gz: 44ee0ca8508dde26832002725e9eccbb80c7ea92cdfbd7b22570f5a8d46795a0
+  data.tar.gz: 0c21f44b090c5f014d0560f06ed780cc5b5d284505e32e20019cdb6ef97ac1c8
 SHA512:
-  metadata.gz: e6373bbf682ee21597645bd5307be3d7ed42e8089c49bc5f73318e9b458af7362568b8b904bfbeb6204a8205df6e75452e12b85ebf90d15a98c815b880333bcf
-  data.tar.gz: 6484a4a776ae1968b9073a1b8f4edd14e09ea1fc9b15afc533ce82da69d14fe57e93d589ea7e5531aa93e1abf69b37ee059fe7f4bc75f81c474ef96446197484
+  metadata.gz: 806c8e33820e5d8d3da6275b5afb607437234cc90682c1e47ded9c8a8bd33ef36c8c7a503deb00343459dc27f285cd8fd5471570b360c18fc6d4d618611da620
+  data.tar.gz: 2dc111d24506f56d5f1612b64319f92e758f108ac507f0bd39882f7ccebe71402dc72e4d3242dbc2d4dd38a99725607e4edcde0a59a2e31b1bb9b364443069ee

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,35 @@
+---
+language: ruby
+
+rvm:
+  - 2.6.6
+
+before_install:
+  - gem update --system
+  - gem install bundler --no-document
+
+branches:
+  only:
+    - master
+    - /^travis.*/
+    - /^v.*/
+
+stages:
+  - name: test
+  - name: deploy
+    if: tag IS present
+
+jobs:
+  include:
+    - stage: test
+      script: bundle exec rake
+
+    - stage: deploy
+      install: skip
+      script: skip
+      deploy:
+        - provider: rubygems
+          api_key: $RUBYGEMS_KEY
+          gem: animatedledstrip-client
+          on:
+            all_branches: true

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gemspec
+gem "codecov", :require => false, :group => :test

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-2020 AnimatedLEDStrip
+
+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,101 @@
+# AnimatedLEDStrip Client Library for Ruby
+
+[![Build Status](https://travis-ci.com/AnimatedLEDStrip/client-ruby.svg?branch=master)](https://travis-ci.com/AnimatedLEDStrip/client-ruby)
+[![Gem Version](https://badge.fury.io/rb/animatedledstrip-client.svg)](https://badge.fury.io/rb/animatedledstrip-client)
+[![codecov](https://codecov.io/gh/AnimatedLEDStrip/client-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/AnimatedLEDStrip/client-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'animatedledstrip-client'
+```
+
+Or install with:
+
+    $ gem install animatedledstrip-client
+
+## Creating an `AnimationSender`
+An `AnimationSender` is constructed with two arguments:
+- `host`: The IP address of the server (as a string)
+- `port`: The port that the client should connect to (as an integer)
+
+```ruby
+sender = AnimationSender.new("10.0.0.254", 5);
+```
+
+## Starting the `AnimationSender`
+An `AnimationSender` is started by calling the `start()` method on the instance.
+
+```ruby
+sender.start
+```
+
+## Stopping the `AnimationSender`
+To stop the `AnimationSender`, call its `end()` method.
+
+```ruby
+sender.end
+```
+
+## Sending Data
+
+### AnimationData
+An animation can be sent to the server by creating an `AnimationData` instance, then calling `send_animation` with the instance as the argument.
+
+```ruby
+cc = ColorContainer.new
+cc.add_color 0xFF
+cc.add_color 0xFF00
+
+data = AnimationData.new
+data.add_color cc
+
+sender.send_animation data
+```
+
+### EndAnimation
+The end of an animation can be sent to the server by creating an `EndAnimation` instance, then calling `send_end_animation` with the instance as the argument.
+
+```ruby
+end_anim = EndAnimation.new
+end_anim.id = "ANIM_ID"
+
+sender.send_end_animation end_anim
+```
+
+### Section
+A new section can be sent to the server by creating a `Section` instance, then calling `send_section` with the instance as the argument.
+Note that changing `num_leds` or `physical_start` will have no effect on the new section.
+
+```ruby
+sect = Section.new
+sect.name = "SECTION"
+sect.start_pixel = 5
+sect.end_pixel = 30
+
+sender.send_section sect
+```
+
+#### `AnimationData` type notes
+The Ruby library uses the following values for `continuous` and `direction`:
+- `continuous`: `nil`, `true`, `false`
+- `direction`: `Direction::FORWARD`, `Direction::BACKWARD`
+
+## Receiving Data
+
+### Supported Animations
+Supported animations are stored in the sender's `supported_animations` hash.
+
+### Running Animations
+Running animations are stored in the sender's `running_animations` hash.
+
+### Ending Animations
+Animations are removed from the sender's `running_animations` hash.
+
+### New Section
+Sections are stored in the sender's `sections` hash.
+
+### Strip Info
+The strip's info is stored in the sender's `strip_info` attribute.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/animatedledstrip-client.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "animatedledstrip-client"
+  spec.version       = "0.7"
+  spec.authors       = ["Max Narvaez"]
+  spec.email         = ["mnmax.narvaez3@gmail.com"]
+
+  spec.summary       = "Library for connecting to an AnimatedLEDStripServer"
+  spec.homepage      = "https://github.com/AnimatedLEDStrip/client-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "simplecov"
+  spec.add_runtime_dependency "url"
+
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/{animation_data.rb → animatedledstrip/animation_data.rb}

@@ -18,18 +18,18 @@
 #   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #   THE SOFTWARE.
 
-require_relative 'animation'
-require_relative 'direction'
-require_relative 'color_container'
+require_relative "direction"
+require_relative "color_container"
 
+#noinspection RubyTooManyInstanceVariablesInspection
 class AnimationData
   attr_accessor :animation, :colors, :center,
                 :continuous, :delay, :delay_mod,
-                :direction, :distance, :end_pixel,
-                :id, :spacing, :start_pixel
+                :direction, :distance, :id,
+                :section, :spacing
 
   def initialize
-    @animation = Animation::COLOR
+    @animation = "Color"
     @colors = []
     @center = -1
     @continuous = nil
@@ -37,10 +37,9 @@ class AnimationData
     @delay_mod = 1.0
     @direction = Direction::FORWARD
     @distance = -1
-    @end_pixel = -1
-    @id = ''
+    @id = ""
+    @section = ""
     @spacing = -1
-    @start_pixel = 0
   end
 
   def add_color(color)
@@ -51,7 +50,7 @@ class AnimationData
 
   # @return [String]
   def json
-    raise TypeError unless @animation.is_a? Integer
+    raise TypeError unless @animation.is_a? String
     raise TypeError unless @colors.is_a? Array
     raise TypeError unless @center.is_a? Integer
     unless @continuous.is_a?(TrueClass) || @continuous.is_a?(FalseClass) || @continuous.nil?
@@ -61,27 +60,44 @@ class AnimationData
     raise TypeError unless @delay_mod.is_a? Float
     raise TypeError unless @direction.is_a? Integer
     raise TypeError unless @distance.is_a? Integer
-    raise TypeError unless @end_pixel.is_a? Integer
     raise TypeError unless @id.is_a? String
+    raise TypeError unless @section.is_a? String
     raise TypeError unless @spacing.is_a? Integer
-    raise TypeError unless @start_pixel.is_a? Integer
 
     @colors.each { |cc| raise TypeError unless cc.is_a? ColorContainer }
 
-    str = "DATA:{\"animation\":\"#{Animation.string(@animation)}\","\
+    str = "DATA:{\"animation\":\"#{@animation}\","\
     '"colors":['
     @colors.each { |cc| str += "#{cc.json}," }
     str.delete_suffix! ','
-    str + '],'\
+    str += '],'\
     "\"center\":#{@center},"\
     "\"continuous\":#{@continuous.nil? ? 'null' : @continuous},"\
     "\"delay\":#{@delay},"\
     "\"delayMod\":#{delay_mod},"\
     "\"direction\":\"#{Direction.string(@direction)}\","\
     "\"distance\":#{@distance},"\
-    "\"endPixel\":#{@end_pixel},"\
     "\"id\":\"#{@id}\","\
-    "\"spacing\":#{@spacing},"\
-    "\"startPixel\":#{@start_pixel}}"
+    "\"section\":\"#{section}\","\
+    "\"spacing\":#{@spacing}}"
+
+    str
+  end
+
+  def self.new_from_json(json_data)
+    data = AnimationData.new
+    data.animation = json_data["animation"] unless json_data["animation"].nil?
+    json_data["colors"].each { |cc| data.add_color(ColorContainer.new_from_json cc) }
+    data.center = json_data["center"] unless json_data["center"].nil?
+    data.continuous = json_data["continuous"]
+    data.delay = json_data["delay"] unless json_data["delay"].nil?
+    data.delay_mod = json_data["delayMod"] unless json_data["delayMod"].nil?
+    data.direction = Direction::from_string(json_data["direction"]) unless json_data["direction"].nil?
+    data.distance = json_data["distance"] unless json_data["distance"].nil?
+    data.id = json_data["id"] unless json_data["id"].nil?
+    data.section = json_data["section"] unless json_data["section"].nil?
+    data.spacing = json_data["spacing"] unless json_data["spacing"].nil?
+
+    data
   end
 end

data/lib/animatedledstrip/animation_info.rb

@@ -0,0 +1,71 @@
+#   Copyright (c) 2019-2020 AnimatedLEDStrip
+#
+#   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.
+
+require_relative 'param_usage'
+
+#noinspection RubyTooManyInstanceVariablesInspection
+class AnimationInfo
+  attr_accessor :name, :abbr, :description,
+                :signature_file, :repetitive,
+                :minimum_colors, :unlimited_colors,
+                :center, :delay, :direction,
+                :distance, :spacing, :delay_default,
+                :distance_default, :spacing_default
+
+  def initialize
+    @name = ""
+    @abbr = ""
+    @description = ""
+    @signature_file = ""
+    @repetitive = false
+    @minimum_colors = 0
+    @unlimited_colors = false
+    @center = ParamUsage::NOTUSED
+    @delay = ParamUsage::NOTUSED
+    @direction = ParamUsage::NOTUSED
+    @distance = ParamUsage::NOTUSED
+    @spacing = ParamUsage::NOTUSED
+    @delay_default = 50
+    @distance_default = -1
+    @spacing_default = 3
+  end
+
+  def self.new_from_json(json_data)
+    info = AnimationInfo.new
+    info.name = json_data["name"] unless json_data["name"].nil?
+    info.abbr = json_data["abbr"] unless json_data["abbr"].nil?
+    info.description = json_data["description"] unless json_data["description"].nil?
+    info.signature_file = json_data["signatureFile"] unless json_data["signatureFile"].nil?
+    info.repetitive = json_data["repetitive"] unless json_data["repetitive"].nil?
+    info.minimum_colors = json_data["minimumColors"] unless json_data["minimumColors"].nil?
+    info.unlimited_colors = json_data["unlimitedColors"] unless json_data["unlimitedColors"].nil?
+    info.center = ParamUsage::from_string(json_data["center"]) unless json_data["center"].nil?
+    info.delay = ParamUsage::from_string(json_data["delay"]) unless json_data["delay"].nil?
+    info.direction = ParamUsage::from_string(json_data["direction"]) unless json_data["direction"].nil?
+    info.distance = ParamUsage::from_string(json_data["distance"]) unless json_data["distance"].nil?
+    info.spacing = ParamUsage::from_string(json_data["spacing"]) unless json_data["spacing"].nil?
+    info.delay_default = json_data["delayDefault"] unless json_data["delayDefault"].nil?
+    info.distance_default = json_data["distanceDefault"] unless json_data["distanceDefault"].nil?
+    info.spacing_default = json_data["spacingDefault"] unless json_data["spacingDefault"].nil?
+
+    info
+  end
+
+end

data/lib/animatedledstrip/animation_sender.rb

@@ -0,0 +1,104 @@
+#   Copyright (c) 2019-2020 AnimatedLEDStrip
+#
+#   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.
+
+require "json"
+require "socket"
+require_relative "animation_data"
+require_relative "animation_info"
+require_relative "end_animation"
+require_relative "section"
+require_relative "strip_info"
+
+class AnimationSender
+  attr_accessor :address, :port, :strip_info,
+                :running_animations, :supported_animations,
+                :sections
+
+  def initialize(address, port)
+    @address = address
+    @port = port
+    @running_animations = {}
+    @supported_animations = {}
+    @sections = {}
+  end
+
+  def start
+    @socket = TCPSocket.new @address, @port
+    @receive_thread = Thread.new {
+      begin
+        while (line = @socket.gets ";;;")
+          puts line
+          if line.start_with? "DATA:"
+            json = JSON.parse (line.delete_prefix "DATA:").delete_suffix(";;;")
+            data = AnimationData::new_from_json json
+            @running_animations[data.id] = data
+          elsif line.start_with? "AINF:"
+            json = JSON.parse (line.delete_prefix "AINF:").delete_suffix(";;;")
+            info = AnimationInfo.new_from_json json
+            @supported_animations[info.name] = info
+          elsif line.start_with? "END :"
+            json = JSON.parse (line.delete_prefix "END :").delete_suffix(";;;")
+            anim = EndAnimation.new_from_json json
+            @running_animations.delete anim.id
+          elsif line.start_with? "SECT:"
+            json = JSON.parse (line.delete_prefix "SECT:").delete_suffix(";;;")
+            sect = Section.new_from_json json
+            @sections[sect.name] = sect
+          elsif line.start_with? "SINF:"
+            json = JSON.parse (line.delete_prefix "SINF:").delete_suffix(";;;")
+            info = StripInfo.new_from_json json
+            @strip_info = info
+          end
+        end
+      rescue IOError
+# ignored
+      end
+    }
+  end
+
+  #noinspection RubyUnusedLocalVariable
+  def end
+    @socket.close
+    @receive_thread.join
+    strip_info = nil
+    running_animations = {}
+    supported_animations = {}
+    sections = {}
+  end
+
+  def send_animation(animation)
+    raise TypeError unless animation.is_a? AnimationData
+
+    @socket.write(animation.json + ";;;")
+  end
+
+  def send_end_animation(end_animation)
+    raise TypeError unless end_animation.is_a? EndAnimation
+
+    @socket.write(end_animation.json + ";;;")
+  end
+
+  def send_section(section)
+    raise TypeError unless section.is_a? Section
+
+    @socket.write(section.json + ";;;")
+  end
+
+end

data/lib/{color_container.rb → animatedledstrip/color_container.rb}

@@ -42,4 +42,11 @@ class ColorContainer
     @colors.push(color)
   end
 
+  def self.new_from_json(json_str)
+    cc = ColorContainer.new
+    json_str["colors"].each { |c| cc.add_color c }
+
+    cc
+  end
+
 end

data/lib/{direction.rb → animatedledstrip/direction.rb}

@@ -25,11 +25,24 @@ module Direction
   def self.string(direction)
     case direction
     when FORWARD
-      'FORWARD'
+      "FORWARD"
     when BACKWARD
-      'BACKWARD'
+      "BACKWARD"
     else
-      'FORWARD'
+      "FORWARD"
     end
   end
-end
+
+  def self.from_string(direction_str)
+    raise TypeError unless direction_str.is_a? String
+
+    case direction_str.upcase
+    when "FORWARD"
+      FORWARD
+    when "BACKWARD"
+      BACKWARD
+    else
+      FORWARD
+    end
+  end
+end

data/{test/test_animation_sender.rb → lib/animatedledstrip/end_animation.rb}

@@ -18,15 +18,23 @@
 #   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #   THE SOFTWARE.
 
-require_relative 'helper'
-require 'minitest'
-require_relative '../lib/animation_sender'
+class EndAnimation
+  attr_accessor :id
 
-class AnimationSenderTest < Minitest::Test
-  def test_initialization
-    sender = AnimationSender.new '10.0.0.254', 5
+  def initialize
+    @id = ""
+  end
+
+  def json
+    raise TypeError unless @id.is_a? String
+
+    "END :{\"id\":\"#{@id}\"}"
+  end
+
+  def self.new_from_json(json_data)
+    anim = EndAnimation.new
+    anim.id = json_data["id"] unless json_data["id"].nil?
 
-    assert_equal '10.0.0.254', sender.address
-    assert_equal 5, sender.port
+    anim
   end
-end
+end

data/lib/{animation_sender.rb → animatedledstrip/param_usage.rb}

@@ -18,29 +18,31 @@
 #   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #   THE SOFTWARE.
 
-require 'socket'
-require_relative 'animation_data'
-
-class AnimationSender
-  attr_accessor :address, :port
-
-  def initialize(address, port)
-    @address = address
-    @port = port
-  end
-
-  def start
-    @socket = TCPSocket.new @address, @port
+module ParamUsage
+  USED = 0
+  NOTUSED = 1
+
+  def self.string(param_usage)
+    case param_usage
+    when USED
+      "USED"
+    when NOTUSED
+      "NOTUSED"
+    else
+      "NOTUSED"
+    end
   end
 
-  def end
-    @socket.close
+  def self.from_string(param_usage_str)
+    raise TypeError unless param_usage_str.is_a? String
+
+    case param_usage_str.upcase
+    when "USED"
+      USED
+    when "NOTUSED"
+      NOTUSED
+    else
+      NOTUSED
+    end
   end
-
-  def send_animation(animation)
-    raise TypeError unless animation.is_a? AnimationData
-
-    @socket.write animation.json
-  end
-
 end

data/lib/animatedledstrip/section.rb

@@ -0,0 +1,52 @@
+#   Copyright (c) 2019-2020 AnimatedLEDStrip
+#
+#   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.
+
+class Section
+  attr_accessor :name, :num_leds, :start_pixel,
+                :end_pixel, :physical_start
+
+  def initialize
+    @name = ""
+    @num_leds = 0
+    @start_pixel = -1
+    @end_pixel = -1
+    @physical_start = -1
+  end
+
+  def json
+    raise TypeError unless @name.is_a? String
+    raise TypeError unless @start_pixel.is_a? Integer
+    raise TypeError unless @end_pixel.is_a? Integer
+
+    "SECT:{\"name\":\"#{@name}\","\
+    "\"startPixel\":#{@start_pixel},\"endPixel\":#{@end_pixel}}"
+  end
+
+  def self.new_from_json(json_data)
+    sect = Section.new
+    sect.name = json_data["name"] unless json_data["name"].nil?
+    sect.num_leds = json_data["numLEDs"] unless json_data["numLEDs"].nil?
+    sect.start_pixel = json_data["startPixel"] unless json_data["startPixel"].nil?
+    sect.end_pixel = json_data["endPixel"] unless json_data["endPixel"].nil?
+    sect.physical_start = json_data["physicalStart"] unless json_data["physicalStart"].nil?
+
+    sect
+  end
+end

data/{test/test_direction.rb → lib/animatedledstrip/strip_info.rb}

@@ -18,14 +18,29 @@
 #   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #   THE SOFTWARE.
 
-require_relative 'helper'
-require 'minitest'
-require_relative '../lib/direction'
+class StripInfo
+  attr_accessor :num_leds, :pin, :image_debugging,
+                :file_name, :renders_before_save,
+                :thread_count
 
-class DirectionTest < Minitest::Test
-  def test_direction_string
-    assert_equal 'FORWARD', Direction.string(Direction::FORWARD)
-    assert_equal 'BACKWARD', Direction.string(Direction::BACKWARD)
-    assert_equal 'FORWARD', Direction.string(-1)
+  def initialize
+    @num_leds = 0
+    @pin = -1
+    @image_debugging = false
+    @file_name = ""
+    @renders_before_save = -1
+    @thread_count = 100
+  end
+
+  def self.new_from_json(json_data)
+    info = StripInfo.new
+    info.num_leds = json_data["numLEDs"] unless json_data["numLEDs"].nil?
+    info.pin = json_data["pin"] unless json_data["pin"].nil?
+    info.image_debugging = json_data["imageDebugging"] unless json_data["imageDebugging"].nil?
+    info.file_name = json_data["fileName"] unless json_data["fileName"].nil?
+    info.renders_before_save = json_data["rendersBeforeSave"] unless json_data["rendersBeforeSave"].nil?
+    info.thread_count = json_data["threadCount"] unless json_data["threadCount"].nil?
+
+    info
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: animatedledstrip-client
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: '0.7'
 platform: ruby
 authors:
 - Max Narvaez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,23 +94,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: 
+email:
+- mnmax.narvaez3@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/animation.rb
-- lib/animation_data.rb
-- lib/animation_sender.rb
-- lib/color_container.rb
-- lib/direction.rb
-- test/test_animation.rb
-- test/test_animation_data.rb
-- test/test_animation_sender.rb
-- test/test_direction.rb
-homepage: 
-licenses: []
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- animatedledstrip-client.gemspec
+- lib/animatedledstrip/animation_data.rb
+- lib/animatedledstrip/animation_info.rb
+- lib/animatedledstrip/animation_sender.rb
+- lib/animatedledstrip/color_container.rb
+- lib/animatedledstrip/direction.rb
+- lib/animatedledstrip/end_animation.rb
+- lib/animatedledstrip/param_usage.rb
+- lib/animatedledstrip/section.rb
+- lib/animatedledstrip/strip_info.rb
+homepage: https://github.com/AnimatedLEDStrip/client-ruby
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -127,13 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Library for connecting to an AnimatedLEDStripServer
-test_files:
-- test/test_animation.rb
-- test/test_animation_data.rb
-- test/test_animation_sender.rb
-- test/test_direction.rb
+test_files: []

data/lib/animation.rb

@@ -1,109 +0,0 @@
-#   Copyright (c) 2019-2020 AnimatedLEDStrip
-#
-#   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.
-
-module Animation
-  COLOR = 0
-  CUSTOM_ANIMATION = 1
-  CUSTOM_REPETITIVE_ANIMATION = 2
-  ALTERNATE = 3
-  BOUNCE = 4
-  BOUNCE_TO_COLOR = 5
-  CAT_TOY = 6
-  CAT_TOY_TO_COLOR = 7
-  FADE_TO_COLOR = 8
-  FIREWORKS = 9
-  METEOR = 10
-  MULTIPIXEL_RUN = 11
-  MULTIPIXEL_RUN_TO_COLOR = 12
-  RIPPLE = 13
-  PIXEL_MARATHON = 14
-  PIXEL_RUN = 15
-  SMOOTH_CHASE = 16
-  SMOOTH_FADE = 17
-  SPARKLE = 18
-  SPARKLE_FADE = 19
-  SPARKLE_TO_COLOR = 20
-  SPLAT = 21
-  STACK = 22
-  STACK_OVERFLOW = 23
-  WIPE = 24
-  END_ANIMATION = 25
-
-  # @return [String]
-  def self.string(animation)
-    case animation
-    when COLOR
-      'COLOR'
-    when CUSTOM_ANIMATION
-      'CUSTOMANIMATION'
-    when CUSTOM_REPETITIVE_ANIMATION
-      'CUSTOMREPETITIVEANIMATION'
-    when ALTERNATE
-      'ALTERNATE'
-    when BOUNCE
-      'BOUNCE'
-    when BOUNCE_TO_COLOR
-      'BOUNCETOCOLOR'
-    when CAT_TOY
-      'CATTOY'
-    when CAT_TOY_TO_COLOR
-      'CATTOYTOCOLOR'
-    when FADE_TO_COLOR
-      'FADETOCOLOR'
-    when FIREWORKS
-      'FIREWORKS'
-    when METEOR
-      'METEOR'
-    when MULTIPIXEL_RUN
-      'MULTIPIXELRUN'
-    when MULTIPIXEL_RUN_TO_COLOR
-      'MULTIPIXELRUNTOCOLOR'
-    when RIPPLE
-      'RIPPLE'
-    when PIXEL_MARATHON
-      'PIXELMARATHON'
-    when PIXEL_RUN
-      'PIXELRUN'
-    when SMOOTH_CHASE
-      'SMOOTHCHASE'
-    when SMOOTH_FADE
-      'SMOOTHFADE'
-    when SPARKLE
-      'SPARKLE'
-    when SPARKLE_FADE
-      'SPARKLEFADE'
-    when SPARKLE_TO_COLOR
-      'SPARKLETOCOLOR'
-    when SPLAT
-      'SPLAT'
-    when STACK
-      'STACK'
-    when STACK_OVERFLOW
-      'STACKOVERFLOW'
-    when WIPE
-      'WIPE'
-    when END_ANIMATION
-      'ENDANIMATION'
-    else
-      'COLOR'
-    end
-  end
-
-end

data/test/test_animation.rb

@@ -1,121 +0,0 @@
-#   Copyright (c) 2019-2020 AnimatedLEDStrip
-#
-#   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.
-
-require_relative 'helper'
-require 'minitest/autorun'
-require_relative '../lib/animation'
-
-class AnimationTest < Minitest::Test
-  def test_color_string
-    assert_equal 'COLOR', Animation.string(Animation::COLOR)
-  end
-
-  def test_custom_animation_string
-    assert_equal 'CUSTOMANIMATION', Animation.string(Animation::CUSTOM_ANIMATION)
-  end
-
-  def test_custom_rep_anim_string
-    assert_equal 'CUSTOMREPETITIVEANIMATION', Animation.string(Animation::CUSTOM_REPETITIVE_ANIMATION)
-  end
-
-  def test_alternate_string
-    assert_equal 'ALTERNATE', Animation.string(Animation::ALTERNATE)
-  end
-
-  def test_bounce_string
-    assert_equal 'BOUNCE', Animation.string(Animation::BOUNCE)
-  end
-
-  def test_bounce_to_color_string
-    assert_equal 'BOUNCETOCOLOR', Animation.string(Animation::BOUNCE_TO_COLOR)
-  end
-
-  def test_cat_toy_string
-    assert_equal 'CATTOY', Animation.string(Animation::CAT_TOY)
-  end
-
-  def test_meteor_string
-    assert_equal 'METEOR', Animation.string(Animation::METEOR)
-  end
-
-  def test_multipixel_run_string
-    assert_equal 'MULTIPIXELRUN', Animation.string(Animation::MULTIPIXEL_RUN)
-  end
-
-  def test_multipixel_rtc_string
-    assert_equal 'MULTIPIXELRUNTOCOLOR', Animation.string(Animation::MULTIPIXEL_RUN_TO_COLOR)
-  end
-
-  def test_ripple_string
-    assert_equal 'RIPPLE', Animation.string(Animation::RIPPLE)
-  end
-
-  def test_pixel_marathon_string
-    assert_equal 'PIXELMARATHON', Animation.string(Animation::PIXEL_MARATHON)
-  end
-
-  def test_pixel_run_string
-    assert_equal 'PIXELRUN', Animation.string(Animation::PIXEL_RUN)
-  end
-
-  def test_smooth_chase_string
-    assert_equal 'SMOOTHCHASE', Animation.string(Animation::SMOOTH_CHASE)
-  end
-
-  def test_smooth_fade_string
-    assert_equal 'SMOOTHFADE', Animation.string(Animation::SMOOTH_FADE)
-  end
-
-  def test_sparkle_string
-    assert_equal 'SPARKLE', Animation.string(Animation::SPARKLE)
-  end
-
-  def test_sparkle_fade_string
-    assert_equal 'SPARKLEFADE', Animation.string(Animation::SPARKLE_FADE)
-  end
-
-  def test_sparkle_to_color_string
-    assert_equal 'SPARKLETOCOLOR', Animation.string(Animation::SPARKLE_TO_COLOR)
-  end
-
-  def test_splat_string
-    assert_equal 'SPLAT', Animation.string(Animation::SPLAT)
-  end
-
-  def test_stack_string
-    assert_equal 'STACK', Animation.string(Animation::STACK)
-  end
-
-  def test_stack_overflow_string
-    assert_equal 'STACKOVERFLOW', Animation.string(Animation::STACK_OVERFLOW)
-  end
-
-  def test_wipe_string
-    assert_equal 'WIPE', Animation.string(Animation::WIPE)
-  end
-
-  def test_end_animation_string
-    assert_equal 'ENDANIMATION', Animation.string(Animation::END_ANIMATION)
-  end
-
-  def test_default_string
-    assert_equal 'COLOR', Animation.string(-1)
-  end
-end

data/test/test_animation_data.rb

@@ -1,200 +0,0 @@
-#   Copyright (c) 2019-2020 AnimatedLEDStrip
-#
-#   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.
-
-require_relative 'helper'
-require 'minitest'
-require_relative '../lib/animation_data'
-
-class AnimationDataTest < Minitest::Test
-  def test_initialization
-    anim = AnimationData.new
-
-    assert_equal Animation::COLOR, anim.animation
-    assert_equal(-1, anim.center)
-    assert_nil anim.continuous
-    assert_equal(-1, anim.delay)
-    assert_equal 1.0, anim.delay_mod
-    assert_equal Direction::FORWARD, anim.direction
-    assert_equal(-1, anim.distance)
-    assert_equal(-1, anim.end_pixel)
-    assert_equal '', anim.id
-    assert_equal(-1, anim.spacing)
-    assert_equal 0, anim.start_pixel
-  end
-
-  def test_add_color
-    cc = ColorContainer.new
-    cc.add_color(0xFF)
-
-    anim = AnimationData.new
-    anim.add_color(cc)
-
-    assert anim.colors.include? cc
-
-    assert_raises TypeError do
-      anim.add_color(0xFF)
-    end
-  end
-
-  def test_json
-    anim = AnimationData.new
-    anim.animation = Animation::METEOR
-    anim.center = 50
-    anim.continuous = false
-    anim.delay = 10
-    anim.delay_mod = 1.5
-    anim.direction = Direction::BACKWARD
-    anim.distance = 45
-    anim.end_pixel = 200
-    anim.id = 'TEST'
-    anim.spacing = 5
-    anim.start_pixel = 15
-
-    cc = ColorContainer.new
-    cc2 = ColorContainer.new
-    cc.add_color 0xFF
-    cc.add_color 0xFF00
-    cc2.add_color 0xFF0000
-
-    anim.add_color cc
-    anim.add_color cc2
-
-    assert_equal 'DATA:{"animation":"METEOR","colors":[{'\
-    '"colors":[255,65280]},{"colors":[16711680]}],"center":50,'\
-    '"continuous":false,"delay":10,"delayMod":1.5,'\
-    '"direction":"BACKWARD","distance":45,"endPixel":200,'\
-    '"id":"TEST","spacing":5,"startPixel":15}', anim.json
-  end
-
-  def test_json_animation_failure
-    anim = AnimationData.new
-
-    anim.animation = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_center_failure
-    anim = AnimationData.new
-
-    anim.center = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_continuous_failure
-    anim = AnimationData.new
-
-    anim.continuous = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_delay_failure
-    anim = AnimationData.new
-
-    anim.delay = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_delay_mod_failure
-    anim = AnimationData.new
-
-    anim.delay_mod = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_direction_failure
-    anim = AnimationData.new
-
-    anim.direction = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_distance_failure
-    anim = AnimationData.new
-
-    anim.distance = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_end_pixel_failure
-    anim = AnimationData.new
-
-    anim.end_pixel = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_id_failure
-    skip
-    anim = AnimationData.new
-
-    anim.continuous = nil
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_spacing_failure
-    anim = AnimationData.new
-
-    anim.spacing = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_start_pixel_failure
-    anim = AnimationData.new
-
-    anim.start_pixel = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-
-  def test_json_colors_failure
-    anim = AnimationData.new
-
-    anim.colors = anim.colors.append 'A'
-
-    assert_raises TypeError do
-      anim.json
-    end
-
-    anim.colors = 'A'
-    assert_raises TypeError do
-      anim.json
-    end
-  end
-end