sitelink_generator 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5521c022606698bd5ee3a8b59c43ef6219aaefed
+  data.tar.gz: dabf4fea0abbfbe3bfc3d8c7ce4e9fe9680bfbad
+SHA512:
+  metadata.gz: 9ac721f4c5d557d33cb7e779344ec22f753a818e751ba322798136268a803e4b6e9575bf232dbdd1f4f8ef5b2bdfa9b1423b155496ee161a66e7441bfe2cdceb
+  data.tar.gz: afed1d460eb83be4f14771b35117b66940b583cb86678cd5e753a1125a356334d3595a49b7af718a21d3af59af09faae647cccfd4ddd633d43e285e8de5f909e

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented generator or bug fix.
+4. Run `bundle exec rake`. If your specs pass, return to step 3.
+5. Implement your generator or bug fix.
+6. Run `bundle exec rake`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: http://help.github.com/send-pull-requests/

data/LICENSE.md

@@ -0,0 +1,11 @@
+## License
+
+This project constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105.
+
+The project utilizes code licensed under the terms of the GNU General Public License and therefore is licensed under GPL v2 or later.
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

data/README.md

@@ -0,0 +1,44 @@
+# Sitelink Generator
+
+[DigitalGov Search](http://search.digitalgov.gov) powers the search box on 1,500 government websites. 
+
+This sitelink generator "decorates" organic web results to provide additional, value-added links to help searchers find what they're looking for.
+
+See the sample results page below that shows sitelink-generated links for EDGAR filings for a search on *apple* on SEC.gov.
+
+![Sitelink-generated links for EDGAR filings on SEC.gov](https://9fddeb862c037f6d2190-f1564c64756a8cfee25b6b19953b1d23.ssl.cf2.rackcdn.com/sitelink.png "Sitelink-generated links for EDGAR filings on SEC.gov")
+
+## Installation
+
+Add sitelink_generator to your `Gemfile` and `bundle install`:
+
+```ruby
+gem 'sitelink_generator'
+```
+
+## Available Generators
+
+[Available generators](lib/sitelink_generator/generators/) include:
+
+* [SecEdgar](lib/sitelink_generator/generators/sec_edgar.rb)
+
+## Usage
+
+```ruby
+require 'sitelink_generator'
+
+url = 'http://www.sec.gov/Archives/edgar/data/1577552/000119312514184994/d709111df1.htm'
+SitelinkGenerator::SecEdgar.generate url
+#=> [{:title=>"Full Filing",
+#     :url=>"http://www.sec.gov/Archives/edgar/data/1577552/0001193125-14-184994-index.htm"},
+#    {:title=>"Most Recent Filings for this Company",
+#     :url=>"http://www.sec.gov/cgi-bin/browse-edgar?CIK=1577552&Find=Search&action=getcompany&owner=exclude"}]
+```
+
+## Supported Ruby Versions
+
+* Ruby 2.1
+
+## Feedback
+
+If you think you found a bug in SitelinkGenerator, you can [submit an issue](https://github.com/GSA/sitelink_generator/issues/new).

data/lib/sitelink_generator.rb

@@ -0,0 +1,18 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/string/inflections'
+require 'i18n'
+
+require_relative 'sitelink_generator/base'
+require_relative 'sitelink_generator/i18n'
+require_relative 'sitelink_generator/version'
+
+module SitelinkGenerator
+  GENERATORS = Dir["#{File.dirname(__FILE__)}/sitelink_generator/generators/*.rb"].sort.collect do |path|
+    generator_file_name = File.basename(path, '.rb')
+
+    require_relative "sitelink_generator/generators/#{generator_file_name}"
+    "SitelinkGenerator::#{generator_file_name.camelize}".constantize
+  end.freeze
+
+  GENERATOR_HASH = Hash[GENERATORS.collect { |g| [g.name, g] }].freeze
+end

data/lib/sitelink_generator/base.rb

@@ -0,0 +1,14 @@
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+
+module SitelinkGenerator
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      class_eval do
+        class_attribute :url_prefix, instance_writer: false
+      end
+    end
+  end
+end

data/lib/sitelink_generator/generators/sec_edgar.rb

@@ -0,0 +1,50 @@
+require 'active_support/core_ext/object/to_query'
+require 'uri'
+
+module SitelinkGenerator
+  class SecEdgar
+    include SitelinkGenerator::Base
+
+    self.url_prefix = 'www.sec.gov/Archives/edgar/data/'.freeze
+
+    MATCHING_URL_REGEX = %r{^(?!.*-index\.htm$)https?://(www\.)?sec\.gov/Archives/edgar/data/\d+/\d+\/.+$}i
+
+    DEFAULT_BROWSE_EDGAR_PARAMS = {
+      Find: 'Search',
+      action: 'getcompany',
+      owner: 'exclude'
+    }.freeze
+
+    def self.generate(url)
+      return [] unless url =~ MATCHING_URL_REGEX
+
+      path_as_array = URI.parse(url).path.split('/')
+      return [] unless path_as_array.length == 7
+
+      [generate_full_filing_url(path_as_array),
+       generate_browse_edgar_url(path_as_array)]
+    end
+
+    def self.generate_browse_edgar_url(path_as_array)
+      title = I18n.t(:'sitelink_generator.sec_edgar.most_recent_filings')
+
+      cik = path_as_array[4]
+      url_params = DEFAULT_BROWSE_EDGAR_PARAMS.merge(CIK: cik)
+      url = "http://www.sec.gov/cgi-bin/browse-edgar?#{url_params.to_param}"
+
+      { title: title, url: url }
+    end
+
+    def self.generate_full_filing_url(path_as_array)
+      cik = path_as_array[4]
+      cik_part_1 = path_as_array[5].slice(0, 10)
+      cik_part_2 = path_as_array[5].slice(10, 2)
+      cik_part_3 = path_as_array[5].slice(12..-1)
+
+      full_filing_path = "#{cik}/#{cik_part_1}-#{cik_part_2}-#{cik_part_3}-index.htm"
+      url = "http://www.sec.gov/Archives/edgar/data/#{full_filing_path}"
+
+      { title: I18n.t('sitelink_generator.sec_edgar.full_filing'), url: url }
+    end
+  end
+end

data/lib/sitelink_generator/i18n.rb

@@ -0,0 +1,2 @@
+I18n.load_path += Dir["#{File.dirname(__FILE__)}/locales/**/*.yml"]
+I18n.config.enforce_available_locales = false

data/lib/sitelink_generator/locales/sec_edgar/en.yml

@@ -0,0 +1,5 @@
+en:
+  sitelink_generator:
+    sec_edgar:
+      full_filing: Full Filing
+      most_recent_filings: Most Recent Filings for this Company

data/lib/sitelink_generator/locales/sec_edgar/es.yml

@@ -0,0 +1,5 @@
+es:
+  sitelink_generator:
+    sec_edgar:
+      full_filing: Todos los informes
+      most_recent_filings: Informes más recientes de esta compañía

data/lib/sitelink_generator/version.rb

@@ -0,0 +1,3 @@
+module SitelinkGenerator
+  VERSION = '0.3.0'
+end

data/sitelink_generator.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitelink_generator/version'
+
+Gem::Specification.new do |s|
+  s.add_dependency 'i18n', '~> 0.6'
+  s.add_dependency 'activesupport', '~> 3.2'
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.authors = ['DigitalGov Search']
+  s.date = '2014-10-29'
+  s.description = 'A DigitalGov Search sitelink generator'
+  s.email = 'search@support.digitalgov.gov'
+  s.files = %w(CONTRIBUTING.md LICENSE.md README.md sitelink_generator.gemspec)
+  s.files += Dir['lib/**/*.rb']
+  s.files += Dir['lib/**/*.yml']
+  s.homepage = 'http://search.digitalgov.gov'
+  s.license = 'MIT'
+  s.name = 'sitelink_generator'
+  s.required_ruby_version = '~> 2.1'
+  s.summary = 'sitelink generator for DigitalGov Search'
+  s.version = SitelinkGenerator::VERSION
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: sitelink_generator
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- DigitalGov Search
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A DigitalGov Search sitelink generator
+email: search@support.digitalgov.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- lib/sitelink_generator.rb
+- lib/sitelink_generator/base.rb
+- lib/sitelink_generator/generators/sec_edgar.rb
+- lib/sitelink_generator/i18n.rb
+- lib/sitelink_generator/locales/sec_edgar/en.yml
+- lib/sitelink_generator/locales/sec_edgar/es.yml
+- lib/sitelink_generator/version.rb
+- sitelink_generator.gemspec
+homepage: http://search.digitalgov.gov
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: sitelink generator for DigitalGov Search
+test_files: []