cocoapods-azure-universal-packages2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7c6958396e8971a36dbc07e01099a518c0863f2908739f25af891c3528d54fa
+  data.tar.gz: 1df3179c1182a84bdc768bbddb6ca0b1a98f57c6e093d73204b9cb8194fa5fff
+SHA512:
+  metadata.gz: 2237ee62ebc27637f86c04824af0f38bfd9ee9294fa273067134413034be4e4f5546185f0c47208e3524356eff078690e8120f9d776735fda41666a986b67697
+  data.tar.gz: eba3a32ccb50ed18f59dd6c7defea71d934bd05630a076d8b308d225b05ffb6622c507a43a02f5c840f91ed2fcc5c20effb443e9536badde225511628e4717cb

data/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    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,79 @@
+# CocoaPods Azure Universal Packages plugin
+
+This project is a [CocoaPods](https://github.com/CocoaPods/CocoaPods) plugin that allows to dowload pods published as [Universal Packages](https://docs.microsoft.com/en-us/azure/devops/artifacts/quickstarts/universal-packages) in [Azure Artifacts](https://azure.microsoft.com/en-gb/services/devops/artifacts/) feeds.
+
+## Getting started
+
+Install the plugin by adding to your `Gemfile`
+```Ruby
+gem "cocoapods-azure-universal-packages"
+```
+
+Under the hood the plugin uses the [Azure CLI](https://aka.ms/azcli) to download the Universal Packages, you can install it running
+```shell
+brew update && brew install azure-cli
+```
+
+Finally, ensure that you are logged in using
+```shell
+az login
+```
+
+## How it works
+
+The plugin replaces the default CocoaPods HTTP downloader when a pod source URL points to a universal package and it uses the Azure CLI to perform the download.
+
+_Note:_ The plugin will install the Azure CLI [DevOps extension](https://github.com/Azure/azure-devops-cli-extension) automatically when running `pod install` or `pod update` for the first time.
+
+## Usage
+
+Add to your Podfile
+```Ruby
+plugin 'cocoapods-azure-universal-packages', {
+    :organization => '{{ORGANIZATION_URL}}'
+}
+```
+replacing `{{ORGANIZATION_URL}}` with the base URL of your Azure Artifacts feed (for example: `https://pkgs.dev.azure.com/myorg`).
+
+Then, in your podspec set the pod's source to
+```Ruby
+# For project scoped feeds:
+spec.source = { :http => '{{ORGANIZATION_URL}}/{{PROJECT}}/_apis/packaging/feeds/{{FEED}}/upack/packages/{{PACKAGE}}/versions/{{VERSION}}' }
+
+# For organization scoped feeds:
+spec.source = { :http => '{{ORGANIZATION_URL}}/_apis/packaging/feeds/{{FEED}}/upack/packages/{{PACKAGE}}/versions/{{VERSION}}' }
+```
+where:
+- `{{ORGANIZATION_URL}}` is the URL of your feed's organization
+- `{{PROJECT}}` is the name of your feed's project (you must specify this only if your feed is a project scoped feed)
+- `{{PACKAGE}}` is the name of your universal package
+- `{{VERSION}}` is the version of your universal package
+
+### Plugin parameters
+
+| Parameter | Description |
+| --------- | ----------- |
+| `organization` | The URL of the Azure Artifacts feed's orgnization. Required unless `organizations` is specified. |
+| `organizations` | An array of URLs of possible Azure Artifacts feeds' organizations. Required unless `organization` is specified. |
+| `update_cli_extension` | Whether to update the Azure CLI DevOps extensions automatically. Default to `false`. |
+
+## Run tests for this plugin
+
+To run the tests, use
+```shell
+rake tests
+```
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

data/lib/cocoapods-azure-universal-packages/azure_universal_package_downloader.rb

@@ -0,0 +1,93 @@
+require 'addressable'
+require 'cocoapods'
+require 'cocoapods-downloader'
+
+module Pod
+  module Downloader
+
+    @azure_organizations = []
+
+    class << self
+      attr_accessor :azure_organizations
+    end
+
+    class Http
+
+      private
+
+      alias_method :aliased_download!, :download!
+
+      executable :az
+
+      def download!
+        # Check if the url matches any known Azure organization
+        organization = Downloader.azure_organizations.find { |org| url.to_s.start_with?(org) }
+
+        if organization.nil?
+          aliased_download!
+        else
+          # Parse the url
+          organization.delete_suffix!('/')
+          aup_uri_template = Addressable::Template.new(
+            "#{organization}{/project}/_apis/packaging/feeds/{feed}/upack/packages/{package}/versions/{version}"
+          )
+          uri = Addressable::URI.parse(url)
+          aup_uri_components = aup_uri_template.extract(uri)
+
+          if !aup_uri_components.nil?
+            download_azure_universal_package!(aup_uri_components.merge({ 'organization' => organization }))
+  
+            # Extract the file if it's the only one in the package
+            package_files = target_path.glob('*')
+            if package_files.count == 1 && package_files.first.file?
+              file = package_files.first
+              file_type = begin
+                case file.to_s
+                when /\.zip$/
+                  :zip
+                when /\.(tgz|tar\.gz)$/
+                  :tgz
+                when /\.tar$/
+                  :tar
+                when /\.(tbz|tar\.bz2)$/
+                  :tbz
+                when /\.(txz|tar\.xz)$/
+                  :txz
+                when /\.dmg$/
+                  :dmg
+                end
+              end
+              extract_with_type(file, file_type) unless file_type.nil?
+            end
+          else
+            Pod::UserInterface.warn("#{url} looks like a Azure artifact feed but it's malformed")
+            aliased_download!
+          end
+        end
+      end
+
+      def download_azure_universal_package!(params)
+        ui_sub_action("Downloading #{params['package']} (#{params['version']}) from Azure feed #{params['feed']} (#{[params['organization'], params['project']].compact.join('/')})") do
+          parameters = [
+            'artifacts',
+            'universal',
+            'download',
+            '--organization', params['organization'],
+            '--feed', params['feed'],
+            '--name', params['package'],
+            '--version', params['version'],
+            '--path', target_path.to_s
+          ]
+
+          # If it's a project scoped feed, we need to pass a few more arguments
+          parameters.push('--project', params['project'], '--scope', 'project') unless params['project'].nil?
+
+          # Fetch the Universal Package
+          az! parameters
+        end
+      end
+
+    end
+
+  end
+end

data/lib/cocoapods-azure-universal-packages/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsAzureUniversalPackages
+  VERSION = '0.0.1'
+end

data/lib/cocoapods-azure-universal-packages/pre_install.rb

@@ -0,0 +1,29 @@
+module CocoapodsAzureUniversalPackages
+  class << self
+
+    Pod::HooksManager.register('cocoapods-azure-universal-packages', :pre_install) do |context, options|
+      CocoapodsAzureUniversalPackages.pre_install(options)
+    end
+
+    def pre_install(options)
+      # Check if the Azure CLI is installed
+      raise Pod::Informative, 'Unable to locate the Azure CLI. To learn more refer to https://aka.ms/azcli' unless Pod::Executable.which('az')
+
+      # Install the azure-devops extension if necessary
+      Pod::Executable.execute_command('az', ['extension', 'add', '--yes', '--name', 'azure-devops'], false)
+
+      # Optionally, update the azure-devops extension
+      if options.fetch(:update_cli_extension, false)
+        Pod::Executable.execute_command('az', ['extension', 'update', '--name', 'azure-devops'], false)
+      end
+
+      # Now we can configure the downloader to use the Azure CLI for downloading pods from the given hosts
+      azure_organizations = options[:organization] || options[:organizations]
+      raise Pod::Informative, 'You must configure at least one Azure organization' unless azure_organizations
+
+      Pod::Downloader.azure_organizations = ([] << azure_organizations).flatten.map { |url| url.delete_suffix('/') }
+      raise Pod::Informative, 'You must configure at least one Azure organization' if Pod::Downloader.azure_organizations.empty?
+    end
+
+  end
+end

data/lib/cocoapods-azure-universal-packages.rb

@@ -0,0 +1,3 @@
+require 'cocoapods-azure-universal-packages/azure_universal_package_downloader'
+require 'cocoapods-azure-universal-packages/gem_version'
+require 'cocoapods-azure-universal-packages/pre_install'

data/lib/cocoapods_plugin.rb

@@ -0,0 +1 @@
+require 'cocoapods-azure-universal-packages'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-azure-universal-packages2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Microsoft Corporation
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cocoapods-downloader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/cocoapods-azure-universal-packages.rb
+- lib/cocoapods-azure-universal-packages/azure_universal_package_downloader.rb
+- lib/cocoapods-azure-universal-packages/gem_version.rb
+- lib/cocoapods-azure-universal-packages/pre_install.rb
+- lib/cocoapods_plugin.rb
+homepage: https://github.com/microsoft/cocoapods-azure-universal-packages
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A CocoaPods plugin for downloading Universal Packages from Azure Artifacts
+  feeds.
+test_files: []