comma-api-rb 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5a3762b9cae821798872f7f1454bd2fa50af41d
+  data.tar.gz: 4005e58e30f8b6ba112f9febc07601bdc9c2746d
+SHA512:
+  metadata.gz: 5fbc0183d97c3fb4a0ac31ccb2a37c6c7be5d640f36e17b47303e52cf3110bcccee750adddad8d035c6f44c730932e40bc72a2e7495c629802e14647f9ea87d3
+  data.tar.gz: 7c329c8fc03fbc10dae2f226653a1ae6d00ae8abfb884806eccb1c1f6aef967d29c9e79194e60db8916018ef2d46b66437afef0aae4780f6e1f2cc6458bcd89e

data/lib/api_client_lib.rb

@@ -0,0 +1,52 @@
+module CommaAPI
+
+  class RPCError < Exception; end
+  class RPCError404 < RPCError; end
+
+  module HTTP
+
+    def request(url:)
+      uri  = URI url
+      req  = Net::HTTP::Get.new uri.request_uri
+      req["Authorization"] = "JWT #{::JWT_TOKEN}"
+      resp = http(uri: uri).request req
+      return RPCError404.new if resp.code == "404"
+      JSON.parse resp.body
+    end
+
+    def post_request(url:, data:)
+      uri  = URI url
+      req  = Net::HTTP::Post.new uri.request_uri
+      req["Authorization"] = "JWT #{::JWT_TOKEN}"
+      req.body = data
+      resp = http(uri: uri).request req
+      JSON.parse resp.body
+    end
+
+    def http(uri:)
+      http = Net::HTTP.new uri.host, uri.port
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http
+    end
+
+  end
+
+
+  # TODO: move (and refactor with refinements)
+
+  module Monkeypatches
+    class ::Hash
+      alias :f :fetch
+
+      def sym_keys
+        Hash[self.map{ |key,value| [key.to_sym, value] }]
+      end
+
+      def str_keys
+        Hash[self.map{ |key,value| [key.to_s, value] }]
+      end
+    end
+  end
+
+end

data/lib/athena_api.rb

@@ -0,0 +1,93 @@
+module CommaAPI
+
+  class Athena
+
+    extend ConfigAthena
+    extend HTTP
+
+    STATE = {
+      rpc_id: 0
+    }
+
+    RpcId = -> {
+      STATE[:rpc_id] += 1
+    }
+
+    class << self
+
+      def health
+        post_rpc m: "getMessage", service: "health"
+      end
+
+      def carState
+        post_rpc m: "getMessage", service: "carState"
+      end
+
+      def logMessage
+        post_rpc m: "getMessage", service: "logMessage"
+      end
+
+      def androidLog
+        post_rpc m: "getMessage", service: "androidLog"
+      end
+
+      def procLog
+        post_rpc m: "getMessage", service: "procLog"
+      end
+
+      def gpsLocation
+        post_rpc m: "getMessage", service: "gpsLocation"
+      end
+
+      def thermal
+        data = post_rpc m: "getMessage", service: "thermal"
+        data[:cpu] = thermal_cpu_avg(data: data)
+        data
+      end
+
+      # ---
+
+      def thermal_cpu_avg(data:)
+        temps = [data.f(:cpu0), data.f(:cpu1), data.f(:cpu2), data.f(:cpu3)]
+        (temps.reduce(:+).to_f / temps.size).round
+      end
+
+      # ---
+
+      def rpc_msg(m:, service:)
+        {
+          method: m,
+          params: { service: service, timeout: 3000 },
+          jsonrpc: "2.0",
+          id: RpcId.(),
+        }.str_keys.to_json
+      end
+
+      def post_rpc(m:, service:)
+        puts "-> rpc message: m: #{m.inspect}, service: #{service.inspect}"
+        url = "#{API_HOST}/#{DONGLE_ID_DEFAULT}"
+        data = rpc_msg(m: m, service: service)
+        begin
+          resp = post_request url: url, data: data
+        rescue
+          return RPCError.new "JSON Parse Error"
+        end
+        parse_rpc resp, service: service
+      end
+
+      def parse_rpc(resp, service:)
+        return RPCError.new if resp["error"] == "Timed out"
+        return RPCError.new if resp["error"] && resp["error"]["message"] == "Server error"
+        result = resp.fetch "result"
+        result = result[service] if result[service]
+        result = result["androidLogEntry"] if service == "androidLog"
+        # TODO: use inflecto gem to snakecase keys
+        result = JSON.parse result if result.is_a? String # TODO: do this only for `logMessage` service
+        result.sym_keys
+      end
+
+    end
+
+  end
+
+end

data/lib/comma-api-rb.rb

@@ -0,0 +1,5 @@
+require_relative 'env'
+
+require_relative 'athena_api'
+
+require_relative 'comma_api'

data/lib/comma_api.rb

@@ -0,0 +1,122 @@
+module CommaAPI
+  class API
+
+    extend Config
+    extend HTTP
+
+    class << self
+
+      # user
+
+      def me
+        get "/v1/me/"
+      end
+
+      # devices
+
+      def devices
+        get "/v1/me/devices/"
+      end
+
+      def device(id:)
+        get "/v1.1/devices/#{id}/"
+      end
+
+      def deviceLocation(id:)
+        get "/v1/devices/#{id}/location"
+      end
+
+      def deviceDefaultLocation
+        return device404Error unless DONGLE_ID_DEFAULT
+        deviceLocation id: DONGLE_ID_DEFAULT
+      end
+
+      def deviceDefault
+        return device404Error unless DONGLE_ID_DEFAULT
+        device id: DONGLE_ID_DEFAULT
+      end
+
+      def deviceDefaultStats
+        return device404Error unless DONGLE_ID_DEFAULT
+        deviceStats id: DONGLE_ID_DEFAULT
+      end
+
+      def deviceStats(id:)
+        get "/v1/devices/#{id}/stats"
+      end
+
+      def devicesStat(id:)
+        devices = get "/v1/devices"
+        # TODO: loop through all devices, return all stats and a total
+        devices.map { |device|
+          get "/v1/devices/#{device.f("dongle_id")}/stats#{args}"
+        }
+      end
+
+      def deviceStatsId(id:)
+        get "/v1/devices/#{id}/stats#{args}"
+      end
+
+      # routes
+
+      def route(route_name:)
+        get "/v1/route/#{route_name}/"
+      end
+
+      def routeFiles(route_name:)
+        get "/v1/route/#{route_name}/files"
+      end
+
+      # segments
+
+      def segments
+        return device404Error unless DONGLE_ID_DEFAULT
+        get "/v1/devices/#{DONGLE_ID_DEFAULT}/segments#{args}"
+      end
+
+      def deviceSegments(id:)
+        return device404Error unless DONGLE_ID_DEFAULT
+        get "/v1/devices/#{id}/segments#{args}"
+      end
+
+      def deviceDefaultSegments
+        return device404Error unless DONGLE_ID_DEFAULT
+        deviceSegments id: DONGLE_ID_DEFAULT
+      end
+
+      def args
+        defaultArgs # alias (alias :args :defaultArgs)
+      end
+
+      def defaultArgs
+        one_week = 604800
+        "?from=#{(Time.now - one_week - 1).to_i}"
+      end
+
+      def opAuth
+        "https://api.commadotai.com/v2/pilotauth/"
+      end
+
+
+      # helper
+
+      def get(method_name)
+        # note: trailing slash gets added here
+        puts "requesting: #{method_name}"
+        url = "#{API_HOST}#{method_name}"
+        puts url
+        request url: url
+      end
+
+
+      # errors
+
+      def device404Error
+        { error: 'Error: DONGLE_ID_DEFAULT is missing - this method cannot be executed, you need to specify a dongle id' }.to_json
+      end
+
+    end
+
+  end
+
+end

data/lib/config.rb

@@ -0,0 +1,27 @@
+module CommaAPI
+
+  module Config
+
+    API_HOST = "https://api.comma.ai"
+
+    ::JWT_TOKEN = ENV["JWT_TOKEN"] || ENV["COMMA_JWT_TOKEN"]
+    raise "JWT_TOKEN not defined, please pass it as ENV variable (rake JWT_TOKEN=YourJwtToken....)" unless JWT_TOKEN
+
+    DONGLE_ID_DEFAULT = ENV["DONGLE_ID_DEFAULT"]
+
+
+    # default device id - used on the `.deviceDefault()` methods
+
+  end
+
+
+  module ConfigAthena
+
+    API_HOST = "https://athena.comma.ai"
+
+    # ::JWT_TOKEN = Config::JWT_TOKEN
+    DONGLE_ID_DEFAULT = Config::DONGLE_ID_DEFAULT
+
+  end
+
+end

data/lib/env.rb

@@ -0,0 +1,17 @@
+require "net/https"
+require 'json'
+require 'cgi'
+# require 'bundler'
+# Bundler.require :default
+require_relative 'config'
+
+module CommaAPI
+  PATH = File.expand_path "./"
+
+  # -----
+  # TODO: refactor
+
+  require_relative 'api_client_lib'
+
+  include Monkeypatches
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CommaAPI
+  VERSION = "TODO - please check gemspec"
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: comma-api-rb
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- "@makevoid - Francesco Canessa"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-23 00:00:00.000000000 Z
+dependencies: []
+description: Comma and Athena API ruby library (prototype - this version is currently
+  in WIP, public API and functionality is guaranteed to change overtime :D, thanks
+  for understanding)
+email: makevoid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/api_client_lib.rb"
+- "./lib/athena_api.rb"
+- "./lib/comma-api-rb.rb"
+- "./lib/comma_api.rb"
+- "./lib/config.rb"
+- "./lib/env.rb"
+- "./lib/version.rb"
+homepage: https://github.com/makevoid/comma_api_rb
+licenses:
+- GPL-3.0
+metadata:
+  source_code_uri: https://github.com/makevoid/comma_api_rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Comma and Athena API ruby library (prototype)
+test_files: []