sec_query 1.1.0 → 1.5.0

data/lib/sec_query/version.rb

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

data/sec_query.gemspec

@@ -2,7 +2,6 @@
 $:.push File.expand_path('../lib', __FILE__)
 
 require 'sec_query/version'
-require 'sec_query'
 
 Gem::Specification.new do |s|
   s.name        = 'sec_query'
@@ -12,7 +11,7 @@ Gem::Specification.new do |s|
   s.license       = 'MIT'
   s.homepage    = 'https://github.com/tyrauber/sec_query'
   s.summary     = 'A ruby gem for querying the United States Securities and Exchange Commission Edgar System.'
-  s.description = 'Search for company or person, by name, symbol or Central Index Key (CIK), and retrieve relationships, transactions and filings.'
+  s.description = 'Search for company or person, by name, symbol or Central Index Key (CIK), and retrieve filings.'
 
   s.rubyforge_project = 'sec_query'
   s.files         = `git ls-files`.split("\n")
@@ -20,11 +19,15 @@ 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 'rspec', '~> 2.14'
-  s.add_development_dependency 'vcr', '~> 2.9'
-  s.add_development_dependency 'webmock', '~> 1.17'
-  s.add_development_dependency 'rubocop', '~> 0.20'
-  s.add_runtime_dependency 'addressable', '~> 2.3'
-  s.add_runtime_dependency 'rest-client', '~> 1.6'
-  s.add_runtime_dependency 'nokogiri', '~> 1.6'
-end
+  s.add_development_dependency 'bundler', '~> 2.2.14'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.10'
+  s.add_development_dependency 'vcr', '~> 6.0'
+  s.add_development_dependency 'webmock', '~> 3.12'
+  s.add_development_dependency 'rubocop', '~> 1.11'
+  s.add_runtime_dependency 'rest-client', '~> 2.1.0'
+  s.add_runtime_dependency 'addressable', '~> 2.7'
+  s.add_runtime_dependency 'nokogiri', '~> 1'
+  s.add_runtime_dependency 'activesupport', '~> 5.2'
+  s.add_runtime_dependency 'rss', '~> 0.2'
+end

data/spec/sec_query/entity_spec.rb

@@ -7,7 +7,7 @@ describe SecQuery::Entity do
 
   describe "Company Queries", vcr: { cassette_name: "aapl"} do
 
-    let(:query){{name: "APPLE INC", sic: "3571", symbol: "aapl", cik:"0000320193"}}
+    let(:query){{name: "Apple Inc.", sic: "3571", symbol: "aapl", cik:"0000320193"}}
     
     [:symbol, :cik, :name].each do |key|
       context "when quering by #{key}" do
@@ -37,7 +37,40 @@ describe SecQuery::Entity do
       end
     end
   end
-  
+
+  describe "Company Queries - Alphabet Inc.", vcr: { cassette_name: "googl"} do
+
+    let(:query){{name: "Alphabet Inc.", sic: "7370", symbol: "googl", cik:"0001652044"}}
+
+    [:symbol, :cik, :name].each do |key|
+      context "when quering by #{key}" do
+        describe "as hash" do
+
+          let(:entity){ SecQuery::Entity.find({ key => query[key] }) }
+
+          it "should be valid" do
+            is_valid?(entity)
+          end
+
+          it "should have a valid mailing address" do
+            is_valid_address?(entity.mailing_address)
+          end
+
+          it "should have a valid business address" do
+            is_valid_address?(entity.business_address)
+          end
+        end
+
+        describe "as string" do
+          it "should be valid" do
+            entity = SecQuery::Entity.find(query[key])
+            is_valid?(entity)
+          end
+        end
+      end
+    end
+  end
+
   describe "People Queries", vcr: { cassette_name: "Steve Jobs"} do
   
     let(:query){ { name: "JOBS STEVEN P", :cik => "0001007844" } }

data/spec/sec_query/filing_spec.rb

@@ -5,57 +5,32 @@ require 'spec_helper'
 describe SecQuery::Filing do
   it '::uri_for_recent' do
     expect(SecQuery::Filing.uri_for_recent.to_s)
-      .to eq('http://www.sec.gov/cgi-bin/browse-edgar?action=getcurrent&company&count=100&output=atom&owner=include&start=0')
+      .to eq('https://www.sec.gov/cgi-bin/browse-edgar?action=getcurrent&company&count=100&output=atom&owner=include&start=0')
   end
 
   it '::uri_for_cik' do
     expect(SecQuery::Filing.uri_for_cik('testing').to_s)
-      .to eq('http://www.sec.gov/cgi-bin/browse-edgar?CIK=testing&action=getcompany&company&count=100&output=atom&owner=include&start=0')
+      .to eq('https://www.sec.gov/cgi-bin/browse-edgar?CIK=testing&action=getcompany&company&count=100&output=atom&owner=include&start=0')
   end
 
-  describe '::filings_for_index' do
-    let(:index) { File.read('./spec/support/idx/test.idx') }
-    let(:filing1) { SecQuery::Filing.filings_for_index(index).first }
+  describe '::for_date', vcr: { cassette_name: 'idx' } do
+    let(:index) { SecQuery::Filing.for_date(Date.parse('20161230')) }
 
     it 'parses all of the filings' do
-      expect(SecQuery::Filing.filings_for_index(index).count).to eq(4628)
+      expect(index.count).to eq(2554)
     end
 
     it 'correctly parses out the link' do
-      expect(filing1.link)
-        .to eq('http://www.sec.gov/Archives/edgar/data/38723/0000038723-14-000001.txt')
+      expect(index.first.link)
+        .to match(/https:\/\/www.sec.gov\/Archives\/edgar\/data\//)
     end
 
     it 'correctly parses out the cik' do
-      expect(filing1.cik).to eq('38723')
+      expect(index.first.cik).to eq('1605941')
     end
 
     it 'correctly parses out the term' do
-      expect(filing1.term).to eq('424B3')
-    end
-  end
-
-  describe '::for_date' do
-    let(:filings) do
-      [].tap do |filings|
-        SecQuery::Filing.for_date(Date.parse('20121123')) do |f|
-          filings << f
-        end
-      end
-    end
-
-    let(:filing1) { filings.first }
-
-    it 'correctly parses a filing from a zipped company index' do
-      expect(filing1.term).to eq('4')
-      expect(filing1.cik).to eq('1551138')
-      expect(filing1.date).to eq(Date.parse('20121123'))
-      expect(filing1.link)
-        .to eq('http://www.sec.gov/Archives/edgar/data/1551138/0001144204-12-064668.txt')
-    end
-
-    it 'returns nil if for_date is run on a market close day' do
-      expect(SecQuery::Filing.for_date(Date.parse('20120101'))).to eq(nil)
+      expect(index.first.term).to eq('N-CSR')
     end
   end
 
@@ -86,61 +61,101 @@ describe SecQuery::Filing do
   end
 
   describe "::find" do
-    let(:query){{
-     name: "JOBS STEVEN P", :cik => "0001007844",
-      relationships:[
-        {cik: "0000320193", name: "APPLE INC"},
-        {cik: "0001001039", name: "WALT DISNEY CO/"},
-        {cik: "0001002114", name: "PIXAR \\CA\\"}
-      ],
-      transactions:[
-        {filing_number: "0001181431-07-052839", reporting_owner: "APPLE INC", shares:120000.0},
-        {filing_number: "0001181431-07-052839", reporting_owner: "APPLE INC", shares: 40000.0},
-        {filing_number: "0001181431-07-052839", reporting_owner: "APPLE INC", shares: 40000.0},
-        {filing_number: "0001181431-07-052839", reporting_owner: "APPLE INC", shares: 40000.0},
-        {filing_number: "0001181431-06-028746", reporting_owner: "WALT DISNEY CO/", shares: 138000004.0},
-        {filing_number: "0001356184-06-000008", reporting_owner: "PIXAR \\CA\\", shares: 60000002.0},
-        {filing_number: "0001181431-06-019230", reporting_owner: "APPLE COMPUTER INC", shares: 4573553.0},
-        {filing_number: "0001181431-06-028747", reporting_owner: "WALT DISNEY CO/", shares: 0.0}
-      ],
-      filings:[
-        {cik: "0001007844", file_id: "0001181431-07-052839"},
-        {cik: "0001007844", file_id: "0001356184-06-000008"},
-        {cik: "0001007844", file_id: "0001193125-06-103741"},
-        {cik: "0001007844", file_id: "0001181431-06-028747"},
-        {cik: "0001007844", file_id: "0001181431-06-028746"},
-        {cik: "0001007844", file_id: "0001181431-06-019230"},
-        {cik: "0001007844", file_id: "0001193125-06-019727"},
-        {cik: "0001007844", file_id: "0001104659-03-004723"}
-      ]
-    }}
-
-    let(:entity) {SecQuery::Entity.find(query[:cik])}
-
-    describe "Filings", vcr: { cassette_name: "Steve Jobs"} do
-      it "should respond to filings" do
-        entity.should respond_to(:filings)
-        entity.filings.should be_kind_of(Array)
+    shared_examples_for "it found filings" do
+      it "should return an array of filings" do
+        expect(filings).to be_kind_of(Array)
       end
 
-      it "should be valid filing" do
-        is_valid_filing?(entity.filings.first)
+      it "the filings should be valid" do
+        is_valid_filing?(filings.first)
       end
     end
 
+    let(:cik){"0000320193"}
+    
+    context "when querying by cik" do
+      let(:filings){ SecQuery::Filing.find(cik) }
+
+      describe "Filings", vcr: { cassette_name: "Steve Jobs"} do
+        it_behaves_like "it found filings"
+      end
+    end
+    
+    context "when querying cik and by type param" do
+      let(:filings){ SecQuery::Filing.find(cik, 0, 40, { type: "10-K" }) }
+
+      describe "Filings", vcr: { cassette_name: "Steve Jobs"} do
+        it_behaves_like "it found filings"
+
+        it "should only return filings of type" do
+          expect(filings.first.term).to eq "10-K"
+        end
+      end
+    end
+    
     describe '#content', vcr: { cassette_name: 'content' } do
+      let(:index) { SecQuery::Filing.for_date(Date.parse('20161230')) }
+      
       it 'returns content of the filing by requesting the link' do
-        f = Filing.new(
-          cik: 123,
-          title: 'test filing title',
-          summary: 'test filing',
-          link: 'http://www.sec.gov/Archives/edgar/data/1572871/000114036114019536/0001140361-14-019536.txt',
-          term: '4',
-          date: Date.today,
-          file_id: 1
-        )
-        expect(f.content).to eq(File.read('./spec/support/filings/filing.txt'))
+        f = Filing.new(link: index.first.link)
+        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

data/spec/sec_query/sec_uri_spec.rb

@@ -7,31 +7,31 @@ describe SecQuery::SecURI do
   describe '#browse_edgar_uri' do
     it 'builds a default /browse-edgar/ url' do
       uri = SecQuery::SecURI.browse_edgar_uri
-      expect(uri.to_s).to eq('http://www.sec.gov/cgi-bin/browse-edgar')
+      expect(uri.to_s).to eq('https://www.sec.gov/cgi-bin/browse-edgar')
     end
 
     it 'builds a default /browse-edgar/ url with options: {symbol: "AAPL"}' do
       uri = SecQuery::SecURI.browse_edgar_uri(symbol: 'AAPL')
       expect(uri.to_s)
-        .to include('http://www.sec.gov/cgi-bin/browse-edgar?CIK=AAPL')
+        .to include('https://www.sec.gov/cgi-bin/browse-edgar?CIK=AAPL')
     end
 
     it 'builds a default /browse-edgar/ url with options: {cik: "AAPL"}' do
       uri = SecQuery::SecURI.browse_edgar_uri(cik: 'AAPL')
       expect(uri.to_s)
-        .to include('http://www.sec.gov/cgi-bin/browse-edgar?CIK=AAPL')
+        .to include('https://www.sec.gov/cgi-bin/browse-edgar?CIK=AAPL')
     end
 
     it 'builds a default /browse-edgar/ url with options: "AAPL"' do
       uri = SecQuery::SecURI.browse_edgar_uri('AAPL')
       expect(uri.to_s)
-        .to eq('http://www.sec.gov/cgi-bin/browse-edgar?CIK=AAPL')
+        .to eq('https://www.sec.gov/cgi-bin/browse-edgar?CIK=AAPL')
     end
 
-    it 'builds a default /browse-edgar/ url with options: "Apple"' do
-      uri = SecQuery::SecURI.browse_edgar_uri('Apple')
+    it 'builds a default /browse-edgar/ url with options: "Apple Inc"' do
+      uri = SecQuery::SecURI.browse_edgar_uri('Apple Inc')
       expect(uri.to_s)
-        .to eq('http://www.sec.gov/cgi-bin/browse-edgar?company=Apple')
+        .to eq('https://www.sec.gov/cgi-bin/browse-edgar?company=Apple%20Inc')
     end
   end
 

data/spec/spec_helper.rb

@@ -6,24 +6,24 @@ require 'sec_query'
 require 'support/vcr'
 
 def is_valid?(entity)
-  entity.should_not be_nil
-  entity.name.should  == query[:name]
-  entity.cik.should == query[:cik]
+  expect(entity).to_not be_nil
+  expect(entity.name).to eq query[:name]
+  expect(entity.cik).to eq query[:cik]
   entity.instance_variables.each do |key|
-    SecQuery::Entity::COLUMNS.should include(key[1..-1].to_sym)
+    expect(SecQuery::Entity::COLUMNS).to include(key[1..-1].to_sym)
   end
 end
 
 def is_valid_address?(address)
-  address.should_not be_nil
+  expect(address).to_not be_nil
   address.keys.each do |key|
-    ['city', 'state', 'street1', 'street2', 'type', 'zip', 'phone'].should include(key)
+    expect(['city', 'state', 'street1', 'street2', 'type', 'zip', 'phone']).to include(key)
   end
 end
 
 def is_valid_filing?(filing)
-  filing.should_not be_nil
+  expect(filing).to_not be_nil
   filing.instance_variables.each do |key|
-    SecQuery::Filing::COLUMNS.should include(key[1..-1].to_sym)
+    expect(SecQuery::Filing::COLUMNS).to include(key[1..-1].to_sym)
   end
 end

metadata

@@ -1,147 +1,199 @@
 --- !ruby/object:Gem::Specification
 name: sec_query
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ty Rauber
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+- !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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.2'
 description: Search for company or person, by name, symbol or Central Index Key (CIK),
-  and retrieve relationships, transactions and filings.
+  and retrieve filings.
 email:
 - tyrauber@mac.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/sec_query.rb
 - lib/sec_query/entity.rb
 - lib/sec_query/filing.rb
-- lib/sec_query/relationship.rb
+- lib/sec_query/filing_detail.rb
 - lib/sec_query/sec_uri.rb
-- lib/sec_query/transaction.rb
 - lib/sec_query/version.rb
 - sec_query.gemspec
 - spec/sec_query/entity_spec.rb
 - spec/sec_query/filing_spec.rb
 - spec/sec_query/sec_uri_spec.rb
-- spec/sec_query/transaction_spec.rb
 - spec/spec_helper.rb
-- spec/support/filings/filing.txt
-- spec/support/idx/test.idx
 - spec/support/vcr.rb
 homepage: https://github.com/tyrauber/sec_query
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,9 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: sec_query
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: A ruby gem for querying the United States Securities and Exchange Commission
   Edgar System.
@@ -166,9 +217,5 @@ test_files:
 - spec/sec_query/entity_spec.rb
 - spec/sec_query/filing_spec.rb
 - spec/sec_query/sec_uri_spec.rb
-- spec/sec_query/transaction_spec.rb
 - spec/spec_helper.rb
-- spec/support/filings/filing.txt
-- spec/support/idx/test.idx
 - spec/support/vcr.rb
-has_rdoc: