ecfs 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alan deLevie
+
+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.md

@@ -0,0 +1,54 @@
+# ECFS
+
+ECFS helps you download and parse filings from the FCC's Electronic Comment Filing System.
+
+[![Build Status](https://travis-ci.org/adelevie/ecfs.png?branch=master)](https://travis-ci.org/adelevie/ecfs)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecfs'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install ecfs
+```
+
+## Usage
+
+```ruby
+
+# get info about a specific proceeding
+proceeding = ECFS::ProceedingsQuery.new.tap do |q|
+  q.eq("proceeding_number", "12-375")
+end.get
+#=>
+{
+  "bureau_name" => "Wireline Competition Bureau",
+  "subject" => 
+  "Implementation of the Pay Telephone Reclassification and Compensation Provisions of the Telecommunications Act of 1996 et al.",
+  "prepared_by" => "Aleta.Bowers",
+  "date_created" => "12/26/2012",
+  "status" => "Open",
+  "total_filings" => "292",
+  "filings_in_last_30_days" => "58"
+}
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/ecfs.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ecfs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecfs"
+  spec.version       = ECFS::VERSION
+  spec.authors       = ["Alan deLevie"]
+  spec.email         = ["adelevie@gmail.com"]
+  spec.description   = %q{ECFS provides a set of utilities for scraping FCC rulemakings}
+  spec.summary       = %q{ECFS helps you obtain comments and other filings from the FCC's Electronic Comment Filing System}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "mechanize"
+  spec.add_dependency "pry"
+end

data/lib/ecfs.rb

@@ -0,0 +1,5 @@
+require "ecfs/version"
+require "ecfs/proceedings_query"
+
+module ECFS
+end

data/lib/ecfs/proceedings_query.rb

@@ -0,0 +1,100 @@
+require "mechanize"
+
+module ECFS
+
+  class ProceedingsQuery
+    attr_reader :constraints
+
+    def initialize
+      @constraints = {}
+    end
+
+    def eq(field, value)
+      @constraints[field] = value
+      self
+    end
+
+    def constraints_dictionary
+      {
+        "docket_number"  => "name",
+        "bureau_code"    => "bureauCode",
+        "subject"        => "subject",
+        "bureau_id"      => "bureauIdentificationNumber",
+        "applicant"      => "application",
+        "filed_by"       => "filedBy",
+        "recent_filings" => "__checkbox_recentFilingsRequired",
+        "open_status"    => "openStatus",
+        "created_after"  => "created.minDate",
+        "created_before" => "created.maxDate",
+        "closed_after"   => "closed.minDate",
+        "closed_before"  => "closed.maxDate",
+        "callsign"       => "callsign",
+        "channel"        => "channel",
+        "rule_section"   => "ruleSection",
+        "page_number"    => "pageNumber"
+      }
+    end
+
+    def format_constraint(constraint)
+      constraints_dictionary[constraint]
+    end
+
+    def query_string
+      @constraints.keys.map do |constraint|
+        format_constraint(constraint) + "=" + @constraints[constraint]
+      end.join("&")
+    end
+
+    def url
+      base = "http://apps.fcc.gov/ecfs/proceeding_search/execute"
+
+      "#{base}?#{query_string}"
+    end
+
+    def get
+      if @constraints["docket_number"]
+        scrape_proceedings_page
+      else
+        scrape_results_page
+      end
+    end
+
+    private
+
+    def scrape_proceedings_page
+      agent = Mechanize.new
+      page = agent.get(url)
+      container = []
+      page.search("div").select do |d| 
+        d.attributes["class"].nil? == false
+      end.select do |d|
+        d.attributes["class"].text == "wwgrp"
+      end.each do |node|
+        node.search("span").each do |span|
+          search = span.search("label")
+          pair = []
+          if search.length > 0
+            key = search.first.children.first.text.lstrip.rstrip.split(":")[0].gsub(" ", "_").downcase
+            pair << key
+          else
+            value = span.text.lstrip.rstrip
+            value.gsub!(",", "") if value.is_a?(String)
+            pair << value
+          end
+          container << pair
+        end
+      end
+      hash = {}
+      container.each_slice(2) do |chunk|
+        hash.merge!({chunk[0][0] => chunk[1][0]})
+      end
+
+      hash
+    end
+
+    def scrape_results_page
+      raise "Parsing result pages is not yet supported."
+    end
+
+  end
+end

data/lib/ecfs/version.rb

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

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+
+require 'test/unit'
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ecfs'

data/test/test_proceedings_query.rb

@@ -0,0 +1,53 @@
+require "helper"
+require "pp"
+
+class TestProceedingsQuery < Test::Unit::TestCase
+  def test_add_constraint
+    proceedings_query = ECFS::ProceedingsQuery.new
+    proceedings_query.eq("docket_number", "12-375")
+    proceedings_query.constraints
+  end
+
+  def test_constraints_dictionary
+    proceedings_query = ECFS::ProceedingsQuery.new
+    dictionary = proceedings_query.constraints_dictionary
+    assert_equal Hash, dictionary.class
+  end
+
+  def test_query_string
+    proceedings_query = ECFS::ProceedingsQuery.new
+    proceedings_query.eq("docket_number", "12-375")
+    proceedings_query.eq("subject", "phones")
+    assert_equal proceedings_query.query_string, "name=12-375&subject=phones"
+  end
+
+  def test_url
+    proceedings_query = ECFS::ProceedingsQuery.new
+    proceedings_query.eq("bureau_code", "WC")
+    proceedings_query.eq("subject", "phones")
+    url = "http://apps.fcc.gov/ecfs/proceeding_search/execute?bureauCode=WC&subject=phones"
+    assert_equal proceedings_query.url, url
+  end
+
+  def test_get_proceeding_info
+    proceedings_query = ECFS::ProceedingsQuery.new
+    proceedings_query.eq("docket_number", "12-375")
+    results = proceedings_query.get
+    %w[
+      bureau_name subject date_created status
+      total_filings filings_in_last_30_days
+    ].each do |key|
+      assert results.keys.include?(key)
+    end
+    pp results
+  end
+
+  # TODO: Implement proceeding search result pages
+  def test_get_proceeding_search_results
+    proceedings_query = ECFS::ProceedingsQuery.new
+    proceedings_query.eq("bureau_code", "WB")
+    assert_raise RuntimeError do
+      proceedings_query.get
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: ecfs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alan deLevie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ECFS provides a set of utilities for scraping FCC rulemakings
+email:
+- adelevie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ecfs.gemspec
+- lib/ecfs.rb
+- lib/ecfs/proceedings_query.rb
+- lib/ecfs/version.rb
+- test/helper.rb
+- test/test_proceedings_query.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ECFS helps you obtain comments and other filings from the FCC's Electronic
+  Comment Filing System
+test_files:
+- test/helper.rb
+- test/test_proceedings_query.rb
+has_rdoc: