em-mqtt 0.0.3 → 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b69ccbdb1c77d893629063eb6b1dad7ba31b2a19
4
+ data.tar.gz: 8d976bd448ee6d79247cb57153722a716f8bf1ab
5
+ SHA512:
6
+ metadata.gz: 77873c2d327cb17e4b551162d766543479df3bf3284fb76ca105d41d47ca6bd454a34b58b22a474290ce497de8e53be3076bbc80b2b149421d6b0e08d34ac0ae
7
+ data.tar.gz: 3a9fdd5efcc5a74af4a93067f61e60297a18e3b08b20f1ac931a4ad3127088ae785dee6d56a2c97b3ec029b1f51742e1355f199f906e03d85372f7e5405ff80a
@@ -0,0 +1,22 @@
1
+ The MIT License (MIT)
2
+ =====================
3
+
4
+ Copyright (c) 2009-2013 Nicholas J Humfrey
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
data/NEWS.md ADDED
@@ -0,0 +1,17 @@
1
+ EventMachine MQTT NEWS
2
+ ======================
3
+
4
+
5
+ EventMachine MQTT Version 0.0.4 (2015-08-07)
6
+ --------------------------------------------
7
+
8
+ * Fix for using version 0.3 of MQTT gem
9
+ * Added support for client authentication
10
+ * Changed license from 'Ruby' to 'MIT'
11
+ * Various other fixes and improvements
12
+
13
+
14
+ EventMachine MQTT Version 0.0.1 (2012-02-04)
15
+ --------------------------------------------
16
+
17
+ * Initial Release.
@@ -11,7 +11,7 @@ Installing
11
11
  You may get the latest stable version from rubygems.org:
12
12
 
13
13
  $ gem install em-mqtt
14
-
14
+
15
15
  It depends upon the mqtt gem to perform packet parsing and serialising.
16
16
 
17
17
 
@@ -19,8 +19,8 @@ Synopsis
19
19
  --------
20
20
 
21
21
  require 'rubygems'
22
- require 'em-mqtt'
23
-
22
+ require 'em/mqtt'
23
+
24
24
  # Publish example
25
25
  EventMachine.run do
26
26
  c = ClientConnection.connect('test.mosquitto.org')
@@ -48,6 +48,12 @@ Resources
48
48
  * GitHub Project: http://github.com/njh/ruby-em-mqtt
49
49
  * Documentation: http://rubydoc.info/gems/em-mqtt/frames
50
50
 
51
+ License
52
+ -------
53
+
54
+ The em-mqtt gem is licensed under the terms of the MIT license.
55
+ See the file LICENSE for details.
56
+
51
57
 
52
58
  Contact
53
59
  -------
@@ -55,4 +61,3 @@ Contact
55
61
  * Author: Nicholas J Humfrey
56
62
  * Email: njh@aelius.com
57
63
  * Home Page: http://www.aelius.com/njh/
58
- * License: Distributes under the same terms as Ruby
@@ -4,33 +4,79 @@ class EventMachine::MQTT::ClientConnection < EventMachine::MQTT::Connection
4
4
 
5
5
  attr_reader :client_id
6
6
  attr_reader :keep_alive
7
- attr_reader :clean_start
8
- attr_reader :message_id
7
+ attr_reader :clean_session
8
+ attr_reader :username
9
+ attr_reader :password
10
+ attr_reader :packet_id
9
11
  attr_reader :ack_timeout
10
12
  attr_reader :timer
11
13
 
12
- # FIXME: change this to optionally take hash of options
13
- def self.connect(host=MQTT::DEFAULT_HOST, port=MQTT::DEFAULT_PORT, *args, &blk)
14
- EventMachine.connect( host, port, self, *args, &blk )
14
+ # Connect to an MQTT server
15
+ #
16
+ # Examples:
17
+ # ClientConnection.connect('localhost', 1883)
18
+ # ClientConnection.connect(:host => 'localhost', :username => 'user', :password => 'pass')
19
+ #
20
+ def self.connect(*args, &blk)
21
+ hash = {
22
+ :host => 'localhost',
23
+ :port => MQTT::DEFAULT_PORT
24
+ }
25
+
26
+ i = 0
27
+ args.each do |arg|
28
+ if arg.is_a?(Hash)
29
+ hash.merge!(arg)
30
+ else
31
+ if i == 0
32
+ hash[:host] = arg
33
+ elsif i == 1
34
+ hash[:port] = arg
35
+ end
36
+ i += 1
37
+ end
38
+ end
39
+
40
+ ::EventMachine.connect( hash.delete(:host), hash.delete(:port), self, hash, &blk )
15
41
  end
16
42
 
17
- def post_init
18
- super
19
- @state = :connecting
43
+ # Initialize connection
44
+ # @param args [Hash] Arguments for connection
45
+ # @option args [String] :client_id A unique identifier for this client
46
+ # @option args [Integer] :keep_alive How often to send keep-alive pings (in seconds)
47
+ # @option args [Boolean] :clean_session Start a clean session with server or resume old one (default true)
48
+ # @option args [String] :username Username to authenticate with the server
49
+ # @option args [String] :password Password to authenticate with the server
50
+ def initialize(args={})
20
51
  @client_id = MQTT::Client.generate_client_id
21
52
  @keep_alive = 10
22
- @clean_start = true
23
- @message_id = 0
53
+ @clean_session = true
54
+ @packet_id = 0
24
55
  @ack_timeout = 5
56
+ @username = nil
57
+ @password = nil
25
58
  @timer = nil
59
+
60
+ if args.is_a?(Hash)
61
+ args.each_pair do |k,v|
62
+ instance_variable_set("@#{k}", v)
63
+ end
64
+ end
65
+ end
66
+
67
+ def post_init
68
+ super
69
+ @state = :connecting
26
70
  end
27
71
 
28
72
  def connection_completed
29
- # Protocol name and version
73
+ # TCP socket established: send Connect packet
30
74
  packet = MQTT::Packet::Connect.new(
31
- :clean_start => @clean_start,
75
+ :client_id => @client_id,
76
+ :clean_session => @clean_session,
32
77
  :keep_alive => @keep_alive,
33
- :client_id => @client_id
78
+ :username => @username,
79
+ :password => @password
34
80
  )
35
81
 
36
82
  send_packet(packet)
@@ -71,11 +117,11 @@ class EventMachine::MQTT::ClientConnection < EventMachine::MQTT::Connection
71
117
  callback do
72
118
  send_packet(
73
119
  MQTT::Packet::Publish.new(
120
+ :id => next_packet_id,
74
121
  :qos => qos,
75
122
  :retain => retain,
76
123
  :topic => topic,
77
- :payload => payload,
78
- :message_id => @message_id.next
124
+ :payload => payload
79
125
  )
80
126
  )
81
127
  end
@@ -87,8 +133,8 @@ class EventMachine::MQTT::ClientConnection < EventMachine::MQTT::Connection
87
133
  callback do
88
134
  send_packet(
89
135
  MQTT::Packet::Subscribe.new(
90
- :topics => topics,
91
- :message_id => @message_id.next
136
+ :id => next_packet_id,
137
+ :topics => topics
92
138
  )
93
139
  )
94
140
  end
@@ -100,8 +146,8 @@ class EventMachine::MQTT::ClientConnection < EventMachine::MQTT::Connection
100
146
  callback do
101
147
  send_packet(
102
148
  MQTT::Packet::Unsubscribe.new(
103
- :topics => topics,
104
- :message_id => @message_id.next
149
+ :id => next_packet_id,
150
+ :topics => topics
105
151
  )
106
152
  )
107
153
  end
@@ -147,4 +193,8 @@ private
147
193
  set_deferred_success
148
194
  end
149
195
 
196
+ def next_packet_id
197
+ @packet_id += 1
198
+ end
199
+
150
200
  end
@@ -36,6 +36,7 @@ class EventMachine::MQTT::Connection < EventMachine::Connection
36
36
  @last_received = Time.now
37
37
  process_packet(@packet)
38
38
  @packet = nil
39
+ receive_data ''
39
40
  end
40
41
  end
41
42
 
@@ -6,7 +6,7 @@ class EventMachine::MQTT::ServerConnection < EventMachine::MQTT::Connection
6
6
  attr_accessor :client_id
7
7
  attr_accessor :last_packet
8
8
  attr_accessor :keep_alive
9
- attr_accessor :message_id
9
+ attr_accessor :packet_id
10
10
  attr_accessor :subscriptions
11
11
 
12
12
  attr_reader :timer
@@ -21,7 +21,7 @@ class EventMachine::MQTT::ServerConnection < EventMachine::MQTT::Connection
21
21
  @state = :wait_connect
22
22
  @client_id = nil
23
23
  @keep_alive = 0
24
- @message_id = 0
24
+ @packet_id = 0
25
25
  @subscriptions = []
26
26
  @timer = nil
27
27
  logger.debug("TCP connection opened")
@@ -1,5 +1,5 @@
1
1
  module EventMachine
2
2
  module MQTT
3
- VERSION = "0.0.3"
3
+ VERSION = "0.0.4"
4
4
  end
5
5
  end
@@ -0,0 +1,23 @@
1
+ $:.unshift(File.dirname(__FILE__))
2
+
3
+ require 'spec_helper'
4
+
5
+ describe EventMachine::MQTT::Connection do
6
+
7
+ let(:signature) { double('signature') }
8
+ let(:subject) { EventMachine::MQTT::Connection.new(signature) }
9
+ let(:packet) { MQTT::Packet::Publish.new( :topic => 'test', :payload => 'hello world' ) }
10
+
11
+ describe "when receiving data" do
12
+ it "should parse packets" do
13
+ expect(subject).to receive(:process_packet).exactly(:once)
14
+ subject.receive_data packet.to_s
15
+ end
16
+
17
+ it "should handle multiple packets at once" do
18
+ expect(subject).to receive(:process_packet).exactly(:twice)
19
+ subject.receive_data [packet, packet].join
20
+ end
21
+ end
22
+
23
+ end
@@ -6,17 +6,16 @@ describe EventMachine::MQTT do
6
6
 
7
7
  describe "version number" do
8
8
  it "should be defined as a constant" do
9
- defined?(EventMachine::MQTT::VERSION).should == 'constant'
9
+ expect(defined?(EventMachine::MQTT::VERSION)).to eq('constant')
10
10
  end
11
11
 
12
12
  it "should be a string" do
13
- EventMachine::MQTT::VERSION.should be_a(String)
13
+ expect(EventMachine::MQTT::VERSION).to be_a(String)
14
14
  end
15
-
15
+
16
16
  it "should be in the format x.y.z" do
17
- EventMachine::MQTT::VERSION.should =~ /^\d{1,2}\.\d{1,2}\.\d{1,2}$/
17
+ expect(EventMachine::MQTT::VERSION).to match(/^\d{1,2}\.\d{1,2}\.\d{1,2}$/)
18
18
  end
19
-
20
- end
19
+ end
21
20
 
22
21
  end
metadata CHANGED
@@ -1,153 +1,158 @@
1
- --- !ruby/object:Gem::Specification
1
+ --- !ruby/object:Gem::Specification
2
2
  name: em-mqtt
3
- version: !ruby/object:Gem::Version
4
- prerelease: false
5
- segments:
6
- - 0
7
- - 0
8
- - 3
9
- version: 0.0.3
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.4
10
5
  platform: ruby
11
- authors:
6
+ authors:
12
7
  - Nicholas J Humfrey
13
8
  autorequire:
14
9
  bindir: bin
15
10
  cert_chain: []
16
-
17
- date: 2013-04-10 00:00:00 +01:00
18
- default_executable:
19
- dependencies:
20
- - !ruby/object:Gem::Dependency
21
- type: :runtime
22
- version_requirements: &id001 !ruby/object:Gem::Requirement
23
- requirements:
24
- - - ">="
25
- - !ruby/object:Gem::Version
26
- segments:
27
- - 0
28
- version: "0"
11
+ date: 2015-08-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
29
14
  name: eventmachine
30
- requirement: *id001
31
- prerelease: false
32
- - !ruby/object:Gem::Dependency
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
33
20
  type: :runtime
34
- version_requirements: &id002 !ruby/object:Gem::Requirement
35
- requirements:
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
36
24
  - - ">="
37
- - !ruby/object:Gem::Version
38
- segments:
39
- - 0
40
- - 0
41
- - 8
42
- version: 0.0.8
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
43
28
  name: mqtt
44
- requirement: *id002
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 0.3.0
34
+ type: :runtime
45
35
  prerelease: false
46
- - !ruby/object:Gem::Dependency
47
- type: :development
48
- version_requirements: &id003 !ruby/object:Gem::Requirement
49
- requirements:
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
50
38
  - - ">="
51
- - !ruby/object:Gem::Version
52
- segments:
53
- - 1
54
- - 0
55
- - 14
56
- version: 1.0.14
39
+ - !ruby/object:Gem::Version
40
+ version: 0.3.0
41
+ - !ruby/object:Gem::Dependency
57
42
  name: bundler
58
- requirement: *id003
59
- prerelease: false
60
- - !ruby/object:Gem::Dependency
61
- type: :development
62
- version_requirements: &id004 !ruby/object:Gem::Requirement
63
- requirements:
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
64
45
  - - ">="
65
- - !ruby/object:Gem::Version
66
- segments:
67
- - 0
68
- - 7
69
- - 2
70
- version: 0.7.2
71
- name: yard
72
- requirement: *id004
73
- prerelease: false
74
- - !ruby/object:Gem::Dependency
46
+ - !ruby/object:Gem::Version
47
+ version: 1.5.0
75
48
  type: :development
76
- version_requirements: &id005 !ruby/object:Gem::Requirement
77
- requirements:
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
78
52
  - - ">="
79
- - !ruby/object:Gem::Version
80
- segments:
81
- - 0
82
- - 8
83
- - 7
84
- version: 0.8.7
53
+ - !ruby/object:Gem::Version
54
+ version: 1.5.0
55
+ - !ruby/object:Gem::Dependency
85
56
  name: rake
86
- requirement: *id005
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: 0.10.0
62
+ type: :development
87
63
  prerelease: false
88
- - !ruby/object:Gem::Dependency
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: 0.10.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: yard
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: 0.8.0
89
76
  type: :development
90
- version_requirements: &id006 !ruby/object:Gem::Requirement
91
- requirements:
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
92
80
  - - ">="
93
- - !ruby/object:Gem::Version
94
- segments:
95
- - 2
96
- - 6
97
- - 0
98
- version: 2.6.0
81
+ - !ruby/object:Gem::Version
82
+ version: 0.8.0
83
+ - !ruby/object:Gem::Dependency
99
84
  name: rspec
100
- requirement: *id006
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 3.0.0
90
+ type: :development
101
91
  prerelease: false
102
- description: This gem adds MQTT (Message Queue Telemetry Transport) protocol support to EventMachine.
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 3.0.0
97
+ - !ruby/object:Gem::Dependency
98
+ name: simplecov
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description: This gem adds MQTT (Message Queue Telemetry Transport) protocol support
112
+ to EventMachine.
103
113
  email: njh@aelius.com
104
- executables:
114
+ executables:
105
115
  - em-mqtt
106
116
  extensions: []
107
-
108
117
  extra_rdoc_files: []
109
-
110
- files:
111
- - README
112
- - COPYING
113
- - GPL
114
- - NEWS
115
- - lib/em/mqtt/client.rb.new.rb
118
+ files:
119
+ - LICENSE.md
120
+ - NEWS.md
121
+ - README.md
122
+ - bin/em-mqtt
123
+ - lib/em/mqtt.rb
116
124
  - lib/em/mqtt/client_connection.rb
117
125
  - lib/em/mqtt/connection.rb
118
126
  - lib/em/mqtt/server.rb
119
127
  - lib/em/mqtt/server_connection.rb
120
128
  - lib/em/mqtt/version.rb
121
- - lib/em/mqtt.rb
122
- has_rdoc: true
129
+ - spec/em_mqtt_connection_spec.rb
130
+ - spec/em_mqtt_version_spec.rb
123
131
  homepage: http://github.com/njh/ruby-em-mqtt
124
- licenses:
125
- - Ruby
132
+ licenses:
133
+ - MIT
134
+ metadata: {}
126
135
  post_install_message:
127
136
  rdoc_options: []
128
-
129
- require_paths:
137
+ require_paths:
130
138
  - lib
131
- required_ruby_version: !ruby/object:Gem::Requirement
132
- requirements:
139
+ required_ruby_version: !ruby/object:Gem::Requirement
140
+ requirements:
133
141
  - - ">="
134
- - !ruby/object:Gem::Version
135
- segments:
136
- - 0
137
- version: "0"
138
- required_rubygems_version: !ruby/object:Gem::Requirement
139
- requirements:
142
+ - !ruby/object:Gem::Version
143
+ version: '0'
144
+ required_rubygems_version: !ruby/object:Gem::Requirement
145
+ requirements:
140
146
  - - ">="
141
- - !ruby/object:Gem::Version
142
- segments:
143
- - 0
144
- version: "0"
147
+ - !ruby/object:Gem::Version
148
+ version: '0'
145
149
  requirements: []
146
-
147
150
  rubyforge_project:
148
- rubygems_version: 1.3.6
151
+ rubygems_version: 2.2.2
149
152
  signing_key:
150
- specification_version: 3
153
+ specification_version: 4
151
154
  summary: MQTT for EventMachine
152
- test_files:
155
+ test_files:
156
+ - spec/em_mqtt_connection_spec.rb
153
157
  - spec/em_mqtt_version_spec.rb
158
+ has_rdoc:
data/COPYING DELETED
@@ -1,56 +0,0 @@
1
- ruby-em-mqtt is copyrighted free software by Nicholas J Humfrey <njh@aelius.com>.
2
- You can redistribute it and/or modify it under either the terms of the GPL
3
- version 2 (see the file GPL), or the conditions below:
4
-
5
- 1. You may make and give away verbatim copies of the source form of the
6
- software without restriction, provided that you duplicate all of the
7
- original copyright notices and associated disclaimers.
8
-
9
- 2. You may modify your copy of the software in any way, provided that
10
- you do at least ONE of the following:
11
-
12
- a) place your modifications in the Public Domain or otherwise
13
- make them Freely Available, such as by posting said
14
- modifications to Usenet or an equivalent medium, or by allowing
15
- the author to include your modifications in the software.
16
-
17
- b) use the modified software only within your corporation or
18
- organization.
19
-
20
- c) give non-standard binaries non-standard names, with
21
- instructions on where to get the original software distribution.
22
-
23
- d) make other distribution arrangements with the author.
24
-
25
- 3. You may distribute the software in object code or binary form,
26
- provided that you do at least ONE of the following:
27
-
28
- a) distribute the binaries and library files of the software,
29
- together with instructions (in the manual page or equivalent)
30
- on where to get the original distribution.
31
-
32
- b) accompany the distribution with the machine-readable source of
33
- the software.
34
-
35
- c) give non-standard binaries non-standard names, with
36
- instructions on where to get the original software distribution.
37
-
38
- d) make other distribution arrangements with the author.
39
-
40
- 4. You may modify and include the part of the software into any other
41
- software (possibly commercial). But some files in the distribution
42
- are not written by the author, so that they are not under these terms.
43
-
44
- For the list of those files and their copying conditions, see the
45
- file LEGAL.
46
-
47
- 5. The scripts and library files supplied as input to or produced as
48
- output from the software do not automatically fall under the
49
- copyright of the software, but belong to whomever generated them,
50
- and may be sold commercially, and may be aggregated with this
51
- software.
52
-
53
- 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
54
- IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
55
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
56
- PURPOSE.
data/GPL DELETED
@@ -1,340 +0,0 @@
1
- GNU GENERAL PUBLIC LICENSE
2
- Version 2, June 1991
3
-
4
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
- 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
- Everyone is permitted to copy and distribute verbatim copies
7
- of this license document, but changing it is not allowed.
8
-
9
- Preamble
10
-
11
- The licenses for most software are designed to take away your
12
- freedom to share and change it. By contrast, the GNU General Public
13
- License is intended to guarantee your freedom to share and change free
14
- software--to make sure the software is free for all its users. This
15
- General Public License applies to most of the Free Software
16
- Foundation's software and to any other program whose authors commit to
17
- using it. (Some other Free Software Foundation software is covered by
18
- the GNU Library General Public License instead.) You can apply it to
19
- your programs, too.
20
-
21
- When we speak of free software, we are referring to freedom, not
22
- price. Our General Public Licenses are designed to make sure that you
23
- have the freedom to distribute copies of free software (and charge for
24
- this service if you wish), that you receive source code or can get it
25
- if you want it, that you can change the software or use pieces of it
26
- in new free programs; and that you know you can do these things.
27
-
28
- To protect your rights, we need to make restrictions that forbid
29
- anyone to deny you these rights or to ask you to surrender the rights.
30
- These restrictions translate to certain responsibilities for you if you
31
- distribute copies of the software, or if you modify it.
32
-
33
- For example, if you distribute copies of such a program, whether
34
- gratis or for a fee, you must give the recipients all the rights that
35
- you have. You must make sure that they, too, receive or can get the
36
- source code. And you must show them these terms so they know their
37
- rights.
38
-
39
- We protect your rights with two steps: (1) copyright the software, and
40
- (2) offer you this license which gives you legal permission to copy,
41
- distribute and/or modify the software.
42
-
43
- Also, for each author's protection and ours, we want to make certain
44
- that everyone understands that there is no warranty for this free
45
- software. If the software is modified by someone else and passed on, we
46
- want its recipients to know that what they have is not the original, so
47
- that any problems introduced by others will not reflect on the original
48
- authors' reputations.
49
-
50
- Finally, any free program is threatened constantly by software
51
- patents. We wish to avoid the danger that redistributors of a free
52
- program will individually obtain patent licenses, in effect making the
53
- program proprietary. To prevent this, we have made it clear that any
54
- patent must be licensed for everyone's free use or not licensed at all.
55
-
56
- The precise terms and conditions for copying, distribution and
57
- modification follow.
58
-
59
- GNU GENERAL PUBLIC LICENSE
60
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
-
62
- 0. This License applies to any program or other work which contains
63
- a notice placed by the copyright holder saying it may be distributed
64
- under the terms of this General Public License. The "Program", below,
65
- refers to any such program or work, and a "work based on the Program"
66
- means either the Program or any derivative work under copyright law:
67
- that is to say, a work containing the Program or a portion of it,
68
- either verbatim or with modifications and/or translated into another
69
- language. (Hereinafter, translation is included without limitation in
70
- the term "modification".) Each licensee is addressed as "you".
71
-
72
- Activities other than copying, distribution and modification are not
73
- covered by this License; they are outside its scope. The act of
74
- running the Program is not restricted, and the output from the Program
75
- is covered only if its contents constitute a work based on the
76
- Program (independent of having been made by running the Program).
77
- Whether that is true depends on what the Program does.
78
-
79
- 1. You may copy and distribute verbatim copies of the Program's
80
- source code as you receive it, in any medium, provided that you
81
- conspicuously and appropriately publish on each copy an appropriate
82
- copyright notice and disclaimer of warranty; keep intact all the
83
- notices that refer to this License and to the absence of any warranty;
84
- and give any other recipients of the Program a copy of this License
85
- along with the Program.
86
-
87
- You may charge a fee for the physical act of transferring a copy, and
88
- you may at your option offer warranty protection in exchange for a fee.
89
-
90
- 2. You may modify your copy or copies of the Program or any portion
91
- of it, thus forming a work based on the Program, and copy and
92
- distribute such modifications or work under the terms of Section 1
93
- above, provided that you also meet all of these conditions:
94
-
95
- a) You must cause the modified files to carry prominent notices
96
- stating that you changed the files and the date of any change.
97
-
98
- b) You must cause any work that you distribute or publish, that in
99
- whole or in part contains or is derived from the Program or any
100
- part thereof, to be licensed as a whole at no charge to all third
101
- parties under the terms of this License.
102
-
103
- c) If the modified program normally reads commands interactively
104
- when run, you must cause it, when started running for such
105
- interactive use in the most ordinary way, to print or display an
106
- announcement including an appropriate copyright notice and a
107
- notice that there is no warranty (or else, saying that you provide
108
- a warranty) and that users may redistribute the program under
109
- these conditions, and telling the user how to view a copy of this
110
- License. (Exception: if the Program itself is interactive but
111
- does not normally print such an announcement, your work based on
112
- the Program is not required to print an announcement.)
113
-
114
- These requirements apply to the modified work as a whole. If
115
- identifiable sections of that work are not derived from the Program,
116
- and can be reasonably considered independent and separate works in
117
- themselves, then this License, and its terms, do not apply to those
118
- sections when you distribute them as separate works. But when you
119
- distribute the same sections as part of a whole which is a work based
120
- on the Program, the distribution of the whole must be on the terms of
121
- this License, whose permissions for other licensees extend to the
122
- entire whole, and thus to each and every part regardless of who wrote it.
123
-
124
- Thus, it is not the intent of this section to claim rights or contest
125
- your rights to work written entirely by you; rather, the intent is to
126
- exercise the right to control the distribution of derivative or
127
- collective works based on the Program.
128
-
129
- In addition, mere aggregation of another work not based on the Program
130
- with the Program (or with a work based on the Program) on a volume of
131
- a storage or distribution medium does not bring the other work under
132
- the scope of this License.
133
-
134
- 3. You may copy and distribute the Program (or a work based on it,
135
- under Section 2) in object code or executable form under the terms of
136
- Sections 1 and 2 above provided that you also do one of the following:
137
-
138
- a) Accompany it with the complete corresponding machine-readable
139
- source code, which must be distributed under the terms of Sections
140
- 1 and 2 above on a medium customarily used for software interchange; or,
141
-
142
- b) Accompany it with a written offer, valid for at least three
143
- years, to give any third party, for a charge no more than your
144
- cost of physically performing source distribution, a complete
145
- machine-readable copy of the corresponding source code, to be
146
- distributed under the terms of Sections 1 and 2 above on a medium
147
- customarily used for software interchange; or,
148
-
149
- c) Accompany it with the information you received as to the offer
150
- to distribute corresponding source code. (This alternative is
151
- allowed only for noncommercial distribution and only if you
152
- received the program in object code or executable form with such
153
- an offer, in accord with Subsection b above.)
154
-
155
- The source code for a work means the preferred form of the work for
156
- making modifications to it. For an executable work, complete source
157
- code means all the source code for all modules it contains, plus any
158
- associated interface definition files, plus the scripts used to
159
- control compilation and installation of the executable. However, as a
160
- special exception, the source code distributed need not include
161
- anything that is normally distributed (in either source or binary
162
- form) with the major components (compiler, kernel, and so on) of the
163
- operating system on which the executable runs, unless that component
164
- itself accompanies the executable.
165
-
166
- If distribution of executable or object code is made by offering
167
- access to copy from a designated place, then offering equivalent
168
- access to copy the source code from the same place counts as
169
- distribution of the source code, even though third parties are not
170
- compelled to copy the source along with the object code.
171
-
172
- 4. You may not copy, modify, sublicense, or distribute the Program
173
- except as expressly provided under this License. Any attempt
174
- otherwise to copy, modify, sublicense or distribute the Program is
175
- void, and will automatically terminate your rights under this License.
176
- However, parties who have received copies, or rights, from you under
177
- this License will not have their licenses terminated so long as such
178
- parties remain in full compliance.
179
-
180
- 5. You are not required to accept this License, since you have not
181
- signed it. However, nothing else grants you permission to modify or
182
- distribute the Program or its derivative works. These actions are
183
- prohibited by law if you do not accept this License. Therefore, by
184
- modifying or distributing the Program (or any work based on the
185
- Program), you indicate your acceptance of this License to do so, and
186
- all its terms and conditions for copying, distributing or modifying
187
- the Program or works based on it.
188
-
189
- 6. Each time you redistribute the Program (or any work based on the
190
- Program), the recipient automatically receives a license from the
191
- original licensor to copy, distribute or modify the Program subject to
192
- these terms and conditions. You may not impose any further
193
- restrictions on the recipients' exercise of the rights granted herein.
194
- You are not responsible for enforcing compliance by third parties to
195
- this License.
196
-
197
- 7. If, as a consequence of a court judgment or allegation of patent
198
- infringement or for any other reason (not limited to patent issues),
199
- conditions are imposed on you (whether by court order, agreement or
200
- otherwise) that contradict the conditions of this License, they do not
201
- excuse you from the conditions of this License. If you cannot
202
- distribute so as to satisfy simultaneously your obligations under this
203
- License and any other pertinent obligations, then as a consequence you
204
- may not distribute the Program at all. For example, if a patent
205
- license would not permit royalty-free redistribution of the Program by
206
- all those who receive copies directly or indirectly through you, then
207
- the only way you could satisfy both it and this License would be to
208
- refrain entirely from distribution of the Program.
209
-
210
- If any portion of this section is held invalid or unenforceable under
211
- any particular circumstance, the balance of the section is intended to
212
- apply and the section as a whole is intended to apply in other
213
- circumstances.
214
-
215
- It is not the purpose of this section to induce you to infringe any
216
- patents or other property right claims or to contest validity of any
217
- such claims; this section has the sole purpose of protecting the
218
- integrity of the free software distribution system, which is
219
- implemented by public license practices. Many people have made
220
- generous contributions to the wide range of software distributed
221
- through that system in reliance on consistent application of that
222
- system; it is up to the author/donor to decide if he or she is willing
223
- to distribute software through any other system and a licensee cannot
224
- impose that choice.
225
-
226
- This section is intended to make thoroughly clear what is believed to
227
- be a consequence of the rest of this License.
228
-
229
- 8. If the distribution and/or use of the Program is restricted in
230
- certain countries either by patents or by copyrighted interfaces, the
231
- original copyright holder who places the Program under this License
232
- may add an explicit geographical distribution limitation excluding
233
- those countries, so that distribution is permitted only in or among
234
- countries not thus excluded. In such case, this License incorporates
235
- the limitation as if written in the body of this License.
236
-
237
- 9. The Free Software Foundation may publish revised and/or new versions
238
- of the General Public License from time to time. Such new versions will
239
- be similar in spirit to the present version, but may differ in detail to
240
- address new problems or concerns.
241
-
242
- Each version is given a distinguishing version number. If the Program
243
- specifies a version number of this License which applies to it and "any
244
- later version", you have the option of following the terms and conditions
245
- either of that version or of any later version published by the Free
246
- Software Foundation. If the Program does not specify a version number of
247
- this License, you may choose any version ever published by the Free Software
248
- Foundation.
249
-
250
- 10. If you wish to incorporate parts of the Program into other free
251
- programs whose distribution conditions are different, write to the author
252
- to ask for permission. For software which is copyrighted by the Free
253
- Software Foundation, write to the Free Software Foundation; we sometimes
254
- make exceptions for this. Our decision will be guided by the two goals
255
- of preserving the free status of all derivatives of our free software and
256
- of promoting the sharing and reuse of software generally.
257
-
258
- NO WARRANTY
259
-
260
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
- FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
- OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
- PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
- OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
- MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
- TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
- PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
- REPAIR OR CORRECTION.
269
-
270
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
- WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
- REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
- INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
- OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
- TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
- YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
- PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
- POSSIBILITY OF SUCH DAMAGES.
279
-
280
- END OF TERMS AND CONDITIONS
281
-
282
- How to Apply These Terms to Your New Programs
283
-
284
- If you develop a new program, and you want it to be of the greatest
285
- possible use to the public, the best way to achieve this is to make it
286
- free software which everyone can redistribute and change under these terms.
287
-
288
- To do so, attach the following notices to the program. It is safest
289
- to attach them to the start of each source file to most effectively
290
- convey the exclusion of warranty; and each file should have at least
291
- the "copyright" line and a pointer to where the full notice is found.
292
-
293
- <one line to give the program's name and a brief idea of what it does.>
294
- Copyright (C) 19yy <name of author>
295
-
296
- This program is free software; you can redistribute it and/or modify
297
- it under the terms of the GNU General Public License as published by
298
- the Free Software Foundation; either version 2 of the License, or
299
- (at your option) any later version.
300
-
301
- This program is distributed in the hope that it will be useful,
302
- but WITHOUT ANY WARRANTY; without even the implied warranty of
303
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
- GNU General Public License for more details.
305
-
306
- You should have received a copy of the GNU General Public License
307
- along with this program; if not, write to the Free Software
308
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
-
310
-
311
- Also add information on how to contact you by electronic and paper mail.
312
-
313
- If the program is interactive, make it output a short notice like this
314
- when it starts in an interactive mode:
315
-
316
- Gnomovision version 69, Copyright (C) 19yy name of author
317
- Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
- This is free software, and you are welcome to redistribute it
319
- under certain conditions; type `show c' for details.
320
-
321
- The hypothetical commands `show w' and `show c' should show the appropriate
322
- parts of the General Public License. Of course, the commands you use may
323
- be called something other than `show w' and `show c'; they could even be
324
- mouse-clicks or menu items--whatever suits your program.
325
-
326
- You should also get your employer (if you work as a programmer) or your
327
- school, if any, to sign a "copyright disclaimer" for the program, if
328
- necessary. Here is a sample; alter the names:
329
-
330
- Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
- `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
-
333
- <signature of Ty Coon>, 1 April 1989
334
- Ty Coon, President of Vice
335
-
336
- This General Public License does not permit incorporating your program into
337
- proprietary programs. If your program is a subroutine library, you may
338
- consider it more useful to permit linking proprietary applications with the
339
- library. If this is what you want to do, use the GNU Library General
340
- Public License instead of this License.
data/NEWS DELETED
@@ -1,8 +0,0 @@
1
- EventMachine MQTT NEWS
2
- ======================
3
-
4
-
5
- EventMachine MQTT Version 0.0.1 (2012-02-04)
6
- --------------------------------------------
7
-
8
- * Initial Release.
@@ -1,96 +0,0 @@
1
- # Client class for talking to an MQTT broker
2
- class MQTT::Client
3
- attr_reader :remote_host # Hostname of the remote broker
4
- attr_reader :remote_port # Port number of the remote broker
5
- attr_accessor :keep_alive # Time (in seconds) between pings to remote broker
6
- attr_accessor :clean_start # Set the 'Clean Start' flag when connecting?
7
- attr_accessor :client_id # Client Identifier
8
- attr_accessor :ack_timeout # Number of seconds to wait for acknowledgement packets
9
-
10
- # Create a new MQTT Client instance
11
- def initialize(remote_host=MQTT::DEFAULT_HOST, remote_port=MQTT::DEFAULT_PORT)
12
- @remote_host = remote_host
13
- @remote_port = remote_port
14
- @keep_alive = 10
15
- @clean_start = true
16
- @client_id = nil
17
- @ack_timeout = 5
18
- @connection = nil
19
- end
20
-
21
- def self.connect(*args, &blk)
22
- self.new(*args).connect(&blk)
23
- end
24
-
25
- # Connect to the MQTT broker
26
- # A block must be given
27
- def connect
28
- #trap("INT") {EM.stop}
29
-
30
- EventMachine.run do
31
- @connection = MQTT::ClientConnection.connect(@remote_host, @remote_port)
32
-
33
- # Stuff happens here
34
- yield(self)
35
-
36
- # Disconnect once all the other deferred callbacks
37
- @connection.callback do
38
- disconnect
39
- end
40
-
41
- puts "Finished initing run"
42
- end
43
- end
44
-
45
- # Disconnect from the MQTT broker.
46
- # If you don't want to say goodbye to the broker, set send_msg to false.
47
- def disconnect(send_msg=true)
48
- @connection.disconnect(send_msg) unless @connection.nil?
49
- end
50
-
51
- # Checks whether the client is connected to the broker.
52
- def connected?
53
- # FIXME: check if connection is connected
54
- not @connection.nil?
55
- end
56
-
57
- # Publish a message on a particular topic to the MQTT broker.
58
- def publish(topic, payload, retain=false, qos=0)
59
- # FIXME: make sure @connection isn't nil
60
- @connection.publish(topic, payload, retain, qos=0)
61
- end
62
-
63
- # Send a subscribe message for one or more topics on the MQTT broker.
64
- # The topics parameter should be one of the following:
65
- # * String: subscribe to one topic with QOS 0
66
- # * Array: subscribe to multiple topics with QOS 0
67
- # * Hash: subscribe to multiple topics where the key is the topic and the value is the QOS level
68
- #
69
- # For example:
70
- # client.subscribe( 'a/b' )
71
- # client.subscribe( 'a/b', 'c/d' )
72
- # client.subscribe( ['a/b',0], ['c/d',1] )
73
- # client.subscribe( 'a/b' => 0, 'c/d' => 1 )
74
- #
75
- def subscribe(*topics)
76
- # FIXME: make sure @connection isn't nil
77
- @connection.subscribe(*topics)
78
- end
79
-
80
- # Return the next message recieved from the MQTT broker.
81
- # This method blocks until a message is available.
82
- #
83
- # The method returns the topic and message as an array:
84
- # topic,message = client.get
85
- #
86
- def get(*topics)
87
- # FIXME: implement this
88
- end
89
-
90
- # Send a unsubscribe message for one or more topics on the MQTT broker
91
- def unsubscribe(*topics)
92
- # FIXME: make sure @connection isn't nil
93
- @connection.unsubscribe(*topics)
94
- end
95
-
96
- end