fastlane-plugin-download_github_release_asset 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3504c7e1cf1ef0d25c26f8c4b0d3ecd6fe74e505
+  data.tar.gz: fa0ddd15a696c9d0eaa5c1c0e18599d73dc07be1
+SHA512:
+  metadata.gz: 3a9add56f8f6fe51d43e0820548291877ad381dd30f422a5e158da0bce1d25564c68631a5fb0aa999048d84b15191622582ffbc1b35cfe0102605046ffcf8968
+  data.tar.gz: e592add801563268add8ec3da3b1d37523fe5ce1527ffa3bc13eb0287e21c7933677ad02036357019024b872ab62ca34e3ebd53afb2f324bac98ff2352092920

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anton Domashnev <antondomashnev@gmail.com>
+
+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,76 @@
+# download_github_release_asset plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-download_github_release_asset)
+[![Build Status](https://travis-ci.org/Antondomashnev/fastlane-plugin-download_github_release_asset.svg?branch=master)](https://travis-ci.org/Antondomashnev/fastlane-plugin-download_github_release_asset)
+[![codebeat badge](https://codebeat.co/badges/553a0e08-15f7-49bf-bdc6-15c93afd8371)](https://codebeat.co/projects/github-com-antondomashnev-fastlane-plugin-download_github_release_asset)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-download_github_release_asset`, add it to your project by running:
+
+```bash
+fastlane add_plugin download_github_release_asset
+```
+
+## About download_github_release_asset
+
+This [fastlane](https://github.com/fastlane/fastlane) plugin downloads the GitHub release's asset using the GitHub API. The possible usage of the plugin can be found in example [Fastfile](https://github.com/Antondomashnev/fastlane-plugin-download_github_release_asset/blob/master/fastlane/Fastfile).  
+Usually the asset on GitHub is a `.zip` file, so here can be really useful another [plugin](https://github.com/maxoly/fastlane-plugin-unzip) to unzip archive.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane example`.
+
+```ruby
+lane :example do |options|
+  release_version = options[:release_version]
+
+  github_release = get_github_release(
+    url: ENV['PRIVATE_CONICHI_IOS_SDK_GITHUB_REPO'],
+    version: release_version,
+    api_token: ENV['CONICHI_CI_GITHUB_TOKEN']
+  )
+
+  assets = github_release["assets"]
+  selected_assets = assets.select do |asset|
+    asset["name"] == "my_asset.zip"
+  end
+
+  my_asset_json = selected_assets[0]
+  my_asset_url = my_asset_json["url"]
+  download_github_release_asset(
+    asset_url: my_asset_url,
+    destination_path: "./here/my_asset.zip",
+    api_token: "token"
+  )
+end
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/download_github_release_asset.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/download_github_release_asset/version'
+
+module Fastlane
+  module DownloadGithubReleaseAsset
+    # 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::DownloadGithubReleaseAsset.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/download_github_release_asset/actions/download_github_release_asset_action.rb

@@ -0,0 +1,97 @@
+module Fastlane
+  module Actions
+    class DownloadGithubReleaseAssetAction < Action
+      def self.run(params)
+        require 'open-uri'
+        require 'fileutils'
+
+        destination_path = File.expand_path(params[:destination_path].shellescape)
+        prepare_destination_path(destination_path)
+
+        UI.important("⏬ Downloading asset '#{params[:asset_url]}' to '#{destination_path}'...")
+        download_asset(params[:asset_url], destination_path, params[:api_token])
+      end
+
+      def self.description
+        "Downloads a GitHub release's asset"
+      end
+
+      def self.details
+        "This action downloads a GitHub release's asset using the GitHub API and puts it in a destination path.\nIf the file has been previously downloaded, it will be overrided."
+      end
+
+      def self.authors
+        ["Anton Domashnev"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :asset_url,
+                                       env_name: "FL_GITHUB_RELEASE_ASSET_URL",
+                                       description: "The URL to the desired asset in GitHub API",
+                                       verify_block: proc do |value|
+                                         UI.important("The URL doesn't start with http or https") unless value.start_with?("https")
+                                       end,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :destination_path,
+                                       env_name: "FL_GITHUB_RELEASE_ASSET_DOWNLOAD_DESTINATION_PATH",
+                                       description: "The path to which save file",
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "FL_GITHUB_RELEASE_ASSET_API_TOKEN",
+                                       description: "Personal API Token for GitHub - generate one at https://github.com/settings/tokens",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      private_class_method def self.download_asset(asset_url, destination_path, api_token)
+        request_url = "#{asset_url}?access_token=#{api_token}"
+        send_download_request(request_url, "fastlane-plugin_download_github_release_asset", "application/octet-stream", destination_path)
+        compressed_file_size = File.size(destination_path).to_f / 2**20
+        formatted_file_size = format('%.2f', compressed_file_size)
+        UI.success("Download finished, total size: #{formatted_file_size} MB ✅")
+      rescue => ex
+        UI.user_error!("Error fetching release's asset: #{ex}")
+      end
+
+      private_class_method def self.send_download_request(request_url, user_agent, accept, destination_path)
+        step = 0
+        partial = 0
+        progress = 0
+        File.open(destination_path, "wb") do |saved_file|
+          # the following "open" is provided by open-uri
+          open(request_url, "User-Agent" => user_agent, "Accept" => accept, :content_length_proc => lambda do |t|
+            if t && 0 < t
+              step = t / 10
+              partial = step
+              formatted_file_size = format('%.2f', t.to_f / 2**20)
+              UI.important("Total size: #{formatted_file_size} MB")
+            end
+          end,
+          :progress_proc => lambda do |s|
+            if s > partial
+              partial += step
+              return if step.zero?
+              UI.message "#{progress}%"
+              progress = (partial / step) * 10
+            end
+          end) do |read_file|
+            saved_file.write(read_file.read)
+          end
+        end
+      end
+
+      private_class_method def self.prepare_destination_path(destination_path)
+        dirname = File.dirname(destination_path)
+        unless File.directory?(dirname)
+          FileUtils.mkdir_p(dirname)
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/download_github_release_asset/helper/download_github_release_asset_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class DownloadGithubReleaseAssetHelper
+      # class methods that you define here become available in your action
+      # as `Helper::DownloadGithubReleaseAssetHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the download_github_release_asset plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module DownloadGithubReleaseAsset
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-download_github_release_asset
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anton Domashnev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: pry
+  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: bundler
+  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: rspec
+  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: rake
+  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: 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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.105.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.105.2
+description: 
+email: antondomashnev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/download_github_release_asset.rb
+- lib/fastlane/plugin/download_github_release_asset/actions/download_github_release_asset_action.rb
+- lib/fastlane/plugin/download_github_release_asset/helper/download_github_release_asset_helper.rb
+- lib/fastlane/plugin/download_github_release_asset/version.rb
+homepage: https://github.com/Antondomashnev/fastlane-plugin-download_github_release_asset
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This action downloads a GitHub release's asset using the GitHub API and puts
+  it in a destination path.\nIf the file has been previously downloaded, it will be
+  overrided.
+test_files: []