MrMurano 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02d6e091a69dd09c071539a97a2b9d3755ad9202
-  data.tar.gz: 46f2c3f6836c39648de3c08beef0eaf7c4ceb54b
+  metadata.gz: 5af905319869d15b61caf042c9ef16ce355013c7
+  data.tar.gz: 5859d5041f72f72143e1bde1412857b66ad817a0
 SHA512:
-  metadata.gz: fa6b24a0ce013cb732a5563efbe86c54bbeb2cb9264cf69cc0dd1a7a43528f3fb22ef005af188ce7400ac2a7be40a9f716d850b395a24076edd550d8faf47d5c
-  data.tar.gz: 2633547b8be35f46ee9239b3092f8d6ebb7242fea6e8c62c53bdf9df93c461b57c22945a8fbabc556d054d64d85208052b8545d8a59bae85c464532e2b9ab389
+  metadata.gz: 92b19376b2470b30da3196aa702958f837002bac6873f093be78dcf3c60d105c3472bdd9e9b27def0a5f1e539cced568120719dc9338ef33e7d28007371e0aff
+  data.tar.gz: a5d950dc9e1089851a0bdd6b3c20a27c308f8b7d7a0a9ef85d47de0037e3109fceaa97b68bfe722c04f010115085532f98c9db5d5492a0afff05614ff71ef346

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -11,6 +11,8 @@ gem 'http-form_data', '~> 1.0.1'
 gem 'rainbow', '~> 2.1.0'
 
 group :test do
-  gem 'rake'
+  gem 'rake', '~> 10.1.1'
+  gem 'rspec', '~> 3.5'
+  gem 'webmock', '~> 2.1.0'
 end
 

data/MrMurano.gemspec

@@ -31,8 +31,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('rainbow', '~> 2.1.0')
 
   s.add_development_dependency('bundler', '~> 1.7.6')
-  s.add_development_dependency('rspec', '~> 3.2')
   s.add_development_dependency('rake', '~> 10.1.1')
+  s.add_development_dependency('rspec', '~> 3.5')
+  s.add_development_dependency('webmock', '~> 2.1.0')
 end
 
 

data/README.markdown

@@ -47,12 +47,30 @@ All of these can be toggled with command line options.
 
 To aid with debugging, MrMurano has direct access to a solution's Keystore service.
 
-To see all of the keys in the current solution: `mr keystore` 
+To see all of the keys in the current solution: `mr keystore`
 
 ### Timeseries
 
 To aid with debugging, MrMurano has direct access to a solution's Timeseries service.
 
+### Product Content Area
+
+MrMurano can manage the content area for a product.  This area is a place to store
+files for use by devices.  Typically holding firmware images for Over-The-Air
+updating.  Although any kind of fleet wide data that devices may need to download
+can be stored here.
+
+Once the `product.id` is set, the content for that product can be accessed with the
+following commands:
+```
+> mr content list
+> mr content upload
+> mr content info
+> mr content delete
+> mr content download
+```
+
+Call them with `--help` for details.
 
 ### Sub-directories
 

data/Rakefile

@@ -5,24 +5,25 @@ task :default => [:test]
 # TODO: figure out better way to test.
 desc "Install gem in user dir"
 task :bob do
-	sh %{gem install --user-install pkg/MrMurano-#{Bundler::GemHelper.gemspec.version}.gem}
+    sh %{gem install --user-install pkg/MrMurano-#{Bundler::GemHelper.gemspec.version}.gem}
 end
 
 desc "Uninstall from user dir"
 task :unbob do
-	sh %{gem uninstall --user-install pkg/MrMurano-#{Bundler::GemHelper.gemspec.version}.gem}
+    sh %{gem uninstall --user-install pkg/MrMurano-#{Bundler::GemHelper.gemspec.version}.gem}
 end
 
 task :echo do
-	puts "= #{Bundler::GemHelper.gemspec.version} ="
+    puts "= #{Bundler::GemHelper.gemspec.version} ="
 end
 
 task :run do
-	sh %{ruby -Ilib bin/mr }
+    sh %{ruby -Ilib bin/mr }
 end
 
 
 task :test do
+    sh %{rspec}
 end
 
 #  vim: set sw=4 ts=4 :

data/bin/mr

@@ -7,7 +7,7 @@ require 'MrMurano'
 require 'pp'
 
 program :version, MrMurano::VERSION
-program :description, %{Manage a Solution in Exosite's Murano}
+program :description, %{Manage a Solution and Product in Exosite's Murano}
 
 global_option('-V', '--verbose', 'Be chatty') {
   $cfg['tool.verbose'] = true

data/lib/MrMurano/Account.rb

@@ -87,9 +87,9 @@ module MrMurano
         # Cannot have token call token, so cannot use workit.
         uri = endPoint('token/')
         request = Net::HTTP::Post.new(uri)
-        curldebug(request)
-
+        request['User-Agent'] = "MrMurano/#{MrMurano::VERSION}"
         request.content_type = 'application/json'
+        curldebug(request)
         #request.basic_auth(username(), password())
         request.body = JSON.generate(_loginInfo)
 

data/lib/MrMurano/Product.rb

@@ -0,0 +1,255 @@
+require 'uri'
+require 'mime/types'
+require 'csv'
+require 'pp'
+
+module MrMurano
+  class ProductBase
+    def initialize
+      @pid = $cfg['product.id']
+      raise "No Product ID!" if @pid.nil?
+      @uriparts = [:product, @pid]
+    end
+
+    include Http
+    include Verbose
+
+    def endPoint(path='')
+      parts = ['https:/', $cfg['net.host'], 'api:1'] + @uriparts
+      s = parts.map{|v| v.to_s}.join('/')
+      URI(s + path.to_s)
+    end
+  end
+
+  class Product < ProductBase
+    def info
+      get('/info')
+    end
+
+    def list(offset=0, limit=50)
+      get("/device/?offset=#{offset}&limit=#{limit}")
+    end
+
+    def enable(sn)
+      post("/device/#{sn.to_s}")
+    end
+
+    def update(specFile)
+      specFile = Pathname.new(specFile) unless specFile.kind_of? Pathname
+
+      uri = endPoint('/definition')
+      request = Net::HTTP::Post.new(uri)
+      ret = nil
+
+      specFile.open do |io|
+        request.body_stream = io
+        request.content_length = specFile.size
+        set_def_headers(request)
+        request.content_type = 'text/yaml'
+        ret = workit(request)
+      end
+      ret
+    end
+
+    def write(sn, values)
+      post("/write/#{sn}", values)
+    end
+
+  end
+
+  ##
+  # Manage the uploadable content for products.
+  class ProductContent < ProductBase
+    def initialize
+      super
+      @uriparts << :proxy
+      @uriparts << :provision
+      @uriparts << :manage
+      @uriparts << :content
+      @uriparts << @pid
+    end
+
+    ## List all things in content area
+    def list
+      ret = get('/')
+      return [] if ret.kind_of?(Hash)
+      ret.lines.map{|i|i.chomp}
+    end
+
+    ## List all contents allowed for sn
+    def list_for(sn)
+      ret = get("/?sn=#{sn}")
+      return [] if ret.kind_of?(Hash)
+      ret.lines.map{|i|i.chomp}
+    end
+
+    ## Create a new content item
+    def create(id, meta='', protect=false)
+      http_reset
+      data = {:id=>id, :meta=>meta}
+      data[:protected] = true if protect
+      postf('/', data)
+    end
+
+    ## Remove Content item
+    def remove(id)
+      postf('/', {:id=>id, :delete=>true})
+    end
+
+    ## Get info for content item
+    def info(id)
+      get("/#{id}") do |request, http|
+        http.request(request) do |resp|
+          case resp
+          when Net::HTTPSuccess
+            return CSV.parse(resp.body)
+          else
+            return nil
+          end
+        end
+      end
+    end
+
+    ## Download data for content item
+    def download(id, &block)
+      get("/#{id}?download=true") do |request, http|
+        http.request(request) do |resp|
+          case resp
+          when Net::HTTPSuccess
+            if block_given? then
+              resp.read_body &block
+            else
+              resp.read_body do |chunk|
+                $stdout.write chunk
+              end
+            end
+          else
+            say_error "got #{resp.to_s} from #{request} #{request.uri.to_s}"
+            raise resp
+          end
+        end
+        nil
+      end
+    end
+
+    ## Upload data for content item
+    # TODO: add support for passing in IOStream
+    def upload(id, path)
+      path = Pathname.new(path) unless path.kind_of? Pathname
+
+      mime = MIME::Types.type_for(path.to_s)[0] || MIME::Types["application/octet-stream"][0]
+      uri = endPoint("/#{id}")
+      request = Net::HTTP::Post.new(uri)
+      ret = nil
+
+      path.open do |io|
+        request.body_stream = io
+        set_def_headers(request)
+        request.content_length = path.size
+        request.content_type = mime.simplified
+        ret = workit(request)
+      end
+      ret
+    end
+
+    ## Delete data for content item
+    # Note that the content item is still present and listed.
+    def remove_content(id)
+      delete("/#{id}")
+    end
+
+  end
+
+  ##
+  # This is not applicable to Murano.  Remove?
+  class ProductModel < ProductBase
+    def initialize
+      super
+      @uriparts << :proxy
+      @uriparts << :provision
+      @uriparts << :manage
+      @uriparts << :model
+    end
+
+    # In Murano, there should only ever be one.
+    # AND it should be @pid
+    def list
+      get('/')
+    end
+
+    def info(modelID=@pid)
+      get("/#{modelID}")
+    end
+
+    def list_sn(modelID=@pid)
+      get("/#{modelID}/")
+    end
+  end
+
+  ## TODO: Determine which of these are expected to be used.
+  class ProductSerialNumber < ProductBase
+    def initialize
+      super
+      @uriparts << :proxy
+      @uriparts << :provision
+      @uriparts << :manage
+      @uriparts << :model
+      @uriparts << @pid
+    end
+
+    def list(offset=0, limit=1000)
+      ret = get("/?offset=#{offset}&limit=#{limit}&status=true")
+      return [] if ret.kind_of?(Hash)
+      CSV.parse(ret)
+    end
+
+    def logs(sn)
+      get("/#{sn}?show=log") # results are empty
+    end
+
+    def regen(sn)
+      postf("/#{sn}", {:enable=>true})
+    end
+
+    def disable(sn)
+      postf("/#{sn}", {:disable=>true})
+    end
+
+    def activate(sn)
+      # TODO: Need to create a new @http for the different host. Fails otherwise
+      uri = URI("https://#{@pid}.m2.exosite.com/provision/activate")
+      request = Net::HTTP::Post.new(uri)
+      request.form_data = {
+        :vendor => @pid,
+        :model => @pid,
+        :sn => sn
+      }
+      request['User-Agent'] = "MrMurano/#{MrMurano::VERSION}"
+      request['authorization'] = nil
+      request.content_type = 'application/x-www-form-urlencoded; charset=utf-8'
+      workit(request)
+    end
+
+    def add_sn(sn, extra='')
+      # this does add, but what does that mean?
+      # Still need to call …/device/<sn> to enable.
+      # How long is the activation window?
+      postf('/', {:sn=>sn,:extra=>extra})
+    end
+
+    def remove_sn(sn)
+      postf('/', {:sn=>sn, :delete=>true})
+    end
+
+    def ranges
+      get('/?show=ranges')
+    end
+
+    def add_range()
+      post('/', {:ranges=>[ ]})
+    end
+
+  end
+
+end
+#  vim: set ai et sw=2 ts=2 :

data/lib/MrMurano/Solution-File.rb

@@ -81,6 +81,7 @@ module MrMurano
       file = HTTP::FormData::File.new(local.to_s, {:mime_type=>remote[:mime_type]})
       form = HTTP::FormData.create(:file=>file)
       req = Net::HTTP::Put.new(uri)
+      set_def_headers(req)
       workit(req) do |request,http|
         request.content_type = form.content_type
         request.content_length = form.content_length
@@ -135,6 +136,7 @@ module MrMurano
           sha1 << hexit(chunk)
         end
       end
+      debug "Checking #{name} (#{mime.simplified} #{sha1.hexdigest})"
 
       {:path=>name, :mime_type=>mime.simplified, :checksum=>sha1.hexdigest}
     end

data/lib/MrMurano/Solution-Services.rb

@@ -126,8 +126,15 @@ module MrMurano
 
     def list
       ret = get()
+      # eventhandler.skiplist is a list of whitespace seperated dot-paired values.
+      # fe: service.event service service service.event
       skiplist = ($cfg['eventhandler.skiplist'] or '').split
-      ret[:items].reject{|i| i.has_key?(:service) and skiplist.include? i[:service] }
+      ret[:items].reject { |i|
+        i.has_key?(:service) and i.has_key?(:event) and
+        ( skiplist.include? i[:service] or
+          skiplist.include? "#{i[:service]}.#{i[:event]}"
+        )
+      }
     end
 
     def fetch(name)

data/lib/MrMurano/Solution.rb

@@ -18,12 +18,7 @@ module MrMurano
     end
 
     include Http
-
-    def verbose(msg)
-      if $cfg['tool.verbose'] then
-        say msg
-      end
-    end
+    include Verbose
 
     def endPoint(path='')
       parts = ['https:/', $cfg['net.host'], 'api:1'] + @uriparts

data/lib/MrMurano/configCommand.rb

@@ -0,0 +1,68 @@
+
+command :config do |c|
+  c.syntax = %{mr config [options] <key> [<new value>]}
+  c.summary = %{Get and set options}
+  c.description = %{
+  You can get, set, or query config options with this command.  All config
+  options are in a 'section.key' format.  There is also a layer of scopes
+  that the keys can be saved in.
+  }
+
+  c.example %{See what the current combined config is}, 'mr config --dump'
+  c.example %{Query a value}, 'mr config solution.id'
+  c.example %{Set a new value; writing to the project config file}, 'mr config solution.id XXXXXXXX'
+  c.example %{Set a new value; writing to the private config file}, 'mr config --private solution.id XXXXXXXX'
+  c.example %{Set a new value; writing to the user config file}, 'mr config --user user.name my@email.address'
+  c.example %{Unset a value in a configfile. (lower scopes will become visible if set)},
+    'mr config diff.cmd --unset'
+
+
+  c.option '--system', 'Use only the system config file. (/etc/mrmuranorc)'
+  c.option '--user', 'Use only the config file in $HOME (.mrmuranorc)'
+  c.option '--project', 'Use only the config file in the project (.mrmuranorc)'
+  c.option '--private', 'Use only the private config file in the project (.mrmuranorc.private)'
+  c.option '--specified', 'Use only the config file from the --config option.'
+
+  c.option '--unset', 'Remove key from config file.'
+  c.option '--dump', 'Dump the current combined view of the config'
+
+  c.action do |args, options|
+
+    if options.dump then
+      puts $cfg.dump()
+    elsif args.count == 0 then
+      say_error "Need a config key"
+    elsif args.count == 1 and not options.unset then
+      options.defaults :system=>false, :user=>false, :project=>false,
+        :specified=>false, :private=>false
+
+      # For read, if no scopes, than all. Otherwise just those specified
+      scopes = []
+      scopes << :system if options.system
+      scopes << :user if options.user
+      scopes << :project if options.project
+      scopes << :private if options.private
+      scopes << :specified if options.specified
+      scopes = MrMurano::Config::CFG_SCOPES if scopes.empty?
+
+      say $cfg.get(args[0], scopes)
+    else
+
+      options.defaults :system=>false, :user=>false, :project=>true,
+        :specified=>false, :private=>false
+      # For write, if scope is specified, only write to that scope.
+      scope = :project
+      scope = :system if options.system
+      scope = :user if options.user
+      scope = :project if options.project
+      scope = :private if options.private
+      scope = :specified if options.specified
+
+      args[1] = nil if options.unset
+      $cfg.set(args[0], args[1], scope)
+    end
+  end
+
+end
+
+#  vim: set ai et sw=2 ts=2 :

data/lib/MrMurano/configFile.rb

@@ -1,6 +1,5 @@
 require 'pathname'
 require 'inifile'
-require 'pp'
 
 module MrMurano
   class Config
@@ -37,27 +36,31 @@ module MrMurano
     CFG_SCOPES=%w{internal specified project private user system defaults}.map{|i| i.to_sym}.freeze
     CFG_FILE_NAME = '.mrmuranorc'.freeze
     CFG_PRVT_NAME = '.mrmuranorc.private'.freeze
+    CFG_DIR_NAME = '.mrmurano'.freeze
+    CFG_ALTRC_NAME = '.mrmurano/config'.freeze
+    CFG_SYS_NAME = '/etc/mrmuranorc'.freeze
 
     def initialize
       @paths = []
       @paths << ConfigFile.new(:internal, nil, IniFile.new())
       # :specified --configfile FILE goes here. (see load_specific)
-      prjfile = findProjectFile()
+      prjfile = findProjectDir()
       unless prjfile.nil? then
-        @paths << ConfigFile.new(:private, prjfile.dirname + CFG_PRVT_NAME)
-        @paths << ConfigFile.new(:project, prjfile)
+        @paths << ConfigFile.new(:private, prjfile + CFG_PRVT_NAME)
+        @paths << ConfigFile.new(:project, prjfile + CFG_FILE_NAME)
       end
       @paths << ConfigFile.new(:user, Pathname.new(Dir.home) + CFG_FILE_NAME)
-      @paths << ConfigFile.new(:system, Pathname.new('/etc') + CFG_FILE_NAME.sub(/^\./,''))
+      @paths << ConfigFile.new(:system, Pathname.new(CFG_SYS_NAME))
       @paths << ConfigFile.new(:defaults, nil, IniFile.new())
 
 
       set('tool.verbose', false, :defaults)
+      set('tool.debug', false, :defaults)
       set('tool.dry', false, :defaults)
 
       set('net.host', 'bizapi.hosted.exosite.io', :defaults)
 
-      set('location.base', prjfile.dirname, :defaults) unless prjfile.nil?
+      set('location.base', prjfile, :defaults) unless prjfile.nil?
       set('location.files', 'files', :defaults)
       set('location.endpoints', 'endpoints', :defaults)
       set('location.modules', 'modules', :defaults)
@@ -67,27 +70,43 @@ module MrMurano
 
       set('files.default_page', 'index.html', :defaults)
 
-      set('eventhandler.skiplist', 'websocket webservice', :defaults)
+      set('eventhandler.skiplist', 'websocket webservice device.service_call', :defaults)
 
       set('diff.cmd', 'diff -u', :defaults)
     end
 
-    # Look at parent directories until HOME
-    # Stop at first.
-    def findProjectFile()
+    ## Find the root of this project Directory.
+    #
+    # The Project dir is the directory between PWD and HOME that has one of (in
+    # order of preference):
+    # - .mrmuranorc
+    # - .mrmuranorc.private
+    # - .mrmurano/config
+    # - .mrmurano/
+    # - .git/
+    def findProjectDir()
       result=nil
+      fileNames=[CFG_FILE_NAME, CFG_PRVT_NAME, CFG_ALTRC_NAME]
+      dirNames=[CFG_DIR_NAME, '.git']
       home = Pathname.new(Dir.home)
       pwd = Pathname.new(Dir.pwd)
       return nil if home == pwd
-      pwd.dirname.ascend do |i| 
+      pwd.dirname.ascend do |i|
+        break unless result.nil?
         break if i == home
-        if (i + CFG_FILE_NAME).exist? then
-          result = i + CFG_FILE_NAME
-          break
+        fileNames.each do |f|
+          if (i + f).exist? then
+            result = i
+          end
+        end
+        dirNames.each do |f|
+          if (i + f).directory? then
+            result = i
+          end
         end
       end
       # if nothing found, assume it will live in pwd.
-      result = Pathname.new(Dir.pwd) + CFG_FILE_NAME if result.nil?
+      result = Pathname.new(Dir.pwd) if result.nil?
       return result
     end
 
@@ -182,70 +201,4 @@ module MrMurano
   end
 end
 
-command :config do |c|
-  c.syntax = %{mr config [options] <key> [<new value>]}
-  c.summary = %{Get and set options}
-  c.description = %{
-  You can get, set, or query config options with this command.  All config
-  options are in a 'section.key' format.  There is also a layer of scopes
-  that the keys can be saved in.
-  }
-
-  c.example %{See what the current combined config is}, 'mr config --dump'
-  c.example %{Query a value}, 'mr config solution.id'
-  c.example %{Set a new value; writing to the project config file}, 'mr config solution.id XXXXXXXX'
-  c.example %{Set a new value; writing to the private config file}, 'mr config --private solution.id XXXXXXXX'
-  c.example %{Set a new value; writing to the user config file}, 'mr config --user user.name my@email.address'
-  c.example %{Unset a value in a configfile. (lower scopes will become visible if set)},
-    'mr config diff.cmd --unset'
-
-
-  c.option '--system', 'Use only the system config file. (/etc/mrmuranorc)'
-  c.option '--user', 'Use only the config file in $HOME (.mrmuranorc)'
-  c.option '--project', 'Use only the config file in the project (.mrmuranorc)'
-  c.option '--private', 'Use only the private config file in the project (.mrmuranorc.private)'
-  c.option '--specified', 'Use only the config file from the --config option.'
-
-  c.option '--unset', 'Remove key from config file.'
-  c.option '--dump', 'Dump the current combined view of the config'
-
-  c.action do |args, options|
-
-    if options.dump then
-      puts $cfg.dump()
-    elsif args.count == 0 then
-      say_error "Need a config key"
-    elsif args.count == 1 and not options.unset then
-      options.defaults :system=>false, :user=>false, :project=>false,
-        :specified=>false, :private=>false
-
-      # For read, if no scopes, than all. Otherwise just those specified
-      scopes = []
-      scopes << :system if options.system
-      scopes << :user if options.user
-      scopes << :project if options.project
-      scopes << :private if options.private
-      scopes << :specified if options.specified
-      scopes = MrMurano::Config::CFG_SCOPES if scopes.empty?
-
-      say $cfg.get(args[0], scopes)
-    else 
-
-      options.defaults :system=>false, :user=>false, :project=>true,
-        :specified=>false, :private=>false
-      # For write, if scope is specified, only write to that scope.
-      scope = :project
-      scope = :system if options.system
-      scope = :user if options.user
-      scope = :project if options.project
-      scope = :private if options.private
-      scope = :specified if options.specified
-
-      args[1] = nil if options.unset
-      $cfg.set(args[0], args[1], scope)
-    end
-  end
-
-end
-
 #  vim: set ai et sw=2 ts=2 :