mosca 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cb5540c23079a910c9ecaaae0552ca1215fce85
-  data.tar.gz: 2877f69002dd959ee86df6d3674f12e34349bc6d
+  metadata.gz: 62212685e26483f954066a4aed24f593b1c76126
+  data.tar.gz: cab4daa5e94d3ddfdaa47bb825e91047466fb837
 SHA512:
-  metadata.gz: 2d3ae4b8afd6a651a7b2d08b20898964b6c68fc95cbbb33e09535e25a20f80059362c638a9e52d2ed13e7644f46795717b5c19b0a8b13941e397e689ef1ef9ac
-  data.tar.gz: f7505d90646a7d672ca05cd0fe59b1e79052b75d8267c9059336292cff0c4042eb08cc7682357f4022ad603bd54f47784ab277db599ed003e71f586f6b108ad4
+  metadata.gz: c837f4511e7e5365698eaf38f3ebfafe9736e1b72149dc68d8b34b1ef1eef55951bd2cf242b52ffc93c080a2fd3331418d6e061aae35fcc551fcc9a20994a316
+  data.tar.gz: f99ac1972ad922a60f9f62b68edd90b838dde7831e13cb8eafbf05e935b8ba94c29c795f057bdc6a6a8058a9b8061ef272c61cbdb957179516252fbc689bf363

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+  fast_finish: true
+env:
+  - CODECLIMATE_REPO_TOKEN=188526a5386ffb1697df439556a65c1f1ab2f7889da7452c04220432549248eb 

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_force.gemspec
+gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    mosca (0.0.4)
+      json (~> 1.8.1)
+      mqtt (~> 0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.4.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.1)
+    method_source (0.8.2)
+    mqtt (0.3.0)
+    multi_json (1.10.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  codeclimate-test-reporter
+  mosca!
+  pry
+  rake
+  rspec

data/README.md

@@ -0,0 +1,76 @@
+[![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
+
+A simple client for mqtt communication
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mosca'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mosca
+    
+## Usage
+
+### Configure
+
+You can configure the default timeout for response, and default mqtt broker.
+
+```ruby
+  Mosca::Client.default_timeout = 10 # 10 seconds
+  Mosca::Client.default_broker = "test.mosquitto.org"
+```
+
+### New instance
+
+```ruby
+  client = Mosca::Client.new user: "username", pass: "password", topic_in: "readings", topic_out: "commands", topic_base: "/device/"
+```
+
+### Publishing
+
+#### Single message
+
+```ruby
+  client.publish "restart" # will be sent to topic /device/commands
+```
+
+#### Message with response
+
+```ruby
+  response = client.publish "some_command", response: true, topic_in: "responses" # will publish and wait for a response on the /device/responses topic
+  
+```
+
+### 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 timeout: 2, topic_in: "another_topic" # will wait up to 2 seconds for a response on the another_topic topic.
+```
+
+###TO DO
+
+Readme not complete yet
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mosca.rb

@@ -1,105 +1,5 @@
-require 'mqtt'
-require 'json'
+require 'mosca/client'
+require 'mosca/exceptions'
 
-class Mosca
-  @@default_broker = "test.mosquitto.org"
-  @@default_timeout = 5
-  @@debug = false
-
-  attr_accessor :user, :pass, :topic_in, :topic_out, :broker, :topic_base, :client
-
-  def initialize params = {}
-    @user = params[:user]
-    @pass = params[:pass]
-    @topic_in = params[:topic_in]
-    @topic_out = params[:topic_out]
-    @topic_base = params[:topic_base] || ""
-    @broker = params[:broker] ||  @@default_broker
-    @client = params[:client] || MQTT::Client
-  end
-
-  def publish json, params = {}
-    connection do |c|
-      topic = params[:topic_out] || @topic_out
-      debug "[start publish] " + timestamp
-      c.subscribe(topic_base + topic_in) if params[:response]
-      c.publish(topic_base + topic,json)
-      debug "[end publish] " + timestamp
-      if params[:response]
-        return get(params.merge({connection: c}))
-      end
-    end
-  end
-
-  def get params = {}
-    response = {}
-    connection(params) do |c|
-      topic = params[:topic_in] || @topic_in
-      timeout = params[:timeout] || @@default_timeout
-      begin
-        Timeout.timeout(timeout) do
-          debug "[start get] " + timestamp
-          c.get(topic_base + topic) do |topic, message|
-            response = parse_response message
-            break
-          end
-          debug "[end get] " + timestamp
-        end
-      rescue
-      end
-    end
-    response
-  end
-
-  def self.default_broker= param
-    @@default_broker = param
-  end
-
-  def self.default_timeout= param
-    @@default_timeout = param
-  end
-
-  def self.debug= param
-    @@debug = param
-  end
-
-  private
-
-  def opts
-    {remote_host: @broker, username: @user, password: @pass}
-  end
-
-  def connection params = {}
-    if params[:connection]
-      yield params[:connection]
-    else
-      @client.connect(opts) do |c|
-        yield c
-      end
-    end
-  end
-
-  def parse_response response
-    if valid_json? response
-      response = JSON.parse response
-    end
-    response
-  end
-
-  def valid_json? json_
-    begin
-      JSON.parse(json_)
-      return true
-    rescue
-      return false
-    end
-  end
-
-  def debug message
-    puts message if @@debug
-  end
-
-  def timestamp
-    Time.new.to_f.to_s
-  end
+module Mosca
 end

data/lib/mosca/client.rb

@@ -0,0 +1,89 @@
+require 'mqtt'
+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
+
+    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]
+      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]
+    end
+
+    def get! params = {}
+      timeout(params) do
+        topic = params[:topic_in] || params[:topic] || @topic_in || Exceptions.raise_missing_topic
+        connection.get(full_topic topic) do |topic, message|
+          return parse_response message
+        end
+      end
+    end
+
+    def get params = {}
+      get! params
+    rescue Timeout::Error
+      nil
+    end
+
+    def full_topic topic_name
+      topic_base + topic_name
+    end
+
+    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
+
+      def connection
+        if @connection and @connection.connected?
+          @connection
+        else
+          @connection ||= @client.connect(client_options)
+        end
+      end
+
+      def parse_response response
+        JSON.parse response
+        rescue JSON::ParserError
+          response
+      end
+
+      def timeout params
+        timeout = params[:timeout] || self.class.default_timeout
+        Timeout.timeout(timeout) do
+          yield
+        end
+      end
+  end
+end

data/lib/mosca/exceptions.rb

@@ -0,0 +1,10 @@
+module Mosca
+  module Exceptions
+    class MissingTopic < StandardError
+    end
+
+    def self.raise_missing_topic
+      raise MissingTopic.new, "Publish or get was called without specifying topic."
+    end
+  end
+end

data/lib/mosca/version.rb

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

data/mosca.gemspec

@@ -19,6 +19,11 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency 'mqtt', '~> 0.2.0'
+  s.add_dependency 'mqtt', '~> 0.3.0'
   s.add_dependency 'json', '~> 1.8.1'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
 end

data/spec/client_double.rb

@@ -1,20 +1,23 @@
 class ClientDouble
+  attr_accessor :connected
   def connect *args
-    yield self
+    connected = true
+    self
   end
 
-  def publish topic, payload
+  def connected?
+    !! connected
+  end
+
+  def method_missing *args
 
   end
 
   def get topic, *args
-
     if topic == "json_in_topic"
       response = '{"a":123}'
-
     elsif topic == "json_array_in_topic"
       response = '["a",1,2]'
-
     else
       response = "response"
     end

data/spec/mosca_spec.rb

@@ -1,51 +1,128 @@
 require 'spec_helper'
 
-describe Mosca do
+describe Mosca::Client do
   OUT = "out_topic"
   IN = "in_topic"
-  Mosca.default_timeout = 200
+  MESSAGE = "test_message"
 
-  before do
-    @client_double = ClientDouble.new
-    @mosca = Mosca.new topic_out: OUT, topic_in: IN, client: @client_double
-    @test_message = "something"
-  end
+  let (:client) {
+    ClientDouble.new
+  }
+
+  let (:mosca) {
+    Mosca::Client.new topic_out: OUT, topic_in: IN, client: client
+  }
 
   it "has a default broker" do
-    @mosca.broker.should eq("test.mosquitto.org")
+    expect(mosca.broker).to eq("test.mosquitto.org")
   end
 
-  it "uses topic_out to publish if it was specified, and publishes the desired message" do
-    @client_double.should_receive(:publish).with(OUT,@test_message)
-    @mosca.publish @test_message
-  end
-  it "can take a topic_out as argument when publishing" do
-    new_out_topic = "other_out_topic"
-    @client_double.should_receive(:publish).with(new_out_topic,@test_message)
-    @mosca.publish @test_message, topic_out: new_out_topic
+  it "has attribute accessors" do
+    %w{user pass broker topic_in topic_out topic_base}.each do |attr|
+      expect(mosca).to respond_to(attr.to_sym)
+      expect(mosca).to respond_to("#{attr}=".to_sym)
+    end
   end
 
-  it "uses topic_in to get messages if it was specified" do
-    @client_double.should_receive(:get).with(IN)
-    @mosca.get
+  describe "publishing" do
+    it "uses topic_out to publish if it was specified, and publishes the desired message" do
+      expect(client).to receive(:publish).with(OUT,MESSAGE)
+      mosca.publish MESSAGE
+    end
+
+    it "can take a topic_out as argument when publishing" do
+      new_out_topic = "other_out_topic"
+      expect(client).to receive(:publish).with(new_out_topic,MESSAGE)
+      mosca.publish MESSAGE, topic_out: new_out_topic
+    end
+
+    it "should wait for a response on topic_in if it's specified" do
+      expect(client).to receive(:connect).once.and_call_original
+      expect(mosca.publish(MESSAGE, response: true)).to eq("response")
+    end
   end
 
-  it "can take a topic_in as argument when getting" do
-    new_in_topic = "other_in_topic"
-    @client_double.should_receive(:get).with(new_in_topic)
-    @mosca.get topic_in: new_in_topic
+  describe "subscribing" do
+    it "uses topic_in to get messages if it was specified" do
+      expect(client).to receive(:get).with(IN)
+      mosca.get
+    end
+
+    it "can take a topic_in as argument when getting" do
+      new_in_topic = "other_in_topic"
+      expect(client).to receive(:get).with(new_in_topic)
+      mosca.get topic_in: new_in_topic
+    end
+
+    it "will receive the message with get" do
+      expect(mosca.get).to eq("response")
+    end
   end
 
-  it "will receive the message with get" do
-    @mosca.get.should eq("response")
+  describe "parsing the incoming messages" do
+    it "gets a hash if the message was a JSON object" do
+      expect(mosca.get topic_in: "json_in_topic").to be_a Hash
+    end
+
+    it "gets an array if the message was a JSON array" do
+      expect(mosca.get topic_in: "json_array_in_topic").to be_a Array
+    end
+
+    it "gets plain text if the message aint JSON" do
+      expect(mosca.get topic_in: "plain_in_topic").to be_a String
+    end
   end
 
-  it "gets a hash if the message was a JSON object" do
-    @mosca.get(topic_in: "json_in_topic").should be_a(Hash)
+  describe "formatting the topic names" do
+    before do
+      mosca.topic_base = "/base/"
+    end
+
+    it "uses topic_base to form the full topic for publishing and receiving" do
+      expect(client).to receive(:get).with("/base/#{IN}")
+      expect(client).to receive(:publish).with("/base/#{OUT}", MESSAGE)
+      mosca.get
+      mosca.publish MESSAGE
+    end
   end
 
-  it "gets an array if the message was a JSON array" do
-    @mosca.get(topic_in: "json_array_in_topic").should be_a(Array)
+  describe "Exceptions raising" do
+    describe "raises MissingTopic" do
+      it "when publishing without topic" do
+        mosca.topic_out = nil
+        expect { mosca.publish "hi" }.to raise_error Mosca::Exceptions::MissingTopic
+      end
+
+      it "when getting without topic" do
+        mosca.topic_in = nil
+        expect { mosca.get }.to raise_error Mosca::Exceptions::MissingTopic
+      end
+    end
   end
 
+  describe "Timeout" do
+    it "has a default timeout of 5 seconds" do
+      expect(Mosca::Client.default_timeout).to eq(5)
+    end
+
+    it "can set a default timeout" do
+      described_class.default_timeout = 1
+      expect(described_class.default_timeout).to eq 1
+    end
+
+    it "calls timeout when getting a message" do
+      expect(Timeout).to receive(:timeout)
+      mosca.get
+    end
+
+    context "time runs out" do
+      before do
+        expect(Timeout).to receive(:timeout).and_raise Timeout::Error
+      end
+
+      it "get returns nil" do
+        expect(mosca.get).to be nil
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
-require 'pry'
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 require 'mosca'
-require 'json'
 require 'client_double'
+require 'pry'

metadata

@@ -1,51 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: mosca
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Armando Andini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple client for mqtt communication
 email: armando.andini@hotmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
 - lib/command_builder.rb
 - lib/mosca.rb
+- lib/mosca/client.rb
+- lib/mosca/exceptions.rb
 - lib/mosca/version.rb
 - mosca.gemspec
 - spec/client_double.rb
@@ -61,17 +125,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: MQTT messaging made easy