haveapi-client 0.14.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9bcb523f6bbbc83aed043d934bed405204f944da508ce27bbbc187789ad2592
-  data.tar.gz: 577821fa05de46f248506925c8d2b50a2da7a6d21dd16f463b0cb6d4873f4c5b
+  metadata.gz: d153eb905ee73a1f0764da87f536881490f9d590219269fca5f365c532d1d726
+  data.tar.gz: 970bc24468ff7dc99d77454bad8770006ef87f8fd91ecc910021833ac5c04e21
 SHA512:
-  metadata.gz: 9985388b53763b4ce873c02b113c9e3b3577ebf7328993acca91cdbdaee0025a865fb4b7feb65dd55b774c98c5f88d475a8c532c2c94b0d1dfccb72862ef0526
-  data.tar.gz: '0835beabb9c0212930238f502c4f2d2c314321dc1ba080c13e2bcd68261a05053ad74cdd4a9a29d2c4b3707b907610a9f4a517e5458d8ee2f77e5692ec2d0134'
+  metadata.gz: 74b9c5de5ad215533b1c1ceeed8044f19367eb06b18d67d9d9460901701e12525ec8c47d461d99cd593c8188c03c8598f7a72405d1de2818903fe35554d69af3
+  data.tar.gz: 1a907240d3323af2830b9b03586d7de2244e8bf695c6700905c8012dcaa107672aa4b65f0597abc35c03d3778d91e65f8a59660d9ebe5391e99fc01520b6b93f

data/lib/haveapi/cli/cli.rb

@@ -395,7 +395,7 @@ module HaveAPI::CLI
     def list_resources(v=nil)
       desc = @api.describe_api(v)
 
-      desc[:resources].each do |resource, children|
+      sort_by_key(desc[:resources]).each do |resource, children|
         nested_resource(resource, children, false)
       end
     end
@@ -403,7 +403,7 @@ module HaveAPI::CLI
     def list_actions(v=nil)
       desc = @api.describe_api(v)
 
-      desc[:resources].each do |resource, children|
+      sort_by_key(desc[:resources]).each do |resource, children|
         nested_resource(resource, children, true)
       end
     end
@@ -443,7 +443,7 @@ module HaveAPI::CLI
       unless desc[:resources].empty?
         puts 'Resources:'
 
-        desc[:resources].each_key do |r|
+        desc[:resources].keys.sort.each do |r|
           puts "  #{r}"
         end
       end
@@ -453,7 +453,7 @@ module HaveAPI::CLI
       unless desc[:actions].empty?
         puts 'Actions:'
 
-        desc[:actions].each_key do |a|
+        desc[:actions].keys.sort.each do |a|
           puts "  #{a}"
         end
       end
@@ -461,14 +461,14 @@ module HaveAPI::CLI
 
     def nested_resource(prefix, children, actions=false)
       if actions
-        children[:actions].each do |action, _|
+        children[:actions].keys.sort.each do |action|
           puts "#{prefix}##{action}"
         end
       else
         puts prefix
       end
 
-      children[:resources].each do |resource, children|
+      sort_by_key(children[:resources]).each do |resource, children|
         nested_resource("#{prefix}.#{resource}", children, actions)
       end
     end
@@ -743,5 +743,11 @@ module HaveAPI::CLI
 
       @opts[:date_format] ? ret.strftime(@opts[:date_format]) : ret
     end
+
+    def sort_by_key(hash)
+      hash.sort do |a, b|
+        a[0]<=> b[0]
+      end
+    end
   end
 end

data/lib/haveapi/client/action.rb

@@ -12,7 +12,7 @@ module HaveAPI::Client
       apply_args(args)
     end
 
-    def execute(data, *_)
+    def execute(data, raw: false)
       params_arg = {}
 
       if input
@@ -25,7 +25,7 @@ module HaveAPI::Client
         params_arg = params.to_api
       end
 
-      ret = @api.call(self, params_arg)
+      ret = @api.call(self, params_arg, raw: raw)
       reset
       ret
     end

data/lib/haveapi/client/client.rb

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

data/lib/haveapi/client/resource.rb

@@ -76,7 +76,7 @@ module HaveAPI::Client
       action.aliases(true).each do |name|
         next unless define_method?(action, name)
 
-        define_singleton_method(name) do |*args, &block|
+        define_singleton_method(name) do |*args, **kwargs, &block|
           client_opts = @client.opts(:block, :block_interval, :block_timeout)
           all_args = @prepared_args + args
 
@@ -89,28 +89,42 @@ module HaveAPI::Client
             end
 
             if action.unresolved_args?
-              raise ArgumentError.new('One or more object ids missing')
+              raise ArgumentError, 'one or more object ids missing'
             end
           end
 
-          if all_args.empty?
-            all_args << default_action_input_params(action)
+          if all_args.length > 1 || (kwargs.any? && all_args.any?)
+            raise ArgumentError, "too many arguments for action #{@name}##{action.name}"
+          end
+
+          arg = all_args.shift
 
-          elsif all_args.last.is_a?(Hash)
-            last = all_args.pop
+          user_params =
+            if kwargs.any? && arg
+              raise ArgumentError,
+                    'pass the input parameters either as a hash or keyword arguments'
+            elsif kwargs.any?
+              kwargs
+            elsif arg
+              arg
+            end
 
-            if last.has_key?(:meta)
-              meta = last[:meta]
+          if user_params.nil?
+            input_params = default_action_input_params(action)
+
+          else
+            if user_params.has_key?(:meta)
+              meta = user_params[:meta]
 
               %i(block block_interval block_timeout).each do |p|
                 client_opts[p] = meta.delete(p) if meta.has_key?(p)
               end
             end
 
-            all_args << default_action_input_params(action).update(last)
+            input_params = default_action_input_params(action).update(user_params)
           end
 
-          ret = Response.new(action, action.execute(*all_args))
+          ret = Response.new(action, action.execute(input_params))
 
           raise ActionFailed.new(ret) unless ret.ok?
 
@@ -137,8 +151,8 @@ module HaveAPI::Client
             }.each do |k, v|
               wait_opts[v] = client_opts[k] if client_opts.has_key?(k)
             end
-            
-            ret.wait_for_completion(wait_opts) do |state|
+
+            ret.wait_for_completion(**wait_opts) do |state|
               block.call(return_value, state) if block
             end
           end

data/lib/haveapi/client/response.rb

@@ -61,10 +61,10 @@ class HaveAPI::Client::Response
   # it is regularly called with the action's state.
   #
   # @see HaveAPI::Client::Action#wait_for_completion
-  def wait_for_completion(*args, &block)
+  def wait_for_completion(**kwargs, &block)
     id = meta[:action_state_id]
     return nil unless id
 
-    HaveAPI::Client::Action.wait_for_completion(@action.client, id, *args, &block)
+    HaveAPI::Client::Action.wait_for_completion(@action.client, id, **kwargs, &block)
   end
 end

data/lib/haveapi/client/version.rb

@@ -1,6 +1,6 @@
 module HaveAPI
   module Client
     PROTOCOL_VERSION = '2.0'
-    VERSION = '0.14.2'
+    VERSION = '0.16.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-client
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Jakub Skokan