apprepo 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ac2808072cad819af871a257b85448c8d76645d
-  data.tar.gz: 2ba4d48bcf6063feebc6bbc8055bc24572389b47
+  metadata.gz: 4df104a9102694794cd681b6fcc02166d26e8c1c
+  data.tar.gz: 47bc5b2d1ff9b4cfa45f47d7eeb861a4e37d2f7b
 SHA512:
-  metadata.gz: 2786029914e35e0ee85cdcf0f284798663759d472bf995e897a8cf36c1c269d5250fe4ac586882334228ea740318d3ec04cb0699690109fb0d705e687b0999be
-  data.tar.gz: da794c44e80a59c549eca53140c1e7b483e78ad5aef98dc841ecafb6e518edeb0707a481080cfd46395fa2e129c2d961c076930e340fa7125776074a0fb84d7c
+  metadata.gz: 69193ee567b1ca06c2aedcc3aeadfe5308aa14fc3c8cb929a3ad3fc484baa1470eb512ea2d22bbe7e6e17636d07e7f6536eb36a133469290e7c2d731bf53dd63
+  data.tar.gz: 8d5d2927717947b29245057c67cd73c1348bea3d099b9ee323bf5230d01af307edeb47415f518678258221125861692908e91b85c5a6dc84a473144295690ba3

data/README.md

@@ -32,16 +32,18 @@
 apprepo
 ============
 
-**This project is now in preparation phase. It is secure, therefore none of it works except for tests against test server with sample account & shared public key.**
+**This project is a preparation phase for fastlane-plugin-apprepo and will eventually deprecate.**
 
 [![Twitter: @igraczech](https://img.shields.io/badge/contact-%40igraczech-green.svg?style=flat)](https://twitter.com/igraczech)
 [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/fastlane/blob/master/deliver/LICENSE)
 [![Gem](https://img.shields.io/gem/v/apprepo.svg?style=flat)](http://rubygems.org/gems/apprepo)
 [![Build Status](https://img.shields.io/circleci/project/suculent/apprepo.svg?style=flat)](https://circleci.com/gh/suculent/apprepo)
+[![Coverage Status](https://coveralls.io/repos/github/suculent/apprepo/badge.svg?branch=master)](https://coveralls.io/github/suculent/apprepo?branch=master)
+![Fastlane](https://img.shields.io/badge/_status_-_waiting--for--fastlane--plugins--manager_-yellow.svg)
 
-###### Deliver IPAs, icons & metadata to AppRepo (or any other SFTP server) using a single command.
+###### Deliver IPAs, icons & manifest.json to AppRepo (or any other SFTP server) using a single command.
 
-`apprepo` can upload ipa files, app icons and metadata to your Enterprise iOS distribution site from the command line. 
+`apprepo` can upload ipa files, app icons and manifest.json to your Enterprise iOS distribution site from the command line. 
 
 You can vote for Android support as well, Michal.
 
@@ -64,7 +66,7 @@ Get in contact with the developer on Twitter: [@igraczech](https://twitter.com/i
 # Future Features
 - Submit to AppRepo completely automatically
 - Upload a new ipa file to AppRepo without Xcode from any Mac
-- Maintain your app metadata locally and push changes to AppRepo
+- Maintain your app manifest locally and push changes to AppRepo
 - Easily implement a real Continuous Deployment process using [fastlane](https://fastlane.tools)
 - Store the configuration in git to easily deploy from **any** Mac, including your Continuous Integration server
 
@@ -85,9 +87,9 @@ Make sure, you have the latest version of the Xcode command line tools installed
 
 # Quick Start
 
-The guide will create all the necessary files for you, [in future also] using the existing app metadata.json from AppRepo (if any). AppRepo on-premise service has nothing to do with iTunesConnect or AppStore Distribution. Its purpose is solely for Enterprise In-House distribution and can leverage your Apple Developer Account credentials to fetch currently valid applications and their bundle identifiers.
+The guide will create all the necessary files for you, [in future also] using the existing app manifest.json from AppRepo (if any). AppRepo on-premise service has nothing to do with iTunesConnect or AppStore Distribution. Its purpose is solely for Enterprise In-House distribution and can leverage your Apple Developer Account credentials to fetch currently valid applications and their bundle identifiers.
 
-Delivery module for your custom SFTP server (e.g. AppRepo, where it specifically supports custom metadata.json format instead of default plist manifest [future todo]).
+Delivery module for your custom SFTP server (e.g. AppRepo, where it specifically supports custom manifest.json format instead of default plist manifest [future todo]).
 
 - ```cd [your_project_folder]```
 - ```apprepo init```
@@ -95,7 +97,7 @@ Delivery module for your custom SFTP server (e.g. AppRepo, where it specifically
 - Enter your `APPREPO` APPCODE for this application in AppRepo, you can omit this for own SFTP server (or expect it to be a directory at your SFTP home path as we don't want to limit your creativity).
 - Enjoy a good drink, while the computer does all the work for you
 
-From now on, you can run `apprepo` to deploy a new update, or just upload new app metadata and icons.
+From now on, you can run `apprepo` to deploy a new update, or just upload new app manifest.json and icons.
 
 
 # Usage
@@ -116,9 +118,9 @@ From now on, you can run `apprepo` to deploy a new update, or just upload new ap
 - [`frameit`](https://github.com/fastlane/fastlane/tree/master/frameit): Quickly put your screenshots into the right device frames
 - [`pem`](https://github.com/fastlane/fastlane/tree/master/pem): Automatically generate and renew your push notification profiles
 - [`sigh`](https://github.com/fastlane/fastlane/tree/master/sigh): Because you would rather spend your time building stuff than fighting provisioning
-- [`produce`](https://github.com/fastlane/fastlane/tree/master/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
+- [`produce`](https://github.com/fastlane/fastlane/tree/master/produce): Create new iOS apps on AppRepo and Dev Portal using the command line
 - [`cert`](https://github.com/fastlane/fastlane/tree/master/cert): Automatically create and maintain iOS code signing certificates
-- [`spaceship`](https://github.com/fastlane/fastlane/tree/master/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
+- [`spaceship`](https://github.com/fastlane/fastlane/tree/master/spaceship): Ruby library to access the Apple Dev Center and AppRepo
 - [`pilot`](https://github.com/fastlane/fastlane/tree/master/pilot): The best way to manage your TestFlight testers and builds from your terminal
 - [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers
 - [`gym`](https://github.com/fastlane/fastlane/tree/master/gym): Building your iOS apps has never been easier

data/lib/apprepo.rb

@@ -4,49 +4,36 @@
 
 require 'json'
 
-require_relative 'apprepo/version'
-require_relative 'apprepo/options'
-
-require_relative 'apprepo/uploader'
-require_relative 'apprepo/upload_metadata'
-require_relative 'apprepo/upload_assets'
+require_relative 'apprepo/analyser'
 require_relative 'apprepo/commands_generator'
-
 require_relative 'apprepo/detect_values'
+require_relative 'apprepo/loader'
+require_relative 'apprepo/manifest'
+require_relative 'apprepo/options'
 require_relative 'apprepo/runner'
 require_relative 'apprepo/setup'
-require_relative 'apprepo/loader'
-
-require_relative 'apprepo/upload_descriptor' # will deprecate or replace :app info
+require_relative 'apprepo/uploader'
+require_relative 'apprepo/version'
 
 require 'fastlane_core'
 
+# Root class of the AppRepo SFTP Uploader
 module AppRepo
   class << self
       def initialize
         UI.message('[AppRepo] Initializing...')
       end
+
+      def new
+        UI.message('[AppRepo] New...')
+      end
   end
 
   Encoding.default_external = Encoding::UTF_8
   Encoding.default_internal = Encoding::UTF_8
 
-  # Generate options (simulates commands_generator.rb)
-  Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  Helper = FastlaneCore::Helper
   UI = FastlaneCore::UI
 
-  appcode = 'ruby-test'
-
-  # Setup descriptor (appcode, ipa, metadata - from repofile)!
-  UI.message('[AppRepoTest] UploadDescriptor.new')
-  uploadDescriptor = UploadDescriptor.new(appcode) # not used yet
-  uploadDescriptor.appcode = appcode
-
-  # Test Uploader (OK)
-  # UI.message('[AppRepoTest] Uploader.new')
-  # upload = Uploader.new('repo.teacloud.net', 'circle', File.dirname(__FILE__) + '/../assets/circle.key', appcode)
-  # upload.run
-
-  UI.message('[AppRepoTest] AppRepo::CommandsGenerator.new.run')
   CommandsGenerator.new.run
 end

data/lib/apprepo/analyser.rb

@@ -0,0 +1,26 @@
+require_relative 'uploader'
+require 'fastlane_core'
+
+module AppRepo
+  # Should provide metadata for current appcode
+  class Analyser
+    attr_accessor :options
+
+    def initialize(options)
+      self.options = options
+    end
+
+    # Fetches remote app version from metadata
+    def fetch_app_version(options)
+      metadata = AppRepo::Uploader.new(options).download_metadata
+      FastlaneCore::UI.user_error!('TODO: Parse version out from metadata')
+      '0.0'
+    end
+
+    # only for testing, should be empty
+    def run
+      FastlaneCore::UI.message('AppRepo:Analyser.run for test...')
+      fetch_app_version(options)
+    end
+  end
+end

data/lib/apprepo/commands_generator.rb

@@ -3,6 +3,7 @@ require 'commander'
 HighLine.track_eof = false
 
 module AppRepo
+  # This class is responsible for providing commands with respective actions
   class CommandsGenerator
     include Commander::Methods
 
@@ -10,15 +11,16 @@ module AppRepo
       FastlaneCore::UpdateChecker.start_looking_for_update('apprepo')
       new.run
     ensure
-      FastlaneCore::UpdateChecker.show_update_status('apprepo', AppRepo::VERSION)
+      checker = FastlaneCore::UpdateChecker
+      checker.show_update_status('apprepo', AppRepo::VERSION)
     end
 
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Style/GlobalVars
     def run
-
-      puts "[AppRepo::CommandsGenerator] run"
-
       program :version, AppRepo::VERSION
       program :description, AppRepo::DESCRIPTION
       program :help, 'Author', 'Matej Sychra <suculent@me.com>'
@@ -26,7 +28,8 @@ module AppRepo
       program :help, 'GitHub', 'https://github.com/suculent/apprepo/tree/master/apprepo'
       program :help_formatter, :compact
 
-      FastlaneCore::CommanderGenerator.new.generate(AppRepo::Options.available_options)
+      generator = FastlaneCore::CommanderGenerator.new
+      generator.generate(AppRepo::Options.available_options)
 
       global_option('--verbose') { $verbose = true }
 
@@ -36,16 +39,18 @@ module AppRepo
         c.syntax = 'apprepo'
         c.description = 'Upload IPA and metadata to SFTP (e.g. AppRepo)'
         c.action do |_args, options|
-          options = FastlaneCore::Configuration.create(AppRepo::Options.available_options, options.__hash__)
+          config = FastlaneCore::Configuration
+          available_opts = AppRepo::Options.available_options
+          options = config.create(available_opts, options.__hash__)
           loaded = options.load_configuration_file('Repofile')
           loaded = true if options[:repo_description] || options[:ipa]
 
           unless loaded
-            puts "[AppRepo::CommandsGenerator] configuration file not loaded"
-            if UI.confirm('No AppRepo configuration found in the current directory. Do you want to setup apprepo?')
-              require 'apprepo/setup'              
+            puts '[AppRepo::CommandsGenerator] configuration file not loaded'
+            if UI.confirm('No Repofile found. Do you want to setup apprepo?')
+              require 'apprepo/setup'
               AppRepo::Setup.new.run(options)
-              puts "[AppRepo::CommandsGenerator] exiting."
+              puts '[AppRepo::CommandsGenerator] exiting.'
               return 0
             end
           end
@@ -54,11 +59,37 @@ module AppRepo
         end
       end
 
-      command :submit_build do |c|
-        c.syntax = 'apprepo submit_build'
-        c.description = 'Submit a specific build-nr for review, use latest for the latest build'
+      command :download_manifest do |c|
+        c.syntax = 'apprepo download manifest'
+        c.description = 'Downloads existing metadata and stores it locally.
+        This overwrites the local files.'
+
+        c.action do |_args, options|
+          config = FastlaneCore::Configuration
+          available_opts = AppRepo::Options.available_options
+          options = config.create(available_opts, options.__hash__)
+          options.load_configuration_file('Repofile')
+          AppRepo::Runner.new(options) # to login...
+          cont = FastlaneCore::Helper.fastlane_enabled? ? './fastlane' : '.'
+          path = options[:manifest_path] || File.join(cont, 'metadata')
+          res = ENV['APPREPO_FORCE_OVERWRITE']
+          msg = 'Do you want to overwrite existing metadata on path '
+          res ||= UI.confirm(msg + '#{File.expand_path(path)}' + '?')
+          return 0 if res.nil?
+          require 'apprepo/setup'
+          # TODO: Fetch version from IPA or else
+          v = options[:app_version].latest_version
+          AppRepo::Setup.new.generate_metadata_files(v, path)
+        end
+      end
+
+      command :submit do |c|
+        c.syntax = 'apprepo submit'
+        c.description = 'Submit a specific build-nr, use latest.'
         c.action do |_args, options|
-          options = FastlaneCore::Configuration.create(AppRepo::Options.available_options, options.__hash__)
+          config = FastlaneCore::Configuration
+          available_opts = AppRepo::Options.available_options
+          options = config.create(available_opts, options.__hash__)
           options.load_configuration_file('Repofile')
           options[:submit_for_review] = true
           options[:build_number] = 'latest' unless options[:build_number]
@@ -68,42 +99,22 @@ module AppRepo
 
       command :init do |c|
         c.syntax = 'apprepo init'
-        c.description = 'Create the initial `apprepo` configuration based on an existing app'
+        c.description = 'Create the initial `apprepo` configuration'
         c.action do |_args, options|
           if File.exist?('Repofile') || File.exist?('fastlane/Repofile')
-            UI.important('You already got a running apprepo setup in this directory')
+            UI.important('You already got a running apprepo setup.')
             return 0
           end
 
           require 'apprepo/setup'
-          options = FastlaneCore::Configuration.create(AppRepo::Options.available_options, options.__hash__)
+          config = FastlaneCore::Configuration
+          available_opts = AppRepo::Options.available_options
+          options = config.create(available_opts, options.__hash__)
           AppRepo::Runner.new(options) # to login...
           AppRepo::Setup.new.run(options)
         end
       end
 
-      command :download_metadata do |c|
-        c.syntax = 'apprepo download_metadata'
-        c.description = 'Downloads existing metadata and stores it locally. This overwrites the local files.'
-
-        c.action do |_args, options|
-          options = FastlaneCore::Configuration.create(AppRepo::Options.available_options, options.__hash__)
-          options.load_configuration_file('Repofile')
-          AppRepo::Runner.new(options) # to login...
-          containing = FastlaneCore::Helper.fastlane_enabled? ? './fastlane' : '.'
-          path = options[:metadata_path] || File.join(containing, 'metadata')
-          res = ENV['APPREPO_FORCE_OVERWRITE']
-          res ||= UI.confirm("Do you want to overwrite existing metadata on path '#{File.expand_path(path)}'?")
-          if res
-            require 'apprepo/setup'
-            #  TODO: Fetch version from IPA or else
-            v = options[:app_version].latest_version
-            AppRepo::Setup.new.generate_metadata_files(v, path)
-          else
-            return 0
-          end
-        end
-      end
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/MethodLength
 

data/lib/apprepo/detect_values.rb

@@ -1,37 +1,25 @@
 module AppRepo
+  # This class is responsible for detecting values from IPA.
   class DetectValues
     def run!(options)
-      # find_app_identifier(options
-      find_folders(options)
+      find_app_identifier(options)
       find_version(options)
     end
 
     def find_app_identifier(options)
       return if options[:app_identifier]
-
       if options[:ipa]
-        identifier = FastlaneCore::IpaFileAnalyser.fetch_app_identifier(options[:ipa])
-      elsif options[:pkg]
-        identifier = FastlaneCore::PkgFileAnalyser.fetch_app_identifier(options[:pkg])
+        # identifier = AppRepo::Analyser.fetch_app_identifier(options[:ipa])
       end
-
-      options[:app_identifier] = identifier if identifier.to_s.length > 0
-      options[:app_identifier] ||= UI.input('The Bundle Identifier of your App: ')
-    end
-
-    def find_folders(options)
-      containing = Helper.fastlane_enabled? ? './fastlane' : '.'
-      unless options[:metadata_path].nil?
-        puts "Containing: '" + options[:metadata_path] + "' folder for TODO RENAME example_manifest.json"
-        options[:metadata_path] ||= File.join(containing, '/../manifest.json')
-        puts "Options: '" + options[:metadata_path] + "'"
-        FileUtils.mkdir_p(options[:metadata_path])
-    end
+      options[:app_identifier] = identifier unless identifier.to_s.empty?
+      input_message = 'The Bundle Identifier of your App: '
+      options[:app_identifier] ||= UI.input(input_message)
     end
 
     def find_version(options)
       unless options[:ipa].nil?
-        options[:app_version] ||= FastlaneCore::IpaFileAnalyser.fetch_app_version(options[:ipa])
+        opt = AppRepo::Analyser.new(options)
+        options[:app_version] ||= opt.fetch_app_version(options[:ipa])
       end
     end
   end

data/lib/apprepo/loader.rb

@@ -1,10 +1,12 @@
 require 'fastlane_core/languages'
 
-module Deliver
+module AppRepo
+  # Responsible for loading language folders
   module Loader
     def self.language_folders(root)
       Dir.glob(File.join(root, '*')).select do |path|
-        File.directory?(path) && ALL_LANGUAGES.include?(File.basename(path).downcase)
+        all = ALL_LANGUAGES.include?(File.basename(path).downcase)
+        File.directory?(path) && all
       end.sort
     end
   end

data/lib/apprepo/manifest.rb

@@ -1,4 +1,7 @@
+require 'json'
+
 module AppRepo
+  # Responsible for parsing and providing manifest.json
   class Manifest
     #
     # Translated internal key names from Fastlane to AppRepo
@@ -14,11 +17,15 @@ module AppRepo
 
     def initialize(appcode)
       self.appcode = appcode
-      UI.message('Initializing "AppRepo:Manifest requies at least APPCODE :"' + self.appcode)
+      UI.message('Initializing requires APPCODE. ' + self.appcode)
+    end
+
+    def parse_json(json)
+      # TODO: load values from JSON
     end
 
     # Provide JSON serialized data
-    def getJSON
+    def manifest_as_json
       structure = {
         appcode: appcode,
         filename: filename,

data/lib/apprepo/options.rb

@@ -1,7 +1,9 @@
 require 'fastlane_core'
 
 module AppRepo
+  # Provides available options for the commands generator
   class Options
+    # rubocop:disable Metrics/AbcSize
     def self.available_options
       [
         FastlaneCore::ConfigItem.new(key: :ipa,
@@ -13,10 +15,6 @@ module AppRepo
                                      verify_block: proc do |value|
                                        UI.user_error!("Could not find ipa file at path '#{value}'") unless File.exist?(value)
                                        UI.user_error!("'#{value}' doesn't seem to be an ipa file") unless value.end_with?('.ipa')
-                                     end,
-                                     conflicting_options: [:pkg],
-                                     conflict_block: proc do |value|
-                                       UI.user_error!("You can't use 'ipa' and '#{value.key}' options in one run.")
                                      end),
         FastlaneCore::ConfigItem.new(key: :app_identifier,
                                      short_option: '-b',
@@ -39,33 +37,55 @@ module AppRepo
                                      optional: false,
                                      env_name: 'APPREPO_USER',
                                      description: 'USER of your Apprepo server'),
+        FastlaneCore::ConfigItem.new(key: :repo_password,
+                                     short_option: '-p',
+                                     optional: true,
+                                     env_name: 'APPREPO_PASSWORD',
+                                     description: 'PASSWORD for your Apprepo server (not for production)',
+                                     conflicting_options: [:repo_key],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("You can't use 'password' and '#{value.key}' options in one run.")
+                                     end),
         FastlaneCore::ConfigItem.new(key: :repo_key,
                                      short_option: '-k',
                                      optional: false,
                                      env_name: 'APPREPO_KEY',
-                                     description: 'RSA key for your Apprepo server'),
+                                     description: 'RSA key for your Apprepo server',
+                                     conflicting_options: [:repo_password],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("You can't use 'repo_key' and '#{value.key}' options in one run.")
+                                     end),
         FastlaneCore::ConfigItem.new(key: :repo_description,
                                      short_option: '-d',
                                      optional: true,
-                                     env_name: 'APPREPO_DESCRIPTION',
-                                     description: 'Long description for your Apprepo server'),
-        FastlaneCore::ConfigItem.new(key: :metadata_path,
+                                     description: 'Long detailed description for your Apprepo server',
+                                     default_value: ''),
+        FastlaneCore::ConfigItem.new(key: :repo_summary,
+                                     short_option: '-s',
+                                     optional: true,
+                                     description: 'Short description for your Apprepo server',
+                                     default_value: ''),
+        FastlaneCore::ConfigItem.new(key: :manifest_path,
                                      short_option: '-m',
                                      description: 'Path to the folder containing the metadata files',
                                      optional: true),
-        FastlaneCore::ConfigItem.new(key: :meta_title,
+        FastlaneCore::ConfigItem.new(key: :repo_title,
                                      short_option: '-a',
-                                     description: 'Name of the app',
-                                     optional: true),
+                                     description: 'Title of the app',
+                                     optional: false),
+        FastlaneCore::ConfigItem.new(key: :appcode,
+                                     short_option: '-o',
+                                     description: 'Name of the app on AppRepo',
+                                     optional: false),
         FastlaneCore::ConfigItem.new(key: :skip_binary_upload,
-                                     description: 'Skip uploading an ipa or pkg to iTunes Connect',
+                                     description: 'Skip uploading an ipa or to AppRepo',
                                      is_string: false,
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :app_version,
                                      short_option: '-z',
                                      description: 'The version that should be edited or created',
                                      optional: true),
-        FastlaneCore::ConfigItem.new(key: :skip_metadata,
+        FastlaneCore::ConfigItem.new(key: :skip_manifest,
                                      description: "Don't upload the metadata (e.g. title, description), this will still upload screenshots",
                                      is_string: false,
                                      default_value: false),
@@ -77,7 +97,7 @@ module AppRepo
                                      short_option: '-n',
                                      description: 'If set the given build number (already uploaded to iTC) will be used instead of the current built one',
                                      optional: true,
-                                     conflicting_options: [:ipa, :pkg],
+                                     conflicting_options: [:ipa],
                                      conflict_block: proc do |value|
                                        UI.user_error!("You can't use 'build_number' and '#{value.key}' options in one run.")
                                      end),