fancybox2 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36eebce6aa26f750e0d2974e2f7ea1a2f029174bddb6d3bb6b8a4adb4e01fd4a
-  data.tar.gz: 7f0d67c72d4472d950bbb581a2b2829cea9a0527bdc4377568a3d4293039ccbc
+  metadata.gz: 88d9c51fb40eb09f50db57b7dd601e78f36dc27df736d3b801c331cf9b6ba62c
+  data.tar.gz: 7cb67a8d2d7894591dca8815f9aee65a809498405ad65fd2fc05e05d3af192f1
 SHA512:
-  metadata.gz: 38a9da60393ba4308c46fca05ef6764111a872128f89cfc62bda02a998df36f64a08f41ef86eedc4108011368cd1eeaf682bbdda1f299ce16bfe2d66dfc075eb
-  data.tar.gz: 6600b35da0bf560f6b6f84edaa7f2307b6a49c4ae8e0c831cda9f764e0652b8f25384df236b87f096e19faba44ee86653381decef46c22d00597f65dfc807ea5
+  metadata.gz: 253c8254774761d441e39ef541038a86e6f4860db9fe5d7584565e7aa1641110247231a59cad0ae2304e5f9fe462a5f09fa2c62f8fb9ebe6aa0cc2a38834cf9f
+  data.tar.gz: ce444bf2a0f6eb8ce1148a17013a0419a50029c193b0a7f89423f768120fcddcd0f25acf2356154d4f75b9c277e265a1499a99fec3588124c1f3f086f3f34d60

data/README.md

@@ -2,188 +2,12 @@
   <img width="480" src="assets/logo.png"/>
 </p>
 
-[![Build Status](https://travis-ci.org/space-bunny/ruby_sdk.svg)](https://travis-ci.org/space-bunny/ruby_sdk)
-[![Gem Version](https://badge.fury.io/rb/spacebunny.svg)](https://badge.fury.io/rb/spacebunny)
+[![Build Status](https://travis-ci.org/FancyPixel/fancybox2-ruby-sdk.svg)](https://travis-ci.org/FancyPixel/fancybox2-ruby-sdk)
+[![Gem Version](https://badge.fury.io/rb/fancybox2.svg)](https://badge.fury.io/rb/fancybox2)
 
-[SpaceBunny](http://spacebunny.io) is the IoT platform that makes it easy for you and your devices to send and
-exchange messages with a server or even with each other. You can store the data, receive timely event notifications,
-monitor live streams and remotely control your devices. Easy to use, and ready to scale at any time.
+FancyPixel's FancyBox2 Ruby SDK for developing modules
 
-This is the source code repository for Ruby SDK.
-Please feel free to contribute!
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'spacebunny'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install spacebunny
-
-After you have signed up for a [SpaceBunny](http://spacebunny.io)'s account, follow the
-[Getting Started](http://getting_started_link) guide for a one minute introduction to the platform concepts
-and a super rapid setup.
-
-This SDK provides Device and LiveStream clients and currently supports the AMQP protocol.
-
-## Device - Basic usage
-
-Pick a device, view its configurations and copy the Device Key. Instantiate a new `Spacebunny::Device` client,
-providing the Device Key:
-
-```ruby
-dev = Spacebunny::Device.new 'device_key'
-```
-
-the SDK will auto-configure, contacting [SpaceBunny APIs](http://doc.spacebunny.io/api) endpoint, retrieving the
-connection configurations and required parameters. Nothing remains but to connect:
-
-```ruby
-dev.connect
-```
-
-### Publish
-
-Ok, all set up! Let's publish some message:
-
-```ruby
-# We're assuming you have created a 'data' channel and you have enabled it for your device
-
-# Let's publish, for instance, some JSON. Payload can be everything you want,
-# SpaceBunny does not impose any constraint on format or content.
-
-require 'json'  # to convert our payload to JSON
-
-# Publish one message every second for a minute.
-60.times do
-  # Generate some random data
-  payload = { greetings: 'Hello, World!', temp: rand(20.0..25.0), foo: rand(100..200) }.to_json
-    
-  # Publish
-  dev.publish :data, payload
-  
-  # Give feedback on what has been published
-  puts "Published: #{payload}"
-
-  # Take a nap...
-  sleep 1
-end
-```
-
-Let's check out that our data is really being sent by going to our web dashboard: navigate to devices, select the
-device and click on 'LIVE DATA'. Select the 'data' channel from the dropdown and click **Start**.
-Having published data as JSON allows SpaceBunny's web UI to parse them and visualize a nice
-realtime graph: On the **Chart** tab write `temp` in the input field and press enter.
-You'll see the graph of the `temp` parameter being rendered. If you want to plot more parameters,
-just use a comma as separator e.g: temp, pressure, voltage
-On the **Messages** tab you'll see raw messages' payloads received on this channel.
-
-### Inbox
-
-Waiting for and reading messages from the device's Inbox is trivial:
-
-```ruby
-dev.inbox(wait: true, ack: :auto) do |message|
-  puts "Received: #{message.payload}"
-end
-```
-
-`wait` option (default false) causes the script to wait forever on the receive block
-
-`ack` option can have two values: `:manual` (default) or `:auto`. When `:manual` you are responsible to ack the messages,
-for instance:
-
-```ruby
-dev.inbox(wait: true, ack: :manual) do |message|
-  puts "Received: #{message.payload}"
-  # Manually ack the message
-  message.ack
-end
-```
-This permits to handle errors or other critical situations
-
-## Live Stream - Basic usage
-
-For accessing a Live Stream a Live Stream Key's is required. On SpaceBunny's Web UI, go to the Streams section,
-click on "Live Stream Keys" and pick or create one.
-
-```ruby
-live = Spacebunny::LiveStream.new client: 'live_stream_key_client', secret: 'live_stream_key_secret'
-```
-
-Similarly to the Device client, the SDK will auto-configure itself, contacting [SpaceBunny APIs](http://doc.spacebunny.io/api)
-endpoint, retrieving the connection configurations and required parameters. Nothing remains but to connect:
-
-```ruby
-live.connect
-```
-
-### Reading live messages
-
-Each LiveStream has its own cache that will keep always last 100 messages (FIFO, when there are more than 100 messages,
-the oldest ones get discarded). If you want to consume messages in a parallel way, you shoul use the cache and connect
- as many LiveStream clients as you need: this way messages will be equally distributed to clients.
-
-```ruby
-live.message_from_cache :some_live_stream, wait: true, ack: :auto do |message|
-  puts "Received from cache: #{message.payload}"
-end
-
-# An equivalent method is:
-# live.message_from :some_live_stream, from_cache: true, wait: true, ack: :auto do |message|
-#   puts "Received from cache: #{message.payload}"
-# end
-```
-
-Conversely, if you want that each client will receive a copy of each message, don't use the cache:
-
-```ruby
-live.message_from :some_live_stream, wait: true, ack: :auto do |message|
-  puts "Received a copy of: #{message.payload}"
-end
-```
-
-Every client subscribed to the LiveStream in this way will receive a copy of the message.
-
-## TLS
-
-Instantiating a TLS-secured connection is trivial:
-
-```ruby
-# For a Device
-
-dev = Spacebunny::Device.new key, tls: true
-
-# Similarly, for a Live Stream
-
-live = Spacebunny::LiveStream.new client, secret, tls: true
-```
-
-## More examples and options
-
-Take a look at the ```examples``` directory for more code samples and further details about available options.
-
-
-### Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/FancyPixel/spacebunny_ruby.
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
-to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
-### Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`.
+[FancyBox](https://www.fancypixel.it/fancybox-standard/)
 
 ### License
 

data/lib/fancybox2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zeitwerk'
 require 'logger'
 

data/lib/fancybox2/core_ext/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Array
   # Extracts options from a set of arguments. Removes and returns the last
   # element in the array if it's a hash, otherwise returns a blank hash.

data/lib/fancybox2/core_ext/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # :nocov:
 class Hash
   # Returns a new hash with all keys converted using the block operation.

data/lib/fancybox2/logger/json_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'json'
 

data/lib/fancybox2/logger/mqtt_log_device.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fancybox2
   module Logger
     class MQTTLogDevice
@@ -11,10 +13,13 @@ module Fancybox2
         unless @client.respond_to?(:publish)
           raise ArgumentError, "provided client does not respond to 'publish'"
         end
+        unless @client.respond_to?(:connected?)
+          raise ArgumentError, "provided client does not respond to 'connected?'"
+        end
       end
 
       def write(message)
-        if @client.connected?
+        if @client && @client.connected?
           @client.publish @topic, message
         end
       end

data/lib/fancybox2/logger/multi.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fancybox2
   module Logger
 

data/lib/fancybox2/module/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'yaml'
 require 'logger'
@@ -28,6 +30,7 @@ module Fancybox2
         @logger = options.fetch :logger, create_default_logger
         @status = :stopped
         @alive_task = nil
+        @configs = {}
       end
 
       def alive_message_data(&block)
@@ -84,20 +87,15 @@ module Fancybox2
           @on_configs = block
           return
         end
-        @configs = begin
-                     # Try to parse
-                     JSON.parse packet.payload
-                   rescue JSON::ParserError
-                     logger.debug 'on_configs: failed parsing packet as JSON, retrying with YAML'
-                     begin
-                       # Try to parse YAML
-                       YAML.load packet.payload
-                     rescue StandardError
-                       logger.debug 'on_configs: failed parsing packet as YAML. Falling back to raw payload'
-                       # Fallback to original content
-                       packet.payload
-                     end
-                   end
+        begin
+          cfg = packet.payload
+          if cfg && cfg.is_a?(Hash) && cfg['configs']
+            self.configs.merge! cfg['configs']
+          end
+        rescue JSON::ParserError
+          logger.debug 'on_configs: failed parsing packet as JSON'
+        end
+
         @on_configs.call(packet) if @on_configs
       end
 
@@ -140,6 +138,8 @@ module Fancybox2
           return
         end
 
+        @status = :on_shutdown
+
         shutdown_ok = true
         logger.debug "Received 'shutdown' command"
         # Stop sending alive messages
@@ -160,17 +160,20 @@ module Fancybox2
         message_to :core, :shutdown, { status: shutdown_message }
         sleep 0.05 # Wait some time in order to be sure that the message has been published (message is not mandatory)
 
-        if mqtt_client && mqtt_client.connected?
-          # Gracefully disconnect from broker and exit
-          logger.debug 'Disconnecting from broker'
-          mqtt_client.disconnect
-        end
+        Thread.new do
+          if mqtt_client && mqtt_client.connected?
+            # Gracefully disconnect from broker and exit
+            logger.debug 'Disconnecting from broker, bye'
+            mqtt_client.disconnect
+            @mqtt_client = nil
+          end
 
-        if do_exit
-          # Exit from process
-          status_code = shutdown_ok ? 0 : 1
-          logger.debug "Exiting with status code #{status_code}"
-          exit status_code
+          if do_exit
+            # Exit from process
+            status_code = shutdown_ok ? 0 : 1
+            logger.debug "Exiting with status code #{status_code}"
+            exit status_code
+          end
         end
       end
 
@@ -186,8 +189,8 @@ module Fancybox2
         # Call user code
         @on_start.call(packet) if @on_start
 
-        configs = packet ? packet.payload : {}
-        interval = configs['aliveTimeout'] || 1000
+        cfg = packet ? packet.payload : {}
+        interval = cfg['aliveTimeout'] || 1000
         # Start code execution from scratch
         logger.debug "Received 'start'"
         @status = :running
@@ -228,14 +231,17 @@ module Fancybox2
       def start_sending_alive(interval: 5000)
         # TODO: replace the alive interval task with Eventmachine?
         # Interval is expected to be msec, so convert it to secs
-        interval /= 1000
+        interval /= 1000.0
         @alive_task.shutdown if @alive_task
         @alive_task = Concurrent::TimerTask.new(execution_interval: interval, timeout_interval: 2, run_now: true) do
-          packet = { status: @status, lastSeen: Time.now.utc }
-          if @alive_message_data
-            packet[:data] = @alive_message_data.call
+          packet = { status: @status, lastSeen: Time.now.utc, data: nil }
+          begin
+            packet[:data] = alive_message_data
+            message_to :core, :alive, packet
+          rescue StandardError => e
+            logger.error "Error in alive_message_data callback:  #{e.message}"
+            logger.error e.backtrace.join "\n"
           end
-          message_to :core, :alive, packet
         end
         @alive_task.execute
       end
@@ -353,12 +359,12 @@ module Fancybox2
 
       def create_default_logger
         stdout_logger = ::Logger.new STDOUT
-        broker_logger = ::Logger.new(Logger::MQTTLogDevice.new(topic_for(dest: :core, action: :logs),
-                                                               client: mqtt_client),
-                                     formatter: Logger::JSONFormatter.new)
-        logger = Logger::Multi.new stdout_logger, broker_logger,
-                                    level: @log_level,
-                                    progname: @log_progname
+        # broker_logger = ::Logger.new(Logger::MQTTLogDevice.new(topic_for(dest: :core, action: :logs),
+        #                                                        client: mqtt_client),
+        #                              formatter: Logger::JSONFormatter.new)
+        logger = Logger::Multi.new stdout_logger,# broker_logger,
+                                   level: @log_level,
+                                   progname: @log_progname
         logger
       end
 

data/lib/fancybox2/module/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fancybox2
   module Module
     class Config

data/lib/fancybox2/module/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fancybox2
   module Module
     module Exceptions

data/lib/fancybox2/utils/os.rb

@@ -4,34 +4,34 @@ module Fancybox2
       extend self
 
       def identifier
-        return @indentifier if @indentifier
+        return @identifier if @identifier
 
         host_os = RbConfig::CONFIG['host_os']
-        case host_os
-        when /aix(.+)$/
-          'aix'
-        when /darwin(.+)$/
-          'darwin'
-        when /linux/
-          'linux'
-        when /freebsd(.+)$/
-          'freebsd'
-        when /openbsd(.+)$/
-          'openbsd'
-        when /netbsd(.*)$/
-          'netbsd'
-        when /dragonfly(.*)$/
-          'dragonflybsd'
-        when /solaris2/
-          'solaris2'
-        when /mswin|mingw32|windows/
-          # No Windows platform exists that was not based on the Windows_NT kernel,
-          # so 'windows' refers to all platforms built upon the Windows_NT kernel and
-          # have access to win32 or win64 subsystems.
-          'windows'
-        else
-          host_os
-        end
+        @identifier = case host_os
+                      when /aix(.+)$/
+                        'aix'
+                      when /darwin(.+)$/
+                        'darwin'
+                      when /linux/
+                        'linux'
+                      when /freebsd(.+)$/
+                        'freebsd'
+                      when /openbsd(.+)$/
+                        'openbsd'
+                      when /netbsd(.*)$/
+                        'netbsd'
+                      when /dragonfly(.*)$/
+                        'dragonflybsd'
+                      when /solaris2/
+                        'solaris2'
+                      when /mswin|mingw32|windows/
+                        # No Windows platform exists that was not based on the Windows_NT kernel,
+                        # so 'windows' refers to all platforms built upon the Windows_NT kernel and
+                        # have access to win32 or win64 subsystems.
+                        'windows'
+                      else
+                        host_os
+                      end
       end
     end
   end

data/lib/fancybox2/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fancybox2
-  VERSION = '0.0.1'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fancybox2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: paho-mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.12
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement