fastlane-plugin-carthage_cache_ftps 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 958099796491c60baa9a025946f3a9ba5b93780a
+  data.tar.gz: 886efc29362b1090a3e991c9fa733e2a61e17d32
+SHA512:
+  metadata.gz: 27b42a1ed8695f21c59c8d8ea7d19542a7b2666c425fa8bc316456378df3f80e59f6f26c38889b8e5a2874182f77b0a3a9e2ebf1e77fe0e19dcff682334b172a
+  data.tar.gz: 82cb326aa8f3680a65a96091973a949889fdfd45b64d9599afaff969d6a0ab77730eabfbf7cecb2852674ab4842050d01f54559fa6aa408c0e5486dfa845f2d4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Wolfgang Lutz <wlut@num42.de>
+
+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,113 @@
+# carthage_cache_ftps plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-carthage_cache_ftps)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-carthage_cache_ftps`, add it to your project by running:
+
+```bash
+fastlane add_plugin carthage_cache_ftps
+```
+
+## About carthage_cache_ftps
+
+Allows to publish or install the carthage builds via FTPS or AWS to avoid recompilation.
+
+
+### AWS
+
+First, run
+
+```bash
+carthage_cache config
+```
+
+to create the `.carthage_cache.yml` file.
+
+Then, call the plugin from the Fastfile using
+
+```ruby
+carthage_cache (
+  command: "install" #This is the default and can be omitted
+)
+```
+
+to install from cache and use
+
+```ruby
+carthage_cache (
+  command: "publish"
+)
+```
+
+to push the current state to the remote.
+
+Run
+
+```bash
+bundle exec fastlane actions carthage_cache
+```
+
+for more information.
+
+### FTPS
+
+Call the plugin from the Fastfile using
+
+```ruby
+carthage_cache_ftps (
+  host: "ftp.yourdomain.de",
+  user: "username",
+  command: "install" #This is the default and can be omitted
+)
+```
+
+to install from cache and use
+
+```ruby
+carthage_cache (
+  host: "ftp.yourdomain.de",
+  user: "username",
+  command: "publish"
+)
+```
+
+to push the current state to the remote.
+
+Run
+
+```bash
+bundle exec fastlane actions carthage_cache_ftps
+```
+
+for more information and parameters.
+
+## 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://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/carthage_cache_ftps.rb

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

data/lib/fastlane/plugin/carthage_cache_ftps/actions/carthage_cache_action.rb

@@ -0,0 +1,57 @@
+require 'carthage_cache'
+
+module Fastlane
+  module Actions
+    class CarthageCacheAction < Action
+      def self.run(params)
+        FastlaneCore::PrintTable.print_values(config: params, title: "Summary for Carthage Cache")
+
+        application = CarthageCache::Application.new(".", true, {})
+
+        command = params.values[:command]
+
+        case command.to_sym
+        when :install
+          exit 1 unless application.install_archive
+        when :publish
+          exit 1 unless application.create_archive
+        end
+      end
+
+      def self.description
+        "Allows to publish or install the carthage builds to AWS to avoid recompilation. Needs a configuration created by 'carthage_cache config'"
+      end
+
+      def self.authors
+        ["Wolfgang Lutz"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "This action uses the carthage_cache_gem to cache the built carthage libraries remotely on AWS."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :command,
+                                  env_name: "CARTHAGE_CACHE_COMMAND",
+                               description: "The carthage cache command to use. Allowed values: publish, install",
+                                  optional: false,
+                                      type: String,
+                             default_value: "install",
+                              short_option: "c",
+                              verify_block: proc do |value|
+                                              UI.user_error!("Unknown carthage cache command. Allowed: install, publish") unless ["install", "publish"].include?(value)
+                                            end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/carthage_cache_ftps/actions/carthage_cache_ftps_action.rb

@@ -0,0 +1,110 @@
+require 'carthage_cache'
+
+module Fastlane
+  module Actions
+    class CarthageCacheFtpsAction < Action
+      def self.run(params)
+        FastlaneCore::PrintTable.print_values(config: params, title: "Summary for Carthage Cache FTPS")
+
+        host = params.values[:host]
+        remote_subfolder = params.values[:subfolder]
+        username = params.values[:username]
+        password = params.values[:password] || PasswordHelper.new.password(host, username)
+
+        config = {
+                  bucket_name: remote_subfolder,
+                  aws_s3_client_options: {
+                    region: host,
+                    aws_access_key_id: username,
+                    secret_access_key: password,
+                    access_key_id: "bla"
+                    }
+                  }
+
+        local_path = params.values[:local_path]
+        application = CarthageCache::Application.new(local_path, true, config, repository: FTPRepository)
+
+        puts application.inspect
+
+        command = params.values[:command]
+
+        case command.to_sym
+        when :install
+          exit 1 unless application.install_archive
+        when :publish
+          exit 1 unless application.create_archive
+        end
+      end
+
+      def self.description
+        "Allows to publish or install the carthage builds via ftps to avoid recompilation"
+      end
+
+      def self.authors
+        ["Wolfgang Lutz"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "This plugin extends the carthage_cache_gem with ftps functionality, to be able to cache the built carthage libraries remotely on an ftp server."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :host,
+                                  env_name: "CARTHAGE_CACHE_FTPS_HOST",
+                               description: "The ftps host to use for carthage cache",
+                                  optional: false,
+                                      type: String,
+                             default_value: "127.0.0.1",
+                              short_option: "h"),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                  env_name: "CARTHAGE_CACHE_FTPS_USERNAME",
+                               description: "The ftps username to use for carthage cache",
+                                  optional: false,
+                                      type: String,
+                             default_value: "anonymous",
+                              short_option: "u"),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                  env_name: "CARTHAGE_CACHE_FTPS_PASSWORD",
+                               description: "The ftps password to use for carthage cache. If not given, keychain is used",
+                                  optional: true,
+                                      type: String,
+                                 sensitive: true,
+                              short_option: "p"),
+          FastlaneCore::ConfigItem.new(key: :command,
+                                  env_name: "CARTHAGE_CACHE_COMMAND",
+                               description: "The carthage cache command to use. Allowed values: publish, install",
+                                  optional: false,
+                                      type: String,
+                             default_value: "install",
+                              short_option: "c",
+                              verify_block: proc do |value|
+                                              UI.user_error!("Unknown carthage cache command. Allowed: install, publish") unless ["install", "publish"].include?(value)
+                                            end),
+          FastlaneCore::ConfigItem.new(key: :subfolder,
+                                  env_name: "CARTHAGE_CACHE_FTPS_SUBFOLDER",
+                               description: "The subfolder to use for carthage cache",
+                                  optional: true,
+                                      type: String,
+                             default_value: "carthage_cache",
+                              short_option: "f"),
+          FastlaneCore::ConfigItem.new(key: :local_path,
+                                  env_name: "CARTHAGE_CACHE_FTPS_LOCAL_PATH",
+                               description: "The path to the folder containing the 'Carthage' folder",
+                                  optional: true,
+                                      type: String,
+                             default_value: ".",
+                              short_option: "l")
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/carthage_cache_ftps/helper/carthage_cache_ftps_helper.rb

@@ -0,0 +1,31 @@
+require "fastlane_core"
+
+module Fastlane
+  module Helper
+    class CarthageCacheFtpsHelper
+      UI = FastlaneCore::UI
+
+      def self.ask_password(message: "Passphrase for FTP: ", confirm: true)
+        ensure_ui_interactive
+        loop do
+          password = UI.password(message)
+          if confirm
+            password2 = UI.password("Type passphrase again: ")
+            if password == password2
+              return password
+            end
+          else
+            return password
+          end
+          UI.error("Passphrases differ. Try again")
+        end
+      end
+
+      def self.ensure_ui_interactive
+        raise "This code should only run in interactive mode" unless UI.interactive?
+      end
+
+      private_class_method :ensure_ui_interactive
+    end
+  end
+end

data/lib/fastlane/plugin/carthage_cache_ftps/helper/ftp_repository.rb

@@ -0,0 +1,45 @@
+class FTPRepository
+  require 'double_bag_ftps'
+
+  attr_reader :ftps_host
+  attr_reader :ftps_remote_path
+  attr_reader :ftps_username
+  attr_reader :ftps_password
+
+  def initialize(host, config)
+    @ftps_host = config[:region]
+    @ftps_remote_path = host
+    @ftps_username = config[:aws_access_key_id]
+    @ftps_password = config[:secret_access_key]
+  end
+
+  def login
+    # Connect to a host using explicit FTPS and do not verify the host's cert
+    ftps = DoubleBagFTPS.new
+    ftps.ssl_context = DoubleBagFTPS.create_ssl_context(verify_mode: OpenSSL::SSL::VERIFY_NONE)
+    ftps.connect(@ftps_host)
+    ftps.login(@ftps_username, @ftps_password)
+    ftps
+  end
+
+  def archive_exist?(archive_filename)
+    ftps = login
+    files = ftps.list
+    ftps.close
+    return !files.select { |f| f.include? "#{@ftps_remote_path}/#{archive_filename}" }.empty?
+  end
+
+  def download(archive_filename, destination_path)
+    ftps = login
+    ftps.getbinaryfile("#{@ftps_remote_path}/#{archive_filename}", destination_path)
+    ftps.close
+  end
+
+  def upload(archive_filename, archive_path)
+    ftps = login
+    files = ftps.list
+    ftps.mkdir(@ftps_remote_path) if files.select { |f| f.include? @ftps_remote_path }.empty?
+    ftps.putbinaryfile(archive_path, "#{@ftps_remote_path}/#{archive_filename}")
+    ftps.close
+  end
+end

data/lib/fastlane/plugin/carthage_cache_ftps/helper/password_helper.rb

@@ -0,0 +1,37 @@
+require 'security'
+require 'shellwords'
+
+class PasswordHelper
+  UI = FastlaneCore::UI
+
+  def server_name(host, username)
+    ["carthage_cache_ftps", host, username].join("_")
+  end
+
+  def password(host, username)
+    password = ENV["CARTHAGE_CACHE_FTPS_PASSWORD"]
+    unless password
+      item = Security::InternetPassword.find(server: server_name(host, username))
+      password = item.password if item
+    end
+
+    unless password
+      if !UI.interactive?
+        UI.error "Neither the CARTHAGE_CACHE_FTPS_PASSWORD environment variable nor the local keychain contained a password."
+        UI.error "Bailing out instead of asking for a password, since this is non-interactive mode."
+        UI.user_error!("Try setting the CARTHAGE_CACHE_FTPS_PASSWORD environment variable, or temporarily enable interactive mode to store a password.")
+      else
+        UI.important "Enter the passphrase that should be used to login to the ftps"
+        UI.important "This passphrase is specific per host and username and will be stored in your local keychain"
+        password = Fastlane::Helper::CarthageCacheFtpsHelper.ask_password(confirm: false)
+        store_password(host, username, password)
+      end
+    end
+
+    return password
+  end
+
+  def store_password(host, username, password)
+    Security::InternetPassword.add(server_name(host, username), "", password)
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module CarthageCacheFtps
+    VERSION = "0.1.3"
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-carthage_cache_ftps
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Wolfgang Lutz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carthage_cache
+  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: double-bag-ftps
+  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: 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: 2.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.44.1
+description: 
+email: wlut@num42.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/carthage_cache_ftps.rb
+- lib/fastlane/plugin/carthage_cache_ftps/actions/carthage_cache_action.rb
+- lib/fastlane/plugin/carthage_cache_ftps/actions/carthage_cache_ftps_action.rb
+- lib/fastlane/plugin/carthage_cache_ftps/helper/carthage_cache_ftps_helper.rb
+- lib/fastlane/plugin/carthage_cache_ftps/helper/ftp_repository.rb
+- lib/fastlane/plugin/carthage_cache_ftps/helper/password_helper.rb
+- lib/fastlane/plugin/carthage_cache_ftps/version.rb
+homepage: 
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Allows to publish or install the carthage builds via ftps to avoid recompilation
+test_files: []