mosca 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62212685e26483f954066a4aed24f593b1c76126
-  data.tar.gz: cab4daa5e94d3ddfdaa47bb825e91047466fb837
+  metadata.gz: cb5e5ed870c959777ce1d362f9d20d12df283979
+  data.tar.gz: b9cc31952645221be2a57aff70a0668622da5d04
 SHA512:
-  metadata.gz: c837f4511e7e5365698eaf38f3ebfafe9736e1b72149dc68d8b34b1ef1eef55951bd2cf242b52ffc93c080a2fd3331418d6e061aae35fcc551fcc9a20994a316
-  data.tar.gz: f99ac1972ad922a60f9f62b68edd90b838dde7831e13cb8eafbf05e935b8ba94c29c795f057bdc6a6a8058a9b8061ef272c61cbdb957179516252fbc689bf363
+  metadata.gz: 2eea2347c5c2ea015ed02a99e8ecf51bb9cb685dc0565a506992bb7eff13511233213aa8b1b1b39a27a499169cf5194ab449c689e0a4185358e039773ea962d3
+  data.tar.gz: 4fa10abd1bc6c7cfed3f6419543ac35ceb7d7dd98c347d65d1e87e80af9f9705fdfc6a8b14f0e3fe2e92231df85faa2240cb7bbbe107fdb0f25f7553aa11ef7a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mosca (0.0.4)
+    mosca (0.0.5)
       json (~> 1.8.1)
       mqtt (~> 0.3.0)
 

data/README.md

@@ -1,8 +1,4 @@
-[![Version     ](https://img.shields.io/gem/v/mosca.svg)](https://rubygems.org/gems/mosca)
-[![Dependency Status](https://gemnasium.com/ionia-corporation/mosca.svg)](https://gemnasium.com/ionia-corporation/mosca)
-[![Code Climate](https://codeclimate.com/github/ionia-corporation/mosca.png)](https://codeclimate.com/github/ionia-corporation/mosca)
-[![Build Status](https://img.shields.io/travis/ionia-corporation/mosca/master.svg)](https://travis-ci.org/ionia-corporation/mosca)
-[![Coverage    ](https://img.shields.io/codeclimate/coverage/github/ionia-corporation/mosca.svg)](https://codeclimate.com/github/ionia-corporation/mosca)
+[![Version     ](https://img.shields.io/gem/v/mosca.svg)](https://rubygems.org/gems/mosca) [![Dependency Status](https://gemnasium.com/ionia-corporation/mosca.svg)](https://gemnasium.com/ionia-corporation/mosca) [![Code Climate](https://codeclimate.com/github/ionia-corporation/mosca.png)](https://codeclimate.com/github/ionia-corporation/mosca) [![Build Status](https://img.shields.io/travis/ionia-corporation/mosca/master.svg)](https://travis-ci.org/ionia-corporation/mosca) [![Coverage    ](https://img.shields.io/codeclimate/coverage/github/ionia-corporation/mosca.svg)](https://codeclimate.com/github/ionia-corporation/mosca)
 
 
 # Mosca
@@ -22,7 +18,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install mosca
-    
+
 ## Usage
 
 ### Configure
@@ -34,6 +30,15 @@ You can configure the default timeout for response, and default mqtt broker.
   Mosca::Client.default_broker = "test.mosquitto.org"
 ```
 
+#### Environment variables
+
+The following environment variables are used when creating clients, so you can use something like dotenv to put them on a file:
+
+    MOSCA_BROKER
+    MOSCA_USER
+    MOSCA_PASS
+    MOSCA_TIMEOUT
+
 ### New instance
 
 ```ruby
@@ -45,7 +50,8 @@ You can configure the default timeout for response, and default mqtt broker.
 #### Single message
 
 ```ruby
-  client.publish "restart" # will be sent to topic /device/commands
+  client.publish "restart" # will be sent to topic /device/commands. Returns nil if timed out.
+  client.publish! "restart" # Raises Timeout::Error if timed out.
 ```
 
 #### Message with response
@@ -58,9 +64,9 @@ You can configure the default timeout for response, and default mqtt broker.
 ### Getting messages
 
 ```ruby
-  puts client.get # will wait up to Mosca.default_timeout (default 5) seconds. will return if no response comes.
-  
+  puts client.get # will wait up to Mosca.default_timeout (default 5) seconds. will return nil if no response comes.
   puts client.get timeout: 2, topic_in: "another_topic" # will wait up to 2 seconds for a response on the another_topic topic.
+  client.get! # Raises exception if timed out
 ```
 
 ###TO DO

data/lib/command_builder.rb

@@ -4,7 +4,7 @@ module CommandBuilder
   public
 
   def method_missing(method, *args)
-    json = full_hash(method, args.first).to_json
+    json = full_hash(method, *args).to_json
     client.publish json
   end
 
@@ -28,9 +28,9 @@ module CommandBuilder
     hash
   end
 
-  def full_hash method, args
-    command_default = process_command(method, args)
-    command_specific = specific_hash(method, args)
+  def full_hash method, *args
+    command_default = process_command(method, *args)
+    command_specific = specific_hash(method, *args)
     default_hash.merge(command_default).merge(command_specific)
   end
 

data/lib/mosca/client.rb

@@ -3,31 +3,40 @@ require 'json'
 require 'mosca/exceptions'
 
 module Mosca
-
   class Client
-
     class << self
       attr_accessor :default_broker, :default_timeout
     end
 
     self.default_broker = ENV["MOSCA_BROKER"] || "test.mosquitto.org"
-    self.default_timeout = 5
+    self.default_timeout = 5 || ENV["MOSCA_TIMEOUT"]
 
     attr_accessor :user, :pass, :topic_in, :topic_out, :broker, :topic_base, :client
 
     def initialize args = {}
-      options = default.merge(args)
-      attributes.each do |attribute|
-        send "#{attribute}=".to_sym, options[attribute]
+      @user = args[:user] || ENV["MOSCA_USER"]
+      @pass = args[:user] || ENV["MOSCA_PASS"]
+      @topic_in = args[:topic_in]
+      @topic_out = args[:topic_out]
+      @topic_base = args[:topic_base] || ""
+      @broker = args[:broker] || ENV["MOSCA_BROKER"] || self.class.default_broker
+      @client = args[:client] || MQTT::Client
+    end
+
+    def publish! message, params = {}
+      timeout(params) do
+        topic_out = params[:topic_out] || params[:topic] || @topic_out || Exceptions.raise_missing_topic
+        topic_in = params[:topic_in] || @topic_in
+        connection.subscribe full_topic(topic_in) if params[:response]
+        connection.publish full_topic(topic_out), message
+        params[:response] ? get(params) : message
       end
     end
 
-    def publish json, params = {}
-      topic_out = params[:topic_out] || params[:topic] || @topic_out || Exceptions.raise_missing_topic
-      topic_in = params[:topic_in] || @topic_in
-      connection.subscribe full_topic(topic_in) if params[:response]
-      connection.publish full_topic(topic_out), json
-      get(params) if params[:response]
+    def publish message, params = {}
+      publish! message, params
+    rescue Timeout::Error
+      nil
     end
 
     def get! params = {}
@@ -51,16 +60,6 @@ module Mosca
 
     private
 
-      def default
-        { topic_base: "",
-          broker: self.class.default_broker,
-          client: MQTT::Client }
-      end
-
-      def attributes
-        [:user, :pass, :topic_in, :topic_out, :topic_base, :broker, :client]
-      end
-
       def client_options
         {remote_host: @broker, username: @user, password: @pass}
       end
@@ -80,7 +79,7 @@ module Mosca
       end
 
       def timeout params
-        timeout = params[:timeout] || self.class.default_timeout
+        timeout = params[:timeout] || ENV["MOSCA_TIMEOUT"].to_i || self.class.default_timeout
         Timeout.timeout(timeout) do
           yield
         end

data/lib/mosca/version.rb

@@ -1,3 +1,3 @@
 module Mosca
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/mosca_spec.rb

@@ -25,9 +25,9 @@ describe Mosca::Client do
   end
 
   describe "publishing" do
-    it "uses topic_out to publish if it was specified, and publishes the desired message" do
+    it "uses topic_out to publish if it was specified, publishes the desired message and returns the message when successfully published" do
       expect(client).to receive(:publish).with(OUT,MESSAGE)
-      mosca.publish MESSAGE
+      expect(mosca.publish MESSAGE).to eq MESSAGE
     end
 
     it "can take a topic_out as argument when publishing" do
@@ -123,6 +123,37 @@ describe Mosca::Client do
       it "get returns nil" do
         expect(mosca.get).to be nil
       end
+
+      it "publish returns nil" do
+        expect(mosca.publish).to be nil
+      end
+
+      it "get! raises the timed out exception" do
+        expect(mosca.get!).to raise_error
+      end
+    end
+  end
+
+  describe "Environment variables" do
+    it "can set MOSCA_BROKER" do
+      ENV["MOSCA_BROKER"] = "broker"
+      expect(described_class.new.broker).to eq "broker"
+    end
+
+    it "can set MOSCA_USER" do
+      ENV["MOSCA_USER"] = "USER"
+      expect(described_class.new.user).to eq "USER"
+    end
+
+    it "can set MOSCA_PASS" do
+      ENV["MOSCA_PASS"] = "PASS"
+      expect(described_class.new.pass).to eq "PASS"
+    end
+
+    it "can set MOSCA_TIMEOUT" do
+      ENV["MOSCA_TIMEOUT"] = "3"
+      expect(Timeout).to receive(:timeout).with 3
+      mosca.get
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mosca
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Armando Andini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt