persona_api 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3365bb039dfa2864780f8f54261ea2dea92d394a9328050b78bab7621a76984f
+  data.tar.gz: c46c19b74478670148948453c5faf8cad81a7d27c528deebc9a788ab4b61dff5
+SHA512:
+  metadata.gz: 398ff5050ea4593c0542531cc2c75f523bbc4b5e5328728a4fed7a9938cd9b50533b654162ea13ecc67525b1d62e2e5441772b0e4f3e69d123cb0a04882f58ae
+  data.tar.gz: 305d8e1af2b69ebd632acdefad1a146654b8d60e0f024f3853b4fe3d4bf61e18e1547646cd59de62412d2cf6e08f040bcceb4e9d58158b6de894e36b5053adca

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+== [0.1.6] - 2022-07-14
+
+* Update README.md
+* Add Api Logs, User Audit Logs, List Items endpoints
+
+== [0.1.5] - 2022-07-11
+
+* Update README.md
+* Add Lists, Events, and Files endpoints
+* Minor bug fixes
+
+== [0.1.4] - 2022-07-10
+
+* Update README.md
+* Add Documents and Reports endpoints
+* Minor bug fixes
+
+== [0.1.3] - 2022-07-09
+
+* Update README.md
+* Minor bug fixes
+
+== [0.1.2] - 2022-07-09
+
+* Update README.md
+* Complete Inquiries and add Case endpoints
+* Update gemspec
+
+== [0.1.1] - 2022-07-09
+
+* Update README.md
+* Include Accounts, Inquiries, and Verifications endpoints
+
+== [0.1.0] - 2022-07-05
+
+* Hello world!

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,72 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mattgriffith0@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident. Enforcement guidelines are listed below. These guidelines are strict and will be applied with zeal - assholes will not be tolerated.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a permanent ban.
+
+### 2. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in persona_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    persona_api (0.1.5)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    multipart-post (2.2.3)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  persona_api!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Matt Griffith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,179 @@
+# PersonaApi
+
+The easiest and most complete rubygem for the [Persona](https://withpersona.com/) API. Currently supports [API v1](https://docs.withpersona.com/reference/introduction)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'persona_api', github: "mattgriffith0/persona_api"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install persona_api
+
+## Usage
+
+To access the API, you'll need to create a `PersonaAPI::Client` and pass in your API key. You can find your API key in your [Persona dashboard](https://app.withpersona.com/dashboard/api-configuration).
+
+```ruby
+client = PersonaApi::Client.new(api_key: ENV["PERSONA_API_KEY"])
+```
+The client then gives you access to all of the resources.
+
+## Resources
+
+The gem attempts to map as closely as possible to the Persona API so that you can easily convert API examples in to gem code.
+
+Responses are (in *almost* all cases) created as Objects like `PersonaAPI::Account`. Having types like `PersonaAPI::Inquiry` is useful for understanding the type of object you're working with. They're built using OpenStruct so that data is easily accessible in a Rubyish way.
+
+##### Pagination
+
+ `list` endpoints return pages of results. The result object will have a `data` key to access the results, as well as metadata like `next_page` and `prev_page` for retrieving the next and previous pages. You may also specify the number of results you would like to have returned and, for some resources, other specific filter params.
+
+```ruby
+results = client.inquiries.list("page[size]": 5)
+#=> PersonaAPI::Collection
+
+results.data
+#=> [#<PersonaAPI::Inquiry>, #<PersonaAPI::Inquiry>]
+
+results.next_page
+#=> "inq_NiHBQW47WfdPT58m4VcqFebx"
+
+# Retrieve the next page
+client.inquiries.list("page[size]": 5, "page[after]": results.next_page)
+#=> PersonaAPI::Collection
+```
+
+### Accounts
+
+```ruby
+client.accounts.list
+client.accounts.create({})
+client.accounts.retrieve(act_id: "id")
+client.accounts.update(act_id: "id", {})
+client.accounts.redact(act_id: "id")
+client.accounts.add_tag(act_id: "id", {})
+client.accounts.remove_tag(act_id: "id", {})
+client.accounts.set_all_tags(act_id: "id", {})
+```
+
+### API Logs
+
+```ruby
+client.api_logs.list
+client.api_logs.retrieve(req_id: "id")
+```
+
+### Cases
+
+```ruby
+client.cases.list
+client.cases.create({})
+client.cases.retrieve(case_id: "id")
+client.cases.assign(case_id: "id", {})
+client.cases.set_status(case_id: "id", {})
+client.cases.add_persona_objects(case_id: "id", {})
+```
+
+### Documents
+
+```ruby
+client.documents.retrieve(doc_id: "id")
+```
+
+### Events
+
+```ruby
+client.events.list
+client.events.retrive(evt_id:)
+```
+
+### Files
+
+```ruby
+client.files.download(file_id:, file_name:)
+```
+
+### Inquiries
+
+```ruby
+client.inquiries.list
+client.inquiries.create({})
+client.inquiries.retrieve(inq_id: "id")
+client.inquiries.update(inq_id: "id", {})
+client.inquiries.redact(inq_id: "id")
+client.inquiries.add_tag(inq_id: "id", {})
+client.inquiries.remove_tag(inq_id: "id", {})
+client.inquiries.set_all_tags(inq_id: "id", {})
+client.inquiries.resume(inq_id: "id")
+client.inquiries.approve(inq_id: "id", {})
+client.inquiries.decline(inq_id: "id", {})
+```
+
+### Lists
+
+```ruby
+client.lists.list
+client.lists.retrieve(lst_id: "id")
+client.lists.archive(lst_id: "id")
+client.lists.create_browser_fingerprint_list({})
+client.lists.create_country_list({})
+client.lists.create_email_address_list({})
+client.lists.create_face_list({})
+client.lists.create_geolocation_list({})
+client.lists.create_government_id_number_list({})
+client.lists.create_ip_address_list({})
+client.lists.create_name_list({})
+client.lists.create_phone_number_list({})
+```
+
+### Reports
+
+```ruby
+client.reports.list
+client.reports.create({})
+client.reports.retrieve(rep_id: "id")
+client.reports.redact(rep_id: "id")
+client.reports.add_tag(rep_id: "id", {})
+client.reports.remove_tag(rep_id: "id", {})
+client.reports.set_all_tags(rep_id: "id", {})
+```
+
+### User Audit Logs
+
+```ruby
+client.user_audit_logs.list
+client.user_audit_logs.retrieve(ual_id: "id")
+```
+
+### Verifications
+
+```ruby
+client.verifications.retrieve(ver_id: "id")
+```
+
+## 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. This will create a `@client` for you to use, assuming you have assigned an API key to `ENV["PERSONA_API_KEY"]`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mattgriffith0/persona_api. 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/mattgriffith0/persona_api/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the PersonaApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattgriffith0/persona_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Thanks
+Massive thanks to [Chris Oliver](https://github.com/excid3), whose Vultr gem served as inspiration.
+
+## License
+
+[The MIT License (MIT)](https://github.com/mattgriffith0/persona_api/blob/main/LICENSE.txt)

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: :spec

data/lib/persona_api/client.rb

@@ -0,0 +1,70 @@
+require "faraday"
+require "faraday_middleware"
+
+module PersonaApi
+  class Client
+    BASE_URL = 'https://withpersona.com/api/v1/'
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter)
+      @api_key = api_key
+      @adapter = adapter
+    end
+
+    def accounts
+      AccountsResource.new(self)
+    end
+
+    def api_logs
+      ApiLogsResource.new(self)
+    end
+
+    def cases
+      CasesResource.new(self)
+    end
+
+    def documents
+      DocumentsResource.new(self)
+    end
+
+    def events
+      EventsResource.new(self)
+    end
+
+    def inquiries
+      InquiriesResource.new(self)
+    end
+
+    def lists
+      ListsResource.new(self)
+    end
+
+    def list_items
+      ListItemsResource.new(self)
+    end
+
+    def reports
+      ReportsResource.new(self)
+    end
+
+    def user_audit_logs
+      UserAuditLogsResource.new(self)
+    end
+
+    def verifications
+      VerificationsResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |connection|
+        connection.url_prefix = BASE_URL
+        connection.request :authorization, :Bearer, api_key
+        connection.headers['Key-Inflection'] = "snake"
+        connection.request :json
+        connection.response :json, content_type: "application/json"
+        connection.adapter adapter
+      end
+    end
+  end
+end

data/lib/persona_api/collection.rb

@@ -0,0 +1,20 @@
+module PersonaApi
+  class Collection
+    attr_reader :data, :next_page, :prev_page
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      new(
+        data: body[key].map{ |attrs| type.new(attrs) },
+        next_page: body.dig("links", "next"),
+        prev_page: body.dig("links", "prev")
+      )
+    end
+
+    def initialize(data:, next_page:, prev_page:)
+      @data = data
+      @next_page = next_page.nil? ? nil : data.last.id
+      @prev_page = prev_page.nil? ? nil : data.first.id
+    end
+  end
+end

data/lib/persona_api/error.rb

@@ -0,0 +1,3 @@
+module PersonaApi
+  class Error < StandardError; end
+end

data/lib/persona_api/object.rb

@@ -0,0 +1,18 @@
+require "ostruct"
+
+module PersonaApi
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      true
+    end
+  end
+end

data/lib/persona_api/objects/account.rb

@@ -0,0 +1,7 @@
+module PersonaApi
+  class Account < Object
+    def reference_id
+      attributes.reference_id
+    end
+  end
+end

data/lib/persona_api/objects/api_log.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class ApiLog < Object
+  end
+end

data/lib/persona_api/objects/case.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class Case < Object
+  end
+end

data/lib/persona_api/objects/document.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class Document < Object
+  end
+end

data/lib/persona_api/objects/event.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class Event < Object
+  end
+end

data/lib/persona_api/objects/file.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class File < Object
+  end
+end

data/lib/persona_api/objects/inquiry.rb

@@ -0,0 +1,28 @@
+module PersonaApi
+  class Inquiry < Object
+    def account
+      # return the account id token associated with this inquiry
+      relationships.account.data.id
+    end
+
+    def completed?
+      attributes.completed_at.nil? ? false : true
+    end
+    
+    def expired?
+      attributes.expired_at.nil? ? false : true
+    end
+
+    def failed?
+      attributes.failed_at.nil? ? false : true
+    end
+    
+    def redacted?
+      attributes.redacted_at.nil? ? false : true
+    end
+
+    def started?
+      attributes.started_at.nil? ? false: true
+    end
+  end
+end

data/lib/persona_api/objects/list.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class List < Object
+  end
+end

data/lib/persona_api/objects/list_item.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class ListItem < Object
+  end
+end

data/lib/persona_api/objects/report.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class Report < Object
+  end
+end

data/lib/persona_api/objects/user_audit_log.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class UserAuditLog < Object
+  end
+end

data/lib/persona_api/objects/verification.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class Verification < Object
+  end
+end

data/lib/persona_api/resource.rb

@@ -0,0 +1,49 @@
+module PersonaApi
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      
+      case response.status
+      when 400
+        raise Error, "The request was unacceptable, often due to invalid parameters."
+      when 401
+        raise Error, "Not authenticated - check your API key"
+      when 403
+        raise Error, "The given API key doesn't have permissions to perform the request or a quota has been exceeded."
+      when 404
+        raise Error, "The requested resource doesn't exist."
+      when 429
+        raise Error, "Your organization's rate limit has been exceeded. We recommend an exponential backoff on requests."
+      when 500
+        raise Error, "Something went wrong on Persona's end."
+      end
+
+      response
+    end
+  end
+end

data/lib/persona_api/resources/accounts.rb

@@ -0,0 +1,42 @@
+module PersonaApi
+  class AccountsResource < Resource
+    def add_tag(act_id:, **attributes)
+      post_request("accounts/#{act_id}/add-tag", body: attributes)
+      true
+    end
+
+    def consolidate_accounts(act_id:, **attributes)
+      post_request("accounts/#{act_id}/consolidate", body: attributes).body.dig("data")
+    end
+
+    def create(**attributes)
+      Account.new post_request("inquiries", body: attributes).body.dig("data")
+    end
+
+    def list(**params)
+      Collection.from_response get_request("accounts", params: params), key: "data", type: Account
+    end
+
+    def retrieve(act_id:)
+      Account.new get_request("accounts/#{act_id}").body.dig("data")
+    end
+
+    def redact(act_id:)
+      delete_request("accounts/#{act_id}")
+    end
+
+    def remove_tag(act_id:, **attributes)
+      post_request("accounts/#{act_id}/remove-tag", body: attributes)
+      true
+    end
+
+    def set_all_tags(act_id:, **attributes)
+      post_request("accounts/#{act_id}/set-tags", body: attributes)
+      true
+    end
+
+    def update(act_id:, **attributes)
+      patch_request("accounts/#{act_id}", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/api_logs.rb

@@ -0,0 +1,11 @@
+module PersonaApi
+  class ApiLogsResource < Resource
+    def list(**params)
+      Collection.from_response get_request("api-logs", params: params), key: "data", type: ApiLog
+    end
+
+    def retrieve(req_id:)
+      ApiLog.new get_request("api-logs/#{req_id}").body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/cases.rb

@@ -0,0 +1,28 @@
+module PersonaApi
+  class CasesResource < Resource
+    def add_persona_objects(case_id:, **attributes)
+      Case.new post_request("cases/#{case_id}/add-objects", body: attributes).body.dig("data")
+    end
+
+    def assign(case_id:, **attributes)
+      Case.new post_request("cases/#{case_id}/assign", body: attributes).body.dig("data")
+    end
+
+    def create(**attributes)
+      # cases attributes must include the 'case-template-id'
+      Case.new post_request("cases", body: attributes).body
+    end
+
+    def list(**params)
+      Collection.from_response get_request("cases", params: params), key: "data", type: Case
+    end
+
+    def retrieve(case_id:)
+      Case.new get_request("cases/#{case_id}").body
+    end
+
+    def set_status(case_id:, **attributes)
+      Case.new post_request("cases/#{case_id}/set-status", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/documents.rb

@@ -0,0 +1,7 @@
+module PersonaApi
+  class DocumentsResource < Resource
+    def retrieve(doc_id:)
+      Document.new get_request("documents/#{doc_id}").body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/events.rb

@@ -0,0 +1,11 @@
+module PersonaApi
+  class EventsResource < Resource
+    def list(**params)
+      Collection.from_response get_request("events", params: params), key: "data", type: Event
+    end
+
+    def retrieve(evt_id:)
+      Event.new get_request("events/#{evt_id}").body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/files.rb

@@ -0,0 +1,8 @@
+module PersonaApi
+  class FilesResource < Resource
+    def download(file_id:, file_name:)
+      get_request("files/#{file_id}/#{file_name}").body.dig("data")
+      true
+    end
+  end
+end

data/lib/persona_api/resources/inquiries.rb

@@ -0,0 +1,52 @@
+module PersonaApi
+  class InquiriesResource < Resource
+    def add_tag(inq_id:, **attributes)
+      post_request("inquiries/#{inq_id}/add-tag", body: attributes)
+      true
+    end
+
+    def approve(inq_id:, **attributes)
+      post_request("inquiries/#{inq_id}/approve", body: attributes)
+    end
+
+    def create(**attributes)
+      # inquiry attributes must include one of 'template-id' or 'inquiry-template-id'
+      Inquiry.new post_request("inquiries", body: attributes).body.dig("data")
+    end
+
+    def decline(inq_id:, **attributes)
+      post_request("inquiries/#{inq_id}/decline", body: attributes)
+    end
+
+    def list(**params)
+      Collection.from_response get_request("inquiries", params: params), key: "data", type: Inquiry
+    end
+
+    def retrieve(inq_id:)
+      Inquiry.new get_request("inquiries/#{inq_id}").body.dig("data")
+    end
+
+    def redact(inq_id:)
+      delete_request("inquiries/#{inq_id}")
+    end
+
+    def remove_tag(inq_id:, **attributes)
+      post_request("inquiries/#{inq_id}/remove-tag", body: attributes)
+      true
+    end
+
+    def resume(inq_id:, **attributes)
+      # this request will return only the session_token
+      post_request("inquiries/#{inq_id}/resume", body: attributes).body.dig("meta", "session_token")
+    end
+
+    def set_all_tags(inq_id:, **attributes)
+      post_request("inquiries/#{inq_id}/set-tags", body: attributes)
+      true
+    end
+
+    def update(inq_id:, **attributes)
+      Inquiry.new patch_request("inquiries/#{inq_id}", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/list_items.rb

@@ -0,0 +1,79 @@
+module PersonaApi
+  class ListItemsResource < Resource
+    # These archive requests will return the body of the response. This is slightly different
+    # from other endpoints with redact/archive requests, as the List Items endpoint doesn't
+    # contain a `retrieve` method.
+
+    def archive_browser_fingerprint_list_item(libf_id:)
+      delete_request("list-item/browser-fingerprints/#{libf_id}").body.dig("data")
+    end
+
+    def archive_country_list_item(libf_id:)
+      delete_request("list-item/countries/#{libf_id}").body.dig("data")
+    end
+
+    def archive_email_address_list_item(libf_id:)
+      delete_request("list-item/email-addresses/#{libf_id}").body.dig("data")
+    end
+
+    def archive_face_list_item(libf_id:)
+      delete_request("list-item/faces/#{libf_id}").body.dig("data")
+    end
+
+    def archive_geolocation_list_item(libf_id:)
+      delete_request("list-item/geolocations#{libf_id}").body.dig("data")
+    end
+
+    def archive_government_id_number_list_item(libf_id:)
+      delete_request("list-item/government-id-numbers#{libf_id}").body.dig("data")
+    end
+
+    def archive_ip_address_list_item(libf_id:)
+      delete_request("list-item/ip-addresses#{libf_id}").body.dig("data")
+    end
+
+    def archive_name_list_item(libf_id:)
+      delete_request("list-item/names#{libf_id}").body.dig("data")
+    end
+
+    def archive_phone_number_list_item(libf_id:)
+      delete_request("list-item/phone-numbers#{libf_id}").body.dig("data")
+    end
+
+    def create_browser_fingerprint_list_item(**attributes)
+      ListItem.new post_request("list-item/browser-fingerprints", body: attributes).body.dig("data")
+    end
+
+    def create_country_list_item(**attributes)
+      ListItem.new post_request("list-item/countries", body: attributes).body.dig("data")
+    end
+
+    def create_email_address_list_item(**attributes)
+      ListItem.new post_request("list-item/email-addresses", body: attributes).body.dig("data")
+    end
+
+    def create_face_list_item(**attributes)
+      ListItem.new post_request("list-item/faces", body: attributes).body.dig("data")
+    end
+
+    def create_geolocation_list_item(**attributes)
+      ListItem.new post_request("list-item/geolocations", body: attributes).body.dig("data")
+    end
+
+    def create_government_id_number_list_item(**attributes)
+      ListItem.new post_request("list-item/government-id-numbers", body: attributes).body.dig("data")
+    end
+
+    def create_ip_address_list_item(**attributes)
+      ListItem.new post_request("list-item/ip-addresses", body: attributes).body.dig("data")
+    end
+
+    def create_name_list_item(**attributes)
+      ListItem.new post_request("list-item/names", body: attributes).body.dig("data")
+    end
+
+    def create_phone_number_list_item(**attributes)
+      ListItem.new post_request("list-item/phone-numbers", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/lists.rb

@@ -0,0 +1,51 @@
+module PersonaApi
+  class ListsResource < Resource
+    def list(**params)
+      Collection.from_response get_request("lists", params: params), key: "data", type: List
+    end
+
+    def retrieve(lst_id:)
+      List.new get_request("lists/#{lst_id}").body.dig("data")
+    end
+
+    def archive(lst_id:)
+      delete_request("lists/#{lst_id}")
+    end
+
+    def create_browser_fingerprint_list(**attributes)
+      List.new post_request("lists/browser-fingerprints", body: attributes).body.dig("data")
+    end
+
+    def create_country_list(**attributes)
+      List.new post_request("lists/countries", body: attributes).body.dig("data")
+    end
+
+    def create_email_address_list(**attributes)
+      List.new post_request("lists/email-addresses", body: attributes).body.dig("data")
+    end
+
+    def create_face_list(**attributes)
+      List.new post_request("lists/faces", body: attributes).body.dig("data")
+    end
+
+    def create_geolocation_list(**attributes)
+      List.new post_request("lists/geolocations", body: attributes).body.dig("data")
+    end
+
+    def create_government_id_number_list(**attributes)
+      List.new post_request("lists/government-id-numbers", body: attributes).body.dig("data")
+    end
+
+    def create_ip_address_list(**attributes)
+      List.new post_request("lists/ip-addresses", body: attributes).body.dig("data")
+    end
+
+    def create_name_list(**attributes)
+      List.new post_request("lists/names", body: attributes).body.dig("data")
+    end
+
+    def create_phone_number_list(**attributes)
+      List.new post_request("lists/phone-numbers", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/reports.rb

@@ -0,0 +1,37 @@
+module PersonaApi
+  class ReportsResource < Resource
+    def add_tag(rep_id:, **attributes)
+      post_request("reports/#{rep_id}/add-tag", body: attributes)
+      true
+    end
+
+    def create(**attributes)
+      # report attributes must include a 'report-template-id' as well as other fields as laid out
+      # in the documentation https://docs.withpersona.com/reference/supported-report-types-and-examples
+
+      Report.new post_request("reports", body: attributes).body.dig("data")
+    end
+
+    def list(**params)
+      Collection.from_response get_request("reports", params: params), key: "data", type: Report
+    end
+
+    def retrieve(rep_id:)
+      Report.new get_request("reports/#{rep_id}").body.dig("data")
+    end
+
+    def redact(rep_id:)
+      delete_request("reports/#{rep_id}")
+    end
+
+    def remove_tag(rep_id:, **attributes)
+      post_request("reports/#{rep_id}/remove-tag", body: attributes)
+      true
+    end
+
+    def set_all_tags(rep_id:, **attributes)
+      post_request("reports/#{rep_id}/set-tags", body: attributes)
+      true
+    end
+  end
+end

data/lib/persona_api/resources/user_audit_logs.rb

@@ -0,0 +1,11 @@
+module PersonaApi
+  class UserAuditLogsResource < Resource
+    def list(**params)
+      Collection.from_response get_request("user-audit-logs", params: params), key: "data", type: UserAuditLog
+    end
+
+    def retrieve(ual_id:)
+      ApiLog.new get_request("user-audit-logs/#{ual_id}").body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/verifications.rb

@@ -0,0 +1,7 @@
+module PersonaApi
+  class VerificationsResource < Resource
+    def retrieve(ver_id:)
+      Verification.new get_request("verifications/#{ver_id}").body.dig("data")
+    end
+  end
+end

data/lib/persona_api/version.rb

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

data/lib/persona_api.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "persona_api/version"
+
+module PersonaApi
+  autoload :Client, "persona_api/client"
+  autoload :Collection, "persona_api/collection"
+  autoload :Error, "persona_api/error"
+  autoload :Object, "persona_api/object"
+  autoload :Resource, "persona_api/resource"
+
+  # objects
+  autoload :Account, "persona_api/objects/account"
+  autoload :Inquiry, "persona_api/objects/inquiry"
+  autoload :Verification, "persona_api/objects/verification"
+  autoload :Case, "persona_api/objects/case"
+  autoload :Document, "persona_api/objects/document"
+  autoload :Report, "persona_api/objects/report"
+  autoload :File, "persona_api/objects/file"
+  autoload :Event, "persona_api/objects/event"
+  autoload :List, "persona_api/objects/list"
+  autoload :ApiLog, "persona_api/objects/api_log"
+  autoload :UserAuditLog, "persona_api/objects/user_audit_log"
+  autoload :ListItem, "persona_api/objects/list_item"
+
+  # resources
+  autoload :AccountsResource, "persona_api/resources/accounts"
+  autoload :InquiriesResource, "persona_api/resources/inquiries"
+  autoload :VerificationsResource, "persona_api/resources/verifications"
+  autoload :CasesResource, "persona_api/resources/cases"
+  autoload :DocumentsResource, "persona_api/resources/documents"
+  autoload :ReportsResource, "persona_api/resources/reports"
+  autoload :FilesResource, "persona_api/resources/files"
+  autoload :EventsResource, "persona_api/resources/events"
+  autoload :ListsResource, "persona_api/resources/lists"
+  autoload :ApiLogsResource, "persona_api/resources/api_logs"
+  autoload :UserAuditLogsResource, "persona_api/resources/user_audit_logs"
+  autoload :ListItemsResource, "persona_api/resoruces/list_items"
+end

data/sig/persona_api.rbs

@@ -0,0 +1,4 @@
+module PersonaApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: persona_api
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Matt Griffith
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Write more in here later.
+email:
+- mattgriffith0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/persona_api.rb
+- lib/persona_api/client.rb
+- lib/persona_api/collection.rb
+- lib/persona_api/error.rb
+- lib/persona_api/object.rb
+- lib/persona_api/objects/account.rb
+- lib/persona_api/objects/api_log.rb
+- lib/persona_api/objects/case.rb
+- lib/persona_api/objects/document.rb
+- lib/persona_api/objects/event.rb
+- lib/persona_api/objects/file.rb
+- lib/persona_api/objects/inquiry.rb
+- lib/persona_api/objects/list.rb
+- lib/persona_api/objects/list_item.rb
+- lib/persona_api/objects/report.rb
+- lib/persona_api/objects/user_audit_log.rb
+- lib/persona_api/objects/verification.rb
+- lib/persona_api/resource.rb
+- lib/persona_api/resources/accounts.rb
+- lib/persona_api/resources/api_logs.rb
+- lib/persona_api/resources/cases.rb
+- lib/persona_api/resources/documents.rb
+- lib/persona_api/resources/events.rb
+- lib/persona_api/resources/files.rb
+- lib/persona_api/resources/inquiries.rb
+- lib/persona_api/resources/list_items.rb
+- lib/persona_api/resources/lists.rb
+- lib/persona_api/resources/reports.rb
+- lib/persona_api/resources/user_audit_logs.rb
+- lib/persona_api/resources/verifications.rb
+- lib/persona_api/version.rb
+- sig/persona_api.rbs
+homepage: https://github.com/mattgriffith0/persona_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mattgriffith0/persona_api
+  source_code_uri: https://github.com/mattgriffith0/persona_api
+  changelog_uri: https://github.com/mattgriffith0/persona_api/blob/main/CHANGELOG.md
+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.3.7
+signing_key:
+specification_version: 4
+summary: An API wrapper for the public Persona API.
+test_files: []