RubyGems - paho - Versions diffs - 0.0.1-java - Mend

paho 0.0.1-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

checksums.yaml +7 -0
data/.gitignore +12 -0
data/.rspec +2 -0
data/.travis.yml +6 -0
data/CODE_OF_CONDUCT.md +49 -0
data/Gemfile +6 -0
data/LICENSE.txt +21 -0
data/README.md +67 -0
data/Rakefile +6 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/certs/andreimaxim.pem +21 -0
data/lib/org/eclipse/paho/org.eclipse.paho.client.mqttv3/1.0.2/org.eclipse.paho.client.mqttv3-1.0.2.jar +0 -0
data/lib/paho.rb +17 -0
data/lib/paho/logging.rb +4 -0
data/lib/paho/processor/base.rb +29 -0
data/lib/paho/proxy.rb +128 -0
data/lib/paho/version.rb +3 -0
data/lib/paho_jars.rb +4 -0
data/paho.gemspec +36 -0
metadata +136 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8906f97e2ee05df5e70001f37cd6e1739c9c6d45
+  data.tar.gz: c9093bb1b61478e350e00d3300432dbad310b31d
+SHA512:
+  metadata.gz: 9378c01aeacdb7e75d9b2aadde3d2ec2cffd257a652308596f8bcc6169a7f75265256ded31535e0f62ad9c9eec92940f9bbdc8324de12a1c14c919cd8ba3aed6
+  data.tar.gz: 5f2d91641f111ede80eddad62d6ce543f036d3333be289b764cb8c5bc357c19f115d17ad61aa7dcb0c676893db1a955b0a6c126851594056f43ff12f42990097

data/.gitignore ADDED

@@ -0,0 +1,12 @@
+/.bundle/
+/.idea/
+/.mvn/
+/.ruby-version
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec ADDED

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

data/.travis.yml ADDED

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - jruby-1.7.24
+  - jruby-9.0.5.0
+before_install: gem install bundler -v 1.11.2
+cache: bundler

data/CODE_OF_CONDUCT.md ADDED

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+Examples of unacceptable behavior by participants include:
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile ADDED

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

data/LICENSE.txt ADDED

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2016 Andrei Maxim
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md ADDED

@@ -0,0 +1,67 @@
+[![Build Status](https://travis-ci.org/andreimaxim/paho-rb.svg?branch=master)](https://travis-ci.org/andreimaxim/paho-rb)
+[![Test Coverage](https://codeclimate.com/github/andreimaxim/paho-rb/badges/coverage.svg)](https://codeclimate.com/github/andreimaxim/paho-rb/coverage)
+[![Code Climate](https://codeclimate.com/github/andreimaxim/paho-rb/badges/gpa.svg)](https://codeclimate.com/github/andreimaxim/paho-rb)
+[![Dependency Status](https://gemnasium.com/andreimaxim/paho-rb.svg)](https://gemnasium.com/andreimaxim/paho-rb)
+# Paho
+The Eclipse Paho project provides a set of clients for the MQTT v3 protocol
+(C/C++, Java, JavaScript, Python, Go and .NET) which implement more advanced
+features, like asynchronous pub/sub or QoS 2.
+Unfortunately, there isn't an implementation specific for Ruby and the only
+Ruby gem that implements a similar client is Nicholas Humfrey's
+[ruby-mqtt][rubymqtt], which does not offer QoS 2.
+[rubymqtt]: https://github.com/njh/ruby-mqtt
+The aim of this project is to provide a Ruby interface for the Paho
+implementations (the Java client for JRuby and the C/C++ client for
+MRI/Rubinius).
+> This project is not associated in any way with the Eclipse Paho project
+## Installation
+> Currently the only supported platform is JRuby
+You may get the latest version from Rubygems:
+```bash
+$ gem install paho
+```
+You can also add it to your application's Gemfile:
+```ruby
+gem 'paho'
+```
+... and then execute `bundle` to install.
+## Usage
+Before going any further, it's important to mention that the Java library does
+not offer a synchronous client (the regular client actually implements
+`MqttAsyncClient`).
+```ruby
+processor = Paho::Processor::Base.new
+Paho::Proxy.subscribe(processor)
+```
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+## Contributing
+1. Fork it ( https://github.com/andreimaxim/paho/fork )
+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 a new Pull Request

data/Rakefile ADDED

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

data/bin/console ADDED

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "paho"
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+require "irb"
+IRB.start

data/bin/setup ADDED

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle install
+# Do any other automated setup that you need to do here

data/certs/andreimaxim.pem ADDED

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMQ8wDQYDVQQDDAZhbmRy
+ZWkxGzAZBgoJkiaJk/IsZAEZFgthbmRyZWltYXhpbTESMBAGCgmSJomT8ixkARkW
+AnJvMB4XDTE2MDMwMTA2NTgyNFoXDTE3MDMwMTA2NTgyNFowQjEPMA0GA1UEAwwG
+YW5kcmVpMRswGQYKCZImiZPyLGQBGRYLYW5kcmVpbWF4aW0xEjAQBgoJkiaJk/Is
+ZAEZFgJybzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMKG4jiyuIkj
+dKrb/FmDSZvCJ10A98JXZDSQZERIJtMactmcHfgYkXdpXfLH4gcbOyy9u3kh+uJx
+Z4VcOKMtOJYH/gC1fQWDV4Y5J5B39+qRMQQWf+YbNdmBYRI5S4JmXxjmbbW1hzaT
+hjl4omfcECpNQeF1xoIfD4xCd/8amNxV1LJenpAfGvxUt1RjbhBOCSw1GZ0HSZVG
+n2MMGPaok6ko2TKF/aC7sI3VoCPfTGJeYmEJ6vSoM8fkm9Zf8KA57x/pZdTJLigk
+OEjIidqFPOHqei2bTczc4st/9c//wEw16u/lIc1xMcyshR4Wupu+gLqZ0B4GOff7
+gNz7ys6nNUkCAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+BBYEFPkPDROvRN4YBVAUMbzaOEyxgnODMCAGA1UdEQQZMBeBFWFuZHJlaUBhbmRy
+ZWltYXhpbS5ybzAgBgNVHRIEGTAXgRVhbmRyZWlAYW5kcmVpbWF4aW0ucm8wDQYJ
+KoZIhvcNAQEFBQADggEBAHk/PaQhYVAjgPA51yJZcR2GK3xr8GrOtKULprQisvMS
+3LXdvtMqs18U08m9dWmzeB5ARKYTcm9lpaV6KhxoDjypZuOXX0u+vWYGEbgJhn3E
+MJc3QCX7909iy6o9RpCRKtPzeHMdeqKB7a9E+EF5Znzo/y1yUagLkk+LJCvE8G6Z
+rxYXd7bTvBpDLs8ns/HlgEckYxdYwXJPWLcNAI9p0rYTwF2kbs2ObxUEq/cuN1/9
+IygC46GdwYXnTJC2bZP9ArhJM/y+J/RMRHnFcE7FTaYI+vR7MGgsQrBbcvblgmf1
+CYTp6Bqdn1/GgGlPXiFwTVYLMpZnihZKdsDpQRSs8ak=
+-----END CERTIFICATE-----

data/lib/org/eclipse/paho/org.eclipse.paho.client.mqttv3/1.0.2/org.eclipse.paho.client.mqttv3-1.0.2.jar ADDED

Binary file

data/lib/paho.rb ADDED

@@ -0,0 +1,17 @@
+require 'paho/version'
+require 'paho_jars'   # Generated by jar-dependencies to autoload the jar files
+                      # so the require '<name>.jar' is no longer needed.
+module Paho
+  # Make the Java package available in the current module, which will act as a
+  # namespace. It should allow the code to call the Paho Java code like this:
+  #
+  #     Paho::MqttClient.new(uri, id, persist)
+  #
+  # ... where `MqttClient` is any kind of class or interface in the
+  # `org.eclipse.paho.client.mqttv3` package.
+  include_package 'org.eclipse.paho.client.mqttv3'
+end
+require 'paho/proxy'
+require 'paho/processor/base'

data/lib/paho/logging.rb ADDED

@@ -0,0 +1,4 @@
+module Paho
+  module Logging
+  end
+end

data/lib/paho/processor/base.rb ADDED

@@ -0,0 +1,29 @@
+module Paho
+  module Processor
+    class Base
+      TOPIC = '#'
+      def initialize
+        puts "Starting #{self.class.name} processor"
+      end
+      def topic
+        self.class::TOPIC
+      end
+      def __get(t, message)
+        log "Listening on #{topic} got [#{t}] #{message.toString}"
+        get(t, message.toString)
+      end
+      alias_method :messageArrived, :__get
+      private
+      def log(m)
+        puts "[Paho][Processor][#{self.class.name}]: #{m}"
+      end
+    end
+  end
+end

data/lib/paho/proxy.rb ADDED

@@ -0,0 +1,128 @@
+require 'singleton'
+module Paho
+  class Proxy
+    include Singleton
+    QOS = 2
+    LOCAL_MQTT = 'tcp://localhost:1883'
+    attr_accessor :topic
+    attr_accessor :qos
+    attr_accessor :processor
+    attr_reader :clients
+    class << self
+      def subscribe(processor, opts = {})
+        self.instance.subscribe(processor, opts)
+      end
+      def publisher
+        self.instance
+      end
+      def publish(topic, payload)
+        self.instance.publish(topic, payload)
+      end
+      def disconnect!
+        self.instance.disconnect!
+      end
+    end
+    def initialize
+      @clients = []
+    end
+    def connect!(opts = {})
+      if client.isConnected
+        true
+      else
+        client.connect(connection_options(opts))
+      end
+    end
+    # Subscribe to a topic.
+    #
+    # The required parameter has to respond to the messageArrived method.
+    #
+    # @param processor Paho::Processor An object that responds to the `topic` and `messageArrived` methods
+    def subscribe(processor, opts = {})
+      topic = processor.topic
+      client_id = id(topic)
+      qos = opts.delete(:qos) { QOS }
+      uri = opts.delete(:uri) { LOCAL_MQTT }
+      log "Creating new subscription for #{topic} with id #{client_id}"
+      c = Paho::MqttClient.new(uri, client_id, nil)
+      c.setCallback(processor)
+      c.connect(connection_options(opts))
+      c.subscribe(topic, qos)
+      log "Created new subscription for #{topic} with id #{client_id}"
+      @clients << c
+      true
+    rescue Java::OrgEclipsePahoClientMqttv3::MqttException => e
+      fail ArgumentError, e.message
+    end
+    # Publish an MQTT message on a topic
+    #
+    # @param topic String The topic to publish to
+    # @param payload String The contents of the message as a plain string
+    def publish(topic, payload)
+      connect!
+      message = Paho::MqttMessage.new
+      message.setQos 2
+      message.setPayload payload.to_s.to_java_bytes
+      message.setMutable false
+      log "Publishing to #{topic} #{payload}"
+      client.publish topic, message
+      log "Published to #{topic} #{payload}"
+    end
+    def client
+      @client ||= Paho::MqttClient.new("tcp://localhost:1883", id)
+    end
+    def disconnect!
+      client.disconnect if client.isConnected
+      @clients.each { |c| c.disconnect if c.isConnected }
+    end
+    private
+    # Generate an ID that is unique and repeatable for each machine. This is
+    # required in order to have the clean session flag work correctly.
+    #
+    # @param key String The key to use to generate the client ID.
+    def id(key = Socket.gethostname)
+      "paho-#{key.to_s.crypt('paho')}"
+    end
+    def connection_options(opts = {})
+      clean_session = opts.fetch(:clean_session) { true }
+      username = opts[:username]
+      password = opts[:password]
+      options = Paho::MqttConnectOptions.new
+      options.setCleanSession clean_session
+      options.setUserName(username) unless username.nil?
+      options.setPassword(password.to_java.toCharArray) unless password.nil?
+      options
+    end
+    def log(m)
+      puts m
+    end
+  end
+end

data/lib/paho/version.rb ADDED

@@ -0,0 +1,3 @@
+module Paho
+  VERSION = '0.0.1'
+end

data/lib/paho_jars.rb ADDED

@@ -0,0 +1,4 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+require 'jar_dependencies'
+require_jar( 'org.eclipse.paho', 'org.eclipse.paho.client.mqttv3', '1.0.2' )

data/paho.gemspec ADDED

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paho/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'paho'
+  spec.version       = Paho::VERSION
+  spec.authors       = ['Andrei Maxim']
+  spec.email         = ['[email protected]']
+  spec.homepage      = 'https://github.com/andreimaxim/paho-rb'
+  spec.license       = 'MIT'
+  spec.summary       = %q{Ruby MQTT client based on the Eclipse Paho components}
+  spec.description   = <<-EOF
+    paho-rb is a Ruby MQTT client that uses native bindings to the Eclipse
+    Paho components (Java or C/C++, based on the Ruby platform used).
+  EOF
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.platform      = 'java'
+  # spec.cert_chain  = ['certs/andreimaxim.pem']
+  # spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'ruby-maven', '~> 3.3'
+  spec.add_runtime_dependency 'jar-dependencies', '~> 0.3'
+  spec.requirements << 'jar org.eclipse.paho, org.eclipse.paho.client.mqttv3, 1.0.2'
+end

metadata ADDED

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: paho
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: java
+authors:
+- Andrei Maxim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  name: ruby-maven
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  name: jar-dependencies
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: |2
+      paho-rb is a Ruby MQTT client that uses native bindings to the Eclipse
+      Paho components (Java or C/C++, based on the Ruby platform used).
+email:
+- [email protected]
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- certs/andreimaxim.pem
+- lib/org/eclipse/paho/org.eclipse.paho.client.mqttv3/1.0.2/org.eclipse.paho.client.mqttv3-1.0.2.jar
+- lib/paho.rb
+- lib/paho/logging.rb
+- lib/paho/processor/base.rb
+- lib/paho/proxy.rb
+- lib/paho/version.rb
+- lib/paho_jars.rb
+- paho.gemspec
+homepage: https://github.com/andreimaxim/paho-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+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:
+- jar org.eclipse.paho, org.eclipse.paho.client.mqttv3, 1.0.2
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Ruby MQTT client based on the Eclipse Paho components
+test_files: []