sec 0.0.2 → 0.0.3

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 1.9.2
 

data/README.rdoc

@@ -1,5 +1,7 @@
 == SEC
 
+{<img src="https://travis-ci.org/reinventinghorses/sec.png" />}[https://travis-ci.org/reinventinghorses/sec]
+
 Retrieve {XBRL}[http://xbrl.org/] information from the U.S. Securities and Exchange Commission.
 
 == Installation

data/Rakefile

@@ -1 +1,14 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+# https://github.com/mongoid/mongoid/blob/master/Rakefile
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/sec/connection.rb

@@ -1,25 +1,32 @@
 module Sec
   class Connection
+    class Error < StandardError; end
 
     require 'patron'
 
-    SEC_BASE_URL = 'http://www.sec.gov'
+    BASE_URL        = 'http://www.sec.gov'
+    CONNECT_TIMEOUT = 30
+    SUCCESSFUL_RESPONSE = 200
+    TIMEOUT         = 120
 
-    attr_reader :session
+    attr_accessor :session
 
     DEFAULT_SESSION_ATTRIBUTES = {
-      :base_url        => SEC_BASE_URL,
-      :connect_timeout => 5000,
-      :timeout         => 5000
+      :base_url        => BASE_URL,
+      :connect_timeout => CONNECT_TIMEOUT,
+      :timeout         => TIMEOUT
     }
 
     def initialize(attrs={})
-      @session = Patron::Session.new
+      self.session = Patron::Session.new
       configure_session(attrs)
     end
 
     def get(uri)
-      @session.get(uri)
+      response = session.get(uri)
+      response.body if response.respond_to?(:body)
+    rescue Patron::Error => error
+      raise Error, error.message
     end
 
     private

data/lib/sec/reader.rb

@@ -6,6 +6,8 @@ module Sec
 
     MONTHLY_PATH = %q{/Archives/edgar/monthly/xbrlrss-%{year}-%{month}.xml}
 
+    attr_accessor :connection
+
     def self.get_monthly_index(year, month)
       reader = Reader.new
       reader.get_monthly_index(year, month)
@@ -16,25 +18,22 @@ module Sec
       reader.get_xbrl_file(url)
     end
 
+    def initialize(attrs={})
+      self.connection = Connection.new(attrs)
+    end
+
     def get_monthly_index(year, month)
-      resp = connection.get(monthly_query_uri(year, month))
-      if resp.status == 200
-        # items are in ["rss"]["channel"]
-        Crack::XML.parse(resp.body)
-      else
-        nil
-      end
+      response = connection.get(monthly_query_uri(year, month))
+      Crack::XML.parse(response)
+    rescue => error
+      raise Error, error.message
     end
 
     def get_xbrl_file(url)
-      resp = connection.get(uri_path(url))
+      connection.get(uri_path(url))
     end
 
     private
-    def connection(attrs={})
-      Connection.new
-    end
-
     def prepend_zero(month)
       month = month.to_s
       month.prepend("0") if month.size == 1
@@ -45,7 +44,7 @@ module Sec
     end
 
     def uri_path(url)
-      url.gsub(Sec::Connection::SEC_BASE_URL, '')
+      url.gsub(/http:\/\/www\.sec\.gov/, '')
     end
   end
 end

data/lib/sec/version.rb

@@ -1,3 +1,3 @@
 module Sec
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/connection_spec.rb

@@ -10,11 +10,29 @@ module Sec
         expect(session).to be_kind_of(Patron::Session)
       end
 
-      it 'should use the SEC base url' do
-        expected = 'http://www.sec.gov'
+      it 'should use the SEC BASE_URL value' do
+        expected = Sec::Connection::BASE_URL
 
         expect(session.base_url).to eq(expected)
       end
+
+      it 'sets the default connect timeout to CONNECT_TIMEOUT value' do
+        expected = Sec::Connection::CONNECT_TIMEOUT
+
+        expect(session.connect_timeout).to eq(expected)
+      end
+
+      it 'sets the default timeout to TIMEOUT value' do
+        expected = Sec::Connection::TIMEOUT
+
+        expect(session.timeout).to eq(expected)
+      end
+
+      it 'sets custom attributes' do
+        connection = Connection.new({ :timeout => 600 })
+
+        expect(connection.session.timeout).to eq(600)
+      end
     end
 
     describe '.get' do
@@ -23,6 +41,13 @@ module Sec
 
         connection.get('/some_path')
       end
+
+      it 'raises a Connection::Error when there is a Patron error' do
+        error = Patron::Error.new
+        session.stub(:get).and_raise(error)
+
+        expect { connection.get('/some_path') }.to raise_error(Connection::Error)
+      end
     end
   end
 end

data/spec/reader_spec.rb

@@ -4,34 +4,49 @@ module Sec
   describe Reader do
     use_vcr_cassette 'reader'
 
-    let(:connection) { Sec::Connection.new }
-    let(:reader) { Reader.new }
+    let(:monthly_index) { Reader.get_monthly_index(2012, 1) }
 
     describe '.get_monthly_index' do
-      let(:response) { reader.get_monthly_index(2012, 1) }
+      # TODO: figure out why this doesnt work
+      xit 'send a GET to Connection' do
+        connection = Connection.new
+        Connection.stub(:new).and_return(connection)
+        connection.should_receive(:get).with("/Archives/edgar/monthly/xbrlrss-2012-01.xml")
+
+        Reader.get_monthly_index(2012, 1)
+      end
 
       it 'returns a hash' do
-        expect(response).to be_kind_of(Hash)
+        expect(monthly_index).to be_kind_of(Hash)
       end
 
-      it 'has a top level rss key' do
-        expect(response.keys).to eq(['rss'])
+      it 'returns the correct top level key' do
+        expect(monthly_index.keys).to eq(['rss'])
+      end
+
+      it 'raises an error when the response isnt valid' do
+        Crack::XML.stub(:parse).and_raise(StandardError)
+
+        expect { Reader.get_monthly_index(2012, 1) }.to raise_error(Reader::Error)
       end
     end
 
     describe '.get_xbrl_file' do
       url = "http://www.sec.gov/Archives/edgar/data/840715/000084071512000011/clro-20111231_pre.xml"
-      let(:response) { reader.get_xbrl_file(url) }
-
-      it 'should receive a 200 response code' do
-        expect(response.status).to eq(200)
-      end
+      let(:xbrl_file) { Reader.get_xbrl_file(url) }
 
       # multiple file types, we'll test one
       # I want a more consistent return between the two,
       # one of the TODOs as I use this gem more
       it 'should return an XML string' do
-        expect(response.body).to match(/xml\sversion/)
+        expect(xbrl_file).to match(/xml\sversion/)
+      end
+
+      xit 'raises an error when the respone isnt valid' do
+        error = Connection::Error.new
+        Connection.stub(:get).and_raise(error)
+
+        expect { Reader.get_xbrl_file(url) }.to raise_error(Connection::Error)
       end
     end
   end

data/spec/support/request_library/reader.yml

@@ -20,10 +20,10 @@ http_interactions:
         U0VD
       !binary "TGFzdC1Nb2RpZmllZA==":
       - !binary |-
-        U3VuLCAyMiBBcHIgMjAxMiAxNjoxMjo0NSBHTVQ=
+        U3VuLCAyMiBBcHIgMjAxMiAxNjozMjo0OCBHTVQ=
       !binary "RXRhZw==":
       - !binary |-
-        IjRiZTQ2Y2FiOWI5NDAi
+        IjRiZTQ3MTI2ZTBjMDAi
       !binary "Q29udGVudC1UeXBl":
       - !binary |-
         YXBwbGljYXRpb24veG1s
@@ -32,10 +32,10 @@ http_interactions:
         bWF4LWFnZT0w
       !binary "RXhwaXJlcw==":
       - !binary |-
-        U2F0LCAyMiBEZWMgMjAxMiAyMToyNTo0MCBHTVQ=
+        TW9uLCAyOCBKYW4gMjAxMyAyMjozNTo0NSBHTVQ=
       !binary "RGF0ZQ==":
       - !binary |-
-        U2F0LCAyMiBEZWMgMjAxMiAyMToyNTo0MCBHTVQ=
+        TW9uLCAyOCBKYW4gMjAxMyAyMjozNTo0NSBHTVQ=
       !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
       - !binary |-
         Y2h1bmtlZA==
@@ -60,9 +60,9 @@ http_interactions:
         b3JnLzIwMDUvQXRvbSIvPgogICAgPGRlc2NyaXB0aW9uPlRoaXMgaXMgYSBs
         aXN0IGFsbCBvZiB0aGUgZmlsaW5ncyBjb250YWluaW5nIFhCUkwgZm9yIDIw
         MTItMDE8L2Rlc2NyaXB0aW9uPgogICAgPGxhbmd1YWdlPmVuLXVzPC9sYW5n
-        dWFnZT4KICAgIDxwdWJEYXRlPlN1biwgMjIgQXByIDIwMTIgMTI6MTI6MjYg
+        dWFnZT4KICAgIDxwdWJEYXRlPlN1biwgMjIgQXByIDIwMTIgMTI6MzE6NTYg
         RURUPC9wdWJEYXRlPgogICAgPGxhc3RCdWlsZERhdGU+U3VuLCAyMiBBcHIg
-        MjAxMiAxMjoxMjoyNiBFRFQ8L2xhc3RCdWlsZERhdGU+CiAgICA8aXRlbT4K
+        MjAxMiAxMjozMTo1NiBFRFQ8L2xhc3RCdWlsZERhdGU+CiAgICA8aXRlbT4K
         ICAgICAgPHRpdGxlPkFNQVpPTiBDT00gSU5DICgwMDAxMDE4NzI0KSAoRmls
         ZXIpPC90aXRsZT4KICAgICAgPGxpbms+aHR0cDovL3d3dy5zZWMuZ292L0Fy
         Y2hpdmVzL2VkZ2FyL2RhdGEvMTAxODcyNC8wMDAxMTkzMTI1MTIwMzI4NDYv
@@ -94292,7 +94292,7 @@ http_interactions:
         ICAgPC9lZGdhcjp4YnJsRmlsZXM+CiAgICAgIDwvZWRnYXI6eGJybEZpbGlu
         Zz4KICAgIDwvaXRlbT4KICA8L2NoYW5uZWw+CjwvcnNzPgo=
     http_version: 
-  recorded_at: Sat, 22 Dec 2012 21:26:05 GMT
+  recorded_at: Mon, 28 Jan 2013 22:36:22 GMT
 - request:
     method: get
     uri: http://www.sec.gov/Archives/edgar/data/840715/000084071512000011/clro-20111231_pre.xml
@@ -94308,15 +94308,15 @@ http_interactions:
       message: !binary |-
         T0s=
     headers:
-      !binary "U2VydmVy":
-      - !binary |-
-        U0VD
       !binary "TGFzdC1Nb2RpZmllZA==":
       - !binary |-
-        TW9uLCAwMiBBcHIgMjAxMiAxMDoxMDo0MyBHTVQ=
+        TW9uLCAwMiBBcHIgMjAxMiAxMDoxMDowNCBHTVQ=
       !binary "RXRhZw==":
       - !binary |-
-        IjRiY2FmNjcyYWNlYzAi
+        IjRiY2FmNjRkN2I3MDAi
+      !binary "U2VydmVy":
+      - !binary |-
+        U0VD
       !binary "Q29udGVudC1UeXBl":
       - !binary |-
         YXBwbGljYXRpb24veG1s
@@ -94325,10 +94325,10 @@ http_interactions:
         bWF4LWFnZT0w
       !binary "RXhwaXJlcw==":
       - !binary |-
-        TW9uLCAyNCBEZWMgMjAxMiAxNTowNDozMCBHTVQ=
+        TW9uLCAyOCBKYW4gMjAxMyAyMjo1MzowOCBHTVQ=
       !binary "RGF0ZQ==":
       - !binary |-
-        TW9uLCAyNCBEZWMgMjAxMiAxNTowNDozMCBHTVQ=
+        TW9uLCAyOCBKYW4gMjAxMyAyMjo1MzowOCBHTVQ=
       !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
       - !binary |-
         Y2h1bmtlZA==
@@ -94337,6 +94337,9 @@ http_interactions:
         VHJhbnNmZXItRW5jb2Rpbmc=
       - !binary |-
         a2VlcC1hbGl2ZQ==
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        ZGF0YWNlbnRlcj1kYzIgOyBQYXRoPS8=
     body:
       encoding: ASCII-8BIT
       string: !binary |-
@@ -96115,5 +96118,5 @@ http_interactions:
         ZGVyPScxLjAnLz4KCTwvbGluazpwcmVzZW50YXRpb25MaW5rPgo8L2xpbms6
         bGlua2Jhc2U+Cg==
     http_version: 
-  recorded_at: Mon, 24 Dec 2012 15:04:30 GMT
+  recorded_at: Mon, 28 Jan 2013 22:53:13 GMT
 recorded_with: VCR 2.3.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2013-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crack
@@ -161,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4128468391754394527
+      hash: -3634642483232780340
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4128468391754394527
+      hash: -3634642483232780340
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23