haveapi 0.20.0 → 0.21.0

data/lib/haveapi/authorization.rb

@@ -33,8 +33,8 @@ module HaveAPI
     # @param blacklist [Array<Symbol>] allow all parameters except listed ones
     def input(whitelist: nil, blacklist: nil)
       @input = {
-        whitelist: whitelist,
-        blacklist: blacklist,
+        whitelist:,
+        blacklist:
       }
     end
 
@@ -43,8 +43,8 @@ module HaveAPI
     # @param blacklist [Array<Symbol>] allow all parameters except listed ones
     def output(whitelist: nil, blacklist: nil)
       @output = {
-        whitelist: whitelist,
-        blacklist: blacklist,
+        whitelist:,
+        blacklist:
       }
     end
 
@@ -75,6 +75,7 @@ module HaveAPI
     end
 
     private
+
     def filter_inner(allowed_params, direction, params, format)
       allowed = {}
 

data/lib/haveapi/client_example.rb

@@ -1,5 +1,5 @@
 module HaveAPI
-  module ClientExamples ; end
+  module ClientExamples; end
 
   # All client example classes should inherit this class. Depending on the client,
   # the subclass may choose to implement either method `example` or `request` and
@@ -39,13 +39,13 @@ module HaveAPI
       end
 
       # Shortcut to {ClientExample#init}
-      def init(*args)
-        new(*args).init
+      def init(*)
+        new(*).init
       end
 
       # Shortcut to {ClientExample#auth}
       def auth(*args)
-        new(*args[0..-3]).auth(*args[-2..-1])
+        new(*args[0..-3]).auth(*args[-2..])
       end
 
       # Shortcut to {ClientExample#example}
@@ -68,30 +68,27 @@ module HaveAPI
       @resource_path, @resource, @action_name, @action = args
     end
 
-    def init
+    def init; end
 
-    end
-
-    def auth(method, desc)
-
-    end
+    def auth(method, desc); end
 
     def version_url
       File.join(base_url, "v#{version}", '/')
     end
 
     protected
+
     # @param password [Boolean] include password parameter
     # @return [Hash<String, String>] parameter => example value
     def auth_token_credentials(desc, password: true)
-      passwords = %i(password pass passwd)
-      params = desc[:resources][:token][:actions]['request'][:input][:parameters].keys - %i(lifetime interval)
+      passwords = %i[password pass passwd]
+      params = desc[:resources][:token][:actions]['request'][:input][:parameters].keys - %i[lifetime interval]
 
       unless password
         params.reject! { |param| passwords.include?(param) }
       end
 
-      Hash[params.map do |param|
+      params.to_h do |param|
         value =
           if passwords.include?(param)
             'secret'
@@ -100,7 +97,7 @@ module HaveAPI
           end
 
         [param, value]
-      end]
+      end
     end
   end
 end

data/lib/haveapi/client_examples/curl.rb

@@ -14,34 +14,34 @@ module HaveAPI::ClientExamples
     def auth(method, desc)
       case method
       when :basic
-        <<END
-# Password is asked on standard input
-$ curl --request OPTIONS \\
-       --user username \\
-       '#{base_url}'
-Password: secret
+        <<~END
+          # Password is asked on standard input
+          $ curl --request OPTIONS \\
+                 --user username \\
+                 '#{base_url}'
+          Password: secret
 
-# Password given on the command line
-$ curl --request OPTIONS \\
-       --user username:secret \\
-       '#{base_url}'
-END
+          # Password given on the command line
+          $ curl --request OPTIONS \\
+                 --user username:secret \\
+                 '#{base_url}'
+        END
 
       when :token
         login = auth_token_credentials(desc).merge(lifetime: 'fixed')
 
-        <<END
-# Acquire the token
-$ curl --request POST \\
-       --header 'Content-Type: application/json' \\
-       --data-binary "#{format_data(token: login)}" \\
-       '#{File.join(base_url, '_auth', 'token', 'tokens')}'
+        <<~END
+          # Acquire the token
+          $ curl --request POST \\
+                 --header 'Content-Type: application/json' \\
+                 --data-binary "#{format_data(token: login)}" \\
+                 '#{File.join(base_url, '_auth', 'token', 'tokens')}'
 
-# Use a previously acquired token
-$ curl --request OPTIONS \\
-       --header '#{desc[:http_header]}: thetoken' \\
-       '#{base_url}'
-END
+          # Use a previously acquired token
+          $ curl --request OPTIONS \\
+                 --header '#{desc[:http_header]}: thetoken' \\
+                 '#{base_url}'
+        END
 
       when :oauth2
         '# See RFC 6749 for authorization process and RFC 6750 for access token usage.'
@@ -50,32 +50,32 @@ END
 
     def request(sample)
       url = File.join(
-          base_url,
-          resolve_path(
-              action[:method],
-              action[:path],
-              sample[:path_params] || [],
-              sample[:request]
-          )
+        base_url,
+        resolve_path(
+          action[:method],
+          action[:path],
+          sample[:path_params] || [],
+          sample[:request]
+        )
       )
 
       data = format_data({
-          action[:input][:namespace] => sample[:request],
+          action[:input][:namespace] => sample[:request]
       })
 
-      <<END
-$ curl --request #{action[:method]} \\
-       --data-binary "#{data}" \\
-       '#{url}'
-END
+      <<~END
+        $ curl --request #{action[:method]} \\
+               --data-binary "#{data}" \\
+               '#{url}'
+      END
     end
 
     def response(sample)
       JSON.pretty_generate({
           status: sample[:status],
           message: sample[:message],
-          response: {action[:output][:namespace] => sample[:response]},
-          errors: sample[:errors],
+          response: { action[:output][:namespace] => sample[:response] },
+          errors: sample[:errors]
       })
     end
 

data/lib/haveapi/client_examples/fs_client.rb

@@ -13,27 +13,27 @@ module HaveAPI::ClientExamples
     def auth(method, desc)
       case method
       when :basic
-        <<END
-# Provide credentials as file system options
-#{init} -o auth_method=basic,user=myuser,password=secret
+        <<~END
+          # Provide credentials as file system options
+          #{init} -o auth_method=basic,user=myuser,password=secret
 
-# If username or password isn't provided, the user is asked on stdin
-#{init} -o auth_method=basic,user=myuser
-Password: secret
-END
+          # If username or password isn't provided, the user is asked on stdin
+          #{init} -o auth_method=basic,user=myuser
+          Password: secret
+        END
 
       when :token
-        <<END
-# Authenticate using username and password
-#{init} -o auth_method=token,user=myuser
-Password: secret
+        <<~END
+          # Authenticate using username and password
+          #{init} -o auth_method=token,user=myuser
+          Password: secret
 
-# If you have generated a token, you can use it
-#{init} -o auth_method=token,token=yourtoken
+          # If you have generated a token, you can use it
+          #{init} -o auth_method=token,token=yourtoken
 
-# Note that the file system can read config file from haveapi-client, so if
-# you set up authentication there, the file system will use it.
-END
+          # Note that the file system can read config file from haveapi-client, so if
+          # you set up authentication there, the file system will use it.
+        END
 
       when :oauth2
         '# OAuth2 is not supported by haveapi-fs.'
@@ -47,9 +47,7 @@ END
 
       unless class_action?
         if !sample[:path_params] || sample[:path_params].empty?
-          fail "example {#{sample}} of action #{resource_path.join('.')}"+
-               ".#{action_name} is for an instance action but does not include "+
-               "URL parameters"
+          raise "example {#{sample}} of action #{resource_path.join('.')}.#{action_name} is for an instance action but does not include URL parameters"
         end
 
         path << sample[:path_params].first.to_s
@@ -69,29 +67,29 @@ END
       end
 
       cmd << "\n# Execute the action"
-      cmd << "$ echo 1 > exec"
+      cmd << '$ echo 1 > exec'
 
       cmd << "\n# Query the action's result"
-      cmd << "$ cat status"
+      cmd << '$ cat status'
       cmd << (sample[:status] ? '1' : '0')
 
       if sample[:status]
         if sample[:response] && !sample[:response].empty? \
-           && %i(hash object).include?(action[:output][:layout])
+           && %i[hash object].include?(action[:output][:layout])
           cmd << "\n# Query the output parameters"
 
           sample[:response].each do |k, v|
             cmd << "$ cat output/#{k}"
 
-            if v === true
-              cmd << '1'
+            cmd << if v === true
+                     '1'
 
-            elsif v === false
-              cmd << '0'
+                   elsif v === false
+                     '0'
 
-            else
-              cmd << "#{v.to_s}"
-            end
+                   else
+                     v.to_s
+                   end
 
             cmd << "\n"
           end
@@ -99,11 +97,11 @@ END
 
       else
         cmd << "\n# Get the error message"
-        cmd << "$ cat message"
+        cmd << '$ cat message'
         cmd << sample[:message]
 
         cmd << "\n# Parameter errors can be seen in the `errors` directory"
-        cmd << "$ ls errors"
+        cmd << '$ ls errors'
         cmd << (sample[:errors] || {}).keys.join("\n")
       end
 

data/lib/haveapi/client_examples/http.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require 'cgi'
 require 'rack/utils'
 require 'haveapi/client_example'
@@ -10,61 +9,61 @@ module HaveAPI::ClientExamples
     order 100
 
     def init
-      <<END
-OPTIONS /v#{version}/ HTTP/1.1
-Host: #{host}
+      <<~END
+        OPTIONS /v#{version}/ HTTP/1.1
+        Host: #{host}
 
-END
+      END
     end
 
     def auth(method, desc)
       case method
       when :basic
-        <<END
-GET / HTTP/1.1
-Host: #{host}
-Authorization: Basic dXNlcjpzZWNyZXQ=
+        <<~END
+          GET / HTTP/1.1
+          Host: #{host}
+          Authorization: Basic dXNlcjpzZWNyZXQ=
 
-END
+        END
 
       when :token
         login = auth_token_credentials(desc).merge(lifetime: 'fixed')
 
-        <<END
-POST /_auth/token/tokens HTTP/1.1
-Host: #{host}
-Content-Type: application/json
+        <<~END
+          POST /_auth/token/tokens HTTP/1.1
+          Host: #{host}
+          Content-Type: application/json
 
-#{JSON.pretty_generate({token: login})}
-END
+          #{JSON.pretty_generate({ token: login })}
+        END
 
       when :oauth2
-        <<END
-# 1) Request authorization code
-GET #{desc[:authorize_path]}?response_type=code&client_id=$client_id&state=$state&redirect_uri=$client_redirect_uri HTTP/1.1
-Host: #{host}
+        <<~END
+          # 1) Request authorization code
+          GET #{desc[:authorize_path]}?response_type=code&client_id=$client_id&state=$state&redirect_uri=$client_redirect_uri HTTP/1.1
+          Host: #{host}
 
-# 2) The user logs in using this API
+          # 2) The user logs in using this API
 
-# 3) The API then redirects the user back to the client application
-GET $client_redirect_uri?code=$authorization_code&state=$state
-Host: client-application
+          # 3) The API then redirects the user back to the client application
+          GET $client_redirect_uri?code=$authorization_code&state=$state
+          Host: client-application
 
-# 4) The client application requests access token
-POST #{desc[:token_path]}
-Content-Type: application/x-www-form-urlencoded
+          # 4) The client application requests access token
+          POST #{desc[:token_path]}
+          Content-Type: application/x-www-form-urlencoded
 
-grant_type=authorization_code&code=$authorization_code&redirect_uri=$client_redirect_uri&client_id=$client_id&client_secret=$client_secret
-END
+          grant_type=authorization_code&code=$authorization_code&redirect_uri=$client_redirect_uri&client_id=$client_id&client_secret=$client_secret
+        END
       end
     end
 
     def request(sample)
       path = resolve_path(
-          action[:method],
-          action[:path],
-          sample[:path_params] || [],
-          sample[:request]
+        action[:method],
+        action[:path],
+        sample[:path_params] || [],
+        sample[:request]
       )
 
       req = "#{action[:method]} #{path} HTTP/1.1\n"
@@ -72,7 +71,7 @@ END
       req << "Content-Type: application/json\n\n"
 
       if action[:method] != 'GET' && sample[:request] && !sample[:request].empty?
-        req << JSON.pretty_generate({action[:input][:namespace] => sample[:request]})
+        req << JSON.pretty_generate({ action[:input][:namespace] => sample[:request] })
       end
 
       req
@@ -82,8 +81,8 @@ END
       content = JSON.pretty_generate({
           status: sample[:status],
           message: sample[:message],
-          response: {action[:output][:namespace] => sample[:response]},
-          errors: sample[:errors],
+          response: { action[:output][:namespace] => sample[:response] },
+          errors: sample[:errors]
       })
 
       status_msg = Rack::Utils::HTTP_STATUS_CODES[sample[:http_status]]

data/lib/haveapi/client_examples/js_client.rb

@@ -7,61 +7,61 @@ module HaveAPI::ClientExamples
     order 10
 
     def init
-      <<END
-import HaveAPI from 'haveapi-client'
+      <<~END
+        import HaveAPI from 'haveapi-client'
 
-var api = new HaveAPI.Client("#{base_url}", {version: "#{version}"});
-END
+        var api = new HaveAPI.Client("#{base_url}", {version: "#{version}"});
+      END
     end
 
     def auth(method, desc)
       case method
       when :basic
-        <<END
-#{init}
+        <<~END
+          #{init}
 
-api.authenticate("basic", {
-  user: "user",
-  password: "secret"
-}, function (client, status) {
-  console.log("Authenticated?", status);
-});
-END
+          api.authenticate("basic", {
+            user: "user",
+            password: "secret"
+          }, function (client, status) {
+            console.log("Authenticated?", status);
+          });
+        END
 
       when :token
-        <<END
-#{init}
-
-// Request a new token
-api.authenticate("token", {
-  #{auth_token_credentials(desc).map { |k, v| "#{k}: \"#{v}\"" }.join(",\n  ")}
-}, function (client, status) {
-  console.log("Authenticated?", status);
-
-  if (status)
-    console.log("Token is", client.authProvider.token);
-});
-
-// Use an existing token
-api.authenticate("token", {
-  token: "qwertyuiop..."
-}, function (client, status) {
-  console.log("Authenticated?", status);
-});
-END
+        <<~END
+          #{init}
+
+          // Request a new token
+          api.authenticate("token", {
+            #{auth_token_credentials(desc).map { |k, v| "#{k}: \"#{v}\"" }.join(",\n  ")}
+          }, function (client, status) {
+            console.log("Authenticated?", status);
+
+            if (status)
+              console.log("Token is", client.authProvider.token);
+          });
+
+          // Use an existing token
+          api.authenticate("token", {
+            token: "qwertyuiop..."
+          }, function (client, status) {
+            console.log("Authenticated?", status);
+          });
+        END
 
       when :oauth2
-        <<END
-#{init}
-// The JavaScript client must be configured with OAuth2 access token, it does not
-// support the authorization procedure to obtain a new access token.
-var accessToken = {
-  access_token: "the access token"
-};
-
-// The client is authenticated immediately, no need for a callback
-api.authenticate("oauth2", {access_token: accessToken});
-END
+        <<~END
+          #{init}
+          // The JavaScript client must be configured with OAuth2 access token, it does not
+          // support the authorization procedure to obtain a new access token.
+          var accessToken = {
+            access_token: "the access token"
+          };
+
+          // The client is authenticated immediately, no need for a callback
+          api.authenticate("oauth2", {access_token: accessToken});
+        END
       end
     end
 
@@ -82,14 +82,14 @@ END
       callback = "function (client, reply) {\n"
       callback << "  console.log('Response', reply);\n"
 
-      if sample[:status]
-        callback << response(sample)
+      callback << if sample[:status]
+                    response(sample)
 
-      else
-        callback << error(sample)
-      end
+                  else
+                    error(sample)
+                  end
 
-      callback << "}"
+      callback << '}'
 
       out << callback.strip
       out << ');'
@@ -117,30 +117,30 @@ END
       when :object
         out << "  // reply is an instance of HaveAPI.Client.ResourceInstance\n"
 
-        (sample[:response] || {}).each do |k, v|
-          param = action[:output][:parameters][k]
+        (sample[:response] || {}).each do |pn, pv|
+          param = action[:output][:parameters][pn]
 
           if param[:type] == 'Resource'
-            out << "  // reply.#{k} = HaveAPI.Client.ResourceInstance("
+            out << "  // reply.#{pn} = HaveAPI.Client.ResourceInstance("
             out << "resource: #{param[:resource].join('.')}, "
 
-            if v.is_a?(::Hash)
-              out << v.map { |k,v| "#{k}: #{PP.pp(v, '').strip}" }.join(', ')
-            else
-              out << "id: #{v}"
-            end
+            out << if pv.is_a?(::Hash)
+                     pv.map { |k, v| "#{k}: #{PP.pp(v, '').strip}" }.join(', ')
+                   else
+                     "id: #{pv}"
+                   end
 
             out << ")\n"
 
-          elsif param[:type] == 'Custom' && (v.is_a?(::Hash) || v.is_a?(::Array))
-            json = JSON.pretty_generate(v).split("\n").map do |v|
+          elsif param[:type] == 'Custom' && (pv.is_a?(::Hash) || pv.is_a?(::Array))
+            json = JSON.pretty_generate(pv).split("\n").map do |v|
               "  // #{v}"
             end.join("\n")
 
-            out << "  // reply.#{k} = #{json}"
+            out << "  // reply.#{pn} = #{json}"
 
           else
-            out << "  // reply.#{k} = #{PP.pp(v, '')}"
+            out << "  // reply.#{pn} = #{PP.pp(pv, '')}"
           end
         end
 
@@ -149,7 +149,6 @@ END
       end
 
       out
-
     end
 
     def error(sample)