xbrlware-ce 1.0.2

data/Copying.txt

@@ -0,0 +1,13 @@
+Copyright 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/License.txt

@@ -0,0 +1,13 @@
+Copyright 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/ruby
+#
+# Author:: xbrlware@bitstat.com
+#
+# Copyright:: 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+require 'rubygems'
+gem 'rake'
+
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+
+LIBDIR = 'lib'
+DOCDIR = 'doc'
+TESTDIR = 'test'
+EXAMPLEDIR = 'example'
+
+# Configure some constants and built-in tasks
+CURRENT_VERSION = '1.0.2'
+PKG_VERSION = ENV['REL'] ? ENV['REL'] : CURRENT_VERSION
+
+COMMUNITY_EDITION = 'xbrlware-ce'
+PKG_NAME = ENV['EDT'] ? ENV['EDT'] : COMMUNITY_EDITION
+
+PKG_DEPENDENCY = {'xml-simple' => '= 1.0.12'}
+
+SCHEMA_VALIDATION="True"
+unless ENV.include?("SCHEMA_VALIDATION")
+  ENV["SCHEMA_VALIDATION"]=SCHEMA_VALIDATION
+end
+
+task :default => "test"
+
+
+# ========================================================================
+# Create a task to perform the unit testing.
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList[
+          'test/lib/**/*_test.rb'
+  ]
+  t.warning = false
+  t.verbose = false
+end
+
+# ========================================================================
+# Create a task to build the RDOC documentation tree.
+Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = DOCDIR
+  rdoc.title = 'xbrl -- Parser library for XBRL Instance Document, Taxonomy, Linkbases'
+  rdoc.main = 'Readme.txt'
+  rdoc.rdoc_files.include('Readme.txt')
+  rdoc.rdoc_files.include("#{LIBDIR}/**/*.rb")
+  rdoc.rdoc_files.exclude("#{LIBDIR}/xbrlware/taxonomies/*.rb")
+end
+
+# ========================================================================
+# Create a task that will package the Rake software into distributable
+# gem files.
+PKG_FILES = FileList[
+        '*.*',
+                "#{LIBDIR}/**/*.rb",
+                "#{DOCDIR}/**/*.*",
+                "#{TESTDIR}/**/*.*",
+                "#{EXAMPLEDIR}/**/*.*"
+]
+
+PKG_FILES.exclude(/\._/)
+
+unless defined?(Gem)
+  puts "Package Target requires RubyGems"
+else
+  spec = Gem::Specification.new do |s|
+
+    # Basic information
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.summary = 'A fast, lightweight framework to parse, extract information from XBRL documents.'
+    description = s.summary +
+            "\nxbrlware understands structure and relationship among elements of XBRL documents and" +
+              "\ndefines a set of APIs for accessing financial & business facts, meta & other related information"+
+              "\ndefined in XBRL documents."
+    
+    s.description = description
+
+    # Files and dependencies
+    s.files = PKG_FILES.to_a
+    s.require_path = LIBDIR
+    PKG_DEPENDENCY.each do |name, ver|
+      s.add_dependency(name, ver)
+    end
+
+    # RDoc information
+    s.has_rdoc = true
+    s.extra_rdoc_files = ['Readme.txt']
+    s.rdoc_options << '--main' << 'Readme.txt'
+
+    # Metadata
+    s.authors = ['bitstat technologies']
+    s.email = 'xbrlware@bitstat.com'
+    s.homepage = 'http://www.bitstat.com/xbrlware/'
+    s.rubyforge_project = 'xbrlware'
+    s.requirements << 'xml-simple v1.0.12'
+  end
+
+  Rake::GemPackageTask.new(spec) do |t|
+    t.need_tar = true
+  end
+end

data/Readme.txt

@@ -0,0 +1,15 @@
+= Copyright/License Info
+
+Copyright 2009, 2010 bitstat (http://www.bitstat.com). All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/doc/classes/Edgar.html

@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Edgar</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Edgar</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/edgar/util_rb.html">
+                lib/edgar/util.rb
+                </a>
+        <br />
+                <a href="../files/lib/edgar/edgar_data_downloader_rb.html">
+                lib/edgar/edgar_data_downloader.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <table>
+<tr><td valign="top">Author:</td><td>xbrlware@bitstat.com
+
+</td></tr>
+<tr><td valign="top">Copyright:</td><td>2009, 2010 bitstat (<a href="http://www.bitstat.com">www.bitstat.com</a>).
+All Rights Reserved.
+
+</td></tr>
+<tr><td valign="top">License:</td><td>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
+you may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+<p>
+<a
+href="http://www.apache.org/licenses/LICENSE-2.0">www.apache.org/licenses/LICENSE-2.0</a>
+</p>
+<p>
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+</p>
+</td></tr>
+</table>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="Edgar/HTMLFeedDownloader.html" class="link">Edgar::HTMLFeedDownloader</a><br />
+Class <a href="Edgar/RSSFeedDownloader.html" class="link">Edgar::RSSFeedDownloader</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Edgar/HTMLFeedDownloader.html

@@ -0,0 +1,199 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Edgar::HTMLFeedDownloader</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Edgar::HTMLFeedDownloader</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/edgar/edgar_data_downloader_rb.html">
+                lib/edgar/edgar_data_downloader.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+This class defines method to <a
+href="HTMLFeedDownloader.html#M000078">download</a> XBRL files from
+SEC&#8216;s EDGAR filling url. See <a
+href="http://code.google.com/p/xbrlware/wiki/ReportGeneration">report
+generation xbrlware wiki</a> for how to use this class.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000078">download</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name">REXML::StreamListener</span>
+        <span class="include-name">FileUtil</span>
+      </div>
+    </div>
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">links</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000078" class="method-detail">
+        <a name="M000078"></a>
+
+        <div class="method-heading">
+          <a href="#M000078" class="method-signature">
+          <span class="method-name">download</span><span class="method-args">(url, download_to=File.expand_path(&quot;.&quot;)+File::SEPARATOR)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Takes url and download_to (where to <a
+href="HTMLFeedDownloader.html#M000078">download</a>)
+</p>
+<pre>
+ default value for download_to is current_dir
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000078-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/edgar/edgar_data_downloader.rb, line 92</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">download</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">download_to</span>=<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-value str">&quot;.&quot;</span>)<span class="ruby-operator">+</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
+      <span class="ruby-identifier">$LOG</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">&quot; Starting download of fillings from SEC url [&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">url</span><span class="ruby-operator">+</span><span class="ruby-value str">&quot;]&quot;</span>
+      <span class="ruby-identifier">files</span>=[]
+      <span class="ruby-identifier">content</span> = <span class="ruby-identifier">open</span>(<span class="ruby-identifier">url</span>).<span class="ruby-identifier">read</span>
+      <span class="ruby-ivar">@links</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>
+      <span class="ruby-identifier">uri</span>=<span class="ruby-constant">URI</span>(<span class="ruby-identifier">url</span>)
+      <span class="ruby-ivar">@base_path</span>=<span class="ruby-value str">&quot;&quot;</span>
+      <span class="ruby-ivar">@base_path</span>=(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span><span class="ruby-operator">+</span><span class="ruby-value str">&quot;://&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span><span class="ruby-operator">+</span>((<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span><span class="ruby-operator">==</span><span class="ruby-value">80</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-value str">&quot;&quot;</span>) <span class="ruby-operator">||</span> <span class="ruby-value str">&quot;:&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span>.<span class="ruby-identifier">to_s</span>)) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>.<span class="ruby-identifier">nil?</span>
+      <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">content</span>)
+      <span class="ruby-identifier">download_to</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">download_to</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
+      <span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">download_to</span>)
+      <span class="ruby-ivar">@links</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">link</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">file</span>=<span class="ruby-identifier">download_to</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">link</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;/&quot;</span>)[<span class="ruby-value">-1</span>]
+        <span class="ruby-identifier">dump_to_file</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">open</span>(<span class="ruby-identifier">link</span>).<span class="ruby-identifier">read</span>)
+        <span class="ruby-identifier">files</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">file</span>
+      <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>.<span class="ruby-identifier">nil?</span>
+      <span class="ruby-identifier">files</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>