tangany 0.0.1

data/README.md

@@ -0,0 +1,410 @@
+# Tangany Ruby Library
+
+[![CI](https://github.com/bitbond/tangany-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/bitbond/tangany-ruby/actions/workflows/ci.yml)
+
+The Tangany Ruby library provides convenient access to the Tangany APIs from applications written in the Ruby language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses.
+
+---
+
+## Installation
+
+You don't need this source code unless you want to modify the gem. If you just want to use the package, just run:
+
+```sh
+gem install tangany
+```
+
+If you want to build the gem from source:
+
+```sh
+gem build tangany.gemspec
+```
+
+### Requirements
+
+- Ruby 2.7.5+.
+
+### Bundler
+
+If you are installing via bundler, you should be sure to use the https rubygems source in your Gemfile, as any gems fetched over http could potentially be compromised in transit and alter the code of gems fetched securely over https:
+
+```ruby
+source "https://rubygems.org"
+
+gem "tangany"
+```
+
+---
+
+## Usage
+
+The library needs to be configured with your account's secrets.
+
+```ruby
+require "tangany"
+Tangany.client_id = "..."
+Tangany.client_secret = "..."
+Tangany.environment = "..." # mainnet or testnet
+Tangany.subscription = "..."
+Tangany.vault_url = "..."
+
+customers_client = Tangany::Customers::Client.new
+custody_client = Tangany::Custody::Client.new
+```
+
+---
+
+## Customers API
+
+### Natural persons
+
+#### List natural_persons
+
+```ruby
+collection = customers_client.natural_persons.list(limit: 21, sort: "asc", pageToken: "foo")
+```
+
+#### Create natural person
+
+```ruby
+natural_person = customers_client.natural_persons.create(
+  id: "ent_123456789",
+  title: "Mr",
+  firstName: "John",
+  lastName: "Doe",
+  gender: "M",
+  birthDate: "1980-01-01",
+  birthPlace: "Milano",
+  birthCountry: "IT",
+  birthName: "John",
+  nationality: "IT",
+  address: {
+    country: "IT",
+    city: "Milano",
+    postcode: "20100",
+    streetName: "Via Roma",
+    streetNumber: "1",
+  },
+  email: "john.doe@example.com",
+  kyc: {
+    id: "kyc_123456789",
+    date: "2021-01-01T00:00:00.000Z",
+    method: "video_ident",
+    document: {
+      country: "IT",
+      nationality: "IT",
+      number: "123456789",
+      issuedBy: "Milano",
+      issueDate: "2015-01-01",
+      validUntil: "2025-01-01",
+      type: "id_card"
+    }
+  },
+  pep: {
+    checkDate: "2021-01-01T00:00:00.000Z",
+    isExposed: true,
+    source: "PEP source",
+    reason: "PEP reason"
+  },
+  sanctions: {
+    checkDate: "2021-01-01T00:00:00.000Z",
+    isExposed: true,
+    source: "Sanctions source",
+    reason: "Sanctions reason"
+  }
+)
+```
+
+#### Retrieve natural person
+
+```ruby
+customer = customers_client.natural_persons.retrieve("ent_123456789")
+```
+
+#### Update natural person
+
+```ruby
+natural_person = customers_client.natural_persons.update(
+  "ent_123456789",
+  title: "Mr",
+  firstName: "John",
+  lastName: "Doe",
+  gender: "M",
+  birthDate: "1980-01-01",
+  birthPlace: "Milano",
+  birthCountry: "IT",
+  birthName: "John",
+  nationality: "IT",
+  address: {
+    country: "IT",
+    city: "Milano",
+    postcode: "20100",
+    streetName: "Via Roma",
+    streetNumber: "1",
+  },
+  email: "john.doe@example.com",
+  kyc: {
+    id: "kyc_123456789",
+    date: "2021-01-01T00:00:00.000Z",
+    method: "video_ident",
+    document: {
+      country: "IT",
+      nationality: "IT",
+      number: "123456789",
+      issuedBy: "Milano",
+      issueDate: "2015-01-01",
+      validUntil: "2025-01-01",
+      type: "id_card"
+    }
+  },
+  pep: {
+    checkDate: "2021-01-01T00:00:00.000Z",
+    isExposed: true,
+    source: "PEP source",
+    reason: "PEP reason"
+  },
+  sanctions: {
+    checkDate: "2021-01-01T00:00:00.000Z",
+    isExposed: true,
+    source: "Sanctions source",
+    reason: "Sanctions reason"
+  }
+)
+```
+
+#### Delete natural person
+
+```ruby
+response = customers_client.natural_persons.delete("ent_123456789")
+```
+
+### Customers
+
+#### List customers
+
+```ruby
+collection = customers_client.customers.list(limit: 21, sort: "asc", pageToken: "foo")
+```
+
+#### Create customer
+
+```ruby
+customer = customers_client.customers.create(
+  id: "cus_123456789",
+  owner: {
+    entityId: "ent_123456789",
+  },
+  authorized: {
+    entityId: "ent_123456789",
+  },
+  contracts: [{
+    type: "standard",
+    signedDate: "2020-09-04",
+  }]
+)
+```
+
+#### Retrieve customer
+
+```ruby
+customer = customers_client.customers.retrieve("cus_123456789")
+```
+
+#### Update customer
+
+```ruby
+customer = customers_client.customers.update(
+  "cus_123456789",
+  owner: {
+    entityId: "ent_123456789",
+  },
+  authorized: {
+    entityId: "ent_123456789",
+  },
+  contracts: [{
+    type: "standard",
+    signedDate: "2020-09-04",
+  }]
+)
+```
+
+#### Delete customer
+
+```ruby
+response = customers_client.customers.delete("cus_123456789")
+```
+
+### Wallet links
+
+#### List wallet links
+
+```ruby
+collection = customers_client.wallet_links.list(limit: 21, sort: "asc", pageToken: "foo")
+```
+
+#### Create wallet link
+
+With an address:
+
+```ruby
+wallet_link = customers_client.wallet_links.create(
+  id: "wl_123456789",
+  address: "0x1234567890abcdef1234567890abcdef12345678",
+  assetId: "ETH",
+  assignment: {
+    customerId: "cus_123456789",
+  }
+)
+```
+
+With a wallet:
+
+```ruby
+wallet_link = customers_client.wallet_links.create(
+  id: "wl_123456789",
+  wallet: "wal_123456789",
+  assetId: "ETH",
+  assignment: {
+    customerId: "cus_123456789",
+  }
+)
+```
+
+#### Retrieve wallet link
+
+```ruby
+wallet_link = customers_client.wallet_links.retrieve("wl_123456789")
+```
+
+---
+
+## Custody API
+
+See [lib/config/chains.json](lib/config/chains.json) for the list of available chains.
+
+### Wallets
+
+#### List wallets
+
+```ruby
+collection = custody_client.wallets.list(limit: 21, order: "wallet", sort: "asc", start: 42, tags: { tag0: "tag 0", tag1: "tag 1" }, xtags: { tag2: "tag 2", tag3: "tag 3" })
+```
+
+#### Create wallet
+
+```ruby
+wallet = custody_client.wallets.create(
+  wallet: "wal_123456789",
+  useHsm: false,
+  tags: [{
+    tag0: "tag 0"
+  }, {
+    tag1: "tag 1",
+  }, {
+    ...
+  }, {
+    tag9: "tag 9"
+  }]
+)
+```
+
+#### Retrieve wallet
+
+```ruby
+wallet = custody_client.wallets.retrieve("wal_123456789")
+```
+
+#### Update wallet
+
+```ruby
+wallet = custody_client.wallets.update(
+  "wal_123456789",
+  tags: [{
+    tag0: "tag 0"
+  }, {
+    tag1: "tag 1",
+  }, {
+    ...
+  }, {
+    tag9: "tag 9"
+  }]
+)
+```
+
+#### Delete wallet
+
+```ruby
+wallet_recovery = custody_client.customers.delete("wal_123456789")
+```
+
+### Wallet statuses
+
+#### Retrieve wallet status
+
+```ruby
+wallet_status = custody_client.wallet_statuses(assetId: "ETH").retrieve("wal_123456789")
+```
+
+---
+
+## Development
+
+### Git config
+
+Tell `git` where to find the project shared hooks:
+
+```bash
+git config core.hooksPath .githooks
+```
+
+### Interactive console
+
+```sh
+bin/console
+```
+
+### Testing
+
+If Tangany API changes, edit the `spec/factories` and the `spec/generators` accordingly, then run all tests:
+
+```sh
+rspec
+```
+
+Fixtures will be regenerated automatically each time you run the tests.
+
+It is also possible to run a test suite against the live API.
+
+> :warning: Be sure to set environment variables **not to production values** before running the following command!
+
+```sh
+bin/test-live
+```
+
+### Linting and code quality
+
+Run the linter:
+
+```sh
+rubocop
+```
+
+Run the code quality checker:
+
+```sh
+rake quality_check
+```
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bitbond/tangany-ruby. 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/bitbond/tangany-ruby/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 Tangany::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bitbond/tangany-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,133 @@
+require "byebug"
+require "bundler/gem_tasks"
+require "factory_bot"
+require "rspec/core/rake_task"
+
+require_relative "spec/generators"
+
+desc "Checks the quality of code and generate reports"
+task :quality_check do
+  puts
+  puts "== Patch-level verification for bundler ".ljust(80, "=")
+  puts
+  abort unless system("bundle-audit update && bundle-audit")
+
+  puts "== Quality report generation ".ljust(80, "=")
+  puts
+  paths = FileList.new(
+    "lib/**/*.rb"
+  ).join(" ")
+  abort unless system("rubycritic #{paths}")
+end
+
+desc "Regenerates the fixtures"
+task :regenerate_fixtures do
+  puts
+  puts "== Regenerating fixtures ".ljust(80, "=")
+
+  # Customers API
+
+  ## Natural persons
+
+  puts " -> Regenerating responses/customers/natural_persons/retrieve"
+  Tangany::Customers::NaturalPersonsResponsesGenerator.new.retrieve
+
+  puts " -> Regenerating inputs/customers/natural_persons/list"
+  Tangany::Customers::NaturalPersonsInputsGenerator.new.list
+
+  puts " -> Regenerating responses/customers/natural_persons/list"
+  Tangany::Customers::NaturalPersonsResponsesGenerator.new.list
+
+  puts " -> Regenerating inputs/customers/natural_persons/create"
+  Tangany::Customers::NaturalPersonsInputsGenerator.new.create
+
+  puts " -> Regenerating responses/customers/natural_persons/create"
+  Tangany::Customers::NaturalPersonsResponsesGenerator.new.create
+
+  puts " -> Regenerating inputs/customers/natural_persons/update"
+  Tangany::Customers::NaturalPersonsInputsGenerator.new.update
+
+  puts " -> Regenerating responses/customers/natural_persons/update"
+  Tangany::Customers::NaturalPersonsResponsesGenerator.new.update
+
+  puts " -> Regenerating responses/customers/natural_persons/delete"
+  Tangany::Customers::NaturalPersonsResponsesGenerator.new.delete
+
+  ## Customers
+
+  puts " -> Regenerating responses/customers/customers/retrieve"
+  Tangany::Customers::CustomersResponsesGenerator.new.retrieve
+
+  puts " -> Regenerating inputs/customers/customers/list"
+  Tangany::Customers::CustomersInputsGenerator.new.list
+
+  puts " -> Regenerating responses/customers/customers/list"
+  Tangany::Customers::CustomersResponsesGenerator.new.list
+
+  puts " -> Regenerating inputs/customers/customers/create"
+  Tangany::Customers::CustomersInputsGenerator.new.create
+
+  puts " -> Regenerating responses/customers/customers/create"
+  Tangany::Customers::CustomersResponsesGenerator.new.create
+
+  puts " -> Regenerating inputs/customers/customers/update"
+  Tangany::Customers::CustomersInputsGenerator.new.update
+
+  puts " -> Regenerating responses/customers/customers/update"
+  Tangany::Customers::CustomersResponsesGenerator.new.update
+
+  puts " -> Regenerating responses/customers/customers/delete"
+  Tangany::Customers::CustomersResponsesGenerator.new.delete
+
+  ## Wallet links
+
+  puts " -> Regenerating responses/customers/wallet_links/retrieve"
+  Tangany::Customers::WalletLinksResponsesGenerator.new.retrieve
+
+  puts " -> Regenerating inputs/customers/wallet-links/list"
+  Tangany::Customers::WalletLinksInputsGenerator.new.list
+
+  puts " -> Regenerating responses/customers/wallet_links/list"
+  Tangany::Customers::WalletLinksResponsesGenerator.new.list
+
+  puts " -> Regenerating inputs/customers/wallet_links/create"
+  Tangany::Customers::WalletLinksInputsGenerator.new.create
+
+  puts " -> Regenerating responses/customers/wallet_links/create"
+  Tangany::Customers::WalletLinksResponsesGenerator.new.create
+
+  puts " -> Regenerating responses/customers/wallet_links/delete"
+  Tangany::Customers::WalletLinksResponsesGenerator.new.delete
+
+  # Custody API
+
+  ## Wallet statuses
+
+  puts " -> Regenerating responses/custody/wallet_statuses/retrieve"
+  Tangany::Custody::WalletStatusesResponsesGenerator.new.retrieve
+
+  ## Wallets
+
+  puts " -> Regenerating responses/custody/wallets/retrieve"
+  Tangany::Custody::WalletsResponsesGenerator.new.retrieve
+
+  puts " -> Regenerating responses/custody/wallets/list"
+  Tangany::Custody::WalletsResponsesGenerator.new.list
+
+  puts " -> Regenerating inputs/custody/wallets/create"
+  Tangany::Custody::WalletsInputsGenerator.new.create
+
+  puts " -> Regenerating responses/custody/wallets/create"
+  Tangany::Custody::WalletsResponsesGenerator.new.create
+
+  puts " -> Regenerating inputs/custody/wallets/update"
+  Tangany::Custody::WalletsInputsGenerator.new.update
+
+  puts " -> Regenerating responses/custody/wallets/update"
+  Tangany::Custody::WalletsResponsesGenerator.new.update
+
+  puts " -> Regenerating responses/custody/wallets/delete"
+  Tangany::Custody::WalletsResponsesGenerator.new.delete
+
+  puts "== Fixtures regenerated ".ljust(80, "=")
+end

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "byebug"
+
+require "tangany"
+
+# 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
+
+Tangany.client_id = ENV.fetch("TEST_TANGANY_CLIENT_ID", "test")
+Tangany.client_secret = ENV.fetch("TEST_TANGANY_CLIENT_SECRET", "test")
+Tangany.environment = "testnet"
+Tangany.subscription = ENV.fetch("TEST_TANGANY_SUBSCRIPTION", "test")
+Tangany.vault_url = ENV.fetch("TEST_TANGANY_VAULT_URL", "test")
+
+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