sec 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in sec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gregory Graf
+
+MIT License
+
+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/README.rdoc

@@ -0,0 +1,45 @@
+== SEC
+
+Retrieve information from the U.S. Securities and Exchange Commission.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sec
+
+== Usage
+
+To retrieve all XBRL filings for March 2012:
+
+    > response = Sec::MonthlyReader.get_xbrl_index(2012, 3)
+
+The response is an RSS document, with each filing in response['channel']['item']
+
+    > response = ['rss']['channel']['item'].count
+    => 4195
+
+== Thanks
+Many thanks are owed to the following for me to be able to release my first gem:
+* {Mike Sassak}[http://github.com/msassak]
+* {Josh Schairbaum}[http://github.com/jschairb]
+* {Philip Toland}[http://github.com/toland]
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+== Licensing
+The SEC gem is released under the {MIT License}[http://www.opensource.org/licenses/MIT].

data/Rakefile

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

data/lib/sec/connection.rb

@@ -0,0 +1,33 @@
+module Sec
+  class Connection
+
+    require 'patron'
+
+    SEC_BASE_URL = 'http://www.sec.gov'
+
+    attr_reader :session
+
+    DEFAULT_SESSION_ATTRIBUTES = {
+      :base_url        => SEC_BASE_URL,
+      :connect_timeout => 5000,
+      :timeout         => 5000
+    }
+
+    def initialize(attrs={})
+      @session = Patron::Session.new
+      configure_session(attrs)
+    end
+
+    def get(uri)
+      @session.get(uri)
+    end
+
+    private
+    def configure_session(attrs={})
+      session_attrs = DEFAULT_SESSION_ATTRIBUTES.merge(attrs)
+      session_attrs.each_pair do |k, v|
+        session.send("#{k}=".to_sym, v)
+      end
+    end
+  end
+end

data/lib/sec/monthly_reader.rb

@@ -0,0 +1,40 @@
+module Sec
+  class MonthlyReader
+    class Error < StandardError; end
+
+    require 'crack'
+
+    MONTHLY_PATH = %q{/Archives/edgar/monthly/xbrlrss-%{year}-%{month}.xml}
+
+    attr_reader :xbrl_hash
+
+    def self.get_xbrl_index(year, month)
+      reader = MonthlyReader.new
+      reader.get_xbrl_index(year, month)
+    end
+
+    def get_xbrl_index(year, month)
+      resp = connection.get(monthly_query_uri(year, month))
+      if resp.status == 200
+        # items are in ["rss"]["channel"]
+        @xbrl_hash = Crack::XML.parse(resp.body)
+      else
+        nil
+      end
+    end
+
+    private
+    def connection(attrs={})
+      Sec::Connection.new
+    end
+
+    def prepend_zero(month)
+      month = month.to_s
+      month.prepend("0") if month.size == 1
+    end
+
+    def monthly_query_uri(year, month)
+      MONTHLY_PATH % {:year => year, :month => prepend_zero(month)}
+    end
+  end
+end

data/lib/sec/version.rb

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

data/lib/sec.rb

@@ -0,0 +1,6 @@
+module Sec
+end
+
+require "sec/connection"
+require "sec/monthly_reader"
+require "sec/version"

data/sec.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sec/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sec"
+  gem.version       = Sec::VERSION
+  gem.authors       = ["Gregory Graf"]
+  gem.email         = ["graf.gregory@gmail.com"]
+  gem.description   = %q{Reads information from the U.S. Securities and Exchange Commission}
+  gem.summary       = %q{SEC Reader}
+  gem.homepage      = "https://github.com/reinventinghorses/sec"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'crack'
+  gem.add_dependency 'patron'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+end

data/spec/connection_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Sec
+  describe 'Connection' do
+    let(:connection) { Connection.new }
+    let(:session) { connection.session }
+
+    describe '.new' do
+      it 'should set up a Patron session' do
+        expect(session).to be_kind_of(Patron::Session)
+      end
+
+      it 'should use the SEC base url' do
+        expected = 'http://www.sec.gov'
+
+        expect(session.base_url).to eq(expected)
+      end
+    end
+
+    describe '.get' do
+      it 'sends a get to the session' do
+        session.should_receive('get').with('/some_path')
+
+        connection.get('/some_path')
+      end
+    end
+  end
+end

data/spec/monthly_reader_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module Sec
+  describe MonthlyReader do
+    use_vcr_cassette 'monthly_reader'
+
+    let(:connection) { Sec::Connection.new }
+    let(:monthly_reader) { MonthlyReader.new }
+    let(:response) { monthly_reader.get_xbrl_index(2012, 1) }
+
+    describe '.get_xbrl_index' do
+      it 'returns a hash' do
+        expect(response).to be_kind_of(Hash)
+      end
+
+      it 'has a top level rss key' do
+        expect(response.keys).to eq(['rss'])
+      end
+    end
+  end
+end

data/spec/sec_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Sec' do
+  it 'should return true' do
+    expect(true).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rspec'
+require 'sec'
+
+# require everything in spec/support, not assuming forward or backward slash
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each {|f| require f }
+