appetize-cli 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ac2414c9e172da66611492b42b6be163259c5f077cd181ca986202c280fc05
-  data.tar.gz: 160af0899d85e7ac9baa4e9767c92076825fe33c9b6765f297aec8fe645fed04
+  metadata.gz: 9cc8bacaba3e5f4e836d8e174d551bd32124a1ca8bfa4df92526492ac4904ae1
+  data.tar.gz: 7650c019adbc139aeac7beb5ee44e58f9163e340e26c7b6a43bf2f78204bd8b2
 SHA512:
-  metadata.gz: 117f6fb975766e2b1bbe02d12af8a411b1149debcdb2eb5847d4016fdf630b306f7065dd4bcdacd7318e8afb8b987519dc90753ecea217d83f3c56de1a692b10
-  data.tar.gz: a53615fdc5959c9a1d0d9e6ebd424fd83d1406551d2868524eb2785a3b02b2ab528025e74d60d3240dc57e31acc0086bed039bde26fe7f01e0a42798ec95353c
+  metadata.gz: 920e345be4a9c43c4cc12b853fbb0b354b2aebbd49fd6b368b6e220d344bac8d440446f7c62c39d34cd6509fb6337a49f01092f16118b99fc9388a098f4664f2
+  data.tar.gz: 49d8e0478a0ec95b035dc0737d758b3c798ec3cb8476a26e5b258f2ab882c452dda6e8237ee3876019facea3dedb81ee362edfbc88b0208aa1aedc88de8f8a1e

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +13,16 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+  
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']
+    

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-08-30
+## [0.1.4] - 2021-09-11
+
+- Upload command will detect & update existing Review Apps when running in GitLab CI
+
+## [0.1.3] - 2021-09-09
+
+- Upload command now returns full JSON response from Appetize
+
+## [0.1.2] - 2021-09-02
+
+- Adding specs, cleaning up gemspec, updated README
+
+## [0.1.1] - 2021-08-30
 
 - Initial release

data/README.md

@@ -1,43 +1,101 @@
-# Appetize
+# Appetize CLI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/appetize`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The Appetize CLI provides a command line interface to the [Appetize API](https://docs.appetize.io/api/overview). 
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install this gem by executing:
+
+    $ gem install appetize-cli
+
+## Usage
+
+Currently there are two supported actions `upload` and `delete` - `help` and `version` commands are also supplied.
 
-```ruby
-gem 'appetize'
+```
+Commands:
+  appetize delete PUBLIC_KEY     # Delete an app deploymment from Appetize
+  appetize help [COMMAND]        # Describe available commands or one specific command
+  appetize upload PATH PLATFORM  # Upload an APK/ZIP to Appetize
+  appetize version               # appetize version
 ```
 
-And then execute:
+### Setup
 
-    $ bundle install
+All actions in this tool require an Appetize API token, which can be generated in your Appetize account. Once a token has been generated you must set it as the environment variable `APPETIZE_API_TOKEN`. 
 
-Or install it yourself as:
+Example:
 
-    $ gem install appetize
+	$ export APPETIZE_API_TOKEN=yourtoken
 
-## Usage
 
-TODO: Write usage instructions here
+### Upload
+
+Upload an APK/ZIP to Appetize
+
+```
+Usage:
+  appetize upload PATH PLATFORM
+```
+
+`PATH` the path to the Apk or Zip file of the app you would like to deploy
+
+`PLATFORM` either `ios` or `android`
+
+Example:
+
+	$ appetize upload builds/app-debug.apk android
+	$ appetize upload builds/app.zip ios
+
+### Update
+
+Update an existing app in Appitize with a new APK/ZIP
+
+```
+Usage:
+  appetize update PATH PUBLIC_KEY
+```
+
+`PATH` the path to the Apk or Zip file of the app you would like to deploy
+
+`PUBLIC_KEY` the public key provided by Appetize for the specific app deployment you'd like to update
+
+Example:
+
+	$ appetize upload builds/app-debug.apk somepublickey
+	$ appetize upload builds/app.zip somepublickey
+
+
+### Delete
+
+Delete an app deploymment from Appetize
+
+```
+Usage:
+  appetize delete PUBLIC_KEY
+```
+
+`PUBLIC_KEY` the public key provided by Appetize for the specific app deployment you'd like to delete
+
+Example:
+
+	$ appetize delete somepublickey
+	
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/appetize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/appetize/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli/-/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli/-/blob/master/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the Appetize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/appetize/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Appetize CLI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli/-/blob/master/CODE_OF_CONDUCT.md).
 
 ## Copyright
 
-Copyright (c) 2021 Darby Frey. See [MIT License](LICENSE.txt) for further details.
+Copyright (c) 2021 GitLab, Inc. See [MIT License](LICENSE.txt) for further details.

data/appetize.gemspec

@@ -11,12 +11,12 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "A Command Line Interface to the Appetize.io API"
   spec.description   = "A Command Line Interface to the Appetize.io API"
-  spec.homepage      = "https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize"
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.homepage      = "https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize"
-  spec.metadata["changelog_uri"] = "https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli/-/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "httparty"
+  spec.add_dependency "thor"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/exe/appetize

@@ -1,18 +1,18 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-lib_path = File.expand_path('../lib', __dir__)
-$:.unshift(lib_path) if !$:.include?(lib_path)
-require 'appetize/cli'
+lib_path = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require "appetize/cli"
 
-Signal.trap('INT') do
+Signal.trap("INT") do
   warn("\n#{caller.join("\n")}: interrupted")
   exit(1)
 end
 
 begin
   Appetize::CLI.start
-rescue Appetize::CLI::Error => err
-  puts "ERROR: #{err.message}"
+rescue Appetize::CLI::Error => e
+  puts "ERROR: #{e.message}"
   exit 1
 end

data/lib/appetize/api.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module Appetize
+  class API
+    def initialize(token = nil, api_host = nil)
+      @token    = token || ENV["APPETIZE_API_TOKEN"]
+      @api_host = api_host || "api.appetize.io"
+
+      raise "Appetize Token Missing" if @token.nil?
+    end
+
+    def create(path, platform)
+      url = "https://#{@api_host}/v1/apps"
+      auth = { username: @token, password: "" }
+      body = { platform: platform, file: File.open(path) }
+
+      HTTParty.post(url, body: body, basic_auth: auth)
+    end
+
+    def update(path, public_key)
+      url = "https://#{@api_host}/v1/apps/#{public_key}"
+      auth = { username: @token, password: "" }
+      body = { file: File.open(path) }
+
+      HTTParty.post(url, body: body, basic_auth: auth)
+    end
+
+    def delete(public_key)
+      url = "https://#{@api_host}/v1/apps/#{public_key}"
+      auth = { username: @token, password: "" }
+
+      HTTParty.delete(url, basic_auth: auth)
+    end
+  end
+end

data/lib/appetize/ci/gitlab.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module Appetize
+  module CI
+    class GitLab
+      def initialize(project_id, ref_name, api_token, api_host = nil)
+        @project_id   = project_id
+        @ref_name     = ref_name
+        @api_token    = api_token
+        @api_host     = api_host || "https://gitlab.com/api/v4"
+      end
+
+      def fetch_artifact(job, artifact_name)
+        url = "#{@api_host}/projects/#{@project_id}/jobs/artifacts/#{@ref_name}/raw/#{artifact_name}?job=#{job}"
+
+        headers = {
+          "PRIVATE-TOKEN" => @api_token
+        }
+
+        HTTParty.get(url, headers: headers)
+      end
+    end
+  end
+end

data/lib/appetize/cli.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
-require 'httparty'
+require "thor"
 
 module Appetize
   # Handle the application command line parsing
@@ -12,33 +11,45 @@ module Appetize
     # Error raised by this runner
     Error = Class.new(StandardError)
 
-    desc 'version', 'appetize version'
+    desc "version", "appetize version"
     def version
-      require_relative 'version'
+      require_relative "version"
       puts "v#{Appetize::VERSION}"
     end
-    map %w(--version -v) => :version
+    map %w[--version -v] => :version
 
-    desc 'upload PATH PLATFORM', 'Upload an APK/ZIP to Appetize'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
+    desc "update PATH PUBLIC_KEY", "Command description..."
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
+    def update(path, public_key, token = nil, api_host = nil)
+      if options[:help]
+        invoke :help, ["update"]
+      else
+        require_relative "commands/update"
+        Appetize::Commands::Update.new(path, public_key, token, api_host, options).execute
+      end
+    end
+
+    desc "upload PATH PLATFORM", "Upload an APK/ZIP to Appetize"
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
     def upload(path, platform, token = nil, api_host = nil)
       if options[:help]
-        invoke :help, ['upload']
+        invoke :help, ["upload"]
       else
-        require_relative 'commands/upload'
+        require_relative "commands/upload"
         Appetize::Commands::Upload.new(path, platform, token, api_host, options).execute
       end
     end
 
-    desc 'delete PUBLIC_KEY', 'Delete an app deploymment from Appetize'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
+    desc "delete PUBLIC_KEY", "Delete an app deploymment from Appetize"
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
     def delete(public_key, token = nil, api_host = nil)
       if options[:help]
-        invoke :help, ['delete']
+        invoke :help, ["delete"]
       else
-        require_relative 'commands/delete'
+        require_relative "commands/delete"
         Appetize::Commands::Delete.new(public_key, token, api_host, options).execute
       end
     end

data/lib/appetize/command.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Appetize
   class Command
@@ -24,7 +24,7 @@ module Appetize
     #
     # @api public
     def command(**options)
-      require 'tty-command'
+      require "tty-command"
       TTY::Command.new(options)
     end
 
@@ -34,7 +34,7 @@ module Appetize
     #
     # @api public
     def cursor
-      require 'tty-cursor'
+      require "tty-cursor"
       TTY::Cursor
     end
 
@@ -44,7 +44,7 @@ module Appetize
     #
     # @api public
     def editor
-      require 'tty-editor'
+      require "tty-editor"
       TTY::Editor
     end
 
@@ -54,7 +54,7 @@ module Appetize
     #
     # @api public
     def generator
-      require 'tty-file'
+      require "tty-file"
       TTY::File
     end
 
@@ -64,7 +64,7 @@ module Appetize
     #
     # @api public
     def pager(**options)
-      require 'tty-pager'
+      require "tty-pager"
       TTY::Pager.new(options)
     end
 
@@ -74,7 +74,7 @@ module Appetize
     #
     # @api public
     def platform
-      require 'tty-platform'
+      require "tty-platform"
       TTY::Platform.new
     end
 
@@ -84,7 +84,7 @@ module Appetize
     #
     # @api public
     def prompt(**options)
-      require 'tty-prompt'
+      require "tty-prompt"
       TTY::Prompt.new(options)
     end
 
@@ -94,7 +94,7 @@ module Appetize
     #
     # @api public
     def screen
-      require 'tty-screen'
+      require "tty-screen"
       TTY::Screen
     end
 
@@ -104,7 +104,7 @@ module Appetize
     #
     # @api public
     def which(*args)
-      require 'tty-which'
+      require "tty-which"
       TTY::Which.which(*args)
     end
 
@@ -114,7 +114,7 @@ module Appetize
     #
     # @api public
     def exec_exist?(*args)
-      require 'tty-which'
+      require "tty-which"
       TTY::Which.exist?(*args)
     end
   end

data/lib/appetize/commands/delete.rb

@@ -1,35 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
+require_relative "../api"
 
 module Appetize
   module Commands
     class Delete < Appetize::Command
-      def initialize(public_key, token, api_host, options)
+      def initialize(public_key, token = nil, api_host = nil, options = {})
+        @api        = Appetize::API.new(token, api_host)
         @public_key = public_key
-        @token      = token
-        @api_host   = api_host
         @options    = options
       end
 
       def execute(input: $stdin, output: $stdout)
-        token      = @token    || ENV['APPETIZE_API_TOKEN']
-        api_host   = @api_host || 'api.appetize.io'
+        response = @api.delete(@public_key)
 
-        url = "https://#{api_host}/v1/apps/#{@public_key}"
-        auth = {
-          username: token,
-          password: ''
-        }
+        raise "Delete failed: #{response.code}" unless response.code == 200
 
-        response = HTTParty.delete(url, basic_auth: auth)
-        
-        if response.code == 200      
-          output.puts response
-        else 
-          message = "Delete failed: #{response.code}" 
-          raise message
-        end
+        output.puts response.body
       end
     end
   end

data/lib/appetize/commands/update.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../api"
+
+module Appetize
+  module Commands
+    class Update < Appetize::Command
+      def initialize(path, public_key, token, api_host, options)
+        @api        = Appetize::API.new(token, api_host)
+        @path       = path
+        @public_key = public_key
+        @options    = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        response = @api.update(@path, @public_key)
+
+        raise "Update failed: #{response.code}" unless response.code == 200
+
+        output.puts response.body
+      end
+    end
+  end
+end

data/lib/appetize/commands/upload.rb

@@ -1,40 +1,58 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
+require_relative "../api"
+require_relative "../ci/gitlab"
 
 module Appetize
   module Commands
     class Upload < Appetize::Command
       def initialize(path, platform, token, api_host, options)
-        @path = path
+        @api      = Appetize::API.new(token, api_host)
+        @path     = path
         @platform = platform
-        @token = token
-        @api_host = api_host
-        @options = options
+        @options  = options
       end
 
       def execute(input: $stdin, output: $stdout)
-        token      = @token    || ENV['APPETIZE_API_TOKEN']
-        api_host   = @api_host || 'api.appetize.io'
-
-        url = "https://#{api_host}/v1/apps"
-        auth = {
-          username: token,
-          password: ''
-        }
-        body = {
-          platform: @platform,
-          file: File.open(@path)          
-        }
-
-        response = HTTParty.post(url, body: body, basic_auth: auth)
-
-        if response.code == 200      
-          output.puts response
-        else 
-          message = "Upload failed: #{response.code}" 
-          raise message
+        # If we are running in GitLab CI, check for an existing pipeline
+        # if a pipeline is found, fetch the public key and update the
+        # existing Appetize app
+        if Appetize::Commands::Upload.gitlab_ci?
+          artifact_response = fetch_gitlab_artifact
+
+          if artifact_response.code == 200
+            public_key = JSON.parse(artifact_response.body)["publicKey"]
+
+            response = @api.update(@path, public_key)
+          end
         end
+
+        response = @api.create(@path, @platform) if public_key.nil?
+
+        raise "Upload failed: #{response.code}" unless response.code == 200
+
+        output.puts response.body
+      end
+
+      def self.gitlab_ci?
+        ENV["GITLAB_CI"].to_s.downcase == "true"
+      end
+
+      private
+
+      def fetch_gitlab_artifact
+        gitlab_client = Appetize::CI::GitLab.new(
+          ENV["CI_PROJECT_ID"],
+          ENV["CI_COMMIT_REF_NAME"],
+          ENV["PRIVATE_TOKEN"],
+          ENV["CI_API_V4_URL"]
+        )
+
+        gitlab_client.fetch_artifact(
+          "startReview",
+          "appetize-information.json"
+        )
       end
     end
   end

data/lib/appetize/templates/update/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/appetize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appetize
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

data/lib/appetize.rb

@@ -4,5 +4,4 @@ require_relative "appetize/version"
 
 module Appetize
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appetize-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Darby Frey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
 description: A Command Line Interface to the Appetize.io API
 email:
 - dfrey@gitlab.com
@@ -45,22 +59,26 @@ files:
 - bin/setup
 - exe/appetize
 - lib/appetize.rb
+- lib/appetize/api.rb
+- lib/appetize/ci/gitlab.rb
 - lib/appetize/cli.rb
 - lib/appetize/command.rb
 - lib/appetize/commands/.gitkeep
 - lib/appetize/commands/delete.rb
+- lib/appetize/commands/update.rb
 - lib/appetize/commands/upload.rb
 - lib/appetize/templates/.gitkeep
 - lib/appetize/templates/delete/.gitkeep
+- lib/appetize/templates/update/.gitkeep
 - lib/appetize/templates/upload/.gitkeep
 - lib/appetize/version.rb
-homepage: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize
+homepage: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize
-  source_code_uri: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize
-  changelog_uri: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize/CHANGELOG.md
+  homepage_uri: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli
+  source_code_uri: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli
+  changelog_uri: https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/appetize-cli/-/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -69,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="