brightbox-cli 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34feccb6a89c40ab981c31b408d896606d548abd
-  data.tar.gz: a58a457c767e64ade86c3283e7313f8a76ba1445
+  metadata.gz: 878ff7e5b319cc7c15095db32d0091a6e1d2988b
+  data.tar.gz: d5809b9c66921ea3820855723d871fb1eeeb99ec
 SHA512:
-  metadata.gz: dd53e4d8ec2d68ad698290ba23a4ca89605a4e17b5af26db4a6f9208362304f68977e144f647ab824b28484b69caea3d88e5fd73da28656054e4a8d232f0859f
-  data.tar.gz: a50b5c409d4b938708b3c2ad29219675f054396cbfaf4175f5019523668cf0ef7bc5175eaafffabb21508c291273990c6cdd6850cd8c89abbcc5e3cd77a17d0a
+  metadata.gz: 95b4dce981e19ad00c6f79636cc4bd29c620eee0ca43eb5256be40c2a5c60be9de634348c861177a21f4d4d72720ed1b26b8c8efbb787c8948011bddc55d148b
+  data.tar.gz: e5f9235468da53a0f4635665376dae4f9f35d4d43612c144ef36bc343342f03496cf1eb415fa682217fd101b09bd1ac06222f6f58b28d5987fb3ca12cf53765e

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+### v2.3.0 / 2015-10-23
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v2.2.0...v2.3.0)
+
+Enhancements:
+
+* Adds embedded client that is used when a user has not setup their own
+  application.
+* Adds `brightbox login` command which allows a simplified login for users with
+  just their email address and password (prompted).
+
+    brightbox login user@example.com
+
+  This uses the embedded application to save extra steps setting up.
+
+Bug fixes:
+
+* Guard against errors when using `DEBUG=true` whilst configuration is not
+  selected triggering a `NoMethodError`
+* Use `pry-remote` for debugging. `pry` runs in process and the IO is trapped
+  when testing and in some error cases making it unusable.
+* Fix configuration code so it can initialise without network side effects when
+  reading client_name and other values.
+
 ### v2.2.0 / 2015-09-28
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v2.1.2...v2.2.0)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (2.2.0)
+    brightbox-cli (2.3.0)
       fog-brightbox (>= 0.9.0)
       gli (~> 2.12.0)
       highline (~> 1.6.0)
@@ -50,6 +50,9 @@ GEM
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
     rake (10.1.0)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -68,7 +71,7 @@ PLATFORMS
 DEPENDENCIES
   brightbox-cli!
   mocha
-  pry
+  pry-remote
   rake
   rspec (~> 2.99)
   vcr (~> 2.5)

data/brightbox-cli.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
   s.add_dependency "hirb", "~> 0.6"
 
   s.add_development_dependency "mocha"
-  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-remote"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 2.99"
   s.add_development_dependency "vcr", "~> 2.5"

data/lib/brightbox/cli/config.rb

@@ -0,0 +1,19 @@
+require "singleton"
+
+module Brightbox
+  module CLI
+    class Config
+      include Singleton
+
+      attr_accessor :config
+    end
+  end
+
+  def self.config
+    CLI::Config.instance.config
+  end
+
+  def self.config=(replacement)
+    CLI::Config.instance.config = replacement
+  end
+end

data/lib/brightbox-cli/accounts.rb

@@ -17,7 +17,7 @@ module Brightbox
     end
 
     def self.all
-      if $config.using_application?
+      if Brightbox.config.using_application?
         conn.accounts.all
       else
         [conn.account]
@@ -25,7 +25,7 @@ module Brightbox
     end
 
     def self.get(id)
-      if $config.using_application?
+      if Brightbox.config.using_application?
         a = conn.accounts.get(id)
       else
         a = conn.account

data/lib/brightbox-cli/api.rb

@@ -22,7 +22,7 @@ module Brightbox
       if @@connection_manager
         @@connection_manager.fetch_connection(require_account?)
       else
-        @@connection_manager = Brightbox::ConnectionManager.new($config.to_fog)
+        @@connection_manager = Brightbox::ConnectionManager.new(Brightbox.config.to_fog)
         @@connection_manager.fetch_connection(require_account?)
       end
     end
@@ -52,7 +52,7 @@ module Brightbox
       else
         raise InvalidArguments, "Can't initialize #{self.class} with #{m.inspect}"
       end
-      $config.cache_id(@id) if $config.respond_to?(:cache_id)
+      Brightbox.config.cache_id(@id) if Brightbox.config.respond_to?(:cache_id)
     end
 
     def fog_model
@@ -164,7 +164,7 @@ module Brightbox
       if value
         value
       else
-        $config.cache_id id
+        Brightbox.config.cache_id id
         @cache[id] = get(id)
       end
     end
@@ -179,7 +179,7 @@ module Brightbox
       @cache = {}
       all.each do |f|
         @cache[f.id] = f
-        $config.cache_id f.id
+        Brightbox.config.cache_id f.id
       end
     end
 

data/lib/brightbox-cli/commands/accounts/default.rb

@@ -16,7 +16,7 @@ module Brightbox
           raise "Invalid account-id"
         end
 
-        $config.save_default_account(account_id)
+        Brightbox.config.save_default_account(account_id)
       end
     end
   end

data/lib/brightbox-cli/commands/accounts/list.rb

@@ -8,7 +8,7 @@ module Brightbox
     cmd.command [:list] do |c|
 
       c.action do |global_options, _options, _args|
-        if $config.using_application?
+        if Brightbox.config.using_application?
           # Collaborating Accounts are combined from owned and collaborations
           accounts = CollaboratingAccount.all
         else

data/lib/brightbox-cli/commands/config/client-add.rb

@@ -14,7 +14,7 @@ module Brightbox
 
       c.action do |_global_options, options, args|
 
-        info "Using config file #{$config.config_filename}"
+        info "Using config file #{Brightbox.config.config_filename}"
 
         client_id = args.shift
         secret = args.shift
@@ -39,7 +39,7 @@ module Brightbox
           :api_url => api_url,
           :auth_url => auth_url
         }
-        $config.add_section(calias, client_id, secret, options)
+        Brightbox.config.add_section(calias, client_id, secret, options)
       end
     end
   end

data/lib/brightbox-cli/commands/config/client-default.rb

@@ -7,16 +7,16 @@ module Brightbox
 
       c.action do |_global_options, _options, args|
 
-        info "Using config file #{$config.config_filename}"
+        info "Using config file #{Brightbox.config.config_filename}"
         calias = args.shift
 
         if calias.nil?
           raise "You must specify the api alias you want to set as the default"
         end
 
-        if $config.client_named?(calias)
+        if Brightbox.config.client_named?(calias)
           info "Setting #{calias} as default api client"
-          $config.set_default_client(calias)
+          Brightbox.config.set_default_client(calias)
         else
           raise "An api client with the alias #{calias} does not exist in the config"
         end

data/lib/brightbox-cli/commands/config/client-list.rb

@@ -8,21 +8,21 @@ module Brightbox
 
       c.action do |global_options, _options, _args|
 
-        info "Using config file #{$config.config_filename}"
+        info "Using config file #{Brightbox.config.config_filename}"
 
-        clients = $config.clients.map do |cid|
-          c = $config[cid]
+        clients = Brightbox.config.section_names.map do |cid|
+          c = Brightbox.config[cid]
           calias = c["alias"] || cid
 
           # Append a star for the configured default client
-          if $config.default_client == cid && $config.has_multiple_clients?
+          if Brightbox.config.default_client == cid && Brightbox.config.has_multiple_clients?
             calias = "*#{calias}"
           end
 
           {
             :alias => calias,
-            :client_id => c["client_id"],
-            :secret => c["secret"],
+            :client_id => c["client_id"] || Brightbox::EMBEDDED_APP_ID,
+            :secret => c["secret"] || Brightbox::EMBEDDED_APP_SECRET,
             :api_url => c["api_url"],
             :auth_url => c["auth_url"] || c["api_url"]
           }

data/lib/brightbox-cli/commands/config/client-remove.rb

@@ -7,7 +7,7 @@ module Brightbox
 
       c.action do |_global_options, _options, args|
 
-        info "Using config file #{$config.config_filename}"
+        info "Using config file #{Brightbox.config.config_filename}"
 
         calias = args.shift
 
@@ -15,8 +15,8 @@ module Brightbox
           raise "You must specify the api alias you want to remove"
         end
 
-        client_config = $config.clients.find do |config|
-          $config[config]["alias"] == calias
+        client_config = Brightbox.config.section_names.find do |config|
+          Brightbox.config[config]["alias"] == calias
         end
 
         if client_config.nil?
@@ -24,7 +24,7 @@ module Brightbox
         end
 
         info "Removing api client #{calias}"
-        $config.delete_section client_config
+        Brightbox.config.delete_section client_config
       end
     end
   end

data/lib/brightbox-cli/commands/config/user-add.rb

@@ -15,7 +15,7 @@ module Brightbox
 
         require 'highline'
 
-        info "Using config file #{$config.config_filename}"
+        info "Using config file #{Brightbox.config.config_filename}"
 
         email = args.shift
         client_id = args.shift
@@ -57,7 +57,7 @@ module Brightbox
           :api_url => api_url,
           :auth_url => auth_url
         }
-        $config.add_section(calias, client_id, secret, options)
+        Brightbox.config.add_section(calias, client_id, secret, options)
       end
     end
   end

data/lib/brightbox-cli/commands/login.rb

@@ -0,0 +1,53 @@
+module Brightbox
+  command [:login] do |cmd|
+    cmd.desc I18n.t("login.desc")
+    cmd.arg_name "email"
+
+    cmd.desc "password, if not specified you will be prompted"
+    cmd.flag [:p, "password"]
+
+    cmd.desc "default account"
+    cmd.flag [:"default-account"]
+
+    cmd.flag [:"application-id"]
+    cmd.flag [:"application-secret"]
+
+    cmd.flag [:"api-url"]
+    cmd.flag [:"auth-url"]
+
+    cmd.action do |_global_options, options, args|
+      config_name = args.shift
+      email = config_name
+
+      raise "You must specify your email address" if email.nil?
+
+      password = options[:p]
+      password = Brightbox.config.gpg_password unless password
+
+      if !password || password.empty?
+        require "highline"
+        highline = HighLine.new
+        password = highline.ask("Enter your password : ") { |q| q.echo = false }
+      end
+      raise "You must specify your Brightbox password." if password.empty?
+
+      api_url = options[:"api-url"] || DEFAULT_API_ENDPOINT
+      auth_url = options[:"auth-url"] || api_url
+
+      section_options = {
+        :client_name => config_name,
+        :alias => config_name,
+        :username => email,
+        :password => password,
+        :api_url => api_url,
+        :auth_url => auth_url
+      }
+      section_options[:default_account] = options[:"default-account"] if options[:"default-account"]
+
+      section_options[:client_id] = options[:"application-id"] if options[:"application-id"]
+      section_options[:secret] = options[:"application-secret"] if options[:"application-secret"]
+
+      Brightbox.config.add_login(email, password, section_options)
+    end
+  end
+end

data/lib/brightbox-cli/config/accounts.rb

@@ -22,6 +22,11 @@ module Brightbox
         end
       end
 
+      def determine_account(preferred_account)
+        return preferred_account if preferred_account
+        return config[client_name]["default_account"] unless client_name.nil?
+      end
+
       def account
         if defined?(@account) && @account
           @account

data/lib/brightbox-cli/config/authentication_tokens.rb

@@ -4,7 +4,7 @@ module Brightbox
       attr_writer :access_token, :refresh_token
 
       def access_token_filename
-        file_name = "#{client_name}.oauth_token"
+        file_name = "#{base_token_name}.oauth_token"
         @access_token_filename ||= File.join(config_directory, file_name)
       end
 
@@ -20,7 +20,7 @@ module Brightbox
       end
 
       def refresh_token_filename
-        file_name = "#{client_name}.refresh_token"
+        file_name = "#{base_token_name}.refresh_token"
         @refresh_token_filename ||= File.join(config_directory, file_name)
       end
 
@@ -55,7 +55,7 @@ module Brightbox
       # This attempts to renew access (and refresh) tokens for the current
       # configuration based on the current connection.
       #
-      # @note $config and Api.conn are actually two different worlds and should
+      # @note Brightbox.config and Api.conn are actually two different worlds and should
       #   be merged (so a configuration holds the current connection)
       #
       def renew_tokens(options = {})
@@ -234,6 +234,13 @@ module Brightbox
       def cached_refresh_token
         File.open(refresh_token_filename, "r") { |fl| fl.read.chomp }
       end
+
+      private
+
+      def base_token_name
+        return nil if client_name.nil?
+        client_name.gsub("/", "_")
+      end
     end
   end
 end

data/lib/brightbox-cli/config/cache.rb

@@ -2,21 +2,17 @@ module Brightbox
   module Config
     module Cache
       def cache_path
-        if @cache_path
-          @cache_path
-        else
-          @cache_path = File.join(config_directory, 'cache')
-          unless File.exist? @cache_path
-            begin
-              FileUtils.mkpath @cache_path
-            rescue Errno::EEXIST
-            end
-          end
-          @cache_path
-        end
+        File.join(config_directory, "cache")
       end
 
       def cache_id(cid)
+        return if cid.nil?
+        unless File.exist?(cache_path)
+          begin
+            FileUtils.mkpath(cache_path)
+          rescue Errno::EEXIST
+          end
+        end
         FileUtils.touch(File.join(cache_path, cid)) unless cid.nil?
       end
     end

data/lib/brightbox-cli/config/clients.rb

@@ -8,12 +8,16 @@ module Brightbox
 
       # Is the currently selected config using user application details?
       def using_application?
-        config_identifier_match_prefix?("app")
+        if client_name
+          !config[client_name]["username"].nil?
+        else
+          raise NoSelectedClientError, NO_CLIENT_MESSAGE
+        end
       end
 
       # Does this config have multiple clients defined within?
       def has_multiple_clients?
-        clients.size > 1
+        section_names.size > 1
       end
 
       # Does the currently selected client have an alias and a config section
@@ -32,44 +36,9 @@ module Brightbox
         selected_config["alias"] || client_name
       end
 
-      # Returns a client name or raises depending on a number of factors.
-      #
-      # FIXME: This combines too much decision making into what appears to be a
-      # getter.
-      #
-      # If a default_client is not set and there are more than one client it
-      # raises an error because it is ambiguous which to use.
-      #
-      # If +force_default_config+ is passed in as false (for +config+ commands)
-      # then it attempts to use the first config
-      #
-      # Calling +client_name+ within the +config+ command will break the config
-      # command because you can no longer manage your config (and set a default)
-      #
-      # This has been fixed by short circuiting to return +nil+ in that case which
-      # should never exist now.
-      #
-      def client_name
-        if @client_name
-          @client_name
-        else
-          # If we do not require a default client do not error if one is not set
-          # TODO: Remove when certain unused
-          if @options[:force_default_config] == false
-            @client_name = default_client
-          else
-            # Is client ambigious?
-            if default_client.nil? && clients.length > 1
-              raise AmbiguousClientError, AMBIGUOUS_CLIENT_ERROR
-            end
-            @client_name = default_client || clients.first
-          end
-        end
-      end
-
       # Returns the actual client ID with no risk of an alias
       def client_id
-        selected_config["client_id"]
+        selected_config["client_id"] || Brightbox::EMBEDDED_APP_ID
       end
 
       # @todo Account for "core" section
@@ -104,6 +73,13 @@ module Brightbox
         @default_client = nil
       end
 
+      def determine_client(preferred_client = nil)
+        return preferred_client unless preferred_client.nil?
+        return default_client unless default_client.nil?
+        section_names.first unless section_names.empty?
+        nil
+      end
+
       private
 
       # If the prefix is in the client ID (identifier not alias) be +true+

data/lib/brightbox-cli/config/sections.rb

@@ -1,6 +1,63 @@
 module Brightbox
   module Config
     module Sections
+      #
+      # @param [String] config_alias The section name usually `email` but `email/suffix` allowed.
+      # @param [String] password
+      # @param [Hash] options
+      # @option options [String] :api_url
+      # @option options [String] :auth_url
+      # @option options [String] :default_account
+      # @option options [String] :client_id
+      # @option options [String] :secret
+      #
+      def add_login(config_alias, password, options = {})
+        # If a custom alias is passed, used that for the config header, otherwise use email
+        email = config_alias.split("/").first
+        config_section = config[config_alias]
+
+        info "Creating new client config #{config_alias}" if config_section.empty?
+
+        config_section["username"] = email unless config_section["username"]
+
+        config_section["api_url"] = options[:api_url] if options.key?(:api_url)
+        config_section["api_url"] = DEFAULT_API_ENDPOINT unless config_section["api_url"]
+
+        config_section["auth_url"] = options[:auth_url] if options.key?(:auth_url)
+        config_section["auth_url"] = config_section["api_url"]
+
+        config_section["default_account"] = options[:default_account] if options.key?(:default_account)
+
+        config_section["client_id"] = options[:client_id] if options.key?(:client_id)
+        config_section["secret"] = options[:secret] if options.key?(:secret)
+
+        dirty!
+
+        self.client_name = client_alias
+
+        # Renew tokens via config...
+        #
+        # Part of the "login" behaviour is to always refresh them
+        #
+        begin
+          flush_access_token!
+          renew_tokens(:client_name => config_alias, :password => password)
+        rescue => e
+          error "Something went wrong trying to refresh new tokens #{e.message}"
+        end
+
+        # Try to determine a default account
+        unless default_account == find_or_set_default_account
+          info "The default account of #{default_account} has been selected"
+        end
+
+        # If only client then set it as the default
+        set_default_client(client_alias) unless default_client
+
+        # Ensure all our config changes are now saved
+        save
+      end
+
       #
       # @param [String] client_alias
       # @param [String] client_id
@@ -12,26 +69,26 @@ module Brightbox
       # @option options [String] :auth_url
       #
       def add_section(client_alias, client_id, secret, options)
-        client_config = config[client_alias]
-        if client_config.empty?
+        config_section = config[client_alias]
+        if config_section.empty?
           info "Creating new client config #{client_alias}"
         else
           old_calias = client_alias
 
-          deduplicator = Brightbox::Config::SectionNameDeduplicator.new(client_alias, clients)
+          deduplicator = Brightbox::Config::SectionNameDeduplicator.new(client_alias, section_names)
           client_alias = deduplicator.next
           # Need to open the new config again
-          client_config = config[client_alias]
+          config_section = config[client_alias]
 
           info "A client config named #{old_calias} already exists using #{client_alias} instead"
         end
 
-        client_config["alias"] = client_alias
-        client_config["client_id"] = client_id
-        client_config["username"] = options[:username]
-        client_config["secret"] = secret
-        client_config["api_url"] = options[:api_url] || DEFAULT_API_ENDPOINT
-        client_config["auth_url"] = options[:auth_url] || client_config["api_url"]
+        config_section["alias"] = client_alias
+        config_section["client_id"] = client_id
+        config_section["username"] = options[:username]
+        config_section["secret"] = secret
+        config_section["api_url"] = options[:api_url] || DEFAULT_API_ENDPOINT
+        config_section["auth_url"] = options[:auth_url] || config_section["api_url"]
 
         dirty!
 
@@ -85,13 +142,13 @@ module Brightbox
         config[section_name]
       end
 
-      # Returns the clients in the config
+      # Returns the section names in the config
       #
       # @return [Array<String>]
       #
-      def clients
+      def section_names
         # Exclude the global "core" section
-        config.sections.select { |s| s != 'core' }
+        config.sections.reject { |s| %w(core alias).include?(s) }
       end
 
       private

data/lib/brightbox-cli/config/user_application.rb

@@ -3,7 +3,7 @@ module Brightbox
     class UserApplication
       # FIXME: api_url should use fog's underlying default
       #
-      NON_BLANK_KEYS = %w(api_url client_id secret username)
+      NON_BLANK_KEYS = %w(api_url username)
 
       attr_accessor :selected_config, :client_name
 
@@ -19,8 +19,8 @@ module Brightbox
           :provider => 'Brightbox',
           :brightbox_api_url => selected_config['api_url'],
           :brightbox_auth_url => selected_config['auth_url'] || selected_config['api_url'],
-          :brightbox_client_id => selected_config['client_id'],
-          :brightbox_secret => selected_config['secret'],
+          :brightbox_client_id => client_id,
+          :brightbox_secret => client_secret,
           :persistent => persistent?
         }
       end
@@ -55,6 +55,14 @@ module Brightbox
 
       private
 
+      def client_id
+        selected_config["client_id"] || Brightbox::EMBEDDED_APP_ID
+      end
+
+      def client_secret
+        selected_config["secret"] || Brightbox::EMBEDDED_APP_SECRET
+      end
+
       def persistent?
         if selected_config["persistent"] == "false"
           false
@@ -68,8 +76,8 @@ module Brightbox
           :provider => 'Brightbox',
           :brightbox_api_url => selected_config['api_url'],
           :brightbox_auth_url => selected_config['auth_url'] || selected_config['api_url'],
-          :brightbox_client_id => selected_config['client_id'],
-          :brightbox_secret => selected_config['secret'],
+          :brightbox_client_id => client_id,
+          :brightbox_secret => client_secret,
           :brightbox_username => selected_config["username"],
           :persistent => persistent?
         }