sec_query 1.0.3 → 1.0.4

data/lib/sec_query/filing.rb

@@ -1,45 +1,50 @@
-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)
+# encoding: UTF-8
 
-            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
+module SecQuery
+  # => SecQuery::Filing
+  # SecQuery::Filing requests and parses filings for any given SecQuery::Entity
+  class Filing
+    COLUMNS = :cik, :title, :summary, :link, :term, :date, :file_id
+    attr_accessor(*COLUMNS)
 
-                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 
+    def initialize(filing)
+      COLUMNS.each do |column|
+        instance_variable_set("@#{ column }", filing[column])
+      end
     end
 
+    def self.find(entity, start, count, limit)
+      start ||= 0
+      count ||= 80
+      url = SecURI.browse_edgar_uri({
+        action: :getcompany,
+        CIK: entity[:cik],
+        output: :atom,
+        count: count,
+        start: start
+      })
+      response = Entity.query(url)
+      doc = Hpricot::XML(response)
+      entries = doc.search(:entry)
+      query_more = false
+      entries.each do |entry|
+        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 && limit.nil?) || (query_more && !limit)
+        Filing.find(entity, start + count, count, limit)
+      else
+        return entity
+      end
+    end
+  end
 end

data/lib/sec_query/relationship.rb

@@ -1,63 +1,72 @@
+# encoding: UTF-8
+
 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
+  # => SecQuery::Relationship
+  # Relationships are Owner / Issuer Relationships between Entities,
+  # forged by Transactions.
+  class Relationship
+    COLUMNS = :name, :position, :cik
+    attr_accessor(*COLUMNS, :date)
+
+    def initialize(relationship)
+      COLUMNS.each do |column|
+        instance_variable_set("@#{ column }", relationship[column])
+      end
+      date = relationship[:date].split('-')
+      @date = Time.utc(date[0], date[1], date[2].to_i)
+    end
+
+    def self.find(entity)
+      @relationships = []
+
+      if entity[:doc]
+        doc = entity[:doc]
+      elsif entity[:cik]
+        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
+
+      return false if lines.empty?
+
+      relationship = {}
+      lines = lines[0].parent.search('//table')[0].search('//tr')
+      lines.each do |line|
+        link = line.search('//a')[0]
+        if link.innerHTML != 'Owner' && link.innerHTML != 'Issuer'
+          relationship[:name] = link.innerHTML
+          relationship[:cik] = line.search('//td')[1].search('//a').innerHTML
+          relationship[:date] = line.search('//td')[2].innerHTML
+          relationship[:position] = line.search('//td')[3].innerHTML
+          @relationships << Relationship.new(relationship)
         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
+      @relationships
+    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')
+        issuer[:relationships].each do |relationship|
+          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/sec_uri.rb

@@ -0,0 +1,98 @@
+# encoding: UTF-8
+require 'debugger'
+
+module SecQuery
+  class SecURI
+    attr_accessor :host, :scheme, :path, :query_values
+
+    def self.browse_edgar_uri(args = nil)
+      build_with_path('/browse-edgar', args)
+    end
+
+    def self.ownership_display_uri(args = nil)
+      build_with_path('/own-disp', args)
+    end
+
+    def self.build_with_path(path, args)
+      instance = SecURI.new
+      instance.path += path
+      return instance if args.nil?
+      options = send("handle_#{ args.class.to_s.underscore }_args", args)
+      instance.query_values = options
+      instance
+    end
+
+    private_class_method :build_with_path
+
+    def self.handle_string_args(string_arg)
+      options = {}
+      # Uhhhg. I hate using Float here. HACK
+      begin Float(string_arg)
+        options[:CIK] = string_arg
+      rescue
+        if string_arg.length <= 4
+          options[:CIK] = string_arg
+        else
+          options[:company] = string_arg.gsub(/[(,?!\''"":.)]/, '')
+        end
+      end
+      options
+    end
+
+    private_class_method :handle_string_args
+
+    def self.handle_hash_args(hash_arg)
+      options = hash_arg
+      if hash_arg[:symbol] || hash_arg[:cik]
+        options[:CIK] = (hash_arg[:symbol] || hash_arg[:cik])
+        return options
+      end
+      options[:company] = company_name_from_hash_args(hash_arg)
+      options
+    end
+
+    private_class_method :handle_hash_args
+
+    def self.company_name_from_hash_args(args)
+      return "#{ args[:last] } #{ args[:first] }" if args[:first] && args[:last]
+      return args[:name].gsub(/[(,?!\''"":.)]/, '') if args[:name]
+    end
+
+    private_class_method :company_name_from_hash_args
+
+    def initialize
+      self.host = 'www.sec.gov'
+      self.scheme = 'http'
+      self.path = 'cgi-bin'
+    end
+
+    def []=(key, value)
+      query_values[key] = value
+      self
+    end
+
+    def output_atom
+      query_values.merge!(output: 'atom')
+      self
+    end
+
+    def to_s
+      uri.to_s
+    end
+
+    def to_str
+      to_s
+    end
+
+    private
+
+    def uri
+      Addressable::URI.new(
+        host: host,
+        scheme: scheme,
+        path: path,
+        query_values: query_values
+      )
+    end
+  end
+end

data/lib/sec_query/transaction.rb

@@ -1,89 +1,106 @@
+# encoding: UTF-8
+
 module SecQuery
-    class Transaction
+  # => SecQuery::Transactions
+  # SecQuery filings for any given SecQuery::Entity instance.
+  class Transaction
+    STR_COLUMNS = :code, :form, :type, :modes, :owner_cik, :security_name,
+                  :deemed, :exercise, :nature, :derivative, :exercised,
+                  :reporting_owner
 
-        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)
+    FLOAT_COLUMNS = :shares, :owned, :underlying_1, :underlying_2,
+                    :underlying_3
 
-            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
+    attr_accessor(*STR_COLUMNS, *FLOAT_COLUMNS, :filing_number, :date, :price,
+                  :owned, :number, :expires)
+
+    def initialize(transaction)
+      @number = transaction[:number].to_i
+      @price = transaction[:price].gsub('$', '').to_f
+      @filing_number = transaction[:form].split('/')[-2][0..19]
+      setup_columns(transaction)
+      setup_date(transaction)
+      setup_expires(transaction)
+    end
+
+    def setup_columns(transaction)
+      STR_COLUMNS.each do |column|
+        instance_variable_set("@#{ column }", transaction[column])
+      end
+      FLOAT_COLUMNS.each do |column|
+        instance_variable_set("@#{ column }", transaction[column].to_f)
+      end
+    end
+
+    def setup_date(transaction)
+      if transaction[:date] && transaction[:date] != '-'
+        date = transaction[:date].split('-')
+        @date = Time.utc(date[0], date[1], date[2])
+      end
+    end
+
+    def setup_expires(transaction)
+      if transaction[:expires]
+        expires = transaction[:expires].split('-')
+        @expires = Time.utc(expires[0], expires[1], expires[2].to_i)
+      end
+    end
+
+    def self.find(entity, start, count, limit)
+      start ||= 0
+      count ||= 80
+      url = SecURI.ownership_display_uri({
+        action: "get#{entity[:type]}",
+        CIK: entity[:cik],
+        start: start,
+        count: count
+      })
+      response = Entity.query(url)
+      doc = Hpricot(response)
+      trans = doc.search("//td[@width='40%']")[0].parent.parent.search('//tr')
+      i = start
+      query_more = false
+      trans.each do |tran|
+        td = tran.search('//td')
+        if td[2] && td[1].innerHTML != 'Exercise'
+          query_more = true
+          unless 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
+            n_td = trans[i + 1].search('//td') if trans[i + 1]
+            if n_td && n_td.count == 7 && 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 += 1
+      end
+
+      if (query_more && limit.nil?) || (query_more && !limit)
+        Transaction.find(entity, start + count, count, limit)
+      else
+        return entity
+      end
     end
+  end
 end