lobbying_disclosure_client 0.0.1

data/lib/lobbying_disclosure_client/util/constants_validator.rb

@@ -0,0 +1,122 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  module Util
+    class ConstantsValidator
+      class InvalidEnumError < StandardError; end
+
+      class ItemToValidate < T::Struct
+        const :enum_klass, T.class_of(T::Enum)
+        const :api_klass, T.any(
+          T.class_of(LobbyingDisclosureClient::V1::Constants::Contribution::ListContributionItemTypes),
+          T.class_of(LobbyingDisclosureClient::V1::Constants::Filing::ListFilingTypes),
+          T.class_of(LobbyingDisclosureClient::V1::Constants::Filing::ListLobbyingActivityGeneralIssues),
+          T.class_of(LobbyingDisclosureClient::V1::Constants::General::ListCountries),
+          T.class_of(LobbyingDisclosureClient::V1::Constants::General::ListStates),
+          T.class_of(LobbyingDisclosureClient::V1::Constants::Lobbyist::ListLobbyistPrefixes),
+          T.class_of(LobbyingDisclosureClient::V1::Constants::Lobbyist::ListLobbyistSuffixes)
+        )
+      end
+
+      ITEMS_TO_VALIDATE = T.let(
+        [
+          ItemToValidate.new(
+            enum_klass: LobbyingDisclosureClient::Enums::ContributionType,
+            api_klass: LobbyingDisclosureClient::V1::Constants::Contribution::ListContributionItemTypes
+          ),
+          ItemToValidate.new(
+            enum_klass: LobbyingDisclosureClient::Enums::FilingType,
+            api_klass: LobbyingDisclosureClient::V1::Constants::Filing::ListFilingTypes
+          ),
+          ItemToValidate.new(
+            enum_klass: LobbyingDisclosureClient::Enums::GeneralIssueCode,
+            api_klass: LobbyingDisclosureClient::V1::Constants::Filing::ListLobbyingActivityGeneralIssues
+          ),
+          ItemToValidate.new(
+            enum_klass: LobbyingDisclosureClient::Enums::Country,
+            api_klass: LobbyingDisclosureClient::V1::Constants::General::ListCountries
+          ),
+          ItemToValidate.new(
+            enum_klass: LobbyingDisclosureClient::Enums::State,
+            api_klass: LobbyingDisclosureClient::V1::Constants::General::ListStates
+          ),
+          ItemToValidate.new(
+            enum_klass: LobbyingDisclosureClient::Enums::Prefix,
+            api_klass: LobbyingDisclosureClient::V1::Constants::Lobbyist::ListLobbyistPrefixes
+          ),
+          ItemToValidate.new(
+            enum_klass: LobbyingDisclosureClient::Enums::Suffix,
+            api_klass: LobbyingDisclosureClient::V1::Constants::Lobbyist::ListLobbyistSuffixes
+          )
+        ].freeze,
+        T::Array[ItemToValidate]
+      )
+
+      VALUES_RETURNED_BY_API_EMPIRICALLY_BUT_NOT_INCLUDED_IN_CONSTANTS_ENDPOINTS = T.let(
+        {
+          LobbyingDisclosureClient::Enums::Country => [
+            LobbyingDisclosureClient::Enums::Country::Blank.serialize
+          ]
+        }.freeze,
+        T::Hash[T.class_of(T::Enum), T::Array[String]]
+      )
+
+      class << self
+        extend T::Sig
+
+        sig { void }
+        def validate!
+          validation_results = ITEMS_TO_VALIDATE.map do |item_to_validate|
+            enum_is_in_sync_with_live_api_result?(item_to_validate)
+          end
+
+          if validation_results.all?
+            puts 'All enums passed validation 🏆🏆🏆'
+          else
+            puts 'Some enums failed validation ⛈️⛈️⛈️'
+            raise InvalidEnumError
+          end
+        end
+
+        private
+
+        sig do
+          params(
+            item_to_validate: ItemToValidate
+          ).returns(T::Boolean)
+        end
+        def enum_is_in_sync_with_live_api_result?(item_to_validate)
+          enum_klass = item_to_validate.enum_klass
+          api_klass = item_to_validate.api_klass
+
+          puts "Validating #{enum_klass.name} against the live API..."
+
+          serialized_enum_values = enum_klass.values.map(&:serialize)
+          api_values = api_klass.call.map(&:value)
+
+          values_missing_from_enum = api_values - serialized_enum_values
+          extra_values_in_enum = serialized_enum_values - api_values - (VALUES_RETURNED_BY_API_EMPIRICALLY_BUT_NOT_INCLUDED_IN_CONSTANTS_ENDPOINTS[enum_klass] || [])
+
+          unless values_missing_from_enum.empty?
+            puts "Detected values in live API result that are missing from #{enum_klass.name}."
+            values_missing_from_enum.map { |value| puts "  - \"#{value}\"" }
+          end
+
+          unless extra_values_in_enum.empty?
+            puts "Detected values in #{enum_klass.name} that are not present in the live API result."
+            extra_values_in_enum.map { |value| puts "  - \"#{value}\"" }
+          end
+
+          if values_missing_from_enum.empty? && extra_values_in_enum.empty?
+            puts "#{enum_klass} passed validation 🏆\n\n"
+            true
+          else
+            puts "#{enum_klass} failed validation ⛈️\n\n"
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/util.rb

@@ -0,0 +1,7 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  module Util
+  end
+end

data/lib/lobbying_disclosure_client/v1/clients/list_clients.rb

@@ -0,0 +1,49 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Clients
+      class ListClients
+        extend T::Sig
+
+        class Input < T::Struct
+          const :client_country, T.nilable(LobbyingDisclosureClient::Enums::Country)
+          const :client_name, T.nilable(String)
+          const :client_ppb_country, T.nilable(LobbyingDisclosureClient::Enums::Country)
+          const :client_ppb_state, T.nilable(LobbyingDisclosureClient::Enums::State)
+          const :client_state, T.nilable(LobbyingDisclosureClient::Enums::State)
+          const :id, T.nilable(Integer)
+          const :ordering, T.nilable(String)
+          const :page, T.nilable(Integer)
+          const :page_size, T.nilable(Integer)
+          const :registrant_id, T.nilable(Integer)
+          const :registrant_name, T.nilable(String)
+        end
+
+        class Output < T::Struct
+          const :count, Integer
+          const :next, T.nilable(String)
+          const :previous, T.nilable(String)
+          const :results, T::Array[LobbyingDisclosureClient::Types::ClientWithRegistrant]
+        end
+
+        sig do
+          params(
+            input: Input
+          ).returns(Output)
+        end
+        def self.call(input:)
+          client = Client.new
+
+          Output.from_hash!(
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Clients_ListClients,
+              query_params: input.serialize.compact
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/clients/retrieve_client.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Clients
+      class RetrieveClient
+        extend T::Sig
+
+        class Input < T::Struct
+          const :id, Integer
+        end
+
+        Output = T.type_alias do
+          LobbyingDisclosureClient::Types::ClientWithRegistrant
+        end
+
+        sig do
+          params(
+            input: Input
+          ).returns(Output)
+        end
+        def self.call(input:)
+          client = Client.new
+
+          LobbyingDisclosureClient::Types::ClientWithRegistrant.from_hash!(
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Clients_RetrieveClient,
+              path_params: [input.id]
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/clients.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Clients
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/contribution/list_contribution_item_types.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Contribution
+        class ListContributionItemTypes
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::Constant])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_Contribution_ItemTypes
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::Constant.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/contribution.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Contribution
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/filing/list_filing_types.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Filing
+        class ListFilingTypes
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::Constant])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_Filing_ListFilingTypes
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::Constant.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/filing/list_government_entities.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Filing
+        class ListGovernmentEntities
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::GovernmentEntity])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_Filing_GovernmentEntities
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::GovernmentEntity.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/filing/list_lobbying_activity_general_issues.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Filing
+        class ListLobbyingActivityGeneralIssues
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::Constant])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_Filing_LobbyingActivityIssues
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::Constant.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/filing.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Filing
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/general/list_countries.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module General
+        class ListCountries
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::Constant])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_General_Countries
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::Constant.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/general/list_states.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module General
+        class ListStates
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::Constant])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_General_States
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::Constant.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/general.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module General
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/lobbyist/list_lobbyist_prefixes.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Lobbyist
+        class ListLobbyistPrefixes
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::Constant])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_Lobbyist_Prefixes
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::Constant.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/lobbyist/list_lobbyist_suffixes.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Lobbyist
+        class ListLobbyistSuffixes
+          extend T::Sig
+
+          sig do
+            returns(T::Array[LobbyingDisclosureClient::Types::Constant])
+          end
+          def self.call
+            client = Client.new
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Constants_Lobbyist_Suffixes
+            ).map do |constant|
+              LobbyingDisclosureClient::Types::Constant.from_hash!(constant)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants/lobbyist.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+      module Lobbyist
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/constants.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module Constants
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/contribution_reports/list_contribution_reports.rb

@@ -0,0 +1,60 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module ContributionReports
+      class ListContributionReports
+        extend T::Sig
+
+        class Input < T::Struct
+          const :contribution_amount_max, T.nilable(BigDecimal)
+          const :contribution_amount_min, T.nilable(BigDecimal)
+          const :contribution_contributor, T.nilable(String)
+          const :contribution_date_after, T.nilable(Date)
+          const :contribution_date_before, T.nilable(Date)
+          const :contribution_honoree, T.nilable(String)
+          const :contribution_payee, T.nilable(String)
+          const :contribution_type, T.nilable(LobbyingDisclosureClient::Enums::ContributionType)
+          const :filing_dt_posted_after, T.nilable(DateTime)
+          const :filing_dt_posted_before, T.nilable(DateTime)
+          const :filing_period, T.nilable(LobbyingDisclosureClient::Enums::FilingPeriod)
+          const :filing_type, T.nilable(LobbyingDisclosureClient::Enums::FilingType)
+          const :filing_uuid, T.nilable(String)
+          const :filing_year, T.nilable(Integer)
+          const :lobbyist_exclude, T.nilable(T::Boolean)
+          const :lobbyist_id, T.nilable(Integer)
+          const :lobbyist_name, T.nilable(String)
+          const :ordering, T.nilable(String)
+          const :page, T.nilable(Integer)
+          const :page_size, T.nilable(Integer)
+          const :registrant_id, T.nilable(Integer)
+          const :registrant_name, T.nilable(String)
+        end
+
+        class Output < T::Struct
+          const :count, Integer
+          const :next, T.nilable(String)
+          const :previous, T.nilable(String)
+          const :results, T::Array[LobbyingDisclosureClient::Types::ContributionReport]
+        end
+
+        sig do
+          params(
+            input: Input
+          ).returns(Output)
+        end
+        def self.call(input:)
+          client = Client.new
+
+          Output.from_hash!(
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Contributions_ListContributionReports,
+              query_params: input.serialize.compact
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/contribution_reports/retrieve_contribution_report.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module ContributionReports
+      class RetrieveContributionReport
+        extend T::Sig
+
+        class Input < T::Struct
+          const :filing_uuid, String
+        end
+
+        Output = T.type_alias do
+          LobbyingDisclosureClient::Types::ContributionReport
+        end
+
+        sig do
+          params(
+            input: Input
+          ).returns(Output)
+        end
+        def self.call(input:)
+          client = Client.new
+
+          LobbyingDisclosureClient::Types::ContributionReport.from_hash!(
+            client.get(
+              LobbyingDisclosureClient::Enums::Route::V1_Contributions_RetrieveContributionReport,
+              path_params: [input.filing_uuid]
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/v1/contribution_reports.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  class V1
+    module ContributionReports
+    end
+  end
+end