MuranoCLI 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b5f23df3ae26fa85d24b1350c090a7699c6b1a
-  data.tar.gz: 2d7f68e4ff2edafc2272184b1b881ed52a89a0ff
+  metadata.gz: 06a751fa4b7c0b5cd5ee4c3ec8e5075d915b31bf
+  data.tar.gz: d3d7f35806143bdea0849b71b8117626dcf58727
 SHA512:
-  metadata.gz: 7ab6a593fb7834cbc3ee696a1446f67ba0541812ede973f8dfd723603204375738438eff824942854d30e157eac340ed10667148a029cfa46933dfff07a55e42
-  data.tar.gz: 9c04e653b85cac4070838993e4a13603e6afcc776db2bd1a11340ba3538e6b53ae3502b80b48dc39f21f47ef9059d17509c04b1ac5004883dfa836caad56ed28
+  metadata.gz: 26f18f7661d62fda5df06fad381f0c1a81286027bf91dcd1da991973cb43489947a257dcffd9d69a4454247ac6a095390147cc993c51d180255d9376c724a152
+  data.tar.gz: 03829cb88d7211ddab47e1c0dc9a9ceed6a8858cf0d320e409a97a1acda999c08548c4f8615768f30a24246532f6bc94d9ef232a4f3e1ba98df71d25fcfc2b84

data/.gitignore

@@ -5,6 +5,7 @@ Icon
 *.sw[a-z]
 cookies
 .jiramulerc
+.yardoc/
 tags
 mr.exe
 
@@ -13,10 +14,13 @@ Pods/
 pkg/
 report/
 coverage/
+doc/
 
 .murano/
+.rspec_examples.txt
 
 _testProject/
+test.*
 
 # Thumbnails
 ._*

data/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 #gemspec
 
-gem 'commander', '~> 4.4.0'
+gem 'commander', '~> 4.4.3'
 gem 'certified', '1.0.0'
 gem 'dotenv', '~> 2.1.1'
 gem 'highline', '~> 1.7.8'
@@ -11,7 +11,7 @@ gem 'inifile', '~> 3.0'
 gem 'json-schema', '~> 2.7.0'
 gem 'mime-types', '~> 3.1'
 gem 'mime-types-data', '~> 3.2016.0521'
-gem 'terminal-table', '~> 1.4.5'
+gem 'terminal-table', '~> 1.7.3'
 
 group :test do
   gem 'coderay', :require => false
@@ -19,6 +19,7 @@ group :test do
   gem 'rspec', '~> 3.5'
   gem 'simplecov', :require => false
   gem 'webmock', '~> 2.3.0'
+  gem 'yard'
 end
 
 group :windows do

data/MuranoCLI.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency('commander', '~> 4.4.0')
+  s.add_runtime_dependency('commander', '~> 4.4.3')
   s.add_runtime_dependency('certified', '1.0.0')
   s.add_runtime_dependency('dotenv', '~> 2.1.1')
   s.add_runtime_dependency('highline', '~> 1.7.8')
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('json-schema', '~> 2.7.0')
   s.add_runtime_dependency('mime-types', '~> 3.1')
   s.add_runtime_dependency('mime-types-data', '~> 3.2016.0521')
-  s.add_runtime_dependency('terminal-table', '~> 1.4.5')
+  s.add_runtime_dependency('terminal-table', '~> 1.7.3')
 
   s.add_development_dependency('bundler', '~> 1.7.6')
   s.add_development_dependency('ocra', '~> 1.3.8')

data/README.markdown

@@ -1,11 +1,11 @@
-# MuranoCLI
+# Murano Command Line Interface (CLI)
 
 [![Gem
 Version](https://badge.fury.io/rb/MuranoCLI.svg)](https://badge.fury.io/rb/MuranoCLI)
-[![Build Status](https://travis-ci.org/tadpol/MrMurano.svg?branch=master)](https://travis-ci.org/tadpol/MrMurano)
+[![Build Status](https://travis-ci.org/exosite/MuranoCLI.svg?branch=master)](https://travis-ci.org/exosite/MuranoCLI)
 [![Inline docs](http://inch-ci.org/github/exosite/MuranoCLI.svg?branch=master)](http://inch-ci.org/github/exosite/MuranoCLI)
 
-Do more from the command line with [Murano](https://exosite.com/platform/)
+Do more from the command line with [Murano](https://exosite.com/platform/).
 
 MuranoCLI is the command-line tool that interacts with Murano and makes different
 tasks easier. MuranoCLI makes it easy to deploy code to a solution, import many
@@ -17,18 +17,24 @@ directory are synced up (or down) from Murano.
 
 ## Usage
 
-### To start from an existing project in Murano
 ```
 mkdir myproject
 cd myproject
-murano config solution.id XXXXXX
-murano syncdown -V
+murano init
 ```
 
-Do stuff, see what changed: `murano status` or `murano diff`.
+Update `myproject.murano` with the info about your project.
+
+If this is a new project, you will also need to run `murano assign set` to connect
+the product and solution.
+
+If this is an existing project, you want to run `murano syncdown -V` after
+running `murano init`.
+
+Now do stuff, see what changed: `murano status` or `murano diff`.
 Then deploy with `murano syncup`
 
-### To start a brand new project
+### To start a brand new project the hard way.
 There are a few steps and pieces to getting a solution with a product up and
 running in Murano. Here is the list.
 
@@ -53,7 +59,7 @@ Then deploy with `murano syncup`
 When upgrading from a 1.\* version to a 2.0, you should uninstall the old versions
 first.
 ```
-> gem uninstall MuranoCLI`
+> gem uninstall MuranoCLI
 ```
 
 And then install:
@@ -91,6 +97,8 @@ installing the new version.
 
 ## Features
 
+### Project File
+
 ### Logs
 
 You can monitor the log messages from your solution with the `murano logs --follow`.
@@ -103,6 +111,95 @@ MuranoCLI does a few things to make your log output easier to follow.
 
 All of these can be toggled with command line options.
 
+### CORS
+
+If you are developing you UI on seperate services and you need cross-origin
+resource sharing, you will need to set the
+[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) options.
+
+The current CORS options can be fetched with `murano cors`
+
+There are three opitons for setting, the first and preferred way is to put your CORS
+opitons into a file named `cors.yaml`.
+
+Second and third are to put the CORS opitons in your project file.  In the `routes`
+section, add a `cors` sub-section with either the name of the file to read, or the
+CORS options inline.
+
+```yaml
+routes:
+	cors: my_cors_file.json
+```
+OR:
+```yaml
+routes:
+	cors: {"origin": true}
+```
+
+Then use `murano cors set` to push these options up to your solution.
+
+### Writing Routes (or endpoints)
+
+All of the routes that you create in your solution are identified by their method
+and path.  You set this with the following line:
+
+```lua
+--#ENDPOINT METHOD PATH
+```
+
+Optionally, you can set what the expected content type is too. (If you don't set
+this, the value is application/json)
+
+```lua
+--#ENDPOINT METHOD PATH CONTENT_TYPE
+```
+
+An example of a route that puts csv data:
+```lua
+--#ENDPOINT PUT /api/upload text/csv
+```
+
+After this header line, the script to handle the route follows.  Since many routes
+end up being a couple of lines or less, you can put multiple routes into a single
+file.
+
+Which looks like this:
+```lua
+--#ENDPOINT GET /api/somedata
+return Tsdb.query(…)
+
+--#ENDPOINT PUT /api/somedata text/csv
+return myimport_module.import(request)
+
+--#ENDPOINT DELETE /api/startover
+return Tsdb.deleteAll()
+```
+
+### Writing Service Event Handlers
+
+All of the event handlers you add to your solution are identified by which service
+they are watching and which event in that service triggers the script.
+
+This is set with the following line:
+```lua
+--#EVENT SERVICE EVENT
+```
+
+For example, the event handler that processes all data coming from your devices
+could be:
+```lua
+--#EVENT device datapoint
+local stamped = nil
+if data.api == "record" then
+	stamped = tostring(data.value[1]) .. 's'
+end
+Tsdb.write{
+	tags = {sn=data.device_sn},
+	metrics = {[data.alias] = tonumber(data.value[2])},
+	ts = stamped
+}
+```
+
 ### MURANO_CONFIGFILE environment and Dotenv
 
 The environment variable `MURANO_CONFIGFILE` is checked for an additional config to
@@ -199,7 +296,7 @@ tests work with the live Murano servers (`--tag needs_password`).
 
 To use the live tests, the following environment variables need to be set:
 - `MURANO_USER` : User name to log into Murano with
-- `MURNO_PASSWORD` : Password for that user
+- `MURANO_PASSWORD` : Password for that user
 - `MURANO_BUSINESS` : Business id to run tests within.
 
 A free account on Murano is sufficient for these tests.

data/lib/MrMurano/Product-Resources.rb

@@ -11,6 +11,16 @@ module MrMurano
     include SyncUpDown
     include ProductOnePlatformRpcShim
 
+    # Resource Specific details on an Item
+    class ResourceItem < Item
+      # @return [String] Reasource Identifier, internal use only.
+      attr_accessor :rid
+      # @return [String] The name of this resource
+      attr_accessor :alias
+      # @return [String] The format of thie resource.
+      attr_accessor :format
+    end
+
     def initialize
       super
       @uriparts << :proxy

data/lib/MrMurano/ProjectFile.rb

@@ -12,6 +12,8 @@ module MrMurano
   class ProjectFile
     include Verbose
 
+    attr_reader :usingProjectfile, :usingSolutionfile
+
     # Methods that are common to various internal structs.
     module PrjStructCommonMethods
       ## Load data from Hash into self
@@ -85,6 +87,8 @@ module MrMurano
     end
 
     def initialize()
+      @usingProjectfile = false
+      @usingSolutionfile = false
       @prjFile = nil
       tname = $cfg['location.base'].basename.to_s.gsub(/[^A-Za-z0-9]/, '')
       @data = PrfFile.new(
@@ -259,6 +263,7 @@ module MrMurano
       schema = YAML.load_file(schemaPath.to_s)
       v = JSON::Validator.fully_validate(schema, data)
       return v unless v.empty?
+      @usingProjectfile = true
 
       @data.each_pair do |key, str|
         str.load(data[key]) if data.has_key? key
@@ -277,6 +282,7 @@ module MrMurano
       schema = YAML.load_file(schemaPath.to_s)
       v = JSON::Validator.fully_validate(schema, data)
       return v unless v.empty?
+      @usingSolutionfile = true
 
       ifset(data, :default_page, @data[:assets], :default_page)
       ifset(data, :file_dir, @data[:assets], :location)
@@ -318,6 +324,7 @@ module MrMurano
       schema = YAML.load_file(schemaPath.to_s)
       v = JSON::Validator.fully_validate(schema, data)
       return v unless v.empty?
+      @usingSolutionfile = true
 
       ifset(data, :default_page, @data[:assets], :default_page)
       ifset(data, :assets, @data[:assets], :location)

data/lib/MrMurano/Solution-Endpoint.rb

@@ -7,6 +7,18 @@ require 'MrMurano/Solution'
 module MrMurano
   # …/endpoint
   class Endpoint < SolutionBase
+    # Route Specific details on an Item
+    class RouteItem < Item
+      # @return [String] HTTP method for this endpoint
+      attr_accessor :method
+      # @return [String] path for URL maps to this endpoint
+      attr_accessor :path
+      # @return [String] Acceptable Content-Type for this endpoint
+      attr_accessor :content_type
+      # ???? What is this?
+      attr_accessor :use_basic_auth
+    end
+
     def initialize
       super
       @uriparts << 'endpoint'
@@ -23,7 +35,7 @@ module MrMurano
           item[:content_type] = 'application/json'
         end
         # XXX should this update the script header?
-        item
+        RouteItem.new(item)
       end
     end
 
@@ -64,20 +76,20 @@ module MrMurano
 
     ##
     # Upload endpoint
-    # :local path to file to push
-    # :remote hash of method and endpoint path
-    # @param modify Bool: True if item exists already and this is changing it
+    # @param local [Pathname] path to file to push
+    # @param remote [RouteItem] of method and endpoint path
+    # @param modify [Boolean] True if item exists already and this is changing it
     def upload(local, remote, modify)
       local = Pathname.new(local) unless local.kind_of? Pathname
       raise "no file" unless local.exist?
 
       # we assume these are small enough to slurp.
-      unless remote.has_key? :script then
+      if remote.script.nil? then
         script = local.read
         remote[:script] = script
       end
       limitkeys = [:method, :path, :script, :content_type, @itemkey]
-      remote = remote.select{|k,v| limitkeys.include? k }
+      remote = remote.to_h.select{|k,v| limitkeys.include? k }
 #      post('', remote)
       if remote.has_key? @itemkey then
         put('/' + remote[@itemkey], remote) do |request, http|
@@ -124,12 +136,12 @@ module MrMurano
           # header line.
           cur[:line_end] = lineno unless cur.nil?
           items << cur unless cur.nil?
-          cur = {:method=>md[:method],
-                 :path=>md[:path],
-                 :content_type=> (md[:ctype] or 'application/json'),
-                 :local_path=>path,
-                 :line=>lineno,
-                 :script=>line}
+          cur = RouteItem.new(:method=>md[:method],
+                              :path=>md[:path],
+                              :content_type=> (md[:ctype] or 'application/json'),
+                              :local_path=>path,
+                              :line=>lineno,
+                              :script=>line)
         elsif not cur.nil? and not cur[:script].nil? then
           cur[:script] << line
         end

data/lib/MrMurano/Solution-File.rb

@@ -9,6 +9,15 @@ require 'MrMurano/Solution'
 module MrMurano
   # …/file
   class File < SolutionBase
+    # File Specific details on an Item
+    class FileItem < Item
+      # @return [String] path for URL maps to this static file
+      attr_accessor :path
+      # @return [String] The MIME-Type for this content
+      attr_accessor :mime_type
+      # @return [String] Checksum for the content.
+      attr_accessor :checksum
+    end
     def initialize
       super
       @uriparts << 'file'
@@ -19,7 +28,7 @@ module MrMurano
     ##
     # Get a list of all of the static content
     def list
-      get()
+      get().map{|i| FileItem.new(i)}
     end
 
     ##
@@ -47,8 +56,8 @@ module MrMurano
     ##
     # Delete a file
     def remove(path)
-      # TODO test
-      delete('/'+path)
+      path = path[1..-1] if path[0] == '/'
+      delete('/'+ URI.encode_www_form_component(path))
     end
 
     def curldebug(request)
@@ -65,7 +74,10 @@ module MrMurano
     def upload(local, remote, modify)
       local = Pathname.new(local) unless local.kind_of? Pathname
 
-      uri = endPoint('upload' + remote[:path])
+      path = remote[:path]
+      path = path[1..-1] if path[0] == '/'
+      uri = endPoint('upload/' + URI.encode_www_form_component(path))
+
       # kludge past for a bit.
       #`curl -s -H 'Authorization: token #{@token}' '#{uri.to_s}' -F file=@#{local.to_s}`
 
@@ -132,7 +144,7 @@ module MrMurano
       end
       debug "Checking #{name} (#{mime.simplified} #{sha1.hexdigest})"
 
-      {:path=>name, :mime_type=>mime.simplified, :checksum=>sha1.hexdigest}
+      FileItem.new(:path=>name, :mime_type=>mime.simplified, :checksum=>sha1.hexdigest)
     end
 
     def synckey(item)

data/lib/MrMurano/Solution-ServiceConfig.rb

@@ -94,15 +94,17 @@ module MrMurano
     end
 
     ## Get list of call operations from a schema
-    def callable(id=sid)
+    def callable(id=sid, all=false)
       scm = schema(id)
       calls = []
       scm[:paths].each do |path, methods|
         methods.each do |method, params|
-          if params.kind_of?(Hash) and
-              not params['x-internal-use'.to_sym] and
-              params.has_key?(:operationId) then
-            calls << [method, params[:operationId]]
+          if params.kind_of?(Hash) then
+            call = [method]
+            call << path.to_s if all
+            call << params[:operationId]
+            call << (params['x-internal-use'.to_sym] or false) if all
+            calls << call
           end
         end
       end