sec_query 1.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sec_query.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    sec_query (0.0.1)
+      hpricot
+      rest-client
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    hpricot (0.8.4)
+    mime-types (1.17.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  sec_query!

data/README.md

@@ -0,0 +1,133 @@
+# sec_query
+
+A ruby gem for searching and retrieving data from the Security and Exchange Commission's Edgar web system.
+
+Look-up an Entity - person or company - by Central Index Key (CIK), stock symbol, company name or person (by first and last name).
+
+Additionally retrieve some, or all, Relationships, Transactions and Filings as recorded by the SEC.
+
+## Installation
+
+To install the 'sec_query' Ruby Gem run the following command at the terminal prompt.
+
+`gem install sec_query`
+
+For an example of what type of information 'sec_query' can retrieve, run the following command:
+
+`bundle exec rspec spec`
+
+If running 'sec_query' from the command prompt in irb:
+
+`irb -rubygems`
+
+`require "sec_query"`
+
+`include SecQuery`
+
+## Functionality
+
+### FIND COMPANY:
+
+#### By Stock Symbol:
+
+`SecQuery::Entity.find("appl")`
+
+Or:
+
+`SecQuery::Entity.find({:symbol=> "aapl"})`
+
+#### By Name:
+
+`SecQuery::Entity.find("Apple, Inc.")`
+
+Or:
+
+`SecQuery::Entity.find({:name=> "Apple, Inc."})`
+
+#### By Central Index Key, CIK:
+
+`SecQuery::Entity.find( "0000320193")`
+
+Or: 
+
+`SecQuery::Entity.find({:cik=> "0000320193"})`
+
+#### FIND PERSON:
+
+By First, Middle and Last Name.
+
+`SecQuery::Entity.find({:first=> "Steve", :middle=> "P", :last=> "Jobs"})`
+
+Middle initial or name is optional, but helps when there are multiple results for First and Last Name.
+
+### RELATIONSHIPS, TRANSACTIONS, FILINGS
+
+To return everything - All Relationships, Transactions and Filings - that the SEC Edgar system has stored on a company or person, do any of the following commands (They all do the same thing.):
+
+`SecQuery::Entity.find("AAPL",  true)`
+
+`SecQuery::Entity.find("AAPL",  true, true, true)`
+
+`SecQuery::Entity.find("AAPL", {:relationships=> true, :transactions=> true, :filings=>true})`
+
+`SecQuery::Entity.find("AAPL", :relationships=> true, :transactions=> true, :filings=>true)`
+
+`SecQuery::Entity.find("AAPL", :relationships=> true, :transactions=> {:start=> 0, :count=> 80}, :filings=>{:start=> 0, :count=> 80})`
+
+You may also limit either the transactions or filings by adding the :limit to the transaction or filing arguements.
+
+For example,
+
+`SecQuery::Entity.find("AAPL", :relationships=> true, :transactions=> {:start=> 0, :count=>20, :limit=> 20}, :filings=>{:start=> 0, :count=> 20, :limit=> 20})`
+
+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.)
+
+* Entity
+
+`:first, :middle, :last, :name, :symbol, :cik, :url, :type, :sic, :location, :state_of_inc, :formerly, :mailing_address, :business_address, :relationships, :transactions, :filings`
+
+* Relationship
+
+`:name, :position, :date, :cik`
+
+* Transaction
+
+`:filing_number, :code, :date, :reporting_owner, :form, :type, :modes, :shares, :price, :owned, :number, :owner_cik, :security_name, :deemed, :exercise, :nature, :derivative, :underlying_1, :exercised,	:underlying_2, :expires, :underlying_3`
+
+* Filing
+
+`:cik, :title, :summary, :link, :term, :date, :file_id`
+
+## 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:
+
+* Edgar is in dire need of a proper, published RESTful API.
+* Edgar needs to be able to return XML or JSON  for any API query.
+* Edgar's search engine is atrocious; Rigid to the point of being almost unusable.
+* Edgar only goes back as far as 1993, and in most cases, only provides extensive information after 2000.
+
+It is my humble opinion that these four issues are limiting the effectiveness of Edgar and the SEC in general.  The information the SEC contains is vitally important to National Security and the stability of the American Economy and the World.  It is time to  make all information available and accessible.
+
+## License
+
+Copyright (c) 2011 Ty Rauber
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sec_query/entity.rb

@@ -0,0 +1,305 @@
+module SecQuery
+    class Entity
+
+        attr_accessor :first, :middle, :last, :name, :symbol, :cik, :url, :type, :sic, :location, :state_of_inc, :formerly, :mailing_address, :business_address, :relationships, :transactions, :filings
+        
+        def initialize(entity)
+            @first = entity[:first]
+            @middle = entity[:middle]
+            @last = entity[:last]
+            @name = entity[:name]
+            @sic = entity[:sic]
+            @url = entity[:url]
+            @location = entity[:location]
+            @state_of_inc = entity[:state_of_inc]
+            @formerly = entity[:formerly]
+            @symbol = entity[:symbol]
+            @cik = entity[:cik]
+            @type =entity[:type]
+            @mailing_address = entity[:mailing_address]
+            @business_address = entity[:business_address]
+            @relationships = entity[:relationships]
+            @transactions = entity[:transactions]
+            @filings = entity[:filings]
+        end
+   
+
+        def self.find(entity_args, *options)
+            
+            temp = {}
+            temp[:url] = Entity.url(entity_args)
+            temp[:cik] = Entity.cik(temp[:url], entity_args)
+        
+            if !temp[:cik]; return false; end
+    
+            ### Get Document and Entity Type
+            doc = Entity.document(temp[:cik])
+            temp = Entity.parse_document(temp, doc)
+
+            ### Get Additional Arguments and Query Additional Details
+            if !options.empty?;
+                temp[:transactions]=[]
+                temp[:filings] =[]
+                options = Entity.options(temp, options); 
+                temp = Entity.details(temp, options);
+            end                   
+            
+            ###  Return entity Object
+            @entity = Entity.new(temp)
+
+            return @entity
+
+        end
+
+
+        def self.query(url)
+            RestClient.get(url){ |response, request, result, &block|
+                case response.code
+                    when 200
+                    return response
+                    else
+                    response.return!(request, result, &block)
+                end
+            }
+        end
+
+
+        def self.url(args)
+            if args.is_a?(Hash)
+                if args[:symbol] != nil
+                    string = "CIK="+args[:symbol]
+                elsif args[:cik] != nil
+                    string = "CIK="+args[:cik]
+                elsif args[:first] != nil and args[:last]
+                    string = "company="+args[:last]+" "+args[:first]
+                elsif args[:name] != nil
+                    string = "company="+args[:name].gsub(/[(,?!\''"":.)]/, '')
+                end
+            elsif args.is_a?(String)
+                begin Float(args)
+                    string = "CIK="+args
+                rescue
+                    if args.length <= 4
+                        string = "CIK="+args
+                    else
+                        string = "company="+args.gsub(/[(,?!\''"":.)]/, '')
+                    end
+                end
+            end
+            string = string.to_s.gsub(" ", "+")
+            url = "http://www.sec.gov/cgi-bin/browse-edgar?"+string+"&action=getcompany"
+            return url
+        end
+
+        def self.cik(url, entity)
+            response = Entity.query(url+"&output=atom")
+            doc = Hpricot::XML(response)
+            data = doc.search(:title)[0];
+            if data.inner_text == "EDGAR Search Results"
+                tbl =  doc.search("//span[@class='companyMatch']")
+                if tbl && tbl.innerHTML != ""
+                    tbl = tbl[0].parent.search("table")[0].search("tr")
+                    for tr in tbl
+                        td = tr.search("td")
+                        if td[1] != nil && entity[:middle] != nil && td[1].innerHTML.downcase == (entity[:last]+" "+entity[:first]+" "+entity[:middle]).downcase or td[1] != nil && td[1].innerHTML.downcase == (entity[:last]+" "+entity[:first]).downcase
+                            cik = td[0].search("a").innerHTML
+                            return cik;
+                        end
+                    end
+                else
+                    return false;
+                end
+            else
+                cik = data.inner_text.scan(/\(([^)]+)\)/).to_s
+                return cik
+            end
+        end
+
+        def self.document(cik)
+            url ="http://www.sec.gov/cgi-bin/own-disp?action=getissuer&CIK="+cik
+            response = query(url)
+            doc = Hpricot(response)
+            text = "Ownership Reports from:"
+            type = "issuer"
+            entity = doc.search("//table").search("//td").search("b[text()*='"+text+"']")
+            if entity.empty?
+                url= "http://www.sec.gov/cgi-bin/own-disp?action=getowner&CIK="+cik
+                response = query(url)
+                doc = Hpricot(response)
+                text = "Ownership Reports for entitys:"
+                type = "owner"
+                entity = doc.search("//table").search("//td").search("b[text()*='"+text+"']")
+            end
+            return [doc, type]
+
+        end
+
+        def self.parse_document(temp, doc)
+
+            temp[:type] = doc[1]
+            info = Entity.info(doc[0])
+            temp[:name] = info[:name]
+            temp[:location] = info[:location]
+            temp[:sic] = info[:sic]
+            temp[:state_of_inc] = info[:state_of_inc]
+            temp[:formerly] = info[:formerly]
+
+            ### Get Mailing Address
+            temp[:mailing_address] = Entity.mailing_address(doc[0])
+
+            ### Get Business Address
+            temp[:business_address] = Entity.business_address(doc[0])
+
+            return temp;
+        end
+
+        def self.info(doc)
+            info={}
+            lines = doc.search("//td[@bgcolor='#E6E6E6']")[0].parent.parent.search("//tr")
+            td = lines[0].search("//td//b").innerHTML
+            info[:name] = td.gsub(td.scan(/\(([^)]+)\)/).to_s, "").gsub("()", "").gsub("\n", "")
+            lines = lines[1].search("//table")[0].search("//tr//td")
+            if lines[0].search("a")[0] != nil
+                info[:sic] = lines[0].search("a")[0].innerHTML
+            end
+            if lines[0].search("a")[1] != nil
+                info[:location] = lines[0].search("a")[1].innerHTML
+            end
+
+            if lines[0].search("b")[0] != nil and lines[0].search("b")[0].innerHTML.squeeze(" ") != " "
+                info[:state_of_inc] = lines[0].search("b")[0].innerHTML
+            end
+            if lines[1] != nil and lines[1].search("font")
+                info[:formerly] = lines[1].search("font").innerHTML.gsub("formerly: ", "").gsub("<br />", "").gsub("\n", "; ")
+            end
+            return info
+        end
+
+
+        def self.business_address(doc)
+            addie = doc.search("//table").search("//td").search("b[text()*='Business Address']")
+            if !addie.empty?; 
+                business_address = addie[0].parent.innerHTML.gsub('<b class="blue">Business Address</b>', '').gsub('<br />', ' '); 
+                return business_address
+            else 
+                return false;
+            end
+        end
+
+        def self.mailing_address(doc)
+            addie = doc.search("//table").search("//td").search("b[text()*='Mailing Address']")
+            if !addie.empty?; 
+                mailing_address = addie[0].parent.innerHTML.gsub('<b class="blue">Mailing Address</b>', '').gsub('<br />', ' '); 
+                return mailing_address
+            else 
+                return false;
+            end
+        end
+
+
+        def self.options(temp, options)
+
+            args={}
+            if options.is_a?(Array) && options.length == 1 && options[0] == true;
+                args[:relationships] = true;
+                args[:transactions]= true;
+                args[:filings] = true;
+            elsif options.is_a?(Array) && options.length > 1 
+                args[:relationships] = options[0];
+                args[:transactions]= options[1];
+                args[:filings] = options[2];
+            elsif options[0].is_a?(Hash)
+                args[:relationships] = options[0][:relationships];
+                args[:transactions]= options[0][:transactions];
+                args[:filings] = options[0][:filings];
+            end
+            return args;
+        end
+
+        def self.details(temp, options)
+
+            ## Get Relationships for entity
+            if options[:relationships] == true
+                relationships = Relationship.find(temp)
+                temp[:relationships] =relationships
+            end
+
+            ## Get Transactions for entity
+            if options[:transactions] != nil and options[:transactions].is_a?(Hash)
+                temp = Transaction.find(temp, options[:transactions][:start], options[:transactions][:count], options[:transactions][:limit])
+            elsif options[:transactions] != nil && options[:transactions] == true
+                temp = Transaction.find(temp, nil, nil, nil)
+            end
+
+
+            ## Get Filings for entity
+
+            if options[:filings] != nil and options[:filings].is_a?(Hash)
+                temp = Filing.find(temp, options[:filings][:start], options[:filings][:count], options[:filings][:limit])
+            elsif options[:filings] != nil and options[:filings] == true 
+                temp = Filing.find(temp, nil, nil, nil)
+            end
+
+            return temp;
+        end
+
+
+        def self.log(entity)
+
+            if entity != false
+                puts "\n\t# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #\n\n"
+                puts "\t"+entity.name
+                puts "\t("+entity.cik+")"
+                if entity.formerly && entity.formerly != ""
+                    puts "\tFormerly: "+entity.formerly
+                end
+                if entity.sic
+                    puts "\tSIC = "+entity.sic
+                end
+                if entity.location
+                    puts "\tLocation: "+entity.location+", "
+                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.to_s+" Total"
+                    printf("\t%-40s %-15s %-30s %-10s\n\n","Entity", "CIK", "Position", "Date")
+                    for relationship in entity.relationships
+                        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.to_s+" Total"
+                    printf("\t%-20s %-10s %-5s %-10s %-10s %-10s %-15s %-10s\n\n","Owner", "CIK", "Modes", "Type","Shares","Price","Owned","Date")
+                    for transaction in entity.transactions
+                        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.to_s+" Total"
+                    printf("\t%-10s %-30s %-20s\n\n","Type", "File ID", "Date")
+                    for filing in entity.filings
+                        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

@@ -0,0 +1,45 @@
+module SecQuery
+    class Filing
+        attr_accessor :cik, :title, :summary, :link, :term, :date, :file_id
+        def initialize(filing)
+            @cik = filing[:cik]
+            @title = filing[:title]
+            @summary = filing[:summary]
+            @link = filing[:link]
+            @term = filing[:term]
+            @date = filing[:date]
+            @file_id = filing[:file_id]
+        end
+  
+    
+        def self.find(entity, start, count, limit)
+
+            if start == nil; start = 0; end
+            if count == nil; count = 80; end
+            url ="http://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&CIK="+entity[:cik]+"&output=atom&count="+count.to_s+"&start="+start.to_s
+            response = Entity.query(url)
+            doc = Hpricot::XML(response)
+            entries = doc.search(:entry);
+            query_more = false;
+            for entry in entries
+                query_more = true;
+                filing={}
+                filing[:cik] = entity[:cik]
+                filing[:title] = (entry/:title).innerHTML
+                filing[:summary] = (entry/:summary).innerHTML
+                filing[:link] =  (entry/:link)[0].get_attribute("href")
+                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 and limit == nil || query_more and !limit
+                Filing.find(entity, start+count, count, limit);
+            else
+                return entity
+            end
+        end 
+    end
+
+end

data/lib/sec_query/relationship.rb

@@ -0,0 +1,63 @@
+module SecQuery
+    class Relationship
+        
+        ## Relationships are Owner / Issuer Relationships between Entities, forged by Transactions.
+        
+        attr_accessor :name, :position, :date, :cik
+        def initialize(relationship)
+            @cik = relationship[:cik];
+            @name = relationship[:name];
+            @position = relationship[:position];
+            date = relationship[:date].split("-")
+            @date = Time.utc(date[0],date[1],date[2].to_i)
+        end
+        
+        
+        def self.find(entity)
+            @relationships =[]
+
+            if entity[:doc] != nil
+                doc = entity[:doc]
+            elsif entity[:cik] != nil
+                doc = Entity.document(entity[:cik])[0]
+            end
+            
+            type = "Ownership Reports for Issuers:"
+            lines = doc.search("//table").search("//td").search("b[text()*='"+type+"']")
+            if lines.empty?
+                type = "Ownership Reports from:"
+                lines = doc.search("//table").search("//td").search("b[text()*='"+type+"']");
+            end
+            if !lines.empty?
+                relationship = {}
+                lines= lines[0].parent.search("//table")[0].search("//tr")
+                for line in lines
+                    link = line.search("//a")[0]
+                    if link.innerHTML != "Owner" and link.innerHTML != "Issuer"
+                        relationship[:name] = link.innerHTML;
+                        relationship[:cik] =  line.search("//td")[1].search("//a").innerHTML
+                        relationship[:date] = position = line.search("//td")[2].innerHTML
+                        relationship[:position] = line.search("//td")[3].innerHTML
+                        @relationship = Relationship.new(relationship)
+                        @relationships << @relationship
+                    
+                    end
+                end
+                return @relationships
+            else
+                return false
+            end
+        end
+        def self.print(relationships)
+            if relationships
+                puts "\n\t"+relationships[1]+"\n"
+                printf("\t%-30s %-10s %-40s %-10s\n\n","Entity", "CIK", "Position", "Date")
+                for relationship in issuer[:relationships]
+                    printf("\t%-30s %-10s %-40s %-10s\n",relationship.name, relationship.cik, relationship.position, relationship.date)
+                end
+            else
+                puts "No relationships"
+            end
+        end
+    end
+end

data/lib/sec_query/transaction.rb

@@ -0,0 +1,89 @@
+module SecQuery
+    class Transaction
+
+        attr_accessor :filing_number, :code, :date, :reporting_owner, :form, :type, :modes, :shares, :price, :owned, :number, :owner_cik, :security_name, :deemed, :exercise, :nature, :derivative, :underlying_1, :exercised,	:underlying_2, :expires, :underlying_3
+    
+        def initialize(transaction)
+            @filing_number = transaction[:form].split("/")[-2][0..19]
+            @code = transaction[:code]
+            if transaction[:date] != nil and transaction[:date] != "-"
+                date = transaction[:date].split("-")
+                @date = Time.utc(date[0],date[1],date[2])
+            end
+            @reporting_owner = transaction[:reporting_owner]
+            @form = transaction[:form]
+            @type = transaction[:type]
+            @modes = transaction[:modes]
+            @shares = transaction[:shares].to_f
+            @price = transaction[:price].gsub("$", "").to_f
+            @owned = transaction[:owned].to_f
+            @number = transaction[:number].to_i
+            @owner_cik = transaction[:owner_cik]
+            @security_name = transaction[:security_name]
+            @deemed = transaction[:deemed]
+            @exercise = transaction[:exercise]
+            @nature = transaction[:nature]
+            @derivative = transaction[:derivative]
+            @underlying_1 = transaction[:underlying_1].to_f
+            @exercised = transaction[:exercised]
+            @underlying_2 = transaction[:underlying_2].to_f
+            if transaction[:expires] != nil;
+                expires = transaction[:expires].split("-")
+                @expires = Time.utc(expires[0],expires[1],expires[2].to_i)
+            end
+            @underlying_3 = transaction[:underlying_3].to_f
+        end        
+    
+        def self.find(entity, start, count, limit)
+
+            if start == nil; start = 0; end
+            if count == nil; count = 80; end
+            url = "http://www.sec.gov/cgi-bin/own-disp?action=get"+entity[:type]+"&CIK="+entity[:cik]+"&start="+start.to_s+"&count="+count.to_s
+            response = Entity.query(url)
+            doc = Hpricot(response)
+            trans = doc.search("//td[@width='40%']")[0].parent.parent.search("//tr")
+            i= start;
+            query_more = false;
+            for tran in trans
+                td = tran.search("//td")
+                if td[2] != nil and td[1].innerHTML != "Exercise"
+                        query_more = true;
+                        if !td[0].empty?
+                        transaction={}
+                        transaction[:code] = td[0].innerHTML;
+                        transaction[:date] = td[1].innerHTML;
+                        transaction[:reporting_owner] = td[2].innerHTML;
+                        transaction[:form] = td[3].innerHTML;
+                        transaction[:type] = td[4].innerHTML;
+                        transaction[:modes] = td[5].innerHTML;
+                        transaction[:shares] = td[6].innerHTML;
+                        transaction[:price] = td[7].innerHTML;
+                        transaction[:owned] = td[8].innerHTML;
+                        transaction[:number] = td[9].innerHTML;
+                        transaction[:owner_cik] = td[10].innerHTML;
+                        transaction[:security_name] = td[11].innerHTML;
+                        transaction[:deemed] = td[12].innerHTML;
+                        if trans[i+1]; n_td = trans[i+1].search("//td"); end
+                        if n_td != nil and n_td.count ==7 and n_td[0].innerHTML.empty?                         
+                            transaction[:exercise] = n_td[1].innerHTML;
+                            transaction[:nature] = n_td[2].innerHTML;
+                            transaction[:derivative] = n_td[3].innerHTML;
+                            transaction[:underlying_1] = n_td[4].innerHTML;
+                            transaction[:exercised] = n_td[5].innerHTML;
+                            transaction[:underlying_2] = n_td[6].innerHTML;
+                            transaction[:expires] = n_td[7].innerHTML;
+                            transaction[:underlying_3] =n_td[8].innerHTML;
+                        end
+                         entity[:transactions] << Transaction.new(transaction)
+                    end
+                end
+                i=i+1 
+            end
+            if query_more and limit == nil || query_more and !limit
+                Transaction.find(entity, start+count, count, limit);
+            else
+                return entity
+            end
+        end
+    end
+end

data/lib/sec_query/version.rb

@@ -0,0 +1,3 @@
+module SecQuery
+  VERSION = "1.0.0"
+end

data/lib/sec_query.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "rest-client"
+require "hpricot"
+
+
+require "sec_query/version"
+require "sec_query/entity"
+require "sec_query/relationship"
+require "sec_query/transaction"
+require "sec_query/filing"
+

data/sec_query.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sec_query/version"
+require "sec_query"
+
+Gem::Specification.new do |s|
+  s.name        = "sec_query"
+  s.version     = SecQuery::VERSION
+  s.authors     = ["Ty Rauber"]
+  s.email       = ["tyrauber@mac.com"]
+  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.rubyforge_project = "sec_query"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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"
+   s.add_runtime_dependency "rest-client"
+   s.add_runtime_dependency "hpricot"
+end

data/spec/sec_query_spec.rb

@@ -0,0 +1,65 @@
+
+#cfr_directors = ["Carla A. Hills", "Robert E. Rubin", "Richard E. Salomon",  "Richard N. Haass", "John P. Abizaid", "Peter Ackerman", "Fouad Ajami", "Madeleine K. Albright", "Alan S. Blinder", "Mary Boies", "David G. Bradley",  "Tom Brokaw", "Sylvia Mathews Burwell", "Kenneth M. Duberstein", "Martin S. Feldstein", "Stephen Friedman","Ann M. Fudge", "Pamela Gann", "Thomas H. Glocer",  "J. Tomilson Hill","Donna J. Hrinak", "Alberto Ibargüen", "Shirley Ann Jackson", "Henry R. Kravis", "Jami Miscik", "Joseph S. Nye",  "James W. Owens",  "Eduardo J. Padrón", "Colin L. Powell", "Penny Pritzker", "David M. Rubenstein",   "George Rupp", "Frederick W. Smith",  "Christine Todd Whitman", "Fareed Zakaria",  "Leslie H. Gelb", "Maurice R. Greenberg",  "Peter G. Peterson","David Rockefeller"]
+
+    
+
+cfr_directors = [
+    {:middle=>"A", :first=>"Carla", :last=>"Hills", :cik_id=> "0001194913"},
+    {:middle=>"E", :first=>"Robert", :last=>"Rubin", :cik_id=> "0001225178"},
+    {:middle=>"E", :first=>"Richard", :last=>"Salomon", :cik_id => "0001217109"},
+    {:middle=>"N", :first=>"Richard", :last=>"Haass", :cik_id => "0001123553"},
+    {:middle=>"P", :first=>"John", :last=>"Abizaid", :cik_id => "0001425152"},
+    {:first=>"Peter", :last=>"Ackerman", :cik_id => "0001111564"},
+    {:first=>"Fouad", :last=>"Ajami"},
+    {:middle=>"K", :first=>"Madeleine", :last=>"Albright"},
+    {:middle=>"S", :first=>"Alan", :last=>"Blinder"},
+    {:first=>"Mary", :last=>"Boies", :cik_id => "0001291933"},
+    {:middle=>"G", :first=>"David", :last=>"Bradley", :cik_id=> "0001106734"},
+    {:first=>"Tom", :last=>"Brokaw"},
+    {:first=>"Sylvia", :last=>"Burwell"},
+    {:middle=>"M", :first=>"Kenneth", :last=>"Duberstein", :cik_id=> "0001179625"},
+    {:middle=>"S", :first=>"Martin", :last=>"Feldstein", :cik_id=> "0001236596"},
+    {:first=>"Stephen", :last=>"Friedman", :cik_id=> "0001029607"},
+    {:middle=>"M", :first=>"Ann", :last=>"Fudge", :cik_id=> "0001198098"},
+    {:first=>"Pamela", :last=>"Gann"},
+    {:middle=>"H", :first=>"Thomas", :last=>"Glocer", :cik_id=> "0001140799"},
+    {:middle=>"J", :first=>"J.", :last=>"Hill"},
+    {:middle=>"J", :first=>"Donna", :last=>"Hrinak", :cik_id=> "0001296811"},
+    {:first=>"Alberto", :last=>"Ibarguen", :cik_id=> "0001339732"},
+    {:first=>"Shirley", :last=>"Jackson", :cik_id=> "0001168019"},
+    {:middle=>"R", :first=>"Henry", :last=>"Kravis", :cik_id=> "0001081714"},
+    {:first=>"Jami", :last=>"Miscik"},
+    {:middle=>"S", :first=>"Joseph", :last=>"Nye", :cik_id=> "0001299821"},
+    {:middle=>"W", :first=>"James", :last=>"Owens", :cik_id=> "0001443909"},
+    {:middle=>"J", :first=>"Eduardo", :last=>"Padron"},
+    {:middle=>"L", :first=>"Colin", :last=>"Powell"},
+    {:first=>"Penny", :last=>"Pritzker", :cik_id=> "0001087398"},
+    {:middle=>"M", :first=>"David", :last=>"Rubenstein"},
+    {:first=>"George", :last=>"Rupp"},
+    {:middle=>"W", :first=>"Frederick", :last=>"Smith", :cik_id=> "0001033677"},
+    {:first=>"Christine", :last=>"Whitman", :cik_id=> "0001271384"},
+    {:first=>"Fareed", :last=>"Zakaria"},
+    {:middle=>"H", :first=>"Leslie", :last=>"Gelb", :cik_id=> "0001240500"},
+    {:middle=>"R", :first=>"Maurice", :last=>"Greenberg", :cik_id=> "0001236599"},
+    {:middle=>"G", :first=>"Peter", :last=>"Peterson", :cik_id=> "0001070843"}, 
+    {:first=>"David", :last=>"Rockefeller", :cik_id=> "0001204357"}
+]
+
+include SecQuery
+
+describe SecQuery::Entity do
+    puts "\n\nCOUNCIL ON FOREIGN RELATIONS' DIRECTORS\nAs perceived by the Security and Exchange Commission Edgar System:\n"
+    for t in cfr_directors
+        entity = SecQuery::Entity.find(t, true)
+        # entity = SecQuery::Entity.find(t, true, {:start => 0, :count => 20, :limit => 20}, {:start => 0, :count => 20, :limit => 20})
+        if entity != false
+          Entity.log(entity)
+          it t[:cik].to_s+" is company "+entity.name.to_s do    
+              if t[:cik] != nil
+                  entity.cik.should eql(t[:cik_id])
+              end
+             
+         end
+        end
+    end    
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "sec_query"

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: sec_query
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ty Rauber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Search for company or person, by name, symbol or Central Index Key (CIK), and retrieve relationships, transactions and filings.
+email: 
+- tyrauber@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/sec_query.rb
+- lib/sec_query/.DS_Store
+- lib/sec_query/entity.rb
+- lib/sec_query/filing.rb
+- lib/sec_query/relationship.rb
+- lib/sec_query/transaction.rb
+- lib/sec_query/version.rb
+- pkg/sec_query-0.0.1.gem
+- sec_query-1.0.0.gem
+- sec_query.gemspec
+- spec/sec_query_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/tyrauber/sec_query
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sec_query
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A ruby gem for querying the United States Securities and Exchange Commission Edgar System.
+test_files: 
+- spec/sec_query_spec.rb
+- spec/spec_helper.rb