sec_query 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ca7e36c7306d858ca010571400b4df5c273897d
-  data.tar.gz: b93df93f32e265f347c8fcd5b66382a764b0040a
+  metadata.gz: 85944bfa167ef27d49aee0beaeed632b44a44fa0
+  data.tar.gz: 536db81b013206c45038b8f10d697ffc4158621c
 SHA512:
-  metadata.gz: 2067ffe3a65836341b7c37ac488d9e32c5806064a11774b611d1c69e4ae14ea6346d7facfb37600d720f6b217762bb95f23c51c89e89b7b9b218b94458db92dc
-  data.tar.gz: 9d0e6373c249503fadd9e580f8a2b2e69789d7368790af5dd02787f714c475efdf452d27566ad0dd3c86ea6c2d81d14d7a1c51d55bb8d36710974c5d061effc8
+  metadata.gz: baccb44f714eb163c13aa2f5313d8e6fd34794ee4cdb92bd386dc1c0e2c9e666475983d8662de49c8f99d42daf44a7bfbd429bfd00dd585140424770e3dc8295
+  data.tar.gz: 26a9c698c541f28f980c7937921f761665c721ffb4c86021b42b89bfcf0e911d1adf7c925099e09919060b982a26bde7ac541b5f54343b7ffe013f9d9415b02c

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+bundler_args: ''
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.4
+  - 2.3.7
+before_install:
+  - gem install bundler --version '~> 2.0.1'
+

data/README.md

@@ -88,7 +88,7 @@ Middle initial or name is optional, but helps when there are multiple results fo
 
 Returns a list of Sec::Filing instances for an Sec::Entity
 
-### Sec::Filing
+### SecQuery::Filing
 
 SecQuery::Filing instance may contains the following attributes:
 
@@ -99,6 +99,7 @@ SecQuery::Filing instance may contains the following attributes:
 * term
 * date
 * file_id
+* detail
 
 #### Class Methods
 
@@ -115,6 +116,27 @@ end
 
 Requires a block. Returns the most recent filings. Use start, count and limit to iterate through recent filings.
 
+### SecQuery::FilingDetail
+Represents the detail page for a given filing. 
+Ex: [Filing Detail page](https://www.sec.gov/Archives/edgar/data/320193/000032019317000070/0000320193-17-000070-index.htm) of Apple's Annual Report from 2017
+
+#### Instance Methods
+* link
+* filing_date
+* accepted_date
+* period_of_report
+* sec_access_number
+* document_count
+* format_files
+* data_files
+
+#### Class Methods
+##### .fetch
+```
+appl_10k_details_url = 'https://www.sec.gov/Archives/edgar/data/320193/000032019317000070/0000320193-17-000070-index.htm'
+filing_detail = SecQuery::FilingDetail.fetch(appl_10k_details_url)
+```
+
 ## To Whom It May Concern at the SEC
 
 Over the last decade, I have gotten to know Edgar quite extensively and I have grown quite fond of it and the information it contains. So it is with my upmost respect that I make the following suggestions:

data/Rakefile

@@ -1 +1,9 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+
+task default: :test
+

data/lib/sec_query.rb

@@ -12,5 +12,6 @@ require 'rubygems'
 # internal
 require 'sec_query/entity'
 require 'sec_query/filing'
+require 'sec_query/filing_detail'
 require 'sec_query/sec_uri'
 require 'sec_query/version'

data/lib/sec_query/filing.rb

@@ -14,6 +14,10 @@ module SecQuery
       end
     end
 
+    def detail
+      @detail ||= FilingDetail.fetch(@link)
+    end
+
     def self.fetch(uri, &blk)
       open(uri) do |rss|
         parse_rss(rss, &blk)
@@ -138,6 +142,11 @@ module SecQuery
       parse(cik, document)
     end
 
+    def self.last(cik, args = {})
+      filings = find(cik, 0, 1, args)
+      filings.is_a?(Array) ? filings.first : nil
+    end
+
     def self.parse(cik, document)
       filings = []
       if document.xpath('//content').to_s.length > 0

data/lib/sec_query/filing_detail.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+
+module SecQuery
+  # => SecQuery::FilingDetail
+  # SecQuery::FilingDetail requests and parses Filing Detail for any given SecQuery::Filing
+  class FilingDetail
+    COLUMNS = [:link, :filing_date, :accepted_date, :period_of_report, :sec_access_number, :document_count, :format_files, :data_files]
+
+    attr_accessor(*COLUMNS)
+
+    def initialize(filing_detail)
+      COLUMNS.each do |column|
+        instance_variable_set("@#{ column }", filing_detail[column])
+      end
+    end
+
+    def self.fetch(uri)
+      document = Nokogiri::HTML(open(uri.gsub('http:', 'https:')))
+      filing_date = document.xpath('//*[@id="formDiv"]/div[2]/div[1]/div[2]').text
+      accepted_date = document.xpath('//*[@id="formDiv"]/div[2]/div[1]/div[4]').text
+      period_of_report = document.xpath('//*[@id="formDiv"]/div[2]/div[2]/div[2]').text
+      sec_access_number = document.xpath('//*[@id="secNum"]/text()').text.strip
+      document_count = document.xpath('//*[@id="formDiv"]/div[2]/div[1]/div[6]').text.to_i
+      format_files_table = document.xpath("//table[@summary='Document Format Files']")
+      data_files_table = document.xpath("//table[@summary='Data Files']")
+
+      format_files = (parsed = parse_files(format_files_table)) && (parsed || [])
+      data_files = (parsed = parse_files(data_files_table)) && (parsed || [])
+
+      new({uri: uri,
+           filing_date: filing_date,
+           accepted_date: accepted_date,
+           period_of_report: period_of_report,
+           sec_access_number: sec_access_number,
+           document_count: document_count,
+           format_files: format_files,
+           data_files: data_files})
+    end
+
+    def self.parse_files(format_files_table)
+      # get table headers
+      headers = []
+      format_files_table.xpath('//th').each do |th|
+        headers << th.text
+      end
+
+      # get table rows
+      rows = []
+      format_files_table.xpath('//tr').each_with_index do |row, i|
+        rows[i] = {}
+        row.xpath('td').each_with_index do |td, j|
+          if td.children.first && td.children.first.name == 'a'
+            relative_url = td.children.first.attributes.first[1].value
+            rows[i][headers[j]] = {
+                'link' => "https://www.sec.gov#{relative_url}",
+                'text' => td.text.gsub(/\A\p{Space}*/, '')
+            }
+          else
+            rows[i][headers[j]] = td.text.gsub(/\A\p{Space}*/, '')
+          end
+        end
+      end
+
+      rows.reject(&:empty?)
+    end
+  end
+end

data/lib/sec_query/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 # => SecQuery::VERSION
 module SecQuery
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/sec_query.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.add_development_dependency 'bundler', '~> 2.0.1'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.5'
   s.add_development_dependency 'vcr', '~> 3.0'
   s.add_development_dependency 'webmock', '~> 2.3'
@@ -26,6 +28,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'byebug', '~> 9.0'
   s.add_runtime_dependency 'rest-client', '~> 2.0'
   s.add_runtime_dependency 'addressable', '~> 2.5'
-  s.add_runtime_dependency 'nokogiri', '~> 1.7'
+  s.add_runtime_dependency 'nokogiri', '>= 1.8.5'
   s.add_runtime_dependency 'activesupport', '>= 0'
-end
+end

data/spec/sec_query/filing_spec.rb

@@ -101,5 +101,61 @@ describe SecQuery::Filing do
         expect(f.content).to match(/^(<SEC-DOCUMENT>)/)
       end
     end
+
+    describe "::last", vcr: { cassette_name: "Steve Jobs"} do
+      let(:cik) { "0000320193" }
+
+      context 'when querying by cik' do
+        let(:filing) { SecQuery::Filing.last(cik) }
+
+        it 'returns the first filing' do
+          expect(filing).to be_kind_of(SecQuery::Filing)
+          is_valid_filing?(filing)
+        end
+      end
+
+      context 'when querying cik and by type param' do
+        let(:filing) { SecQuery::Filing.last(cik,{ type: "10-K" }) }
+
+        describe "Filings", vcr: { cassette_name: "Steve Jobs"} do
+          it "should return filing of type 10-K" do
+            expect(filing).to be_kind_of(SecQuery::Filing)
+            expect(filing.term).to eq "10-K"
+          end
+        end
+      end
+    end
+  end
+
+  describe '#detail', vcr: { cassette_name: 'Steve Jobs'} do
+    let(:cik) { '0000320193' }
+    let(:filing) { SecQuery::Filing.find(cik, 0, 1, {type: type}).first }
+    subject(:filing_detail) { filing.detail }
+
+    shared_examples 'Valid SecQuery::FilingDetail' do |filing_type|
+      it 'valid filing detail' do
+        expect(filing_detail).to be_a SecQuery::FilingDetail
+        expect((Date.strptime(subject.filing_date, '%Y-%m-%d') rescue false)).to be_a Date
+        expect((DateTime.strptime(subject.accepted_date, '%Y-%m-%d %H:%M:%S') rescue false)).to be_a DateTime
+        expect((Date.strptime(subject.period_of_report, '%Y-%m-%d') rescue false)).to be_a Date
+        expect(filing_detail.sec_access_number).to match /^[0-9]{10}-[0-9]{2}-[0-9]{6}$/ # ex: 0000320193-18-000100
+        expect(filing_detail.document_count).to be > 0
+
+
+        expect(filing_detail.data_files).not_to be_empty if filing_type == '10-K'
+        expect(filing_detail.data_files).to be_empty if filing_type == '4'
+        expect(filing_detail.format_files).not_to be_empty
+      end
+    end
+
+    context '10-K' do
+      let(:type) { '10-K' }
+      it_behaves_like 'Valid SecQuery::FilingDetail', '10-K'
+    end
+
+    context 'Form 4' do
+      let(:type) { '4' }
+      it_behaves_like 'Valid SecQuery::FilingDetail', '4'
+    end
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sec_query
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Ty Rauber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +140,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.8.5
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -145,13 +173,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/sec_query.rb
 - lib/sec_query/entity.rb
 - lib/sec_query/filing.rb
+- lib/sec_query/filing_detail.rb
 - lib/sec_query/sec_uri.rb
 - lib/sec_query/version.rb
 - sec_query.gemspec