haveapi-client 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a51b4b1dc13506c4941f343464cb67afcc8e8e59650fe7e4005d18391919327
-  data.tar.gz: c967fc21c0eefeb9734676e0fac978e1a2aa63f576a51eb84821e459251d0e70
+  metadata.gz: d0ef69654a1ce04be90ccdc628dd976c3c6b09d91c24455cce5a1bb9df008185
+  data.tar.gz: fd976abf5adb0366bb573bbef70074977b61accb2d37013aec3a8a8c30e485da
 SHA512:
-  metadata.gz: 87362f19ad6dfc554b20ab02f221e90f8c5f5966cee35253a40f917e297f354372173d3ad8208f4d7e17bc49cf35603841e60aa15717108175469a1e6973ba43
-  data.tar.gz: d82c3bc8f894fbdff0e519274712548cd072be79869bd85efe6c6285033110b142af47267d0929fa00097d4b98b675a3b199fd5d8e7d46bca876f3ccd7c9b1cf
+  metadata.gz: 51e600c0543471f31308f0d8c60fc3e36ae51f048e94a851c0889604b0c22eb97b5880f940903f19aad575a7f6bb73a2ddb9ca6d0313916ce6154f372763907f
+  data.tar.gz: d37e9baf1f316e2f4d5ea0e03af7b98aa6b010fbdb256cc263bd53da60d43359a5ccb6546e318947f80e883fa3a4c7ccdb75d51988c1ffcc5b689447d9a65b1f

data/haveapi-client.gemspec

@@ -6,7 +6,6 @@ require 'haveapi/client/version'
 Gem::Specification.new do |spec|
   spec.name          = 'haveapi-client'
   spec.version       = HaveAPI::Client::VERSION
-  spec.date          = '2017-11-27'
   spec.authors       = ['Jakub Skokan']
   spec.email         = ['jakub.skokan@vpsfree.cz']
   spec.summary       =
@@ -19,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 
   spec.add_runtime_dependency 'activesupport', '>= 4.0'

data/lib/haveapi/cli/authentication/base.rb

@@ -12,9 +12,9 @@ module HaveAPI::CLI
         end
       end
 
-      attr_accessor :communicator
-
-      def initialize(opts = {})
+      def initialize(communicator, desc, opts = {})
+        @communicator = communicator
+        @desc = desc
         opts ||= {}
 
         opts.each do |k, v|
@@ -47,6 +47,9 @@ module HaveAPI::CLI
       def save
         @communicator.auth_save
       end
+
+      protected
+      attr_reader :communicator, :desc
     end
   end
-end
+end

data/lib/haveapi/cli/authentication/token.rb

@@ -1,16 +1,20 @@
 require 'haveapi/cli/authentication/base'
+require 'haveapi/cli/utils'
 
 module HaveAPI::CLI::Authentication
   class Token < Base
     register :token
 
+    include HaveAPI::CLI::Utils
+
     def options(opts)
-      opts.on('--username USER', 'User name') do |u|
-        @user = u
-      end
+      @credentials = {}
 
-      opts.on('--password PASSWORD', 'Password') do |p|
-        @password = p
+      request_credentials.each do |name, desc|
+        opts.on(
+          param_option(name, desc),
+          desc[:label] || name.to_s
+        ) { |v| @credentials[name] = v }
       end
 
       opts.on('--token TOKEN', 'Token') do |t|
@@ -44,31 +48,44 @@ module HaveAPI::CLI::Authentication
     def validate
       return if @token
 
-      @user ||= ask('User name: ') { |q| q.default = nil }
-
-      @password ||= ask('Password: ') do |q|
-        q.default = nil
-        q.echo = false
+      request_credentials.each do |name, desc|
+        if !@credentials.has_key?(name)
+          @credentials[name] = read_param(name, desc)
+        end
       end
     end
 
     def authenticate
-      @communicator.authenticate(:token, {
-          user: @user,
-          password: @password,
-          token: @token,
-          lifetime: @lifetime || :renewable_auto,
-          interval: @interval,
-          valid_to: @valid_to,
-          via: @via
-      })
+      opts = {
+        token: @token,
+        lifetime: @lifetime || :renewable_auto,
+        interval: @interval,
+        valid_to: @valid_to,
+        via: @via,
+      }
+
+      opts.update(@credentials) if @credentials
+
+      @communicator.authenticate(:token, opts) do |action, params|
+        ret = {}
+
+        params.each do |name, desc|
+          ret[name] = read_param(name, desc)
+        end
+
+        ret
+      end
     end
 
     def save
-      super.update({
-                       via: @via,
-                       interval: @interval
-                   })
+      super.update({via: @via, interval: @interval})
+    end
+
+    protected
+    def request_credentials
+      desc[:resources][:token][:actions][:request][:input][:parameters].reject do |name, _|
+        %i(lifetime interval).include?(name)
+      end
     end
   end
 end

data/lib/haveapi/cli/cli.rb

@@ -1,9 +1,9 @@
 require 'optparse'
 require 'pp'
-require 'highline/import'
 require 'yaml'
 require 'time'
 require 'date'
+require 'haveapi/cli/utils'
 
 module HaveAPI::CLI
   class Cli
@@ -29,12 +29,13 @@ module HaveAPI::CLI
       end
     end
 
+    include Utils
+
     def initialize
       @config = read_config || {}
       args, @opts = options
 
-      @api = HaveAPI::Client::Communicator.new(api_url, @opts[:version])
-      @api.identity = $0.split('/').last
+      connect_api unless @api
 
       if @action
         method(@action.first).call( * @action[1..-1] )
@@ -53,7 +54,7 @@ module HaveAPI::CLI
       if cmd = find_command(resources, args[1])
         authenticate if @auth
         c = cmd.new(@opts, HaveAPI::Client::Client.new(nil, communicator: @api))
-          
+
         cmd_opt = OptionParser.new do |opts|
           opts.banner = "\nCommand options:"
           c.options(opts)
@@ -64,13 +65,13 @@ module HaveAPI::CLI
             end
           end
         end
-        
+
         if @opts[:help]
           show_help do
             puts cmd_opt.help
           end
         end
-        
+
         if sep = ARGV.index('--')
           cmd_opt.parse!(ARGV[sep+1..-1])
         end
@@ -106,7 +107,7 @@ module HaveAPI::CLI
       @selected_params = @opts[:output] ? @opts[:output].split(',').uniq
                                         : nil
 
-      @input_params = parameters(action)      
+      @input_params = parameters(action)
 
       includes = build_includes(action) if @selected_params
       @input_params[:meta] = { includes: includes } if includes
@@ -174,7 +175,15 @@ module HaveAPI::CLI
 
         opts.on('-a', '--auth METHOD', Cli.auth_methods.keys, 'Authentication method') do |m|
           options[:auth] = m
-          @auth = Cli.auth_methods[m].new(server_config(options[:client])[:auth][m])
+          connect_api(url: options[:client], version: options[:version])
+
+          @auth = Cli.auth_methods[m].new(
+            @api,
+            @api.describe_api(options[:version])[:authentication][m],
+            server_config(options[:client])[:auth][m]
+          )
+
+          opts.separator "\nAuthentication options:"
           @auth.options(opts)
         end
 
@@ -217,7 +226,7 @@ module HaveAPI::CLI
         opts.on('-r', '--rows', 'Print output in rows') do
           options[:layout] = :rows
         end
-        
+
         opts.on('-s', '--sort PARAMETER', 'Sort output by parameter') do |p|
           options[:sort] = p
         end
@@ -225,7 +234,7 @@ module HaveAPI::CLI
         opts.on('--save', 'Save credentials to config file for later use') do
           options[:save] = true
         end
-        
+
         opts.on('--raw', 'Print raw response as is') do
           options[:raw] = true
         end
@@ -249,7 +258,7 @@ module HaveAPI::CLI
         opts.on('--[no-]block', 'Toggle action blocking mode') do |v|
           options[:block] = v
         end
-        
+
         opts.on(
             '--timeout SEC',
             Float,
@@ -265,11 +274,11 @@ module HaveAPI::CLI
         opts.on('--client-version', 'Show client version') do
           @action = [:show_version]
         end
-        
+
         opts.on('--protocol-version', 'Show protocol version') do
           @action = [:protocol_version]
         end
-        
+
         opts.on('--check-compatibility', 'Check compatibility with API server') do
           @action = [:check_compat]
         end
@@ -293,8 +302,15 @@ module HaveAPI::CLI
 
       unless options[:auth]
         cfg = server_config(options[:client])
+        connect_api(url: options[:client], version: options[:version]) unless @api
 
-        @auth = Cli.auth_methods[cfg[:last_auth]].new(cfg[:auth][cfg[:last_auth]]) if cfg[:last_auth]
+        if m = cfg[:last_auth]
+          @auth = Cli.auth_methods[m].new(
+            @api,
+            @api.describe_api(options[:version])[:authentication][m],
+            cfg[:auth][m],
+          )
+        end
       end
 
       [args, options]
@@ -356,29 +372,6 @@ module HaveAPI::CLI
       options
     end
 
-    def param_option(name, p)
-      ret = '--'
-      name = name.to_s.dasherize
-
-      if p[:type] == 'Boolean'
-        ret += "[no-]#{name}"
-
-      else
-        ret += "#{name} [#{name.underscore.upcase}]"
-      end
-
-      ret
-    end
-
-    def read_param(name, p)
-      prompt = "#{p[:label] || name}: "
-
-      ask(prompt) do |q|
-        q.default = nil
-        q.echo = !p[:protected]
-      end
-    end
-
     def list_versions
       desc = @api.available_versions
 
@@ -521,7 +514,7 @@ module HaveAPI::CLI
       end
 
       cols = []
-      
+
       (@selected_params || action.params.keys).each do |raw_name|
         col = {}
         name = nil
@@ -536,7 +529,7 @@ module HaveAPI::CLI
 
           parts.each do |part|
             fail "'#{part}' not found" unless top.has_key?(part)
-          
+
             if top[part][:type] == 'Resource'
               param = top[part]
               top = @api.get_action(top[part][:resource], :show, []).params
@@ -556,7 +549,7 @@ module HaveAPI::CLI
               break if top[part].nil?
               top = top[part]
             end
-          
+
             case param[:type]
             when 'Resource'
               "#{top[ param[:value_label].to_sym ]} (##{top[ param[:value_id].to_sym ]})"
@@ -570,12 +563,12 @@ module HaveAPI::CLI
           end
 
           col[:label] = raw_name
-          
+
         else # directly accessible parameter
           name = raw_name.to_sym
           param = action.params[name]
           fail "parameter '#{name}' does not exist" if param.nil?
-          
+
           if param[:type] == 'Resource'
             col[:display] = Proc.new do |r|
               next '' unless r
@@ -591,9 +584,9 @@ module HaveAPI::CLI
             name: name,
             align: %w(Integer Float).include?(param[:type]) ? 'right' : 'left',
         })
-        
+
         col[:label] ||= param[:label] && !param[:label].empty? ? param[:label] : name.upcase
-        
+
         cols << col
       end
 
@@ -618,7 +611,6 @@ module HaveAPI::CLI
 
     def authenticate(action = nil)
       if @auth
-        @auth.communicator = @api
         @auth.validate
         @auth.authenticate
 
@@ -669,6 +661,14 @@ module HaveAPI::CLI
       @config[:servers].last
     end
 
+    def connect_api(url: nil, version: nil)
+      @api = HaveAPI::Client::Communicator.new(
+        url || api_url,
+        version || (@opts && @opts[:version])
+      )
+      @api.identity = $0.split('/').last
+    end
+
     def format_errors(action, msg, errors)
       warn "Action failed: #{msg}"
 
@@ -701,7 +701,7 @@ module HaveAPI::CLI
     #   node.name => node
     def build_includes(action)
       ret = []
-      
+
       @selected_params.each do |param|
         next unless param.index('.')
 
@@ -710,8 +710,8 @@ module HaveAPI::CLI
 
         param.split('.').map! { |v| v.to_sym }.each do |part|
           next unless top.has_key?(part)
-          next if top[part][:type] != 'Resource' 
-         
+          next if top[part][:type] != 'Resource'
+
           includes << part
           top = @api.get_action(top[part][:resource], :show, []).params
         end

data/lib/haveapi/cli/utils.rb

@@ -0,0 +1,28 @@
+require 'highline/import'
+
+module HaveAPI::CLI
+  module Utils
+    def param_option(name, p)
+      ret = '--'
+      name = name.to_s.dasherize
+
+      if p[:type] == 'Boolean'
+        ret += "[no-]#{name}"
+
+      else
+        ret += "#{name} [#{name.underscore.upcase}]"
+      end
+
+      ret
+    end
+
+    def read_param(name, p)
+      prompt = "#{p[:label] || name}: "
+
+      ask(prompt) do |q|
+        q.default = nil
+        q.echo = !p[:protected]
+      end
+    end
+  end
+end

data/lib/haveapi/client/action.rb

@@ -14,10 +14,10 @@ module HaveAPI::Client
 
     def execute(data, *_)
       args = [self]
-      
+
       if input
         params = Params.new(self, data)
-        
+
         unless params.valid?
           raise ValidationError.new(self, params.errors)
         end
@@ -98,8 +98,8 @@ module HaveAPI::Client
       @spec[:meta][scope]
     end
 
-    def url
-      @spec[:url]
+    def path
+      @spec[:path]
     end
 
     def help
@@ -107,8 +107,8 @@ module HaveAPI::Client
     end
 
     # Url with resolved parameters.
-    def prepared_url
-      @prepared_url || @spec[:url]
+    def prepared_path
+      @prepared_path || @spec[:path]
     end
 
     def prepared_help
@@ -120,27 +120,27 @@ module HaveAPI::Client
     end
 
     def unresolved_args?
-      prepared_url =~ /:[a-zA-Z\-_]+/
+      prepared_path =~ /:[a-zA-Z\-_]+/
     end
 
     def provide_args(*args)
       apply_args(args)
     end
 
-    def provide_url(url, help)
-      @prepared_url = url
+    def provide_path(path, help)
+      @prepared_path = path
       @prepared_help = help
     end
 
     def reset
-      @prepared_url = nil
+      @prepared_path = nil
       @prepared_help = nil
     end
 
     def update_description(spec)
       @spec = spec
     end
-  
+
     # Block until the action is completed or timeout occurs. If the block is given,
     # it is regularly called with the action's state.
     # @param interval [Float] how often should the action state be checked
@@ -185,7 +185,7 @@ module HaveAPI::Client
           cancel_block = state.cancel_block
 
           ret = cancel(client, id)
-          
+
           if ret.is_a?(Response)
             # The cancel is not a blocking operation, return immediately
             raise ActionFailed, ret unless ret.ok?
@@ -203,7 +203,7 @@ module HaveAPI::Client
                 &cancel_block
             )
           end
-          
+
           return ret
         end
 
@@ -232,12 +232,12 @@ module HaveAPI::Client
 
     private
     def apply_args(args)
-      @prepared_url ||= @spec[:url].dup
+      @prepared_path ||= @spec[:path].dup
       @prepared_help ||= @spec[:help].dup
 
       args.each do |arg|
-        @prepared_url.sub!(/:[a-zA-Z\-_]+/, arg.to_s)
-        @prepared_help.sub!(/:[a-zA-Z\-_]+/, arg.to_s)
+        @prepared_path.sub!(/\{[a-zA-Z\-_]+\}/, arg.to_s)
+        @prepared_help.sub!(/\{[a-zA-Z\-_]+\}/, arg.to_s)
       end
     end
   end

data/lib/haveapi/client/authentication/base.rb

@@ -29,10 +29,11 @@ module HaveAPI::Client
         end
       end
 
-      def initialize(communicator, description, opts)
+      def initialize(communicator, description, opts, &block)
         @communicator = communicator
         @desc = description
         @opts = opts
+        @block = block
 
         setup
       end
@@ -48,7 +49,7 @@ module HaveAPI::Client
       end
 
       # Called for each request. Returns a hash of query parameters.
-      def request_url_params
+      def request_query_params
         {}
       end
 

data/lib/haveapi/client/authentication/token.rb

@@ -15,7 +15,7 @@ module HaveAPI::Client::Authentication
       @configured = true
     end
 
-    def request_url_params
+    def request_query_params
       return {} unless @configured
       check_validity
       @via == :query_param ? {@desc[:query_parameter] => @token} : {}
@@ -65,25 +65,50 @@ module HaveAPI::Client::Authentication
 
     protected
     def request_token
+      input = {
+        lifetime: @opts[:lifetime],
+        interval: @opts[:interval] || 300,
+      }
+      request_credentials.each { |name| input[name] = @opts[name] }
+
+      cont, next_action, token = login_step(:request, input)
+      return if cont == :done
+
+      if @block.nil?
+        raise AuthenticationFailed.new('implement multi-factor authentication')
+      end
+
+      loop do
+        input = {token: token}
+        input.update(@block.call(next_action, auth_action_input(next_action)))
+
+        cont, next_action, token = login_step(next_action, input)
+        return if cont == :done
+      end
+    end
+
+    def login_step(name, input)
       a = HaveAPI::Client::Action.new(
-          nil,
-          @communicator,
-          :request,
-          @desc[:resources][:token][:actions][:request],
-          []
+        nil,
+        @communicator,
+        name,
+        @desc[:resources][:token][:actions][name],
+        []
       )
-      ret = a.execute({
-                          login: @opts[:user],
-                          password: @opts[:password],
-                          lifetime: @opts[:lifetime],
-                          interval: @opts[:interval] || 300})
 
-      raise AuthenticationFailed.new('bad username or password') unless ret[:status]
+      resp = HaveAPI::Client::Response.new(a, a.execute(input))
 
-      @token = ret[:response][:token][:token]
+      if resp.failed?
+        raise AuthenticationFailed.new(resp.message || 'invalid credentials')
+      end
 
-      @valid_to = ret[:response][:token][:valid_to]
-      @valid_to = @valid_to && DateTime.iso8601(@valid_to).to_time
+      if resp[:complete]
+        @token = resp[:token]
+        @valid_to = resp[:valid_to] && DateTime.iso8601(resp[:valid_to]).to_time
+        :done
+      else
+        [:continue, resp[:next_action].to_sym, resp[:token]]
+      end
     end
 
     def check_validity
@@ -95,5 +120,17 @@ module HaveAPI::Client::Authentication
         end
       end
     end
+
+    def request_credentials
+      @desc[:resources][:token][:actions][:request][:input][:parameters].each_key.reject do |name|
+        %i(interval lifetime).include?(name)
+      end
+    end
+
+    def auth_action_input(name)
+      @desc[:resources][:token][:actions][name][:input][:parameters].reject do |k, _|
+        %i(token).include?(k)
+      end
+    end
   end
 end

data/lib/haveapi/client/client.rb

@@ -49,8 +49,8 @@ class HaveAPI::Client::Client
   end
 
   # See Communicator#authenticate.
-  def authenticate(*args)
-    @api.authenticate(*args)
+  def authenticate(*args, &block)
+    @api.authenticate(*args, &block)
   end
 
   # Get uthentication provider

data/lib/haveapi/client/communicator.rb

@@ -41,10 +41,15 @@ module HaveAPI::Client
     # Authenticate user with selected +auth_method+.
     # +auth_method+ is a name of registered authentication provider.
     # +options+ are specific for each authentication provider.
-    def authenticate(auth_method, options = {})
+    def authenticate(auth_method, options = {}, &block)
       desc = describe_api(@version)
 
-      @auth = self.class.auth_methods[auth_method].new(self, desc[:authentication][auth_method], options)
+      @auth = self.class.auth_methods[auth_method].new(
+        self,
+        desc[:authentication][auth_method],
+        options,
+        &block
+      )
       @rest = @auth.resource || @rest
     end
 
@@ -136,11 +141,11 @@ module HaveAPI::Client
 
         end if meta
 
-        args << {params: get_params.update(@auth.request_url_params), accept: :json, user_agent: @identity}.update(@auth.request_headers)
+        args << {params: get_params.update(@auth.request_query_params), accept: :json, user_agent: @identity}.update(@auth.request_headers)
       end
 
       begin
-        response = parse(@rest[action.prepared_url].method(action.http_method.downcase.to_sym).call(*args))
+        response = parse(@rest[action.prepared_path].method(action.http_method.downcase.to_sym).call(*args))
 
       rescue RestClient::Forbidden
         return error('Access forbidden. Bad user name or password? Not authorized?')
@@ -184,14 +189,14 @@ module HaveAPI::Client
 
     def description_for(path, query_params={})
       ret = parse(@rest[path].get_options({
-          params: @auth.request_payload.update(@auth.request_url_params).update(query_params),
+          params: @auth.request_payload.update(@auth.request_query_params).update(query_params),
           user_agent: @identity
       }.update(@auth.request_headers)))
-      
+
       @proto_version = ret[:version]
       p_v = HaveAPI::Client::PROTOCOL_VERSION
       return ret[:response] if ret[:version] == p_v
-      
+
       unless ret[:version]
         raise ProtocolError,
             "Incompatible protocol version: the client uses v#{p_v} "+

data/lib/haveapi/client/resource_instance.rb

@@ -23,13 +23,13 @@ module HaveAPI::Client
       if response
         if response.is_a?(Hash)
           @params = response
-          @prepared_args = response[:_meta][:url_params]
+          @prepared_args = response[:_meta][:path_params]
           @meta = response[:_meta] unless @meta
 
         else
           @response = response
           @params = response.response
-          @prepared_args = response.meta[:url_params]
+          @prepared_args = response.meta[:path_params]
           @meta = response.meta unless @meta
         end
 
@@ -81,14 +81,14 @@ module HaveAPI::Client
     def resolve
       return self if @resolved
 
-      @action.provide_args(*@meta[:url_params])
+      @action.provide_args(*@meta[:path_params])
       @response = Response.new(@action, @action.execute({}))
       @params = @response.response
 
       setup_from_clone(@resource)
       define_attributes
 
-      @prepared_args = @response.meta[:url_params]
+      @prepared_args = @response.meta[:path_params]
       @resolved = true
       self
     end
@@ -133,7 +133,7 @@ module HaveAPI::Client
                           resolved: false,
                           # TODO: this will not work for nested resources, as they have
                           # multiple IDs
-                          url_params: [id],
+                          path_params: [id],
                       },
                   }
               )

data/lib/haveapi/client/version.rb

@@ -1,6 +1,6 @@
 module HaveAPI
   module Client
-    PROTOCOL_VERSION = '1.2'
-    VERSION = '0.12.1'
+    PROTOCOL_VERSION = '2.0'
+    VERSION = '0.13.0'
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-client
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Jakub Skokan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +147,7 @@ files:
 - lib/haveapi/cli/commands/action_state_wait.rb
 - lib/haveapi/cli/example_formatter.rb
 - lib/haveapi/cli/output_formatter.rb
+- lib/haveapi/cli/utils.rb
 - lib/haveapi/client.rb
 - lib/haveapi/client/action.rb
 - lib/haveapi/client/action_state.rb