fastlane-plugin-pcloudy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31b41a535d0d2a935e7bd9df3d37c97260491f3bcbc758cc62d473e762f34969
+  data.tar.gz: e8861e28863669b33b4a52049fa738014412db6aed0839b8df268c0ea77a7a46
+SHA512:
+  metadata.gz: 2edbd581c9ada9dba62432426856447ba32173489260fb97767a8007365e992a21ec316c7b917ed5906f8745317df8cab3687793a8092f89cd84f8a4fa161fa5
+  data.tar.gz: 6d92f4f62758cf0745779161f70e88c520b07ef63be2da5632002c26dcfd43b43872b75d42ca519d4130770d1c8a0e5c7a0c689882c7ab92b38c4e16ea2eb9c3

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.0
+
+First release.
+
+- `pcloudy_list_devices`: lists real iOS and Android devices on pCloudy, with filters for
+  platform, availability, OS version, manufacturer and device name. Prints a table, returns
+  the devices, and stores them in `lane_context[SharedValues::PCLOUDY_DEVICES]`.
+- Supports device.pcloudy.com and private clouds through `cloud_url` / `PCLOUDY_CLOUD_URL`.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Smart Software Testing Solutions
+
+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.md

@@ -0,0 +1,63 @@
+# fastlane-plugin-pcloudy
+
+A [fastlane](https://fastlane.tools) plugin for [pCloudy](https://www.pcloudy.com). It lets your fastlane lanes work with real iOS and Android devices on the pCloudy device cloud.
+
+| Action | Status |
+|---|---|
+| `pcloudy_list_devices`: list available devices | ✅ Available |
+| `pcloudy_upload_app`: upload an `.ipa` / `.apk` | Planned |
+| `pcloudy_resign_app`: resign an `.ipa` for pCloudy devices | Planned |
+| `pcloudy_book_device` / `pcloudy_release_device` | Planned |
+| `pcloudy_install_app`: install and launch on a booked device | Planned |
+
+## Installation
+
+```bash
+fastlane add_plugin pcloudy
+```
+
+This adds `gem "fastlane-plugin-pcloudy"` to your project's `fastlane/Pluginfile`.
+
+## Credentials
+
+Put your pCloudy credentials in `fastlane/.env`, and keep that file out of git:
+
+```
+PCLOUDY_USERNAME=you@company.com
+PCLOUDY_API_KEY=your-api-key        # pCloudy > Settings > API Key
+# PCLOUDY_CLOUD_URL=https://device.pcloudy.com   # optional, for private clouds
+```
+
+## `pcloudy_list_devices`
+
+```ruby
+pcloudy_list_devices                                         # all available devices
+pcloudy_list_devices(platform: "ios", os_version: "17")      # iOS 17.x only
+devices = pcloudy_list_devices(platform: "android",
+                               manufacturer: "Samsung",
+                               print_table: false)
+UI.message("First device id: #{devices.first['id']}")
+```
+
+| Option | Env var | Default | Description |
+|---|---|---|---|
+| `username` | `PCLOUDY_USERNAME` | — | pCloudy account email |
+| `api_key` | `PCLOUDY_API_KEY` | — | pCloudy API key |
+| `cloud_url` | `PCLOUDY_CLOUD_URL` | `https://device.pcloudy.com` | Cloud URL |
+| `platform` | `PCLOUDY_PLATFORM` | `all` | `ios`, `android` or `all` |
+| `available_now` | `PCLOUDY_AVAILABLE_NOW` | `true` | Only devices that are free now |
+| `duration` | `PCLOUDY_DURATION` | `10` | Minutes, used for the availability check |
+| `os_version` | `PCLOUDY_OS_VERSION` | — | OS version or prefix, e.g. `17` or `17.5` |
+| `manufacturer` | `PCLOUDY_MANUFACTURER` | — | e.g. `Apple`, `Samsung` |
+| `name` | `PCLOUDY_DEVICE_NAME` | — | Text in the device name, e.g. `iPhone 15` |
+| `print_table` | — | `true` | Print a table of the results |
+
+The action returns an array of device hashes (`id`, `full_name`, `display_name`, `model`, `manufacturer`, `platform`, `version`, `available`, …). It also stores the array in `lane_context[SharedValues::PCLOUDY_DEVICES]`.
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec                                    # unit tests (HTTP is stubbed)
+bundle exec fastlane list_devices platform:ios       # live run, needs fastlane/.env
+```

data/lib/fastlane/plugin/pcloudy/actions/pcloudy_list_devices_action.rb

@@ -0,0 +1,182 @@
+require "fastlane/action"
+require "terminal-table"
+require_relative "../helper/pcloudy_client"
+
+module Fastlane
+  module Actions
+    module SharedValues
+      PCLOUDY_DEVICES = :PCLOUDY_DEVICES
+    end
+
+    class PcloudyListDevicesAction < Action
+      PLATFORMS = %w(ios android all).freeze
+
+      def self.run(params)
+        client = Helper::PcloudyClient.new(username: params[:username],
+                                           api_key: params[:api_key],
+                                           cloud_url: params[:cloud_url])
+
+        platforms = params[:platform] == "all" ? %w(ios android) : [params[:platform]]
+        devices = platforms.flat_map do |platform|
+          client.devices(platform: platform,
+                         duration: params[:duration],
+                         available_now: params[:available_now])
+        end
+
+        devices = filter(devices, params)
+
+        print_table(devices, params) if params[:print_table]
+        UI.success("Found #{devices.count} pCloudy device(s)")
+
+        Actions.lane_context[SharedValues::PCLOUDY_DEVICES] = devices
+        devices
+      rescue Helper::PcloudyClient::Error => e
+        UI.user_error!(e.message)
+      end
+
+      def self.filter(devices, params)
+        devices.select do |device|
+          matches_version?(device["version"], params[:os_version]) &&
+            matches_text?(device["manufacturer"], params[:manufacturer]) &&
+            matches_name?(device, params[:name])
+        end
+      end
+
+      # "17" matches 17.5.1 and 17.0, but not 1.7 or 170.0
+      def self.matches_version?(version, wanted)
+        return true if wanted.to_s.empty?
+
+        version = version.to_s
+        version == wanted || version.start_with?("#{wanted}.")
+      end
+
+      def self.matches_text?(value, wanted)
+        wanted.to_s.empty? || value.to_s.casecmp?(wanted.to_s)
+      end
+
+      def self.matches_name?(device, wanted)
+        return true if wanted.to_s.empty?
+
+        needle = wanted.to_s.downcase.delete(" ")
+        [device["full_name"], device["display_name"], device["model"]].any? do |value|
+          value.to_s.downcase.delete(" ").include?(needle)
+        end
+      end
+
+      def self.print_table(devices, params)
+        if devices.empty?
+          UI.important("No pCloudy devices matched your filters")
+          return
+        end
+
+        rows = devices.map do |d|
+          [d["id"], d["display_name"], d["manufacturer"], d["platform"], d["version"], d["available"] ? "yes" : "no"]
+        end
+        title = "pCloudy devices (#{params[:platform]}#{params[:available_now] ? ', available now' : ''})"
+        puts(Terminal::Table.new(title: title,
+                                 headings: ["ID", "Device", "Manufacturer", "Platform", "OS", "Available"],
+                                 rows: rows))
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Lists real iOS and Android devices on the pCloudy device cloud"
+      end
+
+      def self.details
+        "Authenticates with your pCloudy username and API key, fetches the device list, " \
+          "optionally filters it by OS version, manufacturer or name, prints a table and returns the devices."
+      end
+
+      def self.authors
+        ["bikee1235"]
+      end
+
+      def self.return_value
+        "Array of device hashes as returned by pCloudy (id, full_name, display_name, model, manufacturer, platform, version, available, ...)"
+      end
+
+      def self.output
+        [["PCLOUDY_DEVICES", "Array of the devices that matched"]]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "PCLOUDY_USERNAME",
+                                       description: "pCloudy account email",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "PCLOUDY_API_KEY",
+                                       description: "pCloudy API key (Settings > API Key)",
+                                       optional: false,
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :cloud_url,
+                                       env_name: "PCLOUDY_CLOUD_URL",
+                                       description: "pCloudy cloud URL (change for private clouds)",
+                                       default_value: Helper::PcloudyClient::DEFAULT_CLOUD_URL,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                       env_name: "PCLOUDY_PLATFORM",
+                                       description: "Device platform: ios, android or all",
+                                       default_value: "all",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("platform must be one of #{PLATFORMS.join(', ')}") unless PLATFORMS.include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :available_now,
+                                       env_name: "PCLOUDY_AVAILABLE_NOW",
+                                       description: "Only list devices that are free right now",
+                                       default_value: true,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :duration,
+                                       env_name: "PCLOUDY_DURATION",
+                                       description: "Booking duration in minutes used for the availability check",
+                                       default_value: 10,
+                                       type: Integer),
+          FastlaneCore::ConfigItem.new(key: :os_version,
+                                       env_name: "PCLOUDY_OS_VERSION",
+                                       description: "Only devices with this OS version or prefix, e.g. \"17\" or \"17.5\"",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :manufacturer,
+                                       env_name: "PCLOUDY_MANUFACTURER",
+                                       description: "Only devices from this manufacturer, e.g. Apple, Samsung",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       env_name: "PCLOUDY_DEVICE_NAME",
+                                       description: "Only devices whose name contains this text, e.g. \"iPhone 15\"",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :print_table,
+                                       description: "Print the devices as a table",
+                                       default_value: true,
+                                       type: Boolean)
+        ]
+      end
+
+      def self.example_code
+        [
+          'pcloudy_list_devices',
+          'pcloudy_list_devices(platform: "ios", os_version: "17")',
+          'devices = pcloudy_list_devices(platform: "android", manufacturer: "Samsung", print_table: false)'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/pcloudy/helper/pcloudy_client.rb

@@ -0,0 +1,87 @@
+require "json"
+require "net/http"
+require "uri"
+
+module Fastlane
+  module Helper
+    # Thin wrapper around the pCloudy REST API.
+    # Every pCloudy response has the shape {"result": {"code": 200, ...}}.
+    class PcloudyClient
+      class Error < StandardError; end
+
+      DEFAULT_CLOUD_URL = "https://device.pcloudy.com".freeze
+
+      def initialize(username:, api_key:, cloud_url: DEFAULT_CLOUD_URL, timeout: 60)
+        @username = username
+        @api_key = api_key
+        @timeout = timeout
+        @base = URI(normalize_url(cloud_url))
+      end
+
+      # GET /api/access with basic auth (email:api_key). The token is cached per client.
+      def token
+        @token ||= begin
+          request = Net::HTTP::Get.new(endpoint("/api/access"))
+          request.basic_auth(@username, @api_key)
+          result = perform(request)
+          result["token"] || raise(Error, "pCloudy authentication returned no token")
+        end
+      end
+
+      # POST /api/devices. Returns an array of device hashes (string keys), e.g.
+      # {"id" => 827, "full_name" => "Apple_iPhone11Pro_Ios_17.5.1_45645", "platform" => "ios", "version" => "17.5.1", ...}
+      def devices(platform:, duration: 10, available_now: true)
+        result = post_json("/api/devices",
+                           token: token,
+                           duration: duration,
+                           platform: platform,
+                           available_now: available_now.to_s)
+        result["models"] || []
+      end
+
+      private
+
+      def post_json(path, payload)
+        request = Net::HTTP::Post.new(endpoint(path), "Content-Type" => "application/json")
+        request.body = JSON.generate(payload)
+        perform(request)
+      end
+
+      def perform(request)
+        response = Net::HTTP.start(@base.host, @base.port,
+                                   use_ssl: @base.scheme == "https",
+                                   open_timeout: @timeout,
+                                   read_timeout: @timeout) do |http|
+          http.request(request)
+        end
+
+        path = request.path
+        raise(Error, "pCloudy #{path} returned HTTP #{response.code}") unless response.is_a?(Net::HTTPSuccess)
+
+        result = JSON.parse(response.body.to_s)["result"]
+        raise(Error, "pCloudy #{path} returned an unexpected response") unless result.kind_of?(Hash)
+
+        unless result["code"].to_i == 200
+          message = result["error"] || result["msg"] || result["message"] || "unknown error"
+          raise(Error, "pCloudy #{path} failed (code #{result['code']}): #{message}")
+        end
+
+        result
+      rescue JSON::ParserError
+        raise(Error, "pCloudy #{request.path} returned invalid JSON")
+      rescue SocketError, Timeout::Error, Errno::ECONNREFUSED, Errno::ECONNRESET, OpenSSL::SSL::SSLError => e
+        raise(Error, "Could not reach pCloudy at #{@base}: #{e.message}")
+      end
+
+      def endpoint(path)
+        URI.join(@base.to_s.end_with?("/") ? @base.to_s : "#{@base}/", path.sub(%r{^/}, ""))
+      end
+
+      def normalize_url(url)
+        url = url.to_s.strip
+        url = "https://#{url}" unless url =~ %r{^https?://}i
+        url.chomp("/")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/pcloudy/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Pcloudy
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/pcloudy.rb

@@ -0,0 +1,16 @@
+require "fastlane/plugin/pcloudy/version"
+
+module Fastlane
+  module Pcloudy
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path("**/{actions,helper}/*.rb", File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Pcloudy.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-pcloudy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bikee1235
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.220.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.220.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Lists available real iOS and Android devices on pCloudy (device.pcloudy.com
+  or a private cloud) from your fastlane lanes, with filters for platform, OS version,
+  manufacturer and device name.
+email:
+- bikee.bihari@sstsinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/fastlane/plugin/pcloudy.rb
+- lib/fastlane/plugin/pcloudy/actions/pcloudy_list_devices_action.rb
+- lib/fastlane/plugin/pcloudy/helper/pcloudy_client.rb
+- lib/fastlane/plugin/pcloudy/version.rb
+homepage: https://github.com/Smart-Software-Testing-Solutions-Opkey/fastlane-plugin-pcloudy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Smart-Software-Testing-Solutions-Opkey/fastlane-plugin-pcloudy
+  changelog_uri: https://github.com/Smart-Software-Testing-Solutions-Opkey/fastlane-plugin-pcloudy/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/Smart-Software-Testing-Solutions-Opkey/fastlane-plugin-pcloudy/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: 'Fastlane plugin for pCloudy: work with real iOS and Android devices on the
+  pCloudy device cloud.'
+test_files: []