apiotics_factory 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57b5011c4903e6ef99d831b9ae85710287b6acc5
+  data.tar.gz: 25d2c749da32bdf104eada7bf53eb272fcaa8eb4
+SHA512:
+  metadata.gz: 12b1eb3b83b55b53141a60a7b43515c57ef152530c532f67fdcacc6be0fff2bbfc6e8114dc929c53869004fa20e025f86a0c0fcc554f903f0796b8c4354a1fac
+  data.tar.gz: 5efec3d5df04768067213d6a421f7783846f3da221d5739e01aebc36f70f9fd9e3555df87e2de5721f2ba7925db0319e76cce2d65e082fb2d2be818d0fa33e7f

data/License

@@ -0,0 +1,9 @@
+Copyright 2018 MicroArx Corporation
+
+Permission is hereby granted to use the Apiotics_Factory Gem (the "Gem") to create driver software.  Software created using the Gem or with its assistance may only be distributed using Apiotics websites such as portal.apiotics.com, and may only be installed on third party devices (devices other than those belonging to the developer of the driver software or to MicroArx Corporation) using Apiotics development tools such as the Apiotics Gem.  Software created using this Gem or with the assistance of this Gem may only be installed on third party devices which are running operating system images or firmware provided by Apiotics or distributed via the Apiotics websites and installed with Apiotics development tools.  
+
+Permission is not granted to install or use this software to subvert the Apiotics website, development tools, operating system images or firmware with intent to install driver software on operating systems or firmware other than those provided by Apiotics and installed with Apiotics development tools, to use Apiotics software or development tools in any way without paying the subscription plan fees as published on portal.apiotics.com, or with any other intent or purpose.
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/apiotics_factory

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative '../lib/apiotics_factory'
+ApioticsFactory::MyCommand.start

data/lib/apiotics_factory/clear_credentials.rb

@@ -0,0 +1,25 @@
+require 'thor/group'
+
+module ApioticsFactory
+  class ClearCredentials < Thor::Group
+
+    include Thor::Actions
+    
+    desc "Deletes vendor and portal credentials."
+  
+    def self.source_root
+      Dir.pwd
+    end
+  
+    def delete_credentials
+      config_dir = File.dirname(__FILE__).chomp("/lib/apiotics_factory") + "/var"
+      #puts config_dir
+      if File.exist?(config_dir + "/config.json")
+        puts "Deleting config file #{config_dir}" + "/config.json"
+        File.delete(config_dir + "/config.json")
+      end
+    end
+
+  
+  end
+end

data/lib/apiotics_factory/configuration.rb

@@ -0,0 +1,30 @@
+module ApioticsFactory
+  class Configuration
+  
+    attr_accessor :public_key, :private_key, :portal, :interface_kinds
+  
+    def initialize
+      @public_key = nil
+      @private_key = nil
+      @portal = "https://portal.apiotics.com/"
+      @interface_kinds = {
+        "string" => "string",
+        "text" => "string",
+        "smallint" => "integer",
+        "integer" => "integer",
+        "bigint" => "integer",
+        "float" => "float",
+        "boolean" => "boolean",
+        "enum" => "string",
+        "json" => "json",
+        "uint8_t" => "integer",
+        "uint16_t" => "integer",
+        "uint32_t" => "integer",
+        "int16_t" => "integer",
+        "int32_t" => "integer",
+        "int64_t" => "integer"
+      }
+    end
+  
+  end
+end

data/lib/apiotics_factory/generator.rb

@@ -0,0 +1,133 @@
+
+require 'json'
+require 'thor/group'
+require 'apiotics_factory/underscore'
+
+module ApioticsFactory
+  class Generator < Thor::Group
+
+    include Thor::Actions
+  
+    argument :id
+    class_option :library, type: :string, default: "grove_pi"
+    
+    desc "Generates an Apiotics driver.  Requires the driver name and driver id (from the portal) as arguments."
+  
+    def self.source_root
+      Dir.pwd
+    end
+  
+    def fetch_info
+      config_dir = File.dirname(__FILE__).chomp("/lib/apiotics_factory") + "/var"
+      #puts config_dir
+      if File.exist?(config_dir + "/config.json")
+        puts "Found config file #{config_dir}" + "/config.json"
+        config = JSON.parse(File.read(config_dir + "/config.json"))
+        ApioticsFactory.configuration.public_key = config["public_key"]
+        ApioticsFactory.configuration.private_key = config["private_key"]
+        ApioticsFactory.configuration.portal = config["portal"]
+      else
+        say("Please enter your vendor public key from the Apiotics Portal.")
+        ApioticsFactory.configuration.public_key = ask("Vendor Public Key: ")
+        say("Please enter your vendor private key from the Apiotics Portal.")
+        ApioticsFactory.configuration.private_key = ask("Vendor Private Key: ")
+        say("Please confirm the Apiotics Portal web address.")
+        ApioticsFactory.configuration.portal = ask("Portal: ", default: "https://portal.apiotics.com/")
+        unless ApioticsFactory.configuration.portal[-1] == "/"
+          ApioticsFactory.configuration.portal = ApioticsFactory.configuration.portal + "/"
+        end
+        config = {
+          "public_key" => ApioticsFactory.configuration.public_key,
+          "private_key" => ApioticsFactory.configuration.private_key,
+          "portal" => ApioticsFactory.configuration.portal
+        }
+        #puts config
+        unless Dir.exist?(config_dir)
+          Dir.mkdir(config_dir)
+        end
+        File.write(config_dir + "/config.json", config.to_json)
+      end
+      puts "Fetching driver data from the portal..."
+      data = ApioticsFactory::Portal.driver(id)
+      #puts data
+      data = JSON.parse(data)
+      @driver_name = data["name"]
+      @status = true
+      unless data.keys.include?("errors")
+        @interfaces = data["interfaces"]# a hash with "read", "write" and "all".  "read" is an array of read and read/write interfaces. "write" is an array of write and read/write interfaces.  "all" is a hash with interface names as the keys.
+        # the value is a hash with an "accessor" key and a "type" key
+        @delay_default = data["delay_default"]
+        if @delay_default == nil
+          @delay_default = Hash.new
+          @interfaces["read"].each do |interface|
+            @delay_default[interface] = 1.0
+          end
+        end
+      else
+        @status = false
+        say("#{data['errors']['detail']}")
+      end
+      @template_path = File.dirname(__FILE__).chomp("/apiotics_factory") + "/templates"
+    end
+  
+    #need to account for the case when the portal call fails.
+  
+    def create_config_file
+      if @status == true
+        puts "Creating driver config file..."
+        template("#{@template_path}/config.json.erb", "#{@driver_name.downcase}/config.json")
+      end
+    end
+  
+    def create_exec_file
+      if @status == true
+        puts "Creating driver executable..."
+        @exec_name = @driver_name
+        @exec_name = @exec_name.gsub(/::/, '/')
+        @exec_name = @exec_name.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        @exec_name = @exec_name.gsub(/([a-z\d])([A-Z])/,'\1_\2')
+        @exec_name = @exec_name.tr("-", "_")
+        @exec_name = @exec_name.downcase
+        template("#{@template_path}/exec.rb.erb", "#{@driver_name.downcase}/rootfs/#{@driver_name.downcase}")
+        chmod "#{@driver_name.downcase}/rootfs/#{@driver_name.downcase}", 0755
+      end
+    end
+  
+    def create_apiotics_driver
+      if @status == true
+        puts "Creating apiotics_driver.rb"
+        template("#{@template_path}/apiotics_driver.rb.erb", "#{@driver_name.downcase}/rootfs/apiotics_driver.rb")
+      end
+    end
+  
+    def create_interface_file
+      if @status == true
+        "Creating #{@exec_name}.rb"
+        template("#{@template_path}/apiotics_interfaces.rb.erb", "#{@driver_name.downcase}/rootfs/#{@exec_name}.rb")
+      end
+    end
+  
+    def create_library
+      if @status == true
+        if options[:library] == "grove_pi"
+          puts "Adding GrovePi library..."
+          insert_into_file "#{@driver_name.downcase}/rootfs/#{@exec_name}.rb", "require_relative './grove_pi.rb'\n", :after => "require_relative './apiotics_driver'\n"
+          copy_file "#{@template_path}/grove_pi/grove_pi.rb", "#{@driver_name.downcase}/rootfs/grove_pi.rb"
+          copy_file "#{@template_path}/grove_pi/i2c/i2c.rb", "#{@driver_name.downcase}/rootfs/i2c.rb"
+          copy_file "#{@template_path}/grove_pi/i2c/driver.rb", "#{@driver_name.downcase}/rootfs/i2c/driver.rb"
+          copy_file "#{@template_path}/grove_pi/i2c/driver/i2c-dev.rb", "#{@driver_name.downcase}/rootfs/i2c/driver/i2c-dev.rb"
+          copy_file "#{@template_path}/grove_pi/i2c/driver/gpio.rb", "#{@driver_name.downcase}/rootfs/i2c/driver/gpio.rb"
+          directory "#{@template_path}/grove_pi/i2c/device", "#{@driver_name.downcase}/rootfs/i2c/device"
+        end
+      end
+    end
+  
+    def create_vendor
+      if @status == true
+        puts "Creating vendor directory..."
+        empty_directory "#{@driver_name.downcase}/rootfs/vendor"
+      end
+    end
+  
+  end
+end

data/lib/apiotics_factory/my_command.rb

@@ -0,0 +1,15 @@
+require "thor"
+
+module ApioticsFactory
+  class MyCommand < Thor
+    # register(class_name, subcommand_alias, usage_list_string, description_string)
+    register(ApioticsFactory::Generator, "generate", "generate <DriverId>", "Generate Apiotics Driver.  You can find the Id for your driver on the portal.  If your driver does not yet exist on the portal, create it there first.")
+    
+    # register(class_name, subcommand_alias, usage_list_string, description_string)
+    register(ApioticsFactory::Publish, "publish", "publish <DriverId>", "Publish Apiotics Driver.  You can find the Id for your driver on the portal.  If your driver does not yet exist on the portal, create it there first.")
+  
+    # register(class_name, subcommand_alias, usage_list_string, description_string)
+    register(ApioticsFactory::ClearCredentials, "clear_credentials", "clear_credentials", "Delete vendor and portal information from the Gem.")
+    
+  end
+end

data/lib/apiotics_factory/portal.rb

@@ -0,0 +1,33 @@
+require 'httparty'
+require 'json'
+require 'rest-client'
+#require 'resolv-replace'
+
+module ApioticsFactory
+  class Portal
+    
+    def self.driver(driver)
+      puts "portal: #{ApioticsFactory.configuration.portal}"
+      puts "public_key: #{ApioticsFactory.configuration.public_key}"
+      puts "private_key: #{ApioticsFactory.configuration.private_key}"
+      puts "id: #{driver}"
+      json = HTTParty.post("#{ApioticsFactory.configuration.portal}api/driver", :query => {:public_key => ApioticsFactory.configuration.public_key, :private_key => ApioticsFactory.configuration.private_key, driver: driver}).body
+    end
+    
+    def self.driver_version(driver)
+      json = HTTParty.post("#{ApioticsFactory.configuration.portal}api/driver_version", :query => {:public_key => ApioticsFactory.configuration.public_key, :private_key => ApioticsFactory.configuration.private_key, driver: driver}).body
+    end
+    
+    def self.publish_driver(driver, path)
+      payload = {
+        :multipart => true,
+        :file => File.open(path, 'rb'),
+        :public_key => ApioticsFactory.configuration.public_key,
+        :private_key => ApioticsFactory.configuration.private_key,
+        :driver => driver
+      }
+      r = RestClient.post("#{ApioticsFactory.configuration.portal}api/upload_driver", payload)
+    end
+    
+  end
+end

data/lib/apiotics_factory/publish.rb

@@ -0,0 +1,83 @@
+
+require 'json'
+require 'thor/group'
+
+module ApioticsFactory
+  class Publish < Thor::Group
+
+    include Thor::Actions
+  
+    argument :id
+    class_option :path
+    
+    desc "Publishes an Apiotics driver.  Requires the driver name and driver id (from the portal) as arguments."
+  
+    def self.source_root
+      if :path == nil
+        Dir.pwd
+      else
+        :path
+      end
+    end
+  
+    def fetch_info
+      config_dir = File.dirname(__FILE__).chomp("/lib/apiotics_factory") + "/var"
+    
+      if File.exist?(config_dir + "/config.json")
+        config = JSON.parse(File.read(config_dir + "/config.json"))
+        ApioticsFactory.configuration.public_key = config["public_key"]
+        ApioticsFactory.configuration.private_key = config["private_key"]
+        ApioticsFactory.configuration.portal = config["portal"]
+      else
+        say("Please enter your vendor public key from the Apiotics Portal.")
+        ApioticsFactory.configuration.public_key = ask("Vendor Public Key: ")
+        say("Please enter your vendor private key from the Apiotics Portal.")
+        ApioticsFactory.configuration.private_key = ask("Vendor Private Key: ")
+        say("Please confirm the Apiotics Portal web address.")
+        ApioticsFactory.configuration.portal = ask("Portal: ", default: "https://portal.apiotics.com/")
+        unless ApioticsFactory.configuration.portal[-1] == "/"
+          ApioticsFactory.configuration.portal = ApioticsFactory.configuration.portal + "/"
+        end
+        config = {
+          "public_key" => ApioticsFactory.configuration.public_key,
+          "private_key" => ApioticsFactory.configuration.private_key,
+          "portal" => ApioticsFactory.configuration.portal
+        }
+        unless Dir.exist?(config_dir)
+          Dir.mkdir(config_dir)
+        end
+        File.write(config_dir + "/config.json", config.to_json)
+      end
+      data = ApioticsFactory::Portal.driver_version(id)
+      #puts data
+      data = JSON.parse(data)
+      @driver_name = data["name"]
+      @status = true
+      unless data.keys.include?("errors")
+        @version = data["version"]
+      else
+        @status = false
+        say("#{data['errors']['detail']}")
+      end
+    end
+  
+    #need to account for the case where the portal call fails.
+  
+    def publish
+      if @status == true
+        run("tar -cvzf #{@driver_name.downcase}-#{@version}.tgz ./#{@driver_name.downcase}")
+        say("Uploading driver to the portal...")
+        path = Dir.pwd + "/#{@driver_name.downcase}-#{@version}.tgz"
+        response = ApioticsFactory::Portal.publish_driver(id, path)
+        say("Cleaning up...")
+        run("rm #{@driver_name.downcase}-#{@version}.tgz")
+        if response.code == 200
+          say("Upload successful")
+        else
+          say("Upload not successful")
+        end
+      end
+    end
+  
+  end
+end

data/lib/apiotics_factory/underscore.rb

@@ -0,0 +1,11 @@
+module ApioticsFactory
+  class String
+    def underscore
+      self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/apiotics_factory/version.rb

@@ -0,0 +1,3 @@
+module ApioticsFactory
+  VERSION = '1.0.0'
+end

data/lib/apiotics_factory.rb

@@ -0,0 +1,28 @@
+require "apiotics_factory/configuration"
+require "apiotics_factory/version"
+require "apiotics_factory/portal"
+require "apiotics_factory/underscore"
+require "apiotics_factory/generator"
+require "apiotics_factory/publish"
+require "apiotics_factory/clear_credentials"
+require "apiotics_factory/my_command"
+
+module ApioticsFactory
+  
+  class << self
+    attr_accessor :configuration
+  end
+  
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  def self.reset
+    @configuration = Configuration.new
+  end
+  
+  def self.configure
+    yield(configuration)
+  end
+  
+end

data/lib/templates/apiotics_driver.rb.erb

@@ -0,0 +1,244 @@
+class ApioticsDriver
+  require 'socket'
+  require 'json'
+  
+  attr_accessor :debug_enable
+  
+  def initialize
+    if File.file?("driver_config.json")
+      @config = JSON.parse(File.read("driver_config.json"))
+      if @config.keys.include?("log_file")
+        $stdout = File.open( @config["log_file"], 'a' )
+        $stdout.sync = true
+      end
+      if @config.keys.include?("driver_name")
+        @driver_name = @config["driver_name"]
+      else
+        @driver_name = "Unspecified"
+      end
+      puts "initializing #{@driver_name}"
+      @socket_address = "localhost"
+      @socket_port = 8001
+      @debug_enable = false
+      @delay = <%= @delay_default %>
+      @threads = {}
+      @state = {}
+      @read_interfaces = <%= @interfaces["read"] %>
+      @write_interfaces = <%= @interfaces["write"] %>
+      @interfaces = <%= @interfaces["all"] %>
+      @interface_kinds = {
+        "string" => "string",
+        "text" => "string",
+        "smallint" => "integer",
+        "integer" => "integer",
+        "bigint" => "integer",
+        "float" => "float",
+        "boolean" => "boolean",
+        "enum" => "string",
+        "json" => "json",
+        "uint8_t" => "integer",
+        "uint16_t" => "integer",
+        "uint32_t" => "integer",
+        "int16_t" => "integer",
+        "int32_t" => "integer",
+        "int64_t" => "integer"
+      }
+      @connected = false
+      @msg_queue = []
+      @flush_active = false
+    end
+  end
+  
+  def send_msg(value)
+    interface = caller_locations(1,1)[0].label
+    if interface[0..5] == "write_"
+      interface = interface[6..-1]
+    elsif interface[0..4] == "read_"
+      interface = interface[5..-1]
+    end
+    unless interface == "port"
+      @state[interface] = value
+    else
+      @state[interface] = Kernel.const_get(value)
+    end
+    msg = {
+      "action" => "set-complete",
+      "driver" => @driver_name,
+      "interface" => {
+        interface => value
+      }
+    }
+    self.deliver_msg(msg)
+  end
+  
+  def send_msg2(interface, value)
+    if interface[0..5] == "write_"
+      interface = interface[6..-1]
+    elsif interface[0..4] == "read_"
+      interface = interface[5..-1]
+    end
+    unless interface == "port"
+      @state[interface] = value
+    else
+      @state[interface] = Kernel.const_get(value)
+    end
+    msg = {
+      "action" => "set-complete",
+      "driver" => @driver_name,
+      "interface" => {
+        interface => value
+      }
+    }
+    self.deliver_msg(msg)
+  end
+  
+  def get_msg
+    puts "Starting get message..."
+    #begin
+      Thread::abort_on_exception = true
+      Thread.new do
+        if @connected == false
+          @socket = TCPSocket.open( @socket_address, @socket_port )
+          connect_msg = {
+            "action" => "connect",
+            "driver" => @driver_name
+          }
+          puts "Sending #{connect_msg.to_json}..."
+          @socket.puts connect_msg.to_json
+          @connected = true
+        end
+        while response = @socket.gets.chomp
+          if @debug_enable == true
+            puts "Received message #{response}..."
+          end
+          msg = JSON.parse(response)
+          msg = msg["interface"]
+          if msg != nil
+            msg.each do |k,v|
+              if k != "delay" && k != "port" && @write_interfaces.include?(k)
+                method = "write_#{k}"
+                v = self.type_cast(k,v)
+                if @interfaces.keys.include?("port")
+                  unless @state["port"] == nil
+                    self.send(method, v)
+                  else
+                    self.msg_queue(method, v)
+                  end
+                else
+                  self.send(method, v)
+                end
+              elsif k == "delay"
+                if v.is_a?(String)
+                  v = JSON.parse(v)
+                end
+                v.each do |key, val|
+                  @delay[key] = val.to_f
+                  self.send_msg2(k,v)
+                end
+              else
+                self.send_msg2(k,v)
+              end
+            end
+          end
+        end
+      end
+    #rescue => e
+    #  puts e.message
+    #  puts e.backtrace
+    #  get_msg
+    #end
+  end
+  
+  def msg_queue(method, v)
+    array = [method, v]
+    @msg_queue << array
+    if @flush_active == false
+      self.flush_queue
+    end
+  end
+  
+  def flush_queue
+    Thread::abort_on_exception = true
+    Thread.new do
+      @flush_active = true
+      while @msg_queue.length > 0
+        entry = @msg_queue[0]
+        if @state["port"] != nil
+          self.send(entry[0], entry[1])
+          @msg_queue = @msg_queue - [entry]
+        end
+        sleep 0.1
+      end
+      @flush_active = false
+    end
+  end
+  
+  def read_msg
+    puts "starting read message"
+    @delay.each do |k,v|
+      unless @threads.keys.include?(k) || k == "port" || k == "delay"
+        #begin
+          Thread::abort_on_exception = true
+          t = Thread.new do
+            while true
+              unless @state["port"] == nil
+                read_function = "read_#{k}"
+                self.send(read_function)
+                sleep @delay[k]
+              end
+            end
+          end
+        #rescue => e
+        #  if @debug_enable == true
+        #    puts e.message
+        #    puts e.backtrace
+        #  end
+        #  @threads.delete(k)
+        #  read_msg
+        #end
+        @threads[k] = t
+      end
+    end
+  end
+  
+  
+  def close
+    msg = {
+      "action" => "disconnect"
+    }
+    msg = msg.to_json
+    self.deliver_msg(msg)
+  end
+  
+  def type_cast(k, v)
+    if @interfaces[k]["type"] == "boolean"
+      if v.is_a?(String)
+        if v == "true"
+          v = true
+        elsif v == "false"
+          v = false
+        end
+      end
+    end
+    if @interfaces[k]["type"] == "float"
+      if v.is_a?(String)
+        v = v.to_f
+      end
+    end
+    if @interface_kinds[@interfaces[k]["type"]] == "integer"
+      if v.is_a?(String)
+        v = v.to_i
+      end
+    end
+    return v
+  end
+  
+  def deliver_msg(msg)
+    if @debug_enable == true
+      puts "Sending Message: #{msg}\n"
+    end
+    jmsg = msg.to_json
+    @socket.puts(jmsg)
+  end
+  
+end

data/lib/templates/apiotics_interfaces.rb.erb

@@ -0,0 +1,33 @@
+require_relative './apiotics_driver'
+class <%= @driver_name %> < ApioticsDriver
+  
+  def initialize
+    super
+    self.get_msg
+    sleep 5
+    self.read_msg
+  end
+  
+  # the @state variable is available to you.  For each interface you have, you can get it's current
+  # value by reading @state["interface_name"].
+  <% @interfaces["all"].each do |k, v|%>
+  <% unless k == "port" || k == "delay" %>
+  <% if v["accessor"] == "write only" || v["accessor"] == "read/write"  %>
+  def <%= "write_#{k}(#{v["type"]})"%> 
+    
+    # Your hardware specific logic to set the state of your <%= k %> hardware goes here based on the value of the <%= v['type'] %> variable.
+    
+    self.send_msg(<%= v["type"]%>) # This line sends a confirmation message back to the web application noting that the operation is complete.
+  end
+  <% end %>
+  <% if v["accessor"] == "read only" || v["accessor"] == "read/write" %>
+  def <%= "read_#{k}"%> 
+    
+    # Your hardware specific logic here should read a value from your <%= k %> hardware, and set the <%= v["type"] %> variable appropriately.
+    
+    self.send_msg(<%= v["type"]%>) # This line sends the value in the <%= v["type"] %> variable to the web application.
+  end
+  <% end %>
+  <% end %>
+  <% end %>
+end