fcc-content-api 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fcc-content-api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+The FCC Content API allows you to programmatically access much of the content accessible on [FCC.gov](http://fcc.gov).
+
+fcc-content-api is a lightweight Ruby wrapper for the Federal Communication Commission's Content API. The query interface resembles ActiveRecord. The response objects are simple Ruby `Hash`es and `Array`s.
+
+The FCC Content API is powered by the [Drupal Content API Module](http://drupal.org/project/contentapi).
+
+## Usage
+
+First, familiarize yourself with the [FCC Content API REST Documentation](http://www.fcc.gov/developer/fcc-content-api).
+
+The `FccContentApi::Content` object is where you'll do most of the querying.
+
+```ruby 
+results = FccContentApi::Content.where(:search_string => "broadband").all
+results.first # => {"count"=>"587", "pages"=>58, "itemsPerPage"=>10, "currentPage"=>0}
+results[1] # => {"nid"=>"38802", "title"=>"PSHSB Seeks Comment on Broadband Waiver Transition Process", "created"=>"2012-04-06", "changed"=>"2012-04-09", "type"=>"edoc", "webUrl"=>"http://www.fcc.gov/document/pshsb-seeks-comment-broadband-waiver-transition-process", "uri"=>"http://www.fcc.gov/api/content/38802"}
+```
+
+Options for `FccContentApi#where` map 1-to-1 to the query options listed in the official [FCC docs](http://www.fcc.gov/developer/fcc-content-api).
+
+For example, if you want proceedings, related edocs and comments:
+
+```ruby
+FccContentApi::Content.where(:edocs => "true").where(:type => "proceeding").where(:comments => "true").all
+
+# or pass a single Hash:
+FccContentApi::Content.where({:edocs => "true", :type => "proceeding" :comments => "true"}).all
+```
+
+## Installation
+
+`gem install fcc-content-api` or:
+
+```ruby
+	# Gemfile
+	gem "fcc-content-api"
+```
+
+## More Info
+
+For more information, please visit the [FCC's Developers page](http://www.fcc.gov/developers) and the [FCC's Github page](http://github.com/fcc).

data/Rakefile

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

data/fcc-content-api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fcc-content-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fcc-content-api"
+  s.version     = FccContentApi::VERSION
+  s.authors     = ["Alan deLevie"]
+  s.email       = ["adelevie@gmail.com"]
+  s.homepage    = "http://github.com/adelevie"
+  s.summary     = %q{A Ruby wrapper for the FCC's Content API}
+  s.description = %q{A Ruby wrapper for the FCC's Content API}
+
+  s.rubyforge_project = "fcc-content-api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock", ">= 1.8.0"
+  s.add_runtime_dependency "weary"
+end

data/lib/fcc-content-api/version.rb

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

data/lib/fcc-content-api.rb

@@ -0,0 +1,72 @@
+require "fcc-content-api/version"
+require "weary"
+require "json"
+
+module FccContentApi
+
+	def self.client
+		@@client ||= FccContentApi::Client.new
+	end
+
+	class Content
+		def self.where(*args)
+			Query.new(self).where(*args)
+		end
+
+		def self.all
+			Query.new(self).all
+		end
+
+		def self.find(id)
+			resp = FccContentApi::Client.new.get(:id => id).perform.body
+			JSON.parse resp
+		end
+	end
+
+	class Query
+
+		def initialize(klass); @klass = klass; end
+
+		def criteria; @criteria ||= {}; end
+
+		def where(args)
+			criteria.merge! args
+			self
+		end
+
+		def all; execute; end
+
+		def request
+			@request ||= FccContentApi::Client.new.all criteria
+		end
+
+		def execute
+			resp = request.perform.body
+			JSON.parse(resp)
+		end
+
+	end
+
+	class Client < Weary::Client
+		domain "http://www.fcc.gov/api"
+
+		get :all, "/content.json?" do |resource|
+			resource.optional :created_before, :created_after, # YYYY-MM-DD
+												:changed_before, :changed_after, # YYYY-MM-DD
+												:search_string,
+												:limit,
+												:page,
+												:fields,		# true
+												:edocs, 		# true
+												:comments, 	# true
+												:major_topics,
+												:type,
+												:term,
+												:topic,
+												:title
+		end
+
+		get :get, "/content/{id}.json"
+
+	end
+end

data/test/test_client.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+
+class TestClient < Test::Unit::TestCase
+	VCR.use_cassette("test_title") do
+		def test_title
+			title = "Open Internet Workshops and Speeches"
+			resp = FccContentApi::Content.where(:title => URI.encode(title)).all
+			assert_equal resp.first.keys.sort!, ["count", "pages", "itemsPerPage", "currentPage"].sort!
+			assert_equal resp[1].keys.sort!, ["nid", "title", "created", "changed", "type", "webUrl", "uri"].sort!
+			assert_equal title, resp[1]["title"]
+		end
+	end
+
+	VCR.use_cassette("test_all") do
+		def test_all
+			resp = FccContentApi::Content.all
+			assert_equal resp.first.keys.sort!, ["count", "pages", "itemsPerPage", "currentPage"].sort!
+			assert_equal resp[1].keys.sort!, ["nid", "title", "created", "changed", "type", "webUrl", "uri"].sort!
+		end
+	end
+
+	VCR.use_cassette("test_find") do
+		def test_find
+			resp = FccContentApi::Content.find 38837
+			assert_equal resp.class, Hash
+			keys = ["nid", "title", "created", "changed", 
+							"type", "webUrl", "taxonomy", "body", 
+							"vid", "field_short_title", "field_short_description", 
+							"field_author", "field_job_title", "field_edoc_internal_id", 
+							"field_released_date", "field_published_date", 
+							"field_adopted_date", "field_comment_date", "field_edoc_id", 
+							"field_featured_image", "topics", "uri"] 
+			assert_equal resp.keys.sort!, keys.sort!
+		end
+	end
+
+	def test_params
+		params = {
+			:attribute1 => "value1", # invalid
+			:search_string => "searchq"  # valid
+		}
+		req = FccContentApi::Content.where(params).request
+		assert_equal req.uri.to_s.split("?")[1], "search_string=searchq"
+	end
+
+	def test_equivalent_queries
+		q1 = FccContentApi::Content.where({:search_string => "broadband", :created_afer => "2012-1-1"}).request
+		q2 = FccContentApi::Content.where(:search_string => "broadband").where(:created_afer => "2012-1-1").request
+		assert_equal q1.uri.to_s, q2.uri.to_s
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'fcc-content-api'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  #c.stub_with :webmock
+end

data/test/test_query.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+class TestQuery < Test::Unit::TestCase
+
+
+	def test_where
+		query = FccContentApi::Query.new(FccContentApi::Content)
+		query.where(:attribute => "value")
+		assert_equal query.criteria[:attribute], "value"
+	end
+
+	def test_stacked_wheres
+		query = FccContentApi::Query.new(FccContentApi::Content)
+		query.where(:attribute => "value")
+		assert_equal query.criteria[:attribute], "value"
+		query.where(:second_attribute => "second_value")
+		assert_equal query.criteria[:second_attribute], "second_value"
+		assert_equal query.criteria[:attribute], "value"
+	end
+
+	def test_request
+		query = FccContentApi::Query.new(FccContentApi::Content)
+		assert_equal query.request.class, Weary::Request
+	end
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: fcc-content-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alan deLevie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70341875787080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70341875787080
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70341875786580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70341875786580
+- !ruby/object:Gem::Dependency
+  name: weary
+  requirement: &70341875786160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70341875786160
+description: A Ruby wrapper for the FCC's Content API
+email:
+- adelevie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- fcc-content-api.gemspec
+- lib/fcc-content-api.rb
+- lib/fcc-content-api/version.rb
+- test/test_client.rb
+- test/test_helper.rb
+- test/test_query.rb
+homepage: http://github.com/adelevie
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: fcc-content-api
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the FCC's Content API
+test_files:
+- test/test_client.rb
+- test/test_helper.rb
+- test/test_query.rb