setsuzoku 0.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aef3c39e156bb15569d8bf6de134794150fa92d13d09c90ebd2353db146abe5a
+  data.tar.gz: 0e583bdf0d58ef9e51ff614ccb604a8ac936c0e57f6c1d310bba7ec856539ffa
+SHA512:
+  metadata.gz: 8f4a10541b26ac6e634aa9f615d636961016667c85a80d371f67df0391c8267ef7c0123bd9e2bdbd9894b0e1d0a1bfdc8573f0d7df5afa53c5e269007e7ce8df
+  data.tar.gz: 21fe9ec50e376486befa73d5228a953e772db4f02372bd17da83984ecad29448679fbc9cc73c02c141afbf727c4fef6a34d55827a233a75be97e84a16168effc

data/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+sorbet/rbi/hidden-definitions/errors.txt
+
+# rspec failure tracking
+.rspec_status
+.idea

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in setsuzoku.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    setsuzoku (0.10.1)
+      activesupport (~> 5.0)
+      faraday (~> 0.11)
+      httparty (~> 0.16.4)
+      nokogiri (~> 1.10)
+      sorbet-runtime (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.5)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    sorbet (0.5.5675)
+      sorbet-static (= 0.5.5675)
+    sorbet-runtime (0.5.5786)
+    sorbet-static (0.5.5675-universal-darwin-14)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  setsuzoku!
+  sorbet (~> 0.5)
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Luke Stadtler
+
+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,93 @@
+# Setsuzoku
+We found ourselves writing lots of 3rd-party integration code
+that started to look really similar (lots of common API call, credential management and error handling logic).
+Additionally, we found that our application code was becoming too
+strongly coupled to a specific 3rd-party implementation. Heavily relying on the structures
+and conventions of a payment platform for instance, making our reliance on that vendor inseverable.
+
+Our solution was to build a generic interface layer between 3rd-party services and a ruby application.
+
+Setsuzoku lets you build and use plugins that can generically define behaviors expected with a 3rd party service.
+
+As an example: the first plugin we built was a mobile/sms plugin. It defines generic API actions
+for the application to consume. E.g. send_message, search_local, search_toll_free. With these defined 
+and your application configured to use this generalized plugin API adding a 3rd-party vendor implementation becomes much cleaner.
+All a new mobile/sms plugin is required to do is define its API actions, endpoints and any vendor-specific mapping required to normalize the requests and response.
+This way your application can interact with a plugin agnostic of how the plugin implements its methods under the hood.
+Meaning if you're using one 3rd-party vendor and  want to replace it, you simply create the new plugin, implement the methods you want
+and swap it out.
+
+To ensure plugins are holding up their end of the bargain the base plugin of a business use-case, e.g. billing/sms etc
+can define a spec for each API action it wants implemented. If a plugin implements this action it must
+satisfy the test's expectations. 
+
+Additionally, application code that relies on plugins has its data stubbed
+without relying on the evaluation of the plugin's code. To ensure the stubbed data upholds its contract
+we also test that the plugin's stub definition satisfy the data contract. 
+
+This ensures a base plugin has properly stubbed its data for application testing, and any implementation
+plugin has properly implemented the actions it chooses to implement.
+
+## Usage
+Any class in your application can register a plugin. By registering a plugin a class has established
+that is has dependence on a third-party service and would like off-load the busy work of interfacing to the plugin.
+To correctly register a plugin, often, a credential must be provided, as well as plugin specific parameters.
+
+Once registered your integration to the generic 3rd-party service should be pretty seamless and well decoupled from your application.
+
+####Our general practice as an example is this:
+
+First we define a base application class that will consume the plugin api actions.
+This should handle all logic and be able to interface w/ all plugins such that
+the code here is generic, and any changes should happen in the plugin implementations. 
+
+    MobileIntegration < ApplicationRecord
+        # Application work to do when sending a message
+        def send_message(body)
+          #this resp is generic regardless of the plugin
+          resp = plugin.send_message(body)
+          notify_customer(resp) if resp.success
+        end
+        ....
+    end
+
+Then we define 2 service specific implementations that will register plugins.
+You will also need to specify credential, and instance level methods here.
+   
+    FirstMobileIntegration < MobileIntegration
+        self.register_plugin(plugin_class: Setsuzoku::FirstMobilePlugin)
+    end
+
+    
+    SecondMobileIntegration < MobileIntegration
+        self.register_plugin(plugin_class: Setsuzoku::SecondMobilePlugin)
+    end
+    
+Now, as long as your application is getting an instance of the correct plugin.
+E.g. your application knows when to use  `FirstMobileIntegration` vs `SecondMobileIntegration`
+setsuzoku plugins should handle the request mapping/request transmission/response parsing/response mapping
+and return your application a nicely formatted exception handled response. Now your application can interface with 
+all these 3rd-parties in a simple to understand and common way.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'setsuzoku'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install setsuzoku
+```
+
+## Contributing
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "setsuzoku"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/lib/setsuzoku.rb

@@ -0,0 +1,37 @@
+# typed: true
+
+require 'faraday'
+require 'httparty'
+require 'nokogiri'
+require 'sorbet-runtime'
+require 'active_support'
+
+#Define base module for orchestrating configuration of classes
+module Setsuzoku
+
+  autoload :ApiResponse, 'setsuzoku/api_response'
+  autoload :ApiStrategy, 'setsuzoku/api_strategy'
+  autoload :AuthStrategy, 'setsuzoku/auth_strategy'
+  autoload :Credential, 'setsuzoku/credential'
+  autoload :Exception, 'setsuzoku/exception'
+  autoload :ExternalApiHandler, 'setsuzoku/external_api_handler'
+  autoload :Pluggable, 'setsuzoku/pluggable'
+  autoload :Service, 'setsuzoku/service' #needs to load before plugin
+  autoload :Plugin, 'setsuzoku/plugin'
+  autoload :Utilities, 'setsuzoku/utilities'
+  autoload :VERSION, 'setsuzoku/version'
+
+  @@external_api_handler = ExternalApiHandler
+
+  def self.external_api_handler
+    @@external_api_handler
+  end
+
+  def self.external_api_handler=(val)
+    @@external_api_handler = val
+  end
+
+  def self.configure
+    yield(self)
+  end
+end

data/lib/setsuzoku/api_response.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Setsuzoku
+  # The generic API response object that all API responses should return.
+  class ApiResponse < T::Struct
+    prop :data, T.nilable(T::Hash[Symbol, T.untyped]), default: {}
+    prop :success, T::Boolean, default: false
+    prop :error, T.nilable(String), default: nil
+  end
+end

data/lib/setsuzoku/api_strategy.rb

@@ -0,0 +1,124 @@
+# typed: false
+# frozen_string_literal: true
+
+module Setsuzoku
+  # The API Type Interface definition.
+  # Any ApiStrategy that implements this interface must implement all abstract methods defined by ApiStrategy.
+  #
+  # Defines all necessary methods for handling interfacing with an external API/Service for any authentication strategy.
+  module ApiStrategy
+
+    extend Forwardable
+    extend T::Sig
+    extend T::Helpers
+    abstract!
+
+    attr_accessor :current_action
+    attr_accessor :service
+    def_delegators :@service, :plugin, :auth_strategy, :external_api_handler
+
+    # Initialize the auth_strategy and provide reference to service.
+    #
+    # @param service [Service] the new instance of service with its correct strategies.
+    #
+    # @return [ApiStrategy] the new instance of api_strategy
+    sig(:final) do
+      params(
+          service: T.any(
+              Setsuzoku::Service::WebService::Service,
+              T.untyped
+          ),
+          args: T.untyped
+      ).returns(T.any(
+          Setsuzoku::Service::WebService::ApiStrategies::RestStrategy,
+          T.untyped
+      ))
+    end
+    def initialize(service:, **args)
+      #TODO: here we need to assign credentials etc, I think.
+      self.service = service
+      self
+    end
+
+    # Perform the external call for the external API.
+    # Each ApiStrategy must define how this works.
+    #
+    # It should:
+    # 1. Make the external request
+    # 2. Parse the response
+    # 3. Handle any bad response
+    # 4. Format the response
+    #
+    # @param request [APIRequest] the request object to be used for the request. Each strategy defines its request structure.
+    # @param action_details [Hash] the action_details for the action to execute.
+    # @param options [Any] any additional options needed to pass to correctly perform the request.
+    #
+    # @return [Any] the formatted response object.
+    sig { abstract.params(request: T.untyped, action_details: T::Hash[T.untyped, T.untyped], options: T.untyped).returns(T.untyped) }
+    def perform_external_call(request:, action_details:, **options); end
+
+    # Perform an external system call.
+    # This provides a uniform way of executing and handling responses for calls to external systems.
+    #
+    # @param request [Hash] the request hash used in the API request.
+    #
+    # @return [Hash] the response from the external system.
+    sig { params(request: T.untyped, strategy: T.nilable(Symbol), options: T.untyped).returns(ApiResponse) }
+    def call_external_api(request:, strategy: nil, **options)
+      self.current_action = request.action
+      formatted_response = T.let(nil, T.nilable(T::Hash[Symbol, T.untyped]))
+      success = T.let(false, T::Boolean)
+      exception = T.let(nil, T.nilable(Setsuzoku::Exception))
+      action_details = case strategy
+                       when :auth
+                         { actions: self.plugin.auth_actions, url: self.plugin.auth_base_url }
+                       when :webhook
+                         { actions: self.plugin.api_actions, url: self.plugin.webhook_base_url }
+                       else
+                         { actions: self.plugin.api_actions, url: self.plugin.api_base_url }
+                       end
+      self.external_api_handler.call_external_api_wrapper(plugin: self.plugin, request: request, action_details: action_details) do
+        begin
+          # raise if the token is invalid and needs refreshed, but don't raise if we are trying to get a refresh token
+          raise Setsuzoku::Exception::InvalidAuthCredentials.new unless (request.action == :refresh_token || self.auth_strategy.auth_credential_valid?)
+          raw_response = self.perform_external_call(request: request, action_details: action_details, **options)
+          formatted_response = self.parse_response(response: raw_response, response_type: action_details[:actions][request.action][:response_type])
+          success = true
+        rescue Exception => e
+          exception = e
+          self.external_api_handler.call_external_api_exception(
+              plugin: self.plugin,
+              request: request,
+              action_details: action_details,
+              options: options,
+              raw_response: raw_response,
+              formatted_response: formatted_response,
+              exception: exception
+          )
+        end
+
+        {
+            success: success,
+            plugin: self.plugin,
+            request: request,
+            options: options,
+            raw_response: raw_response,
+            formatted_response: formatted_response,
+            exception: exception
+        }
+      end
+      self.current_action = nil
+      ApiResponse.new(data: formatted_response, success: success)
+    end
+
+    # Parse the response from the API for the given request.
+    # This should just convert JSON strings/XML/SQL rows to a formatted response Hash.
+    #
+    # @param response [Any] the response from the external request.
+    # @param options [Hash] the parsing options. Generally the response_type. e.g. :xml, :json
+    #
+    # @return [Hash] the parsed hash of the response object.
+    sig { abstract.params(response: T.untyped, options: T.untyped).returns(T::Hash[Symbol, T.untyped]) }
+    def parse_response(response:, **options); end
+  end
+end