ruby-experian 0.0.9 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ddcec7c703945c2b63eba47acdcfb84ee3a09a851ffbf527d7f790f443b0a8
-  data.tar.gz: 28c7e6edeefed2f402092a6e556e80944a6a20ed84efa57231fe2d84f5c8d70a
+  metadata.gz: 49f72214cb1be783e88337a4252fe8f43bae3094264009d8cb320ff6d16af3f6
+  data.tar.gz: f960aa5170a197c7094d69ec4249ce789197e835183cdd8b1f2182d84732e2ee
 SHA512:
-  metadata.gz: 73af74282469e11505a92dde059eac50d225c627bc788a8ab20d7d113ec118061bb3c1e4722c8059dc0d689fdeddb543912f14a0e34b9d48b1c68c026d72307d
-  data.tar.gz: 6d86f7ef7e91008a09bf5b8fc723ad89ea230acc4aa767f24a33dc52035b9319dad79a85b7cc4653d9bee2655acf47ff0167f9b2df04fcf1574a16aae069f86f
+  metadata.gz: 2a04cc506991c122892e4c53fc298cf9dfb710a993b426e3b5f225a624b45a2c785cb3eb719980355e0e0cbc3e41c329afe65d2946b78d3c61b81d5557b188e2
+  data.tar.gz: 68b312e16f9125b563cb862521b6473d135b610d5f95dd9620075fb46036e41acedd1d7af102e1d5c07eeaa79e5473f023f3040a82b0bd653aac38092a7657b9

data/Gemfile

@@ -7,7 +7,6 @@ gem "dotenv", "~> 2.8.1"
 gem "rake", "~> 13.1"
 gem "rspec", "~> 3.13"
 gem "rubocop", "~> 1.50.2"
-gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.23.0"
 
 group :development, :test do
@@ -19,6 +18,7 @@ group :development, :test do
 end
 
 group :test do
+  gem "vcr", "~> 6.1.0"
   gem "simplecov"
   gem "simplecov-cobertura"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-experian (0.0.9)
+    ruby-experian (0.1.1)
       faraday (>= 1)
       multi_xml (>= 0.6.0)
       rexml (>= 3.2)

data/README.md

@@ -61,6 +61,8 @@ Experian.configure do |config|
 end
 ```
 
+By default, this gem will look for the environment variables `EXPERIAN_USER_CODE` and `EXPERIAN_PASSWORD` to set the default values for user code and password.
+
 Then you can create a client like this:
 
 ```ruby
@@ -122,9 +124,9 @@ You can further configure the faraday connection by passing in a block to the cl
   end
 ```
 
-### Report
+### Credit Report
 
-You can hit the report api to get the 360 credit report from Experian by passing in a CIF to the call. Note that only some sections of the report are exposed. Other sections will be exposed as needed / requested.
+You can hit the credit report api to get the 360 credit report from Experian by passing in a CIF to the call. Note that only some sections of the report are exposed. Other sections will be exposed as needed / requested.
 
 The exposed sections for now are:
 
@@ -133,9 +135,29 @@ The exposed sections for now are:
 - rating
 - number_of_employees
 - cnae
+- constitution_date
+
+```ruby
+report = client.credit_report(cif: "cif goes here")
+report.rating.inspect
+# => "#<OpenStruct score=8, default_probability=0.529, risk=\"Mínimo\", size=\"Grande\">"
+```
+
+### Trade Report
+
+You can hit the trade report api to get the 360 trade report from Experian by passing in a CIF to the call. Note that only some sections of the report are exposed. Other sections will be exposed as needed / requested.
+
+The exposed sections for now are:
+
+- model_200(period:)
+- address
+- rating
+- most_recent_number_of_employees
+- cnae
+- constitution_date
 
 ```ruby
-report = client.report(cif: "cif goes here")
+report = client.trade_report(cif: "cif goes here")
 report.rating.inspect
 # => "#<OpenStruct score=8, default_probability=0.529, risk=\"Mínimo\", size=\"Grande\">"
 ```

data/bin/console

@@ -4,6 +4,7 @@ require "bundler/setup"
 require "experian"
 require "pry"
 require "pry-byebug"
+require "dotenv/load"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/experian/trade_report.rb

@@ -2,6 +2,9 @@ module Experian
   class TradeReport < Report
     def model_200(period: last_submitted_year)
       {
+        "00041" => number_of_employees(period:, type: "EmpleadoFijo"),
+        "00042" => number_of_employees(period:, type: "EmpleadoEventual"),
+
         # Balance Sheet - Assets
         "00101" => financial_data("Activo", "11000", period:), # ACTIVO NO CORRIENTE
         "00102" => financial_data("Activo", "11100", period:), # Inmovilizado intangible
@@ -35,6 +38,44 @@ module Experian
       }
     end
 
+    def constitution_date
+      date = data.dig("SeccionDatosRegistrales", "FechaConstitucion")
+      date && Date.parse(date)
+    end
+
+    def address
+      if (address_xml = data["SeccionDatosRegistrales"]["DomicilioSocial"])
+        OpenStruct.new(
+          line: address_xml["Domicilio"],
+          city: address_xml["Poblacion"] || address_xml["Provincia"],
+          province: address_xml["Provincia"],
+          postal_code: address_xml["CodigoPostal"],
+          municipality: address_xml["Municipio"],
+        )
+      end
+    end
+
+    def most_recent_number_of_employees
+      data.dig("ListaAnualEmpleados", "Empleado").first&.dig("EmpleadoFijo")&.to_i
+    end
+
+    def cnae
+      data.dig("ActividadComercial", "Cnae")&.first&.dig("Codigo")&.to_i
+    end
+
+    def rating
+      if (rating_xml = data["Rating"])
+        return unless rating_xml["RatingAxesorDef"]
+
+        OpenStruct.new(
+          score: rating_xml["RatingAxesorDef"]&.strip&.to_i,
+          default_probability: rating_xml["ProbImpago"]&.to_f,
+          risk: rating_xml["GrupoRiesgo"],
+          size: rating_xml["Tamaño"],
+        )
+      end
+    end
+
     private
 
     def last_submitted_year
@@ -52,5 +93,9 @@ module Experian
     def section(section_name)
       data.dig("InformeEconomicoFinanciero")&.first&.dig("ListaGrupos", "Grupo").find { |d| d["Tipo"][section_name] }&.dig("ListaColumnas", "Columna", "ListaDatos", "Dato")
     end
+
+    def number_of_employees(period:, type: "EmpleadoFijo")
+      data.dig("ListaAnualEmpleados", "Empleado").find { |d| d["Ejercicio"] == period.to_s }&.dig(type)&.to_i
+    end
   end
 end

data/lib/experian/version.rb

@@ -1,3 +1,3 @@
 module Experian
-  VERSION = "0.0.9".freeze
+  VERSION = "0.1.1".freeze
 end

data/lib/experian.rb

@@ -21,8 +21,8 @@ module Experian
     DEFAULT_REQUEST_TIMEOUT = 120
 
     def initialize
-      @user_code = nil
-      @password = nil
+      @user_code = ENV.fetch("EXPERIAN_USER_CODE", nil)
+      @password = ENV.fetch("EXPERIAN_PASSWORD", nil)
       @version = DEFAULT_VERSION
       @request_timeout = DEFAULT_REQUEST_TIMEOUT
       @base_uri = DEFAULT_BASE_URI

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-experian
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.1
 platform: ruby
 authors:
 - Martin Mochetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.test"
 - ".github/dependabot.yml"
 - ".github/pull_request_template.md"
 - ".github/workflows/tests.yml"