nutella_lib 0.4.27 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b11c022814995ed25e82654c006f3e5a81c84ee2d48ad86f3710135fba31fa63
-  data.tar.gz: 46152efd052e5734e1d0687c9cb18d11c461e15167ce0dcd128768edcfad3bd6
+  metadata.gz: aa7384c4726a3e52f18381983e8b022f01a13039642e4eeb66c0f83950c8481a
+  data.tar.gz: a660ef5d63f9d768a089a557d501367fdabf4630891933a4cb09840e30d151ad
 SHA512:
-  metadata.gz: ebd24e14b6ba9742016caa2e88bac98761eea356d4c866fd6528878f3db7ee631a6f193289e93925e6cd71bf652a636d8548cf98dd7e2db7f28717b9192eaa9d
-  data.tar.gz: da02fd9b215b7045cc9fdb9cab0ba34d1be5bc6fcf1dc4ba708a1d848cfc88c7bf6ca4eef284ab9ba7c733d5c67feb19a754f2ba20111eece2a376149b4dc82c
+  metadata.gz: 7f8461b3850835943925f23adf6fe69fc0ec9a05cd8785e31681679a3dbb87e17957d118003a6426fd2963641596e735cc84652eada6f257aeaba8e476c5f308
+  data.tar.gz: bb06eea03b236e50aa179bda90c04fe390f8485e8a3a8155584caeb1921c002361c46020a1f1a916ad381ad9f3847d2c7819082ff27260194530988f97f8670f

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format Fuubar
+--color

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
-  - 2.1.1
+  - 2.6.3
+before_install:
+  - gem update --system
+  - gem install bundler
 notifications:
   email: false

data/Gemfile

@@ -1,19 +1,18 @@
 source 'http://rubygems.org'
 
-gem 'mqtt', '~> 0.3', '>= 0.3.1'
-gem 'ansi', '~> 1.5', '>= 1.4'
-gem 'mongo','~> 2.0.0'
+gem 'mqtt', '~> 0.5', '>= 0.5'
+gem 'ansi', '~> 1.5', '>= 1.5'
+gem 'mongo','~> 2.0'
 
 group :development do
-  gem 'shoulda', '~> 3', '>= 3'
-  gem 'minitest', '~> 5.4', '>= 5'
-  gem 'yard', '~> 0.8', '>= 0.8.7'
-  gem 'rdoc', '~> 4.0', '>= 4.0'
-  gem 'bundler', '~> 1.0', '>= 1.0'
-  gem 'jeweler', '~> 2.0', '>= 2.0.1'
-  gem 'simplecov', '~> 0', '>= 0'
+  gem 'bundler', '~> 2.0'
+  gem 'jeweler', '~> 2.3'
+  gem 'yard', '>= 0.9.12'
+  gem 'simplecov', '>= 0.17'
 end
 
 group :test do
   gem 'rake'
-end
+  gem "rspec", '~> 3.8'
+  gem 'fuubar', '~> 2.4'
+end

data/README.md

@@ -2,11 +2,18 @@
 [![Build Status](https://travis-ci.org/nutella-framework/nutella_lib.rb.svg)](https://travis-ci.org/nutella-framework/nutella_lib.rb)
 
 # nutella_lib.rb
-nutella library for Ruby. Used mostly to create bots in Ruby.
+nutella library for Ruby
 
-# Getting started
+## Getting started
 Take a look at [basic-ruby-bot](https://github.com/nutella-framework/basic-ruby-bot) to see how to use nutella_lib to build a bot. 
 
-# Docs
+## Docs
 Check out the docs at [http://www.rubydoc.info/gems/nutella_lib](http://www.rubydoc.info/gems/nutella_lib)
 
+# Contributing
+1. Clone repo
+1. Bundle (`bundle`)
+1. Run tests (`rake`)
+1. Make changes
+1. Run tests (`rake test`)
+1. Open a PR

data/Rakefile

@@ -17,28 +17,20 @@ Jeweler::Tasks.new do |gem|
   gem.name = "nutella_lib"
   gem.homepage = "https://github.com/nutella-framework/nutella_lib.rb"
   gem.license = "MIT"
-  gem.summary = %Q{nutella protocol library for ruby}
-  gem.description = %Q{Implements the nutella protocol and exposes it natively to ruby developers}
+  gem.summary = %Q{nutella library for ruby}
+  gem.description = %Q{Implements the nutella protocol and exposes it natively}
   gem.email = "tebemis@gmail.com"
   gem.authors = ["Alessandro Gnoli"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-desc "Code coverage detail"
-task :simplecov do
-  ENV['COVERAGE'] = "true"
-  Rake::Task['test'].execute
-end
-
-task :default => :test
-
 require 'yard'
 YARD::Rake::YardocTask.new
+
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.4.27
+0.5.0

data/lib/nutella_lib/app_core.rb

@@ -1,9 +1,10 @@
 module Nutella
-
+  #  App-level APIs sub-module
   module App
 
     # Initializes this component as an application component
     # @param [String] broker_hostname
+    # @param [String] app_id
     # @param [String] component_id
     def self.init( broker_hostname, app_id, component_id )
       Nutella.app_id = app_id
@@ -12,6 +13,7 @@ module Nutella
       Nutella.resource_id = nil
       Nutella.mongo_host = broker_hostname
       Nutella.mqtt = SimpleMQTTClient.new broker_hostname
+      
       # Start pinging
       Nutella.net.start_pinging
       # Fetch the `run_id`s list for this application and subscribe to its updates

data/lib/nutella_lib/core.rb

@@ -1,10 +1,10 @@
 # This module is the wrapper around the whole nutella library.
 module Nutella
 
-
   # Initializes this component as a run component
-  # @param [String] run_id
   # @param [String] broker_hostname
+  # @param [String] app_id
+  # @param [String] run_id
   # @param [String] component_id
   def self.init( broker_hostname, app_id, run_id, component_id )
     @app_id = app_id
@@ -17,7 +17,6 @@ module Nutella
     Nutella.net.start_pinging
   end
 
-
   # Variables accessors
   def self.app_id; @app_id end
   def self.run_id; @run_id end
@@ -45,16 +44,16 @@ module Nutella
   def self.mqtt=(val); @mqtt=val; end
   def self.ping_thread=(val); @ping_thread=val; end
 
-
-  # Accessors for sub-modules
+  # Accessors for app and framework sub-modules
   def self.app; Nutella::App; end
+  def self.f;   Nutella::Framework; end
+  # Accessors run-level sub-modules
   def self.net; Nutella::Net; end
   def self.log; Nutella::Log; end
   def self.persist; Nutella::Persist; end
 
 
-  # Utility functions
-
+  # Utility methods
 
   # Parse command line arguments for run level components
   #
@@ -85,8 +84,4 @@ module Nutella
     @resource_id = resource_id
   end
 
-end
-
-
-
-
+end

data/lib/nutella_lib/framework_core.rb

@@ -0,0 +1,47 @@
+module Nutella
+  #  Framework-level APIs sub-module
+  module Framework
+
+    # Initializes this component as a framework component
+    # @param [String] broker_hostname
+    # @param [String] component_id
+    def self.init( broker_hostname, component_id )
+      Nutella.app_id = nil
+      Nutella.run_id = nil
+      Nutella.component_id = component_id
+      Nutella.resource_id = nil
+      Nutella.mongo_host = broker_hostname
+      Nutella.mqtt = SimpleMQTTClient.new broker_hostname
+      # Start pinging
+      Nutella.net.start_pinging
+      # Fetch the `run_id`s list for this application and subscribe to its updates
+      net.async_request('app_runs_list', lambda { |res| Nutella.app.app_runs_list = res })
+      self.net.subscribe('app_runs_list', lambda {|message, _| Nutella.app.app_runs_list = message })
+    end
+
+    # Accessors for sub-modules
+    def self.net; Nutella::Framework::Net; end
+    def self.log; Nutella::Framework::Log; end
+    def self.persist; Nutella::Framework::Persist; end
+
+
+    # Utility functions
+
+    # Extracts the component name from the folder where the code for this component is located
+    #
+    # @return [String] the component name
+    def self.extract_component_id
+      Nutella.extract_component_id
+    end
+
+    # Sets the resource id
+    #
+    # @param [String] resource_id the resource id (i.e. the particular instance of this component)
+    def self.set_resource_id( resource_id )
+      Nutella.set_resource_id resource_id
+    end
+
+
+  end
+
+end

data/lib/nutella_lib/framework_log.rb

@@ -0,0 +1,49 @@
+require 'ansi'
+
+module Nutella
+
+  module Framework
+
+    module Log
+
+      def self.debug(message, code=nil)
+        puts( ANSI.cyan + message + ANSI.reset )
+        Nutella.f.net.publish( 'logging', log_to_json(message, code, __method__) )
+        code
+      end
+
+      def self.info(message, code=nil)
+        puts( message )
+        Nutella.f.net.publish( 'logging', log_to_json(message, code, __method__) )
+        code
+      end
+
+      def self.success(message, code=nil)
+        puts( ANSI.green + message + ANSI.reset )
+        Nutella.f.net.publish( 'logging', log_to_json(message, code, __method__) )
+        code
+      end
+
+      def self.warn(message, code=nil)
+        puts( ANSI.yellow + message + ANSI.reset )
+        Nutella.f.net.publish( 'logging', log_to_json(message, code, __method__) )
+        code
+      end
+
+      def self.error(message, code=nil)
+        puts( ANSI.red + message + ANSI.reset )
+        Nutella.f.net.publish( 'logging', log_to_json(message, code, __method__) )
+        code
+      end
+
+      private
+
+      def self.log_to_json( message, code, level)
+        code.nil? ? {level: level, message: message} : {level: level, message: message, code: code}
+      end
+
+    end
+
+  end
+
+end