mass_shootings 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56342cbde02ebb1f08df1f9eab8957b2827b3156
+  data.tar.gz: 66ff3cb637ac2edd7896673b182c81727b1c2586
+SHA512:
+  metadata.gz: b0c9ad74375a2f5d3bfac7d39413741c285520be7310403db95ce053181f74544cbc1c50398ca3d134aea5fbac8ffed9432e6bd73c574a974acd21fadce64707
+  data.tar.gz: 65353201bda10ce4ec4f32745a9d34212339b176ac769f22a0eb3301ea6e8ec8e6b00b14321eddd19289cbb1abaa7d5b4995bb4f68ccaf3515862f926c4c1301

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright © 2015 David P. Kleinschmidt
+
+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,39 @@
+# mass_shootings
+
+`mass_shootings` provides an easy-to-use Ruby interface to query and report on
+mass shootings in America.
+
+## Usage
+
+Mass shootings have several properties:
+
+- **id** a unique identifier
+- **alleged_shooters** the names of the alleged shooters, if known
+- **casualties** count of casualties, classified by type (`:dead` or `:injured`)
+- **date** date the shooting occurred
+- **location** where the shooting occurred
+- **references** links to relevant news sources
+
+To retrieve a list of mass shootings that occurred within a date range:
+
+```ruby
+MassShootings::Tracker.in_date_range Date.new(2015, 12, 6)...Date.today + 1
+```
+
+To retrieve a single mass shooting by ID:
+
+```ruby
+MassShootings::Tracker.get '2015-318'
+```
+
+You can use Ruby's built-in Enumerable methods to filter results:
+
+```ruby
+shootings.
+  reject { |shooting| shooting.casualties.fetch(:dead, 0) == 0 }.
+  sort_by { |shooting| shooting.casualties[:dead] }
+```
+
+Shootings are cached in-memory. If you use `mass_shooting` in a long-lived
+process, the cache may become stale unless you call
+`MassShootings::Tracker.reset` every 24 hours and 36 minutes or so.

data/lib/mass_shootings/gemspec.rb

@@ -0,0 +1,31 @@
+require 'mass_shootings/version'
+
+module MassShootings
+  class << self
+    #
+    # Gemspec for `mass_shootings`. This is only used by the gemspec and the
+    # Rakefile, and must be required separately.
+    #
+    def gemspec
+      @gemspec ||= Gem::Specification.new do |gem|
+        gem.authors  = 'David P Kleinschmidt'
+        gem.email    = 'david@kleinschmidt.name'
+        gem.homepage = 'http://bitbucket.org/zobar/mass_shootings'
+        gem.license  = 'MIT'
+        gem.name     = 'mass_shootings'
+        gem.summary  = 'Mass shootings as a service'
+        gem.version  = VERSION
+
+        gem.files = Dir['*.md', '{lib,spec}/**/*.rb']
+
+        gem.add_dependency 'activemodel', '~> 4.2'
+        gem.add_dependency 'nokogiri',    '~> 1.6'
+
+        gem.add_development_dependency 'minitest',  '~> 5.8'
+        gem.add_development_dependency 'mocha',     '~> 1.1'
+        gem.add_development_dependency 'simplecov', '~> 0.11'
+        gem.add_development_dependency 'yard',      '~> 0.8'
+      end
+    end
+  end
+end

data/lib/mass_shootings/shooting.rb

@@ -0,0 +1,38 @@
+require 'active_model'
+
+module MassShootings
+  #
+  # A `MassShooting::Shooting` is when four or more people are shot in an event,
+  # or related series of events, likely without a cooling off period.
+  #
+  class Shooting
+    include ActiveModel::AttributeMethods
+
+    define_attribute_methods :id, :alleged_shooters, :casualties, :date,
+      :location, :references
+
+    #
+    # Retrieves an attribute by name.
+    #
+    def attribute(name)
+      @attributes[name.to_sym]
+    end
+
+    #
+    # Creates a new Shooting with the given attributes.
+    #
+    # @param [Hash] attributes Information pertaining to the Shooting.
+    # @option attributes [String] id a unique identifier
+    # @option attributes [Array<String>] alleged_shooters (nil) the names of the
+    #         alleged shooters
+    # @option attributes [Hash{Symbol => Integer}] casualties count of
+    #         casualties, classified by type (`:dead` or `:injured`)
+    # @option attributes [Date] date date the shooting occurred
+    # @option attributes [String] location where the shooting occurred
+    # @option attributes [Array<URI>] references links to relevant news sources
+    #
+    def initialize(attributes)
+      @attributes = attributes
+    end
+  end
+end

data/lib/mass_shootings/tracker/page.rb

@@ -0,0 +1,86 @@
+require 'mass_shootings/shooting'
+require 'nokogiri'
+require 'pp'
+
+module MassShootings
+  module Tracker
+    class Page
+      include Enumerable
+
+      attr_reader :page_id, :wiki
+      delegate :each, to: :shootings
+      delegate :[], to: :indexed
+
+      def initialize(page_id, data)
+        @page_id = page_id
+        @wiki = Nokogiri::HTML.parse(data).css '.wiki'
+      end
+
+      private
+
+      def format
+        @format ||= /\A\s*Number\s*(?<number>.+?):\s*
+          (?<date>.+?),\s*
+          (?<alleged_shooters>.+),\s*
+          (?<casualties>.*?\d.*?),\s*
+          (?<location>.+)\s*\Z/x
+      end
+
+      def indexed
+        @indexed ||= Hash[shootings.map { |shooting| [shooting.id, shooting] }]
+      end
+
+      def parse(elements)
+        h2, as = elements[0], elements[1..-1]
+
+        format.match h2.content do |match|
+          alleged_shooters = parse_alleged_shooters match['alleged_shooters']
+          attributes = {
+            id:         "#{page_id}-#{match['number']}",
+            casualties: parse_casualties(match['casualties']),
+            date:       parse_date(match['date']),
+            location:   match['location'],
+            references: as.map { |a| URI(a[:href]) }
+          }
+
+          if alleged_shooters.any?
+            attributes[:alleged_shooters] = alleged_shooters
+          end
+
+          Shooting.new attributes
+        end
+      end
+
+      def parse_alleged_shooters(alleged_shooters)
+        alleged_shooters.
+          split(/\s*(?:,?\s+(?:and|&)\s+|[,;](?!\s*Jr\.))\s*/).
+          reject do |shooter|
+            shooter =~ /identified|identity|unnamed|unkn?own|unreported/i
+          end
+      end
+
+      def parse_casualties(casualties)
+        Hash[
+          casualties.
+            scan(/(\d+)\s+(.+?)\b/).
+            map { |count, type| [type.to_sym, count.to_i] }
+        ]
+      end
+
+      def parse_date(date)
+        result = Date.strptime date, '%m/%d/%Y'
+        result.year < 100 ? Date.strptime(date, '%m/%d/%y') : result
+      rescue
+
+      end
+
+      def shootings
+        @shootings ||= wiki.
+          xpath('child::h2 | child::h2/following-sibling::p/a').
+          slice_before { |element| element.node_name == 'h2' }.
+          map(&method(:parse)).
+          tap { |s| PP.pp s }
+      end
+    end
+  end
+end

data/lib/mass_shootings/tracker.rb

@@ -0,0 +1,69 @@
+require 'active_support/core_ext/range/overlaps'
+
+module MassShootings
+  #
+  # Retrieves mass shootings from the [r/GunsAreCool shooting tracker]
+  # (https://www.reddit.com/r/GunsAreCool/wiki/2015massshootings).
+  #
+  module Tracker
+    autoload :Page, 'mass_shootings/tracker/page'
+    private_constant :Page
+
+    class << self
+      #
+      # Retrieves a `Shooting` by unique ID.
+      # @param [String] id the `Shooting`'s unique identifier. This is opaque;
+      #        you should not depend on its format.
+      #
+      def get(id)
+        year, number = id.split '-', 2
+        page(year)[id]
+      end
+
+      #
+      # Retrieves all `Shooting`s that occurred within a date range.
+      # @param [Range<Date>] date_range the date range to search. Inclusive and
+      #        exclusive ranges are both supported.
+      #
+      def in_date_range(date_range)
+        pages_in_date_range(date_range).
+          map(&method(:page)).
+          flat_map(&:to_a).
+          select { |shooting| date_range.cover? shooting.date }
+      end
+
+      #
+      # Invalidates the in-memory cache. In a long-running process, you should
+      # arrange for this method to be called approximately every 24 hours and 36
+      # minutes.
+      #
+      def reset
+        @pages = {}
+      end
+
+      private
+
+      def page(year)
+        pages[year] ||= Page.new year, Net::HTTP.get(uri(year))
+      end
+
+      def pages
+        @pages || reset
+      end
+
+      def pages_in_date_range(date_range)
+        result = []
+        year = date_range.begin.year
+        while date_range.overlaps? Date.new(year, 1, 1)...Date.new(year + 1, 1, 1)
+          result << year.to_s
+          year += 1
+        end
+        result
+      end
+
+      def uri(year)
+        URI "https://www.reddit.com/r/GunsAreCool/wiki/#{year}massshootings"
+      end
+    end
+  end
+end

data/lib/mass_shootings/version.rb

@@ -0,0 +1,6 @@
+module MassShootings
+  #
+  # Current version of `mass_shootings`
+  #
+  VERSION = '0.0.1'
+end

data/lib/mass_shootings.rb

@@ -0,0 +1,8 @@
+#
+# Mass shootings as a service.
+#
+module MassShootings
+  autoload :Shooting, 'mass_shootings/shooting'
+  autoload :Tracker,  'mass_shootings/tracker'
+  autoload :VERSION,  'mass_shootings/version'
+end

data/spec/mass_shootings/tracker_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+require 'mass_shootings/tracker'
+
+describe MassShootings::Tracker do
+  let(:alleged_shooters) { ['Alleged Shooter'] }
+  let(:casualties)       { {dead: dead, injured: injured} }
+  let(:date)             { Date.today }
+  let(:dead)             { 1 }
+  let(:injured)          { 2 }
+  let(:id)               { "#{year}-#{number}" }
+  let(:location_)        { 'City, ST' }
+  let(:number)           { 1 }
+  let(:reference)        { URI('http://example.com/reference') }
+  let(:references)       { [reference] }
+  let(:year)             { date.year }
+
+  let(:description) do
+    [
+      "Number #{number}: #{date.strftime('%-m/%-d/%Y')}",
+      alleged_shooters.join(' and '),
+      casualties.map { |c| c.reverse.join ' ' }.join(' '),
+      location_
+    ].join ', '
+  end
+
+  let(:page) do
+    <<-HTML
+      <!DOCTYPE html>
+      <title></title>
+      <div class='wiki'>
+        <h2>#{description}</h2>
+        <p><a href='#{reference}'>#{reference}</a>
+      </div>
+    HTML
+  end
+
+  let(:uri) do
+    URI "https://www.reddit.com/r/GunsAreCool/wiki/#{year}massshootings"
+  end
+
+  before { Net::HTTP.stubs(:get).with(uri).returns(page) }
+  after  { MassShootings::Tracker.reset }
+
+  describe '.get' do
+    subject { MassShootings::Tracker.get id }
+
+    it 'sets the alleged shooter' do
+      subject.alleged_shooters.must_equal alleged_shooters
+    end
+
+    it 'sets the date' do
+      subject.date.must_equal date
+    end
+
+    it 'sets the dead' do
+      subject.casualties[:dead].must_equal dead
+    end
+
+    it 'sets the id' do
+      subject.id.must_equal id
+    end
+
+    it 'sets the injured' do
+      subject.casualties[:injured].must_equal injured
+    end
+
+    it 'sets the location' do
+      subject.location.must_equal location_
+    end
+
+    it 'sets the references' do
+      subject.references.must_equal references
+    end
+
+    describe 'with an unknown alleged shooter' do
+      let(:alleged_shooters) { ['Unknown'] }
+
+      it 'does not set the alleged shooter' do
+        subject.alleged_shooters.must_be_nil
+      end
+    end
+
+    describe 'with an unidentified alleged shooter' do
+      let(:alleged_shooters) { ['Unidentified'] }
+
+      it 'does not set the alleged shooter' do
+        subject.alleged_shooters.must_be_nil
+      end
+    end
+
+    describe 'with two alleged shooters' do
+      let(:alleged_shooters) { ['Alleged', 'Shooter'] }
+
+      it 'sets the alleged shooters' do
+        subject.alleged_shooters.must_equal alleged_shooters
+      end
+    end
+
+    describe 'with three alleged shooters' do
+      let(:alleged_shooters)           { ['Three', 'Alleged', 'Shooters'] }
+      let(:formatted_alleged_shooters) { 'Three, Alleged, and Shooters' }
+
+      it 'sets the alleged shooters' do
+        subject.alleged_shooters.must_equal alleged_shooters
+      end
+    end
+  end
+
+  describe '.in_date_range' do
+    subject          { MassShootings::Tracker.in_date_range date_range }
+    let(:date_2)     { date.prev_year }
+    let(:date_range) { from...to }
+    let(:from)       { date_2 }
+    let(:id_2)       { "#{year_2}-#{number_2}" }
+    let(:number_2)   { 7 }
+    let(:to)         { date }
+    let(:year_2)     { date_2.year }
+
+    let(:description_2) do
+      "Number #{number_2}: #{date_2.strftime('%-m/%-d/%Y')}, Alleged Shooter 2, 11 dead 12 injured, City 2, S2"
+    end
+
+    let(:page_2) do
+      <<-HTML
+        <!DOCTYPE html>
+        <title></title>
+        <div class='wiki'>
+          <h2>#{description_2}</h2>
+        </div>
+      HTML
+    end
+
+    let(:uri_2) do
+      URI "https://www.reddit.com/r/GunsAreCool/wiki/#{year_2}massshootings"
+    end
+
+    before { Net::HTTP.stubs(:get).with(uri_2).returns(page_2) }
+
+    describe 'exclusive' do
+      it 'excludes shootings on the end date' do
+        subject.map(&:id).must_equal [id_2]
+      end
+    end
+
+    describe 'inclusive' do
+      let(:date_range) { from..to }
+
+      it 'includes shootings on the end date' do
+        subject.map(&:id).must_equal [id_2, id]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'mocha/mini_test'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: mass_shootings
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David P Kleinschmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email: david@kleinschmidt.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/mass_shootings.rb
+- lib/mass_shootings/gemspec.rb
+- lib/mass_shootings/shooting.rb
+- lib/mass_shootings/tracker.rb
+- lib/mass_shootings/tracker/page.rb
+- lib/mass_shootings/version.rb
+- spec/mass_shootings/tracker_spec.rb
+- spec/spec_helper.rb
+homepage: http://bitbucket.org/zobar/mass_shootings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: Mass shootings as a service
+test_files: []