facturama-ruby-sdk 0.0.3

data/lib/facturama/services/cfdi_multi_service.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative 'crud_service'
+require 'base64'
+
+module Facturama
+  module Services
+    class CfdiMultiService < CrudService
+      def initialize(connection_info)
+        super(connection_info, '')
+      end
+
+      # ------------------------ CRUD ------------------------
+
+      # CFDI 3.3
+      def create(model)
+        post(model, 'api-lite/2/cfdis')
+      end
+
+      # CFDI 4.0
+      def create3(model)
+        post(model, 'api-lite/3/cfdis')
+      end
+
+      def remove(id, motive, uuidReplacement)
+        motive = '02' if motive.nil? && motive != ''
+        uuidReplacement = '' if uuidReplacement.nil? && uuidReplacement != ''
+
+        raise(FacturamaException('El Id del cfdi a eliminar es obligatorio')) unless !id.nil? && id != ''
+
+        delete("api-lite/cfdis/#{id}?motive=#{motive}&uuidReplacement=#{uuidReplacement}")
+      end
+
+      def retrieve(id)
+        get("api-lite/cfdis/#{id}")
+      end
+
+      # ------------------------ DESCARGA DE ARCHIVOS (PDF, XML, HTML) ------------------------
+
+      # Obtiene un archivo referente a un CFDI del tipo "Issued"
+      # @param id Identificador del CFDI
+      # @param format Formato deseado ( pdf | html | xml )
+      # @param type Tipo de comprobante ( payroll | received | issued )
+      # @return Archivo en cuestion
+      def get_file(id, format, type)
+        resource = "cfdi/#{format}/#{type}/#{id}"
+        get(resource)
+      end
+
+      # Decodifica y guarda un archivo base64 en una ruta
+      def save_file(file_path, file_content_base64)
+        file_content_decoded = Base64.decode64(file_content_base64)
+        File.open(file_path, 'wb') do |f|
+          f.write(file_content_decoded)
+        end
+      end
+
+      def save_pdf(file_path, id, type = Facturama::InvoiceType::ISSUED_LITE)
+        file_content = get_file(id, Facturama::FileFormat::PDF, type)
+        save_file(file_path, file_content['Content'])
+      end
+
+      def save_xml(file_path, id, type = Facturama::InvoiceType::ISSUED_LITE)
+        file_content = get_file(id, Facturama::FileFormat::XML, type)
+        save_file(file_path, file_content['Content'])
+      end
+
+      def save_html(file_path, id, type = Facturama::InvoiceType::ISSUED_LITE)
+        file_content = get_file(id, Facturama::FileFormat::HTML, type)
+        save_file(file_path, file_content['Content'])
+      end
+
+      # ------------------------ LISTADO DE CFDIS ------------------------
+
+      # Listado de Cfdi filtrando por palabra clave
+      def list_by_keyword(keyword,
+                          status = Facturama::CfdiStatus::ACTIVE)
+
+        resource = "api-lite/cfdis?status=#{status}&keyword=#{keyword}"
+        get(resource)
+      end
+
+      # Listado de Cfdi filtrando por palabra RFC
+      def list_by_rfc(rfc,
+                      status = Facturama::CfdiStatus::ACTIVE,
+                      _type = Facturama::InvoiceType::ISSUED)
+
+        resource = "api-lite/cfdis?status=#{status}&rfc=#{rfc}"
+        get(resource)
+      end
+
+      # Listado con todas las opciones posibles
+      def list(folio_start = -1, folio_end = -1,
+               rfc = nil,  tax_entity_name = nil,
+               date_start = nil, date_end = nil,
+               id_branch = nil,  serie = nil,
+               status = Facturama::CfdiStatus::ACTIVE,
+               type = Facturama::InvoiceType::ISSUED)
+
+        resource = "api-lite/cfdis?type=#{type}&status=#{status}"
+
+        resource += "&folioStart=#{folio_start}" if folio_start > -1
+
+        resource += "&folioEnd=#{folio_end}" if folio_end > -1
+
+        resource += "&rfc=#{rfc}" unless rfc.nil?
+
+        resource += "&taxEntityName=#{tax_entity_name}" unless tax_entity_name.nil?
+
+        resource += "&dateStart=#{date_start}" unless date_start.nil?
+
+        resource += "&dateEnd=#{date_end}" unless date_end.nil?
+
+        resource += "&idBranch=#{id_branch}" unless id_branch.nil?
+
+        resource += "&serie=#{serie}" unless serie.nil?
+
+        get(resource)
+      end
+
+      # ------------------------ ENVIO POR CORREO ------------------------
+
+      # Envía el CFDI por correo, con el asunto especificado
+      def send_by_mail(id, email, subject, type = Facturama::InvoiceType::ISSUED_LITE)
+        response = post(nil, "cfdi?cfdiType=#{type}&cfdiId=#{id}&email=#{email}&subject=#{subject}")
+        !!response['success']
+      end
+    end
+  end
+end

data/lib/facturama/services/cfdi_service.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative 'crud_service'
+require 'base64'
+
+module Facturama
+  module Services
+    class CfdiService < CrudService
+      def initialize(connection_info)
+        super(connection_info, '')
+      end
+
+      # ------------------------ CRUD ------------------------
+
+      # CFDI 3.3
+      def create(model)
+        post(model, '2/cfdis')
+      end
+
+      # CFDI 4.0
+      def create3(model)
+        post(model, '3/cfdis')
+      end
+
+      def remove(id, type, motive, uuidReplacement)
+        motive = '02' if motive.nil? && motive != ''
+        uuidReplacement = '' if uuidReplacement.nil? && uuidReplacement != ''
+
+        raise(FacturamaException('El Id del cfdi a eliminar es obligatorio')) unless !id.nil? && id != ''
+
+        delete("cfdi/#{id}?type=#{type}&motive=#{motive}&uuidReplacement=#{uuidReplacement}")
+      end
+
+      def retrieve(id, type = nil)
+        str_type = if type.nil?
+                     'Issued'
+                   else
+                     type
+                   end
+
+        get("cfdi/#{id}?type=#{str_type}")
+      end
+
+      # ------------------------ DESCARGA DE ARCHIVOS (PDF, XML, HTML) ------------------------
+
+      # Obtiene un archivo referente a un CFDI del tipo "Issued"
+      # @param id Identificador del CFDI
+      # @param format Formato deseado ( pdf | html | xml )
+      # @param type Tipo de comprobante ( payroll | received | issued )
+      # @return Archivo en cuestion
+      def get_file(id, format, type)
+        resource = "api/cfdi/#{format}/#{type}/#{id}"
+        get(resource)
+      end
+
+      # Decodifica y guarda un archivo base64 en una ruta
+      def save_file(file_path, file_content_base64)
+        file_content_decoded = Base64.decode64(file_content_base64)
+        File.open(file_path, 'wb') do |f|
+          f.write(file_content_decoded)
+        end
+      end
+
+      def save_pdf(file_path, id, type = Facturama::InvoiceType::ISSUED)
+        file_content = get_file(id, Facturama::FileFormat::PDF, type)
+        save_file(file_path, file_content['Content'])
+      end
+
+      def save_xml(file_path, id, type = Facturama::InvoiceType::ISSUED)
+        file_content = get_file(id, Facturama::FileFormat::XML, type)
+        save_file(file_path, file_content['Content'])
+      end
+
+      def save_html(file_path, id, type = Facturama::InvoiceType::ISSUED)
+        file_content = get_file(id, Facturama::FileFormat::HTML, type)
+        save_file(file_path, file_content['Content'])
+      end
+
+      # ------------------------ LISTADO DE CFDIS ------------------------
+
+      # Listado de Cfdi filtrando por palabra clave
+      def list_by_keyword(keyword,
+                          status = Facturama::CfdiStatus::ACTIVE,
+                          type = Facturama::InvoiceType::ISSUED)
+
+        resource = "cfdi?type=#{type}&status=#{status}&keyword=#{keyword}"
+        get(resource)
+      end
+
+      # Listado de Cfdi filtrando por palabra RFC
+      def list_by_rfc(rfc,
+                      status = Facturama::CfdiStatus::ACTIVE,
+                      type = Facturama::InvoiceType::ISSUED)
+
+        resource = "cfdi?type=#{type}&status=#{status}&rfc=#{rfc}"
+        get(resource)
+      end
+
+      # Listado con todas las opciones posibles
+      def list(folio_start = -1, folio_end = -1,
+               rfc = nil,  tax_entity_name = nil,
+               date_start = nil, date_end = nil,
+               id_branch = nil,  serie = nil,
+               status = Facturama::CfdiStatus::ACTIVE,
+               type = Facturama::InvoiceType::ISSUED)
+
+        resource = "cfdi?type=#{type}&status=#{status}"
+
+        resource += "&folioStart=#{folio_start}" if folio_start > -1
+
+        resource += "&folioEnd=#{folio_end}" if folio_end > -1
+
+        resource += "&rfc=#{rfc}" unless rfc.nil?
+
+        resource += "&taxEntityName=#{tax_entity_name}" unless tax_entity_name.nil?
+
+        resource += "&dateStart=#{date_start}" unless date_start.nil?
+
+        resource += "&dateEnd=#{date_end}" unless date_end.nil?
+
+        resource += "&idBranch=#{id_branch}" unless id_branch.nil?
+
+        resource += "&serie=#{serie}" unless serie.nil?
+
+        get(resource)
+      end
+
+      # ------------------------ ENVIO POR CORREO ------------------------
+
+      # Envía el CFDI por correo, con el asunto especificado
+      def send_by_mail(id, email, subject, type = Facturama::InvoiceType::ISSUED)
+        response = post(nil, "cfdi?cfdiType=#{type}&cfdiId=#{id}&email=#{email}&subject=#{subject}")
+        !!response['success']
+      end
+    end
+  end
+end

data/lib/facturama/services/client_service.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'crud_service'
+
+module Facturama
+  module Services
+    class ClientService < CrudService
+      def initialize(connection_info)
+        super(connection_info, 'client')
+      end
+    end
+  end
+end

data/lib/facturama/services/crud_service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'http_service'
+
+module Facturama
+  module Services
+    class CrudService < HttpService
+      def retrieve(message)
+        HttpService.instance_method(:get).bind(self).call(message)
+      end
+
+      def list
+        HttpService.instance_method(:get).bind(self).call('')
+      end
+
+      def create(message, url = '')
+        HttpService.instance_method(:post).bind(self).call(message, url)
+      end
+
+      def create3(message, url = '')
+        HttpService.instance_method(:post).bind(self).call(message, url)
+      end
+
+      def remove(message)
+        HttpService.instance_method(:delete).bind(self).call(message)
+      end
+
+      def update(message, url = '')
+        HttpService.instance_method(:put).bind(self).call(message, url)
+      end
+    end
+  end
+end

data/lib/facturama/services/csd_service.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'crud_service'
+
+module Facturama
+  module Services
+    class CsdService < CrudService
+      def initialize(connection_info)
+        super(connection_info, 'api-lite/csds')
+      end
+    end
+  end
+end

data/lib/facturama/services/http_service.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require_relative '../models/exception/facturama_exception'
+require_relative '../models/connection_info'
+
+module Facturama
+  module Services
+    class HttpService
+      def initialize(connection_info, uri_resource)
+        @connection_info = connection_info
+        @uri_resource = uri_resource
+      end
+
+      def get(args = '')
+        res = RestClient::Request.new(
+          method: :get,
+          url: url(args),
+          user: @connection_info.facturama_user,
+          password: @connection_info.facturama_password,
+          headers: { accept: :json,
+                     content_type: :json,
+                     user_agent: '' }
+        )
+
+        executor(res)
+      end
+
+      def post(message, args = '')
+        json = message.to_json
+
+        res = RestClient::Request.new(
+          method: :post,
+          url: url(args),
+          user: @connection_info.facturama_user,
+          password: @connection_info.facturama_password,
+          payload: json,
+          headers: { content_type: :json }
+        )
+
+        executor(res)
+      end
+
+      def put(message, args = '')
+        json = message.to_json
+
+        res = RestClient::Request.new(
+          method: :put,
+          url: url(args),
+          user: @connection_info.facturama_user,
+          password: @connection_info.facturama_password,
+          payload: json,
+          headers: { accept: :json,
+                     content_type: :json }
+        )
+
+        executor(res)
+      end
+
+      def delete(args = '')
+        res = RestClient::Request.new(
+          method: :delete,
+          url: url(args),
+          user: @connection_info.facturama_user,
+          password: @connection_info.facturama_password,
+          headers: { accept: :json,
+                     content_type: :json }
+        )
+
+        executor(res)
+      end
+
+      private
+
+      def url(args = '')
+        slash = ''
+        args = args.to_s
+
+        if args.length.positive?
+          slash = args =~ /^\?/ ? '' : '/'
+        end
+
+        @uri_resource = "/#{@uri_resource}" if @uri_resource.length.positive?
+
+        @connection_info.uri_base + @uri_resource + slash + args
+      end
+
+      # Executa la peticion y procesa la respuesta decodificando el JSON a un Hash y
+      # Conviriendo los errores de la API en FacturamaExceptions
+      def executor(request)
+        response = request.execute
+
+        JSON[response] if response.code != 204 && response.body != '' # 204 = sin contenido
+
+      # exceptions
+      rescue Exception => e
+        case e.class.name
+        when 'RestClient::NotFound'
+          raise FacturamaException, '404 NotFound: Elemento no encontrado'
+        when 'RestClient::BadRequest'
+          json_response = JSON[e.response]
+          model_state = json_response['ModelState']
+          unless model_state.nil?
+            model_state = json_response['ModelState'].map { |k, v| [k.to_s, v] }
+            fact_exception = FacturamaException.new(json_response['Message'])
+          end
+
+          fact_exception = FacturamaException.new(json_response['Message'], model_state)
+          raise(fact_exception)
+        else
+          raise StandardError, e.response
+        end
+      end
+    end
+  end
+end

data/lib/facturama/services/product_service.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'crud_service'
+
+module Facturama
+  module Services
+    class ProductService < CrudService
+      def initialize(connection_info)
+        super(connection_info, 'product')
+      end
+    end
+  end
+end

data/lib/facturama/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Facturama
+  VERSION = '0.0.3'
+end

data/lib/facturama.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Conectividad
+# require 'rest-client'
+# require 'json'
+
+module Facturama
+  # MODELOS
+  require_relative 'facturama/version'
+  require_relative 'facturama/models/model'
+  require_relative 'facturama/models/product_tax'
+  require_relative 'facturama/models/product'
+  require_relative 'facturama/models/address'
+  require_relative 'facturama/models/client'
+  require_relative 'facturama/models/cfdi_relation'
+  require_relative 'facturama/models/cfdi_relations'
+  require_relative 'facturama/models/cfdi'
+  require_relative 'facturama/models/receiver'
+  require_relative 'facturama/models/tax'
+  require_relative 'facturama/models/item'
+  require_relative 'facturama/models/branch_office'
+  require_relative 'facturama/models/csd'
+  require_relative 'facturama/models/serie'
+  require_relative 'facturama/models/image'
+  require_relative 'facturama/models/complement'
+  require_relative 'facturama/models/tax_stamp'
+  require_relative 'facturama/models/tax_entity'
+
+  # SERVICIOS
+  require_relative 'facturama/services/http_service'
+  require_relative 'facturama/services/crud_service'
+  require_relative 'facturama/services/client_service'
+  require_relative 'facturama/services/product_service'
+  require_relative 'facturama/services/catalog_service'
+  require_relative 'facturama/services/branch_office_service'
+  require_relative 'facturama/services/cfdi_service'
+  require_relative 'facturama/services/csd_service'
+  require_relative 'facturama/services/cfdi_multi_service'
+
+  require_relative 'facturama/facturama_api_web'
+  require_relative 'facturama/facturama_api_multi'
+end

data/lib/samples/sample_api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Facturama
+  module Samples
+    class SampleApi
+      def run
+        rasie 'Este método debe ser sobrecargado, colocando las pruebas adecuadas, segun el tipo de API (Web, Multiemisor)'
+      end
+    end
+  end
+end