fcc_reboot 0.1 → 0.2.1

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.1
+  - 1.9.2
+  - jruby
+  - ree
+  - ruby-head

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--tag key:"Requires API key"
+--markup markdown
+-
+LICENSE.md

data/Gemfile

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

data/{README.mkd → README.md}

@@ -4,46 +4,46 @@ A Ruby wrapper for the FCC Reboot APIs.
 
 Does your project or organization use this gem?
 ------------------------------------------
-Add it to the [apps](http://github.com/cfalabs/fcc_reboot/wiki/apps) wiki!
+Add it to the [apps](https://github.com/cfalabs/fcc_reboot/wiki/apps) wiki!
 
 Installation
 ------------
-    $ [sudo] gem install fcc_reboot
+    gem install fcc_reboot
 
 Usage Examples
 --------------
     require 'fcc_reboot'
-        
+
     # Provide speed test statistics for a US County given the passed Latitude and Longitude
     FccReboot.broadband_test(:latitude => '38.0', :longitude => '-77.5')
-    
-    # Returns a list of the frequency bands 
+
+    # Returns a list of the frequency bands
     FccReboot.get_spectrum_bands(:frequencyFrom=>'226', :frequencyTo => '900')
-    
+
     # Provide high level overview of who owns spectrum across the country within the 225 MHz to 3700 MHz frequency
     FccReboot.get_spectrum_licenses(:name=> 'AT', :radioservice=>'Cellular')
-    
+
     # Provide census block info for the given latitude and longitude
     FccReboot.find_census_block(:latitude => '38.0', :longitude => '-77.5')
-    
+
     # Provide FRN list for the state of Illinois
     FccReboot.frn_getlist(:stateCode => 'IL', :multi => 'No')
-    
+
     # Provide FRN info for Cygnus Telecommunications Corporation (FRN number 0017855545)
     FccReboot.find_census_block(:frn => '0017855545')
-    
+
     # Returns the number of licenses up for renewal in a given month for Sprint Nextel.
     FccReboot.get_issued(:commonName=> 'Sprint Nextel')
-    
+
     # Returns the counts and percent distribution of active licenses by entity type
     FccReboot.get_renewals()
-    
+
     # Provide number of licenses that were issued by the Commission on a yearly basis
     FccReboot.get_licenses(:searchValue => 'Verizon Wireless')
-    
+
     # Returns the license counts and percent distribution by status.
     FccReboot.get_statuses(:commonName => 'Sprint Nextel')
-    
+
 Contributing
 ------------
 In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
@@ -57,15 +57,15 @@ Here are some ways *you* can contribute:
 * by writing specifications
 * by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
 * by refactoring code
-* by resolving [issues](http://github.com/cfalabs/fcc_reboot/issues)
+* by resolving [issues](https://github.com/cfalabs/fcc_reboot/issues)
 * by reviewing patches
 
 Submitting an Issue
 -------------------
-We use the [GitHub issue tracker](http://github.com/cfalabs/fcc_reboot/issues) to track bugs and
+We use the [GitHub issue tracker](https://github.com/cfalabs/fcc_reboot/issues) to track bugs and
 features. Before submitting a bug report or feature request, check to make sure it hasn't already
 been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
-bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+bug report, please include a [Gist](https://gist.github.com/) that includes a stack trace and any
 details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
 operating system. Ideally, a bug report should include a pull request with failing specs.
 
@@ -81,7 +81,35 @@ Submitting a Pull Request
 8. Commit and push your changes.
 9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
 
+Supported Rubies
+----------------
+This library aims to support and is [tested
+against](http://travis-ci.org/codeforamerica/fcc_reboot) the following Ruby
+implementations:
+
+* Ruby 1.8.7
+* Ruby 1.9.1
+* Ruby 1.9.2
+* Ruby Enterprise Edition 1.8.7
+* JRuby 1.6
+
+If something doesn't work on one of these interpreters, it should be considered
+a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+implementation, you will be personally responsible for providing patches in a
+timely fashion. If critical issues for a particular implementation exist at the
+time of a major release, support for that Ruby version may be dropped.
+
 Copyright
 ---------
 Copyright (c) 2010 Code for America Laboratories
-See [LICENSE](https://github.com/cfalabs/fcc_reboot/blob/master/LICENSE.mkd) for details.
+See [LICENSE](https://github.com/cfalabs/fcc_reboot/blob/master/LICENSE.md) for details.
+
+[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/fcc_reboot.png)](http://stats.codeforamerica.org/projects/fcc_reboot)

data/Rakefile

@@ -1,3 +1,5 @@
+#!/usr/bin/env rake
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/fcc_reboot.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fcc_reboot/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_development_dependency 'ZenTest', '~> 4.5'
+  gem.add_development_dependency 'maruku', '~> 0.6'
+  gem.add_development_dependency 'nokogiri', '~> 1.4'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.4'
+  gem.add_development_dependency 'webmock', '~> 1.6'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_runtime_dependency 'faraday', '~> 0.7.4'
+  gem.add_runtime_dependency 'faraday_middleware', '~> 0.7.0'
+  gem.add_runtime_dependency 'hashie', '~> 1.0.0'
+  gem.add_runtime_dependency 'multi_json', '~> 1.0.0'
+  gem.add_runtime_dependency 'multi_xml', '~> 0.2.0'
+  gem.authors = ["Dan Melton", "Javier Muniz"]
+  gem.description = %q{Wrapper for FCC API}
+  gem.email = 'info@codeforamerica.org'
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/codeforamerica/fcc_reboot'
+  gem.name = 'fcc_reboot'
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+  gem.summary = %q{FCC API Wrapper}
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version = FccReboot::VERSION
+end

data/lib/fcc_reboot.rb

@@ -1,47 +1,25 @@
-require ::File.expand_path('../fcc_reboot/version', __FILE__)
-require ::File.expand_path('../fcc_reboot/configuration.rb', __FILE__)
-require ::File.expand_path('../fcc_reboot/client', __FILE__)
+require 'fcc_reboot/configuration'
+require 'fcc_reboot/client'
+require 'fcc_reboot/version'
 
 module FccReboot
   extend Configuration
-
-  # Alias for FccReboot::Client.new
-  #
-  # @return [FccReboot::Client]
-  def self.client(options={})
-    FccReboot::Client.new(options)
-  end
-
-  # Delegate to FccReboot::Client
-  def self.method_missing(method, *args, &block)
-    return super unless client.respond_to?(method)
-    client.send(method, *args, &block)
+  class << self
+    # Alias for FccReboot::Client.new
+    #
+    # @return [FccReboot::Client]
+    def new(options={})
+      FccReboot::Client.new(options)
+    end
+
+    # Delegate to FccReboot::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
   end
-
-  # Custom error class for rescuing from all FccReboot errors
-  class Error < StandardError; end
-
-  # Raised when FccReboot returns a 400 HTTP status code
-  class BadRequest < Error; end
-
-  # Raised when FccReboot returns a 401 HTTP status code
-  class Unauthorized < Error; end
-
-  # Raised when FccReboot returns a 403 HTTP status code
-  class Forbidden < Error; end
-
-  # Raised when FccReboot returns a 404 HTTP status code
-  class NotFound < Error; end
-
-  # Raised when FccReboot returns a 406 HTTP status code
-  class NotAcceptable < Error; end
-
-  # Raised when FccReboot returns a 500 HTTP status code
-  class InternalServerError < Error; end
-
-  # Raised when FccReboot returns a 502 HTTP status code
-  class BadGateway < Error; end
-
-  # Raised when FccReboot returns a 503 HTTP status code
-  class ServiceUnavailable < Error; end
 end

data/lib/fcc_reboot/client/api.rb

@@ -1,31 +1,35 @@
 # -*- coding: utf-8 -*-
-require 'JSON'
 
 module FccReboot
   class Client
     module Api
+      include FccReboot::Client::Connection
       # speed test statistics for a US County given the passed Latitude and Longitude
       #
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options.
+      # @param latitude
+      # @param longitutde
       # @return [Array]
       # @see http://reboot.fcc.gov/developer/consumer-broadband-test-api
       # @example Provide speed test statistics for a US County given the passed Latitude and Longitude
       #   FccReboot.broadband_test(:latitude => '38.0', :longitude => '-77.5')
       def broadband_test(options={})
-        options.merge!({:format => "json"})                
+        options.merge!({:format => "json"})
         response = get('speedtest/find', options)
-        JSON.parse(response)["SpeedTestCounty"]
+        response["Errors"] ? response : response["SpeedTestCounty"]
       end
-      
-      # This API returns the US Census Bureau Census Block number (aka the 15 character FIPS Code) given 
-      # a passed Latitude and Longitude. The API also returns the US State and County name associated with 
+
+      # This API returns the US Census Bureau Census Block number (aka the 15 character FIPS Code) given
+      # a passed Latitude and Longitude. The API also returns the US State and County name associated with
       # the Block.
       #
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options.
+      # @param latitude
+      # @param longitutde
       # @return [Hash]
       # @see http://reboot.fcc.gov/developer/census-block-conversions-api
       # @example Provide census block info for the given latitude and longitude
@@ -33,7 +37,6 @@ module FccReboot
       def find_census_block(options={})
         options.merge!({:format => "json"})
         response = get('block/find', options)
-        JSON.parse(response)
       end
 
       # This API returns returns all the broadband providers in a given state, where those operators
@@ -42,6 +45,8 @@ module FccReboot
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options.
+      # @param stateCode
+      # @param multi
       # @return [Hash]
       # @see http://reboot.fcc.gov/developer/frn-conversions-api
       # @example Provide FRN list for the state of Illinois
@@ -50,14 +55,14 @@ module FccReboot
         options[:multi] = options[:multi] ? "Yes" : "No"
         options.merge!({:format => "json"})
         response = get('frn/getList', options)
-        JSON.parse(response)
       end
-      
+
       # This API returns information about a provider by FRN number.
       #
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options.
+      # @param frn
       # @return [Hash]
       # @see http://reboot.fcc.gov/developer/frn-conversions-api
       # @example Provide FRN info for Cygnus Telecommunications Corporation (FRN number 0017855545)
@@ -65,47 +70,42 @@ module FccReboot
       def frn_getinfo(options={})
         options.merge!({:format => "json"})
         response = get('frn/getInfo', options)
-        JSON.parse(response)
       end
-      
-      # This API accepts a frequency range and returns a list of the frequency bands 
+
+      # This API accepts a frequency range and returns a list of the frequency bands
       # along with a high level description of how the band is allocated and for what uses within the 225 MHz and 3700 MHz frequency range.
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options:
-      # frequencyFrom (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
-      # frequencyTo (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
-      # pageNum (Optional) – Default is 1.
-      # sortColumn (Optional) – Default is lowerBand. Valid values are: lowerBand, upperBand, or desc.
-      # sortOrder (Optional) – Default is asc. Valid values are: asc, desc.
-      # pageSize (Optional) – Default value is 1000.
-      # limit (Optional) – Default value is 100.
-      # format (Optional) – Default value is xml. Valid values are: xml, json, jsonp
-      # jsonCallback (Optional) – Default value is callback.
+      # @param frequencyFrom (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
+      # @param frequencyTo (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
+      # @param pageNum (Optional) – Default is 1.
+      # @param sortColumn (Optional) – Default is lowerBand. Valid values are: lowerBand, upperBand, or desc.
+      # @param sortOrder (Optional) – Default is asc. Valid values are: asc, desc.
+      # @param pageSize (Optional) – Default value is 1000.
+      # @param limit (Optional) – Default value is 100.
       # @return [Array]
       # @see http://reboot.fcc.gov/developer/spectrum-dashboard-api
-      # @example Returns a list of the frequency bands 
+      # @example Returns a list of the frequency bands
       #   FccReboot.get_spectrum_bands(:frequencyFrom=>'226', :frequencyTo => '900')
       def get_spectrum_bands(options={})
-        options.merge!({:format => "json"})          
-        response = get('spectrum-view/services/advancedSearch/getSpectrumBands', options)      
-        JSON.parse(response)["SpectrumBands"]["SpectrumBand"]        
+        options.merge!({:format => "json"})
+        response = get('spectrum-view/services/advancedSearch/getSpectrumBands', options)
+        response["Errors"] ? response : response["SpectrumBands"]["SpectrumBand"]
       end
-      
-      # This API returns a high level overview of who owns spectrum across the country 
-      # within the 225 MHz to 3700 MHz frequency range in radio services deemed appropriate for 
-      # mobile broadband use. 
+
+      # This API returns a high level overview of who owns spectrum across the country
+      # within the 225 MHz to 3700 MHz frequency range in radio services deemed appropriate for
+      # mobile broadband use.
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options:
-      # frequencyFrom (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
-      # frequencyTo (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
-      # pageNum (Optional) – Default is 1.
-      # sortColumn (Optional) – Default is lowerBand. Valid values are: lowerBand, upperBand, or desc.
-      # sortOrder (Optional) – Default is asc. Valid values are: asc, desc.
-      # pageSize (Optional) – Default value is 1000.
-      # limit (Optional) – Default value is 100.
-      # format (Optional) – Default value is xml. Valid values are: xml, json, jsonp
+      # @param frequencyFrom (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
+      # @param frequencyTo (Optional) – If a frequency range is not provided then the API will return all spectrum bands falling within the 225 to 3700 MHz range. Both a lower and upper frequency value must be provided when entering search criteria.
+      # @param pageNum (Optional) – Default is 1.
+      # @param sortColumn (Optional) – Default is lowerBand. Valid values are: lowerBand, upperBand, or desc.
+      # @param sortOrder (Optional) – Default is asc. Valid values are: asc, desc.
+      # @param pageSize (Optional) – Default value is 1000.
       # @return [Array]
       # @see http://reboot.fcc.gov/developer/spectrum-dashboard-api
       # @example Provide high level overview of who owns spectrum across the country within the 225 MHz to 3700 MHz frequency
@@ -113,67 +113,67 @@ module FccReboot
       def get_spectrum_licenses(options={})
         options.merge!({:format => "json"})
         response = get('spectrum-view/services/advancedSearch/getLicenses', options)
-        JSON.parse(response)["Licenses"]["License"]        
+        response["Errors"] ? response : response["Licenses"]["License"]
       end
-      
-      # his API returns high level license information including name, FRN, call sign, 
-      # category, service, status, expiration date and license id, based on the search criteria passed. 
+
+      # his API returns high level license information including name, FRN, call sign,
+      # category, service, status, expiration date and license id, based on the search criteria passed.
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options:
-      # searchValue (Required)
-      # pageNum (Optional) – Default is 1.
-      # sortColumn (Optional) – Default is licName. Valid values are: licName, frn, callsign, service, status, expdate
-      # sortOrder (Optional) – Default is asc. Valid values are: asc, desc
-      # pageSize (Optional) – Default is 100.
+      # @param searchValue (Required)
+      # @param pageNum (Optional) – Default is 1.
+      # @param sortColumn (Optional) – Default is licName. Valid values are: licName, frn, callsign, service, status, expdate
+      # @param sortOrder (Optional) – Default is asc. Valid values are: asc, desc
+      # @param pageSize (Optional) – Default is 100.
       # @return [Array]
       # @see http://reboot.fcc.gov/developer/license-view-api
       # @example Provide number of licenses that were issued by the Commission on a yearly basis
       #   FccReboot.get_licenses(:searchValue => 'Verizon Wireless')
       def get_licenses(options={})
-        options.merge!({:format => "json"})        
+        options.merge!({:format => "json"})
         response = get('license-view/basicSearch/getLicenses', options)
-        JSON.parse(response)["Licenses"]["License"]
+        response["Errors"] ? response : response["Licenses"]["License"]
       end
 
       # This API returns a list of currently known licensee names associated with a common name.
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options:
-      # commonName (Optional)
-      # limit (Optional) – Number of request rows
+      # @param commonName (Optional)
+      # @param limit (Optional) – Number of request rows
       # @return [Array]
       # @see http://reboot.fcc.gov/developer/license-view-api
       # @example Returns a list of currently known licensee names associated with a common name.
       #   FccReboot.get_common_names(:commonName => 'Sprint Nextel')
       def get_common_names(options={})
-        options.merge!({:format => "json"})        
+        options.merge!({:format => "json"})
         response = get('license-view/licenses/getCommonNames', options)
-        JSON.parse(response)['Stats']['Stat']
+        response["Errors"] ? response : response['Stats']['Stat']
       end
-      
+
       # This API returns the license counts and percent distribution by status.
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options:
-      # commonName (Optional)
-      # limit (Optional) – Number of request rows
+      # @param commonName (Optional)
+      # @param limit (Optional) – Number of request rows
       # @return [Array]
       # @see http://reboot.fcc.gov/developer/license-view-api
       # @example Returns the license counts and percent distribution by status.
       #   FccReboot.get_statuses(:commonName => 'Sprint Nextel')
       def get_statuses(options={})
-        options.merge!({:format => "json"})        
+        options.merge!({:format => "json"})
         response = get('license-view/licenses/getStatuses', options)
-        JSON.parse(response)['Stats']['Stat']
+        response["Errors"] ? response : response['Stats']['Stat']
       end
 
-      # This API returns the number of licenses that were issued by the Commission on a yearly basis. 
-      #The data returned includes the year and the total number of licenses issued.
+      # This API returns the number of licenses that were issued by the Commission on a yearly basis.
+      # The data returned includes the year and the total number of licenses issued.
       # @format :json
       # @key false
       # @param options [Hash] A customizable set of options:
-      # commonName - Name of the coporation
+      # @param commonName - Name of the coporation
       # @return [Array]
       # @see http://reboot.fcc.gov/developer/license-view-api
       # @example Provide number of licenses that were issued by the Commission on a yearly basis
@@ -181,53 +181,53 @@ module FccReboot
       def get_issued(options={})
         options.merge!({:format => "json"})
         response = get('license-view/licenses/getIssued', options)
-        JSON.parse(response)["Stats"]["Stat"]
+        response["Errors"] ? response : response["Stats"]["Stat"]
       end
-      
+
       # This API returns the number of licenses up for renewal in a given month. The API returns 12 months worth of data.
-       # @format :json
-       # @key false
-       # @param options [Hash] A customizable set of options:
-       # commonName - Name of the coporation
-       # @return [Array]
-       # @see http://reboot.fcc.gov/developer/license-view-api
-       # @example Returns the number of licenses up for renewal in a given month. The API returns 12 months worth of data for Sprint Nextel.
-       #   FccReboot.get_renewals(:commonName=> 'Sprint Nextel')
-       def get_renewals(options={})
-         options.merge!({:format => "json"})
-         response = get('license-view/licenses/getRenewals', options)
-         JSON.parse(response)["Stats"]["Stat"]
-       end
-       
-       # This API returns the counts and percent distribution of active licenses by entity type. 
-       # There are four entity categories: Individual, Business, Government and Other.
-        # @format :json
-        # @key false
-        # @param options [Hash] A customizable set of options:
-        # @return [Array]
-        # @see http://reboot.fcc.gov/developer/license-view-api
-        # @example Returns the counts and percent distribution of active licenses by entity type
-        #   FccReboot.get_renewals()
-        def get_entities(options={})
-          options.merge!({:format => "json"})
-          response = get('license-view/licenses/getEntities', options)
-          JSON.parse(response)["Stats"]["Stat"]
-        end
-        
-        # This API returns the counts and percent distribution of active licenses by category. A license falls into only one category.
-         # There are four entity categories: Individual, Business, Government and Other.
-          # @format :json
-          # @key false
-          # @param options [Hash] A customizable set of options:
-          # @return [Array]
-          # @see http://reboot.fcc.gov/developer/license-view-api
-          # @example Returns the counts and percent distribution of active licenses by category
-          #   FccReboot.get_categories()
-          def get_categories(options={})
-            options.merge!({:format => "json"})
-            response = get('license-view/licenses/getCategories', options)
-            JSON.parse(response)["Stats"]["Stat"]
-          end
+      # @format :json
+      # @key false
+      # @param options [Hash] A customizable set of options:
+      # @param commonName - Name of the coporation
+      # @return [Array]
+      # @see http://reboot.fcc.gov/developer/license-view-api
+      # @example Returns the number of licenses up for renewal in a given month. The API returns 12 months worth of data for Sprint Nextel.
+      #   FccReboot.get_renewals(:commonName=> 'Sprint Nextel')
+      def get_renewals(options={})
+        options.merge!({:format => "json"})
+        response = get('license-view/licenses/getRenewals', options)
+        response["Errors"] ? response : response["Stats"]["Stat"]
+      end
+
+      # This API returns the counts and percent distribution of active licenses by entity type.
+      # There are four entity categories: Individual, Business, Government and Other.
+      # @format :json
+      # @key false
+      # @param options [Hash] A customizable set of options:
+      # @return [Array]
+      # @see http://reboot.fcc.gov/developer/license-view-api
+      # @example Returns the counts and percent distribution of active licenses by entity type
+      #   FccReboot.get_renewals()
+      def get_entities(options={})
+        options.merge!({:format => "json"})
+        response = get('license-view/licenses/getEntities', options)
+        response["Errors"] ? response : response["Stats"]["Stat"]
+      end
+
+      # This API returns the counts and percent distribution of active licenses by category. A license falls into only one category.
+      # There are four entity categories: Individual, Business, Government and Other.
+      # @format :json
+      # @key false
+      # @param options [Hash] A customizable set of options:
+      # @return [Array]
+      # @see http://reboot.fcc.gov/developer/license-view-api
+      # @example Returns the counts and percent distribution of active licenses by category
+      #   FccReboot.get_categories()
+      def get_categories(options={})
+        options.merge!({:format => "json"})
+        response = get('license-view/licenses/getCategories', options)
+        response["Errors"] ? response : response["Stats"]["Stat"]
+      end
     end
   end
 end