sec_query 1.0.3 → 1.0.4

data/lib/sec_query/version.rb

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

data/sec_query.gemspec

@@ -1,27 +1,29 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
 
-require "sec_query/version"
-require "sec_query"
+require 'sec_query/version'
+require 'sec_query'
 
 Gem::Specification.new do |s|
-  s.name        = "sec_query"
+  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.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"]
+  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"
+  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'
 end

data/spec/sec_query_spec.rb

@@ -1,105 +1,125 @@
+# encoding: UTF-8
+
 include SecQuery
+require 'spec_helper'
 
 describe SecQuery::Entity do
-  puts "SecQuery Tests for all methods listed in the readme"
 
-  describe "Company Queries" do
+  describe 'Company Queries', vcr: { cassette_name: 'aapl' } do
 
-    let(:apple){{name: "APPLE INC",sic: "3571", symbol: "aapl", cik:"0000320193"}}
+    let(:apple) do
+      { name: 'APPLE INC', sic: '3571', symbol: 'aapl', cik: '0000320193' }
+    end
 
-    context "when quering by stock symbol" do
-      it "lazely" do  
+    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]})
+
+      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  
+
+    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]})
+
+      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  
+
+    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]})
+
+      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]})
+
+  describe 'People Queries', vcr: { cassette_name: 'Steve Jobs' } do
+    let(:jobs) do
+      { first: 'Steve', middle: 'P', last: 'Jobs', cik: '0001007844' }
+    end
+
+    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
-    
+
+  describe 'Relationships, Transactions and Filings', vcr: { cassette_name: 'Steve Jobs' } 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
+
+    let(:jobs) do
+      { 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' }
+        ]
+      }
+    end
+
+    let(:entity) do
+      SecQuery::Entity.find(
+        { first: 'Steve',
+          middle: 'P',
+          last: 'Jobs',
+          cik: '0001007844' },
+        true)
+    end
+
+    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
+
+      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
+
+      it 'should provide filings' do
         entity.filings.each_with_index do |f, i|
           f.file_id.should eql(jobs[:filings][i][:file_id])
         end

data/spec/sec_uri_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+include SecQuery
+require 'spec_helper'
+
+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')
+    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')
+    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')
+    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')
+    end
+
+    it 'builds a default /browse-edgar/ url with options: "Apple"' do
+      uri = SecQuery::SecURI.browse_edgar_uri('Apple')
+      expect(uri.to_s)
+        .to eq('http://www.sec.gov/cgi-bin/browse-edgar?company=Apple')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,6 @@
-require "sec_query"
+# encoding: UTF-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'sec_query'
+require 'support/vcr'

data/spec/support/vcr.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/vcr_cassettes'
+  c.hook_into :webmock
+  c.ignore_localhost = true
+  c.default_cassette_options = { record: :new_episodes }
+  c.configure_rspec_metadata!
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sec_query
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,58 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-10 00:00:00.000000000 Z
+date: 2014-04-17 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -67,24 +115,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - 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/sec_uri.rb
 - lib/sec_query/transaction.rb
 - lib/sec_query/version.rb
 - pkg/sec_query-1.0.1.gem
 - pkg/sec_query-1.0.2.gem
-- sec_query-1.0.3.gem
+- pkg/sec_query-1.0.3.gem
 - sec_query.gemspec
 - spec/sec_query_spec.rb
+- spec/sec_uri_spec.rb
 - spec/spec_helper.rb
+- spec/support/vcr.rb
 homepage: https://github.com/tyrauber/sec_query
 licenses: []
 post_install_message: 
@@ -112,4 +161,7 @@ summary: A ruby gem for querying the United States Securities and Exchange Commi
   Edgar System.
 test_files:
 - spec/sec_query_spec.rb
+- spec/sec_uri_spec.rb
 - spec/spec_helper.rb
+- spec/support/vcr.rb
+has_rdoc: 

data/Gemfile.lock

@@ -1,30 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sec_query (1.0.2)
-      hpricot
-      rest-client
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    hpricot (0.8.6)
-    mime-types (1.21)
-    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!