sec-edgar-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1deaba9be7991c3f74b96b760e001f9e073a498694d56902434c9dce4417352b
+  data.tar.gz: decdcdc9172f069b100464add33110e35a5e52e2f78c07aa9251603cccf915af
+SHA512:
+  metadata.gz: 7bf3a468f7cc84f28b872ca47673e0d43977e0e9a90e1adf87a16dba20a432709ed1e6d1dd17a85644274e73299e1c8de2583bd9d70a881bff5b7dd313b3c927
+  data.tar.gz: 3084cbb59e1672cd21ade5596df4723b832889a0f3f9948393bdc50c337b33d6e0bb72fded789bd40efdfe9f2221070147bb52eea9d40391e0a9405a3e56b816

data/lib/sec-edgar/client_result.rb

@@ -0,0 +1,17 @@
+module SecEdgar
+  class ClientResult
+    def initialize(response)
+      @response = response
+    end
+
+    def to_h
+      JSON.parse(response.body).deep_symbolize_keys
+    end
+
+    delegate_missing_to :response
+
+    private
+
+    attr_reader :response
+  end
+end

data/lib/sec-edgar/full_text_search.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SecEdgar
+  class FullTextSearch
+    include HTTParty
+    base_uri 'https://efts.sec.gov'
+
+    # Performs a text search using the EDGAR Full Text Search API
+    #
+    # @keys_typed [String] The search term to use in the search query.
+    # @narrow [Boolean] Whether or not to narrow the search results.
+    # The Company Search Page seems to use this control parameter.
+    # https://www.sec.gov/edgar/searchedgar/companysearch.html
+    #
+    def self.perform(keys_typed:, narrow: false)
+      response = post(
+        '/LATEST/search-index',
+        headers: { 'Content-Type': 'application/json' },
+        body: {
+          keysTyped: keys_typed,
+          narrow: narrow
+        }.compact.to_json
+      )
+
+      ClientResult.new(response)
+    end
+  end
+end

data/lib/sec-edgar/version.rb

@@ -0,0 +1,3 @@
+module SecEdgar
+  VERSION = '0.1.0'
+end

data/lib/sec-edgar-sdk.rb

@@ -0,0 +1,6 @@
+require 'active_support/core_ext/hash'
+require 'httparty'
+
+require_relative 'sec-edgar/version'
+require_relative 'sec-edgar/client_result'
+require_relative 'sec-edgar/full_text_search'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: sec-edgar-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Christensen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+description: A Ruby SDK for the SEC EDGAR API
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sec-edgar-sdk.rb
+- lib/sec-edgar/client_result.rb
+- lib/sec-edgar/full_text_search.rb
+- lib/sec-edgar/version.rb
+homepage: https://github.com/david-christensen/sec-edgar-edgar-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: SEC EDGAR SDK
+test_files: []