sp-job 0.2.3 → 0.3.22

data/lib/sp/job/curl_http_client.rb

@@ -0,0 +1,100 @@
+#
+# Copyright (c) 2011-2016 Cloudware S.A. All rights reserved.
+#
+# This file is part of sp-job.
+#
+# sp-job is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sp-job is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with sp-job.  If not, see <http://www.gnu.org/licenses/>.
+#
+# encoding: utf-8
+#
+
+#
+# A helper class to do HTTP request without session management.
+#
+
+require 'curb'
+require_relative 'easy_http_client'
+require_relative 'jsonapi_error'
+
+module SP
+  module Job
+    class CurlHTTPClient < EasyHttpClient
+      def self.post(url:, headers:, body:, expect:, conn_options: {})
+        # since we're not auto-renew tokens, we can use a simple CURL request
+        conn_options[:connection_timeout] ||= 10
+        conn_options[:request_timeout] ||= 60
+        r = Curl::Easy.http_post(url, body) do |handle|
+          handle.connect_timeout = conn_options[:connection_timeout]
+          handle.timeout = conn_options[:request_timeout]
+          headers.each do |k,v|
+            handle.headers[k] = v
+          end
+        end
+        nr = self.normalize_response(curb_r: r)
+        # compare status code
+        if nr[:code] != expect[:code]
+          if 401 == nr[:code]
+            raise ::SP::Job::JSONAPI::Error.new(status: nr[:code], code: 'A01', detail: nil)
+          else
+            raise ::SP::Job::JSONAPI::Error.new(status: nr[:code], code: 'B01', detail: nil)
+          end
+        end
+        # compare content-type
+        if nr[:content][:type] != expect[:content][:type]
+          raise ::SP::Job::JSONAPI::Error.new(status: 500, code: 'I01', detail: "Unexpected 'Content-Type': #{nr[:content][:type]}, expected #{expect[:content][:type]}!")
+        end
+        # done
+        nr
+      end
+
+      def self.get(url:)
+        response = Curl::Easy.http_get(url)
+        self.normalize_response(curb_r: response)
+      end
+
+      def self.delete(url:, headers:)
+        response = Curl::Easy.http_delete(url, headers)
+        self.normalize_response(curb_r: response)
+      end
+
+      private
+
+      def self.normalize_response(curb_r:)
+        http_response, *http_headers = curb_r.header_str.split(/[\r\n]+/).map(&:strip)
+        o = {
+          code: curb_r.response_code,
+          body: curb_r.body,
+          description: http_reason(code: curb_r.response_code),
+          content: {
+            type: nil,
+            length: 0
+          }
+         }
+        http_headers.each do |header|
+          m = header.match("(^Content-Type){1}:\s(.*){1}")
+          if nil != m && 3 == m.length
+            o[:content][:type] = m[2]
+          end
+          m = header.match("(^Content-Length){1}:\s\([0-9]+){1}")
+          if nil != m && 3 == m.length
+            o[:content][:length] = m[2]
+          end
+        end
+        o
+      end
+
+
+    end
+  end
+end

data/lib/sp/job/easy_http_client.rb

@@ -0,0 +1,94 @@
+#
+# Copyright (c) 2011-2016 Cloudware S.A. All rights reserved.
+#
+# This file is part of sp-job.
+#
+# sp-job is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sp-job is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with sp-job.  If not, see <http://www.gnu.org/licenses/>.
+#
+# encoding: utf-8
+#
+
+module SP
+  module Job
+    class EasyHttpClient
+      @@REASONS = {
+        100 => 'Continue',
+        101 => 'Switching Protocols',
+        102 => 'Processing',
+        200 => 'OK',
+        201 => 'Created',
+        202 => 'Accepted',
+        203 => 'Non-Authoritative Information',
+        204 => 'No Content',
+        205 => 'Reset Content',
+        206 => 'Partial Content',
+        207 => 'Multi-Status',
+        226 => 'IM Used',
+        300 => 'Multiple Choices',
+        301 => 'Moved Permanently',
+        302 => 'Found',
+        303 => 'See Other',
+        304 => 'Not Modified',
+        305 => 'Use Proxy',
+        306 => 'Reserved',
+        307 => 'Temporary Redirect',
+        308 => 'Permanent Redirect',
+        400 => 'Bad Request',
+        401 => 'Unauthorized',
+        402 => 'Payment Required',
+        403 => 'Forbidden',
+        404 => 'Not Found',
+        405 => 'Method Not Allowed',
+        406 => 'Not Acceptable',
+        407 => 'Proxy Authentication Required',
+        408 => 'Request Timeout',
+        409 => 'Conflict',
+        410 => 'Gone',
+        411 => 'Length Required',
+        412 => 'Precondition Failed',
+        413 => 'Request Entity Too Large',
+        414 => 'Request-URI Too Long',
+        415 => 'Unsupported Media Type',
+        416 => 'Requested Range Not Satisfiable',
+        417 => 'Expectation Failed',
+        418 => "I'm a Teapot",
+        422 => 'Unprocessable Entity',
+        423 => 'Locked',
+        424 => 'Failed Dependency',
+        426 => 'Upgrade Required',
+        500 => 'Internal Server Error',
+        501 => 'Not Implemented',
+        502 => 'Bad Gateway',
+        503 => 'Service Unavailable',
+        504 => 'Gateway Timeout',
+        505 => 'HTTP Version Not Supported',
+        506 => 'Variant Also Negotiates',
+        507 => 'Insufficient Storage',
+        510 => 'Not Extended'
+      }
+
+      def self.http_reason(code:)
+        return @@REASONS[code]
+      end
+
+      def self.post(url:, headers:, body:, expect:)
+        raise NotImplementedError
+      end
+
+      def self.get(url:)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/sp/job/http_client.rb

@@ -0,0 +1,51 @@
+#
+# Copyright (c) 2011-2016 Cloudware S.A. All rights reserved.
+#
+# This file is part of sp-job.
+#
+# sp-job is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sp-job is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with sp-job.  If not, see <http://www.gnu.org/licenses/>.
+#
+# encoding: utf-8
+#
+
+#
+# A helper class to do HTTP request without session management.
+#
+
+require_relative 'curl_http_client'      unless RUBY_ENGINE == 'jruby'
+require_relative 'manticore_http_client' if RUBY_ENGINE == 'jruby'
+
+module SP
+  module Job
+    class HttpClient < EasyHttpClient
+
+      def self.get_klass
+        RUBY_ENGINE == 'jruby' ? ManticoreHTTPClient : CurlHTTPClient
+      end
+
+      def self.post(url:, headers:, body:, expect:, conn_options: {})
+        get_klass.post(url: url, headers: headers, body: body, expect: expect, conn_options: conn_options)
+      end
+
+      def self.get(url:)
+        get_klass.get(url: url)
+      end
+
+      def self.delete(url:, headers:)
+        get_klass.delete(url: url, headers: headers)
+      end
+
+    end
+  end
+end

data/lib/sp/job/job_db_adapter.rb

@@ -1,60 +1,62 @@
 module SP
   module Job
 
-    unless RUBY_ENGINE == 'jruby'  # TODO suck in the base class from SP-DUH
-
-      class JobDbAdapter < ::SP::Duh::JSONAPI::Adapters::Db
+    if RUBY_ENGINE == 'jruby'  # TODO suck in the base class from SP-DUH
+      class JobDbAdapter < ::SP::JSONAPI::Adapters::Db
 
         private
 
           # Implement the JSONAPI request by direct querying of the JSONAPI function in the database
           def do_request_on_the_db(method, path, params)
-            jsonapi_query = %Q[ SELECT * FROM public.jsonapi($1, $2, $3, $4, $5, $6, $7, $8, $9) ]
+            jsonapi_query = %Q[ SELECT * FROM public.jsonapi('%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s') ]
 
-            response = service.connection.exec jsonapi_query, method, (method == 'GET' ? url_with_params_for_query(path, params) : url(path)), (method == 'GET' ? '' : params_for_body(params)), user_id, company_id, company_schema, sharded_schema, accounting_schema, accounting_prefix
+            response = service.connection.exec jsonapi_query, method, (method == 'GET' ? url_with_params_for_query(path, params) : url(path)), (method == 'GET' ? '' : params_for_body(params)), user_id, entity_id, entity_schema, sharded_schema, subentity_schema, subentity_prefix
             response.first if response.first
           end
 
-          def explicit_do_request_on_the_db(exp_accounting_schema, exp_accounting_prefix, method, path, params)
-            jsonapi_query = %Q[ SELECT * FROM public.jsonapi($1, $2, $3, $4, $5, $6, $7, $8, $9) ]
+          def explicit_do_request_on_the_db(exp_subentity_schema, exp_subentity_prefix, method, path, params)
+            jsonapi_query = %Q[ SELECT * FROM public.jsonapi('%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s') ]
 
-            response = service.connection.exec jsonapi_query, method, (method == 'GET' ? url_with_params_for_query(path, params) : url(path)), (method == 'GET' ? '' : params_for_body(params)), user_id, company_id, company_schema, sharded_schema, exp_accounting_schema, exp_accounting_prefix
+            response = service.connection.exec jsonapi_query, method, (method == 'GET' ? url_with_params_for_query(path, params) : url(path)), (method == 'GET' ? '' : params_for_body(params)), user_id, entity_id, entity_schema, sharded_schema, exp_subentity_schema, exp_subentity_prefix
             response.first if response.first
           end
 
-          def user_id           ; service.parameters.user_id ; end
-          def company_id        ; service.parameters.company_id ; end
-          def company_schema    ; service.parameters.company_schema.nil? ? nil : service.parameters.company_schema ; end
-          def sharded_schema    ; service.parameters.sharded_schema.nil? ? nil : service.parameters.sharded_schema ; end
-          def accounting_schema ; service.parameters.accounting_schema.nil? ? nil : service.parameters.accounting_schema ; end
-          def accounting_prefix ; service.parameters.accounting_prefix.nil? ? nil : service.parameters.accounting_prefix ; end
+          def user_id          ; service.parameters.user_id ; end
+          def entity_id        ; service.parameters.entity_id ; end
+          def entity_schema    ; service.parameters.entity_schema.nil? ? nil : service.parameters.entity_schema ; end
+          def sharded_schema   ; service.parameters.sharded_schema.nil? ? nil : service.parameters.sharded_schema ; end
+          def subentity_schema ; service.parameters.subentity_schema.nil? ? nil : service.parameters.subentity_schema ; end
+          def subentity_prefix ; service.parameters.subentity_prefix.nil? ? nil : service.parameters.subentity_prefix ; end
+
+      end
+    else
+
+      class JobDbAdapter < ::SP::Duh::JSONAPI::Adapters::Db
+
+        private
 
-          def params_for_body(params)
-            params.blank? ?  '' : params.to_json
+          # Implement the JSONAPI request by direct querying of the JSONAPI function in the database
+          def do_request_on_the_db(method, path, params)
+            jsonapi_query = %Q[ SELECT * FROM public.jsonapi('%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s') ]
+
+            response = service.connection.exec jsonapi_query, method, (method == 'GET' ? url_with_params_for_query(path, params) : url(path)), (method == 'GET' ? '' : params_for_body(params)), user_id, entity_id, entity_schema, sharded_schema, subentity_schema, subentity_prefix
+            response.first if response.first
           end
 
-          def params_for_query(params)
-            query = ""
-            if !params.blank?
-              case
-                when params.is_a?(Array)
-                  # query = params.join('&')
-                  query = params.map{ |v| URI.encode(URI.encode(v), "&") }.join('&')
-                when params.is_a?(Hash)
-                  query = params.map do |k,v|
-                    if v.is_a?(String)
-                      "#{k}=\"#{URI.encode(URI.encode(v), "&")}\""
-                    else
-                      "#{k}=#{v}"
-                    end
-                  end.join('&')
-                else
-                  query = params.to_s
-              end
-            end
-            query
+          def explicit_do_request_on_the_db(exp_subentity_schema, exp_subentity_prefix, method, path, params)
+            jsonapi_query = %Q[ SELECT * FROM public.jsonapi('%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s') ]
+
+            response = service.connection.exec jsonapi_query, method, (method == 'GET' ? url_with_params_for_query(path, params) : url(path)), (method == 'GET' ? '' : params_for_body(params)), user_id, entity_id, entity_schema, sharded_schema, exp_subentity_schema, exp_subentity_prefix
+            response.first if response.first
           end
 
+          def user_id          ; service.parameters.user_id ; end
+          def entity_id        ; service.parameters.entity_id ; end
+          def entity_schema    ; service.parameters.entity_schema.nil? ? nil : service.parameters.entity_schema ; end
+          def sharded_schema   ; service.parameters.sharded_schema.nil? ? nil : service.parameters.sharded_schema ; end
+          def subentity_schema ; service.parameters.subentity_schema.nil? ? nil : service.parameters.subentity_schema ; end
+          def subentity_prefix ; service.parameters.subentity_prefix.nil? ? nil : service.parameters.subentity_prefix ; end
+
       end
 
     end

data/lib/sp/job/jsonapi_error.rb

@@ -7,88 +7,45 @@
 # Helper to obtain tokens to access toconline API's.
 #
 
+require 'sp/job/common'
+
 module SP
   module Job
-
-    #
-    #  Helper class to transform an error into json api format.
-    #
-    class JSONAPIError < StandardError
-
-      # {
-      #   "errors": [
-      #     {
-      #       "status": nullptr,
-      #       "code": nullptr,
-      #       "detail": nullptr,
-      #       "meta": {
-      #         "internal-error": nullptr
-      #       }
-      #     }
-      #   ]
-      # }
-
-      private
-
-        @error
-
-      public
-
-      def initialize (code: 500, detail: nil, internal: nil)
-        @errors = [
-          {
-            :code   => code,
-            :detail => detail
+    module JSONAPI
+
+      class Error < ::SP::Job::Common::Exception
+        def initialize(status:, code:, detail:, internal:nil)
+          body = {
+             errors: [
+               {
+                 code: "#{code}",
+                 detail: "#{detail}",
+                 status: "#{status} - #{::SP::Job::HttpClient.http_reason(code: status)}"
+               }
+            ]
           }
-        ]
-        # 4xx
-        case code
-        when 400
-          @errors[0][:status] = "Bad Request"
-        when 401
-          @errors[0][:status] = "Unauthorized"
-        when 403
-          @errors[0][:status] = "Forbidden"
-        when 404
-          @errors[0][:status] = "Not Found"
-        when 405
-          @errors[0][:status] = "Method Not Allowed"
-        when 406
-          @errors[0][:status] = "Not Acceptable"
-        when 408
-          @errors[0][:status] = "Request Timeout"
-        # 5xx
-        when 501
-          @errors[0][:status] = "Not Implemented"
-        else
-        # other
-          @errors[0][:status] = "Internal Server Error"
-        end
-        @errors[0][:status] = "#{code} #{@errors[0][:status]}"
-        if nil != internal
-          @errors[0][:meta] = { :'internal-error' => internal }
+          if nil != internal
+            body[:meta] = {
+              'internal-error' => internal
+            }
+          end
+          super(status_code: status, content_type: 'application/vnd.api+json;charset=utf-8', body: body)
         end
-      end
-
-      def code ()
-        return @errors[0][:code]
-      end
 
-      def content_type ()
-        "application/vnd.api+json;charset=utf-8"
-      end
+        def code
+          @body[:errors][0][:code]
+        end
 
-      def body ()
-        {
-          :errors => @errors
-        }
-      end
+        def message
+          @body[:errors][0][:detail]
+        end
 
-      def content_type_and_body ()
-        [ content_type(), body() ]
-      end
+        def content_type_and_body
+          [ 'application/vnd.api+json', message ]
+        end
 
-    end
+      end # class Error
 
+    end # JSONAPI module
   end # Job module
 end # SP module