incognia_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5eb3f0cd63a0319c016e88eea0d86fd5892271befa4a28b8c5d8870c21cd27bb
+  data.tar.gz: 8439dfd8d7cefe7ee1b7d0c91687d8f062b8809afb7a76798e52de2c792c520a
+SHA512:
+  metadata.gz: 88e070f8841a1410117cd527139be05ee19b8e73aea4d1190642f107f97dc181a086b56cbe1c0bfab2bc833d7a0000500b66fc2ce6a3c57b9b0d9e9d58979640
+  data.tar.gz: e7d396d6623a7b2f0965e6b430faa5d5aa28d22b137949a2b24c6956840f85787906d6739f342004381cb593f614af8ec5596443e64277a71e6aaf84a994df00

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @guiocavalcanti

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in incognia_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+group :test do
+  gem "webmock"
+  gem "timecop"
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    incognia_api (0.1.0)
+      faraday
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
+    timecop (0.9.4)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+
+DEPENDENCIES
+  incognia_api!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  timecop
+  webmock
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,98 @@
+# Incognia Ruby Library
+
+[![Ruby](https://github.com/inloco/incognia-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/inloco/incognia-ruby/actions/workflows/main.yml)
+
+Incognia Ruby library provides easy access to the Incogia API from Ruby
+applications. It includes:
+
+- Basic Access Token management (with transparent token refresh)
+- API resounces dinamically built from API responses
+
+For more information on how to integrate Incognia APIs, refer to one of the
+following guides:
+
+- Address verification on user onboarding
+- Protecting app logins
+- Secure and frictionless device change
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'incognia_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install incognia_api
+
+## Usage
+
+### Configuration
+
+Before using the API client, you must initialize it using credentials obtained
+from the [Incognia dashboard]():
+
+```ruby
+api = Incognia::Api.new(client_id: "your-client-id", client_secret:
+"your-client-secret")
+
+```
+
+For sandbox credentials, refer to the [API testing guide]().
+
+
+### Registering a Signup
+
+This method registers a new signup for the given installation and address, returning a signup assessment, containing the risk assessment and supporting evidence:
+
+```ruby
+address = Incognia::Address.new(line: "West 34th Street, New York City, NY 10001")
+installation_id = "WlMksW+jh5GPhqWBorsV8yDihoSHHpmt+DpjJ7eYxpHhuO/5tuHTuA..."
+
+assessment = api.register_signup(
+  installation_id: installation_id,
+  address: address
+)
+
+# => #<OpenStruct id="...", request_id="...", device_id="...", risk_assessment="..", evidence=...>
+
+```
+
+### Getting a Signup
+
+This method allows you to query the latest assessment for a given signup event, returning signup assessment, containing the risk assessment and supporting evidence:
+
+```ruby
+assessment = api.get_signup_assessment(signup_id: "95a9fc56-f65e-436b-a87f-a1338043678f")
+
+# => #<OpenStruct id="...", request_id="...", device_id="...", risk_assessment="..", evidence=...>
+
+```
+
+## Exception handling
+
+Every method call can throw `APIError` and `APIAuthenticationError`.
+
+`APIError` is thrown when the API returned an unexpected http status code or if something goes wrong with the request (network failure, for example). You can retrieve it by calling the `status` method in the exception, along with the `errors` method, which returns the api response payload, which might include additional details. As any subclass of `StandardError` it also responds to `message`.
+
+`APIAuthenticationError` indicates that the credentials used to authenticate were considered invalid by the API.
+
+## How to Contribute
+
+If you have found a bug or if you have a feature request, please report them at this repository issues section.
+
+### Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "incognia"
+
+# 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/fixtures/vcr_cassettes/token.yml

@@ -0,0 +1,101 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://incognia.inloco.com.br/api/v2/token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.4.2
+      Authorization:
+      - Basic R1BXSzFMQ1paSW8xRkxPQ0NuTExNcU44UWkxSHYzazQ6RUxHOV8yazU5T0hkMUdiVXhIaGRTdGtqZUI3TXlQZ21vRjhlR2YxM0xBMU1scmZRZ1Q1bkhFMmFIaVNobVc0WA==
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Fri, 28 May 2021 18:35:32 GMT
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      cf-cache-status:
+      - DYNAMIC
+      cf-request-id:
+      - 0a55dba85a0000db787b9d4000000001
+      expect-ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      report-to:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v2?s=TNlC7ygzRcV1NVUH05toX7rM1LCh0iEmsEwDAp%2Bmruqc6hMLyH%2Bb4cUreSYsSI96oTX%2FVfOnOzWPNZ5eYZwGww6giYqd97ZXMHfLpU7A%2BuiFoCyVeeqTCIRgsmZ1O787%2F2rN"}],"group":"cf-nel","max_age":604800}'
+      nel:
+      - '{"report_to":"cf-nel","max_age":604800}'
+      strict-transport-security:
+      - max-age=15552000; includeSubDomains; preload
+      x-content-type-options:
+      - nosniff
+      server:
+      - cloudflare
+      cf-ray:
+      - 65699553cdf2db78-GIG
+      alt-svc:
+      - h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJFVkNPVGMwTkVaRk9EVTFNekUzTlVRMFEwSTNNekZDTVVFeE5ESkdSREJHUWpkQlFVSTVNUSJ9.eyJodHRwczovL2FjY291bnRzL29yZ2FuaXphdGlvbl9pZCI6IjQ5MSIsImlzcyI6Imh0dHBzOi8vaW5sb2NvLXByb2R1Y3Rpb24uYXV0aDAuY29tLyIsInN1YiI6IkdQV0sxTENaWklvMUZMT0NDbkxMTXFOOFFpMUh2M2s0QGNsaWVudHMiLCJhdWQiOiJodHRwczovL2luY29nbmlhLmlubG9jby5jb20uYnIiLCJpYXQiOjE2MjIyMjY5MzIsImV4cCI6MTYyMjIyODEzMiwiYXpwIjoiR1BXSzFMQ1paSW8xRkxPQ0NuTExNcU44UWkxSHYzazQiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMifQ.Csc3cJ4eqzqR4s-aLh5Qvdl41LrTyD2DnBe3iNv4gtwzAVqRD6rdTxZAfKzWwOdYZ91bw0o1aCVN7MA3fGj6dUqkgtylvCFdWVTU5xWlW6ugaZ6VMRuPmJkD0DkZuctjXkFl_Um9mw-_M-84CqSvrVqFHDK_AJrdymztcsc_aoFKVMDLFgn-gHBNT9TchLatePHFeRKa6S3IaevcR900DiAmeU4_BKvVYc_TlhS4iIJGwIXUNX4V2x-76CxSs6aFFJD3t76x1GehGdrjmxzis-ciWZrhflSWSFq_2M4kWFiCIiCgiFe0pln0JUG-u9Hm5yu5S3dPJ46Br3kg8MOZJQ","expires_in":"1200","token_type":"Bearer"}'
+  recorded_at: Fri, 28 May 2021 18:35:30 GMT
+- request:
+    method: post
+    uri: https://incognia.inloco.com.br/api/onboarding/signups
+    body:
+      encoding: UTF-8
+      string: '{"installation_id":"xyz"}'
+    headers:
+      User-Agent:
+      - Faraday v1.4.2
+      Authorization:
+      - Bearer access_token
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      date:
+      - Fri, 28 May 2021 18:35:33 GMT
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      cf-cache-status:
+      - DYNAMIC
+      cf-request-id:
+      - 0a55dbadde000009d0c5074000000001
+      expect-ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      report-to:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v2?s=wRYcemb6TiPJlpWuANxj0o5Qq05jbH3gynAJX%2FNI8ErLVVffL65N7zUFJfOhFs1U9bUZqEUCkKOgJaD%2B%2FKYe%2FjeL4oPo%2FGyc3Ax1vvz4TCIOTEVMpRd%2FcCO1J11ulga8bve0"}],"group":"cf-nel","max_age":604800}'
+      nel:
+      - '{"report_to":"cf-nel","max_age":604800}'
+      strict-transport-security:
+      - max-age=15552000; includeSubDomains; preload
+      x-content-type-options:
+      - nosniff
+      server:
+      - cloudflare
+      cf-ray:
+      - 6569955c9fcd09d0-GIG
+      alt-svc:
+      - h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400
+    body:
+      encoding: UTF-8
+      string: ''
+  recorded_at: Fri, 28 May 2021 18:35:31 GMT
+recorded_with: VCR 6.0.0

data/incognia.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/incognia/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "incognia_api"
+  spec.version       = Incognia::VERSION
+  spec.authors       = ["Guilherme Cavalcanti"]
+  spec.email         = ["guiocavalcanti@gmail.com"]
+
+  spec.summary       = "Official Ruby lib for communicating with Incognia API"
+  spec.description   = "Official Ruby lib for communicating with Incognia API"
+  spec.homepage      = "https://github.com/inloco/incognia-api-ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/inloco/incognia-api-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/inloco/incognia-api-ruby/blob/master/"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency('faraday')
+  spec.add_dependency('faraday_middleware')
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/incognia/address.rb

@@ -0,0 +1,108 @@
+require "ostruct"
+
+module Incognia
+  class Address
+    attr_reader :line, :coordinates, :structured
+
+    class Line
+      def initialize(address)
+        @address = address
+      end
+
+      def to_hash
+        { address_line: @address }
+      end
+    end
+
+    class Coordinates
+      def initialize(lat:, lng:)
+        @lat, @lng = lat, lng
+      end
+
+      def to_hash
+        { address_coordinates: { lat: @lat, lng: @lng } }
+      end
+    end
+
+    class Structured
+      attr_reader :locale, :country_name, :country_code, :state, :city, :borough,
+        :neighborhood, :state, :city, :borough, :neighborhood, :postal_code,
+        :street, :number, :complements
+
+      def initialize(locale: nil, country_name: nil, country_code: nil, \
+                     state: nil, city: nil, borough: nil, neighborhood: nil, \
+                     postal_code: nil, street: nil, number: nil, complements: nil)
+
+        @locale = locale
+        @country_name = country_name
+        @country_code = country_code
+        @state = state
+        @city = city
+        @borough = borough
+        @neighborhood = neighborhood
+        @postal_code = postal_code
+        @street = street
+        @number = number
+        @complements = complements
+      end
+
+      def to_hash
+        {
+          structured_address: {
+            locale: locale,
+            country_name: country_name,
+            country_code: country_code,
+            state: state,
+            city: city,
+            borough: borough,
+            neighborhood: neighborhood,
+            street: street,
+            number: number,
+            complements: complements,
+            postal_code: postal_code
+          }.select { |_,v| !v.nil? }
+        }
+      end
+    end
+
+    FORMATS = [:line, :coordinates, :structured].freeze
+
+    def initialize(line: nil, coordinates: {}, structured: {})
+      coordinates = Util.symbolize_names(coordinates)
+      structured = Util.symbolize_names(structured)
+
+      if line.nil? && coordinates.empty? && structured.empty?
+        raise ArgumentError.new(
+          "missing keyword: should be one of #{FORMATS.join(', ')}"
+        )
+      end
+
+      @line = build_line(line)
+      @coordinates = build_coordinates(coordinates)
+      @structured = build_structured(structured)
+    end
+
+    def to_hash
+      hash = {}
+      hash.merge!(@line.to_hash)
+      hash.merge!(@coordinates.to_hash)
+      hash.merge!(@structured.to_hash)
+      hash
+    end
+
+    protected
+
+    def build_coordinates(hash)
+      hash.empty? ? hash : Coordinates.new(**hash)
+    end
+
+    def build_line(raw_line = nil)
+      raw_line ? Line.new(raw_line) : {}
+    end
+
+    def build_structured(hash)
+      hash.empty? ? hash : Structured.new(**hash)
+    end
+
+  end
+end

data/lib/incognia/api.rb

@@ -0,0 +1,39 @@
+require "faraday"
+require "json"
+require "logger"
+require 'faraday_middleware'
+
+module Incognia
+  class Api
+    # business layer: uses the Client to build domain objects
+    # raises missing parameters errors
+    attr_accessor :connection
+
+    def initialize(client_id:, client_secret:)
+      @connection = Client.new(client_id: client_id,
+                               client_secret: client_secret,
+                               host: "https://api.incognia.com/api")
+    end
+
+    def register_signup(installation_id:, address: )
+      response = connection.request(
+        :post,
+        'v2/onboarding/signups',
+        installation_id: installation_id,
+        **address.to_hash
+      )
+
+      SignupAssessment.from_hash(response.body) if response.success?
+    end
+
+    def get_signup_assessment(signup_id:)
+      response = connection.request(
+        :get,
+        "v2/onboarding/signups/#{signup_id}"
+      )
+
+      SignupAssessment.from_hash(response.body) if response.success?
+    end
+  end
+
+end

data/lib/incognia/client.rb

@@ -0,0 +1,74 @@
+require "time"
+
+module Incognia
+  class Client
+    # TODO:
+    # (ok) http/adapter specific code
+    # (ok) raises network/authentication errors
+    # (ok) handles token refreshing ok
+    # future: handles retrying
+    attr_reader :connection
+
+    def initialize(client_id:, client_secret:, host:)
+      @client_id = client_id
+      @client_secret = client_secret
+      @host = host
+
+      @connection = Faraday.new(host) do |faraday|
+        faraday.adapter Faraday.default_adapter
+        faraday.request :json
+        faraday.response :json, content_type: /\bjson$/
+        # faraday.response :logger, nil, { headers: true, bodies: true }
+        faraday.response :raise_error
+      end
+    end
+
+    def request(method, endpoint = nil, data = nil, headers = {})
+      connection.send(method, endpoint, data, headers) do |r|
+        r.headers[Faraday::Request::Authorization::KEY] ||= Faraday::Request
+          .lookup_middleware(:authorization)
+          .header(:Bearer, credentials.access_token)
+      end
+    rescue Faraday::ClientError, Faraday::ServerError => e
+      raise APIError.new(e.to_s, e.response)
+    rescue Faraday::Error => e
+      raise APIError.new(e.to_s)
+    end
+
+    def credentials
+      @credentials = request_credentials if @credentials.nil? || @credentials.stale?
+
+      @credentials
+    end
+
+    protected
+
+    def request_credentials
+      basic_auth = Faraday::Request
+        .lookup_middleware(:basic_auth)
+        .header(@client_id, @client_secret)
+
+      response = connection.send(:post, 'v2/token') do |r|
+        r.headers[Faraday::Request::Authorization::KEY] = basic_auth
+      end
+
+      response.success? ? build_credentials(response) : nil
+    rescue Faraday::UnauthorizedError => e
+      raise APIAuthenticationError
+    rescue Faraday::Error => e
+      raise APIError.new(e.to_s)
+    end
+
+    def build_credentials(raw_response)
+      body = raw_response.body
+      response_date = raw_response.headers['Date']
+
+      properties = body.merge(
+        generated_at: response_date ? Time.parse(response_date) : Time.now
+      )
+
+      Credentials.from_hash(properties)
+    end
+
+  end
+end

data/lib/incognia/resources/api_resource.rb

@@ -0,0 +1,13 @@
+require 'delegate'
+
+module Incognia
+  class APIResource < SimpleDelegator
+    def self.from_hash(hash)
+      hash = hash.each_with_object({}) do |(k, v), h|
+        h[k] = v.is_a?(Hash) ? from_hash(v) : v
+      end
+
+      new(OpenStruct.new(hash))
+    end
+  end
+end

data/lib/incognia/resources/credentials.rb

@@ -0,0 +1,11 @@
+require 'ostruct'
+
+module Incognia
+  class Credentials < APIResource
+    STALE_BEFORE = 10
+
+    def stale?
+      Time.now >= (generated_at + expires_in.to_i - STALE_BEFORE)
+    end
+  end
+end

data/lib/incognia/resources/signup_assessment.rb

@@ -0,0 +1,5 @@
+require_relative "api_resource"
+
+module Incognia
+  class SignupAssessment < APIResource; end
+end

data/lib/incognia/util.rb

@@ -0,0 +1,19 @@
+module Incognia
+  module Util
+    def self.symbolize_names(object)
+      case object
+      when Hash
+        new_hash = {}
+        object.each do |key, value|
+          key = (begin key.to_sym; rescue StandardError; key end) || key
+          new_hash[key] = symbolize_names(value)
+        end
+        new_hash
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+  end
+end

data/lib/incognia/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Incognia
+  VERSION = "0.1.0"
+end

data/lib/incognia.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "incognia/version"
+require_relative "incognia/client"
+require_relative "incognia/util"
+require_relative "incognia/address"
+require_relative "incognia/api"
+
+require_relative "incognia/resources/api_resource"
+require_relative "incognia/resources/signup_assessment"
+require_relative "incognia/resources/credentials"
+
+module Incognia
+  class APIError < StandardError
+    attr_reader :message, :errors, :status
+
+    def initialize(message, response_info = {})
+      @status = response_info[:status]
+      @errors = response_info[:body]
+      @message = format_message(message)
+    end
+
+    def to_s
+      message
+    end
+
+    def format_message(initial_message)
+      message = "[HTTP #{status}]: #{initial_message}"
+      message += "\n#{errors}" if errors
+    end
+  end
+
+  class APIAuthenticationError < StandardError
+    def to_s
+      "Informed credentials failed"
+    end
+  end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: incognia_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guilherme Cavalcanti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Official Ruby lib for communicating with Incognia API
+email:
+- guiocavalcanti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/token.yml
+- incognia.gemspec
+- lib/incognia.rb
+- lib/incognia/address.rb
+- lib/incognia/api.rb
+- lib/incognia/client.rb
+- lib/incognia/resources/api_resource.rb
+- lib/incognia/resources/credentials.rb
+- lib/incognia/resources/signup_assessment.rb
+- lib/incognia/util.rb
+- lib/incognia/version.rb
+homepage: https://github.com/inloco/incognia-api-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/inloco/incognia-api-ruby
+  source_code_uri: https://github.com/inloco/incognia-api-ruby
+  changelog_uri: https://github.com/inloco/incognia-api-ruby/blob/master/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.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: Official Ruby lib for communicating with Incognia API
+test_files: []