flic 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30e6a6023c2fe3f2a83299ce7358050ef07195c8
-  data.tar.gz: f1ac706e5cfca806615de68e6bf147893225662e
+  metadata.gz: b313acdfde6b058cfba2f4d0c148b8937e6c2ab9
+  data.tar.gz: c5805fd3c6421a2b688e7f4b85b7594423dbe4a1
 SHA512:
-  metadata.gz: a9bc7ad01daea014be21f5214cb15a5cd4d4a2cb0ae6a7cc69b8da408fed1153279475607d1267172f6f1a2bb6e13fe391829f596989189af3f449a3030b257b
-  data.tar.gz: a1263c875e8c918b4cd100d65d91964dda1a3d08c3ea613468556ac1eb6dcad6d25ec3c9e8a8fb074d445249358646dd4c1a2ca8b945712ea6065048fb9e84d0
+  metadata.gz: 2e8dd3aa2feed080bf4d36af89dd3bf532ebf00842099d08aca5a3403974a83fcc859edae2b45760d5097db6b6308277d4f194f26bf22e5b7733586a8bb25b68
+  data.tar.gz: 934f32212c39ef034446a6d502ffd6a7fd611e1fd751a1dba8bceaee079fe4bb455038cf93ae305db0d04ef2a46f4550b2b51cbc8865e75c89ccbfd7a215cb04

data/README.md

@@ -32,7 +32,7 @@ A button must be in public mode before it can be added. To put a button in publi
 Similarly, a button may be disconnected by passing `Flic::SimpleClient#disconnect_button` a button's bluetooth address.
 
 ### Listening for button events
-`Flic::SimpleClient#listen` accepts a latency mode (`:low`, `:normal`, or `:high`) as it's first argument and button bluetooth addresses as its other arguments. For each event that occurs to those buttons, it yields the bluetooth address of the button responsible for a given event, the type of click involved in the event (`:button_down`, `:button_up`, `:button_single_click`, `:button_double_click`, or `:button_hold`), the time in milliseconds since the event occured, and whether the event was queued. **It will block until the connection is closed or the block raises some other exception.**
+`Flic::SimpleClient#listen` accepts a latency mode (`:low`, `:normal`, or `:high`) as it's first argument and button bluetooth addresses as its other arguments. For each event that occurs to those buttons, it yields the bluetooth address of the button responsible for a given event, the type of click involved in the event (`:button_down`, `:button_up`, `:button_single_click`, `:button_double_click`, or `:button_hold`), the time in seconds since the event occured, and whether the event was queued. **It will block until the connection is closed or the block raises some other exception.**
 
 ### Closing the connection to `flicd`
 To gracefully cleanup all connection channels and close the socket connection, call `Flic::SimpleClient#shutdown`. Once a `Flic::SimpleClient` has been shutdown it will close the underlying socket and cannot be used anymore.
@@ -40,6 +40,7 @@ To gracefully cleanup all connection channels and close the socket connection, c
 ### Example
 This is the script that I wrote to allow some of my Flic buttons to control Wink-enabled smart devices in home.
 ```ruby
+
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
@@ -55,61 +56,62 @@ BEDROOM_BUTTON 		= 'XX:XX:XX:XX:XX:XX'
 NIGHTSTAND_BUTTON 	= 'XX:XX:XX:XX:XX:XX'
 
 begin
-	puts "[*] Opening a connection to flicd..."
-	client = Flic::SimpleClient.new
-
-	puts "[*] Entering main loop"
-	client.listen(:low, LIVING_ROOM_BUTTON, BEDROOM_BUTTON, NIGHTSTAND_BUTTON) do |button, event, latency_ms|
-		if latency_ms > 2000
-			puts "[*] [#{button}] Ignoring #{event} because the latency is #{latency_ms} ms"
-		else
-			puts "[*] [#{button}] Handling #{event}"
-
-			case button
-			when LIVING_ROOM_BUTTON
-				case event
-				when :button_single_click
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				when :button_double_click
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				when :button_hold
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				end
-
-			when BEDROOM_BUTTON
-				case event
-				when :button_single_click
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				when :button_double_click
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				when :button_hold
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				end
-
-			when NIGHTSTAND_BUTTON
-				case event
-				when :button_single_click
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				when :button_double_click
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				when :button_hold
-					puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
-				end
-			end
-		end
-	end
+    puts "[*] Opening a connection to flicd..."
+    client = Flic::SimpleClient.new
+
+    puts "[*] Entering main loop"
+    client.listen(:low, LIVING_ROOM_BUTTON, BEDROOM_BUTTON, NIGHTSTAND_BUTTON) do |button, event, latency|
+        if latency > 10
+            puts "[*] [#{button}] Ignoring #{event} because the latency is #{latency} seconds"
+        else
+            puts "[*] [#{button}] Handling #{event}"
+
+            case button
+            when LIVING_ROOM_BUTTON
+                case event
+                when :button_single_click
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                when :button_double_click
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                when :button_hold
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                end
+
+            when BEDROOM_BUTTON
+                case event
+                when :button_single_click
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                when :button_double_click
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                when :button_hold
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                end
+
+            when NIGHTSTAND_BUTTON
+                case event
+                when :button_single_click
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                when :button_double_click
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                when :button_hold
+                    puts HTTParty.post('https://api.wink.com/scenes/SCENE_ID/activate', headers: { Authorization: "Bearer #{WINK_ACCESS_TOKEN}" }).inspect
+                end
+            end
+        end
+    end
 rescue StandardError => error
-	puts "[!] Whoops! #{error.inspect} occured. Wait for a second and restart everything."
-	sleep 1
+    puts "[!] Whoops! #{error.inspect} occured. Wait for a second and restart everything."
+    sleep 1
 
-	retry
+    retry
 rescue Interrupt
-	puts "[*] Shutting down gracefully because of an interrupt"
+    puts "[*] Shutting down gracefully because of an interrupt"
 
-	client.shutdown
+    client.shutdown
 end
 
 puts "[*] Goodbye cruel world!"
+
 ```
 
 ## Advanced Usage

data/Rakefile

@@ -1,12 +1,17 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
 task :test => :spec
 
+YARD::Rake::YardocTask.new(:yard)
+task :doc => :yard
+
 task :console do
   require 'flic'
   require 'pry'
   Pry.start
 end
+
+task :default => [:spec, :doc]

data/flic.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'yard'
 end

data/lib/flic.rb

@@ -1,6 +1,7 @@
 require 'flic/version'
 
 module Flic
+  autoload :Blocker, 'flic/blocker'
   autoload :Callbacks, 'flic/callbacks'
   autoload :Client, 'flic/client'
   autoload :Protocol, 'flic/protocol'

data/lib/flic/blocker.rb

@@ -0,0 +1,59 @@
+require 'flic'
+
+require 'thread'
+
+module Flic
+  class Blocker
+    attr_reader :rejection_value
+
+    def initialize
+      @semaphore = Mutex.new
+      @queues = []
+      @rejection_value = nil
+    end
+
+    def block_until_callback
+      queue = Queue.new
+
+      begin
+        @semaphore.synchronize do
+          if @queues.frozen?
+            raise *rejection_value
+          else
+            @queues << queue
+          end
+        end
+
+        yield proc { |value| queue << [:resolve, value] }
+
+        control, value = queue.pop
+
+        case control
+          when :resolve
+            value
+          when :reject
+            raise *rejection_value
+        end
+      ensure
+        @semaphore.synchronize do
+          unless @queues.frozen?
+            @queues.delete queue
+          end
+        end
+      end
+    end
+
+    def unblock_all!(*rejection_value)
+      @semaphore.synchronize do
+        unless @queues.frozen?
+          @rejection_value = rejection_value
+
+          @queues.each { |queue| queue << [:reject, *rejection_value] }.clear
+          @queues.freeze
+
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/flic/client.rb

@@ -6,7 +6,7 @@ require 'socket'
 module Flic
   class Client
     class Error < StandardError; end
-    class ClientShutdownError < Error; end
+    class Shutdown < Error; end
 
     autoload :ConnectionChannel, 'flic/client/connection_channel'
     autoload :Features, 'flic/client/features'
@@ -41,27 +41,32 @@ module Flic
     define_callbacks :new_button_verified, :bluetooth_controller_state_changed,
                      :connections_exhausted, :connection_available
 
-
     def initialize(host = 'localhost', port = 5551)
       @host, @port = host, port
       @handle_next_event_semaphore = Mutex.new
       @socket = TCPSocket.new(host, port)
       @connection = Protocol::Connection.new(socket)
+      @is_shutdown = false
       yield self if block_given?
     end
 
+    def shutdown?
+      @is_shutdown
+    end
+
     def shutdown
-      connection.close
+      socket.close
+      @is_shutdown = true
     end
 
     def handle_next_event
       @handle_next_event_semaphore.synchronize do
         begin
           handle_event connection.recv_event
-        rescue Protocol::Connection::ConnectionClosedError
+        rescue Protocol::Connection::UnderlyingSocketClosedError
           shutdown
 
-          raise ClientShutdownError, 'The connection has been closed'
+          raise Shutdown, 'The connection has been closed'
         end
       end
     end
@@ -74,10 +79,10 @@ module Flic
 
     def send_command(command)
       connection.send_command(command)
-    rescue Protocol::Connection::ConnectionClosedError
+    rescue Protocol::Connection::UnderlyingSocketClosedError
       shutdown
 
-      raise ClientShutdownError, 'The connection has been closed'
+      raise Shutdown, 'The connection has been closed'
     end
 
     def handle_event(event)

data/lib/flic/client/scan_wizard.rb

@@ -9,6 +9,10 @@ module Flic
 
       define_callbacks :added, :removed,
                        :found_private_button, :found_public_button, :button_connected
+
+      def successful?
+        result == :success
+      end
     end
   end
 end

data/lib/flic/protocol.rb

@@ -1,7 +1,11 @@
 require 'flic'
 
 module Flic
+  # This module contains an implementation of the Flic binary protocol. Of particular external interest is
+  # `Flic::Protocol::Connection` which provides a wrapper for the binary protocol around a socket instance.
   module Protocol
+    extend self
+
     class Error < StandardError; end
 
     autoload :Commands, 'flic/protocol/commands'
@@ -10,9 +14,10 @@ module Flic
     autoload :PacketHeader, 'flic/protocol/packet_header'
     autoload :Primitives, 'flic/protocol/primitives'
 
-    INVALID_BUTTON_UUID = '00000000-0000-0000-0000-000000000000'.freeze
-
-    def self.serialize_command(command)
+    # Serializes an instance of a protocol command class to a binary string
+    # @param command [Flic::Protocol::Commands::Command]
+    # @return [String] binary string
+    def serialize_command(command)
       case command
         when Commands::Command
           command.to_binary_s
@@ -23,7 +28,10 @@ module Flic
       raise Error, "Cannot serialize command `#{command.inspect}`"
     end
 
-    def self.parse_command(serialized_command)
+    # Deserializes an instance of a protocol command class from a binary string
+    # @param serialized_command [String] binary string
+    # @return [Flic::Protocol::Commands::Command]
+    def parse_command(serialized_command)
       command = Commands::Command.read(serialized_command)
       opcode = command.opcode
       command_class = Commands::Command.command_class_for_opcode(opcode)
@@ -37,7 +45,10 @@ module Flic
       raise Error, "Cannot parse event `#{serialized_command.inspect}`"
     end
 
-    def self.serialize_event(event)
+    # Serializes an instance of a protocol event class to a binary string
+    # @param event [Flic::Protocol::Events::Event]
+    # @return [String] binary string
+    def serialize_event(event)
       case event
         when Commands::Event
           event.to_binary_s
@@ -48,7 +59,10 @@ module Flic
       raise Error, "Cannot serialize event `#{event.inspect}`"
     end
 
-    def self.parse_event(serialized_event)
+    # Deserializes an instance of a protocol event class from a binary string
+    # @param serialized_event [String] binary string
+    # @return [Flic::Protocol::Events::Event]
+    def parse_event(serialized_event)
       event = Events::Event.read(serialized_event)
       opcode = event.opcode
       event_class = Events.event_class_for_opcode(opcode)

data/lib/flic/protocol/commands.rb

@@ -2,6 +2,7 @@ require 'flic/protocol'
 
 module Flic
   module Protocol
+    # A namespace module for all of the command classes
     module Commands
       autoload :CancelScanWizard, 'flic/protocol/commands/cancel_scan_wizard'
       autoload :ChangeModeParameters, 'flic/protocol/commands/change_mode_parameters'
@@ -32,10 +33,16 @@ module Flic
 
       OPCODE_COMMAND_CLASS = COMMAND_CLASS_OPCODE.invert.freeze
 
+      # Finds the command class for a given opcode
+      # @param opcode [Integer]
+      # @return [Class]
       def self.command_class_for_opcode(opcode)
         OPCODE_COMMAND_CLASS[opcode]
       end
 
+      # Finds the opcode for a given command class
+      # @param command_class [Class]
+      # @return [Integer]
       def self.opcode_for_command_class(command_class)
         COMMAND_CLASS_OPCODE[command_class]
       end

data/lib/flic/protocol/commands/cancel_scan_wizard.rb

@@ -6,9 +6,7 @@ module Flic
   module Protocol
     module Commands
       class CancelScanWizard < Command
-        endian :little
-
-        uint32 :scan_wizard_id
+        uint32le :scan_wizard_id
       end
     end
   end

data/lib/flic/protocol/commands/change_mode_parameters.rb

@@ -7,9 +7,7 @@ module Flic
   module Protocol
     module Commands
       class ChangeModeParameters < Command
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         latency_mode :latency_mode
         disconnect_time :auto_disconnect_time
       end

data/lib/flic/protocol/commands/command.rb

@@ -6,15 +6,21 @@ module Flic
   module Protocol
     module Commands
       class Command < BinData::Record
-        endian :little
-
-        uint8 :opcode, initial_value: -> { init_opcode }
+        uint8le :opcode, initial_value: :class_opcode, assert: :opcode_matcher
 
         private
 
-        def init_opcode
+        def class_opcode
           Commands.opcode_for_command_class(self.class)
         end
+
+        def opcode_matcher
+          if class_opcode
+            class_opcode
+          else
+            true
+          end
+        end
       end
     end
   end

data/lib/flic/protocol/commands/create_connection_channel.rb

@@ -8,9 +8,7 @@ module Flic
   module Protocol
     module Commands
       class CreateConnectionChannel < Command
-        endian :little
-
-        uint32 :connection_channel_id
+        uint32le :connection_channel_id
         bluetooth_address :bluetooth_address
 
         latency_mode :latency_mode