sec_query 1.0.4 → 1.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2MyNjkwMGQyYzk4NmYwY2IxM2Q3YmU1NDlmZDJmNGI5NzQ0YzllMA==
+  data.tar.gz: !binary |-
+    YTQ1MThkMWUwYzFlYTFiMDMxMzVhMDVhMTIwMGVlZDlkNWU1OWFiYQ==
+SHA512:
+  metadata.gz: !binary |-
+    MjQyMmY0NzViYjY4ZDMwMzVmNDRkMDg2NzEzZWJjZGNjYjUyM2JhN2IwNzk1
+    YmE2YjI1Mjg5MTBhMjI5ODkwMGY1MGRjNjkyZDdkN2E3ZDg5M2E2MDU0MDA2
+    ZGU5MmFkOGEyOGZiNGNjMTU5YzNjMDdlZTFlYWU5N2RkODg1ZmE=
+  data.tar.gz: !binary |-
+    NWY4MzFmZjJlYmE1YTMyYWViNzY1MzgxOTExMjkyZWY4ZjdmZDJlOGRiNGVh
+    MWEyODVhMTdiYmM4MTk1M2U3ZGE1Yzk5MTI4MjA3MGFkYmQ3MTU0OGEzMTJh
+    ZDcwMjU1MDliNzFiNDU2OTA0Y2U4YzYxNGE3ODYwZTA0NjA2ZmE=

data/README.md

@@ -80,15 +80,6 @@ For example,
 
 The above query will only return the last 20 transactions and filings.  This is helpful when querying companies that may have thousands or tens of thousands of transactions or filings.
 
-### Entity.log(entity)
-
-For doing terminal queries, there is a log function that formats and prints the entity data to your terminal window.
-
-`entity = SecQuery::Entity.find("AAPL",  true)`
-
-`SecQuery::Entity.log(entity)`
-
-
 ## Classes
 
 This gem contains four classes - Entity, Relationship, Transaction and Filing.  Each Class contains the listed fields. (Everything I could parse out of the query results.)
@@ -109,6 +100,21 @@ This gem contains four classes - Entity, Relationship, Transaction and Filing.
 
 `:cik, :title, :summary, :link, :term, :date, :file_id`
 
+Filings can are fetched a few different ways. Here are some of the supported
+methods:
+
+```rb
+# prints the links for the most recent filings
+SecQuery::Filing.recent do |filing|
+  p filing.link
+end
+
+# prints all of the links for cik 0000704051 (LEGG MASON, INC.)
+SecQuery::Filing.for_cik('0000704051') do |filing|
+  p filing.link
+end
+```
+
 ## 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/lib/sec_query.rb

@@ -4,7 +4,9 @@
 require 'active_support/all'
 require 'addressable/uri'
 require 'hpricot'
+require 'open-uri'
 require 'rest-client'
+require 'rss'
 require 'rubygems'
 
 # internal

data/lib/sec_query/entity.rb

@@ -217,87 +217,5 @@ module SecQuery
 
       temp
     end
-
-    def self.log(entity)
-      if entity
-        puts '\n\t# # # # # # # # # # # # # # # # # # # # # # # # #\n\n'
-        puts "\t#{ entity.name }"
-        puts "\t(#{ entity.cik })"
-        puts "\tSIC = #{ entity.sic }" if entity.sic
-        puts "\tLocation: #{ entity.location }, " if entity.location
-
-        if entity.formerly && entity.formerly != ''
-          puts "\tFormerly: #{ entity.formerly }"
-        end
-
-        if entity.state_of_inc
-          puts "\tState of Incorporation: #{ entity.state_of_inc }"
-        end
-
-        if entity.mailing_address
-          puts "\tMailing Address:\t#{ entity.mailing_address.inspect.gsub('\n', ' ').squeeze(" ") }"
-        end
-
-        if entity.business_address
-          puts "\tBusiness Address:\t#{ entity.business_address.inspect.gsub('\n', ' ').squeeze(" ") }"
-        end
-
-        if !entity.relationships
-          puts '\n\tRELATIONSHIPS:\t0 Total'
-        else
-          puts "\n\tRELATIONSHIPS:\t#{ entity.relationships.count } Total"
-          printf("\t%-40s %-15s %-30s %-10s\n\n",
-                 'Entity',
-                 'CIK',
-                 'Position',
-                 'Date')
-          entity.relationships.each do |relationship|
-            printf("\t%-40s %-15s %-30s %-10s\n",
-                   relationship.name,
-                   relationship.cik,
-                   relationship.position,
-                   relationship.date)
-          end
-        end
-
-        if entity.transactions
-          puts "\n\tTRANSACTIONS:\t#{ entity.transactions.count } Total"
-          printf("\t%-20s %-10s %-5s %-10s %-10s %-10s %-15s %-10s\n\n",
-                 'Owner',
-                 'CIK',
-                 'Modes',
-                 'Type',
-                 'Shares',
-                 'Price',
-                 'Owned',
-                 'Date')
-          entity.transactions.each do |transaction|
-            printf("\t%-20s %-10s %-5s %-10s%-10s %-10s %-15s %-10s\n",
-                   transaction.reporting_owner,
-                   transaction.owner_cik,
-                   transaction.modes,
-                   transaction.type,
-                   transaction.shares,
-                   transaction.price,
-                   transaction.owned,
-                   transaction.date)
-          end
-        end
-
-        if entity.filings
-          puts "\n\tFILINGS:\t#{ entity.filings.count } Total"
-          printf("\t%-10s %-30s %-20s\n\n", 'Type', 'File ID', 'Date')
-          entity.filings.each do |filing|
-            printf("\t%-10s %-30s %-20s\n",
-                   filing.term,
-                   filing.file_id,
-                   filing.date)
-          end
-        end
-        puts "\t#{ entity.url }\n\n"
-      else
-        return 'No Entity found.'
-      end
-    end
   end
 end

data/lib/sec_query/filing.rb

@@ -13,16 +13,78 @@ module SecQuery
       end
     end
 
-    def self.find(entity, start, count, limit)
-      start ||= 0
-      count ||= 80
-      url = SecURI.browse_edgar_uri({
+    def self.fetch(uri, &blk)
+      open(uri) do |rss|
+        parse_rss(rss, &blk)
+      end
+    end
+
+    def self.recent(options = {}, &blk)
+      start = options.fetch(:start, 0)
+      count = options.fetch(:count, 100)
+      limit = options.fetch(:limit, 100)
+      limited_count = [limit - start, count].min
+      fetch(uri_for_recent(start, limited_count), &blk)
+      start += count
+      return if start >= limit
+      recent({ start: start, count: count, limit: limit }, &blk)
+    rescue OpenURI::HTTPError
+      return
+    end
+
+    def self.for_cik(cik, options = {}, &blk)
+      start = options.fetch(:start, 0)
+      count = options.fetch(:count, 100)
+      limit = options.fetch(:limit, 100)
+      fetch(uri_for_cik(cik, start, count), &blk)
+      start += count
+      return if start >= limit
+      for_cik(cik, { start: start, count: count, limit: limit }, &blk)
+    rescue OpenURI::HTTPError
+      return
+    end
+
+    def self.uri_for_recent(start = 0, count = 100)
+      SecURI.browse_edgar_uri(
+        action: :getcurrent,
+        owner: :include,
+        output: :atom,
+        start: start,
+        count: count
+      )
+    end
+
+    def self.uri_for_cik(cik, start = 0, count = 100)
+      SecURI.browse_edgar_uri(
         action: :getcompany,
-        CIK: entity[:cik],
+        owner: :include,
         output: :atom,
+        start: start,
         count: count,
-        start: start
-      })
+        CIK: cik
+      )
+    end
+
+    def self.parse_rss(rss, &blk)
+      feed = RSS::Parser.parse(rss, false)
+      feed.entries.each do |entry|
+        filing = Filing.new({
+          cik: entry.title.content.match(/\((\w{10})\)/)[1],
+          file_id: entry.id.content.split('=').last,
+          term:  entry.category.term,
+          title: entry.title.content,
+          summary: entry.summary.content,
+          date: DateTime.parse(entry.updated.content.to_s),
+          link: entry.link.href.gsub('-index.htm', '.txt')
+        })
+        blk.call(filing)
+      end
+    end
+
+    def self.find(entity, start, count, limit)
+      start ||= 0
+      count ||= 80
+      url = uri_for_cik(entity[:cik], start, count)
       response = Entity.query(url)
       doc = Hpricot::XML(response)
       entries = doc.search(:entry)
@@ -37,7 +99,6 @@ module SecQuery
         filing[:term] = (entry/:category)[0].get_attribute('term')
         filing[:date] = (entry/:updated).innerHTML
         filing[:file_id] = (entry/:id).innerHTML.split('=').last
-
         entity[:filings] << Filing.new(filing)
       end
       if (query_more && limit.nil?) || (query_more && !limit)

data/lib/sec_query/sec_uri.rb

@@ -1,5 +1,4 @@
 # encoding: UTF-8
-require 'debugger'
 
 module SecQuery
   class SecURI
@@ -22,8 +21,6 @@ module SecQuery
       instance
     end
 
-    private_class_method :build_with_path
-
     def self.handle_string_args(string_arg)
       options = {}
       # Uhhhg. I hate using Float here. HACK

data/lib/sec_query/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 # => SecQuery::VERSION
 module SecQuery
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

data/sec_query.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.version     = SecQuery::VERSION
   s.authors     = ['Ty Rauber']
   s.email       = ['tyrauber@mac.com']
+  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.'
@@ -19,11 +20,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  # specify any dependencies here; for example:
-  s.add_development_dependency 'rspec', '>= 2.14'
-  s.add_development_dependency 'vcr'
-  s.add_development_dependency 'webmock'
-  s.add_development_dependency 'rubocop'
-  s.add_runtime_dependency 'rest-client'
-  s.add_runtime_dependency 'hpricot'
+  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 'rest-client', '~> 1.6'
+  s.add_runtime_dependency 'hpricot', '~> 0.8'
 end

data/spec/sec_query/filing_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+include SecQuery
+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')
+  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')
+  end
+
+  describe '::recent', vcr: { cassette_name: 'recent' } do
+    let(:filings) { [] }
+    before(:each) do
+      SecQuery::Filing.recent({start: 0, count: 10, limit: 10}) do |filing|
+        filings.push filing
+      end
+    end
+
+    it 'should accept options' do
+      expect(filings.count).to eq(10)
+    end
+
+    it 'should have filing attributes', vcr: { cassette_name: 'recent' } do
+      filings.each do |filing|
+        expect(filing.cik).to be_present
+        expect(filing.title).to be_present
+        expect(filing.summary).to be_present
+        expect(filing.link).to be_present
+        expect(filing.term).to be_present
+        expect(filing.date).to be_present
+        expect(filing.file_id).to be_present
+      end
+    end
+  end
+end

metadata

@@ -1,112 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: sec_query
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Ty Rauber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: hpricot
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 description: Search for company or person, by name, symbol or Central Index Key (CIK),
   and retrieve relationships, transactions and filings.
 email:
@@ -130,38 +117,40 @@ files:
 - pkg/sec_query-1.0.2.gem
 - pkg/sec_query-1.0.3.gem
 - sec_query.gemspec
-- spec/sec_query_spec.rb
-- spec/sec_uri_spec.rb
+- spec/sec_query/filing_spec.rb
+- spec/sec_query/sec_query_spec.rb
+- spec/sec_query/sec_uri_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr.rb
 homepage: https://github.com/tyrauber/sec_query
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: sec_query
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A ruby gem for querying the United States Securities and Exchange Commission
   Edgar System.
 test_files:
-- spec/sec_query_spec.rb
-- spec/sec_uri_spec.rb
+- spec/sec_query/filing_spec.rb
+- spec/sec_query/sec_query_spec.rb
+- spec/sec_query/sec_uri_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr.rb
 has_rdoc: