cocoapods-azure-universal-packages 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 207b72a97e6c7b283572863af8c19956f93b9e88bf12946661f90e7c55832a3c
+  data.tar.gz: 0c6f5ef6a710f9881ef7d62621e61b7b606266da852df8a4e124045d04fbb380
+SHA512:
+  metadata.gz: b52f628384ebaddb4f8b1f88460bdd31c03267f9ce93ab746917e9bb26ec490a8c71a60b9fd3de68345184bf461c8a56e80c060f60cdf3f5face9d1929af6321
+  data.tar.gz: ab61da34afb943407abd8da58b3ad93ebb4cfabcf7c5d20813a46b41b86bf88b8db840d9473f2eee0c1236c2265754b7e16d4dddeb79d94821b1e7385fdcc906

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,80 @@
+# 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', {
+    :base_url => '{{BASE_URL}}'
+}
+```
+replacing `{{BASE_URL}}` with the base URL of your Azure Artifacts feed (for example, `https://pkgs.dev.azure.com/`).
+
+Then, in your podspec set the pod's source to
+```Ruby
+# For project scoped feeds:
+spec.source = { :http => '{{BASE_URL}}/{{ORGANIZATION}}/{{PROJECT}}/_apis/packaging/feeds/{{FEED}}/upack/packages/{{PACKAGE}}/versions/{{VERSION}}' }
+
+# For organization scoped feeds:
+spec.source = { :http => '{{BASE_URL}}/{{ORGANIZATION}}/_apis/packaging/feeds/{{FEED}}/upack/packages/{{PACKAGE}}/versions/{{VERSION}}' }
+```
+where:
+- `{{BASE_URL}}` is the base URL you chose above
+- `{{ORGANIZATION}}` is the name 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 |
+| --------- | ----------- |
+| `base_url` | The base URL of the Azure Artifacts feed. Required unless `base_urls` is specified. |
+| `base_urls` | An array of base URLs of possible Azure Artifacts feeds. Required unless `base_url` 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.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-azure-universal-packages/azure_universal_package_downloader.rb

@@ -0,0 +1,60 @@
+require 'addressable'
+require 'cocoapods'
+require 'cocoapods-downloader'
+
+module Pod
+  module Downloader
+
+    @azure_base_urls = []
+
+    class << self
+      attr_accessor :azure_base_urls
+    end
+
+    class Http
+
+      private
+
+      alias_method :aliased_download!, :download!
+
+      executable :az
+
+      def download!
+        aup_uri_template = Addressable::Template.new(
+          '{scheme}://{host}/{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? && Downloader.azure_base_urls.include?("#{aup_uri_components['scheme']}://#{aup_uri_components['host']}")
+          download_azure_universal_package!(aup_uri_components)
+        else
+          aliased_download!
+        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['scheme']}://#{params['host']}/#{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_base_urls = options[:base_url] || options[:base_urls]
+      raise Pod::Informative, 'You must configure at least one Azure base url' unless azure_base_urls
+
+      Pod::Downloader.azure_base_urls = ([] << azure_base_urls).flatten.map { |url| url.delete_suffix('/') }
+      raise Pod::Informative, 'You must configure at least one Azure base url' if Pod::Downloader.azure_base_urls.empty?
+    end
+
+  end
+end

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-packages
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Microsoft Corporation
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-14 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: '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: 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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A CocoaPods plugin for downloading Universal Packages from Azure Artifacts
+  feeds.
+test_files: []