thirteen_f 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b6299aaa6691236c2f61152986f601cb6714609759b85ecbfac375d74522e32
-  data.tar.gz: d9135d7b9f522841ce392cffcada7db8b8bf557bc071ed05602f904ebaf794ef
+  metadata.gz: c49261f579858881f09bf7f929b5e26ab270a3212f04d873ced78c8ff2cca5a7
+  data.tar.gz: 7357540f69f1cd5e3dd754463d362e1f8efccebf23d2a1add14d9c8a26226049
 SHA512:
-  metadata.gz: 62336e373ed54038ac532e0500eae824be5886e876bc24eff2b1be255ceb85e20585f069348a63baa6e3ed9bb96953eb03aa8af92e8c8c40557096ad9808a5a4
-  data.tar.gz: 3a97bb255bb67dae639ef478e5954fa64b1dbb479ae6b50707bc7e3b356d2d128209b6c11237e4c4af287765253dd2abb4ec74c71b76721c607e0c6919d6dbff
+  metadata.gz: 990cfd15c836e9337df3d364feb813a47e2fd20b7a1269cf622b564c52e296a2fbef56d91b84f7e530237ca3594290ad05c8dbd748abb30df4ab1164e5379858
+  data.tar.gz: 2f120c6e8afc60a95b8be94358e8aa3f03ee5f19e7e87a37451a44408618146d75ffff8684986b22dcbe0ab2b040c863c2e9d73b557b89f8d1d1fafdd82770d2

data/README.md

@@ -10,7 +10,7 @@ Reports. What is a 13F Report? Please visit
  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.
+via a persistence layer and/or UI in their own applications.
 
 ## Installation
 
@@ -34,19 +34,32 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/thirteen_f. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/thirteen_f/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/fordfischer/thirteen_f. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [code of
+conduct](https://github.com/fordfischer/thirteen_f/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the ThirteenF project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/thirteen_f/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ThirteenF project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/fordfischer/thirteen_f/blob/master/CODE_OF_CONDUCT.md).

data/lib/thirteen_f/company.rb

@@ -4,7 +4,7 @@ require 'http'
 
 class ThirteenF
   class Company
-    attr_reader :cik, :name, :state_or_country, :filings
+    attr_reader :cik, :name, :state_or_country, :filings, :most_recent_holdings
 
     BASE_URL = 'https://www.sec.gov'
 
@@ -34,6 +34,13 @@ class ThirteenF
       true
     end
 
+    def get_most_recent_holdings
+      get_filings unless filings
+      most_recent_filing = filings.select(&:period_of_report).max_by(&:period_of_report)
+      @most_recent_holdings = Position.from_xml_filing most_recent_filing
+      true
+    end
+
     def sec_filings_page_url
       "#{BASE_URL}/cgi-bin/browse-edgar?CIK=#{cik}"
     end

data/lib/thirteen_f/position.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'http'
+
+class ThirteenF
+  class Position
+    attr_reader :name_of_issuer, :title_of_class, :cusip, :value_in_thousands,
+      :shares_or_principal_amount_type, :shares_or_principal_amount, :put_or_call,
+      :investment_discretion, :other_managers, :voting_authority, :filing
+
+    def self.from_xml_filing(filing)
+      return unless filing.table_xml_url
+      response = HTTP.get filing.table_xml_url
+      xml_doc = Nokogiri::XML response.to_s
+      xml_doc.search('infoTable').map do |info_table|
+        position = new filing
+        position.attributes_from_info_table(info_table)
+        position
+      end
+    end
+
+    def initialize(filing)
+      @filing = filing
+    end
+
+    def attributes_from_info_table(info_table)
+      @name_of_issuer = info_table.search('nameOfIssuer').text
+      @title_of_class = info_table.search('titleOfClass').text
+      @cusip = info_table.search('cusip').text
+      @value_in_thousands = info_table.search('value').text
+      @shares_or_principal_amount_type = info_table.search('sshPrnamtType').text
+      @shares_or_principal_amount = info_table.search('sshPrnamt').text
+
+      not_found = info_table.search('putCall').count == 0
+      @put_or_call = info_table.search('putCall').text unless not_found
+
+      @investment_discretion = info_table.search('investmentDiscretion').text
+      @other_managers = info_table.search('otherManager').text
+      @voting_authority = {
+        sole: info_table.search('Sole').text,
+        shared: info_table.search('Shared').text,
+        none: info_table.search('None').text
+      }
+    end
+  end
+end
+

data/lib/thirteen_f/version.rb

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

data/lib/thirteen_f.rb

@@ -3,6 +3,7 @@
 require "thirteen_f/company"
 require "thirteen_f/search"
 require "thirteen_f/filing"
+require "thirteen_f/position"
 require "thirteen_f/version"
 
 class ThirteenF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thirteen_f
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - fordfischer
@@ -91,6 +91,7 @@ files:
 - lib/thirteen_f.rb
 - lib/thirteen_f/company.rb
 - lib/thirteen_f/filing.rb
+- lib/thirteen_f/position.rb
 - lib/thirteen_f/search.rb
 - lib/thirteen_f/version.rb
 - thirteen_f.gemspec