mushy 0.15.3 → 0.19.0

data/lib/mushy/fluxs/read_file.rb

@@ -5,10 +5,12 @@ module Mushy
     def self.details
       {
         name: 'ReadFile',
+        title: 'Read File',
+        fluxGroup: { name: 'Files' },
         description: 'Read a file.',
         config: {
-          name: {
-                  description: 'The name of the file to read.',
+          file: {
+                  description: 'The file to read.',
                   type:        'text',
                   value:       'file.csv',
                 },
@@ -18,24 +20,37 @@ module Mushy
                   shrink:      true,
                   value:       '',
                 },
-          path: {
-                  description: 'The path in the event to return the contents of the file.',
-                  type:        'text',
-                  value:       'content',
-                },
+          key: {
+                 description: 'The key in the resulting event to return the contents of the file.',
+                 type:        'text',
+                 value:       'content',
+               },
         },
+        examples: {
+          "Example" => {
+                         description: 'Using this Flux to read the contents of a text file.',
+                         input: {
+                                  file: "data.csv"
+                                },
+                         config: {
+                                   file: '{{file}}',
+                                   key: 'csvdata'
+                                 },
+                         result: { csvdata: 'a,b,c\nd\n\e\f'}
+                       },
+        }
       }
     end
 
     def process event, config
-      file = config[:name]
+      file = config[:file]
 
       file = File.join(config[:directory], file) if config[:directory].to_s != ''
 
       content = File.open(file).read
 
       {
-        config[:path] => content
+        config[:key] => content
       }
     end
 

data/lib/mushy/fluxs/read_json.rb

@@ -7,20 +7,34 @@ module Mushy
     def self.details
       {
         name: 'ReadJson',
+        title: 'Deserialize JSON',
+        fluxGroup: { name: 'JSON' },
         description: 'Read JSON and output it as an event.',
         config: {
-          json: {
-                  description: 'The JSON contents that will be returned as an event.',
-                  type:        'text',
-                  value:       'json',
-                },
+          key: {
+                 description: 'The JSON contents that will be returned as an event.',
+                 type:        'text',
+                 value:       'json',
+               },
         },
+        examples: {
+          "Example" => {
+                         description: 'Using this Flux to deserialize a JSON string.',
+                         input: {
+                                  orange: "{\"people\":[{\"name\":\"John\"},{\"name\":\"Jane\"}]}"
+                                },
+                         config: {
+                                   key: 'orange'
+                                 },
+                         result: { people: [ { name: "John" }, { name: "Jane" } ] }
+                       },
+                  }
       }
     end
 
     def process event, config
-      return nil unless config[:json].to_s != ''
-      JSON.parse config[:json]
+      return nil unless event[config[:key]].to_s != ''
+      JSON.parse event[config[:key]]
     end
 
   end

data/lib/mushy/fluxs/screenshot.rb

@@ -5,7 +5,7 @@ module Mushy
     def self.details
       details = Browser.details
       details[:name] = 'Screenshot'
-      details[:description] = 'Take a screenshot of the browser.'
+      details[:description] = 'Take a screenshot of the browser. This works the same as the Browser, but with a screenshot at the end.'
 
       details[:config].merge!(Mushy::WriteFile.file_saving_config.tap do |x|
         x[x.keys.first][:value] = 'file.jpg'
@@ -23,7 +23,77 @@ module Mushy
          shrink:      true,
          value:       '',
       }
-      details
+      details.tap do |config|
+        config[:examples] = {
+          "Screenshot of google.com" => {
+                                 description: 'This will open https://www.google.com and take a screenshot.',
+                                 config: {
+                                           url: "https://www.google.com",
+                                           file: 'file.jpg'
+                                         },
+                                 result: {
+                                           url: "https://www.google.com/",
+                                           status: 200,
+                                           title: "Google",
+                                           cookies: [
+                                           {
+                                             name: "1P_JAR",
+                                             value: "2021-10-07-21",
+                                             domain: ".google.com",
+                                             path: "/",
+                                             expires: 1636232420.005369,
+                                             size: 19,
+                                             httpOnly: false,
+                                             secure: true,
+                                             session: false,
+                                             sameSite: "None",
+                                             priority: "Medium"
+                                            }
+                                          ],
+                                          headers: {},
+                                          time: 1.520785498,
+                                          body: "...",
+                                          options: {
+                                            path: "file.jpg",
+                                            full: true,
+                                            quality: 100
+                                          },
+                                          file: {
+                                            inode: "439545",
+                                            hard_links: 1,
+                                            owner: "pi",
+                                            group: "pi",
+                                            size: 54269,
+                                            date: {
+                                              year: 2021,
+                                              month: 10,
+                                              day: 7,
+                                              hour: 16,
+                                              minute: 0,
+                                              second: 20,
+                                              nanosecond: 444437482,
+                                              utc_offset: -18000,
+                                              weekday: 4,
+                                              day_of_month: 7,
+                                              day_of_year: 280,
+                                              string: "2021-10-07 16:00:20 -0500",
+                                              epoch_integer: 1633640420,
+                                              epoch_float: 1633640420.4444375,
+                                              seconds_ago: 0.016297478
+                                            },
+                                            name: "file.jpg",
+                                            type: "-",
+                                            owner_permission: "rw-",
+                                            group_permission: "r--",
+                                            other_permission: "r--",
+                                            directory: "/home/pi/Desktop/mushy",
+                                            path: "/home/pi/Desktop/mushy/file.jpg"
+                                          }
+                                        }
+                               },
+        }
+        config[:fluxGroup] = { name: 'Export' }
+      end
     end
 
     def adjust input

data/lib/mushy/fluxs/sense_hat_environmental_sensors.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'SenseHatEnvironmentalSensors',
+        title: 'Read Environmental Sensors',
         description: 'Pull values from the Sense HAT environmental sensors.',
+        fluxGroup: { name: 'SenseHAT' },
         config: Mushy::SimplePythonProgram.default_config,
       }.tap do |c|
         measurements

data/lib/mushy/fluxs/sense_hat_led_matrix.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'SenseHatLedMatrix',
+        title: 'Use LED Matrix',
         description: 'Interface with the LED Matrix.',
+        fluxGroup: { name: 'SenseHAT' },
         config: Mushy::SimplePythonProgram.default_config.tap do |config|
           config[:get_pixels] = {
                                   description: 'Specify the pixels you want returned as events. Use "all" to return all 64, 3,3 to return x:3 y:3, or "none" to return none.',

data/lib/mushy/fluxs/simple_python_program.rb

@@ -6,6 +6,7 @@ module Mushy
       Mushy::Bash.details[:config].tap do |config|
         config.delete :command
         config.delete :directory
+        config[:fluxGroup] = { name: 'Execute' }
       end
     end
 

data/lib/mushy/fluxs/smtp.rb

@@ -48,8 +48,9 @@ module Mushy
 
     def self.details
       {
-        name: 'Smtp',
+        name: 'Send Email Using SMTP',
         description: 'Send email through SMTP.',
+        fluxGroup: { name: 'Email' },
         config: {
           from: {
                   description: 'From whom the email will be sent.',

data/lib/mushy/fluxs/stdout.rb

@@ -5,6 +5,8 @@ module Mushy
     def self.details
       {
         name: 'Stdout',
+        title: 'Export text to stdout',
+        fluxGroup: { name: 'Environment' },
         description: 'Standard Out',
         config: {
           message: {

data/lib/mushy/fluxs/times.rb

@@ -5,13 +5,22 @@ module Mushy
     def self.details
       {
         name: 'Times',
+        title: 'Repeat an event X times',
         description: 'Return the event passed to it, X times.',
+        fluxGroup: { name: 'Flows' },
         config: {
           times: {
                    description: 'The number of times this event should be returned.',
                    type:        'integer',
                    value:       '1',
                  },
+        },
+        examples: {
+          "Basic Example" => {
+                               input: {name: "Elephant"},
+                               config: {times: 2},
+                               result: [ { name: "Elephant", index: 0 }, { name: "Elephant", index: 1 } ],
+                              }
         }
       }
     end

data/lib/mushy/fluxs/twilio_message.rb

@@ -0,0 +1,113 @@
+module Mushy
+
+  class TwilioMessage < Bash
+
+    def self.details
+      {
+        name: 'TwilioMessage',
+        title: 'Send SMS',
+        fluxGroup: { name: 'Twilio' },
+        description: 'Send a Twilio Message.',
+        config: {
+          account_sid: {
+                         description: 'Your Twilio Account SID.',
+                         type:        'text',
+                         value:       '{{twilio_account_sid}}',
+                       },
+          auth_token: {
+                        description: 'Your Twilio Auth Token.',
+                        type:        'text',
+                        value:       '{{twilio_auth_token}}',
+                      },
+          from: {
+                  description: 'The phone number from which the message will be sent.',
+                  type:        'text',
+                  value:       '+1{{from}}',
+                },
+          to: {
+                description: 'The phone number to which the message will be sent.',
+                type:        'text',
+                value:       '+1{{to}}',
+              },
+          body: {
+                  description: 'The content of the message.',
+                  type:        'text',
+                  value:       '{{body}}',
+                },
+          media_url: {
+                       description: 'A URL to a file that can be included with the text message, like https://.../your_file.png.',
+                       type:        'text',
+                       value:       '',
+                       shrink:      true,
+                     },
+        },
+        examples: {
+          "Basic Example" => {
+                               description: "This is what a basic text message.",
+                               input: { message: "Hello World!" },
+                               config: {
+                                 account_sid: 'Your Twilio Account SID',
+                                 auth_token: 'Your Twilio Auth Token',
+                                 from: '+15555555555',
+                                 to: '+14444444444',
+                                 body: '{{message}}',
+                               },
+                               result: {
+                                         sid: "the sid",
+                                         date_created: "Sun, 10 Oct 2021 20:16:48 +0000",
+                                         date_updated: "Sun, 10 Oct 2021 20:16:48 +0000",
+                                         date_sent: nil,
+                                         account_sid: "account sid",
+                                         to: "+15555555555",
+                                         from: "+14444444444",
+                                         messaging_service_sid: nil,
+                                         body: "Hello World!",
+                                         status: "queued",
+                                         num_segments: "1",
+                                         num_media: "0",
+                                         direction: "outbound-api",
+                                         api_version: "2010-04-01",
+                                         price: nil,
+                                         price_unit: "USD",
+                                         error_code: nil,
+                                         error_message: nil,
+                                         uri: "/2010-04-01/Accounts/ABC/Messages/DEF.json",
+                                         subresource_uris: {
+                                           media: "/2010-04-01/Accounts/ABC/Messages/DEF/Media.json"
+                                         }
+                                       }
+                             },
+          "A Failed Call" => {
+                               description: "This is what a failed call may look like.",
+                               result: {
+                                         code: 20003,
+                                         detail: "Your AccountSid or AuthToken was incorrect.",
+                                         message: "Authentication Error - invalid username",
+                                         more_info: "https://www.twilio.com/docs/errors/20003",
+                                         status: 401
+                                       }
+                             },
+        },
+      }
+    end
+
+    def process event, config
+      arguments = {
+        from: "From",
+        to: "To",
+        body: "Body",
+        media_url: "MediaUrl",
+      }.select { |x| config[x].to_s != "" }
+       .map { |x| [x[1], config[x[0]].to_s.gsub('"', '\\"')] }
+       .reduce("") { |t, i| "#{t} --data-urlencode \"#{i[0]}=#{i[1]}\"" }
+
+      config[:command] = "curl -X POST https://api.twilio.com/2010-04-01/Accounts/#{config[:account_sid]}/Messages.json -u #{config[:account_sid]}:#{config[:auth_token]} #{arguments}"
+
+      result = super event, config
+
+      JSON.parse result[:text]
+    end
+
+  end
+
+end

data/lib/mushy/fluxs/write_file.rb

@@ -5,7 +5,9 @@ module Mushy
     def self.details
       {
         name: 'WriteFile',
+        title: 'Write File',
         description: 'Write a file.',
+        fluxGroup: { name: 'Files' },
         config: file_saving_config.merge({
                   data: {
                           description: 'The text to write. You can use Liquid templating here to pull data from the event, or write hardcoded data.',
@@ -13,6 +15,52 @@ module Mushy
                           value:       '{{data}}',
                         },
                 }),
+        examples: {
+          "Example" => {
+                         description: 'Using this Flux to write the contents of a text file. Details about the file are returned.',
+                         input: {
+                                  file: "data.csv",
+                                  content: "a,b,c\nd,e,f",
+                                },
+                         config: {
+                                   file: '{{file}}',
+                                   data: '{{content}}'
+                                 },
+                         result: {
+                                   file: {
+                                     inode: "439540",
+                                     hard_links: 1,
+                                     owner: "pi",
+                                     group: "pi",
+                                     size: 3,
+                                     date: {
+                                       year: 2021,
+                                       month: 10,
+                                       day: 7,
+                                       hour: 15,
+                                       minute: 41,
+                                       second: 14,
+                                       nanosecond: 163590058,
+                                       utc_offset: -18000,
+                                       weekday: 4,
+                                       day_of_month: 7,
+                                       day_of_year: 280,
+                                       string: "2021-10-07 15:41:14 -0500",
+                                       epoch_integer: 1633639274,
+                                       epoch_float: 1633639274.1635902,
+                                       seconds_ago: 0.018665617
+                                    },
+                                     name: "file.csv",
+                                     type: "-",
+                                     owner_permission: "rw-",
+                                     group_permission: "r--",
+                                     other_permission: "r--",
+                                     directory: "/home/pi/Desktop/mushy",
+                                     path: "/home/pi/Desktop/mushy/file.csv"
+                                  }
+                                }
+                       },
+        }
       }
     end
 

data/lib/mushy/fluxs/write_json.rb

@@ -7,7 +7,9 @@ module Mushy
     def self.details
       {
         name: 'WriteJson',
+        title: 'Serialize as JSON',
         description: 'Write the incoming event as JSON.',
+        fluxGroup: { name: 'JSON' },
         config: {
           key: {
                 description: 'The key of the outgoing field that will contain the JSON.',
@@ -15,6 +17,20 @@ module Mushy
                 value:       'json',
               },
         },
+        examples: {
+          "Example" => {
+                         description: 'Using this Flux to convert input to a JSON string.',
+                         input: {
+                                  people: [ { name: "John" }, { name: "Jane" } ]
+                                },
+                         config: {
+                                   key: 'apple'
+                                 },
+                         result: {
+                                   apple: "{\"people\":[{\"name\":\"John\"},{\"name\":\"Jane\"}]}"
+                                 }
+                       },
+          }
       }
     end
 

data/mushy.gemspec

@@ -4,7 +4,7 @@ require 'mushy/version'
 
 Gem::Specification.new do |s|
   s.name           = 'mushy'
-  s.version        = '0.15.3'
+  s.version        = '0.19.0'
   s.date           = '2020-11-23'
   s.summary        = 'Process streams of work using common modules.'
   s.description    = 'This tool assists in the creation and processing of workflows.'

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: mushy
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.19.0
 platform: ruby
 authors:
 - Darren Cauthon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-11-23 00:00:00.000000000 Z
@@ -172,11 +172,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/mushy
+- hey.mushy
 - lib/mushy.rb
 - lib/mushy/builder/api.rb
 - lib/mushy/builder/axios.rb
 - lib/mushy/builder/bulma.rb
 - lib/mushy/builder/dark.rb
+- lib/mushy/builder/documentation.rb
 - lib/mushy/builder/index.rb
 - lib/mushy/builder/vue.rb
 - lib/mushy/date_parts.rb
@@ -200,7 +202,6 @@ files:
 - lib/mushy/fluxs/ls.rb
 - lib/mushy/fluxs/parse_html.rb
 - lib/mushy/fluxs/pdf.rb
-- lib/mushy/fluxs/print.rb
 - lib/mushy/fluxs/pwd.rb
 - lib/mushy/fluxs/read_csv.rb
 - lib/mushy/fluxs/read_file.rb
@@ -212,6 +213,7 @@ files:
 - lib/mushy/fluxs/smtp.rb
 - lib/mushy/fluxs/stdout.rb
 - lib/mushy/fluxs/times.rb
+- lib/mushy/fluxs/twilio_message.rb
 - lib/mushy/fluxs/write_file.rb
 - lib/mushy/fluxs/write_json.rb
 - lib/mushy/masher.rb
@@ -225,7 +227,7 @@ homepage: https://cauthon.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,9 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Process streams of work using common modules.
 test_files: []

data/lib/mushy/fluxs/print.rb

@@ -1,26 +0,0 @@
-module Mushy
-
-  class Print < Flux
-
-    def self.details
-      {
-        name: 'Print',
-        description: 'Print output to the screen.',
-        config: {
-          message: {
-                  description: 'The message to display',
-                  type:        'text',
-                  value:       '',
-                },
-        }
-      }
-    end
-
-    def process event, config
-      puts config[:message]
-      {}
-    end
-
-  end
-
-end