beebotte 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a342811e6b3041aacf419ffa54d37bc9ff1904e
-  data.tar.gz: ca0f73eda5f8a58aa780dcb913ef52769b413e4c
+  metadata.gz: fd37c393fe2779c46d062e6d63e5857aef14b607
+  data.tar.gz: 5042564e8a7228df947b303bfe34665d884c4b20
 SHA512:
-  metadata.gz: bbea1488fbed398f5640f684ef9942a5a84f40bbac798685cd53de98ae24e62cebae1f24b45d4f03e53fef040eac57e393a824fa4f89500506bbefd308c5bcf2
-  data.tar.gz: fa588fa2d9acac1a8a5acfc220c69bb741afb5c726134a2f823363998933c5a08b59851e765072f1ab2e035de60e51bdadd6b37730ce80ed69d0a692aef1145d
+  metadata.gz: ee1382b295f31a6440f925e2b2153c17212e29c76d03cba9d594f92c3cdadb7553c6dc5dd831c77e7d77612e3cbe44b414050ad73b70a1f65000cd405ff0e912
+  data.tar.gz: 6c0de50a52d1ba9764f91267366b07c1c98861edebdb177055134faef10317f95578ea2dde89173abc276ec288d5becba00329b71507ab76c35464f16149d312

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2009-2013 Michael S. Kazmier
+
+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

@@ -2,10 +2,34 @@ Beebotte ruby gem
 =================
 
 
-THIS IS ALPHA SOFTWARE - USE AT YOUR OWN PERIL
+**THIS IS ALPHA SOFTWARE - USE AT YOUR OWN PERIL**
 
-Example usage:
---------------
+
+Basic Usage
+-----------
+
+Install the gem: `gem install beebotte`
+
+In your ruby code:
+```
+require 'beebotte'
+```
+
+
+There are two main classes: `Connector` and `Stream`.  The Connector class 
+implements the REST API and the Stream class implements the MQTT connection
+ to Beebotte.
+ 
+ Please see the Beebotte document here: https://beebotte.com/overview for 
+ more details on their implmentation.
+ 
+**Currently the Connector class only works with API and Secret key, Token 
+ authentication is not yet supported.**
+
+
+
+Full api examples:
+------------------------
 ```
 b = Beebotte::Connector.new("<yourApiKey>", "<yourSecretKey>", 'api.beebotte.com', 443)
 
@@ -50,6 +74,21 @@ b.get_resources(resource_name) {|r, code| puts "(#{code}) #{r.inspect}"}
 puts "\n\n---------\ndel_channel:"
 b.del_channel(channel_name) {|r, code| puts "(#{code}) #{r.inspect}"}
 
+
+
+
+s = Beebotte::Stream.new({token: "yourChannelToken"})
+s.connect()
+
+s.subscribe("#{channel_name}/#{resource_name}")
+
+s.publish(channel_name, resource_name, {status: 456})
+ 
+s.write(channel_name, resource_name, {status: 789})
+ 
+s.get { |topic, message| puts "\n\nTopic: #{topic}\nMessage: #{message}" }
+
+
 ```
 
 TODO:
@@ -58,4 +97,8 @@ TODO:
 1. Testing
 1. Token authentication for REST API
 1. Bulk API
-1. Stream API
+
+License
+-------
+
+The Beebotte ruby gem is licensed under the terms of the MIT license. See the file LICENSE for details.

data/beebotte.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'openssl'
   spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'rest-client', '>= 2.0.0'
+  spec.add_runtime_dependency 'rest-client', '>= 1.8.0'
   spec.add_runtime_dependency 'classy_hash'
   spec.add_runtime_dependency 'mqtt'
   spec.add_development_dependency "rspec"

data/lib/beebotte.rb

@@ -264,20 +264,19 @@ module Beebotte
 
   class Stream
     attr_accessor :token, :host, :port, :ssl
-    attr_reader :subsciptions
+    attr_reader :subscriptions
 
     class NotConnected < StandardError; end
     class NoSubscriptions < StandardError; end
 
     def initialize(opts = {})
       @token = opts[:token]
-      @apiKey = opts[:api_key]
       @secretKey = opts[:secret_key]
-      raise ArguementError, 'Must set token OR api_key and secret key' if (@token.nil? && (@apiKey.nil? || @secretKey.nil?))
+      raise ArguementError, 'Must set token OR secret_key in opts' if (@token.nil? && @secretKey.nil?)
       @host = opts[:host] || "mqtt.beebotte.com"
       @port = opts[:port] || 1883
       @ssl = opts[:ssl] || false
-      @subscrptions = []
+      @subscriptions = []
       @client = MQTT::Client.new
     end
 
@@ -290,6 +289,8 @@ module Beebotte
       @subscriptions = []
       if @token
         @client.username = "token:#{@token}"
+      else
+        @client.username = @secretKey
       end
       @client.connect()
       @client.connected?
@@ -298,6 +299,7 @@ module Beebotte
     def disconnect
       @subscriptions = []
       @client.disconnect()
+      true
     end
 
     def connected?

data/lib/beebotte/version.rb

@@ -1,3 +1,3 @@
 module Beebotte
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beebotte
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Kazmier
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: classy_hash
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,7 @@ files:
 - ".gitignore"
 - Gemfile
 - Guardfile
+- LICENSE.md
 - README.md
 - Rakefile
 - beebotte.gemspec