fcc_reboot 0.1

data/lib/fcc_reboot/client/connection.rb

@@ -0,0 +1,37 @@
+require 'faraday_middleware'
+require 'faraday/response/raise_error'
+
+module FccReboot
+  class Client
+    # @private
+    module Connection
+      private
+
+      def connection(raw=false)
+        options = {
+          #:headers => {'Accept' => "*/#{format}", 'User-Agent' => user_agent},
+          :headers => {'Accept' => 'application/json'},
+          :proxy => proxy,
+          :ssl => {:verify => false},
+          :url => 'http://data.fcc.gov/api/' + endpoint.to_s
+        }
+
+        Faraday::Connection.new(options) do |connection|
+          connection.use Faraday::Request::Multipart
+          unless raw
+            connection.use Faraday::Response::Mashify
+            case format.to_s.downcase
+            when 'json'
+              connection.use Faraday::Response::ParseJson
+            when 'xml'
+              connection.use Faraday::Response::ParseXml
+            end
+          end
+          connection.use Faraday::Response::RaiseError
+          connection.adapter(adapter)
+        end
+      end
+    end
+  end
+end
+

data/lib/fcc_reboot/client/request.rb

@@ -0,0 +1,40 @@
+module FccReboot
+  class Client
+    module Request
+      def get(path, options={}, raw=false)
+        request(:get, path, options, raw)
+      end
+
+      def post(path, options={}, raw=false)
+        request(:post, path, options, raw)
+      end
+
+      def put(path, options={}, raw=false)
+        request(:put, path, options, raw)
+      end
+
+      def delete(path, options={}, raw=false)
+        request(:delete, path, options, raw)
+      end
+
+      private
+
+      def request(method, path, options, raw)
+        response = connection(raw).send(method) do |request|
+          case method
+          when :get, :delete
+            request.url(formatted_path(path), options)
+          when :post, :put
+            request.path = formatted_path(path)
+            request.body = options unless options.empty?
+          end
+        end
+        raw ? response : response.body
+      end
+
+      def formatted_path(path)
+        [path, format].compact.join('.')
+      end
+    end
+  end
+end

data/lib/fcc_reboot/configuration.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+
+module FccReboot
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :endpoint,
+      :user_agent,
+      :proxy,
+      :format].freeze
+
+    VALID_FORMATS = [
+      :json,
+      :xml].freeze
+
+    DEFAULT_ADAPTER      = Faraday.default_adapter
+    DEFAULT_ENDPOINT     = nil
+    DEFAULT_PROXY        = nil
+    DEFAULT_FORMAT       = nil
+    DEFAULT_USER_AGENT   = "FccReboot Ruby Gem #{FccReboot::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset
+      self.adapter      = DEFAULT_ADAPTER
+      self.user_agent   = DEFAULT_USER_AGENT
+      self.endpoint     = DEFAULT_ENDPOINT
+      self.format       = DEFAULT_FORMAT
+      self.proxy        = DEFAULT_FORMAT
+    end
+  end
+end

data/lib/fcc_reboot/version.rb

@@ -0,0 +1,3 @@
+module FccReboot
+  VERSION = "0.1"
+end

data/spec/api.rb

@@ -0,0 +1,294 @@
+require 'helper'
+
+describe FccReboot, ".broadband_test" do
+  before do
+    stub_request(:get, 'http://data.fcc.gov/api/speedtest/find').
+    with(:query => {:format => 'json', :latitude => '38.0', :longitude => '-77.5'}).
+    to_return(:body => fixture('broadband_test.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.broadband_test({:latitude => '38.0', :longitude => '-77.5'})
+    a_request(:get, 'http://data.fcc.gov/api/speedtest/find').
+    with(:query => {:format => 'json', :latitude => '38.0', :longitude => '-77.5'}).
+    should have_been_made
+  end
+
+  it "should return the correct results" do
+    test = FccReboot.broadband_test({:latitude => '38.0', :longitude => '-77.5'})
+    puts test.inspect
+    test.should be_an Hash
+    test["wirelineMaxDownload"].should == 17773.0
+  end
+end
+
+describe FccReboot, ".census_block" do
+  before do
+    stub_request(:get, 'http://data.fcc.gov/api/block/find').
+      with(:query => {:format => 'json', :latitude => '38.0', :longitude => '-77.5'}).
+      to_return(:body => fixture('census-block-conversions-api.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.find_census_block(:latitude => '38.0', :longitude => '-77.5')
+    a_request(:get, 'http://data.fcc.gov/api/block/find').
+      with(:query => {:format => 'json', :latitude => '38.0', :longitude => '-77.5'}).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    services = FccReboot.find_census_block(:latitude => '38.0', :longitude => '-77.5')
+    services.should be_a Hash
+    services["Block"]["FIPS"].should == '510339905003000'
+  end
+end
+
+describe FccReboot, ".frn_getlist" do
+  before do
+    stub_request(:get, 'http://data.fcc.gov/api/frn/getList').
+      with(:query => {:format => 'json', :stateCode => 'IL', :multi => 'Yes'}).
+      to_return(:body => fixture('frn-conversions-getlist.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+    stub_request(:get, 'http://data.fcc.gov/api/frn/getList').
+      with(:query => {:format => 'json', :stateCode => 'IL', :multi => 'No'}).
+      to_return(:body => fixture('frn-conversions-getlist.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.frn_getlist(:stateCode => 'IL', :multi => true)
+    a_request(:get, 'http://data.fcc.gov/api/frn/getList').
+      with(:query => {:format => 'json', :stateCode => 'IL', :multi => 'Yes'}).
+      should have_been_made
+  end
+  
+  it "should request the correct resource" do
+    FccReboot.frn_getlist(:stateCode => 'IL', :multi => false)
+    a_request(:get, 'http://data.fcc.gov/api/frn/getList').
+      with(:query => {:format => 'json', :stateCode => 'IL', :multi => 'No'}).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    services = FccReboot.frn_getlist(:stateCode => 'IL', :multi => false)
+    services.should be_a Hash
+    services["Frns"]["Frn"].first["frn"].should == '0017855545'
+  end
+end
+
+describe FccReboot, ".frn_getinfo" do
+  before do
+    stub_request(:get, 'http://data.fcc.gov/api/frn/getInfo').
+      with(:query => {:format => 'json', :frn => '0017855545'}).
+      to_return(:body => fixture('frn-conversions-getinfo.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.frn_getinfo(:frn => '0017855545')
+    a_request(:get, 'http://data.fcc.gov/api/frn/getInfo').
+      with(:query => {:format => 'json', :frn => '0017855545'}).
+      should have_been_made
+  end
+  
+  it "should return the correct results" do
+    services = FccReboot.frn_getinfo(:frn => '0017855545')
+    services.should be_a Hash
+    services["Info"]["frn"].should == '0017855545'
+  end
+end
+
+describe FccReboot, ".get_spectrum_bands" do
+  before do
+    stub_request(:get, 'http://data.fcc.gov/api/spectrum-view/services/advancedSearch/getSpectrumBands').
+      with(:query => {:format => 'json', :frequencyFrom=>'226', :frequencyTo => '900'}).
+      to_return(:body => fixture('get_spectrum_bands.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_spectrum_bands(:frequencyFrom=>'226', :frequencyTo => '900')
+    a_request(:get, 'http://data.fcc.gov/api/spectrum-view/services/advancedSearch/getSpectrumBands').
+      with(:query => {:format => 'json', :frequencyFrom=>'226', :frequencyTo => '900'}).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    services = FccReboot.get_spectrum_bands(:frequencyFrom=>'226', :frequencyTo => '900')
+    services.should be_a Array
+    services[0]["upperBand"].should == "235"
+  end
+end
+
+describe FccReboot, ".get_spectrum_licenses" do
+  before do
+    stub_request(:get, 'http://data.fcc.gov/api/spectrum-view/services/advancedSearch/getLicenses').
+      with(:query => {:format => 'json', :name=> 'AT', :radioservice=>'Cellular'}).
+      to_return(:body => fixture('get_licenses.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_spectrum_licenses(:name=> 'AT', :radioservice=>'Cellular')
+    a_request(:get, 'http://data.fcc.gov/api/spectrum-view/services/advancedSearch/getLicenses').
+      with(:query => {:format => 'json', :name=> 'AT', :radioservice=>'Cellular'}).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    services = FccReboot.get_spectrum_licenses(:name=> 'AT', :radioservice=>'Cellular')
+    services.should be_a Array
+    services[0]["id"].should == "11538"
+  end
+end
+
+describe FccReboot, ".get_licenses" do
+  before do
+    @query = {:searchValue => 'Verizon%20Wireless', :format =>'json'}
+    stub_request(:get, 'http://data.fcc.gov/api/license-view/basicSearch/getLicenses').
+      with(:query => @query).
+      to_return(:body => fixture('license-view-get-licenses.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_licenses(@query)
+    a_request(:get, 'http://data.fcc.gov/api/license-view/basicSearch/getLicenses').
+      with(:query => @query).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    licenses = FccReboot.get_licenses(@query)
+    licenses.should be_a Array
+    licenses[0]["licenseID"].should == '2300007967'
+  end
+end
+
+describe FccReboot, ".get_common_names" do
+  before do
+    @query = {:commonName => 'Sprint%20Nextel', :limit => '10'}
+    @url = 'http://data.fcc.gov/api/license-view/licenses/getCommonNames'
+    stub_request(:get, @url).
+      with(:query => @query).
+      to_return(:body => fixture('license-view-get-common-names.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_common_names(@query)
+    a_request(:get, @url).
+      with(:query => @query).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    common_names = FccReboot.get_common_names(@query)
+    common_names.should be_a Array
+    common_names[0]["statCount"].should == '11989'
+  end
+end
+
+describe FccReboot, ".get_statuses" do
+  before do
+    @query = {:commonName => 'Sprint%20Nextel', :limit => '10'}
+    @url = 'http://data.fcc.gov/api/license-view/licenses/getStatuses'
+    stub_request(:get, @url).
+      with(:query => @query).
+      to_return(:body => fixture('license-view-get-statuses.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_statuses(@query)
+    a_request(:get, @url).
+      with(:query => @query).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    statuses = FccReboot.get_statuses(@query)
+    statuses.should be_a Array
+    statuses[0]["statCount"].should == '43980'
+  end
+end
+
+describe FccReboot, ".get_issued" do
+  before do
+    @query = {:commonName => 'Sprint%Nextel', :format => 'json'}
+    stub_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getIssued').
+      with(:query => @query).
+      to_return(:body => fixture('get_issued.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_issued(@query)
+    a_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getIssued').
+      with(:query => @query).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    licenses = FccReboot.get_issued(@query)
+    licenses.should be_a Array
+    licenses[0]["statDesc"].should == '2001'
+  end
+end
+
+describe FccReboot, ".get_renewals" do
+  before do
+    @query = {:commonName => 'Sprint%Nextel', :format => 'json'}
+    stub_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getRenewals').
+      with(:query => @query).
+      to_return(:body => fixture('get_renewals.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_renewals(@query)
+    a_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getRenewals').
+      with(:query => @query).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    licenses = FccReboot.get_renewals(@query)
+    licenses.should be_a Array
+    licenses[0]["statDesc"].should == '201104'
+  end
+end
+
+describe FccReboot, ".get_entities" do
+  before do
+    @query = {:commonName => 'Sprint%Nextel', :format => 'json'}
+    stub_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getEntities').
+      with(:query => @query).
+      to_return(:body => fixture('get_entities.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_entities(@query)
+    a_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getEntities').
+      with(:query => @query).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    licenses = FccReboot.get_entities(@query)
+    licenses.should be_a Array
+    licenses[0]["statDesc"].should == 'Individual'
+  end
+end
+
+describe FccReboot, ".get_categories" do
+  before do
+    @query = {:commonName => 'Sprint%Nextel', :limit=>"10", :format => 'json'}
+    stub_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getCategories').
+      with(:query => @query).
+      to_return(:body => fixture('get_entities.json'), :headers => {'Content-Type' => 'text/json; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    FccReboot.get_categories(@query)
+    a_request(:get, 'http://data.fcc.gov/api/license-view/licenses/getCategories').
+      with(:query => @query).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    licenses = FccReboot.get_categories(@query)
+    licenses.should be_a Array
+    licenses[0]["statDesc"].should == 'Individual'
+  end
+end

data/spec/fixtures/broadband_test.json

@@ -0,0 +1 @@
+{"SpeedTestCounty":{"wirelineMaxDownload":17773.0,"wirelineMaxUpload":18680.0,"wirelineAvgDownload":9072.4,"wirelineAvgUpload":4562.2,"wirelessMaxDownload":14490.0,"wirelessMaxUpload":11180.0,"wirelessAvgDownload":9146.5,"wirelessAvgUpload":6498.5,"wirelineTests":66,"wirelessTests":21},"status":"OK","executionTime":"0.156"}

data/spec/fixtures/census-block-conversions-api.json

@@ -0,0 +1,7 @@
+{
+ "executionTime": "0.045",
+ "status": "OK",
+ "Block": {"FIPS":"510339905003000"},
+ "County": {"name":"Caroline","FIPS":"51033"},
+ "State": {"name":"Virginia","code":"VA","FIPS":"51"}
+}

data/spec/fixtures/frn-conversions-getinfo.json

@@ -0,0 +1,13 @@
+{
+ "@executionTime": "0.014",
+ "@status": "OK",
+ "Info": {
+  "frn": "0017855545",
+  "companyName": "Cygnus Telecommunications Corporation",
+  "holdingCompanyName": "Cygnus Telecommunications Corporation",
+  "regulationStatus": "N",
+  "States": {"state": "IL"},
+  "TechnologyDescs": null,
+  "modifyDate": "2010.07.30 15:23:02"
+ }
+}