mapquest 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -1,4 +1,4 @@
-# MapQuest [![Build Status](https://travis-ci.org/ggordan/mapquest.png?branch=master)](https://travis-ci.org/ggordan/mapquest)
+# MapQuest [![Build Status](https://travis-ci.org/ggordan/mapquest.png?branch=master)](https://travis-ci.org/ggordan/mapquest) [![Code Climate](https://codeclimate.com/github/ggordan/mapquest.png)](https://codeclimate.com/github/ggordan/mapquest)
 
 A gem to communicate with the MapQuest web services.
 
@@ -28,7 +28,7 @@ Or install it yourself as:
     mapquest = MapQuest.new API_KEY
 
     # Get geolocation data
-    data = mapquest.geocoding.decode :location => "London, UK"
+    data = mapquest.geocoding.address "London, UK"
 
     # Get lat/long coordinates of all the locations found
     data.locations.each { |location| puts location[:latLng] }

data/Rakefile

@@ -3,7 +3,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['test/**/*_spec.rb']
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
 task :default => :spec

data/lib/mapquest.rb

@@ -8,27 +8,33 @@ require "mapquest/services/geocoding"
 
 class MapQuest
 
-  attr_accessor :api_key, :response
-  class Error < StandardError; end
+  attr_accessor :api_key
 
   def initialize(key)
     @api_key = key
   end
 
+  # Acess the geocoding API
   def geocoding
     Services::Geocoding.new self
   end
 
+  # Access the directions API
   def directions
     Services::Directions.new self
   end
 
+  # Request handler for the web services. Creates a new request based on the API method provided, and returns a new
+  # response object. Removes any empty parameters that were provided. This method is only used internally.
+  # ==Required parameters
+  # * method [Hash] The hash containing the API method, version and type.
+  # * params [Hash] The parameters used for creating the query string
+  # * response [Response] The response object of the API being called
   def request(method, params, response)
     req = Request.new method
     params.merge! :key => api_key
     params.each { |k,v| params.delete(k) if v.nil? }
-    @response = response.new req.send(params)
-    return @response
+    response.new req.query(params), params
   end
 
 end

data/lib/mapquest/request.rb

@@ -8,7 +8,7 @@ class MapQuest
       super API_ROOT % [method[:location], method[:version], method[:call]]
     end
 
-    def send(params)
+    def query(params)
       get :params => params
     end
 

data/lib/mapquest/response.rb

@@ -1,12 +1,30 @@
 class MapQuest
   class Response
 
-    attr_reader :response, :valid
+    attr_reader :response, :valid, :params
 
     class InvalidRequest < StandardError; end
 
-    def initialize(response_string)
+    def initialize(response_string, params = {})
+      @params = params
       @response = JSON.parse(response_string, :symbolize_names => true)
+      valid_request?
+    end
+
+    # Check whether the request made to the API call is valid. Raises an error if the response code is 500
+    def valid_request?
+      # 400 - Error with input
+      # 403 - Key related error
+      # 500 -Unknown error
+      # Check http://www.mapquestapi.com/geocoding/status_codes.html for more details
+      @valid = case status[:code]
+        when 500
+          raise InvalidRequest
+        when 400, 403
+          false
+        else
+          true
+      end
     end
 
     def info
@@ -17,6 +35,10 @@ class MapQuest
       info[:copyright]
     end
 
+    def options
+      response[:options]
+    end
+
     # Returns information about the response.
     # :code is an integer return value. See http://www.mapquestapi.com/geocoding/status_codes.html
     # :messages subfield is an array of error messages which describe the status.

data/lib/mapquest/services/core.rb

@@ -4,8 +4,19 @@ class MapQuest
 
       attr_accessor :mapquest
 
-      def initialize(mq)
-        @mapquest = mq
+      def initialize(mapquest)
+        @mapquest = mapquest
+      end
+
+      def call_api(api, version, call, options)
+        # Remove invalid options
+        options.keys.select { |k| api.class::VALID_OPTIONS.include? k }
+        api_method = {
+            :location => api.class::API_LOCATION,
+            :version => version,
+            :call => call
+        }
+        mapquest.request api_method, options, api.class::Response
       end
 
     end

data/lib/mapquest/services/directions.rb

@@ -1,30 +1,32 @@
 class MapQuest
   module Services
+    # The main class used for communicating with the MapQuest Directions API
     class Directions < Core
 
       API_LOCATION = :directions
+      VALID_OPTIONS = [:to, :from]
 
-      def get(params)
-        if params.has_key? :from && :to
-          api_method = {
-              :location => API_LOCATION,
-              :version => '1',
-              :call => 'route'
-          }
-          response = mapquest.request api_method, params, Response
+      # Allows you to search for direction to a location. It returns a response object of the route
+      #
+      #   Example: .route :to => "London, UK", "Manchester, UK"
+      #
+      # ==Required parameters
+      # * from [String] The location where to end route
+      # * to [String] The location from which to start route
+      def route(from, to, options = {})
+        if from && to
+          options[:to] = to
+          options[:from] = from
+          call_api self, 1, 'route', options
         else
-          raise Error
+          raise ArgumentError, 'The method must receive the to, and from parameters'
         end
       end
 
       class Response < MapQuest::Response
 
-        def valid_request?
-          if response[:route].any?
-            true
-          else
-            false
-          end
+        def initialize(response_string, params = {})
+          super
         end
 
         def route
@@ -38,25 +40,29 @@ class MapQuest
 
         # Returns the calculated distance of the route in <b>miles</b>
         def distance
-          route[:distance].to_i
+          if valid
+            route[:distance].to_i
+          end
         end
 
         def locations
-          route[:locations]
+          if valid
+            route[:locations]
+          end
         end
 
         # Returns a hash of the maneuvers in the route
         def maneuvers
-          route[:legs].first[:maneuvers]
+          if valid
+            route[:legs].first[:maneuvers]
+          end
         end
 
         # Returns only the narratives for the route as a list
         def narrative
-          narrative = []
-          route[:legs].first[:maneuvers].each do |maneuver|
-            narrative.push maneuver[:narrative]
+          if valid
+            route[:legs].first[:maneuvers].map { |maneuver| maneuver[:narrative] }
           end
-          narrative
         end
 
       end

data/lib/mapquest/services/geocoding.rb

@@ -1,79 +1,60 @@
 class MapQuest
   module Services
+    # The main class used for communicating with the MapQuest Geocoding API
     class Geocoding < Core
 
       API_LOCATION = :geocoding
+      VALID_OPTIONS = [:location,:maxResults,:thumbMaps]
 
-      # Returns a response object of the found locations
-      # == Required parameters
-      # * :location [String] The location for which you wish to get data
-      # == Optional parameters
+      class TooManyLocations < StandardError; end
+
+      # Allows you to search for a single location and returns a response object of the found locations
+      #
+      #   Example: .address :location => "London, UK"
+      #
+      # ==Required parameters
+      # * location [String] The location for which you wish to get data
+      # ==Optional parameters
       # * :maxResults [Integer] The number of results to limit the response to. Defaults to -1 (-1 indicates no limit)
       # * :thumbMaps [Boolean] Return a URL to a static map thumbnail image for a location. Defaults to true
-      def decode(params = {})
-        raise Error unless params.has_key? :location
-
-        # Remove keys that are not supported
-        params.keys.each { |k| params.delete(k) unless [:location,:maxResults,:thumbMaps].include? k }
-        api_method = {
-            :location => API_LOCATION,
-            :version => '1',
-            :call => 'address'
-        }
-        mapquest.request api_method, params, Response
+      def address(location, options = {})
+        raise ArgumentError, 'Method must receive a location (string)' unless location
+        options[:location] = location
+        call_api self, 1, 'address', options
       end
 
-      # Returns a response object of the found locations
-      # == Required parameters
-      # * :location [Array] The lat, and lng to search for
-      # == Optional parameters
+      # Allows you to search for a location using lat/lng values and returns a response object of the found locations
+      #
+      #   Example: .reverse :location => ['40.0755','-76.329999']
+      #
+      # ==Required parameters
+      # * location [Array] The lat, and lng to search for
+      # ==Optional parameters
       # * :maxResults [Integer] The number of results to limit the response to. Defaults to -1 (-1 indicates no limit)
       # * :thumbMaps [Boolean] Return a URL to a static map thumbnail image for a location. Defaults to true
-      def reverse(params = {})
-        raise Error unless params.has_key?(:location) && params[:location].kind_of?(Array)
-        params[:location] = params[:location].join(',')
-        api_method = {
-            :location => API_LOCATION,
-            :version => '1',
-            :call => 'reverse'
-        }
-        mapquest.request api_method, params, Response
+      def reverse(location, options = {})
+        raise ArgumentError, 'Method must receive a location (array)' unless location && location.kind_of?(Array)
+        options[:location] = location.join(',')
+        call_api self, 1, 'reverse', options
       end
 
-      class Response < MapQuest::Response
 
-        def initialize(response_string)
-          super response_string
-          valid_request?
-        end
+      class Response < MapQuest::Response
 
-        # Check whether the request made to the API call is valid. Raises an error if the response code is 500
-        def valid_request?
-          # 400 - Error with input
-          # 403 - Key related error
-          # 500 -Unknown error
-          # Check http://www.mapquestapi.com/geocoding/status_codes.html for more details
-          invalid_requests = [400, 403, 500]
-          if invalid_requests.include? status[:code]
-            if status[:code] === 500
-              raise InvalidRequest
-            end
-            @valid = false
-          else
-            @valid = true
-          end
+        def initialize(response_string, params = {})
+          super
         end
 
         def locations
-          if valid then response[:results].first[:locations] else status end
+          if valid
+            response[:results].first[:locations]
+          end
         end
 
         def providedLocation
-          if valid then response[:results].first[:providedLocation] else status end
-        end
-
-        def options
-          if valid then response[:options] else status end
+          if valid
+            response[:results].first[:providedLocation]
+          end
         end
 
       end

data/lib/mapquest/version.rb

@@ -1,3 +1,3 @@
 class MapQuest
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mapquest.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json"
   spec.add_dependency "rest-client"
 
-  spec.add_development_dependency "rspec", "~> 2.8.0"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.8"
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 1.11"
   spec.add_development_dependency "rake"
 end

data/spec/directions_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe MapQuest::Services::Directions do
+
+  let(:mapquest) { MapQuest.new 'xxx' }
+
+  describe '#route' do
+    it 'should be an instance of Directions' do
+      mapquest.directions.should be_an_instance_of MapQuest::Services::Directions
+    end
+  end
+
+  describe '#route' do
+
+    context 'to or from are not provided' do
+      it 'should raise an error if location is not provided' do
+        expect { mapquest.directions.route 'xxx' }.to raise_error ArgumentError
+      end
+    end
+
+    context 'to and from are provided' do
+      subject(:directions) { mapquest.directions.route 'Lancaster,PA', 'York,PA' }
+
+      it 'should receive to and from' do
+        fixture = fixture 'directions/route_only'
+        query = {
+            :key => 'xxx',
+            :from => 'Lancaster,PA',
+            :to => 'York,PA'
+        }
+        stub_request(:get, 'www.mapquestapi.com/directions/v1/route').with(:query => query).to_return(:body => fixture)
+      end
+    end
+
+    context 'when request is valid' do
+
+      describe MapQuest::Services::Directions::Response do
+
+        let(:max_results) { -1 }
+        let(:fixt) { 'directions/route_only' }
+        let(:thumb_maps) { true }
+
+        let(:valid_response) do
+          query = {
+              :key => 'xxx',
+              :from => 'Lancaster,PA',
+              :to => 'York,PA'
+          }
+          MapQuest::Services::Directions::Response.new fixture(fixt), query
+        end
+
+        it { valid_response.status[:code].should == 0 }
+        it { valid_response.status[:messages].should == [] }
+        it { valid_response.valid.should == true }
+        it { valid_response.locations.should be_kind_of(Array) }
+        it { valid_response.maneuvers.should be_kind_of(Array) }
+        it { valid_response.distance.should be_kind_of(Integer) }
+        it { valid_response.time.should be_kind_of(Integer) }
+        it { valid_response.route.should be_kind_of(Hash) }
+
+      end
+    end
+
+    context 'when invalid request' do
+
+      context 'when api key is invalid' do
+        let(:wrong_api_key_response) do
+          MapQuest::Services::Directions::Response.new fixture 'directions/invalid_key'
+        end
+
+        describe MapQuest::Services::Geocoding::Response do
+          it { wrong_api_key_response.status[:code].should == 403 }
+          it { wrong_api_key_response.status[:messages].first.should match /^This is not a valid key/ }
+        end
+      end
+
+      context 'when argument is invalid' do
+
+        let(:invalid_argument) do
+          MapQuest::Services::Geocoding::Response.new fixture 'directions/invalid_value'
+        end
+
+        describe MapQuest::Services::Geocoding::Response do
+          it { invalid_argument.status[:code].should == 400 }
+          it { invalid_argument.status[:messages].first.should match /^Error processing route/ }
+        end
+
+      end
+    end
+
+  end
+end