aptly_cli 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTlmNzM3YjU0YzFkYjVmYTNjOWZmNWZiMmIzNjgxNDZiYzNmOGM1MQ==
+    NjhkOTM5MjIwOGJkNDc5ZTViY2NlZjY1ODg2YjU1OTQ0YjU2NmIxYg==
   data.tar.gz: !binary |-
-    MjZhOTk4NmYwYzQ0NTYwODcyYTNlMzIxZmI0NTViMDRhMTRlOTJkOA==
+    Yjc1N2EyMjI4OTFlYzE2NWQzOTg1NTE0OWM0Y2I2ZDE2NDg1NTI1OA==
 SHA512:
   metadata.gz: !binary |-
-    NzIwNmZiNjI1NmYzMTc3NmU3ODIyYTQxNDY2MTY4YmQ4MjY3MGRmYmQzNjcz
-    YjRlNDM4NDEwNTdkYTY3ZWUwNzQ4ZmQ3ZDg2ZjQ4OTdhYjU3NzQyMzhiOGMy
-    NDhiYTlmZWE4NmYzMDFiZjRjODVmZjYyMDIwYWQ0MjJlZDBjOGI=
+    NGRjMmJiOGI5ZDBmOTYyMjBiNTAwN2IxMmI3NjhlY2IwOWNmNTk0MWEwOTFm
+    N2I5OTYyOGYxOGNiYTFkNmI0ODAzOGYxOWUxMjhlOTMwNjZkN2RiNjNmYjIw
+    MzgwM2NmMzZlOTRlY2ZlZjk1NzRkODJjMjNiNTY1ZmVmY2QxYWM=
   data.tar.gz: !binary |-
-    MmZiZTBiYjFjZTg0NTMzZTM3NWQyZWYyMWFhNDZlOGZkZDdkZmU5OWJiODY3
-    MTI0ZDI5OTY4NGQwZDcxYjU4ZTQ4ODVmMzlkZDMwYWJiNjhlYTM1MzAwNjYy
-    NjdmZjcxOGMzNmI0OGY1OGY4Y2IxZjA3NjMzYzcyNzUzYjUzMDQ=
+    YzVhOWZmYjM1YTU2YjhkMmI3YmZhODZiOTc4ZGMwY2M0YjAxNGE5YWZkYTg0
+    ZDkzMTI5ZTkwNjE3YTBhN2I2OWIzN2MyYmNkZDY1MmFjNDJiMDA1M2ViODdm
+    YTUxMmZkZTRiMzIyMTNiNjAwY2Q5NDZiZGM3ZTI3MDhmNDQ5Mjk=

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in aptly_cli.gemspec
 gemspec
+
+gem "keyring", require: false, platform: :ruby_20
+
+group :test do
+  gem "rubocop", require: false
+  gem "simplecov", require: false
+end

data/README.md

@@ -12,9 +12,9 @@ A command line interface to execute [Aptly](http://aptly.info) commands againts
 ### Install Gem:
 
     $ gem install aptly_cli
-    
-or...    
-    
+
+or...
+
 ### Install and run aptly-cli from Docker:
 
     # Optional: If you don't pull explicitly, `docker run` will do it for you
@@ -47,42 +47,138 @@ If you use Basic Authentication to protect your API, add username and password:
 :password: api-password
 ```
 
+The username and password can also be configured for prompt entry using
+the following in `aptly-cli.conf`:
+
+```yaml
+:username: ${PROMPT}
+:password: ${PROMPT_PASSWORD}
+```
+
+The tool will prompt for the specified values, where `${PROMPT}` results
+in a regular prompt and `${PROMPT_PASSWORD}` results in a password
+prompt where the input is replaced by asterisks, e.g.:
+
+    $ aptly-cli version
+      Enter a value for username:
+      zane
+      Enter a value for password:
+      ********
+
+Another possibility for storing passwords is `${KEYRING}`. To use this feature,
+you must have the [`keyring` gem](https://github.com/jheiss/keyring) installed
+and also have a system that is set up to use one of the backends that the
+`keyring` gem supports, such as Mac OS X Keychain or GNOME 2 Keyring (Note:
+Only Mac OS X Keychain has been tested thus far):
+
+    $ gem install keyring
+
+Then you can put something like this in `aptly-cli.conf`:
+
+```yaml
+:username: zane
+:password: ${KEYRING}
+```
+
+The first time you run an `aptly-cli` command, you will be prompted to enter a
+password.
+
+    $ aptly-cli version
+    Enter a value for password:
+    ***************
+
+The entered password will be stored in your keyring so that future uses of
+`aptly-cli` can get the password from your keyring:
+
+    $ aptly-cli version
+    {"Version"=>"0.9.7"}
+
 Also make sure that your config file isn't world readable (```chmod o-rw /etc/aptly-cli.conf```)
 
-If a configuration file is not found the defaults in the example configuration file above will be used
+If a configuration file is not found, the defaults in the example
+configuration file above will be used.
 
 ## Usage - available aptly-cli commands
 
-    aptly-cli --help
-
-    file_delete        Deletes all files in upload directory and directory itself. Or delete just a file
-    file_list          List all directories that contain uploaded files
-    file_upload        Parameter --directory is upload directory name. Directory would be created if it doesn’t exist.
-    graph              Download a graph of repository layout.  Current options are "svg" and "png"
-    help               Display global or [command] help documentation
-    publish_drop       Delete published repository, clean up files in published directory.
-    publish_list       List published repositories.
-    publish_repo       Publish local repository or snapshot under specified prefix. Storage might be passed in prefix as well, e.g. s3:packages/. To supply empty prefix, just remove last part (POST /api/publish/:prefix/<:repos>or<:snapshots>
-    publish_update     Update published repository. If local repository has been published, published repository would be updated to match local repository contents. If snapshots have been been published, it is possible to switch each component to new snapshot
-    repo_create        Create a new repository, requires --name
-    repo_delete        Delete a local repository, requires --name
-    repo_edit          Edit a local repository metadata, requires --name
-    repo_list          Show list of currently available local repositories
-    repo_package_query List all packages in local repository or perform search on repository contents and return result., requires --name
-    repo_show          Returns basic information about local repository
-    repo_upload        Import packages from files (uploaded using File Upload API) to the local repository. If directory specified, aptly would discover package files automatically.Adding same package to local repository is not an error. By default aptly would try to remove every successfully processed file and directory :dir (if it becomes empty after import).
-    snapshot_create    Create snapshot of current local repository :name contents as new snapshot with name :snapname
-    snapshot_delete    Delete snapshot. Snapshot can’t be deleted if it is published. aptly would refuse to delete snapshot if it has been used as source to create other snapshots, but that could be overridden with force parameter
-    snapshot_diff      Calculate difference between two snapshots --name (left) and --withsnapshot (right).
-    snapshot_list      Return list of all snapshots created in the system
-    snapshot_search    List all packages in snapshot or perform search on snapshot contents and return result
-    snapshot_show      Get information about snapshot by name
-    snapshot_update    Update snapshot’s description or name
-    version            Display aptly server 
-    
+The `--config` (`-c`) option allows specifying an alternative config file, e.g.:
+
+    $ aptly-cli -c ~/.config/aptly-cli/aptly-cli.conf repo_list
+
+The `--server`, `--username`, and `--password` options allow specifying
+those things on the command-line and not even requiring a config file.
+
+    $ aptly-cli --server 10.3.0.46 --username marca --password '${PROMPT_PASSWORD}' repo_list
+
+Note that you can use `${PROMPT}`, `${PROMPT_PASSWORD}`, and `${KEYRING}` in
+the values of these options, just as you can in a config file. Note that you
+might have to quote them to prevent the shell from trying to expand them.
+
+    $ aptly-cli --help
+      NAME:
+
+        aptly-cli
+
+      DESCRIPTION:
+
+        Aptly repository API client
+
+      COMMANDS:
+
+        file_delete        File delete
+        file_list          List all directories
+        file_upload        File upload
+        graph              Download an svg or png graph of repository layout
+        help               Display global or [command] help documentation
+        publish_drop       Delete published repository
+        publish_list       List published repositories
+        publish_repo       Publish local repository or snapshot under specified prefix
+        publish_update     Update published repository
+        repo_create        Create a new repository, requires --name
+        repo_delete        Delete a local repository, requires --name
+        repo_edit          Edit a local repository metadata, requires --name
+        repo_list          Show list of currently available local repositories
+        repo_package_query List all packages or search on repo contents, requires --name
+        repo_show          Returns basic information about local repository
+        repo_upload        Import packages from files
+        snapshot_create    Create snapshot, require --name
+        snapshot_delete    Delete snapshot, require --name
+        snapshot_diff      Calculate difference between two snapshots
+        snapshot_list      Return list of all snapshots created in the system
+        snapshot_search    List all packages in snapshot or perform search
+        snapshot_show      Get information about snapshot by name
+        snapshot_update    Update snapshot’s description or name
+        version            Display aptly server version
+
+      GLOBAL OPTIONS:
+
+        -c, --config FILE
+            Path to YAML config file
+
+        -s, --server SERVER
+            Host name or IP address
+
+        --username USERNAME
+            User name
+
+        --password PASSWORD
+            Password
+
+        --debug
+            Enable debug output
+
+        -h, --help
+            Display help documentation
+
+        -v, --version
+            Display version information
+
+        -t, --trace
+            Display backtrace when an error occurs
+
+
 ### To see more options for each command
 
-    aptly-cli <command> --help
+    $ aptly-cli <command> --help
 
 
 ## Development

data/Rakefile

@@ -2,6 +2,13 @@ require "bundler/gem_tasks"
 
 require "rake/testtask"
 
+begin
+  require 'rubocop/rake_task'
+	RuboCop::RakeTask.new
+rescue LoadError
+  puts 'Install "rubocop" to enable rubocop Rake task.'
+end
+
 Rake::TestTask.new do |t|
   t.libs << "lib"
   t.libs << "test"

data/bin/aptly-cli

@@ -5,11 +5,12 @@ require 'rubygems'
 require 'commander/import'
 require 'aptly_cli'
 
-program :version, AptlyCli::VERSION 
-program :description, 'Aptly repository API client'
+program :version, AptlyCli::VERSION
+program :description, 'Aptly repository API client (https://github.com/sepulworld/aptly_cli)'
 
 $config_file = '/etc/aptly-cli.conf'
 $server = nil
+$port = nil
 $username = nil
 $password = nil
 $debug = false
@@ -18,13 +19,16 @@ global_option('-c', '--config FILE', 'Path to YAML config file') do |config_file
   $config_file = config_file
 end
 
-global_option('-s', '--server SERVER', 'Host name or IP address') do |server|
+global_option('-s', '--server SERVER', 'Host name or IP address of Aptly API server') do |server|
   $server = server
 end
-global_option('--username USERNAME', 'User name') do |username|
+global_option('-p', '--port PORT', 'Port of Aptly API server') do |port|
+  $port = port
+end
+global_option('--username USERNAME', 'User name or \'${PROMPT}\'') do |username|
   $username = username
 end
-global_option('--password PASSWORD', 'Password') do |password|
+global_option('--password PASSWORD', 'Password or \'${PROMPT_PASSWORD}\' or \'${KEYRING}\'') do |password|
   $password = password
 end
 global_option('--debug', 'Enable debug output') do
@@ -35,6 +39,9 @@ def handle_global_options(options)
   if $server
     options.server = $server
   end
+  if $port
+    options.port = $port
+  end
   if $username
     options.username = $username
   end

data/lib/aptly_cli/version.rb

@@ -1,3 +1,3 @@
 module AptlyCli
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/aptly_command.rb

@@ -1,55 +1,71 @@
-class AptlyCommand
-  def initialize(config, options = nil)
-    @config = config
-    options ||= Options.new
+module AptlyCli
+  class AptlyCommand
+    include HTTMultiParty
 
-    if options.server
-      @config[:server] = options.server
-    end
+    attr_accessor :config
 
-    if options.username
-      @config[:username] = options.username
-    end
+    def initialize(config, options = nil)
+      @config = config
+      options ||= Options.new
 
-    if options.password
-      @config[:password] = options.password
-    end
+      if options.respond_to?(:server) && options.server
+        @config[:server] = options.server
+      end
 
-    if options.debug
-      @config[:debug] = options.debug
-    end
+      if options.respond_to?(:port) && options.port
+        @config[:port] = options.port
+      end
+
+      if options.respond_to?(:username) && options.username
+        @config[:username] = options.username
+      end
+
+      if options.respond_to?(:password) && options.password
+        @config[:password] = options.password
+      end
 
-    @config.each do |k, v|
-      if v == '${PROMPT}'
-        @config[k.to_sym] = ask("Enter a value for #{k}:")
-      elsif v == '${PROMPT_PASSWORD}'
-        @config[k.to_sym] = password("Enter a value for #{k}:")
-      elsif v == '${KEYRING}'
-        require 'keyring'
+      if options.respond_to?(:debug) && options.debug
+        @config[:debug] = options.debug
+      end
 
-        keyring = Keyring.new
-        value = keyring.get_password(@config[:server], @config[:username])
+      @config.each do |k, v|
+        if v == '${PROMPT}'
+          @config[k.to_sym] = ask("Enter a value for #{k}:")
+        elsif v == '${PROMPT_PASSWORD}'
+          @config[k.to_sym] = password("Enter a value for #{k}:")
+        elsif v == '${KEYRING}'
+          require 'keyring'
 
-        unless value
-          # Prompt for password...
-          value = password("Enter a value for #{k}:")
+          keyring = Keyring.new
+          keychain_item_name = 'Aptly API server at ' + \
+                               @config[:server] + ':' + @config[:port].to_s
+          value = keyring.get_password(keychain_item_name, @config[:username])
 
-          # ... and store in keyring
-          keyring.set_password(@config[:server], @config[:username], value)
-        end
+          unless value
+            # Prompt for password...
+            value = password("Enter a value for #{k}:")
 
-        @config[k.to_sym] = value
+            # ... and store in keyring
+            keyring.set_password(keychain_item_name, @config[:username], value)
+          end
+
+          @config[k.to_sym] = value
+        end
       end
-    end
 
-    base_uri = "#{@config[:proto]}://#{@config[:server]}:#{@config[:port]}/api"
-    self.class.base_uri base_uri
+      base_uri = "#{@config[:proto]}://#{@config[:server]}:#{@config[:port]}" \
+                 '/api'
+      self.class.base_uri base_uri
+
+      if @config[:username]
+        if @config[:password]
+          self.class.basic_auth @config[:username].to_s, @config[:password].to_s
+        end
+      end
 
-    if @config[:username]
-      if @config[:password]
-        self.class.basic_auth @config[:username].to_s, @config[:password].to_s
+      if respond_to?(:debug_output)
+        debug_output $stdout if @config[:debug] == true
       end
     end
-    debug_output $stdout if @config[:debug] == true
   end
 end

data/lib/aptly_file.rb

@@ -6,7 +6,6 @@ require 'httmultiparty'
 module AptlyCli
   # Uploading file into Aptly
   class AptlyFile < AptlyCommand
-    include HTTMultiParty
     attr_accessor :file_uri, :package, :local_file_path
 
     def file_dir

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptly_cli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Zane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler