nova 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98f99f8e3d4e94b3634e3881015900048f2d1565
-  data.tar.gz: 16f716c8f300fa1ed9d2ff472f0ca0e1ee6e97cc
+  metadata.gz: 11c2e75370d3f3ecf0bc62bd2f82a62f411cbdcc
+  data.tar.gz: a5e74b138bead7aece86bf1b769d6e79cc457732
 SHA512:
-  metadata.gz: e53c896e97cda1f47557f7cfa670af707175f2e13bddde1dbc9e3a0ca87daaf15f85ba15bbe943a7251cbbd73a9f7e9bb519fdfadeb833665989b03241480997
-  data.tar.gz: 4d46a1cfbc412411ffa75ed218c3cd4e907e6fdc8b63008fe7b3c78f15c0815fd7e1df5f81dcc16726c3bc9bc05f417e4f1509fc5277b16c40e190e62187b454
+  metadata.gz: 1d751e0be3c45d63d22c9e0169d80af621a281293715f6f483c0d002581218a2c04b46239c083b2f0ff9bcef281e7ce2b40e3ce6dea3b48f970daddac877ac47
+  data.tar.gz: 887e4091e028eba84f005fd8f1d446ad6814a19ee3e2674dcaeffc0fef51cb0a12de20af118644def845719345d950b142d97cbfd473150d21f198f2a8900a6e

data/lib/generator/template/new_install/Gemfile

@@ -0,0 +1 @@
+gem 'nova', '~> 0.1'

data/lib/generator/template/new_install/{supernova.yml → nova.yml}

@@ -1,7 +1,7 @@
 load_paths:
   - ./galaxy
 
-# If this is an array, every time we run +Nova server up+, multiple
+# If this is an array, every time we run +nova server up+, multiple
 # instances are created, each matching the values here.
 servers:
   - :name: tcp_server
@@ -10,7 +10,7 @@ servers:
     :port: 2010
   - :name: unix_server
     :type: :unix
-    :path: "./Nova.sock"
+    :path: "./nova.sock"
     :protocol:
       :allow_plaintext: true
 

data/lib/nova.rb

@@ -23,7 +23,9 @@ module Nova
     @logger ||= Logger.new(STDOUT)
   end
 
-  attr_writer :logger
+  class << self
+    attr_writer :logger
+  end
 
   # This creates a star with a given block, unless it already exists;
   # if it does, it just modifies that star.

data/lib/nova/commands/server.rb

@@ -12,7 +12,7 @@ module Nova
         :desc => "Which servers to run.  Empty means all.",
         :default => []
       long_desc <<-DESC
-      Runs servers defined in Nova.yml.  If the forgeground
+      Runs servers defined in nova.yml.  If the forgeground
       option is specified, the process is run in the foreground.
       Otherwise, it's ran as a daemon.  If the which parameter is
       specified, it only runs the servers that were specified.

data/lib/nova/common/event_handler.rb

@@ -97,9 +97,10 @@ module Nova
         # @return [Object] the result of the event.
         def run!(name, options = {})
           matched = has_event_with_options? name, options
+          new_options = Metadata::Options.new(options)
 
           if matched
-            matched.run(bind, options)
+            matched.run(bind, new_options)
           else
             raise NoEventError, "Could not find event #{name}."
           end

data/lib/nova/common/event_handler/event.rb

@@ -45,7 +45,7 @@ module Nova
         # @option options [Symbol] :on the platform the event
         #   is written for.  If this doesn't match the current
         #   platform, the event is never run.  Must be in the
-        #   results of {Remote::Fake::Platforms#platform} (or
+        #   results of {Remote::Fake::Platform#types} (or
         #   remote's definition of platform).  Can also be +:for+.
         # @option options [Symbol, Array<Symbol>] :requires
         #   what options the event requires when being run.  The

data/lib/nova/common/metadata.rb

@@ -1,4 +1,5 @@
 require 'nova/common/metadata/data'
+require 'nova/common/metadata/options'
 
 module Nova
   module Common
@@ -43,6 +44,7 @@ module Nova
 
         # Sets the options, validating them.
         def options=(options)
+          options = Options.new(options)
           @meta.validate_options! options
           @options = options
         end

data/lib/nova/common/metadata/data.rb

@@ -123,7 +123,7 @@ module Nova
         def validate_options!(options)
           keys = options.keys
 
-          unless (data[:required_options] - keys).empty?
+          unless (data[:required_options].map(&:to_s) - keys).empty?
             raise InvalidOptionsError, "Missing options " +
               "#{(data[:required_options] - keys).join(', ')}"
           end

data/lib/nova/common/metadata/options.rb

@@ -0,0 +1,71 @@
+module Nova
+  module Common
+    module Metadata
+
+      # Handles options that are passed to the module.
+      #
+      # @note This stores everything in a hash, and all keys within
+      #   hash are Strings, no matter what.
+      class Options < BasicObject
+
+        # Initialize the options class.
+        #
+        # @param data [Hash] the data to represent with this
+        #   class.
+        def initialize(data)
+          @_data = data
+          _clean_data
+        end
+
+        # Accessor for this class.  Returns the default value if the
+        # key does not exist.
+        #
+        # @param key [#to_s] the key to look up.
+        # @return [Object] the value.
+        def [](key)
+          fetch(key) { default(key.to_s) }
+        end
+
+        # Fetches the given key.  If it doesn't exist, uses the given
+        # default value or calls the block.
+        #
+        # @param key [#to_s] the key to look up.
+        # @param default_value [Object] the default object to return,
+        #   if the key doesn't exist in the table.
+        # @yieldparam key [String] the key that was looked up.
+        # @yieldreturn [Object] the value to use.
+        # @return [Object] the value of the key.
+        def fetch(key, *args, &block)
+          @_data.fetch(key.to_s, *args, &block)
+        end
+
+        # Forwards all methods to the hash. 
+        #
+        # @param method [Symbol] the method to forward.
+        # @param arguments [Array<Object>] the arguments for the
+        #   method.
+        # @return [Object]
+        def method_missing(method, *arguments, &block)
+          @_data.public_send(method, *arguments, &block)
+        end
+
+        private
+
+        # Cleans the data hash by forcing all keys to strings, and then
+        # freezes the newly created hash.
+        #
+        # @return [Hash]
+        def _clean_data
+          new_data = {}
+
+          @_data.each do |k, v|
+            new_data[k.to_s] = v
+          end
+
+          @_data = new_data.freeze
+        end
+
+      end
+    end
+  end
+end

data/lib/nova/common/star_management.rb

@@ -108,6 +108,19 @@ module Nova
             super
           end
         end
+
+        # Retrieves a star from a given target.  The target should be
+        # in the format +[<type>.]<star name>[.<action>]+.
+        #
+        # @param target [String] the target star.
+        # @return [nil, Class] nil if the star doesn't exist, the star
+        #   itself otherwise.
+        def from_target(target)
+          type, star_name, action = target.scan(%r{\A(?:([\w]+)\.)?([\w]+)(?:\.([\w]+?))?\z}).first
+
+          type ||= :star
+          stars[type.intern][star_name.intern]
+        end
       end
 
       # Instance methods.

data/lib/nova/project.rb

@@ -121,7 +121,7 @@ module Nova
         if File.exists?(server[:files][:pid])
           pid = File.open(server[:files][:pid], "r") { |f| f.read }.to_i
 
-          puts "Sending INT to #{pid}..."
+          print "Sending INT to #{pid}... "
 
           Process.kill :INT, pid rescue Errno::ESRCH
 
@@ -187,9 +187,9 @@ module Nova
           File.delete(server[:files][:pid]) rescue Errno::ENOENT
         end
 
-        return s.listen
+        s.listen
       rescue => e
-        Nova.logger.fatal { "#{e}: #{e.message}; #{e.backtrace[0]}" }
+        Nova.logger.fatal { "#{e}: #{e.message} => #{e.backtrace[0]}" }
         File.delete(server[:files][:pid]) rescue Errno::ENOENT
         exit
       end

data/lib/nova/remote.rb

@@ -1,10 +1,17 @@
+
+
 module Nova
+
+  # Classes to handle running commands on platforms.
   module Remote
 
-    autoload :Common, "nova/remote/common"
-    autoload :Fake, "nova/remote/fake"
-    autoload :Local, "nova/remote/local"
-    autoload :SSH, "nova/remote/ssh"
+    if ENV["NOVA_ENV"] == "testing"
+      require 'nova/remote/fake'
+    else
+      autoload :Fake, "nova/remote/fake"
+      #autoload :Local, "nova/remote/local"
+      #autoload :SSH, "nova/remote/ssh"
+    end
 
   end
 end

data/lib/nova/remote/local.rb

@@ -0,0 +1,7 @@
+module Nova
+  module Remote
+    class Local
+      
+    end
+  end
+end

data/lib/nova/shell.rb

@@ -0,0 +1,32 @@
+require 'irb'
+
+module Nova
+  class Shell
+
+    IRB_PROMPT = {
+      :AUTO_INDENT => true,
+      :PROMPT_I    => "nova[%03n] >> ",
+      :PROMPT_S    => "nova[%03n] %l> ",
+      :PROMPT_C    => "nova[%03n] %i> ",
+      :RETURN      => "nova <- %s\n"
+    }
+
+    def start_shell
+      IRB.setup __FILE__
+      IRB.conf[:PROMPT][:NOVA_PROMPT] = IRB_PROMPT
+      IRB.conf[:PROMPT_MODE] = :NOVA_PROMPT
+      irb = IRB::Irb.new(IRB::WorkSpace.new(binding))
+
+      IRB.conf[:MAIN_CONTEXT] = irb.context
+
+      trap("SIGINT") { irb.signal_handle }
+
+      begin
+        catch(:IRB_EXIT) { irb.eval_input }
+      ensure
+        IRB.irb_at_exit
+      end
+    end
+    
+  end
+end

data/lib/nova/starbound/default_behavior.rb

@@ -0,0 +1,26 @@
+require "nova/starbound/default_behavior/eventable"
+require "nova/starbound/default_behavior/passwordable"
+require "nova/starbound/default_behavior/star_runnable"
+require "nova/starbound/default_behavior/echoable"
+require "multi_json"
+
+module Nova
+  module Starbound
+    class DefaultBehavior
+
+      include Eventable
+      include Passwordable
+      include StarRunnable
+      include Echoable
+
+      # @!parse include Eventable::InstanceMethods
+      # @!parse extend Eventable::ClassMethods
+
+      # Initialize the class.
+      def initialize(protocol)
+        attach_events protocol
+      end
+
+    end
+  end
+end

data/lib/nova/starbound/default_behavior/echoable.rb

@@ -0,0 +1,28 @@
+module Nova
+  module Starbound
+    class DefaultBehavior
+      module Echoable
+        
+        # Called when this module is included into another module.
+        # Sets up the echo packet management.
+        #
+        # @param reciever [Module]
+        # @return [void]
+        def self.included(reciever)
+          reciever.handle :packet => :echo
+        end
+
+        private
+
+        # Handles the echo packet by responding to it with the same
+        # body that was sent.
+        #
+        # @return [void]
+        def handle_packet_echo(packet, protocol)
+          protocol.respond_to packet, :echo, packet.body
+        end
+
+      end
+    end
+  end
+end

data/lib/nova/starbound/default_behavior/eventable.rb

@@ -0,0 +1,87 @@
+module Nova
+  module Starbound
+    class DefaultBehavior
+
+      # Handles events such as packets.
+      module Eventable
+
+        # Class methods.
+        module ClassMethods
+          
+          # Defines how to handle a specific type of packet.  The
+          # method of handling a packet can be defined in 3 ways:
+          # first, if a method name (second argument) is given, 
+          # that method is used to handle the packet.  Second, if
+          # a block is given, that block is used.  And last, if
+          # neither of them are provided, the method name is assumed
+          # from the struct type and packet type in the format
+          # +handle_<struct>_<packet>+.  The given method can and
+          # should be private.
+          #
+          # @note If a block isn't used, the method should accept two
+          #   arguments (see yield params for the arguments).
+          # @param type [Hash<Symbol, Symbol>] a single key-value pair,
+          #   with the key being the struct type and the value being
+          #   the packet type.
+          # @param meth [nil, Symbol] the method name to use when
+          #   calling a block.
+          # @yieldparam packet [Protocol::Packet] the packet.
+          # @yieldparam protocol [Protocol] the protocol.
+          # @return [void]
+          def handle(type, meth = nil, &block)
+            struct = type.keys.first
+            packet = type.values.first
+
+            proc = nil
+
+            if meth
+              proc = meth
+            elsif block_given?
+              proc = block
+            else
+              proc = :"handle_#{struct}_#{packet}"
+            end
+
+            handles[{struct => packet}] = proc
+          end
+
+          # The handles for events that are defined on this class.
+          #
+          # @return [Hash]
+          def handles
+            @handles ||= {}
+          end
+
+        end
+        
+        # Instance methods.
+        module InstanceMethods
+
+          # Attaches the specified events to the protocol.
+          #
+          # @return [void]
+          def attach_events(protocol)
+            self.class.handles.each do |k, v|
+              if v.is_a? Symbol
+                protocol.on(k, &method(v))
+              else
+                protocol.on(k, &v)
+              end
+            end
+          end
+          
+        end
+        
+        # Called when this module is included by a module or class.
+        # Extends that module or class by {ClassMethods}, and includes
+        # {InstanceMethods} into that class.
+        #
+        # @return [void]
+        def self.included(receiver)
+          receiver.extend         ClassMethods
+          receiver.send :include, InstanceMethods
+        end
+      end
+    end
+  end
+end

data/lib/nova/starbound/default_behavior/passwordable.rb

@@ -0,0 +1,75 @@
+module Nova
+  module Starbound
+    class DefaultBehavior
+
+      # Handles passwords with the default behavior.
+      module Passwordable
+        
+        # The current password.  If it's nil, any password works; if
+        # it's an empty string, no password works; and if it's a
+        # string, only passwords matching that string works.
+        #
+        # @return [nil, String]
+        attr_writer :password
+
+        # Checks to see if the given password is valid.  Returns
+        # false if it isn't, true if it is.
+        #
+        # @param pass [String] the password to check.
+        # @return [Boolean]
+        def valid_password?(pass)
+          if password.nil? || (pass == password && password != "")
+            true
+          else
+            false
+          end
+        end
+
+        # Checks to see if the given password is valid.  If it is, it
+        # sets authenticated to true.  Otherwise, sets it to false.
+        #
+        # @param pass [String] the password to check.
+        # @return [Boolean]
+        def check_password(pass)
+          @authenticated = valid_password? pass
+        end
+
+        # Whether or not it was authenticated.
+        #
+        # @return [Boolean]
+        def authenticated?
+          @authenticated
+        end
+
+        private
+
+        # Handles the password packet, by checking the password.  If it
+        # matches, it returns an "OK" packet.  Otherwise, it returns a
+        # "FAIL" packet.
+        #
+        # @param packet [Protocol::Packet] the packet that the client sent.
+        # @param proto [Protocol] the protocol used to communicate
+        #   with the client.
+        # @return [void]
+        def handle_packet_password(packet, proto)
+          if reciever.check_password packet.body
+            proto.respond_to packet, :password, "OK"
+          else
+            proto.respond_to packet, :password, "FAIL"
+          end
+        end
+
+        public
+
+        # When this is included by {DefaultBehavior}, define the
+        # packets nessicary for password management.
+        #
+        # @return [void]
+        def self.included(reciever)
+          reciever.handle :packet => :password
+        end
+
+      end
+    end
+  end
+end

data/lib/nova/starbound/default_behavior/star_runnable.rb

@@ -0,0 +1,61 @@
+module Nova
+  module Starbound
+    class DefaultBehavior
+
+      # Handles running stars.
+      module StarRunnable
+        
+        # Runs the star with the given information.
+        #
+        # @param target [String] the target to originate the star to
+        #   run from.
+        # @param data [Hash] the data to pass to the event.
+        # @return [Boolean] if it was successful.
+        def run_star(target, data)
+          return false unless authenticated?
+          star = Star.from_target target
+
+          return false unless star
+          inst = star.new Remote::Local
+          inst.options = data["options"]
+          out = inst.run(target.split('.').last, data["arguments"])
+
+          if out.is_a? NoEventError
+            return false
+          else
+            return true
+          end
+        end
+
+        private
+
+        # Handles an incoming packet request for handling stars.
+        #
+        # @param packet [Protocol::Packet] the packet to handle.
+        # @param protocol [Protocol] the protocol.
+        # @return [void]
+        def handle_packet_star_run(packet, protocol)
+          raw = MultiJson.load packet.body
+
+          if raw["target"] && run_star(raw["target"], raw)
+          else
+            protocol.respond_to packet, :standard_error, "Unable to run #{raw["target"]}"
+          end
+
+        rescue MultiJson::LoadError => e
+          protocol.respond_to packet, :standard_error, e.message
+        end
+
+        public
+
+        # When this is included by {DefaultBehavior}, define the
+        # packets nessicary for star running.
+        #
+        # @return [void]
+        def self.included(reciever)
+          reciever.handle :packet => :star_run
+        end
+      end
+    end
+  end
+end

data/lib/nova/starbound/protocol.rb

@@ -3,6 +3,7 @@ require 'nova/starbound/protocol/encryption'
 require 'nova/starbound/protocol/messages'
 require 'nova/starbound/protocol/packet'
 require 'nova/starbound/protocol/socket'
+require 'nova/starbound/default_behavior'
 
 module Nova
   module Starbound
@@ -76,6 +77,13 @@ module Nova
         @state = :offline
       end
 
+      # Sets up default behaviors within this protocol.
+      #
+      # @return [DefaultBehavior]
+      def default_behavior
+        @_default_behavior ||= DefaultBehavior.new(self)
+      end
+
     end
   end
 end

data/lib/nova/starbound/protocol/packet.rb

@@ -49,7 +49,9 @@ module Nova
           :close              => 0x05,
 
           # content
-          :echo               => 0x06
+          :echo               => 0x06,
+          :password           => 0x07,
+          :star_run           => 0x08
         }.freeze
 
         # Used internally to check the types of packets when

data/lib/nova/starbound/protocol/socket.rb

@@ -150,7 +150,7 @@ module Nova
           @_callbacks ||= Hash.new { |h, k| h[k] = [] }
         end
 
-        # Runs a callback.
+        # Runs a callback.  Automatically called by #wait_for_socket.
         #
         # @param struct [Symbol] the struct that the callback is for.
         # @param type [Symbol] the type of callback this is for.
@@ -219,7 +219,8 @@ module Nova
             packet = encryption_provider.decrypt(
               Packet.from_socket(socket))
 
-            run_callback packet.struct, packet.type, packet
+            run_callback packet.struct, packet.type, 
+              packet, self unless state == :handshake
           end
 
           packet

data/lib/nova/version.rb

@@ -1,5 +1,5 @@
 module Nova
 
   # The version of Nova.
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nova
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jeremy Rodi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: command-runner
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,8 +109,10 @@ files:
 - lib/nova/remote/fake/commands.rb
 - lib/nova/remote/fake/file_system.rb
 - lib/nova/remote/fake.rb
+- lib/nova/remote/local.rb
 - lib/nova/project.rb
 - lib/nova/common/metadata/data.rb
+- lib/nova/common/metadata/options.rb
 - lib/nova/common/features.rb
 - lib/nova/common/features/feature.rb
 - lib/nova/common/metadata.rb
@@ -104,6 +120,7 @@ files:
 - lib/nova/common/event_handler.rb
 - lib/nova/common/star_management.rb
 - lib/nova/version.rb
+- lib/nova/shell.rb
 - lib/nova/remote.rb
 - lib/nova/common.rb
 - lib/nova/star.rb
@@ -119,13 +136,19 @@ files:
 - lib/nova/starbound/protocol/encryption.rb
 - lib/nova/starbound/protocol/packet.rb
 - lib/nova/starbound/protocol/exceptions.rb
+- lib/nova/starbound/default_behavior/eventable.rb
+- lib/nova/starbound/default_behavior/passwordable.rb
+- lib/nova/starbound/default_behavior/echoable.rb
+- lib/nova/starbound/default_behavior/star_runnable.rb
 - lib/nova/starbound/encryptor.rb
 - lib/nova/starbound/protocol.rb
+- lib/nova/starbound/default_behavior.rb
 - lib/nova/exceptions.rb
 - lib/nova/constructor.rb
 - lib/nova/starbound.rb
-- lib/generator/template/new_install/supernova.yml
 - lib/generator/template/new_install/galaxy/some_star.rb
+- lib/generator/template/new_install/Gemfile
+- lib/generator/template/new_install/nova.yml
 - lib/nova.rb
 - bin/nova
 - spec/constructor_spec.rb
@@ -141,7 +164,8 @@ files:
 - spec/starbound/rbnacl_encryptor_spec.rb
 - spec/star_spec.rb
 homepage: http://redjazz96.github.io/nova/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -164,3 +188,4 @@ signing_key:
 specification_version: 4
 summary: Software management system.  Boom.
 test_files: []
+has_rdoc: false