haveapi 0.20.0 → 0.21.0

data/lib/haveapi/client_examples/php_client.rb

@@ -7,77 +7,77 @@ module HaveAPI::ClientExamples
     order 20
 
     def init
-      <<END
-$api = new \\HaveAPI\\Client("#{base_url}", "#{version}");
-END
+      <<~END
+        $api = new \\HaveAPI\\Client("#{base_url}", "#{version}");
+      END
     end
 
     def auth(method, desc)
       case method
       when :basic
-        <<END
-#{init}
+        <<~END
+          #{init}
 
-$api->authenticate("basic", ["user" => "user", "password" => "secret"]);
-END
+          $api->authenticate("basic", ["user" => "user", "password" => "secret"]);
+        END
 
       when :token
-        <<END
-#{init}
+        <<~END
+          #{init}
 
-// Get token using username and password
-$api->authenticate("token", [#{auth_token_credentials(desc).map { |k, v| "\"#{k}\" => \"#{v}\"" }.join(', ')}]);
+          // Get token using username and password
+          $api->authenticate("token", [#{auth_token_credentials(desc).map { |k, v| "\"#{k}\" => \"#{v}\"" }.join(', ')}]);
 
-echo "Token = ".$api->getAuthenticationProvider()->getToken();
+          echo "Token = ".$api->getAuthenticationProvider()->getToken();
 
-// Next time, the client can authenticate using the token directly
-$api->authenticate("token", ["token" => $savedToken]);
-END
+          // Next time, the client can authenticate using the token directly
+          $api->authenticate("token", ["token" => $savedToken]);
+        END
 
       when :oauth2
-        <<END
-// OAuth2 requires session
-session_start();
-
-// Client instance
-#{init}
-// Check if we already have an access token
-if (isset($_SESSION["access_token"])) {
-  // We're already authenticated, reuse the existing access token
-  $api->authenticate("oauth2", ["access_token" => $_SESSION["access_token"]]);
-
-} else {
-  // Follow the OAuth2 authorization process to get an access token using
-  // authorization code
-  $api->authenticate("oauth2", [
-    // Client id and secret are given by the API server
-    "client_id" => "your client id",
-    "client_secret" => "your client secret",
-
-    // This example code should run on the URL below
-    "redirect_uri" => "https://your-client.tld/oauth2-callback",
-
-    // Scopes are specific to the API implementation
-    "scope" => "all",
-  ]);
-
-  $provider = $api->getAuthenticationProvider();
-
-  // We don't have authorization code yet, request one
-  if (!isset($_GET['code'])) {
-    // Redirect the user to the authorization endpoint
-    $provider->requestAuthorizationCode();
-    exit;
-
-  } else {
-    // Request access token using the token endpoint
-    $provider->requestAccessToken();
-
-    // Store the access token in the session
-    $_SESSION['access_token'] = $provider->jsonSerialize();
-  }
-}
-END
+        <<~END
+          // OAuth2 requires session
+          session_start();
+
+          // Client instance
+          #{init}
+          // Check if we already have an access token
+          if (isset($_SESSION["access_token"])) {
+            // We're already authenticated, reuse the existing access token
+            $api->authenticate("oauth2", ["access_token" => $_SESSION["access_token"]]);
+
+          } else {
+            // Follow the OAuth2 authorization process to get an access token using
+            // authorization code
+            $api->authenticate("oauth2", [
+              // Client id and secret are given by the API server
+              "client_id" => "your client id",
+              "client_secret" => "your client secret",
+
+              // This example code should run on the URL below
+              "redirect_uri" => "https://your-client.tld/oauth2-callback",
+
+              // Scopes are specific to the API implementation
+              "scope" => "all",
+            ]);
+
+            $provider = $api->getAuthenticationProvider();
+
+            // We don't have authorization code yet, request one
+            if (!isset($_GET['code'])) {
+              // Redirect the user to the authorization endpoint
+              $provider->requestAuthorizationCode();
+              exit;
+
+            } else {
+              // Request access token using the token endpoint
+              $provider->requestAccessToken();
+
+              // Store the access token in the session
+              $_SESSION['access_token'] = $provider->jsonSerialize();
+            }
+          }
+        END
       end
     end
 
@@ -96,7 +96,7 @@ END
 
       return (out << response(sample)) if sample[:status]
 
-      out << "// Throws exception \\HaveAPI\\Client\\Exception\\ActionFailed"
+      out << '// Throws exception \\HaveAPI\\Client\\Exception\\ActionFailed'
       out
     end
 
@@ -107,7 +107,7 @@ END
       when :hash
         out << "// $reply is an instance of \\HaveAPI\\Client\\Response\n"
         out << "// $reply->getResponse() returns an associative array of output parameters:\n"
-        out << format_parameters(:output, sample[:response] || {}, "// ")
+        out << format_parameters(:output, sample[:response] || {}, '// ')
 
       when :hash_list
         out << "// $reply is an instance of \\HaveAPI\\Client\\Response\n"
@@ -116,31 +116,31 @@ 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'
-            out << "// $reply->#{k} is a custom type"
+            out << "// $reply->#{pn} is a custom type"
 
           else
-            out << "// $reply->#{k} = #{PP.pp(v, '')}"
+            out << "// $reply->#{pn} = #{PP.pp(pv, '')}"
           end
         end
 
       when :object_list
-        out << "// $reply is an instance of \\HaveAPI\\Client\\ResourceInstanceList"
+        out << '// $reply is an instance of \\HaveAPI\\Client\\ResourceInstanceList'
       end
 
       out
@@ -150,12 +150,12 @@ END
       ret = []
 
       params.each do |k, v|
-        if action[dir][:parameters][k][:type] == 'Custom'
-          ret << "#{prefix}  \"#{k}\" => custom type}"
+        ret << if action[dir][:parameters][k][:type] == 'Custom'
+                 "#{prefix}  \"#{k}\" => custom type}"
 
-        else
-          ret << "#{prefix}  \"#{k}\" => #{value(v)}"
-        end
+               else
+                 "#{prefix}  \"#{k}\" => #{value(v)}"
+               end
       end
 
       "#{prefix}[\n#{ret.join(",\n")}\n#{prefix}]"
@@ -163,6 +163,7 @@ END
 
     def value(v)
       return v if v.is_a?(::Numeric) || v === true || v === false
+
       "\"#{v}\""
     end
   end

data/lib/haveapi/client_examples/ruby_cli.rb

@@ -1,5 +1,5 @@
 module HaveAPI
-  module CLI ; end
+  module CLI; end
 end
 
 require 'haveapi/cli/output_formatter'
@@ -18,28 +18,28 @@ module HaveAPI::ClientExamples
     def auth(method, desc)
       case method
       when :basic
-        <<END
-# Provide credentials on command line
-#{init} --auth basic --user user --password secret
+        <<~END
+          # Provide credentials on command line
+          #{init} --auth basic --user user --password secret
 
-# If username or password isn't provided, the user is asked on stdin
-#{init} --auth basic --user user
-Password: secret
-END
+          # If username or password isn't provided, the user is asked on stdin
+          #{init} --auth basic --user user
+          Password: secret
+        END
 
       when :token
-        <<END
-# Get token using username and password and save it to disk
-# Note that the client always has to call some action. APIs should provide
-# an action to get information about the current user, so that's what we're
-# calling now.
-#{init} --auth token #{auth_token_credentials(desc, password: false).map { |k, v| "--#{k} #{v}" }.join(' ')} --save user current
-Password: secret
-
-# Now the token is read from disk and the user does not have to provide username
-# nor password and be authenticated
-#{init} user current
-END
+        <<~END
+          # Get token using username and password and save it to disk
+          # Note that the client always has to call some action. APIs should provide
+          # an action to get information about the current user, so that's what we're
+          # calling now.
+          #{init} --auth token #{auth_token_credentials(desc, password: false).map { |k, v| "--#{k} #{v}" }.join(' ')} --save user current
+          Password: secret
+
+          # Now the token is read from disk and the user does not have to provide username
+          # nor password and be authenticated
+          #{init} user current
+        END
 
       when :oauth2
         '# OAuth2 is not supported by HaveAPI Ruby CLI.'
@@ -56,7 +56,7 @@ END
         cmd << "-- \\\n"
 
         res = cmd.join(' ') + sample[:request].map do |k, v|
-          ' '*14 + input_param(k, v)
+          (' ' * 14) + input_param(k, v)
         end.join(" \\\n")
 
       else
@@ -84,32 +84,32 @@ END
 
       action[:output][:parameters].each do |name, param|
         col = {
-            name: name,
-            align: %w(Integer Float).include?(param[:type]) ? 'right' : 'left',
-            label: param[:label] && !param[:label].empty? ? param[:label] : name.upcase,
+            name:,
+            align: %w[Integer Float].include?(param[:type]) ? 'right' : 'left',
+            label: param[:label] && !param[:label].empty? ? param[:label] : name.upcase
         }
 
         if param[:type] == 'Resource'
-          col[:display] = Proc.new do |r|
+          col[:display] = proc do |r|
             next '' unless r
             next r unless r.is_a?(::Hash)
 
-            "#{r[ param[:value_label].to_sym ]} (##{r[ param[:value_id].to_sym ]})"
+            "#{r[param[:value_label].to_sym]} (##{r[param[:value_id].to_sym]})"
           end
         end
 
         cols << col
       end
 
-      res << "\n" << HaveAPI::CLI::OutputFormatter.format(
-          sample[:response],
-          cols
+      res << "\n" << HaveAPI::CLI::OutputFormatter.to_s(
+        sample[:response],
+        cols
       )
       res
     end
 
     def input_param(name, value)
-      option = name.to_s.gsub(/_/, '-')
+      option = name.to_s.gsub('_', '-')
 
       if action[:input][:parameters][name][:type] == 'Boolean'
         return value ? "--#{option}" : "--no-#{name}"

data/lib/haveapi/client_examples/ruby_client.rb

@@ -8,34 +8,34 @@ module HaveAPI::ClientExamples
     order 0
 
     def init
-      <<END
-require 'haveapi-client'
+      <<~END
+        require 'haveapi-client'
 
-client = HaveAPI::Client.new("#{base_url}", version: "#{version}")
-END
+        client = HaveAPI::Client.new("#{base_url}", version: "#{version}")
+      END
     end
 
     def auth(method, desc)
       case method
       when :basic
-        <<END
-#{init}
+        <<~END
+          #{init}
 
-client.authenticate(:basic, user: "user", password: "secret")
-END
+          client.authenticate(:basic, user: "user", password: "secret")
+        END
 
       when :token
-        <<END
-#{init}
+        <<~END
+          #{init}
 
-# Get token using username and password
-client.authenticate(:token, #{auth_token_credentials(desc).map { |k, v| "#{k}: \"#{v}\"" }.join(', ')})
+          # Get token using username and password
+          client.authenticate(:token, #{auth_token_credentials(desc).map { |k, v| "#{k}: \"#{v}\"" }.join(', ')})
 
-puts "Token = \#{client.auth.token}"
+          puts "Token = \#{client.auth.token}"
 
-# Next time, the client can authenticate using the token directly
-client.authenticate(:token, token: saved_token)
-END
+          # Next time, the client can authenticate using the token directly
+          client.authenticate(:token, token: saved_token)
+        END
 
       when :oauth2
         '# OAuth2 is not supported by HaveAPI Ruby client.'
@@ -58,7 +58,7 @@ END
       return (out << response(sample)) if sample[:status]
 
       out << "\n"
-      out << "# Raises exception HaveAPI::Client::ActionFailed"
+      out << '# Raises exception HaveAPI::Client::ActionFailed'
       out
     end
 
@@ -79,29 +79,29 @@ END
       when :object
         out << "# reply is an instance of HaveAPI::Client::ResourceInstance\n"
 
-        (sample[:response] || {}).each do |k, v|
+        (sample[:response] || {}).each do |pn, pv|
           param = action[:output][:parameters][k]
 
           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"
 
           else
-            out << "# reply.#{k} = #{PP.pp(v, '')}"
+            out << "# reply.#{pn} = #{PP.pp(pv, '')}"
           end
         end
 
       when :object_list
         out << "# reply is an instance of HaveAPI::Client::ResourceInstanceList,\n"
-        out << "# which is a subclass of Array"
+        out << '# which is a subclass of Array'
       end
 
       out

data/lib/haveapi/common.rb

@@ -3,13 +3,13 @@ module HaveAPI
     class << self
       attr_accessor :custom_attrs
 
-      def has_attr(name, default=nil)
+      def has_attr(name, default = nil)
         @custom_attrs ||= []
         @custom_attrs << name
 
         instance_variable_set("@#{name}", default)
 
-        self.class.send(:define_method, name) do |value=nil|
+        self.class.send(:define_method, name) do |value = nil|
           if value.nil?
             instance_variable_get("@#{name}")
           else
@@ -34,8 +34,7 @@ module HaveAPI
 
       def check_build(msg)
         yield
-      
-      rescue => e
+      rescue StandardError => e
         raise BuildError.new(msg, e)
       end
     end

data/lib/haveapi/context.rb

@@ -5,8 +5,8 @@ module HaveAPI
                   :action_instance, :action_prepare, :layout
 
     def initialize(server, version: nil, request: nil, resource: [], action: nil,
-                  path: nil, args: nil, params: nil, user: nil,
-                  authorization: nil, endpoint: nil, resource_path: [])
+                   path: nil, args: nil, params: nil, user: nil,
+                   authorization: nil, endpoint: nil, resource_path: [])
       @server = server
       @version = version
       @request = request
@@ -33,7 +33,7 @@ module HaveAPI
       ret
     end
 
-    def path_for(action, args=nil)
+    def path_for(action, args = nil)
       top_module = Kernel
       top_route = @server.routes[@version]
 
@@ -42,16 +42,15 @@ module HaveAPI
 
         begin
           top_module.obj_type
-
         rescue NoMethodError
           next
         end
 
-        if top_module.obj_type == :resource
-          top_route = top_route[:resources][top_module]
-        else
-          top_route = top_route[:actions][top_module]
-        end
+        top_route = if top_module.obj_type == :resource
+                      top_route[:resources][top_module]
+                    else
+                      top_route[:actions][top_module]
+                    end
       end
 
       ret = top_route.dup
@@ -65,6 +64,7 @@ module HaveAPI
       ret = params && action.resolve_path_params(obj)
 
       return [ret] if ret && !ret.is_a?(Array)
+
       ret
     end
 
@@ -87,10 +87,11 @@ module HaveAPI
     end
 
     def action_scope
-      resource_path.map(&:downcase).join('.') + '#' + action.action_name.underscore
+      "#{resource_path.map(&:downcase).join('.')}##{action.action_name.underscore}"
     end
 
     private
+
     def resolve_arg!(path, arg)
       path.sub!(/\{[a-zA-Z\-_]+\}/, arg.to_s)
     end

data/lib/haveapi/example.rb

@@ -50,9 +50,13 @@ module HaveAPI
     end
 
     def provided?
-      instance_variables.detect do |v|
+      if instance_variables.detect do |v|
         instance_variable_get(v)
-      end ? true : false
+      end
+        true
+      else
+        false
+      end
     end
 
     def describe(context)
@@ -66,7 +70,7 @@ module HaveAPI
           status: @status.nil? ? true : @status,
           message: @message,
           errors: @errors,
-          http_status: @http_status || 200,
+          http_status: @http_status || 200
         }
       else
         {}
@@ -74,12 +78,13 @@ module HaveAPI
     end
 
     protected
+
     def filter_input_params(context, input)
       case context.action.input.layout
       when :object, :hash
         context.authorization.filter_input(
           context.action.input.params,
-          ModelAdapters::Hash.output(context, input),
+          ModelAdapters::Hash.output(context, input)
         )
 
       when :object_list, :hash_list

data/lib/haveapi/example_list.rb

@@ -19,8 +19,8 @@ module HaveAPI
       ret
     end
 
-    def each(&block)
-      @examples.each(&block)
+    def each(&)
+      @examples.each(&)
     end
 
     include Enumerable

data/lib/haveapi/exceptions.rb

@@ -5,5 +5,5 @@ module HaveAPI
     include Nesty::NestedError
   end
 
-  class AuthenticationError < StandardError ; end
+  class AuthenticationError < StandardError; end
 end

data/lib/haveapi/extensions/action_exceptions.rb

@@ -4,7 +4,7 @@ module HaveAPI::Extensions
   class ActionExceptions < Base
     class << self
       def enabled(server)
-        HaveAPI::Action.connect_hook(:exec_exception) do |ret, context, e|
+        HaveAPI::Action.connect_hook(:exec_exception) do |ret, _context, e|
           break(ret) unless @exceptions
 
           @exceptions.each do |handler|
@@ -20,7 +20,7 @@ module HaveAPI::Extensions
 
       def rescue(klass, &block)
         @exceptions ||= []
-        @exceptions << {klass: klass, block: block}
+        @exceptions << { klass:, block: }
       end
     end
   end

data/lib/haveapi/extensions/base.rb

@@ -1,9 +1,7 @@
 module HaveAPI
   module Extensions
     class Base
-      def self.enabled(server)
-
-      end
+      def self.enabled(server); end
     end
   end
 end