thirteen_f 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faa86b34f746b8c24e08c909422945e7d16c1fc970532f0ed47b030484f3c75b
-  data.tar.gz: 2f6bea3847ab8ae71d4ad93935935f736b3f6aa2dbf7857ebc3ddd118d6f46cc
+  metadata.gz: 3b6299aaa6691236c2f61152986f601cb6714609759b85ecbfac375d74522e32
+  data.tar.gz: d9135d7b9f522841ce392cffcada7db8b8bf557bc071ed05602f904ebaf794ef
 SHA512:
-  metadata.gz: bae8ed73b154e06568f55d4debeef353dc67bf5dfef321f52a9a42c126177ed4ebcd92fa21e6eb0c2fdf307258b5d02faa8c09965a895de6d37e8e352b2f8b71
-  data.tar.gz: 876b5c9291b0845f14932e36143c9e5d19f5dc723a826975a0fceb390421d8ce4a522b78891ca87394b5b4a403543e5274a6719ee798d864e9b3228c1f2e0713
+  metadata.gz: 62336e373ed54038ac532e0500eae824be5886e876bc24eff2b1be255ceb85e20585f069348a63baa6e3ed9bb96953eb03aa8af92e8c8c40557096ad9808a5a4
+  data.tar.gz: 3a97bb255bb67dae639ef478e5954fa64b1dbb479ae6b50707bc7e3b356d2d128209b6c11237e4c4af287765253dd2abb4ec74c71b76721c607e0c6919d6dbff

data/README.md

@@ -1,8 +1,16 @@
 # ThirteenF
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/thirteen_f`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A ruby interface for S.E.C. 13-F Data. There is a lot of great finance and
+investing data that is available for free, but few developer tools that let
+us interact with the data outside of commercial platforms. This library
+aims to remedy a small piece of this by providing a robust API to search and
+retrieve investment holdings data of institutional investors through 13F
+Reports. What is a 13F Report? Please visit
+[this S.E.C. webpage](https://www.sec.gov/fast-answers/answers-form13fhtm.html)
+ for a full description.
+
+This library is meant to serve a lightweight API which developers can enhance
+via a persistence layer in their own applications.
 
 ## Installation
 

data/lib/thirteen_f/company.rb

@@ -4,7 +4,7 @@ require 'http'
 
 class ThirteenF
   class Company
-    attr_reader :cik, :name, :state_or_country
+    attr_reader :cik, :name, :state_or_country, :filings
 
     BASE_URL = 'https://www.sec.gov'
 
@@ -42,19 +42,23 @@ class ThirteenF
       "#{sec_filings_page_url}&type=13f&count=#{count}"
     end
 
-    def get_links_to_filings
-      response = HTTP.get thirteen_f_filings_url
-      page = Nokogiri::HTML response.to_s
-      # compare these two - documents_button would be more direct
-      rows = page.search('table/tableFile2 > tr')[1..-1]
-      btns = page.search('#documentsbutton')
-      p [rows.count, btns.count]
+    def get_filings(count: 100)
+      @filings = Filing.from_index_urls thirteen_f_urls(count: count)
+      true
     end
 
     private
       def self.parse_name(name_cell)
         name_cell.text.split("\n").first
       end
+
+      def thirteen_f_urls(count: 100)
+        response = HTTP.get thirteen_f_filings_url(count: count)
+        page = Nokogiri::HTML response.to_s
+        page.search('#documentsbutton').map do |btn|
+          "#{BASE_URL + btn.attributes['href'].value}"
+        end
+      end
   end
 end
 

data/lib/thirteen_f/filing.rb

@@ -1,11 +1,128 @@
 # frozen_string_literal: true
 
 require 'http'
+require 'date'
 
 class ThirteenF
   class Filing
-    def initialize
+    attr_reader :index_url, :table_html_url, :table_xml_url,
+      :cover_page_html_url, :cover_page_xml_url, :complete_text_file_url,
+      :period_of_report, :time_accepted, :response_status
+
+    BASE_URL = 'https://www.sec.gov'
+
+    def self.from_index_urls(urls)
+      redo_count = 0
+      urls.map do |index_url|
+        response = HTTP.get index_url
+        sleep 0.33
+        if response.status == 200
+          redo_count = 0
+          attributes = set_attributes(response, index_url)
+          new(**attributes)
+        else
+          redo_count += 1
+          redo unless redo_count > 1
+          attributes = bad_response_attributes(response, index_url)
+          new(**attributes)
+        end
+      end
+    end
+
+    def reset_attributes_from_index_url
+      return unless index_url
+      response = HTTP.get index_url
+      sleep 0.33
+      if response.status == 200
+        attributes = self.class.set_attributes(response, index_url)
+        assign_attributes(**attributes)
+        true
+      else
+        false
+      end
+    end
+
+    def initialize(response_status:, index_url:, complete_text_file_url:,
+                   period_of_report:, time_accepted:, table_html_url: nil,
+                   table_xml_url: nil, cover_page_html_url: nil,
+                   cover_page_xml_url: nil)
+      @response_status = response_status
+      @index_url = index_url
+      @table_html_url = table_html_url
+      @table_xml_url = table_xml_url
+      @cover_page_html_url = cover_page_html_url
+      @cover_page_xml_url = cover_page_xml_url
+      @complete_text_file_url = complete_text_file_url
+      @period_of_report = period_of_report
+      @time_accepted = time_accepted
       true
     end
+
+    private
+      def self.set_attributes(response, index_url)
+        page = Nokogiri::HTML response.to_s
+        table_links = page.search('table.tableFile')[0].search('a')
+        attributes = Hash.new
+        attributes[:response_status] = response.status.to_s
+        attributes[:index_url] = index_url
+        attributes[:period_of_report] = get_period_of_report page
+        attributes[:time_accepted] = get_time_accepted page
+        attributes[:complete_text_file_url] = "#{BASE_URL + table_links[-1].attributes['href'].value}"
+        if table_links.count == 5
+          attributes = xml_present(attributes, table_links)
+        end
+        attributes
+      end
+
+      def self.get_period_of_report(page)
+        period_header_div = page.search('div.infoHead').find do |div|
+          div.text.include?('Period of Report')
+        end
+        period_string = period_header_div.next.next.text.strip
+        Date.parse period_string
+      end
+
+      def self.get_time_accepted(page)
+        accepted_header_div = page.search('div.infoHead').find do |div|
+          div.text.include?('Accepted')
+        end
+        accepted_string = accepted_header_div.next.next.text.strip
+        DateTime.parse accepted_string
+      end
+
+      def self.xml_present(attributes, table_links)
+        attributes[:table_html_url] = "#{BASE_URL + table_links[2].attributes['href'].value}"
+        attributes[:table_xml_url] = "#{BASE_URL + table_links[3].attributes['href'].value}"
+        attributes[:cover_page_html_url] = "#{BASE_URL + table_links[0].attributes['href'].value}"
+        attributes[:cover_page_xml_url] = "#{BASE_URL + table_links[1].attributes['href'].value}"
+        attributes
+      end
+
+      def self.bad_response_attributes(response, index_url)
+        attributes = Hash.new
+        attributes[:response_status] = response.status.to_s
+        attributes[:index_url] = index_url
+        attributes[:period_of_report] = nil
+        attributes[:time_accepted] = nil
+        attributes[:complete_text_file_url] = nil
+        attributes
+      end
+
+      def assign_attributes(response_status:, index_url:, complete_text_file_url:,
+                    period_of_report:, time_accepted:, table_html_url: nil,
+                    table_xml_url: nil, cover_page_html_url: nil,
+                    cover_page_xml_url: nil)
+        @response_status = response_status
+        @index_url = index_url
+        @table_html_url = table_html_url
+        @table_xml_url = table_xml_url
+        @cover_page_html_url = cover_page_html_url
+        @cover_page_xml_url = cover_page_xml_url
+        @complete_text_file_url = complete_text_file_url
+        @period_of_report = period_of_report
+        @time_accepted = time_accepted
+        true
+      end
   end
 end
+

data/lib/thirteen_f/search.rb

@@ -25,7 +25,7 @@ class ThirteenF
       else
         raise 'SEC results are not available right now'
       end
-
+      true
     end
 
     private

data/lib/thirteen_f/version.rb

@@ -1,3 +1,3 @@
 class ThirteenF
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/thirteen_f.gemspec

@@ -6,17 +6,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ["fordfischer"]
   spec.email         = ["fordfischer07@gmail.com"]
 
-  spec.summary       = %q{thirteen_f lets you easily interact with SEC 13-F
-  filing data in all the ways we think normal human beings might want to. The
-  SEC is the U.S. Securities and Exchange Commission. 13-F filings are
-  disclosures large investors in public securites have to provide and make
-  public every quarter.}
+  spec.summary       = %q{A ruby interface for S.E.C. 13-F Data.}
 
   spec.description   = %q{thirteen_f lets you easily interact with SEC 13-F
   filing data in all the ways we think normal human beings might want to. The
   SEC is the U.S. Securities and Exchange Commission. 13-F filings are
-  disclosures large investors in public securites have to provide and make
-  public every quarter.}
+  disclosures large institutional investors in public securites have to provide
+  and make public every quarter.}
   spec.homepage      = "https://github.com/fordfischer/thirteen_f"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thirteen_f
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - fordfischer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -70,8 +70,8 @@ description: |-
   thirteen_f lets you easily interact with SEC 13-F
     filing data in all the ways we think normal human beings might want to. The
     SEC is the U.S. Securities and Exchange Commission. 13-F filings are
-    disclosures large investors in public securites have to provide and make
-    public every quarter.
+    disclosures large institutional investors in public securites have to provide
+    and make public every quarter.
 email:
 - fordfischer07@gmail.com
 executables: []
@@ -119,8 +119,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: thirteen_f lets you easily interact with SEC 13-F filing data in all the
-  ways we think normal human beings might want to. The SEC is the U.S. Securities
-  and Exchange Commission. 13-F filings are disclosures large investors in public
-  securites have to provide and make public every quarter.
+summary: A ruby interface for S.E.C. 13-F Data.
 test_files: []