haveapi 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 321e49887ffa5dc763ebc2eb535ee04c5776fc5bcec813feadc0444da1736d9c
-  data.tar.gz: e8b1045190e92e6bf38843c3c96be69d66b48490ace40655c3e31721169ce4d4
+  metadata.gz: 6c66cdf4f10a5d8d65b70c4d934cd4ab98b96d89fd5af283cdd1d0cd21cbb4b8
+  data.tar.gz: d3beeb71e1da7049735864c44e76abdd512fe22fbec0df056d10f2f0ad9dc409
 SHA512:
-  metadata.gz: 2231a352ccd0e78268b164aa70613fa369462bc9bcaf2bc0fef51d088107c38c78bd43bf26fa01815afadb9ebc9af3c8cd7deae057c80b0b92ad15d75ca8e423
-  data.tar.gz: f736a80afa224ae0c0d687472ad2754660f877a26a3c02b111101d3004c1875c7c3d6927682ee582aef587f98f269a976b33920c738868a516e264b3a66fa4a3
+  metadata.gz: a139c2b9bfc85f476a77c8e113d8e9d769dc505261028d807a4804dc108e1dee07dfa65f54220988b28bc78d4893fde0cbad37fee9e0eae01d697a3c58719b88
+  data.tar.gz: 18525da72a705a5bd8f955b5597f87035bde722fe3520abd2db09e6fac9066cb01eafffb39dbc1f480504568b60852388144e4245861a3d2d2590ba69f7eb790

data/haveapi.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'activesupport', '>= 7.1'
   s.add_runtime_dependency 'github-markdown'
-  s.add_runtime_dependency 'haveapi-client', '~> 0.22.0'
+  s.add_runtime_dependency 'haveapi-client', '~> 0.23.0'
   s.add_runtime_dependency 'json'
   s.add_runtime_dependency 'mail'
   s.add_runtime_dependency 'nesty', '~> 1.0'

data/lib/haveapi/client_examples/php_client.rb

@@ -147,15 +147,12 @@ module HaveAPI::ClientExamples
     end
 
     def format_parameters(dir, params, prefix = '')
-      ret = []
-
-      params.each do |k, v|
-        ret << if action[dir][:parameters][k][:type] == 'Custom'
-                 "#{prefix}  \"#{k}\" => custom type}"
-
-               else
-                 "#{prefix}  \"#{k}\" => #{value(v)}"
-               end
+      ret = params.map do |k, v|
+        if action[dir][:parameters][k][:type] == 'Custom'
+          "#{prefix}  \"#{k}\" => custom type}"
+        else
+          "#{prefix}  \"#{k}\" => #{value(v)}"
+        end
       end
 
       "#{prefix}[\n#{ret.join(",\n")}\n#{prefix}]"

data/lib/haveapi/client_examples/ruby_client.rb

@@ -80,7 +80,7 @@ module HaveAPI::ClientExamples
         out << "# reply is an instance of HaveAPI::Client::ResourceInstance\n"
 
         (sample[:response] || {}).each do |pn, pv|
-          param = action[:output][:parameters][k]
+          param = action[:output][:parameters][pn]
 
           if param[:type] == 'Resource'
             out << "# reply.#{pn} = HaveAPI::Client::ResourceInstance("

data/lib/haveapi/resource.rb

@@ -116,7 +116,7 @@ module HaveAPI
       cls
     end
 
-    def self.define_action(name, superclass: Action, &block)
+    def self.define_action(name, superclass: Action, &)
       return false if const_defined?(name)
 
       cls = Class.new(superclass)
@@ -124,7 +124,7 @@ module HaveAPI
       cls.resource = self
       cls.action_name = name
       superclass.delayed_inherited(cls)
-      cls.class_exec(&block)
+      cls.class_exec(&)
     end
   end
 end

data/lib/haveapi/resources/action_state.rb

@@ -61,7 +61,6 @@ module HaveAPI::Resources
       authorize { allow }
 
       def exec
-        ret = []
         actions = @context.server.action_state.list_pending(
           current_user,
           input[:offset],
@@ -69,11 +68,9 @@ module HaveAPI::Resources
           input[:order].to_sym
         )
 
-        actions.each do |state|
-          ret << state_to_hash(state)
+        actions.map do |state|
+          state_to_hash(state)
         end
-
-        ret
       end
     end
 

data/lib/haveapi/server.rb

@@ -11,6 +11,20 @@ module HaveAPI
 
     include Hookable
 
+    has_hook :pre_mount,
+             desc: 'Called before API actions are mounted in sinatra',
+             args: {
+               server: 'HaveAPI::Server',
+               sinatra: 'Sinatra::Base'
+             }
+
+    has_hook :post_mount,
+             desc: 'Called after API actions are mounted in sinatra',
+             args: {
+               server: 'HaveAPI::Server',
+               sinatra: 'Sinatra::Base'
+             }
+
     # Called after the user was authenticated (or not). The block is passed
     # current user object or nil as an argument.
     has_hook :post_authenticated,
@@ -339,12 +353,16 @@ module HaveAPI
 
       @extensions.each { |e| e.enabled(self) }
 
+      call_hooks_for(:pre_mount, args: [self, @sinatra])
+
       # Mount default version first
       mount_version(@root, @default_version)
 
       @versions.each do |v|
         mount_version(version_prefix(v), v)
       end
+
+      call_hooks_for(:post_mount, args: [self, @sinatra])
     end
 
     def mount_version(prefix, v)

data/lib/haveapi/spec/mock_action.rb

@@ -8,7 +8,7 @@ module HaveAPI::Spec
       @v = v
     end
 
-    def call(input, user: nil, &block)
+    def call(input, user: nil, &)
       action = @action.new(nil, @v, input, nil, HaveAPI::Context.new(
                                                   @server,
                                                   version: @v,
@@ -26,7 +26,7 @@ module HaveAPI::Spec
       status, data, errors = action.safe_exec
       raise(data || 'action failed') unless status
 
-      action.instance_exec(@test, &block)
+      action.instance_exec(@test, &)
       data
     end
   end

data/lib/haveapi/spec/spec_methods.rb

@@ -74,12 +74,12 @@ module HaveAPI::Spec
     # @param version [any] API version, if not specified, the default version is used
     # @param user [any] object representing authenticated user
     # @yield [self] the block is executed in the action instance
-    def mock_action(r_name, a_name, params, version: nil, user: nil, &block)
+    def mock_action(r_name, a_name, params, version: nil, user: nil, &)
       app
       v = version || @api.default_version
       action, path = find_action(v, r_name, a_name)
       m = MockAction.new(self, @api, action, path, v)
-      m.call(params, user:, &block)
+      m.call(params, user:, &)
     end
 
     # Return parsed API response.

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'.freeze
-  VERSION = '0.22.0'.freeze
+  VERSION = '0.23.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -204,13 +204,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- doc/Hooks.md
-- doc/create-client.md
 - doc/hooks.erb
 - doc/index.md
-- doc/json-schema.html
-- doc/protocol.md
-- doc/protocol.png
 - haveapi.gemspec
 - lib/haveapi.rb
 - lib/haveapi/action.rb

data/doc/Hooks.md

@@ -1,81 +0,0 @@
-
-# Hooks
-
-##HaveAPI::Server
-	
-### post_authenticated
-<table>
-	<tr>
-		<td style="vertical-align: top;">Description:</td>
-		<td>Called after the user was authenticated</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Context:</td>
-		<td>current</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Arguments:</td>
-		<td><dl><dt>current_user</dt><dd>object returned by the authentication backend</dd></dl></td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Initial value:</td>
-		<td>none</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Return value:</td>
-		<td>none</td>
-	</tr>
-</table>
-	
-### description_exception
-<table>
-	<tr>
-		<td style="vertical-align: top;">Description:</td>
-		<td>Called when an exception occurs when building self-description</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Context:</td>
-		<td>current</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Arguments:</td>
-		<td><dl><dt>context</dt><dd>HaveAPI::Context</dd><dt>exception</dt><dd>exception instance</dd></dl></td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Initial value:</td>
-		<td>none</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Return value:</td>
-		<td><dl><dt>http_status</dt><dd>HTTP status code to send to client</dd><dt>message</dt><dd>error message sent to the client</dd></dl></td>
-	</tr>
-</table>
-	
-
-##HaveAPI::Action
-	
-### exec_exception
-<table>
-	<tr>
-		<td style="vertical-align: top;">Description:</td>
-		<td>Called when unhandled exceptions occurs during Action.exec</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Context:</td>
-		<td>current</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Arguments:</td>
-		<td><dl><dt>action</dt><dd>HaveAPI::Action instance</dd><dt>exception</dt><dd>exception instance</dd></dl></td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Initial value:</td>
-		<td>none</td>
-	</tr>
-	<tr>
-		<td style="vertical-align: top;">Return value:</td>
-		<td><dl><dt>status</dt><dd>true or false, indicating whether error should be reported</dd><dt>message</dt><dd>error message sent to the user</dd></dl></td>
-	</tr>
-</table>
-	
-

data/doc/create-client.md

@@ -1,107 +0,0 @@
-# Client definition
-It is necessary to differentiate between clients for HaveAPI based APIs
-and clients to work with your API instance. This document describes
-the former. If you only want to use your API, you should check a list
-of available clients and pick the one in the right language. Only when
-there isn't a client already available in the language you want, then
-continue reading.
-
-# Design rules
-The client must completely depend on the API description:
-
- - it has no assumptions and API-specific code,
- - it does not know any resources, actions and parameters,
- - everything the client knows must be found out from the API description.
-
-All clients should use a similar paradigm, so that it is possible to use
-clients in different languages in the same way, as far as the language syntax
-allows. Clients bundled with HaveAPI may serve as a model. A client should
-use all the advantages and coding styles of the language it is written
-in (e.g. use objects in object oriented languages).
-
-A model paradigm (in no particular language):
-
-    // Create client instance
-    api = new HaveAPI.Client("https://your.api.tld")
-
-    // Authenticate
-    api.authenticate("basic", {"user": "yourname", "password": "yourpassword"})
-
-    // Access resources and actions
-    api.<resource>.<action>( { <parameters> } )
-    api.user.new({"name": "Very Name", "password": "donottellanyone"})
-    api.user.list()
-    api.nested.resource.deep.list()
-
-    // Pass IDs to resources
-    api.nested(1).resource(2).deep.list()
-
-    // Object-like access
-    user = api.user.show(1)
-    user.id
-    user.name
-    user.destroy()
-
-    // Logout
-    api.logout()
-
-# Necessary features to implement
-A client should implement all of the listed features in order to be useful.
-
-## Resource tree
-The client gives access to all listed resources and their actions.
-
-In scripting languages, resources and actions are usually defined as dynamic
-properties/objects/methods, depending on the language.
-
-## Input/output parameters
-Allow sending input parameters and accessing the response.
-
-## Input/output formats
-A client must send appropriate HTTP header `Accept`. As only JSON is by now built-in
-in HaveAPI, it should send `application/json`.
-
-## Authentication
-All authentication methods that are built-in the HaveAPI should be supported
-if possible. The client should choose suitable authentication method
-for its purpose and allow the developer to select the authentication method
-if it makes sense to do so.
-
-It is a good practise to implement authentication methods as plugins,
-so that developers may add custom authentication providers easily.
-
-## Object-like access
-A client must interpret the API response according to action output layout.
-Layouts `object` and `object_list` should be handled as object instances,
-if the language allows it.
-
-Object instances represent the object fetched from the database. Received
-parameters are accessed via object attributes/properties. Actions are defined
-as instance methods. Objects may have associations to other resources which
-must be made available and be easy to access.
-
-# Supplemental features
-Following features are supplemental. It is good to support them,
-but is not necessary.
-
-## Client-side validations
-Client may make use of described validators and validate the input before
-sending it to the API, to lessen the API load and make it more user-friendly.
-
-However, as the input is validated on the server anyway, it does not have
-to be implemented.
-
-## Metadata channel
-Metadata channel is currently used to specify what associated resources should
-be prefetched and whether an object list should contain total number of items.
-
-Metadata is nothing more than a hash in input parameters under key `_meta`.
-
-## Blocking actions
-Useful for APIs with long-running actions. Clients can check state of such actions
-using resource `ActionState`. Because this resource is automatically present in all
-APIs that use blocking actions, client libraries expose this resource to the developer
-just as any other resource in the API.
-
-However, you may wish to integrate it in your client and provide ways for the action
-call to block/accept callbacks.