xbrlware-ruby19 1.1.2.19.1 → 1.1.2.19.2

data/lib/xbrlware-ruby19.rb

@@ -17,8 +17,9 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-require 'rubygems'
 require 'xmlsimple'
+require 'rexml/document'
+require 'rexml/streamlistener'
 
 require 'date'
 require 'bigdecimal'
@@ -58,8 +59,8 @@ require 'xbrlware-ruby19/linkbase/calculation_linkbase'
 require 'xbrlware-ruby19/linkbase/definition_linkbase'
 require 'xbrlware-ruby19/linkbase/presentation_linkbase'
 
-require 'xbrlware-ruby19/edgar_data_downloader'
 require 'xbrlware-ruby19/edgar_util'
+require 'xbrlware-ruby19/edgar_data_downloader'
 
 require 'logger'
 require 'benchmark'

data/lib/xbrlware-ruby19/edgar_data_downloader.rb

@@ -17,110 +17,112 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-module Edgar
+module Xbrlware
+  module Edgar
+    
+    # This class defines method to download XBRL files from SEC's XBRL RSS Feed.  
+    # See {report generation xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/ReportGeneration] for how to use this class.  
+    class RSSFeedDownloader
+      include ::Xbrlware::Edgar::FileUtil
   
-  # This class defines method to download XBRL files from SEC's XBRL RSS Feed.  
-  # See {report generation xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/ReportGeneration] for how to use this class.  
-  class RSSFeedDownloader
-    include FileUtil
-
-    attr_reader :content
-
-    def initialize(sec_edgar_rss_file=nil)
-      sec_edgar_rss_file ||= "http://www.sec.gov/Archives/edgar/usgaap.rss.xml"
-      @content = XmlSimple.xml_in(open(sec_edgar_rss_file).read, {'ForceContent' => true})
-    end
-
-    # Takes limit (how many entities to download), download_to (where to download)
-    #  default value for limit is 100
-    #  default value for download_to is current_dir + "/edgar_data" 
-    def download(limit=100, download_to=File.expand_path(".")+File::SEPARATOR+"edgar_data")
-      items=@content["channel"][0]["item"]
-      items.each_with_index do |item, index|
-        break if index==limit
-        files=get_xbrl_files(item)
-        download_to += File::SEPARATOR unless download_to.end_with?(File::SEPARATOR)
-        data_dir=download_to
-        data_dir=data_dir+File::SEPARATOR+item["xbrlFiling"][0]["cikNumber"][0]["content"]
-        data_dir=data_dir+File::SEPARATOR+item["xbrlFiling"][0]["accessionNumber"][0]["content"]
-        mkdir(data_dir)
-        files.each do |file|
-          file_content=open(file["edgar:url"]).read
-          dump_to_file(data_dir+File::SEPARATOR+file["edgar:file"], file_content)
+      attr_reader :content
+  
+      def initialize(sec_edgar_rss_file=nil)
+        sec_edgar_rss_file ||= "http://www.sec.gov/Archives/edgar/usgaap.rss.xml"
+        @content = XmlSimple.xml_in(open(sec_edgar_rss_file).read, {'ForceContent' => true})
+      end
+  
+      # Takes limit (how many entities to download), download_to (where to download)
+      #  default value for limit is 100
+      #  default value for download_to is current_dir + "/edgar_data" 
+      def download(limit=100, download_to=File.expand_path(".")+File::SEPARATOR+"edgar_data")
+        items=@content["channel"][0]["item"]
+        items.each_with_index do |item, index|
+          break if index==limit
+          files=get_xbrl_files(item)
+          download_to += File::SEPARATOR unless download_to.end_with?(File::SEPARATOR)
+          data_dir=download_to
+          data_dir=data_dir+File::SEPARATOR+item["xbrlFiling"][0]["cikNumber"][0]["content"]
+          data_dir=data_dir+File::SEPARATOR+item["xbrlFiling"][0]["accessionNumber"][0]["content"]
+          FileUtils.mkdir_p(data_dir)
+          files.each do |file|
+            file_content=open(file["edgar:url"]).read
+            dump_to_file(data_dir+File::SEPARATOR+file["edgar:file"], file_content)
+          end
         end
       end
-    end
-
-    def print_stat # :nodoc:
-      i_url=""
-      i_size=0
-      title=""
-      items=@content["channel"][0]["item"]
-      items.each do |item|
-        files=get_xbrl_files(item)
-        files.each do |file|
-          if file["type"]=="EX-101.INS" && (i_size==0 || file["size"].to_i < i_size)
-            i_size = file["edgar:size"].to_i
-            i_url = file["edgar:url"]
-            title = item["edgar:title"]
+  
+      def print_stat # :nodoc:
+        i_url=""
+        i_size=0
+        title=""
+        items=@content["channel"][0]["item"]
+        items.each do |item|
+          files=get_xbrl_files(item)
+          files.each do |file|
+            if file["type"]=="EX-101.INS" && (i_size==0 || file["size"].to_i < i_size)
+              i_size = file["edgar:size"].to_i
+              i_url = file["edgar:url"]
+              title = item["edgar:title"]
+            end
           end
         end
+        puts ""
+        puts " Smallest Instance File " + i_url 
       end
-      puts ""
-      puts " Smallest Instance File " + i_url 
-    end
-
-    private
-    # Gets url that end with xml and xsd 
-    def get_xbrl_files(item)
-      xbrl_files=item["xbrlFiling"][0]["xbrlFiles"][0]["xbrlFile"]
-      return xbrl_files.select {|e| e["edgar:url"].end_with?("xml") || e["edgar:url"].end_with?("xsd")}
-    end
-
-  end
-
-  # This class defines method to download XBRL files from SEC's EDGAR filling url.
-  # See {report generation xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/ReportGeneration] for how to use this class.
-  class HTMLFeedDownloader
-    include REXML::StreamListener
-    include FileUtil
-
-    attr_reader :links
-
-    # Takes url and download_to (where to download)
-    #  default value for download_to is current_dir    
-    def download(url, download_to=File.expand_path(".")+File::SEPARATOR)
-      $LOG.info " Starting download of fillings from SEC url ["+url+"]"
-      files=[]
-      content = open(url).read
-      @links = Set.new
-      uri=URI(url)
-      @base_path=""
-      @base_path=(uri.scheme+"://"+uri.host+((uri.port==80 && "") || ":"+uri.port.to_s)) unless uri.host.nil?
-      parse(content)
-      download_to += File::SEPARATOR unless download_to.end_with?(File::SEPARATOR)
-      mkdir(download_to)
-      @links.each do |link|
-        file=download_to + link.split("/")[-1]
-        dump_to_file(file, open(link).read)
-        files << file
-      end unless uri.host.nil?
-      files
-    end
-
-    # Callback method for notifying start of xml elements by REXML stream parser. 
-    def tag_start(name, attrs) # :nodoc:
-      if "a"==name
-        href=attrs["href"]
-        @links << @base_path + href if href.end_with?("xml") || href.end_with?("xsd")
+  
+      private
+      # Gets url that end with xml and xsd 
+      def get_xbrl_files(item)
+        xbrl_files=item["xbrlFiling"][0]["xbrlFiles"][0]["xbrlFile"]
+        return xbrl_files.select {|e| e["edgar:url"].end_with?("xml") || e["edgar:url"].end_with?("xsd")}
       end
+  
     end
-
-    private
-    def parse(text)
-      REXML::Document.parse_stream(text, self)
+  
+    # This class defines method to download XBRL files from SEC's EDGAR filling url.
+    # See {report generation xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/ReportGeneration] for how to use this class.
+    class HTMLFeedDownloader
+      include REXML::StreamListener
+      include ::Xbrlware::Edgar::FileUtil
+  
+      attr_reader :links
+  
+      # Takes url and download_to (where to download)
+      #  default value for download_to is current_dir    
+      def download(url, download_to=File.expand_path(".")+File::SEPARATOR)
+        $LOG.info " Starting download of fillings from SEC url ["+url+"]"
+        files=[]
+        content = open(url).read
+        @links = Set.new
+        uri=URI(url)
+        @base_path=""
+        @base_path=(uri.scheme+"://"+uri.host+((uri.port==80 && "") || ":"+uri.port.to_s)) unless uri.host.nil?
+        parse(content)
+        download_to += File::SEPARATOR unless download_to.end_with?(File::SEPARATOR)
+        FileUtils.mkdir_p(download_to)
+        @links.each do |link|
+          file=download_to + link.split("/")[-1]
+          dump_to_file(file, open(link).read)
+          files << file
+        end unless uri.host.nil?
+        files
+      end
+  
+      # Callback method for notifying start of xml elements by REXML stream parser. 
+      def tag_start(name, attrs) # :nodoc:
+        if "a"==name
+          href=attrs["href"]
+          @links << @base_path + href if href.end_with?("xml") || href.end_with?("xsd")
+        end
+      end
+  
+      private
+      def parse(text)
+        REXML::Document.parse_stream(text, self)
+      end
+  
     end
-
+  
   end
-
 end

data/lib/xbrlware-ruby19/edgar_util.rb

@@ -17,14 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-module Edgar
-  module FileUtil # :nodoc:
-    def mkdir(dir)
-      File.makedirs(dir) unless File.directory?(dir)  
+module Xbrlware
+  module Edgar
+    module FileUtil # :nodoc:
+      #def mkdir(dir)
+      #  File.makedirs(dir) unless File.directory?(dir)  
+      #end
+      
+      def dump_to_file(file, content)
+        File.open(file, 'w') {|f| f.write(content) }
+      end  
     end
-    
-    def dump_to_file(file, content)
-      File.open(file, 'w') {|f| f.write(content) }
-    end  
   end
-end
+end

data/lib/xbrlware-ruby19/version.rb

@@ -18,5 +18,5 @@
 #           limitations under the License.
 #
 module Xbrlware
-  VERSION = "1.1.2.19.1"
+  VERSION = "1.1.2.19.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xbrlware-ruby19
 version: !ruby/object:Gem::Version
-  version: 1.1.2.19.1
+  version: 1.1.2.19.2
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &73643820 !ruby/object:Gem::Requirement
+  requirement: &71299010 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *73643820
+  version_requirements: *71299010
 - !ruby/object:Gem::Dependency
   name: bigdecimal
-  requirement: &73643610 !ruby/object:Gem::Requirement
+  requirement: &71298800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *73643610
+  version_requirements: *71298800
 - !ruby/object:Gem::Dependency
   name: logger
-  requirement: &73643400 !ruby/object:Gem::Requirement
+  requirement: &71298590 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *73643400
+  version_requirements: *71298590
 description: Re-packaging of xbrlware for ruby19
 email:
 - jim.lindstrom@gmail.com