mdq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b6ccf8139b087e853fd80d2f993a1ed23f36fdb9f00e91a9cdfbe139ad925cc
+  data.tar.gz: 27be35859eb50189dfc0a892340f66c135f0b5071eacf4ef8b3d775a58397fcc
+SHA512:
+  metadata.gz: e667d4599d3a713d5eccfa134559d73b58c62ad7a86421dd02522cc3302925884e36785be34937b27ec39f243e466cdd4841bd9e0a75aa2619f88dd28b99688d
+  data.tar.gz: 9ed7bf1a7bde453757d2924eb9b9b64b9ee0289a76baa1720ffcfcd53a2d1f88cc37990d67ae11adcbc31a0e29beb28bb9f2ab64363ae8420a73659b308c7c88

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,38 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 999999`
+# on 2025-05-18 05:31:37 UTC using RuboCop version 1.71.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 38
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 46
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 160
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 4
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 50
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 arthur87
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+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/README.base.md

@@ -0,0 +1,103 @@
+<!---------------------------->
+<!-- multilingual suffix: en, ja -->
+<!-- no suffix: en -->
+<!---------------------------->
+
+<!-- $ mmg -y README.base.md -->
+
+# mdq - Mobile Device Query
+
+MDQ stands for Mobile Device Query and is a command line tool for displaying information about Android and Apple devices.  
+
+# Usage
+
+## Check
+
+To fully use MDQ, you need to install ADB and Xcode beforehand.
+Check the software installation status.
+
+```
+$ mdq check
+```
+
+## List
+
+It's easy to use.
+
+```
+$ mdq list
+[
+  {
+    "id": 1,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "Pixel Tablet",
+    "authorized": true,
+    "platform": "Android",
+    "marketing_name": null,
+    "model": "Pixel Tablet",
+    "build_version": "16",
+    "build_id": "BP22.250325.012",
+    "battery_level": 89,
+    "total_capacity": 115855444,
+    "free_capacity": 101137652
+   },
+   {
+    "id": 2,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "iPhone 16 Pro",
+    "authorized": true,
+    "platform": "iOS",
+    "marketing_name": "iPhone 16 Pro",
+    "model": "iPhone17,1",
+    "build_version": "18.4.1",
+    "build_id": "22E252",
+    "battery_level": null,
+    "total_capacity": null,
+    "free_capacity": null
+  }
+]
+```
+
+You can filter using SQL.
+
+```
+$ mdq list -q="select * from devices where platform='iOS'"
+[
+   {
+    "id": 1,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "iPhone 16 Pro",
+    "authorized": true,
+    "platform": "iOS",
+    "marketing_name": "iPhone 16 Pro",
+    "model": "iPhone17,1",
+    "build_version": "18.4.1",
+    "build_id": "22E252",
+    "battery_level": null,
+    "total_capacity": null,
+    "free_capacity": null
+  }
+]
+```
+
+# Specification
+
+Details of the devices table.
+
+| name | android | apple devices |
+| -- | -- | -- |
+| udid | Serial number | hardwareProperties.udid |
+| serial_number | Serial number | hardwareProperties.serialNumber |
+| name | device_name | deviceProperties.name | 
+| authorized | "False" if additional authentication is required. | Always "True" |
+| platform | Always "Android" | hardwareProperties.platform |
+| marketing_name | Always "null" | hardwareProperties.marketingName |
+| model | ro.product.model | hardwareProperties.productType |
+| build_version | ro.build.version.release | deviceProperties.osVersionNumber |
+| build_id | ro.build.id | deviceProperties.osBuildUpdate | 
+| battery_level | battery | Always "null" |
+| total_capacity | df | Always "null" |
+| free_capacity | df | Always "null" |

data/README.ja.md

@@ -0,0 +1,98 @@
+
+
+# mdq - Mobile Device Query
+
+MDQ stands for Mobile Device Query and is a command line tool for displaying information about Android and Apple devices.  
+
+# Usage
+
+## Check
+
+To fully use MDQ, you need to install ADB and Xcode beforehand.
+Check the software installation status.
+
+```
+$ mdq check
+```
+
+## List
+
+It's easy to use.
+
+```
+$ mdq list
+[
+  {
+    "id": 1,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "Pixel Tablet",
+    "authorized": true,
+    "platform": "Android",
+    "marketing_name": null,
+    "model": "Pixel Tablet",
+    "build_version": "16",
+    "build_id": "BP22.250325.012",
+    "battery_level": 89,
+    "total_capacity": 115855444,
+    "free_capacity": 101137652
+   },
+   {
+    "id": 2,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "iPhone 16 Pro",
+    "authorized": true,
+    "platform": "iOS",
+    "marketing_name": "iPhone 16 Pro",
+    "model": "iPhone17,1",
+    "build_version": "18.4.1",
+    "build_id": "22E252",
+    "battery_level": null,
+    "total_capacity": null,
+    "free_capacity": null
+  }
+]
+```
+
+You can filter using SQL.
+
+```
+$ mdq list -q="select * from devices where platform='iOS'"
+[
+   {
+    "id": 1,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "iPhone 16 Pro",
+    "authorized": true,
+    "platform": "iOS",
+    "marketing_name": "iPhone 16 Pro",
+    "model": "iPhone17,1",
+    "build_version": "18.4.1",
+    "build_id": "22E252",
+    "battery_level": null,
+    "total_capacity": null,
+    "free_capacity": null
+  }
+]
+```
+
+# Specification
+
+Details of the devices table.
+
+| name | android | apple devices |
+| -- | -- | -- |
+| udid | Serial number | hardwareProperties.udid |
+| serial_number | Serial number | hardwareProperties.serialNumber |
+| name | device_name | deviceProperties.name | 
+| authorized | "False" if additional authentication is required. | Always "True" |
+| platform | Always "Android" | hardwareProperties.platform |
+| marketing_name | Always "null" | hardwareProperties.marketingName |
+| model | ro.product.model | hardwareProperties.productType |
+| build_version | ro.build.version.release | deviceProperties.osVersionNumber |
+| build_id | ro.build.id | deviceProperties.osBuildUpdate | 
+| battery_level | battery | Always "null" |
+| total_capacity | df | Always "null" |
+| free_capacity | df | Always "null" |

data/README.md

@@ -0,0 +1,98 @@
+
+
+# mdq - Mobile Device Query
+
+MDQ stands for Mobile Device Query and is a command line tool for displaying information about Android and Apple devices.  
+
+# Usage
+
+## Check
+
+To fully use MDQ, you need to install ADB and Xcode beforehand.
+Check the software installation status.
+
+```
+$ mdq check
+```
+
+## List
+
+It's easy to use.
+
+```
+$ mdq list
+[
+  {
+    "id": 1,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "Pixel Tablet",
+    "authorized": true,
+    "platform": "Android",
+    "marketing_name": null,
+    "model": "Pixel Tablet",
+    "build_version": "16",
+    "build_id": "BP22.250325.012",
+    "battery_level": 89,
+    "total_capacity": 115855444,
+    "free_capacity": 101137652
+   },
+   {
+    "id": 2,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "iPhone 16 Pro",
+    "authorized": true,
+    "platform": "iOS",
+    "marketing_name": "iPhone 16 Pro",
+    "model": "iPhone17,1",
+    "build_version": "18.4.1",
+    "build_id": "22E252",
+    "battery_level": null,
+    "total_capacity": null,
+    "free_capacity": null
+  }
+]
+```
+
+You can filter using SQL.
+
+```
+$ mdq list -q="select * from devices where platform='iOS'"
+[
+   {
+    "id": 1,
+    "udid": "XXXXX",
+    "serial_number": "XXXXX",
+    "name": "iPhone 16 Pro",
+    "authorized": true,
+    "platform": "iOS",
+    "marketing_name": "iPhone 16 Pro",
+    "model": "iPhone17,1",
+    "build_version": "18.4.1",
+    "build_id": "22E252",
+    "battery_level": null,
+    "total_capacity": null,
+    "free_capacity": null
+  }
+]
+```
+
+# Specification
+
+Details of the devices table.
+
+| name | android | apple devices |
+| -- | -- | -- |
+| udid | Serial number | hardwareProperties.udid |
+| serial_number | Serial number | hardwareProperties.serialNumber |
+| name | device_name | deviceProperties.name | 
+| authorized | "False" if additional authentication is required. | Always "True" |
+| platform | Always "Android" | hardwareProperties.platform |
+| marketing_name | Always "null" | hardwareProperties.marketingName |
+| model | ro.product.model | hardwareProperties.productType |
+| build_version | ro.build.version.release | deviceProperties.osVersionNumber |
+| build_id | ro.build.id | deviceProperties.osBuildUpdate | 
+| battery_level | battery | Always "null" |
+| total_capacity | df | Always "null" |
+| free_capacity | df | Always "null" |

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/exe/mdq

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'mdq'
+
+Mdq::CLI.start

data/lib/mdq/check.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'mdq'
+
+# Mdq
+module Mdq
+  # Check
+  class Check
+    def initialize
+      ddb = Mdq::DDB.new
+      ddb.show_version('adb', 'adb version')
+      ddb.show_version('Xcode', 'xcrun devicectl --version')
+    end
+  end
+end

data/lib/mdq/cli.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'mdq'
+require 'thor'
+
+module Mdq
+  # entry point
+  class CLI < Thor
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+
+    desc 'version', 'Show Version'
+    def version
+      puts(Mdq::VERSION)
+    end
+
+    desc 'check', 'Check the software installation status'
+    def check
+      Mdq::Check.new
+    end
+
+    desc 'list', 'Show mobile devices'
+    method_option :output, desc: 'Save the results as a JSON file', aliases: '-o'
+    method_option :query, desc: 'SQL to filter devices', aliases: '-q'
+    method_option :cap, desc: 'Path to save screenshots(Android only)'
+    method_option :install, desc: 'Installing the app'
+    method_option :uninstall, desc: 'Uninstalling the app'
+    def list
+      Mdq::List.new(options)
+    end
+  end
+end

data/lib/mdq/ddb.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+require 'mdq'
+require 'active_record'
+require 'fileutils'
+
+# Mdq
+module Mdq
+  # DDB
+  class DDB
+    def initializ; end
+
+    # 接続中のデバイスを取得する
+    def get(sql)
+      ActiveRecord::Schema.verbose = false
+      InitialSchema.migrate(:up)
+
+      android_discover
+      apple_discover
+
+      if sql
+        begin
+          ActiveRecord::Base.connection.execute(sql)
+        rescue StandardError
+          warn 'SQL Syntax Error.'
+          exit
+        end
+      else
+        Device.all
+      end
+    end
+
+    # 指定したソフトウェアのインストール状況を表示する
+    def show_version(name, command)
+      output, = Open3.capture3(command)
+      puts "# #{name} installed."
+      puts output
+    rescue StandardError
+      puts "# #{name} is not installed."
+    end
+
+    # Androidデバイスのスクリーンショットを撮る
+    def device_screencap(output, udid, is_android)
+      return unless is_android
+
+      FileUtils.mkdir_p(output)
+      file = "/sdcard/#{udid}.png"
+      adb_command("shell screencap -p #{file}", udid)
+      adb_command("pull #{file} #{output}", udid)
+      adb_command("adb shell rm #{file}")
+    end
+
+    def app_install(input, udid, is_android)
+      if is_android && input.end_with?('.apk')
+        adb_command("install #{input}", udid)
+      else
+        apple_command("device install app #{input}", udid)
+      end
+    end
+
+    def app_uninstall(input, udid, is_android)
+      if is_android
+        adb_command("uninstall #{input}", udid)
+      else
+        apple_command("device uninstall app #{input}", udid)
+      end
+    end
+
+    private
+
+    # Androidデバイス一覧を取得する
+    def android_discover
+      output, = adb_command('devices -l')
+      return if output.nil?
+
+      output.split("\n").each_with_index do |line, index|
+        next if index.zero?
+
+        columns = line.split
+
+        udid = columns[0]
+        authorized = line.index('unauthorized').nil?
+
+        if authorized
+          model = adb_command('shell getprop ro.product.model', udid)
+          build_version = adb_command('shell getprop ro.build.version.release', udid)
+          build_id = adb_command('shell getprop ro.build.id', udid)
+          name = adb_command('shell settings get global device_name', udid)
+          battery_level = nil
+          total_capacity = nil
+          free_capacity = nil
+
+          # バッテリー
+          lines1, = adb_command('shell dumpsys battery', udid)
+          if (match = lines1.match(/level: (\d*)/))
+            battery_level = match[1].to_i
+          end
+
+          # ストレージ
+          lines2, = adb_command('shell df', udid)
+          lines2.split("\n").each_with_index do |line2, index2|
+            next if index2.zero?
+
+            columns = line2.split
+            unless columns[5].index('/data').nil?
+              total_capacity = columns[1]
+              free_capacity = columns[3]
+            end
+          end
+
+          Device.create({
+                          udid: udid,
+                          serial_number: udid,
+                          name: name,
+                          authorized: true,
+                          model: model,
+                          build_version: build_version,
+                          build_id: build_id,
+                          battery_level: battery_level,
+                          total_capacity: total_capacity,
+                          free_capacity: free_capacity,
+                          platform: 'Android'
+                        })
+        else
+          Device.create({
+                          udid: udid,
+                          serial_number: udid,
+                          authorized: false,
+                          platform: 'Android'
+                        })
+        end
+      end
+    end
+
+    # ADBコマンド
+    def adb_command(arg, udid = nil)
+      command = if udid.nil?
+                  "adb #{arg}"
+                else
+                  "adb -s #{udid} #{arg}"
+                end
+
+      begin
+        output, = Open3.capture3(command)
+        output.strip
+      rescue StandardError
+        nil
+      end
+    end
+
+    # devicectlコマンド
+    def apple_command(arg, udid = nil)
+      command = if udid.nil?
+                  "xcrun devicectl #{arg}"
+                else
+                  "xcrun devicectl #{arg} --device #{udid}"
+                end
+
+      begin
+        output, = Open3.capture3(command)
+        output.strip
+      rescue StandardError
+        nil
+      end
+    end
+
+    # Appleデバイス一覧を取得する
+    def apple_discover
+      file = [Dir.home, '.mdq.json'].join(File::Separator)
+
+      begin
+        Open3.capture3("xcrun devicectl list devices -v -j #{file}")
+      rescue StandardError
+        return
+      end
+
+      return unless File.exist?(file)
+
+      File.open(file, 'r') do |f|
+        result = JSON.parse(f.read)
+        result['result']['devices'].each do |device|
+          Device.create({
+                          udid: device['hardwareProperties']['udid'],
+                          serial_number: device['hardwareProperties']['serialNumber'],
+                          name: device['deviceProperties']['name'],
+                          authorized: true,
+                          platform: device['hardwareProperties']['platform'],
+                          marketing_name: device['hardwareProperties']['marketingName'],
+                          model: device['hardwareProperties']['productType'],
+                          build_version: device['deviceProperties']['osVersionNumber'],
+                          build_id: device['deviceProperties']['osBuildUpdate']
+                        })
+        end
+
+        File.delete(file)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+# スキーマの設定
+class InitialSchema < ActiveRecord::Migration[5.1]
+  def self.up
+    create_table :devices do |t|
+      t.string :udid
+      t.string :serial_number
+      t.string :name
+      t.boolean :authorized
+      t.string :platform
+      t.string :marketing_name
+      t.string :model
+      t.string :build_version
+      t.string :build_id
+      t.integer :battery_level
+      t.integer :total_capacity
+      t.integer :free_capacity
+    end
+  end
+
+  def self.down
+    drop_table :devices
+  end
+end
+
+class Device < ActiveRecord::Base
+end

data/lib/mdq/list.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'mdq'
+
+# Mdq
+module Mdq
+  # List
+  class List
+    def initialize(options)
+      ddb = Mdq::DDB.new
+      devices = ddb.get(options['query'])
+
+      output = JSON.pretty_generate(devices.as_json)
+      puts output
+      if options['output']
+        File.open(options['output'], 'w') do |f|
+          f.write(output)
+        end
+      end
+
+      devices.each do |device|
+        model = Device.find_by(udid: device.udid)
+        udid = model.udid
+        is_android = model.platform == 'Android'
+
+        ddb.device_screencap(options[:cap], udid, is_android) if options[:cap]
+        ddb.app_install(options[:install], udid) if options[:install]
+        ddb.app_uninstall(options[:uninstall], udid, is_android) if options[:uninstall]
+      rescue StandardError
+        # none
+      end
+    end
+  end
+end

data/lib/mdq/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mdq
+  VERSION = '0.1.0'
+end

data/lib/mdq.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'mdq/version'
+require 'mdq/cli'
+require 'mdq/check'
+require 'mdq/list'
+require 'mdq/ddb'
+require 'open3'
+require 'active_record'
+require 'json'
+
+module Mdq
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mdq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- arthur87
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: mdq is a command line tool for displaying information about Android and
+  Apple devices.
+email:
+- arthur87@users.noreply.github.com
+executables:
+- mdq
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- LICENSE
+- README.base.md
+- README.ja.md
+- README.md
+- Rakefile
+- exe/mdq
+- lib/mdq.rb
+- lib/mdq/check.rb
+- lib/mdq/cli.rb
+- lib/mdq/ddb.rb
+- lib/mdq/list.rb
+- lib/mdq/version.rb
+homepage: https://github.com/arthur87/mdq
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arthur87/mdq
+  source_code_uri: https://github.com/arthur87/mdq
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: mdq is a command line tool for displaying information about Android and Apple
+  devices.
+test_files: []