presdocs 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+*.rbc
+.bundle
+.config
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    presdocs (0.0.1)
+      json
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (1.7.7)
+    minitest (4.6.1)
+    oj (2.0.7)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.1.0)
+  minitest
+  presdocs!
+  rake (= 0.8.7)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derek Willis
+
+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,42 @@
+# Presdocs: A Ruby wrapper for the Compilation of Presidential Documents
+
+The White House releases a lot of stuff, and some of it is included in what's known as the [Compilation of Presidential Documents](http://www.gpo.gov/fdsys/browse/collection.action?collectionCode=CPD). This is a Ruby library for accessing details about those documents, including subjects, dates, locations and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'presdocs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install presdocs
+
+## Usage
+
+    require 'rubygems'
+    require 'presdocs'
+    include Presdocs
+    
+    @latest_docs = Document.latest
+    
+More documentation coming soon. Check the tests, too.
+
+## Test
+
+Presdocs uses minitest; to run the tests:
+  
+    rake test
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test_*.rb"
+end

data/lib/presdocs/category.rb

@@ -0,0 +1,29 @@
+module Presdocs
+  class Category
+    
+    attr_reader :name, :count, :children
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+       instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def self.all
+      url = "http://m.gpo.gov/wscpd/mobilecpd/category.json"
+      results = Oj.load(open(url).read)
+      create_categories(results['navigatorResults']['Category'])
+    end
+    
+    def self.create_categories(results)
+      cats = []
+      results.each do |result|
+        cats << self.new(:name => result['name'],
+                  :count => result['count'],
+                  :children => result['children'])
+      end
+      cats
+    end
+    
+  end
+end

data/lib/presdocs/document.rb

@@ -0,0 +1,72 @@
+module Presdocs
+  class Document
+    
+    attr_reader :location, :title, :source, :president, :date, :package_id, :lat, :lng, :subjects, :category, :notes, :fdsys_url, :html, :city, :state
+   
+    def initialize(params={})
+      params.each_pair do |k,v|
+       instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def add_attributes(params)
+      params.each_pair do |k,v|
+       instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def self.detail(package_id)
+      url = "http://m.gpo.gov/wscpd/mobilecpd/detailwgc/#{package_id}.json"
+      result = Oj.load(open(url).read)
+      create_document(result, nil, full=true)
+    end
+    
+    def self.latest
+      url = "http://m.gpo.gov/wscpd/mobilecpd/home.json"
+      results = Oj.load(open(url).read)
+      create_from_search_results(results['searchResults'], nil)
+    end
+    
+    def self.with_locations
+      url = "http://m.gpo.gov/wscpd/mobilecpd/location.json"
+      results = Oj.load(open(url).read)
+      create_from_search_results(results['searchResults'], results['coordinates'])
+    end
+    
+    def self.create_from_search_results(results, coordinates)
+      docs = []
+      results.each do |result|
+        docs << create_document(result, coordinates)
+      end
+      docs
+    end
+    
+    def self.create_document(result, coordinates, full=false)
+      if full
+        detail = result
+        result = result['searchResult']
+      end
+      city, state = result['location'].split(', ')
+      if coordinates
+        locations = coordinates.map{|l| {"state" => l['state'], "city" => l['city'], "lat" => l["lat"], "lng" => l["lang"]}}.uniq
+        lat = locations.detect{|l| l['city'] == city && l['state'] == state}['lat']
+        lng = locations.detect{|l| l['city'] == city && l['state'] == state}['lng']
+      end
+      doc = self.new(:id => result['packageId'],
+                :city => city,
+                :state => state,
+                :lat => lat,
+                :lng => lng,
+                :title => result['line1'],
+                :source => result['line2'],
+                :president => result['president'],
+                :date => Date.parse(result['eventDate']))
+      
+      if full
+        h = {:category => detail['category'], :notes => detail['notes'], :subjects => detail['subject'].map{|s| s.strip}.reject!(&:empty?), :fdsys_url => detail['fdsysUrl'], :html => detail['fullText']}
+        doc.add_attributes(h)
+      end
+      doc
+    end
+  end
+end

data/lib/presdocs/version.rb

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

data/lib/presdocs.rb

@@ -0,0 +1,6 @@
+require 'open-uri'
+require 'oj'
+
+%w(document.rb category.rb version.rb).each do |f|
+  require File.join(File.dirname(__FILE__), 'presdocs/', f)
+end

data/presdocs.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'presdocs/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "presdocs"
+  gem.version       = Presdocs::VERSION
+  gem.authors       = ["Derek Willis"]
+  gem.email         = ["dwillis@gmail.com"]
+  gem.description   = %q{Thin Ruby wrapper for the Compilation of Presidential Documents}
+  gem.summary       = %q{Official publications of materials released by the White House Press Secretary}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.required_rubygems_version = ">= 1.3.6"
+  gem.rubyforge_project         = "presdocs"
+  gem.add_runtime_dependency "json"
+  
+  gem.add_dependency "oj"
+  
+  gem.add_development_dependency "rake", "0.8.7"
+  gem.add_development_dependency "bundler", ">= 1.1.0"
+  gem.add_development_dependency "minitest"
+  
+end

data/test/test_document.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'presdocs'
+include Presdocs
+require 'minitest/autorun'
+
+class TestDocument < MiniTest::Unit::TestCase
+  
+  def setup
+    @latest = Document.latest
+    @categories = Category.all
+    @locations = Document.with_locations
+    @doc = Document.detail('DCPD-201300104')
+  end
+
+  def test_that_there_are_five_latest_docs
+    assert_equal 5, @latest.size
+  end
+  
+  def test_that_latest_docs_dont_have_coords
+    assert_nil @latest.first.lat
+  end
+  
+  def test_that_categories_have_a_positive_count
+    assert_operator @categories.count, :>=, 0
+  end
+  
+  def test_that_location_docs_have_lat_and_lng
+    assert @locations.last.lat
+    assert @locations.first.lng
+  end
+  
+  def test_that_document_detail_has_an_fdsys_url
+    assert_equal "http://www.gpo.gov/fdsys/pkg/DCPD-201300104/html/DCPD-201300104.htm", @doc.fdsys_url
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: presdocs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Derek Willis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: oj
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: Thin Ruby wrapper for the Compilation of Presidential Documents
+email:
+- dwillis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/presdocs.rb
+- lib/presdocs/category.rb
+- lib/presdocs/document.rb
+- lib/presdocs/version.rb
+- presdocs.gemspec
+- test/test_document.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3717820495547087070
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: presdocs
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Official publications of materials released by the White House Press Secretary
+test_files:
+- test/test_document.rb