persona-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ee36ffc57f06970c8199420290d73f294e6664fa3a742420837d3d15238b6c7
+  data.tar.gz: 637973e9ae19df541886e97e97694ca7c62bce3108e5df6a8efacb3b1bc91864
+SHA512:
+  metadata.gz: 85c6172d9f5b815de9cc999aa6c29e74edf95bd55b26e17c4e5c258b98c7883b155b8aecb4fb6ce926b72621f358b954b87907adf16bcf9717d33598d4de9630
+  data.tar.gz: 0b51f987d9e6e713f7047a5d379f7710b07e78d012256e0dbdccc99c6162d7074f051225f734e219d686ce1c3a917b4dd7bd45408a5fb6b1dad236666127b0f6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - lib/persona-ruby.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 150

data/CHANGELOG.md

@@ -0,0 +1 @@
+## [Unreleased]

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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 me@jordanell.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
+
+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. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. 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 temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. 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,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "faraday", ">= 2.0.1"
+
+group :development, :test do
+  gem "rake", "~> 13.0.6"
+  gem "rspec", "~> 3.12.0"
+  gem "rspec_junit_formatter", "~> 0.6.0"
+  gem "rubocop", "~> 1.52.1"
+  gem "rubocop-rspec", "~> 2.22.0"
+  gem "webmock", "~> 3.18.1"
+end

data/Gemfile.lock

@@ -0,0 +1,87 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    bigdecimal (3.1.7)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    hashdiff (1.1.0)
+    json (2.7.2)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.5)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.9.0)
+    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.3)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.2)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      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.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-23
+
+DEPENDENCIES
+  faraday (>= 2.0.1)
+  rake (~> 13.0.6)
+  rspec (~> 3.12.0)
+  rspec_junit_formatter (~> 0.6.0)
+  rubocop (~> 1.52.1)
+  rubocop-rspec (~> 2.22.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.5.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Riipen
+
+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,85 @@
+# persona-ruby
+Persona is a service which is used to collect, verify, understand and orchestrate customer identities.
+This API is designed to allow Ruby developers to interact with the Persona API programmatically.
+
+For reference, the Persona API documentation can be found here:
+
+https://docs.withpersona.com/docs
+
+## Install
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'persona-ruby'
+```
+
+Then `bundle install`.
+
+
+## Usage
+
+### API Client
+
+The Persona API client uses an access token to authenticate API requests.
+
+To obtain an access code you must visit the Persona Dashboard (https://app.withpersona.com/dashboard/api-keys).
+
+Then you can create a Persona API client.
+
+```ruby
+client = Persona::Client.new(
+    access_token: 'access_token', # Access token from authorization flow
+)
+```
+
+### API Endpoints
+
+For use of each endpoint please consult the [Persona API reference](https://docs.withpersona.com/reference/introduction).
+
+### List Inquiries
+
+[API docs](https://docs.withpersona.com/reference/list-all-inquiries)
+
+Example: `client.inquiry_list()`
+
+### Get Inquiry
+
+[API docs](https://docs.withpersona.com/reference/retrieve-an-inquiry)
+
+Example: `client.inquiry_get('abcd1234')`
+
+### Create Inquiry
+
+[API docs](https://docs.withpersona.com/reference/create-an-inquiry)
+
+Example: `client.inquiry_create(data = {"attribute1": "abc", "attribute2": "vcdf"})`
+
+### Update Inquiry Update
+
+[API docs](https://docs.withpersona.com/reference/update-an-inquiry)
+
+Example: `client.inquiry_update('abcd1234', data = {"attribute1": "abc", "attribute2": "vcdf"})`
+
+### Delete Inquiry
+
+[API docs](https://docs.withpersona.com/reference/redact-an-inquiry)
+
+Example: `client.inquiry_update('abcd1234')`
+
+### Errors
+
+Any error code returned by the Persona API will result in one of the following expections
+
+|Code|Exception|
+|----|---------|
+|400| Persona::BadRequest|
+|401| Persona::Unauthorized|
+|403| Persona::Forbidden|
+|404| Persona::NotFound|
+|429| Persona::TooManyRequests|
+|400...499| Persona::ClientError|
+|500| Persona::InternalServerError|
+|502| Persona::BadGateway|
+|503| Persona::ServiceUnavailable|
+|500...599| Persona::ServerError|

data/Rakefile

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

data/lib/persona-ruby/actions/inquiries.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Persona
+  module Actions
+    module Inquiries
+      def inquiry_list
+        connection.get("inquiries", {})
+      end
+
+      def inquiry_get(id)
+        connection.get("inquiries/#{id}", {})
+      end
+
+      def inquiry_create(attributes = {})
+        connection.post("inquiries", {data: { attributes:}})
+      end
+
+      def inquiry_update(id, attributes = {})
+        connection.patch("inquiries/#{id}", {data: {attributes:}})
+      end
+
+      def inquiry_delete(id)
+        connection.delete("inquiries/#{id}", {})
+      end
+    end
+  end
+end

data/lib/persona-ruby/client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Persona
+  class Client
+    include Persona::Actions::Inquiries
+    attr_reader :url
+
+    BASE_URL = "https://withpersona.com/api/v1"
+
+    def initialize(access_token:)
+      @access_token = "Bearer #{access_token}"
+      @url = BASE_URL
+    end
+
+    def connection
+      Connection.new(@url, @access_token)
+    end
+  end
+end

data/lib/persona-ruby/connection.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Persona
+  class Connection
+    def initialize(url, auth_token)
+      @connection = Faraday.new(url: url) do |builder|
+        builder.request :json
+        builder.headers[:accept] = "application/json"
+        builder.response :json
+        builder.request :authorization, auth_token, ""
+      end
+    end
+
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def patch(path, params = {})
+      request(:patch, path, params)
+    end
+
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    def request(method, path, params = {})
+      response = @connection.send(method, path, params)
+
+      error = Error.from_response(response)
+
+      raise error if error
+
+      response.body
+    end
+  end
+end

data/lib/persona-ruby/error.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Persona
+  class Error < StandardError
+    attr_reader :response
+
+    def self.from_response(response)
+      klass =
+        case response.status
+        when 400 then BadRequest
+        when 401 then Unauthorized
+        when 403 then Forbidden
+        when 404 then NotFound
+        when 429 then TooManyRequests
+        when 400..499 then ClientError
+        when 500 then InternalServerError
+        when 502 then BadGateway
+        when 503 then ServiceUnavailable
+        when 500..599 then ServerError
+        end
+
+      klass&.new(response)
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil?
+
+      @response.body
+    end
+  end
+
+  class ClientError < Error; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+  class Forbidden < Error; end
+  class NotFound < Error; end
+  class TooManyRequests < Error; end
+  class ServerError < Error; end
+  class InternalServerError < Error; end
+  class ServiceUnavailable < Error; end
+  class BadGateway < Error; end
+end

data/lib/persona-ruby/version.rb

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

data/lib/persona-ruby.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require "persona-ruby/actions/inquiries"
+require "persona-ruby/client"
+require "persona-ruby/connection"
+require "persona-ruby/error"
+require "persona-ruby/version"

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: persona-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ravi Trivedi
+- Stephen Tredger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Access the Persona REST API.
+email:
+- stephen.tredger@riipen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/persona-ruby.rb
+- lib/persona-ruby/actions/inquiries.rb
+- lib/persona-ruby/client.rb
+- lib/persona-ruby/connection.rb
+- lib/persona-ruby/error.rb
+- lib/persona-ruby/version.rb
+homepage: https://github.com/riipen/persona-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/riipen/persona-ruby
+  source_code_uri: https://github.com/riipen/persona-ruby
+  changelog_uri: https://github.com/riipen/persona-ruby/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.5.3
+signing_key:
+specification_version: 4
+summary: An API client for Persona in ruby.
+test_files: []