sec_entities 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWJmZWEyMTkwOGJjMjdmNzFjYTU0NTI5YzlhZDRhOTBmMmE4ZTBhOA==
+  data.tar.gz: !binary |-
+    NzBiZWQ4Y2U3YmEwNDAxOTJiNmUxZWI5YmQzZmVmYWJlZjhkMTBkNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTg3NWJmMDNlNTgyNDMzOGU0ODJhNzQ4MjQ3YWEzMmQ3ZmFkYTFhNzNlYzIy
+    NDI0N2RlNTU1YzlkOTAyZDI5YWQ0MWUyYWY4NWVlMGFjNjAxM2QzZjUwMGYz
+    NDYwNTU5NWUzYjI1NDU2NGNjMzUxZTE1N2UzZDY2OGU3ZTYyODg=
+  data.tar.gz: !binary |-
+    YTE0ZWFiMmQwZGY3MjJlOWQyNDBiMTVkN2VlZDZhOTk1ZGNmMGIyY2I1NWFj
+    NzZkMmViODViOWNlNGI5ZDk5MGQyOGUxZWUwYWUyNTg4MTM0MzhlYmRhNWM1
+    NzMzMjkzYThlNGRlNTQ1Y2IxNGQ0ZjRhZDliZGJmYWFmMzBiNzE=

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,40 @@
+PATH
+  remote: .
+  specs:
+    sec_query (1.0.3)
+      crack
+      hashie
+      hpricot
+      nokogiri
+      rest-client
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.1.3)
+    hashie (2.0.5)
+    hpricot (0.8.6)
+    mime-types (1.25)
+    mini_portile (0.5.1)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    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)
+    safe_yaml (0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  sec_query!

data/README.md

@@ -0,0 +1,42 @@
+# sec_entities
+
+A ruby gem for searching and retrieving data from the Security and Exchange Commission's Edgar web system.
+
+This gem was originally made by Ty Rauber and had more functions, but I couldn't get to work and I didn't need all of the functions so I made it work for what I needed.
+If I can get the other one to work eventually, I'll retire this one.
+
+
+## Installation
+
+To install the 'sec_query' Ruby Gem run the following command at the terminal prompt.
+
+`gem install sec_entities`
+
+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_entities"`
+
+## Functionality
+
+### FIND COMPANY:
+
+#### By Name:
+
+Sec::Entity.find("WEYEHAUSER")
+
+
+## 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_entities/entity.rb

@@ -0,0 +1,73 @@
+module Sec
+    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 self.find(entity_args, *options)
+            Entity.cik(Entity.url(entity_args), entity_args)
+        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")
+            # puts response
+            entries = []
+            Nokogiri::HTML(response).xpath('//feed/entry').each do |e|
+                # e.remove_namespaces!('link')
+                if e.xpath('//content/company-info').to_s.length > 0
+                    doc = Hashie::Mash.new(Crack::XML.parse(e.xpath('//content/company-info').to_s))
+                end
+                if e.xpath('//company-info').to_s.length > 0
+                    doc = Hashie::Mash.new(Crack::XML.parse(e.xpath('//company-info').to_s))
+                end
+                if e.xpath('//content/accession-nunber').to_s.length > 0
+                    doc = Crack::XML.parse(e.xpath('//content').to_s).collect {|k, v| v }
+                end
+                
+                entries << doc
+            end
+
+            return entries
+        end
+
+   end
+end

data/lib/sec_entities/version.rb

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

data/lib/sec_entities.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "rest-client"
+require "hpricot"
+require 'nokogiri'
+require 'hashie'
+require 'crack'
+
+require "sec_entities/version"
+require "sec_entities/entity"
+

data/sec_entities.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "sec_entities/version"
+require "sec_entities"
+
+Gem::Specification.new do |s|
+  s.name        = "sec_entities"
+  s.version     = SecQuery::VERSION
+  s.authors     = ["Ty Rauber"]
+  s.email       = ["tyrauber@mac.com"]
+  s.homepage    = "https://github.com/ballantyne/sec_entities"
+  s.summary     = "A ruby gem for querying the United States Securities and Exchange Commission Edgar System."
+  s.description = "This gem was originally made by Ty Rauber and had more functions, but I couldn't get to work and I didn't need all of the functions so I made it work for what I needed."
+
+  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 "nokogiri"
+   s.add_runtime_dependency "hashie"
+   s.add_runtime_dependency "crack"
+
+end

data/spec/sec_query_spec.rb

@@ -0,0 +1,109 @@
+include SecQuery
+
+describe SecQuery::Entity do
+  puts "SecQuery Tests for all methods listed in the readme"
+
+  describe "Company Queries" do
+
+    let(:apple){{name: "APPLE INC",sic: "3571", symbol: "aapl", cik:"0000320193"}}
+
+    context "when quering by stock symbol" do
+      it "lazely" do  
+        entity = SecQuery::Entity.find(apple[:symbol])
+        entity.cik.should eql(apple[:cik])
+      end
+      it "explicitly" do
+        entity = SecQuery::Entity.find({:symbol=> apple[:symbol]})
+        entity.cik.should eql(apple[:cik])
+      end
+    end
+    
+    context "when querying by entity name" do
+      it "lazely" do  
+        entity = SecQuery::Entity.find(apple[:name])
+        entity.cik.should eql(apple[:cik])
+      end
+      it "explicitly" do
+        entity = SecQuery::Entity.find({:name=> apple[:name]})
+        entity.cik.should eql(apple[:cik])
+      end
+    end
+    
+    context "when querying by cik" do
+      it "lazely" do  
+        entity = SecQuery::Entity.find(apple[:cik])
+        entity.name.should match(apple[:name])
+      end
+      it "explicitly" do
+        entity = SecQuery::Entity.find({:cik=> apple[:cik]})
+        entity.name.should match(apple[:name])
+      end
+    end
+  end
+  
+  describe "People Queries" do
+
+    let(:jobs){{first: "Steve", middle: "P", last: "Jobs", :cik => "0001007844"}}
+  
+    context "when querying by name" do
+      it "first, middle and last name" do
+        entity = SecQuery::Entity.find({:first=> jobs[:first], :middle=> jobs[:middle], :last=> jobs[:last]})
+        entity.cik.should eql(jobs[:cik])
+      end
+    end
+  end
+  
+  describe "Relationships, Transactions and Filings" do
+    
+    ## Using Steve, because data should not change in the future. RIP.
+    
+    let(:jobs){{
+      first: "Steve", middle: "P", last: "Jobs", :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({:first=> "Steve",  middle: "P", last: "Jobs", :cik => "0001007844"}, true)}
+    
+    context "when quering entities with option 'true'" do
+      it "should provide relationships" do
+        entity.relationships.each_with_index do |r, i|
+          r.cik.should eql(jobs[:relationships][i][:cik])
+        end
+      end
+      it "should provide transactions" do
+        entity.transactions.each_with_index do |t, i|
+          t.filing_number.should eql(jobs[:transactions][i][:filing_number])
+        end
+      end
+      it "should provide filings" do
+        entity.filings.each_with_index do |f, i|
+          f.file_id.should eql(jobs[:filings][i][:file_id])
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sec_entities
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ty Rauber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem was originally made by Ty Rauber and had more functions, but
+  I couldn't get to work and I didn't need all of the functions so I made it work
+  for what I needed.
+email:
+- tyrauber@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/sec_entities.rb
+- lib/sec_entities/.DS_Store
+- lib/sec_entities/entity.rb
+- lib/sec_entities/version.rb
+- sec_entities.gemspec
+- spec/sec_query_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ballantyne/sec_entities
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sec_query
+rubygems_version: 2.0.6
+signing_key: 
+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/spec_helper.rb