haveapi 0.14.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05bae78d58ccbb9544d69219d3b34f1db107fc16931cbf0714d652ab8efb05f8
-  data.tar.gz: db18c21a2d73446645d9eba73b8fec50f209a893733c45b69c7d89a33dc96e83
+  metadata.gz: 7d8c351c765bd18dc2ff8a33d5ad0e879e0e837e6c959435f24cd07168ac4d94
+  data.tar.gz: 3735e10f7f093a64715220405e4a8a69f769433d0ecd81e55fac048fdeb2e769
 SHA512:
-  metadata.gz: 69549de1aafe12d346343e1061c5c1513a56cb9d9b7f4f6452afb87d78764febb4a378805c69f55f9bd32db47e73b0b3680a4077bb055b295cc2b64db6935794
-  data.tar.gz: ed988016903b8d341118c42986e2786bd34609109dcbba31fde6097c9dd42e2370731503ee25498252cfe66b35dc0cd9360b67550e33830f7a33c3bf8d447676
+  metadata.gz: eef44b308fd207bed35e45cba52b2efc63c8f3404804d054fc91f276ddf2d9c648f2cb9f4b8063532e08e9938c28d9592176cec0e16c53c16ef4cbfaffd9e9d9
+  data.tar.gz: 5b8a1c07a524dbfd639eae3748cd8fa5603e72c0830f8330fd9682664152509e0fc32455a627f6a86ffa8e2da04d5046ad1220d3dda53836bd39eb3f46ce3c35

data/haveapi.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'github-markdown'
   s.add_runtime_dependency 'nesty', '~> 1.0'
-  s.add_runtime_dependency 'haveapi-client', '~> 0.14.2'
+  s.add_runtime_dependency 'haveapi-client', '~> 0.15.0'
   s.add_runtime_dependency 'mail'
 end

data/lib/haveapi/action.rb

@@ -464,11 +464,11 @@ module HaveAPI
     end
 
     protected
-    def with_restricted(*args)
-      if args.empty?
+    def with_restricted(**kwargs)
+      if kwargs.empty?
         @authorization.restrictions
       else
-        args.first.update(@authorization.restrictions)
+        kwargs.update(@authorization.restrictions)
       end
     end
 

data/lib/haveapi/authorization.rb

@@ -17,8 +17,8 @@ module HaveAPI
 
     # Apply restrictions on query which selects objects from database.
     # Most common usage is restrict user to access only objects he owns.
-    def restrict(*args)
-      @restrict << args.first
+    def restrict(**kwargs)
+      @restrict << kwargs
     end
 
     # Restrict parameters client can set/change.

data/lib/haveapi/hooks.rb

@@ -84,7 +84,8 @@ module HaveAPI
     # +opts+ is a hash and can have following keys:
     #   - desc - why this hook exists, when it's called
     #   - context - the context in which given blocks are called
-    #   - args - hash of block arguments
+    #   - args - hash of block positional arguments
+    #   - kwargs - hash of block keyword arguments
     #   - initial - hash of initial values
     #   - ret - hash of return values
     def self.register_hook(klass, name, opts = {})
@@ -138,6 +139,7 @@ module HaveAPI
     # @param name [Symbol] hook name
     # @param where [Class instance] class in whose context hooks are executed
     # @param args [Array] an array of arguments passed to hooks
+    # @param kwargs [Hash] an array of arguments passed to hooks
     # @param initial [Hash] initial return value
     # @param instance [Boolean] call instance hooks or not; nil means auto-detect
     def self.call_for(
@@ -145,6 +147,7 @@ module HaveAPI
         name,
         where = nil,
         args: [],
+        kwargs: {},
         initial: {},
         instance: nil
     )
@@ -165,10 +168,10 @@ module HaveAPI
 
         hooks.each do |hook|
           if where
-            ret = where.instance_exec(initial, *args, &hook)
+            ret = where.instance_exec(initial, *args, **kwargs, &hook)
 
           else
-            ret = hook.call(initial, *args)
+            ret = hook.call(initial, *args, **kwargs)
           end
 
           initial.update(ret) if ret
@@ -201,48 +204,46 @@ module HaveAPI
       end
 
       # Call all hooks for +name+. see Hooks.call_for.
-      def call_hooks(*args)
-        Hooks.call_for(self.to_s, *args)
+      def call_hooks(*args, **kwargs)
+        Hooks.call_for(self.to_s, *args, **kwargs)
       end
     end
 
     module InstanceMethods
       # Call all instance and class hooks.
-      def call_hooks_for(*args)
-        ret = call_instance_hooks_for(*args)
+      def call_hooks_for(*args, **kwargs)
+        ret = call_instance_hooks_for(*args, **kwargs)
 
-        if args.last.is_a?(::Hash)
-          args.last.update(initial: ret)
-          call_class_hooks_for(*args)
-        else
-          call_class_hooks_for(*args, initial: ret)
-        end
+        kwargs[:initial] = ret
+        call_class_hooks_for(*args, **kwargs)
       end
 
       # Call only instance hooks.
-      def call_instance_hooks_for(name, where = nil, args: [], initial: {})
-        Hooks.call_for(self, name, where, args: args, initial: initial)
+      def call_instance_hooks_for(name, where = nil, args: [], kwargs: {}, initial: {})
+        Hooks.call_for(self, name, where, args: args, kwargs: kwargs, initial: initial)
       end
 
       # Call only class hooks.
-      def call_class_hooks_for(name, where  = nil, args: [], initial: {})
-        Hooks.call_for(self.class, name, where, args: args, initial: initial)
+      def call_class_hooks_for(name, where  = nil, args: [], kwargs: {}, initial: {})
+        Hooks.call_for(self.class, name, where, args: args, kwargs: kwargs, initial: initial)
       end
 
       # Call hooks for different +klass+.
-      def call_hooks_as_for(klass, *args)
-        ret = call_instance_hooks_as_for(klass, *args)
-        call_class_hooks_as_for(klass.class, *args, initial: ret)
+      def call_hooks_as_for(klass, *args, **kwargs)
+        ret = call_instance_hooks_as_for(klass, *args, **kwargs)
+
+        kwargs[:initial] = ret
+        call_class_hooks_as_for(klass.class, *args, **kwargs)
       end
 
       # Call only instance hooks for different +klass+.
-      def call_instance_hooks_as_for(klass, *args)
-        Hooks.call_for(klass, *args)
+      def call_instance_hooks_as_for(klass, *args, **kwargs)
+        Hooks.call_for(klass, *args, **kwargs)
       end
 
       # Call only class hooks for different +klass+.
-      def call_class_hooks_as_for(klass, *args)
-        Hooks.call_for(klass, *args)
+      def call_class_hooks_as_for(klass, *args, **kwargs)
+        Hooks.call_for(klass, *args, **kwargs)
       end
 
       # Connect instance level hook +name+ to +block+.

data/lib/haveapi/params.rb

@@ -78,52 +78,47 @@ module HaveAPI
       @namespace = n.to_sym if n
     end
 
-    def requires(*args)
-      add_param(*apply(args, required: true))
+    def requires(name, **kwargs)
+      add_param(name, apply(kwargs, required: true))
     end
 
-    def optional(*args)
-      add_param(*apply(args, required: false))
+    def optional(name, **kwargs)
+      add_param(name, apply(kwargs, required: false))
     end
 
-    def string(*args)
-      add_param(*apply(args, type: String))
+    def string(name, **kwargs)
+      add_param(name, apply(kwargs, type: String))
     end
 
-    def text(*args)
-      add_param(*apply(args, type: Text))
+    def text(name, **kwargs)
+      add_param(name, apply(kwargs, type: Text))
     end
 
-    def password(*args)
-      add_param(*apply(args, type: String, protected: true))
+    def password(name, **kwargs)
+      add_param(name, apply(kwargs, type: String, protected: true))
     end
 
-    def id(*args)
-      integer(*args)
+    def bool(name, **kwargs)
+      add_param(name, apply(kwargs, type: Boolean))
     end
 
-    def foreign_key(*args)
-      integer(*args)
+    def integer(name, **kwargs)
+      add_param(name, apply(kwargs, type: Integer))
     end
 
-    def bool(*args)
-      add_param(*apply(args, type: Boolean))
-    end
-
-    def integer(*args)
-      add_param(*apply(args, type: Integer))
-    end
+    alias_method :id, :integer
+    alias_method :foreign_key, :integer
 
-    def float(*args)
-      add_param(*apply(args, type: Float))
+    def float(name, **kwargs)
+      add_param(name, apply(kwargs, type: Float))
     end
 
-    def datetime(*args)
-      add_param(*apply(args, type: Datetime))
+    def datetime(name, **kwargs)
+      add_param(name, apply(kwargs, type: Datetime))
     end
 
-    def param(*args)
-      add_param(*args)
+    def param(name, **kwargs)
+      add_param(name, kwargs)
     end
 
     def use(name, include: nil, exclude: nil)
@@ -153,20 +148,20 @@ module HaveAPI
       end
     end
 
-    def resource(*args)
-      add_resource(*args)
+    def resource(name, **kwargs)
+      add_resource(name, **kwargs)
     end
 
     alias_method :references, :resource
     alias_method :belongs_to, :resource
 
-    def patch(name, changes = {})
+    def patch(name, **changes)
       @params.detect { |p| p.name == name }.patch(changes)
     end
 
     # Action returns custom data.
-    def custom(*args, &block)
-      add_param(*apply(args, type: Custom, clean: block))
+    def custom(name, **kwargs, &block)
+      add_param(name, apply(kwargs, type: Custom, clean: block))
     end
 
     def describe(context)
@@ -274,8 +269,8 @@ module HaveAPI
     end
 
     private
-    def add_param(*args)
-      p = Parameters::Typed.new(*args)
+    def add_param(name, kwargs)
+      p = Parameters::Typed.new(name, kwargs)
 
       return if @include && !@include.include?(p.name)
       return if @exclude && @exclude.include?(p.name)
@@ -283,8 +278,8 @@ module HaveAPI
       @params << p unless param_exists?(p.name)
     end
 
-    def add_resource(*args)
-      r = Parameters::Resource.new(*args)
+    def add_resource(name, kwargs)
+      r = Parameters::Resource.new(name, kwargs)
 
       return if @include && !@include.include?(r.name)
       return if @exclude && @exclude.include?(r.name)
@@ -296,10 +291,9 @@ module HaveAPI
       !@params.detect { |p| p.name == name }.nil?
     end
 
-    def apply(args, default)
-      args << {} unless args.last.is_a?(Hash)
-      args.last.update(default)
-      args
+    def apply(kwargs, **default)
+      kwargs.update(default)
+      kwargs
     end
 
     def valid_layout?(params)

data/lib/haveapi/server.rb

@@ -40,7 +40,7 @@ module HaveAPI
         return @current_user if @current_user
 
         @current_user = settings.api_server.send(:do_authenticate, v, request)
-        settings.api_server.call_hooks_for(:post_authenticated, args: @current_user)
+        settings.api_server.call_hooks_for(:post_authenticated, args: [@current_user])
         @current_user
       end
 

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'
-  VERSION = '0.14.2'
+  VERSION = '0.15.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.15.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement