lobbying_disclosure_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 443db2822b042a2ca0d0d0e1ee2f0a4013f8e707fca59befc559e149572d8205
+  data.tar.gz: '028781104589d3694a4b22fe6dd612e99e9ae8b50aede4e1a3c7389ae97b4681'
+SHA512:
+  metadata.gz: 4073fd1e091d6ffb15308a10fcfcb69c23b92f8b7f882d09aa49ab9932cf129e9b067a50393fca5ffe8a2b3e888a7fc89242b05102f1d1ab7ba1103e0b122bb8
+  data.tar.gz: 8d2e685e8e48fd1e9e7fe7fc0d7a4763adbad7546d00c48a30140d9c254ced283bc09c2652a390ae6d75d615369476e630378d87aca141b047d2777c28397096

data/.rubocop.yml

@@ -0,0 +1,50 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+  - rubocop-sorbet
+
+AllCops:
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+RuboCopStyle/OptionalBooleanParameter:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Sorbet/StrictSigil:
+  Enabled: true
+  Exclude:
+    - 'test/**/*'
+
+Sorbet/FalseSigil:
+  Enabled: true
+  Include:
+    - 'test/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Daniel Lee
+
+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,78 @@
+# Lobbying Disclosure Client
+
+This gem acts as a client for the Lobbying Disclosure Client REST API. See [the full API documentation](https://lda.senate.gov/api/redoc/v1/) for more detail.
+
+## Installation
+
+Add to your Gemfile:
+
+```
+gem 'lobbying_disclosure_client'
+```
+
+```
+bundle install
+```
+
+## Usage
+
+### Using an API key
+
+The API _does_ allow for "anonymous" requests (i.e. without an API key), but the rate limit is pretty unforgiving. It's very easy to [register for one](https://lda.senate.gov/api/register/). You can configure the gem to use your key as such:
+
+```ruby
+LobbyingDisclosureClient.api_key = ENV['YOUR_API_KEY']
+```
+
+### Supported endpoints
+
+The gem supports all V1 endpoints, which can be called as such:
+
+```ruby
+LobbyingDisclosureClient::V1::Clients::ListClients.call(...)
+LobbyingDisclosureClient::V1::Clients::RetrieveClient.call(...)
+
+LobbyingDisclosureClient::V1::ContributionReports::ListContributionReports.call(...)
+LobbyingDisclosureClient::V1::ContributionReports::RetrieveContributionReport.call(...)
+
+LobbyingDisclosureClient::V1::Filings::ListFilings.call(...)
+LobbyingDisclosureClient::V1::Filings::RetrieveFiling.call(...)
+
+LobbyingDisclosureClient::V1::Lobbyists::ListLobbyists.call(...)
+LobbyingDisclosureClient::V1::Lobbyists::RetrieveLobbyist.call(...)
+
+LobbyingDisclosureClient::V1::Registrants::ListRegistrants.call(...)
+LobbyingDisclosureClient::V1::Registrants::RetrieveRegistrant.call(...)
+
+# Lists all endpoints
+LobbyingDisclosureClient::V1.call
+```
+
+Endpoints namespaced under `/v1/constants` return valid values for various enums. The Ruby representations of these enums are automatically validated against the live API as part of the CI pipeline.
+
+```ruby
+LobbyingDisclosureClient::V1::Constants::Contribution::ListContributionItemTypes.call
+
+LobbyingDisclosureClient::V1::Constants::Filing::ListFilingTypes.call
+LobbyingDisclosureClient::V1::Constants::Filing::ListGovernmentEntities.call
+LobbyingDisclosureClient::V1::Constants::Filing::ListLobbyingActivityGeneralIssues.call
+
+LobbyingDisclosureClient::V1::Constants::General::ListCountries.call
+LobbyingDisclosureClient::V1::Constants::General::ListStates.call
+
+LobbyingDisclosureClient::V1::Constants::Lobbyist::ListLobbyistPrefixes.call
+LobbyingDisclosureClient::V1::Constants::Lobbyist::ListLobbyistSuffixes.call
+```
+
+There are also a few endpoints related to auth/login.
+
+```ruby
+# Given username/password, returns an API key
+LobbyingDisclosureClient::Auth::Login.call(...)
+
+# Sends a password reset email
+LobbyingDisclosureClient::Auth::Password::Reset.call(...)
+
+# Sets a new password, given a UID from the password reset email
+LobbyingDisclosureClient::Auth::Password::Reset::Confirm.call(...)
+```

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+require 'lobbying_disclosure_client'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test
+
+desc 'Validate enums against values from the API'
+task :validate_constants do
+  require_relative 'lib/lobbying_disclosure_client/util/constants_validator'
+  LobbyingDisclosureClient::Util::ConstantsValidator.validate!
+end

data/lefthook.yml

@@ -0,0 +1,9 @@
+pre-commit:
+  parallel: true
+  commands:
+    Rubocop:
+      glob: "{*.rb,*.rake,Rakefile}"
+      run: bundle exec rubocop  --color --force-exclusion --format simple
+    Sorbet:
+      glob: "{*.rb,*.rake,Rakefile}"
+      run: bundle exec srb tc

data/lib/lobbying_disclosure_client/auth/login.rb

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  module Auth
+    class Login
+      extend T::Sig
+
+      class Input < T::Struct
+        const :username, String
+        const :password, String
+      end
+
+      class Output < T::Struct
+        const :key, String
+      end
+
+      sig do
+        params(
+          input: Input
+        ).returns(Output)
+      end
+      def self.call(input:)
+        client = Client.new
+        response = client.post(LobbyingDisclosureClient::Enums::Route::Auth_Login, input.serialize)
+
+        Output.new(
+          key: T.must(response['key'])
+        )
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/auth/password/reset/confirm.rb

@@ -0,0 +1,39 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  module Auth
+    module Password
+      class Reset
+        class Confirm
+          extend T::Sig
+
+          class Input < T::Struct
+            const :new_password1, String
+            const :new_password2, String
+            const :uid, String
+            const :token, String
+          end
+
+          class Output < T::Struct
+            const :detail, String
+          end
+
+          sig do
+            params(
+              input: Input
+            ).returns(Output)
+          end
+          def self.call(input:)
+            client = Client.new
+            response = client.post(LobbyingDisclosureClient::Enums::Route::Auth_Password_Reset_Confirm, input.serialize)
+
+            Output.new(
+              detail: T.must(response['detail'])
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/auth/password/reset.rb

@@ -0,0 +1,34 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  module Auth
+    module Password
+      class Reset
+        extend T::Sig
+
+        class Input < T::Struct
+          const :email, String
+        end
+
+        class Output < T::Struct
+          const :detail, String
+        end
+
+        sig do
+          params(
+            input: Input
+          ).returns(Output)
+        end
+        def self.call(input:)
+          client = Client.new
+          response = client.post(LobbyingDisclosureClient::Enums::Route::Auth_Password_Reset, input.serialize)
+
+          Output.new(
+            detail: T.must(response['detail'])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/auth/password.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  module Auth
+    module Password
+    end
+  end
+end

data/lib/lobbying_disclosure_client/auth.rb

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

data/lib/lobbying_disclosure_client/client.rb

@@ -0,0 +1,108 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'faraday'
+
+module LobbyingDisclosureClient
+  class Client
+    extend T::Sig
+
+    sig do
+      params(
+        route: LobbyingDisclosureClient::Enums::Route,
+        path_params: T::Array[T.any(String, Integer)],
+        query_params: T::Hash[String, T.untyped]
+      ).returns(
+        T.untyped
+      )
+    end
+    def get(route, path_params: [], query_params: {})
+      handle_response(
+        connection.get(
+          route.to_full_api_path(path_params:),
+          query_params
+        )
+      )
+    end
+
+    sig do
+      params(
+        route: LobbyingDisclosureClient::Enums::Route,
+        body: T::Hash[String, String]
+      ).returns(
+        T::Hash[String, String]
+      )
+    end
+    def post(route, body = {})
+      handle_response(
+        connection.post(
+          route.to_full_api_path,
+          body.to_json
+        )
+      )
+    end
+
+    private
+
+    sig do
+      returns(Faraday::Connection)
+    end
+    def connection
+      Faraday.new(
+        headers: build_headers
+      ) do |conn|
+        conn.adapter :net_http
+      end
+    end
+
+    sig do
+      returns(T::Hash[String, String])
+    end
+    def build_headers
+      headers = { 'Content-Type' => 'application/json' }
+
+      # The Lobbying Disclosure API does allow unauthenticated ("anonymous") requests,
+      # though they are aggressively rate-limited.
+
+      headers['Authorization'] = "Token #{LobbyingDisclosureClient.api_key}" if LobbyingDisclosureClient.api_key
+
+      headers
+    end
+
+    sig do
+      params(
+        response: T.untyped
+      ).returns(T.untyped)
+    end
+    def handle_response(response)
+      response_code = response.status
+      response_body = JSON.parse(response.body)
+
+      case response_code
+      when 200
+        response_body
+      when 400
+        # The API docs specify two distinct response schemas for 400 errors:
+        #   1. { "detail": "..." }
+        #   2. { "registrant_id": ["Enter a number."], "another_field": ["Another error message"] }
+        # Collapsing these into one error type for now.
+
+        raise LobbyingDisclosureClient::Errors::BadRequestError, response_body
+      when 401
+        raise LobbyingDisclosureClient::Errors::InvalidApiKeyError, response_body['detail']
+      when 404
+        raise LobbyingDisclosureClient::Errors::NotFoundError, response_body['detail']
+      when 405
+        raise LobbyingDisclosureClient::Errors::UnsupportedHttpMethodError, response_body['detail']
+      when 429
+        raise LobbyingDisclosureClient::Errors::RequestThrottledError.new(
+          response_body['detail'],
+          Integer(response.headers['Retry-After'], 10)
+        )
+      else
+        raise LobbyingDisclosureClient::Errors::UnknownError,
+              "Got #{response_code}. Response: #{response_body}"
+      end
+    end
+  end
+end

data/lib/lobbying_disclosure_client/enums/contribution_type.rb

@@ -0,0 +1,16 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LobbyingDisclosureClient
+  module Enums
+    class ContributionType < T::Enum
+      enums do
+        Feca = new('feca')
+        HonoraryExpenses = new('he')
+        MeetingExpenses = new('me')
+        PresidentialLibraryExpenses = new('ple')
+        PresidentialInauguralCommittee = new('pic')
+      end
+    end
+  end
+end