appetize-cli 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 642908ae4d7480ba11ec35402e9a73a7f59b669eea197f702309ae1a4176b73a
-  data.tar.gz: 5f230ed7ad97f5dd2ff48ab2563c975e5818c9e38b3fa0535dddb8e88d52a653
+  metadata.gz: d2101282d9a12bdff13f6a1dd9201f02ad8d2a224cb3a3812062fcd071055d45
+  data.tar.gz: b15eb9a303bf9a1eacd987e104389d152f099e041449a58849eaeb2e6ea106c7
 SHA512:
-  metadata.gz: eb0850157f3cffcea73c08d1eace35568c3fdc70c1b78c667ada8c3b4f742ee063a645f8fe0a7efc6247be0a35028b5760e74de2eddc62514c21ffae221ecd3d
-  data.tar.gz: f861b188ad460b2e53fd2ba5e87e18c50f931f825ca1907ab671ec94cb23d2d1cc19e12d18e9a29cfca73cb4740e9bf7834a50aa078f9f2101567ff5517c05ad
+  metadata.gz: 928614f04e34a1cde2585b6d626e83a7e3b78610b9349142ab212f8c8cd3b50a78dc4566d49f6b688826e9a9d21802ce0b5a6dd485bc4bdb733f674af53da49b
+  data.tar.gz: 22ca9b064911e3271dc4c1aba63bc7a37761cca606ca1337465c7c66550fafc0025268e7f5c4d6a66bbb80b36ae260da73e380d5f3a3aef42389131fa0d7feba

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +11,12 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+  
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-08-30
+## [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,83 @@
-# 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
+
+
+### 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/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.

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/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,33 @@ 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 "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,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require "httparty"
+require_relative "../command"
 
 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 = {})
         @public_key = public_key
         @token      = token
         @api_host   = api_host
@@ -13,23 +14,17 @@ module Appetize
       end
 
       def execute(input: $stdin, output: $stdout)
-        token      = @token    || ENV['APPETIZE_API_TOKEN']
-        api_host   = @api_host || 'api.appetize.io'
+        token     = @token    || ENV["APPETIZE_API_TOKEN"]
+        api_host  = @api_host || "api.appetize.io"
 
         url = "https://#{api_host}/v1/apps/#{@public_key}"
-        auth = {
-          username: token,
-          password: ''
-        }
+        auth = { username: token, password: "" }
 
         response = HTTParty.delete(url, basic_auth: auth)
-        
-        if response.code == 200      
-          output.puts response
-        else 
-          message = "Delete failed: #{response.code}" 
-          raise message
-        end
+
+        raise "Delete failed: #{response.code}" unless response.code == 200
+
+        output.puts response.message
       end
     end
   end

data/lib/appetize/commands/upload.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require "httparty"
+require_relative "../command"
 
 module Appetize
   module Commands
@@ -14,27 +15,18 @@ module Appetize
       end
 
       def execute(input: $stdin, output: $stdout)
-        token      = @token    || ENV['APPETIZE_API_TOKEN']
-        api_host   = @api_host || 'api.appetize.io'
+        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)          
-        }
+        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
-        end
+        raise "Upload failed: #{response.code}" unless response.code == 200
+
+        output.puts response.message
       end
     end
   end

data/lib/appetize/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appetize-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Darby Frey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -68,13 +68,13 @@ files:
 - lib/appetize/templates/delete/.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/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -83,7 +83,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:
   - - ">="