thirteen_f 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: faa86b34f746b8c24e08c909422945e7d16c1fc970532f0ed47b030484f3c75b
+  data.tar.gz: 2f6bea3847ab8ae71d4ad93935935f736b3f6aa2dbf7857ebc3ddd118d6f46cc
+SHA512:
+  metadata.gz: bae8ed73b154e06568f55d4debeef353dc67bf5dfef321f52a9a42c126177ed4ebcd92fa21e6eb0c2fdf307258b5d02faa8c09965a895de6d37e8e352b2f8b71
+  data.tar.gz: 876b5c9291b0845f14932e36143c9e5d19f5dc723a826975a0fceb390421d8ce4a522b78891ca87394b5b4a403543e5274a6719ee798d864e9b3228c1f2e0713

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/vendor/
+Gemfile.lock
+
+.gemrc
+
+*.swp
+*.swo
+

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fordfischer07@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in thirteen_f.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    thirteen_f (0.1.0)
+      http (>= 4.4)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.12.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.3)
+    rake (12.3.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  rake (~> 12.0)
+  thirteen_f!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 fordfischer
+
+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,44 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thirteen_f'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install thirteen_f
+
+## Usage
+
+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.
+
+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).
+
+
+## License
+
+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).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "thirteen_f"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/thirteen_f/company.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'http'
+
+class ThirteenF
+  class Company
+    attr_reader :cik, :name, :state_or_country
+
+    BASE_URL = 'https://www.sec.gov'
+
+    def self.from_sec_search_rows(rows)
+      rows.map do |row|
+        raise "Bad row" unless row.search('td').count == 3
+        cells = row.search('td')
+        cik = cells.first.text
+        name = parse_name cells[1]
+        state_or_country = cells.last.text
+        new cik, name, state_or_country
+      end
+    end
+
+    def self.from_company_page(page)
+      arr = page.search('.companyName').text.split('CIK#:')
+      name = arr.first.strip
+      cik = arr.last.strip.split(' ').first
+      state_or_country = page.search('.identInfo a').first.text
+      Array.new 1, new(cik, name, state_or_country)
+    end
+
+    def initialize(cik, name, state_or_country)
+      @cik = cik
+      @name = name
+      @state_or_country = state_or_country
+      true
+    end
+
+    def sec_filings_page_url
+      "#{BASE_URL}/cgi-bin/browse-edgar?CIK=#{cik}"
+    end
+
+    def thirteen_f_filings_url(count: 100)
+      "#{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]
+    end
+
+    private
+      def self.parse_name(name_cell)
+        name_cell.text.split("\n").first
+      end
+  end
+end
+

data/lib/thirteen_f/filing.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'http'
+
+class ThirteenF
+  class Filing
+    def initialize
+      true
+    end
+  end
+end

data/lib/thirteen_f/search.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'nokogiri'
+require 'pry'
+
+class ThirteenF
+  class Search
+    attr_reader :companies, :search_params
+
+    BASE_URL = 'https://www.sec.gov'
+    SEARCH_URL = "#{BASE_URL}/cgi-bin/browse-edgar"
+
+    def initialize(search_string, count: 100)
+      @search_params = [SEARCH_URL, params: {
+        company: search_string,
+        count: count
+      }]
+    end
+
+    def get_companies
+      response = HTTP.get(*search_params)
+      if response.status == 200
+        @companies = configure_search_results response
+      else
+        raise 'SEC results are not available right now'
+      end
+
+    end
+
+    private
+      def configure_search_results(response)
+        page = Nokogiri::HTML response.to_s
+        company_rows = page.search('table.tableFile2 > tr')[1..-1]
+        column_count = company_rows.first.search('td').count
+        if column_count == 3
+          company_rows.search('br').each { |n| n.replace("\n") }
+          Company.from_sec_search_rows company_rows
+        elsif column_count == 5
+          Company.from_company_page page
+        end
+      end
+  end
+end
+

data/lib/thirteen_f/version.rb

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

data/lib/thirteen_f.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "thirteen_f/company"
+require "thirteen_f/search"
+require "thirteen_f/filing"
+require "thirteen_f/version"
+
+class ThirteenF
+
+  class Error < StandardError; end
+
+end
+

data/thirteen_f.gemspec

@@ -0,0 +1,41 @@
+require_relative 'lib/thirteen_f/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thirteen_f"
+  spec.version       = ThirteenF::VERSION
+  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.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.}
+  spec.homepage      = "https://github.com/fordfischer/thirteen_f"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fordfischer/thirteen_f"
+  spec.metadata["changelog_uri"] = "https://github.com/fordfischer/thirteen_f/commits/master"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "http", ">= 4.4"
+  spec.add_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: thirteen_f
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fordfischer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email:
+- fordfischer07@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/thirteen_f.rb
+- lib/thirteen_f/company.rb
+- lib/thirteen_f/filing.rb
+- lib/thirteen_f/search.rb
+- lib/thirteen_f/version.rb
+- thirteen_f.gemspec
+homepage: https://github.com/fordfischer/thirteen_f
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fordfischer/thirteen_f
+  source_code_uri: https://github.com/fordfischer/thirteen_f
+  changelog_uri: https://github.com/fordfischer/thirteen_f/commits/master
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: 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.
+test_files: []