ruby-experian 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e0371a986bd95bab1599a0f614435a49f5dbeffd31f697b3c4c16f0fef69abe
+  data.tar.gz: 0d77ee8c6e4f27391c377fecb9e4d65fb2655c41fd788852060a78aab0652c55
+SHA512:
+  metadata.gz: 4a652cd2104b641d78efddf0c838b7544949eeedf013d33fec6f7737af5a9c0d0014e68c1f97024eff464745fa08d85e765b3570b5c9e3c4f079920cab0cbe00
+  data.tar.gz: 011dc686d3221ec58536df841b04a7d3f80595cb87f88e64dacbe62706d1989cd1be556d7d460d15af2cb3218348756f10d55a367a82090ca8bf3242fd0c230e

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: webmock
+    versions:
+    - 3.11.1
+    - 3.11.3
+  - dependency-name: rspec
+    versions:
+    - 3.10.0

data/.github/pull_request_template.md

@@ -0,0 +1,5 @@
+## All Submissions:
+
+- [ ] Have you followed the guidelines in our [Contributing document](../blob/main/CONTRIBUTING.md)?
+- [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
+- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?

data/.github/workflows/tests.yml

@@ -0,0 +1,44 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Ruby version specified in `.ruby-version`
+        uses: eregon/use-ruby-action@master # this will use by default the .ruby-version file in your repository
+
+      - name: Install required apt packages
+        run: |
+          sudo apt-get -y install libpq-dev
+
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+
+      - name: Rspec tests
+        run: bundle exec rspec
+        env:
+          COVERAGE_DIR: coverage
+
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v4-beta
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          file: coverage/coverage.xml

data/.gitignore

@@ -0,0 +1,74 @@
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+
+
+# Used by dotenv library to load environment variables.
+.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status
+
+# IDE
+.idea
+.idea/
+.idea/*
+.vscode
+.vs/
+
+# Mac
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  # Skips checking to make sure top level modules / classes have a comment.
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - "**/*.gemspec"
+
+Lint/AmbiguousOperator:
+  # https://github.com/rubocop/rubocop/issues/4294
+  Exclude:
+    - "lib/experian/client.rb"
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexrudall@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moraki/ruby-experian. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alexrudall/ruby-experian/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -0,0 +1,27 @@
+source "https://rubygems.org"
+
+# Include gem dependencies from ruby-experian.gemspec
+gemspec
+
+gem "dotenv", "~> 2.8.1"
+gem "rake", "~> 13.1"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.50.2"
+gem "vcr", "~> 6.1.0"
+gem "webmock", "~> 3.19.1"
+gem "sha3"
+gem "rexml", '~> 3.2'
+gem "multi_xml", '~> 0.6.0'
+
+group :development, :test do
+  gem "byebug", "~> 11.1"
+  gem "pry", "~> 0.14.2"
+  gem "pry-byebug", "~> 3.10"
+  gem "pry-rescue", "~> 1.5"
+  gem "pry-stack_explorer", "~> 0.6.1"
+end
+
+group :test do
+  gem "simplecov"
+  gem "simplecov-cobertura"
+end

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    ruby-experian (0.0.1)
+      faraday (>= 1)
+      faraday_middleware (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    debug_inspector (1.2.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dotenv (2.8.1)
+    faraday (1.2.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    hashdiff (1.1.0)
+    interception (0.5)
+    json (2.7.1)
+    method_source (1.0.0)
+    multi_xml (0.6.0)
+    multipart-post (2.3.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    pry-rescue (1.5.2)
+      interception (>= 0.5)
+      pry (>= 0.12.0)
+    pry-stack_explorer (0.6.1)
+      binding_of_caller (~> 1.0)
+      pry (~> 0.13)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    sha3 (1.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.5.0)
+    vcr (6.1.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  dotenv (~> 2.8.1)
+  multi_xml (~> 0.6.0)
+  pry (~> 0.14.2)
+  pry-byebug (~> 3.10)
+  pry-rescue (~> 1.5)
+  pry-stack_explorer (~> 0.6.1)
+  rake (~> 13.1)
+  rexml (~> 3.2)
+  rspec (~> 3.12)
+  rubocop (~> 1.50.2)
+  ruby-experian!
+  sha3
+  simplecov
+  simplecov-cobertura
+  vcr (~> 6.1.0)
+  webmock (~> 3.19.1)
+
+BUNDLED WITH
+   2.4.22

data/README.md

@@ -0,0 +1,178 @@
+# Ruby Experian
+
+<a href="https://codecov.io/github/moraki-finance/ruby-experian" >
+ <img src="https://codecov.io/github/moraki-finance/ruby-experian/graph/badge.svg?token=SKTT14JJGV"/>
+</a>
+
+[![Tests](https://github.com/moraki-finance/ruby-experian/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/moraki-finance/ruby-experian/actions/workflows/tests.yml)
+
+Use the [Experian Axesor Informe 360](<https://axesor.es/blog/openai-api/](https://www.axesor.es/informacion-empresas/informes/informe-axesor-360.aspx)https://www.axesor.es/informacion-empresas/informes/informe-axesor-360.aspx>) API with Ruby! 🩵
+
+Allows you to get a detailed credit risk report for Spanish companies.
+
+### Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby-experian"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+### Gem install
+
+Or install with:
+
+```bash
+$ gem install ruby-experian
+```
+
+and require with:
+
+```ruby
+require "experian"
+```
+
+## Usage
+
+- Get your user_code and password from [https://axesor.es](https://www.axesor.es/)
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+client = Experian::Client.new(user_code: "user code goes here", password: "password goes here")
+```
+
+### With Config
+
+For a more robust setup, you can configure the gem with your API keys, for example in an `experian.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
+
+```ruby
+Experian.configure do |config|
+    config.user_code = ENV.fetch("EXPERIAN_USER_CODE")
+    config.password = ENV.fetch("EXPERIAN_PASSWORD")
+end
+```
+
+Then you can create a client like this:
+
+```ruby
+client = Experian::Client.new
+```
+
+You can still override the config defaults when making new clients; any options not included will fall back to any global config set with Experian.configure. e.g. in this example the base_uri, request_timeout, etc. will fallback to any set globally using Experian.configure, with only the access_token overridden:
+
+```ruby
+client = Experian::Client.new(password: "some other password")
+```
+
+#### Custom timeout or base URI
+
+The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client. You can also change the base URI used for all requests, eg. to use observability tools like [Helicone](https://docs.helicone.ai/quickstart/integrate-in-one-line-of-code).
+
+```ruby
+client = Experian::Client.new(
+    user_code: "user code goes here",
+    base_uri: "https://oai.hconeai.com/",
+    request_timeout: 240,
+    extra_headers: {
+      "Helicone-Auth": "Bearer HELICONE_API_KEY"
+      "helicone-stream-force-format" => "true",
+    }
+)
+```
+
+or when configuring the gem:
+
+```ruby
+Experian.configure do |config|
+    config.user_code = ENV.fetch("EXPERIAN_USER_CODE")
+    config.password = ENV.fetch("EXPERIAN_PASSWORD")
+    config.base_uri = "https://oai.hconeai.com/" # Optional
+    config.request_timeout = 240 # Optional
+    config.extra_headers = {
+      "Helicone-Auth": "Bearer HELICONE_API_KEY"
+    } # Optional
+end
+```
+
+#### Extra Headers per Client
+
+You can dynamically pass headers per client object, which will be merged with any headers set globally with Experian.configure:
+
+```ruby
+client = Experian::Client.new(user_code: "code goes here", password: "password goes here")
+client.add_headers("X-Proxy-TTL" => "43200")
+```
+
+#### Verbose Logging
+
+You can pass [Faraday middleware](https://lostisland.github.io/faraday/#/middleware/index) to the client in a block, eg. to enable verbose logging with Ruby's [Logger](https://ruby-doc.org/3.2.2/stdlibs/logger/Logger.html):
+
+```ruby
+  client = Experian::Client.new do |f|
+    f.response :logger, Logger.new($stdout), bodies: true
+  end
+```
+
+### 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.
+
+The exposed sections for now are:
+
+- id
+- address
+- rating
+- number_of_employees
+
+```ruby
+report = client.report(cif: "cif goes here")
+report.rating.inspect
+# => "#<OpenStruct score=8, default_probability=0.529, risk=\"Mínimo\", size=\"Grande\">"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Warning
+
+If you have an `EXPERIAN_USER_CODE` and `EXPERIAN_PASSWORD` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
+
+## Release
+
+In order to release this gem, you'll need the `gem-release` gem globally installed:
+
+```bash
+gem install gem-release
+```
+
+Second, run the specs without VCR so they actually hit the API. Set `EXPERIAN_USER_CODE` and `EXPERIAN_PASSWORD` in your environment or pass it in like this:
+
+```
+EXPERIAN_USER_CODE=code EXPERIAN_PASSWORD=password bundle exec rspec
+```
+
+Then update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/moraki-finance/ruby-experian>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/moraki-finance/ruby-experian/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/moraki-finance/ruby-experian/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "experian"
+require "pry"
+require "pry-byebug"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/experian/client.rb

@@ -0,0 +1,27 @@
+module Experian
+  class Client
+    include Experian::HTTP
+
+    CONFIG_KEYS = %i[
+      user_code password request_timeout base_uri extra_headers
+    ].freeze
+    attr_reader(*CONFIG_KEYS, :faraday_middleware)
+
+    def initialize(config = {}, &faraday_middleware)
+      CONFIG_KEYS.each do |key|
+        # Set instance variables like api_type & access_token. Fall back to global config
+        # if not present.
+        instance_variable_set("@#{key}", config[key] || Experian.configuration.send(key))
+      end
+      @faraday_middleware = faraday_middleware
+    end
+
+    def report(cif:, format: :xml)
+      response = get(path: "/informe", format:, cif:, cod_servicio: 57)
+
+      return Experian::Report.new(response) if format == :xml
+
+      response
+    end
+  end
+end

data/lib/experian/http.rb

@@ -0,0 +1,122 @@
+require "base64"
+require "sha3"
+
+module Experian
+  module HTTP
+    module FlatParamsEncoder
+      class << self
+        extend Forwardable
+        def_delegators :'Faraday::Utils', :escape, :unescape
+      end
+
+      def self.encode(params)
+        return nil if params == nil
+
+        if !params.is_a?(Array)
+          if !params.respond_to?(:to_hash)
+            raise TypeError,
+              "Can't convert #{params.class} into Hash."
+          end
+          params = params.to_hash
+          params = params.map do |key, value|
+            key = key.to_s if key.kind_of?(Symbol)
+            [key, value]
+          end
+        end
+
+        # The params have form [['key1', 'value1'], ['key2', 'value2']].
+        buffer = ''
+        params.each do |key, value|
+          encoded_key = escape(key)
+          value = value.to_s if value == true || value == false
+          if value == nil
+            buffer << "#{encoded_key}&"
+          elsif value.kind_of?(Array)
+            value.each do |sub_value|
+              encoded_value = escape(sub_value)
+              buffer << "#{encoded_key}=#{encoded_value}&"
+            end
+          else
+            encoded_value = escape(value)
+            buffer << "#{encoded_key}=#{encoded_value}&"
+          end
+        end
+        return buffer.chop
+      end
+
+      def self.decode(query)
+        empty_accumulator = {}
+        return nil if query == nil
+        split_query = (query.split('&').map do |pair|
+          pair.split('=', 2) if pair && !pair.empty?
+        end).compact
+        return split_query.inject(empty_accumulator.dup) do |accu, pair|
+          pair[0] = unescape(pair[0])
+          pair[1] = true if pair[1].nil?
+          if pair[1].respond_to?(:to_str)
+            pair[1] = unescape(pair[1].to_str.gsub(/\+/, " "))
+          end
+          if accu[pair[0]].kind_of?(Array)
+            accu[pair[0]] << pair[1]
+          elsif accu[pair[0]]
+            accu[pair[0]] = [accu[pair[0]], pair[1]]
+          else
+            accu[pair[0]] = pair[1]
+          end
+          accu
+        end
+      end
+    end
+
+    def get(path:, format:, **query)
+      tip_formato = {
+        xml: 2,
+        pdf: 3
+      }[format]
+
+      raise Experian::Error, "Invalid format: #{format}" unless tip_formato
+
+      query.merge!(tip_formato:)
+      full_uri = uri(path:, query:)
+
+      if format == :xml
+        return conn.get(full_uri) do |req|
+          req.headers = headers
+        end
+      end
+
+      full_uri
+    end
+
+    private
+
+    def conn
+      connection = Faraday.new do |f|
+        f.options[:timeout] = request_timeout
+        f.options[:params_encoder] = FlatParamsEncoder
+        f.use MiddlewareErrors
+        f.response :raise_error
+      end
+
+      @faraday_middleware&.call(connection)
+
+      connection
+    end
+
+    def uri(path:, query: {})
+      query[:cod_usuario] = user_code
+      query[:crc] = crc(query)
+      File.join(base_uri, path) + "?#{URI.encode_www_form(query)}"
+    end
+
+    def crc(query = {})
+      SHA3::Digest.hexdigest(:sha256, query.values.join << password)
+    rescue => e
+      raise Experian::Error, "Error calculating CRC: #{e.message}"
+    end
+
+    def headers
+      {}.merge(extra_headers)
+    end
+  end
+end

data/lib/experian/report.rb

@@ -0,0 +1,70 @@
+require "multi_xml"
+require "rexml"
+
+module Experian
+  class Report
+    attr_reader :response, :url, :raw_xml, :xml
+
+    def initialize(response)
+      @response = response
+      @url = response.env.url.to_s
+      @raw_xml = response.body
+      MultiXml.parser = :rexml
+      @xml = MultiXml.parse(@raw_xml)
+
+      raise Experian::AuthenticationError if authentication_error?
+    end
+
+    def id
+      if (id_xml = data["DatosIdentificativos"])
+        OpenStruct.new(
+          cif: id_xml["Cif"],
+          name: id_xml["Nombre"],
+          infotel_code: id_xml["CodigoInfotel"],
+          incorporation_date: id_xml["FechaFundacion"],
+          social_form: id_xml["FormaSocial"]["__content__"],
+        )
+      end
+    end
+
+    def address
+      if (address_xml = data["DomicilioComercial"])
+        OpenStruct.new(
+          line: address_xml["Domicilio"],
+          city: address_xml["Poblacion"],
+          province: address_xml["Provincia"],
+          postal_code: address_xml["CodigoPostal"],
+          municipality: address_xml["Municipio"],
+        )
+      end
+    end
+
+    # Number of employees in the last recorded excercise
+    def number_of_employees
+      data.dig("ListaAnualEmpleados", "Empleado")&.first&.dig("EmpleadoFijo")&.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 data
+      xml.dig("ServicioWebAxesor", "ListaPaquetesNegocio")
+    end
+
+    def authentication_error?
+      xml.dig("DatosError", "CodError") == "1"
+    end
+  end
+end

data/lib/experian/version.rb

@@ -0,0 +1,3 @@
+module Experian
+  VERSION = "0.0.1".freeze
+end

data/lib/experian.rb

@@ -0,0 +1,69 @@
+require "faraday"
+require "faraday_middleware"
+
+require_relative "experian/http"
+require_relative "experian/client"
+require_relative "experian/version"
+require_relative "experian/report"
+
+module Experian
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class ConfigurationError < Error; end
+
+  class MiddlewareErrors < Faraday::Middleware
+    def call(env)
+      @app.call(env)
+    rescue Faraday::Error => e
+      raise e unless e.response.is_a?(Hash)
+
+      logger = Logger.new($stdout)
+      logger.formatter = proc do |_severity, _datetime, _progname, msg|
+        "\033[31mExperian HTTP Error (spotted in ruby-experian #{VERSION}): #{msg}\n\033[0m"
+      end
+      logger.error(e.response[:body])
+
+      raise e
+    end
+  end
+
+  class Configuration
+    attr_writer :user_code, :password, :version, :request_timeout, :base_uri, :extra_headers
+    attr_reader :base_uri, :request_timeout, :version, :extra_headers
+
+    DEFAULT_BASE_URI = "https://informes.axesor.es".freeze
+    DEFAULT_VERSION = "9.0".freeze
+    DEFAULT_REQUEST_TIMEOUT = 120
+
+    def initialize
+      @user_code = nil
+      @password = nil
+      @version = DEFAULT_VERSION
+      @request_timeout = DEFAULT_REQUEST_TIMEOUT
+      @base_uri = DEFAULT_BASE_URI
+      @extra_headers = {}
+    end
+
+    def user_code
+      return @user_code if @user_code
+      raise ConfigurationError, "Experian user_code missing!"
+    end
+
+    def password
+      return @password if @password
+      raise ConfigurationError, "Experian password missing!"
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Experian::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/ruby/experian.rb

@@ -0,0 +1 @@
+require_relative "../experian"

data/ruby-experian.gemspec

@@ -0,0 +1,22 @@
+require_relative "lib/experian/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "ruby-experian"
+  s.version               = Experian::VERSION
+  s.summary               = "Experian connector"
+  s.description           = "A simple hello world gem"
+  s.authors               = ["Martin Mochetti"]
+  s.email                 = "martin@moraki.co"
+  s.files                 = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  s.homepage              = "https://github.com/moraki/ruby-experian"
+  s.license               = "MIT"
+  s.bindir                = "bin"
+  s.executables           = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths         = ["lib"]
+
+  s.add_dependency "faraday", ">= 1"
+  s.add_dependency "faraday_middleware", ">= 1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: ruby-experian
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Mochetti
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A simple hello world gem
+email: martin@moraki.co
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/experian.rb
+- lib/experian/client.rb
+- lib/experian/http.rb
+- lib/experian/report.rb
+- lib/experian/response.rb
+- lib/experian/version.rb
+- lib/ruby/experian.rb
+- ruby-experian.gemspec
+homepage: https://github.com/moraki/ruby-experian
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Experian connector
+test_files: []