setsuzoku 0.11.9 → 0.12.54

data/lib/setsuzoku/service/web_service/credentials/basic_auth_credential.rb

@@ -6,9 +6,9 @@ module Setsuzoku
     module WebService
       module Credentials
         module BasicAuthCredential
-          include Setsuzoku::Credential
           extend T::Sig
           extend T::Helpers
+          include Setsuzoku::Credential
           abstract!
 
           # The username to use for the credential.
@@ -42,8 +42,8 @@ module Setsuzoku
           # @return [Struct] a stubbed basic_auth_credential-like struct.
           sig { returns(Struct) }
           def self.stub_credential
-            s = Struct.new(:status, :settings, :username, :password)
-            s.new('active', {}, 'stubbed_username', 'stubbed_password')
+            s = Struct.new(:auth_strategy, :status, :settings, :username, :password)
+            s.new(nil, 'active', {}, 'stubbed_username', 'stubbed_password')
           end
         end
       end

data/lib/setsuzoku/service/web_service/credentials/custom_auth_credential.rb

@@ -0,0 +1,46 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Setsuzoku
+  module Service
+    module WebService
+      module Credentials
+        module CustomAuthCredential
+          extend T::Sig
+          extend T::Helpers
+          include Setsuzoku::Credential
+          include UsesTokenCredential
+          abstract!
+
+          #
+          # uses_token?
+          sig{ abstract.returns(T::Boolean) }
+          #
+          # If the credential uses a token.
+          #
+          # @return [Boolean] if the credential should request and store tokens.
+          def uses_token?; end
+          #
+          # auth_headers
+          sig{ abstract.returns(T::Hash[Symbol, T.untyped]) }
+          # The custom auth_headers this credential provides for custom_auth_strategy.
+          #
+          # @return [Hash] the auth headers.
+          def auth_headers; end
+
+          #
+          # self.stub_credential
+          sig { returns(Struct) }
+          #
+          # Stub a custom_auth_credential-like instance.
+          #
+          # @return [Struct] a stubbed custom_auth_credential-like struct.
+          def self.stub_credential
+            s = Struct.new(:auth_strategy, :status, :settings, :auth_headers, :uses_token?, :token, :refresh_token, :expires_on)
+            s.new(nil, 'active', {}, { stubbed_auth_header: 'stubbed_auth_header' }, true, 'stubbed_token', 'stubbed_refresh_token', (Time.now + 30.days))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/setsuzoku/service/web_service/credentials/o_auth_credential.rb

@@ -10,8 +10,32 @@ module Setsuzoku
         module OAuthCredential
           extend T::Sig
           extend T::Helpers
+          include Setsuzoku::Credential
+          include UsesTokenCredential
           abstract!
 
+          #
+          # auth_actions
+          sig { overridable.returns(T::Hash[T.untyped, T.untyped]) }
+          #
+          # All auth actions that are implemented.
+          #
+          # @return [Hash] all auth endpoint definitions for the API.
+          def auth_actions
+            {
+                new_token: {
+                    'POST' => 'token',
+                    request_type: :json,
+                    response_type: :json
+                },
+                refresh_token: {
+                    'POST' => 'token',
+                    request_type: :json,
+                    response_type: :json
+                }
+            }
+          end
+
           # The application's client_id to o_auth with.
           #
           # @return [String] the client_id for o_auth.
@@ -30,51 +54,33 @@ module Setsuzoku
           sig { abstract.returns(T.nilable(String)) }
           def redirect_url; end
 
-          # The token to use for the credential.
-          #
-          # @return [String] the credential's token.
-          sig{ abstract.returns(T.nilable(String)) }
-          def token; end
-
-          # The token to set for the credential.
+          # The token, refresh_token, and expires_at to assign for an OAuth token request.
           #
-          # @return [String] the credential's token to set.
+          # @param resp [Hash] the response hash from the external api call for a token.
           #
-          sig{ abstract.params(val: String).returns(T.nilable(String)) }
-          def token=(val); end
+          # @return [Hash] the attributes to assign to the credential.
+          sig{ override.params(resp: Setsuzoku::ApiResponse).returns(T::Hash[Symbol, T.untyped]) }
+          def token_attributes_to_assign(resp)
+            attrs = {
+                token: resp.data[:access_token],
+                refresh_token: resp.data[:refresh_token]
+            }
 
-          # The refresh token to use for the credential.
-          #
-          # @return [String] the credential's refresh token.
-          sig{ abstract.returns(T.nilable(String)) }
-          def refresh_token; end
+            expires_in = resp.data[:expires_in]
+            if expires_in && (expires_in.is_a?(Integer) || expires_in.match(/^\d+$/))
+              attrs[:expires_on] = expires_in.to_i.seconds.from_now
+            end
 
-          # The refresh token to set for the credential.
-          #
-          # @return [String] the credential's refresh token to set.
-          #
-          sig{ abstract.params(val: String).returns(T.nilable(String)) }
-          def refresh_token=(val); end
-
-          # The time the currently valid token expires on.
-          #
-          # @return [Datetime] the time the current token expires.
-          sig{ abstract.returns(T.nilable(DateTime)) }
-          def expires_on; end
-
-          # The time to set for when the token expires on.
-          #
-          # @return [Datetime] the time to set for the current token's expiry.
-          sig{ abstract.params(val: DateTime).returns(T.nilable(DateTime)) }
-          def expires_on=(val); end
+            attrs
+          end
 
           # Stub an o_auth_credential-like instance.
           #
           # @return [Struct] a stubbed o_auth_credential-like struct.
           sig { returns(Struct) }
           def self.stub_credential
-            s = Struct.new(:status, :settings, :client_id, :client_secret, :redirect_url, :token, :refresh_token, :expires_on)
-            s.new('active', {'extension': 'test'}, 'stubbed_client_id', 'stubbed_client_secret', 'stubbed_redirect_url', 'stubbed_token', 'refresh_token', (Time.now + 30.days))
+            s = Struct.new(:auth_strategy, :status, :settings, :client_id, :client_secret, :redirect_url, :token, :refresh_token, :expires_on)
+            s.new(nil, 'active', {'extension': 'test'}, 'stubbed_client_id', 'stubbed_client_secret', 'stubbed_redirect_url', 'stubbed_token', 'stubbed_refresh_token', (Time.now + 30.days))
           end
         end
       end

data/lib/setsuzoku/service/web_service/credentials/uses_credential_token.rb

@@ -0,0 +1,68 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Setsuzoku
+  module Service
+    module WebService
+      module Credentials
+        module UsesTokenCredential
+          extend T::Sig
+          extend T::Helpers
+
+          # The base auth url for the plugin.
+          #
+          # @return [String] the auth url.
+          sig { abstract.returns(String) }
+          def auth_base_url; end
+
+          # The token to use for the credential.
+          #
+          # @return [String] the credential's token.
+          sig{ abstract.returns(T.nilable(String)) }
+          def token; end
+
+          # The token to set for the credential.
+          #
+          # @return [String] the credential's token to set.
+          #
+          sig{ abstract.params(val: String).returns(T.nilable(String)) }
+          def token=(val); end
+
+          # The refresh token to use for the credential.
+          #
+          # @return [String] the credential's refresh token.
+          sig{ abstract.returns(T.nilable(String)) }
+          def refresh_token; end
+
+          # The refresh token to set for the credential.
+          #
+          # @return [String] the credential's refresh token to set.
+          #
+          sig{ abstract.params(val: String).returns(T.nilable(String)) }
+          def refresh_token=(val); end
+
+          # The time the currently valid token expires on.
+          #
+          # @return [Datetime] the time the current token expires.
+          sig{ abstract.returns(T.nilable(DateTime)) }
+          def expires_on; end
+
+          # The time to set for when the token expires on.
+          #
+          # @return [Datetime] the time to set for the current token's expiry.
+          sig{ abstract.params(val: DateTime).returns(T.nilable(DateTime)) }
+          def expires_on=(val);
+
+          # The token fields to bet set for the custom credential.
+          #
+          # @param resp [Hash] the response hash from the external api call for a token.
+          #
+          # @return [Hash] the attributes to assign to the credential.
+          sig{ abstract.params(resp: T::Hash[Symbol, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
+          def token_attributes_to_assign(resp); end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/setsuzoku/service/web_service/service.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: ignore
 # frozen_string_literal: true
 
 module Setsuzoku
@@ -18,6 +18,7 @@ module Setsuzoku
           {
             auth: {
                 basic: Setsuzoku::Service::WebService::AuthStrategies::BasicAuthStrategy,
+                custom: Setsuzoku::Service::WebService::AuthStrategies::CustomAuthStrategy,
                 o_auth: Setsuzoku::Service::WebService::AuthStrategies::OAuthStrategy
             },
             api: {

data/lib/setsuzoku/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Setsuzoku
-  VERSION = '0.11.9'
+  VERSION = '0.12.54'
 end

data/setsuzoku.gemspec

@@ -44,7 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sorbet", "~> 0.5"
   spec.add_runtime_dependency "sorbet-runtime", "~> 0.5"
   #TODO: we should remove httparty if we can just use faraday
-  spec.add_runtime_dependency "httparty", "~> 0.16.4"
   spec.add_runtime_dependency "faraday", "~> 0.11"
   spec.add_runtime_dependency "nokogiri", "~> 1.10"
 end

data/sorbet/rbi/gems/activesupport.rbi

@@ -809,6 +809,10 @@ class ActiveSupport::HashWithIndifferentAccess < Hash
   def with_defaults(other_hash); end
   def with_indifferent_access; end
 end
+class Class < Module
+  def descendants; end
+  def subclasses; end
+end
 module ActiveSupport::Multibyte
   def self.proxy_class; end
   def self.proxy_class=(klass); end
@@ -1069,57 +1073,3 @@ module DateAndTime::Calculations
   def years_since(years); end
   def yesterday; end
 end
-class Class < Module
-  def class_attribute(*attrs); end
-  def descendants; end
-  def subclasses; end
-end
-module ActiveSupport::NumberHelper
-  def number_to_currency(number, options = nil); end
-  def number_to_delimited(number, options = nil); end
-  def number_to_human(number, options = nil); end
-  def number_to_human_size(number, options = nil); end
-  def number_to_percentage(number, options = nil); end
-  def number_to_phone(number, options = nil); end
-  def number_to_rounded(number, options = nil); end
-  extend ActiveSupport::Autoload
-  extend ActiveSupport::NumberHelper
-end
-class ActiveSupport::NumberHelper::NumberConverter
-  def default_format_options; end
-  def default_value(key); end
-  def execute; end
-  def format_options; end
-  def i18n_format_options; end
-  def initialize(number, options); end
-  def namespace; end
-  def namespace=(val); end
-  def namespace?; end
-  def number; end
-  def options; end
-  def opts; end
-  def self.convert(number, options); end
-  def self.namespace; end
-  def self.namespace=(val); end
-  def self.namespace?; end
-  def self.validate_float; end
-  def self.validate_float=(val); end
-  def self.validate_float?; end
-  def translate_in_locale(key, i18n_options = nil); end
-  def translate_number_value_with_default(key, i18n_options = nil); end
-  def valid_float?; end
-  def validate_float; end
-  def validate_float=(val); end
-  def validate_float?; end
-end
-class ActiveSupport::NumberHelper::NumberToPhoneConverter < ActiveSupport::NumberHelper::NumberConverter
-  def convert; end
-  def convert_to_phone_number(number); end
-  def convert_with_area_code(number); end
-  def convert_without_area_code(number); end
-  def country_code(code); end
-  def delimiter; end
-  def phone_ext(ext); end
-  def regexp_pattern(default_pattern); end
-  def start_with_delimiter?(number); end
-end

data/sorbet/rbi/gems/i18n.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/i18n/all/i18n.rbi
 #
-# i18n-1.8.2
+# i18n-1.8.3
 
 module I18n
   def self.interpolate(string, values); end
@@ -87,7 +87,7 @@ module I18n::Base
   def enforce_available_locales=(value); end
   def exception_handler; end
   def exception_handler=(value); end
-  def exists?(key, _locale = nil, locale: nil); end
+  def exists?(key, _locale = nil, locale: nil, **options); end
   def handle_exception(handling, exception, locale, key, options); end
   def l(object, locale: nil, format: nil, **options); end
   def load_path; end

data/sorbet/rbi/gems/rspec-core.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/rspec-core/all/rspec-core.rbi
 #
-# rspec-core-3.9.2
+# rspec-core-3.8.2
 
 module RSpec
   def self.clear_examples; end
@@ -403,7 +403,6 @@ class RSpec::Core::Reporter
   def example_pending(example); end
   def example_started(example); end
   def examples; end
-  def exit_early(exit_code); end
   def fail_fast_limit_met?; end
   def failed_examples; end
   def finish; end
@@ -808,7 +807,6 @@ class RSpec::Core::World
   def descending_declaration_line_numbers_by_file; end
   def everything_filtered_message; end
   def example_count(groups = nil); end
-  def example_group_counts_by_spec_file; end
   def example_groups; end
   def exclusion_filter; end
   def fail_if_config_and_cli_options_invalid; end
@@ -1106,7 +1104,8 @@ class RSpec::Core::Configuration
   def extend(mod, *filters); end
   def extract_location(path); end
   def fail_fast; end
-  def fail_fast=(value); end
+  def fail_fast=(arg0); end
+  def fail_fast?; end
   def fail_if_no_examples; end
   def fail_if_no_examples=(arg0); end
   def fail_if_no_examples?; end
@@ -1729,157 +1728,6 @@ class RSpec::Core::Profiler
   def example_started(notification); end
   def initialize; end
 end
-class RSpec::Core::DidYouMean
-  def call; end
-  def formats(probables); end
-  def initialize(relative_file_name); end
-  def red_font(mytext); end
-  def relative_file_name; end
-  def top_and_tail(rspec_format); end
-end
-class RSpec::Core::Formatters::BaseFormatter
-  def close(_notification); end
-  def example_group; end
-  def example_group=(arg0); end
-  def example_group_started(notification); end
-  def initialize(output); end
-  def output; end
-  def output_supports_sync; end
-  def restore_sync_output; end
-  def start(notification); end
-  def start_sync_output; end
-end
-class RSpec::Core::Formatters::BaseTextFormatter < RSpec::Core::Formatters::BaseFormatter
-  def close(_notification); end
-  def dump_failures(notification); end
-  def dump_pending(notification); end
-  def dump_summary(summary); end
-  def message(notification); end
-  def seed(notification); end
-end
-class RSpec::Core::Formatters::DocumentationFormatter < RSpec::Core::Formatters::BaseTextFormatter
-  def current_indentation(offset = nil); end
-  def example_failed(failure); end
-  def example_group_finished(_notification); end
-  def example_group_started(notification); end
-  def example_passed(passed); end
-  def example_pending(pending); end
-  def example_started(_notification); end
-  def failure_output(example); end
-  def flush_messages; end
-  def initialize(output); end
-  def message(notification); end
-  def next_failure_index; end
-  def passed_output(example); end
-  def pending_output(example, message); end
-end
-class RSpec::Core::Formatters::HtmlPrinter
-  def flush; end
-  def indentation_style(number_of_parents); end
-  def initialize(output); end
-  def make_example_group_header_red(group_id); end
-  def make_example_group_header_yellow(group_id); end
-  def make_header_red; end
-  def make_header_yellow; end
-  def move_progress(percent_done); end
-  def print_example_failed(pending_fixed, description, run_time, failure_id, exception, extra_content); end
-  def print_example_group_end; end
-  def print_example_group_start(group_id, description, number_of_parents); end
-  def print_example_passed(description, run_time); end
-  def print_example_pending(description, pending_message); end
-  def print_html_start; end
-  def print_summary(duration, example_count, failure_count, pending_count); end
-  include ERB::Util
-end
-class RSpec::Core::Formatters::HtmlFormatter < RSpec::Core::Formatters::BaseFormatter
-  def dump_summary(summary); end
-  def example_failed(failure); end
-  def example_group_number; end
-  def example_group_started(notification); end
-  def example_number; end
-  def example_passed(passed); end
-  def example_pending(pending); end
-  def example_started(_notification); end
-  def extra_failure_content(failure); end
-  def initialize(output); end
-  def percent_done; end
-  def start(notification); end
-  def start_dump(_notification); end
-end
-class RSpec::Core::Formatters::FallbackMessageFormatter
-  def initialize(output); end
-  def message(notification); end
-  def output; end
-end
-class RSpec::Core::Formatters::ProgressFormatter < RSpec::Core::Formatters::BaseTextFormatter
-  def example_failed(_notification); end
-  def example_passed(_notification); end
-  def example_pending(_notification); end
-  def start_dump(_notification); end
-end
-class RSpec::Core::Formatters::ProfileFormatter
-  def bold(text); end
-  def dump_profile(profile); end
-  def dump_profile_slowest_example_groups(profile); end
-  def dump_profile_slowest_examples(profile); end
-  def format_caller(caller_info); end
-  def initialize(output); end
-  def output; end
-end
-class RSpec::Core::Formatters::JsonFormatter < RSpec::Core::Formatters::BaseFormatter
-  def close(_notification); end
-  def dump_profile(profile); end
-  def dump_profile_slowest_example_groups(profile); end
-  def dump_profile_slowest_examples(profile); end
-  def dump_summary(summary); end
-  def format_example(example); end
-  def initialize(output); end
-  def message(notification); end
-  def output_hash; end
-  def seed(notification); end
-  def stop(notification); end
-end
-module RSpec::Core::Bisect
-end
-class RSpec::Core::Bisect::ExampleSetDescriptor < Struct
-  def all_example_ids; end
-  def all_example_ids=(_); end
-  def failed_example_ids; end
-  def failed_example_ids=(_); end
-  def self.[](*arg0); end
-  def self.inspect; end
-  def self.members; end
-  def self.new(*arg0); end
-end
-class RSpec::Core::Bisect::BisectFailedError < StandardError
-  def self.for_failed_spec_run(spec_output); end
-end
-class RSpec::Core::Bisect::Notifier
-  def initialize(formatter); end
-  def publish(event, *args); end
-end
-class RSpec::Core::Bisect::Channel
-  def close; end
-  def initialize; end
-  def receive; end
-  def send(message); end
-end
-class RSpec::Core::Formatters::BaseBisectFormatter
-  def example_failed(notification); end
-  def example_finished(notification); end
-  def initialize(expected_failures); end
-  def self.inherited(formatter); end
-  def start_dump(_notification); end
-end
-class RSpec::Core::Formatters::BisectDRbFormatter < RSpec::Core::Formatters::BaseBisectFormatter
-  def initialize(_output); end
-  def notify_results(results); end
-end
-class RSpec::Core::Formatters::FailureListFormatter < RSpec::Core::Formatters::BaseFormatter
-  def dump_profile(_profile); end
-  def example_failed(failure); end
-  def message(_message); end
-end
 module RSpec::Core::MockingAdapters
 end
 module RSpec::Core::MockingAdapters::RSpec