ruby-experian 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6c744efbe089056cb402d802ef84639284c6195156677fa9c9613cf5452d0b
-  data.tar.gz: 93910e87df645330255fa3ca288fc73468d579c4837e95820788cf52141a8554
+  metadata.gz: 0e6f48cd5cc5a1e3d6297d4e1b49e8157191baa678372334f8cb7f4421d3b016
+  data.tar.gz: 59ce950b92934263c1c4e3ea110c1b1279a4be4e5a28dc36d87b8b9c647040f9
 SHA512:
-  metadata.gz: '00099d053097cd37b7ad517a2054760b78fc28e99eb31eea03b226723b05950cd79b9eccd108490518b60955de22d5d7ae7f908fb7bfc02e10ae2db52a0fcd67'
-  data.tar.gz: 56f76810e3ae4cc15f8daeb630ce97c76e26f670dcddacec5424eae55e05fd4bf070e9f873a2f5e4f05c49d751dc7029681dffe2ce29385467ea340e2892ce56
+  metadata.gz: b30f7f97476e672715767b2803c217c9995a2dd01ba61bd4735432e1f67ac845e53705ecaf12fcfc10a7ab29c4c279b7ef4581ba2426dbae04aa5119878fcec9
+  data.tar.gz: aa97405213f53b81b01f1c9c51d0bdfeac9e40c63bdce767433de8d7e073695596fac64c7787fc194f882ffedc28be844237f2ea42832fd70a9a0cbe75c7c8b0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-experian (0.1.0)
+    ruby-experian (0.1.2)
       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

@@ -38,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.dig("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

data/lib/experian/version.rb

@@ -1,3 +1,3 @@
 module Experian
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.2".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.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Martin Mochetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-06-16 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"