nabaztag_hack_kit 0.1.0.beta8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd395348ad5c455b3587202f9fbf9782259cf829
-  data.tar.gz: e23d930933234912c081a5425003577a0db51fd2
+  metadata.gz: c22883b8dddfe8fe2395c1bdd0d22c0df2b33dcf
+  data.tar.gz: 1c20b4f56c758b25bc542e3226d26663333ef57f
 SHA512:
-  metadata.gz: 896a8d1f950033dfa49494747a982a3c58fa4ac92565e44725effbaecdce2c39ac46b73a12a8975eeab9f0c7f34df1550577e69705cdcbdc8c43eb953e6643be
-  data.tar.gz: 14abe18bd4b1502a7682aa5b5c24c579dfc51b36bcdc3d3bd290bd500407fb80fa686bfc47d4ee8d2beb2631b725d7b6af039c7b75e9bcf47a970721eb023c19
+  metadata.gz: 4b773982a492c28c15dc427b2e430cd2fa04bae067ac8c8ec391db2042731faada8266303ab270e46487aedcd4336b70e673103558e2608787a6943ae2303eb8
+  data.tar.gz: 8067914e37fa19ac263a5c9100957effc70ef92c56d829309a651bf3b9248a9d6a0f5125d188ae5be3ee9b8e434f14ee139e54451a438d83e2a30a141c8f5a9d

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/ModuleFunction:
+  EnforcedStyle:
+    extend_self

data/.rubocop_todo.yml

@@ -0,0 +1,57 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-12-03 00:04:40 +0100 using RuboCop version 0.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/unit/server_spec.rb'
+
+# Offense count: 6
+Metrics/AbcSize:
+  Max: 50
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 44
+
+# Offense count: 19
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 145
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 40
+
+# Offense count: 8
+Style/ClassVars:
+  Exclude:
+    - 'examples/record/server.rb'
+    - 'lib/nabaztag_hack_kit/mods/callback.rb'
+
+# Offense count: 16
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'examples/basic/config.ru'
+    - 'examples/record/server.rb'
+    - 'lib/nabaztag_hack_kit.rb'
+    - 'lib/nabaztag_hack_kit/bunny.rb'
+    - 'lib/nabaztag_hack_kit/message.rb'
+    - 'lib/nabaztag_hack_kit/message/helper.rb'
+    - 'lib/nabaztag_hack_kit/mods/button.rb'
+    - 'lib/nabaztag_hack_kit/mods/callback.rb'
+    - 'lib/nabaztag_hack_kit/mods/logger.rb'
+    - 'lib/nabaztag_hack_kit/mods/playground.rb'
+    - 'lib/nabaztag_hack_kit/mods/recording.rb'
+    - 'lib/nabaztag_hack_kit/mods/streaming.rb'
+    - 'lib/nabaztag_hack_kit/server.rb'

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in nabaztag_hack_kit.gemspec
 gemspec

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'bundler/gem_tasks'

data/bytecode/Rakefile

@@ -1,7 +1,9 @@
 
-desc "Test bytcode"
+# frozen_string_literal: true
+
+desc 'Test bytcode'
 task :test do
   puts `bin/mtl_simu test/test.mtl`
 end
 
-task :default => :test
+task default: :test

data/examples/basic/Gemfile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # A sample Gemfile
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "nabaztag_hack_kit", path:"../../"
+gem 'nabaztag_hack_kit', path: '../../'

data/examples/basic/config.ru

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $stdout.sync = true
 

data/examples/record/Gemfile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # A sample Gemfile
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "nabaztag_hack_kit"
-gem "ruby-echonest"
+gem 'nabaztag_hack_kit'
+gem 'ruby-echonest'

data/examples/record/config.ru

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require './server'
@@ -6,14 +7,14 @@ require './server'
 # use Rack::Reloader, 0
 
 ECHONEST_CFG = {
-  :key => "",
-}
+  key: ''
+}.freeze
 
 SOUNDCLOUD_CFG = {
-  :client_id      => "",
-  :client_secret  => "",
-  :username       => "",
-  :password       => "",
-}
+  client_id: '',
+  client_secret: '',
+  username: '',
+  password: ''
+}.freeze
 
 run Record::Server.new(ECHONEST_CFG, SOUNDCLOUD_CFG)

data/examples/record/server.rb

@@ -1,9 +1,10 @@
-require "nabaztag_hack_kit/server"
-require "soundcloud"
-require "echonest"
+# frozen_string_literal: true
 
-class Server < NabaztagHackKit::Server
+require 'nabaztag_hack_kit/server'
+require 'soundcloud'
+require 'echonest'
 
+class Server < NabaztagHackKit::Server
   def initialize(echonest_cfg, soundcloud_cfg)
     super
     @@echonest   = Echonest(echonest_cfg[:key])
@@ -33,7 +34,7 @@ class Server < NabaztagHackKit::Server
     puts beats = an.tempo.to_i
     loud = an.loudness.to_i
 
-    if beats > 0
+    if beats.positive?
       {
         REC_START => [3],
         EAR_L => norm(an.segments.first.timbre, 16),
@@ -41,7 +42,7 @@ class Server < NabaztagHackKit::Server
         BMP => [beats],
         LED_L1 => norm(an.segments.first.timbre, 255),
         LED_L2 => norm([beats, beats, beats, beats, loud, loud, loud, loud], 255),
-        LED_L3 => norm(norm an.segments.first.pitches, 255),
+        LED_L3 => norm(norm(an.segments.first.pitches, 255))
       }
     else
       {
@@ -57,52 +58,48 @@ class Server < NabaztagHackKit::Server
   end
 
   def upload(file)
-    @@soundcloud.post('/tracks', :track => {
-      :title        => 'Bunny Boogie',
-      :asset_data   => File.new(file)
-    })
+    @@soundcloud.post('/tracks', track: {
+                        title: 'Bunny Boogie',
+                        asset_data: File.new(file)
+                      })
     {
-      EAR_L  => [16,0,16,0,16,0],
+      EAR_L  => [16, 0, 16, 0, 16, 0],
       LED_L1 => [0],
       LED_L2 => [0],
       LED_L3 => [0]
     }
   end
 
-  on "start" do
+  on 'start' do
     @@dance = true
-    if @@recording
-      @@recording = false
-    end
-    send_nabaztag({
-      REC_STOP => []
-    })
+    @@recording = false if @@recording
+    send_nabaztag(REC_STOP => [])
   end
 
-  on "button-pressed" do
-    send_nabaztag if @@recording
-      @@recording = false
-      {
-        REC_STOP => [],
-        LED_L1   => [100,0,0,0],
-        LED_L2   => [0,100,0,100],
-        LED_L3   => [0,0,100,0]
-      }
-    else
-      @@recording = true
-      sec = @@dance ? 3 : 0
-      {
-        REC_START => [sec]
-      }
-    end
+  on 'button-pressed' do
+    send_nabaztag(if @@recording
+                    @@recording = false
+                    {
+                      REC_STOP => [],
+                      LED_L1   => [100, 0, 0, 0],
+                      LED_L2   => [0, 100, 0, 100],
+                      LED_L3   => [0, 0, 100, 0]
+                    }
+                  else
+                    @@recording = true
+                    sec = @@dance ? 3 : 0
+                    {
+                      REC_START => [sec]
+                    }
+                  end)
   end
 
-  on "recording-finished" do |file_name|
+  on 'recording-finished' do |file_name|
     @@recording = false
-    send_nabaztag if @@dance
-      dance
-    else
-      upload(file_name)
-    end
+    send_nabaztag(if @@dance
+                    dance
+                  else
+                    upload(file_name)
+                  end)
   end
 end

data/ext/bin/mtl_comp

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 BIN_NAME    = 'mtl_compiler'
 BIN_PATH    = File.dirname(__FILE__)
-BIN         = File.join(File.expand_path("../mtl_linux", BIN_PATH), BIN_NAME)
+BIN         = File.join(File.expand_path('../mtl_linux', BIN_PATH), BIN_NAME)
 FILE        = ARGV.first
 
 FILTER      = ENV['FILTER'] || "| grep -v 'bytes' | grep -e'[a-z]'"
 MERGE       = File.join(BIN_PATH, 'mtl_merge')
 TMP         = ENV['TMP'] || '.tmp.mtl'
-OUT         = ENV['OUT'] || "bytecode.bin"
+OUT         = ENV['OUT'] || 'bytecode.bin'
 
 unless FILE
   puts "usage: #{File.basename(__FILE__)} [filename]"
@@ -19,11 +20,11 @@ end
 `TMP='#{TMP}' #{MERGE} #{FILE}`
 
 # compile
-out = if File.exists?(BIN)
-  `#{BIN} -s #{TMP} #{OUT} 2>&1 #{FILTER}`
-else
-  "local binary not found: #{BIN}"
-end
+out = if File.exist?(BIN)
+        `#{BIN} -s #{TMP} #{OUT} 2>&1 #{FILTER}`
+      else
+        "local binary not found: #{BIN}"
+      end
 
 puts out
 `rm #{TMP}`

data/ext/bin/mtl_merge

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Merge a file with its includes, pass filename as first argument
 
@@ -19,7 +20,7 @@ end
 
 def src_file(name)
   [BASE_DIR, BASE_DIR_LIB].each do |dir|
-    if (path = File.join(dir, name)) && File.exists?(path)
+    if (path = File.join(dir, name)) && File.exist?(path)
       return path
     end
   end
@@ -28,9 +29,7 @@ end
 
 File.open(TMP, 'w') do |out|
   File.open(file).each_line do |line|
-    if line =~ /\A#include "([^"]+)"/
-      line = `cat #{src_file(mtl_file($1))}`
-    end
+    line = `cat #{src_file(mtl_file(Regexp.last_match(1)))}` if line =~ /\A#include "([^"]+)"/
     out.puts line
   end
 end

data/ext/bin/mtl_simu

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 BIN_NAME    = File.basename(__FILE__)
 BIN_PATH    = File.dirname(__FILE__)
-BIN         = File.join(File.expand_path("../mtl_linux", BIN_PATH), BIN_NAME)
+BIN         = File.join(File.expand_path('../mtl_linux', BIN_PATH), BIN_NAME)
 FILE        = ARGV.first
 
 FILTER      = ENV['FILTER'] || "| grep -v 'bytes' | grep -e'[a-z]'"
 MERGE       = File.join(BIN_PATH, 'mtl_merge')
 TMP         = ENV['TMP'] || '.tmp.mtl'
-OUT         = ENV['OUT'] || "bytecode.bin"
+OUT         = ENV['OUT'] || 'bytecode.bin'
 
 unless FILE
   puts "usage: #{File.basename(__FILE__)} [filename]"
@@ -19,11 +20,11 @@ end
 `TMP='#{TMP}' #{MERGE} #{FILE}`
 
 # simu
-out = if File.exists?(BIN)
-  `#{BIN} --source #{TMP}`
-else
-  "local binary not found: #{BIN}"
-end
+out = if File.exist?(BIN)
+        `#{BIN} --source #{TMP}`
+      else
+        "local binary not found: #{BIN}"
+      end
 
 puts out
 `rm #{TMP}`

data/ext/extconf.rb

@@ -1 +1,2 @@
-# nothing to here as gem process will execute `make` and `make install`
+# frozen_string_literal: true
+# nothing to here as gem process will execute `make` and `make install`

data/lib/nabaztag_hack_kit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nabaztag_hack_kit/version'
 
 module NabaztagHackKit

data/lib/nabaztag_hack_kit/bunny.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nabaztag_hack_kit/message'
 
 module NabaztagHackKit
@@ -43,11 +45,11 @@ module NabaztagHackKit
       Message.build(*@queued_commands.shift || Message::Api::OK)
     end
 
-    def to_json(state = nil, deepth = nil)
+    def to_json(_state = nil, _deepth = nil)
       {
-        :id                   => id,
-        :last_seen            => last_seen,
-        :queued_commands_size => queued_commands.size,
+        id: id,
+        last_seen: last_seen,
+        queued_commands_size: queued_commands.size
       }.to_json
     end
   end

data/lib/nabaztag_hack_kit/message.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module NabaztagHackKit
   module Message
     extend self
 
     def build(*commands)
       commands = if commands.first.is_a?(Hash)
-        commands.first
-      elsif !commands.first.is_a?(Array)
-        [commands]
-      else
-        commands
-      end
+                   commands.first
+                 elsif !commands.first.is_a?(Array)
+                   [commands]
+                 else
+                   commands
+                 end
 
-      pack full_message commands.map { |cmd, *data|
+      pack full_message(commands.map do |cmd, *data|
         data = convert_data(data)
         [cmd.to_i] + to_3b(data.size) + data.map(&:to_i)
-      }
+      end)
     end
 
     def to_3b(int)
@@ -30,6 +32,7 @@ module NabaztagHackKit
     end
 
     private
+
     def full_message(*data)
       [0x7F] + data.flatten + [0xFF, 0x0A]
     end
@@ -38,5 +41,4 @@ module NabaztagHackKit
       message.pack('c*')
     end
   end
-
 end

data/lib/nabaztag_hack_kit/message/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nabaztag_hack_kit/message'
 
 module NabaztagHackKit
@@ -43,7 +45,6 @@ module NabaztagHackKit
       #     Message.to_3b(value)
       #   end.flatten
       # end
-
     end
   end
 end

data/lib/nabaztag_hack_kit/message/helper.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 module NabaztagHackKit
   module Message
     module Helper
       extend self
       include Api
 
-      #blink
+      # blink
       def bl(loops = 1, color_on = 0xFF, color_off = 0x00)
         repeat(loops, [color_on, color_off])
       end
 
-      #repeat
+      # repeat
       def rp(loops, pattern = 0)
         Array.new(loops, pattern).flatten
       end
-      alias_method :sl, :rp #sleep
+      alias sl rp # sleep
 
-      #knight rider
+      # knight rider
       def kr(color = 0xFF, led1 = LED_L1, led2 = LED_L2, led3 = LED_L3)
         {
-          led1 => [color,0,0,0],
-          led2 => [0,color],
-          led3 => [0,0,color,0]
+          led1 => [color, 0, 0, 0],
+          led2 => [0, color],
+          led3 => [0, 0, color, 0]
         }
       end
 
@@ -28,29 +30,29 @@ module NabaztagHackKit
         data = Array.new(16) do |i|
           Message.to_3b(i * color)
         end + Array.new(8) do |i|
-          Message.to_3b((15-i) * 2 * color)
+          Message.to_3b((15 - i) * 2 * color)
         end
 
         {
-          (led1+10) => data + [0,0,0] + [0,0,0],
-          (led2+10) => [0,0,0] + data + [0,0,0],
-          (led3+10) => [0,0,0] + [0,0,0] + data
+          (led1 + 10) => data + [0, 0, 0] + [0, 0, 0],
+          (led2 + 10) => [0, 0, 0] + data + [0, 0, 0],
+          (led3 + 10) => [0, 0, 0] + [0, 0, 0] + data
         }
       end
 
       def wink(s = 1, e = 4, times = 3)
         {
-          EAR_L => ([s,e] * times) + [s],
-          EAR_R => [s] + ([s,e] * times)
+          EAR_L => ([s, e] * times) + [s],
+          EAR_R => [s] + ([s, e] * times)
         }
       end
 
       def circle(times = 15)
         {
-          LED_0 => [r,0,0,0] * times,
-          LED_1 => [0,r,0,0] * times,
-          LED_4 => [0,0,r,0] * times,
-          LED_3 => [0,0,0,r] * times,
+          LED_0 => [r, 0, 0, 0] * times,
+          LED_1 => [0, r, 0, 0] * times,
+          LED_4 => [0, 0, r, 0] * times,
+          LED_3 => [0, 0, 0, r] * times
         }
       end
 
@@ -69,11 +71,12 @@ module NabaztagHackKit
           EAR_L  => 0,
           EAR_R  => 0,
           EAR_LL => 0,
-          EAR_LR => 0,
+          EAR_LR => 0
         }
       end
 
       private
+
       def r
         rand(255)
       end

data/lib/nabaztag_hack_kit/mods/button.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module NabaztagHackKit
   module Mods
     module Button
-
       def self.registered(app)
-        app.on "button-pressed" do |bunny, data, request, run|
-          callback("button-pressed", bunny, params[:duration], request, run+1)
+        app.on 'button-pressed' do |bunny, _data, request, run|
+          callback('button-pressed', bunny, params[:duration], request, run + 1)
         end
       end
-
     end
   end
 end

data/lib/nabaztag_hack_kit/mods/callback.rb

@@ -1,15 +1,18 @@
 
+# frozen_string_literal: true
+
 require 'nabaztag_hack_kit/message/api'
 
 module NabaztagHackKit
   module Mods
     module Callback
-
       module Helpers
         def callback(action, bunny, data, request, run = 0)
-          if (cb = self.class.callbacks[action.to_s]) && (callback = cb[run])
-            instance_exec(bunny, data, request, run, &callback) || callback(action, bunny, data, request, run+1)
-          end
+          cb = self.class.callbacks[action.to_s]
+          return unless cb
+          callback = cb[run]
+          return unless callback
+          instance_exec(bunny, data, request, run, &callback) || callback(action, bunny, data, request, run + 1)
         end
       end
 
@@ -22,15 +25,15 @@ module NabaztagHackKit
         app.helpers Callback::Helpers
 
         # generic api callback
-        %w(get post).each do |method|
-          app.send(method, "/api/:bunnyid/:action.jsp") do
+        %w[get post].each do |method|
+          app.send(method, '/api/:bunnyid/:action.jsp') do
             bunny = Bunny.find(params[:bunnyid])
             callback('request', bunny, params, request)
             callback(params[:action], bunny, params, request).tap do |response|
               unless response
                 logger.warn "no successful callback found for #{params[:action]}"
                 status 404
-                return
+                break
               end
             end
           end
@@ -40,7 +43,6 @@ module NabaztagHackKit
       def callbacks
         @@callbacks ||= {}
       end
-
     end
   end
 end

data/lib/nabaztag_hack_kit/mods/logger.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module NabaztagHackKit
   module Mods
     module Logger
-
       module Helper
         def parse_log(logs)
-          logs.to_s.split("|").map do |line|
-            type, time, *values = line.split(",")
+          logs.to_s.split('|').map do |line|
+            type, time, *values = line.split(',')
             time = time.to_i
             values = values.map(&:to_i)
 
-            if type == "moved"
+            if type == 'moved'
               values << (time - values[1]) << (values[1] - values[2]) << (time - values[2]) << (time - values[3])
             end
             "#{type}-#{time}: #{values.join("\t")}"
@@ -18,16 +19,15 @@ module NabaztagHackKit
       end
 
       def self.registered(app)
-        app.on "log" do |data, request, run|
+        app.on 'log' do |data, request, run|
           parse_log(data).tap do |logs|
-            logger.info "#########################"
+            logger.info '#########################'
             logger.info logs.join("\n")
-            logger.info "#########################"
+            logger.info '#########################'
           end
-          callback('log', data, request, run+1)
+          callback('log', data, request, run + 1)
         end
       end
     end
-
   end
 end

data/lib/nabaztag_hack_kit/mods/playground.rb

@@ -1,15 +1,16 @@
-require "json"
+# frozen_string_literal: true
+
+require 'json'
 require 'nabaztag_hack_kit/bunny'
 require 'nabaztag_hack_kit/message/helper'
 
 module NabaztagHackKit
   module Mods
     module Playground
-
       module Helpers
         def commands(commands, command_values)
           Array(commands).zip(command_values).map do |command, values|
-            [command] + int_array(values.split(","))
+            [command] + int_array(values.split(','))
           end
         end
 
@@ -27,61 +28,57 @@ module NabaztagHackKit
       def self.registered(app)
         app.helpers Playground::Helpers
 
-        app.get "/" do
-          redirect "/playground"
+        app.get '/' do
+          redirect '/playground'
         end
 
-        app.get "/playground" do
-          File.read(public_file("index.html"))
+        app.get '/playground' do
+          File.read(public_file('index.html'))
         end
 
-        #API
-        app.get "/playground/commands" do # return list of commands
-          Message::Api.constants.sort.inject({}) do |hash, constant|
+        # API
+        app.get '/playground/commands' do # return list of commands
+          Message::Api.constants.sort.each_with_object({}) do |constant, hash|
             if constant.to_s.length > 2
               hash[constant] = Message::Api.const_get(constant)
             end
-            hash
           end.to_json
         end
 
-        app.get "/playground/bunnies" do # return list of bunnies
+        app.get '/playground/bunnies' do # return list of bunnies
           Bunny.all.to_json
         end
 
-        app.post "/playground/bunnies/:bunnyid" do #  {"command"=>["40"], "command_values"=>[["1,2,3,4"],[]]}
-          if bunny = Bunny.find(params[:bunnyid])
+        app.post '/playground/bunnies/:bunnyid' do #  {"command"=>["40"], "command_values"=>[["1,2,3,4"],[]]}
+          if (bunny = Bunny.find(params[:bunnyid]))
             bunny.queue_commands commands(params[:command], params[:command_values])
             bunny.to_json
           end
         end
 
-        app.post "/playground/bunnies" do #  {"bunny"=>["0019db9c2daf"], "command"=>["40"], "command_values"=>[["1,2,3,4"],[]]}
+        app.post '/playground/bunnies' do #  {"bunny"=>["0019db9c2daf"], "command"=>["40"], "command_values"=>[["1,2,3,4"],[]]}
           Array(params[:bunny]).uniq.each do |bunnyid|
-            if bunny = Bunny.find(bunnyid)
+            if (bunny = Bunny.find(bunnyid))
               bunny.queue_commands commands(params[:command], params[:command_values])
             end
           end
 
-          redirect "/playground"
+          redirect '/playground'
         end
 
         ##################################################################
 
-        app.on "ping" do |bunny|
-          if bunny
-            bunny.next_message!
-          end
+        app.on 'ping' do |bunny|
+          bunny&.next_message!
         end
 
-        app.on 'request' do |bunny, data|
-          if bunny = Bunny.find_or_initialize_by_id(data[:bunnyid])
+        app.on 'request' do |_bunny, data|
+          if (bunny = Bunny.find_or_initialize_by_id(data[:bunnyid]))
             bunny.seen!
           end
           nil # pass it on
         end
       end
-
     end
   end
 end

data/lib/nabaztag_hack_kit/mods/recording.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 module NabaztagHackKit
   module Mods
     module Streaming
-
-      REC_FILE = "rec.wav"
+      REC_FILE = 'rec.wav'
 
       def self.registered(app)
-        app.on "recording-finished" do |bunny, data, request, run|
-          file_name = REC_FILE # TODO add timestamp??
-          File.open(file_name, "w+") do |f|
+        app.on 'recording-finished' do |bunny, _data, request, run|
+          file_name = REC_FILE # TODO: add timestamp??
+          File.open(file_name, 'w+') do |f|
             f.write request.body.read
           end
-          callback('recording-finished', bunny, file_name, request, run+1)
+          callback('recording-finished', bunny, file_name, request, run + 1)
         end
       end
-
     end
   end
 end

data/lib/nabaztag_hack_kit/mods/streaming.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module NabaztagHackKit
   module Mods
     module Streaming
-
       def self.registered(app)
-        app.get "/streams/:file.mp3" do
-          if file = public_file("#{params[:file]}.mp3")
+        app.get '/streams/:file.mp3' do
+          if (file = public_file("#{params[:file]}.mp3"))
             File.read file
           else
             status 404
           end
         end
       end
-
     end
   end
 end

data/lib/nabaztag_hack_kit/server.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 
 module NabaztagHackKit
   class Server < Sinatra::Base
-
     configure :production, :development do
       enable :logging
     end
@@ -13,23 +14,23 @@ module NabaztagHackKit
       super
       @base_file     = opts.fetch(:base_file, __FILE__)
       @bytecode_file = opts.fetch(:bytecode_file, public_file('bytecode.bin')).to_s
-      abort("Couldn't find Bytecode file. Pls compile first") unless File.exists?(@bytecode_file)
+      abort("Couldn't find Bytecode file. Pls compile first") unless File.exist?(@bytecode_file)
       puts "Serving Bytecode from #{@bytecode_file}"
     end
 
-    get "/bc.jsp" do
+    get '/bc.jsp' do
       send_file @bytecode_file
     end
 
-    get "/" do
-      "Welcome to Nabaztag Hack Kit - it works!"
+    get '/' do
+      'Welcome to Nabaztag Hack Kit - it works!'
     end
 
-    get "/favicon.ico" do
+    get '/favicon.ico' do
     end
 
     # generic catchall
-    get "/*" do
+    get '/*' do
       logger.warn "no route found for #{params[:splat]}"
       status 404
     end
@@ -37,13 +38,14 @@ module NabaztagHackKit
     ####################################################################
 
     protected
+
     def public_file(name)
       public_file_path(name) || public_file_path(name, __FILE__)
     end
 
     def public_file_path(name, base = @base_file)
       File.expand_path(File.join('..', 'public', name), base).tap do |file|
-        return file if File.exists?(file)
+        return file if File.exist?(file)
       end
       nil
     end

data/lib/nabaztag_hack_kit/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NabaztagHackKit
-  VERSION = "0.1.0.beta8"
+  VERSION = '0.1.0'
 end

data/nabaztag_hack_kit.gemspec

@@ -1,29 +1,33 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "nabaztag_hack_kit/version"
+
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'nabaztag_hack_kit/version'
 
 Gem::Specification.new do |s|
-  s.name        = "nabaztag_hack_kit"
+  s.name        = 'nabaztag_hack_kit'
   s.version     = NabaztagHackKit::VERSION
-  s.authors     = ["RngTng - Tobias Bielohlawek"]
-  s.email       = ["tobi@rngtng.com"]
-  s.homepage    = "https://github.com/rngtng/NabaztagHackKit"
-  s.summary     = %q{Sinatra server to run custom Nabaztag bytecode}
-  s.description = %q{Sinatra server api framework to run custom bytecode on Nabaztag v1/v2. Sources + Compiler included (linux only)}
+  s.authors     = ['RngTng - Tobias Bielohlawek']
+  s.email       = ['tobi@rngtng.com']
+  s.homepage    = 'https://github.com/rngtng/NabaztagHackKit'
+  s.summary     = 'Sinatra server to run custom Nabaztag bytecode'
+  s.description = 'Sinatra server api framework to run custom bytecode on Nabaztag' \
+                  ' v1/v2. Sources + Compiler included (linux only)'
 
   s.files         = `git ls-files --recurse-submodules`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.extensions    = ['ext/extconf.rb']
 
   s.bindir        = 'ext/bin'
-  s.executables   = ['mtl_comp', 'mtl_simu', 'mtl_merge']
+  s.executables   = %w[mtl_comp mtl_simu mtl_merge]
 
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_dependency 'sinatra', '>= 2.0'
   s.add_dependency 'rack', '>= 2.0'
+  s.add_dependency 'sinatra', '>= 2.0'
 
+  s.add_development_dependency 'rack-test', '>= 0.6'
   s.add_development_dependency 'rake', '>= 11.2'
   s.add_development_dependency 'rspec', '>= 3.5'
-  s.add_development_dependency 'rack-test', '>= 0.6'
+  s.add_development_dependency 'rubocop', '>= 0.49'
 end

data/spec/integration/server_spec.rb

@@ -1,17 +1,19 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-require "nabaztag_hack_kit/server"
-require "rack/test"
+require 'spec_helper'
+
+require 'nabaztag_hack_kit/server'
+require 'rack/test'
 
 shared_examples_for :successful_route do
-  it "returns 200" do
+  it 'returns 200' do
     get route
     expect(last_response).to be_ok
   end
 end
 
 shared_examples_for :notfound_route do
-  it "returns 404" do
+  it 'returns 404' do
     get route
     expect(last_response.status).to eq 404
   end
@@ -20,10 +22,10 @@ end
 describe NabaztagHackKit::Server do
   include Rack::Test::Methods
 
-  let(:app) { NabaztagHackKit::Server.new(:bytecode_file => __FILE__) }
+  let(:app) { NabaztagHackKit::Server.new(bytecode_file: __FILE__) }
 
-  describe "/bc.jsp" do
-    let(:route) { "/bc.jsp" }
+  describe '/bc.jsp' do
+    let(:route) { '/bc.jsp' }
 
     it_behaves_like :successful_route
   end
@@ -46,14 +48,14 @@ describe NabaztagHackKit::Server do
   #   # it_behaves_like :successful_route
   # end
 
-  describe "catch all route" do
-    let(:route) { "/api/bunnyid/custom.jsp" }
+  describe 'catch all route' do
+    let(:route) { '/api/bunnyid/custom.jsp' }
 
     it_behaves_like :notfound_route
 
-    it "execute callback" do
+    it 'execute callback' do
       get route
-      expect(last_response.body).to eq ""
+      expect(last_response.body).to eq ''
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'rspec'
 
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
 
-$: << File.expand_path("../../lib", __FILE__)
-
-require "nabaztag_hack_kit"
+require 'nabaztag_hack_kit'

data/spec/unit/message_spec.rb

@@ -1,10 +1,12 @@
-require "spec_helper"
-require "nabaztag_hack_kit/message"
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'nabaztag_hack_kit/message'
 
 describe NabaztagHackKit::Message do
   CMD  = 30
   CMD1 = 31
-  let(:data) { [1,2,3,4,5] }
+  let(:data) { [1, 2, 3, 4, 5] }
   let(:size) { NabaztagHackKit::Message.to_3b(data.size) }
 
   before do
@@ -12,49 +14,49 @@ describe NabaztagHackKit::Message do
     allow(NabaztagHackKit::Message).to receive(:pack) { |data| data }
   end
 
-  describe ".build" do
-    it "accepts single input" do
-      expect(NabaztagHackKit::Message.build(*[["40"], ["40", "2", "3", "4"]])).to eq [[40, 0, 0, 0], [40, 0, 0, 1, 50]]
+  describe '.build' do
+    it 'accepts single input' do
+      expect(NabaztagHackKit::Message.build(['40'], %w[40 2 3 4])).to eq [[40, 0, 0, 0], [40, 0, 0, 1, 50]]
     end
 
-    it "accepts single input" do
+    it 'accepts single input' do
       expect(NabaztagHackKit::Message.build(CMD)).to eq [[CMD, 0, 0, 0]]
     end
 
-    it "accepts flat input" do
+    it 'accepts flat input' do
       expect(NabaztagHackKit::Message.build(CMD, *data)).to eq [[CMD, *size, *data]]
     end
 
-    it "accepts array input" do
+    it 'accepts array input' do
       expect(NabaztagHackKit::Message.build([CMD, *data])).to eq [[CMD, *size, *data]]
     end
 
-    it "accepts multiple array input" do
+    it 'accepts multiple array input' do
       expect(NabaztagHackKit::Message.build([CMD, *data], [CMD1, *data])).to eq [[CMD, *size, *data], [CMD1, *size, *data]]
     end
 
-    it "accepts hash input" do
+    it 'accepts hash input' do
       expect(NabaztagHackKit::Message.build(CMD => data, CMD1 => data)).to eq [[CMD, *size, *data], [CMD1, *size, *data]]
     end
 
-    context "as string" do
-      it "accepts hash input" do
+    context 'as string' do
+      it 'accepts hash input' do
         expect(NabaztagHackKit::Message.build(CMD.to_s => data.map(&:to_s), CMD1.to_s => data)).to eq [[CMD, *size, *data], [CMD1, *size, *data]]
       end
     end
   end
 
-  describe ".to_3b" do
-    it "accepts zero" do
+  describe '.to_3b' do
+    it 'accepts zero' do
       expect(NabaztagHackKit::Message.to_3b(0)).to eq [0, 0, 0]
     end
 
-    it "accepts 2 byte input" do
+    it 'accepts 2 byte input' do
       expect(NabaztagHackKit::Message.to_3b(511)).to eq [0, 1, 255]
     end
 
-    it "accepts 3 byte input" do
-      expect(NabaztagHackKit::Message.to_3b(6334239)).to eq [96, 167, 31]
+    it 'accepts 3 byte input' do
+      expect(NabaztagHackKit::Message.to_3b(6_334_239)).to eq [96, 167, 31]
     end
   end
 end

data/spec/unit/server_spec.rb

@@ -1,32 +1,32 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-require "nabaztag_hack_kit/server"
+require 'spec_helper'
+
+require 'nabaztag_hack_kit/server'
 
 describe NabaztagHackKit::Server do
   let(:app) { NabaztagHackKit::Server.new }
 
-  describe "#bc.jsp" do
+  describe '#bc.jsp' do
     def do_action(path)
-      app.call({
-        'REQUEST_METHOD' => 'GET',
-        'PATH_INFO'      => path,
-        'rack.input'     => StringIO.new
-      })
+      app.call('REQUEST_METHOD' => 'GET',
+               'PATH_INFO'      => path,
+               'rack.input'     => StringIO.new)
     end
 
-    xit "reads from public/bytecode.bin" do
-      expect(app).to_receive(:send_file).with("public/bytecode.bin")
+    xit 'reads from public/bytecode.bin' do
+      expect(app).to_receive(:send_file).with('public/bytecode.bin')
       begin
         do_action '/bc.jsp'
       rescue SystemExit
       end
     end
 
-    context "with custom bin code route" do
+    context 'with custom bin code route' do
       let(:app) { NabaztagHackKit::Server.new(custom_route) }
-      let(:custom_route) { "bytecode.bin" }
+      let(:custom_route) { 'bytecode.bin' }
 
-      xit "reads from" do
+      xit 'reads from' do
         expect(app).to_receive(:send_file).with(custom_route)
         begin
           do_action '/bc.jsp'
@@ -36,8 +36,8 @@ describe NabaztagHackKit::Server do
     end
   end
 
-  describe "#on" do
-    xit "accepts" do
+  describe '#on' do
+    xit 'accepts' do
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nabaztag_hack_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta8
+  version: 0.1.0
 platform: ruby
 authors:
 - RngTng - Tobias Bielohlawek
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2017-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.49'
 description: Sinatra server api framework to run custom bytecode on Nabaztag v1/v2.
   Sources + Compiler included (linux only)
 email:
@@ -94,6 +108,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitmodules"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -255,9 +271,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1