magic_mirror 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cf70f0e31e11fca22459e7960f5c953561b73dc
-  data.tar.gz: 781941ac1db3d9b076deb59960a4e86e0face783
+  metadata.gz: 99ae6ed2cd45562d4fe35027396c9fb97c71e35a
+  data.tar.gz: 9a94943f0ec1d9c6e59534a1653cef1aa5584dfc
 SHA512:
-  metadata.gz: b595cd0b4776e3181fb7bfd68c9d65b00b8e814928de0dd30c56b0bd5b9ac8e92141bcb40f5ab6782114ba68ecfae39a432931a54916304b638d68765d7e2665
-  data.tar.gz: ea30cb839bc94c180e75d882759b934a9950c67ab99178b30d31a88d53e4559c5dd9d6b453be500a0fb12b889e8fd94a8ae40489343ed70f54e2965a67f11104
+  metadata.gz: b44cbc8caa075fd22f931bea1ca149b99c0bd2b8a95d5e7577998b71c714a5dde15ffa7fa7e3394a6259cd68949b5418e5a71e97c9a68fc2c5382e74de394298
+  data.tar.gz: 5b8b356d1117ef8d273a2c54d9747e079cad042afa0eda612d82643aef108e14c547a879174285bc86d1ff5430d1c427342150a80333aae0053a0c90c3aa0f08

data/changelog

@@ -2,6 +2,15 @@
   TODO:  List off what features you'll be including at some point in the
 future.
 
+	- Test against port in use problem.
+
+  - How do you tell the host gem to just 'listen for commands' and idle there?
+    (so the reverse usage of trtl)
+    possible do a .join() on the sinatra thread?
+
+  - limitation:  Can only have one rendering display at a time *per computer*
+      > Solution: Clean up the output and make ports random
+
   - Bug:  If faye server goes offline for a second, and misses commands, then comes back online,
     the command_cache variable will be out of sync with that of the server
       > Solutions:  Javascript Function periodically checks in to see the
@@ -22,9 +31,15 @@ Currently:
 
 Finished:
 
+** 0.1.1 **
+
+  - Added command_cache#reset
+	- Silenced booting of servers and added own boot message
+
+
 ** 0.1.0 **
 
-- Changed API to Minimizing magic_mirror commands needed on the host gem
+	- Changed API to Minimizing magic_mirror commands needed on the host gem
 
 ** 0.0.2 **
   - got websockets online

data/lib/magic_mirror/command_cache.rb

@@ -7,5 +7,10 @@ module MagicMirror
       super
     end
 
+    def reset
+      self.clear
+      MagicMirror.mirror.speak_into("MagicMirror.clearCommandCache();")
+    end
+
   end
 end

data/lib/magic_mirror/mirror.rb

@@ -6,33 +6,58 @@ module MagicMirror
     end
 
     def init_servers!
-      threads = []
+      Thin::Logging.silent = true
+      print "\nActivating the Magic Mirror."
+
+      @threads = []
+
       # start sinatra
-      threads << start_sinatra
-      threads << start_faye
+      @threads << start_sinatra
+      @threads << start_faye
 
+      puts "\nThe Magic Mirror is Activated.  Navigate to http://127.0.0.1:4567"
       self
     end
 
     def start_sinatra
+      queue = Queue.new # allows waiting for sinatra boot
+      $stderr_backup = $stderr.dup
+      $stderr.reopen("/dev/null", "w")
+
       Thread.new {
-        SinatraSilver::App.run!
+        SinatraSilver::App.run! do |server|
+          queue.push("started") # tells caller thread to continue
+        end
       }
+
+      queue.pop # blocks until sinatra is booted
+      print "."
+
+      $stderr = $stderr_backup.dup
     end
 
     def start_faye
+      queue = Queue.new # allows waiting for sinatra boot
 
       Thread.new {
         bayeux = Faye::RackAdapter.new(:mount => '/faye', :timeout => 25)
         bayeux.listen(FAYE_PORT)
-        run bayeux
+        bayeux.run!
+        #run bayeux
       }
 
-      #wait_until_faye_is_up
+      #queue.pop # blocks until server is booted
+      wait_until_faye_is_up
+      print "."
+
     end
 
-    def get_faye_app
+    def command_cache
+      MagicMirror.command_cache
+    end
 
+    def command_cache=(value)
+      MagicMirror.command_cache = value
     end
 
     # sends messages through faye server to web interface
@@ -45,22 +70,22 @@ module MagicMirror
       begin
         Net::HTTP.post_form(uri, :message => message.to_json)
       rescue
-        puts "failed to send message to faye server and thus webclient"
+        $stderr.puts "failed to send message to faye server and thus webclient"
       end
 
     end
 
     def wait_until_faye_is_up
+      require 'net/http'
       while(true) do
         begin
-          uri = URI.parse("http://localhost:#{FAYE_PORT}/faye")
-          # Shortcut
+          uri = URI.parse("http://localhost:#{FAYE_PORT}/")
           response = Net::HTTP.get_response(uri)
         rescue
 
         end
-        sleep 1
-        break if response and response.code == 400 and response.body == "Bad request"
+        break if response and response.code == "404" and response.body == "Sure you're not looking for /faye ?"
+        sleep 0.1
       end
     end
 

data/lib/magic_mirror/sinatra_silver.rb

@@ -7,6 +7,12 @@ module SinatraSilver
     # set :views, MagicMirror.sinatra_root
     set :views, Proc.new { File.join(MagicMirror.sinatra_root, "lib", "views") }
     #set :public_folder, Proc.new { File.join(MagicMirror.sinatra_root, "lib", "views") }
+    #set :logging, false
+    set :logging, false
+
+    configure do
+      disable :logging
+    end
 
     get '/' do
       @command_cache = MagicMirror.command_cache.to_json

data/lib/magic_mirror/version.rb

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

data/talk.md

@@ -0,0 +1,57 @@
+## S1.0 What is magic_mirror?
+
+
+
+
+## S1.1 rails vs traditional programming
+
+Everyone here has probably heard of rails before.  
+Well Rails, Sinatra, Python's django... Flask...
+These are all ways of building GUI applications for
+  * Multiple Users
+  and in an
+  * MVC design pattern
+
+Now that I know rails, I'm happy with MVC.  
+It helps us keep our code organized and clean.  
+Though in some use cases, it slows us down.  
+Say, if you wanted your app to print the version number when /version is accessed.
+That should only take 4 lines of code, one after another, right?  
+But with MVC, we need to change 4 different files.  
+So MVC is good for some things.  
+But MVC isn't good for *all* things, I don't think that's a controversial statement.  
+
+So what if we just want to add a GUI to our existing command line app?
+Obviously our CLI apps aren't designed in the MVC pattern,
+so we can't just start copy/pasting things into a rails app.  
+And maybe we don't even want to put it on the web,
+we want to use the app exclusively from our own machine.  
+
+That's where magic_mirror comes in.  
+We simply add it as a dependency, and call MagicMirror.new() and pass in a root
+directory from which to serve our index view.  
+
+Of course we have to draw up an html file to serve as our GUI,
+but once that's done, you now have a GUI for your once gooey-less application.  
+
+So in principle, this is a pretty cool gem...
+
+
+## S2 What is magic_mirror... Specifically?
+
+So by now you're probably wondering what comprises this interesting gem.  
+Well magic_mirror is:
+  * A sinatra html/ web server (on thin)
+  * A Faye websocket server (on thin)
+  * A class variable that caches all commands sent through the websocket server
+    (The mirror if you will)
+
+## S3 How do you add magic_mirror to a project?
+
+To use magic_mirror, simply require the gem as a dependency and add a line
+`@mirror = MagicMirror.new(options)`
+As options, you must specify where your html assets live.  
+Then you can do `@mirror.init_servers!` to boot the web/ websocket servers.  
+
+
+## Lets do a hello world

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magic_mirror
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - TheNotary
@@ -159,6 +159,7 @@ files:
 - lib/views/index.erb
 - magic_mirror.gemspec
 - rspec
+- talk.md
 homepage: https://github.com/TheNotary/magic_mirror
 licenses:
 - MIT