sec 0.0.1 → 0.0.2

data/.travis.yml

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

data/README.rdoc

@@ -1,6 +1,6 @@
 == SEC
 
-Retrieve information from the U.S. Securities and Exchange Commission.
+Retrieve {XBRL}[http://xbrl.org/] information from the U.S. Securities and Exchange Commission.
 
 == Installation
 
@@ -18,15 +18,30 @@ Or install it yourself as:
 
 == Usage
 
-To retrieve all XBRL filings for March 2012:
+To retrieve an index of all XBRL filings for March 2012:
 
-    > response = Sec::MonthlyReader.get_xbrl_index(2012, 3)
+    > response = Sec::Reader.get_monthly_index(2012, 3)
 
 The response is an RSS document, with each filing in response['channel']['item']
 
-    > response = ['rss']['channel']['item'].count
+    > response['rss']['channel']['item'].count
     => 4195
 
+From there, you can retrieve an individual file:
+    > response = Sec::Reader.get_xbrl_file("http://www.sec.gov/Archives/edgar/data/840715/000084071512000011/clro-20111231.xml")
+    > puts response.body
+    > <?xml version='1.0' encoding='iso-8859-1'?>
+    > ...
+
+The entries of type "edgar:description"=>"XBRL INSTANCE DOCUMENT" can be parsed by {xbrlware-ruby19}[https://github.com/jimlindstrom/xbrlware-ruby19] for financial facts:
+    > require 'xbrlware-ruby19'
+
+    > ins = Xbrlware.ins(<xbrl_instance_file_path>) # Initialize XBRL instance
+    > items = ins.item("ProfitLoss") # Fetch all "ProfitLoss" financial fact
+    > items.each do |item|
+    >   puts item.value # Print value of each "ProfitLoss" item
+    > end
+
 == Thanks
 Many thanks are owed to the following for me to be able to release my first gem:
 * {Mike Sassak}[http://github.com/msassak]

data/lib/sec/{monthly_reader.rb → reader.rb}

@@ -1,31 +1,38 @@
 module Sec
-  class MonthlyReader
+  class Reader
     class Error < StandardError; end
 
     require 'crack'
 
     MONTHLY_PATH = %q{/Archives/edgar/monthly/xbrlrss-%{year}-%{month}.xml}
 
-    attr_reader :xbrl_hash
+    def self.get_monthly_index(year, month)
+      reader = Reader.new
+      reader.get_monthly_index(year, month)
+    end
 
-    def self.get_xbrl_index(year, month)
-      reader = MonthlyReader.new
-      reader.get_xbrl_index(year, month)
+    def self.get_xbrl_file(url)
+      reader = Reader.new
+      reader.get_xbrl_file(url)
     end
 
-    def get_xbrl_index(year, month)
+    def get_monthly_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)
+        Crack::XML.parse(resp.body)
       else
         nil
       end
     end
 
+    def get_xbrl_file(url)
+      resp = connection.get(uri_path(url))
+    end
+
     private
     def connection(attrs={})
-      Sec::Connection.new
+      Connection.new
     end
 
     def prepend_zero(month)
@@ -36,5 +43,9 @@ module Sec
     def monthly_query_uri(year, month)
       MONTHLY_PATH % {:year => year, :month => prepend_zero(month)}
     end
+
+    def uri_path(url)
+      url.gsub(Sec::Connection::SEC_BASE_URL, '')
+    end
   end
 end

data/lib/sec/version.rb

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

data/lib/sec.rb

@@ -2,5 +2,5 @@ module Sec
 end
 
 require "sec/connection"
-require "sec/monthly_reader"
+require "sec/reader"
 require "sec/version"

data/sec.gemspec

@@ -19,8 +19,10 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'crack'
   gem.add_dependency 'patron'
+  gem.add_dependency 'rake'
 
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'vcr'
-  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'webmock', '1.8.11'
 end

data/spec/reader_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Sec
+  describe Reader do
+    use_vcr_cassette 'reader'
+
+    let(:connection) { Sec::Connection.new }
+    let(:reader) { Reader.new }
+
+    describe '.get_monthly_index' do
+      let(:response) { reader.get_monthly_index(2012, 1) }
+
+      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
+
+    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
+
+      # 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/)
+      end
+    end
+  end
+end