mq_reader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 213f8ef4d130b18d54d5dde286ef08ad5984faf7
+  data.tar.gz: 1828e04bf2bbf9d1f3c2ebf914a3b3220977a2c5
+SHA512:
+  metadata.gz: 01b19271c4ee892c80ca975fad87dd6b205e666888beaf631eaa891b2535779251e3044db008f9112bc94decdb4cea38ed11f51890fb5fcf34822dce176bb04f
+  data.tar.gz: 2b327a7967b10d8c2cb04d508048ef2ea3358347253672bddf551840c3f1aea03ae90a3b28871a5c18ee2bea1a1d3cadf6ec20927c2c7a815b776ecc5f9c331d

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/mq_reader/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/mq_reader.rb

@@ -0,0 +1,3 @@
+require "httparty"
+require "mq_reader/mq_reader"
+require "cgi"

data/lib/mq_reader/mq_reader.rb

@@ -0,0 +1,149 @@
+module MQReader
+
+  BASE_URI = 'http://open.mapquestapi.com'
+  GEOCODING_PATH = '/geocoding/v1/address'
+
+  module ClassMethods
+
+    @options = []
+
+    # Geocode a address.
+    # This method takes an address as a string and performs the geocoding against mapquest's api.
+    # The options hash can have any option accepted by the mapquest geocoding api.
+    # The options key can be written ruby-style with underscores, they are transformed to mapquests format.
+    # If in the future a new option is added to the api by mapquest, you can add it in the options hash and it will work.
+    #
+    # @param [String] address to geocode
+    # @param [Hash] options for mapquest geocoding service
+    def geocode_address(address, options = {})
+      path = GEOCODING_PATH
+      params = ({ location: CGI::escape(address) }.merge!(to_mapquest_notation(options) ))
+      MQGeocode.new(send_get_to_mapquest(path, params))
+    end
+
+    private
+
+    # Method that posts to the mapquest geocoding api
+    #
+    # @params [String] path to the geocoding api. /geocoding/v1..
+    # @params [Hash] params to be sent with the request. See http://open.mapquestapi.com/geocoding/ for params details.
+    #
+    # @return [String] with geocoding response body.
+    def send_get_to_mapquest(path, params)
+      self.get(BASE_URI + path, query: { key: MQReader.configuration.api_key}.merge!(params)).body
+    end
+
+    # Turns underscore keys into mapquest's camelized keys
+    # I belive a good ruby api wrapper should let the developer write in a rubyish way.
+    # Mapquest accepts options that are camelcased and start with a lowercase letter.
+    #
+    # @param [Hash] options to turn into mapquest's key format
+    #
+    # @return [Hash] options hash with mapquest's key format
+    def to_mapquest_notation(options)
+      Hash[options.map{ |k, v| [camelize_string(k.to_s), v] }]
+    end
+  end
+
+  module UtilMethods
+    # Same as camelize(:lower) in ActiveSupport
+    #
+    # @param [String] string to be camelized
+    #
+    # @return [String] camelized string
+    #
+    # Example
+    # camelize_string("a_long_string") # => "aLongString"
+    def camelize_string(string)
+      string.split("_").each_with_index {|s, i| s.capitalize! unless i == 0 }.join("")
+    end
+  end
+
+  #Extend the module on inclusion.
+  #Include Httparty and prevent encoding the api_key(Already encoded by mapquest).
+  def self.included(base)
+    base.extend ClassMethods
+    base.extend UtilMethods
+    base.send :include, HTTParty
+    # Avoid encoding the api key
+    base.query_string_normalizer proc { |query|
+      query.map do |key, value|
+          "#{key}=#{value}"
+      end.join('&')
+    }
+  end
+
+  # Configuration Class
+  # Right now it's only used to set the API key from the application that's using the gem.
+  class Configuration
+    attr_accessor :api_key
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  # Class used to be able to call #geocode_address directly.
+  class BaseClass
+    include MQReader
+  end
+
+  def self.geocode_address(*args)
+    BaseClass.geocode_address(*args)
+  end
+
+  # Class to handle the response from the mapquest api
+  #
+  # Provides methods to get every value from the geocoded address.
+  class MQGeocode
+    attr_reader :street, :city, :zip, :county, :state, :country, :lat, :lng, :raw_geocode
+
+    def initialize(json_geocode)
+      @raw_geocode = JSON.parse(json_geocode)
+      raise StandardError, "The request raised an error: #{@raw_geocode['info']['messages']}" if @raw_geocode['info']['statuscode'] != 0
+      return if @raw_geocode['results'].first['locations'].empty?
+      @lng,@lat = lat_lng_values
+      @street = value('street')
+      @city = value('adminArea5')
+      @county = value('adminArea4')
+      @state = value('adminArea3')
+      @country = value('adminArea1')
+      @zip = value('postalCode')
+      @type = value('type')
+      @geocode_quality = value('geocodeQuality')
+      @side_of_street = value('sideOfStreet')
+    end
+
+    def address_found?
+      @raw_geocode['results'].first['locations'].any?
+    end
+
+  private
+
+    # Get the value of a field from the respond
+    def value(field)
+      @raw_geocode['results'].first['locations'].first[field]
+    end
+
+    # Get the latitude and longitude from the response
+    def lat_lng_values
+      latLng = value('latLng')
+      return [latLng['lng'],latLng['lat']]
+    end
+
+    # Use method_missing to define accesors for any response attributes that might not be listed in #initialize
+    # This accesors are rubyish(underscore notation).
+    def method_missing(method_sym, *arguments, &block)
+      result = send(:value, BaseClass.camelize_string(method_sym.to_s))
+      result.empty? ? super : result
+    end
+  end
+end

data/lib/mq_reader/version.rb

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

data/mq_reader.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name          = "mq_reader"
+  s.version       = "0.0.1"
+  s.summary       = "Mapquest api wrapper"
+  s.date          = "2013-02-18"
+  s.description   = "This is a wrapper for mapquest's geocoding api."
+  s.authors       = ["Santiago Piria"]
+  s.email         = ["santiago.piria@gmail.com"]
+  s.homepage      = "http://rubylearning.org/"
+  s.files         = %w[Rakefile mq_reader.gemspec]
+  s.files        += Dir.glob('lib/**/*.rb')
+  s.files        += Dir.glob('spec/**/*')
+  s.require_paths = %w[lib]
+  s.test_files    = Dir.glob('spec/**/*')
+  s.add_dependency 'httparty', '0.13.1'
+  s.license       = 'MIT'
+end

data/spec/fixtures/address_found.json

@@ -0,0 +1 @@
+{"results":[{"locations":[{"latLng":{"lng":-56.15989,"lat":-34.889265},"adminArea4":"","adminArea5Type":"City","adminArea4Type":"County","adminArea5":"Montevideo","street":"Avenida 8 de Octubre 2710","adminArea1":"UY","adminArea3":"Montevideo","type":"s","displayLatLng":{"lng":-56.15989,"lat":-34.889265},"linkId":0,"postalCode":"11600","sideOfStreet":"N","dragPoint":false,"adminArea1Type":"Country","geocodeQuality":"POINT","geocodeQualityCode":"P1XXX","mapUrl":"http://open.mapquestapi.com/staticmap/v4/getmap?key=Fmjtd|luur2g61nl,bl=o5-9az25f&type=map&size=225,160&pois=purple-1,-34.8892649,-56.1598895,0,0|&center=-34.8892649,-56.1598895&zoom=15&rand=1680921967","adminArea3Type":"State"}],"providedLocation":{"location":"2710 Avenida 8 de Octubre, Montevideo, Uruguay"}}],"options":{"ignoreLatLngInput":false,"maxResults":2,"thumbMaps":true},"info":{"copyright":{"text":"© 2014 MapQuest, Inc.","imageUrl":"http://api.mqcdn.com/res/mqlogo.gif","imageAltText":"© 2014 MapQuest, Inc."},"statuscode":0,"messages":[]}}

data/spec/fixtures/address_not_found.json

@@ -0,0 +1 @@
+{"results":[{"locations":[],"providedLocation":{"location":"I INVENTEND THIS"}}],"options":{"ignoreLatLngInput":false,"maxResults":2,"thumbMaps":true},"info":{"copyright":{"text":"© 2014 MapQuest, Inc.","imageUrl":"http://api.mqcdn.com/res/mqlogo.gif","imageAltText":"© 2014 MapQuest, Inc."},"statuscode":0,"messages":[]}}

data/spec/mq_reader/mq_reader_spec.rb

@@ -0,0 +1,126 @@
+require_relative '../spec_helper'
+describe MQReader do
+
+  before(:each) do
+    MQReader.configure do |config|
+      config.api_key = YOUR_API_KEY
+    end
+  end
+
+  describe 'ClassMethods' do
+
+    before do
+      stub_get_geocode_with('address_found.json')
+    end
+
+    describe '#geocode_address' do
+      context 'address found' do
+        it 'should return MQGeocode object with attributes' do
+          geocode_obj = MQReader.geocode_address("2710 Avenida 8 de Octubre, Montevideo, Uruguay", { max_results: 2 })
+          expect(geocode_obj.class).to eq(MQReader::MQGeocode)
+          expect(geocode_obj.lat).to eq(-34.889265)
+          expect(geocode_obj.lng).to eq(-56.15989)
+          expect(geocode_obj.street).to eq('Avenida 8 de Octubre 2710')
+          expect(geocode_obj.geocode_quality).to eq('POINT')
+          expect(geocode_obj.country).to eq('UY')
+          expect(geocode_obj.geocode_quality_code).to eq('P1XXX')
+          expect(geocode_obj.address_found?).to be_true
+        end
+      end
+      context 'address not found' do
+        it 'should return MQGeocode object with no attributes except raw_geocode' do
+          stub_get_geocode_with('address_not_found.json')
+          geocode_obj = MQReader.geocode_address("2710 Avenida 8 de Octubre, Montevideo, Uruguay", { max_results: 2 })
+          expect(geocode_obj.class).to eq(MQReader::MQGeocode)
+          expect(geocode_obj.street).to be_nil
+          expect(geocode_obj.address_found?).to be_false
+        end
+      end
+      it 'should call #geocode_address on BaseClass' do
+        MQReader::BaseClass.should_receive(:geocode_address)
+        MQReader.geocode_address('home', max_results: 2)
+      end
+      it "should call #send_get_to_mapquest with correct params and MQGeocode#new" do
+        MQReader::BaseClass.should_receive(:send_get_to_mapquest).with(MQReader::GEOCODING_PATH, { location: 'home', 'maxResults' => 2 })
+        MQReader::MQGeocode.should_receive(:new)
+        MQReader.geocode_address('home', max_results: 2)
+      end
+    end
+
+    describe '#send_get_to_mapquest' do
+      it 'should call #get on BaseClass, and the call #body on the result of #get' do
+        obj = double('object')
+        MQReader::BaseClass.should_receive(:get).with(MQReader::BASE_URI + 'path', { query: { key: MQReader.configuration.api_key, param: 'something' } }).and_return(obj)
+        obj.should_receive(:body)
+        MQReader::BaseClass.send(:send_get_to_mapquest, 'path', { param: 'something' })
+      end
+    end
+
+    describe '#to_mapquest_notation' do
+      it 'should transform keys' do
+        expect(MQReader::BaseClass.send(:to_mapquest_notation, ({}))).to eq({})
+        expect(MQReader::BaseClass.send(:to_mapquest_notation, ({a_key: 'value', another_key: 'value'}))).to eq({'aKey' => 'value', 'anotherKey' => 'value'})
+        expect(MQReader::BaseClass.send(:to_mapquest_notation, ({'' => 'value'}))).to eq({'' => 'value'})
+        expect(MQReader::BaseClass.send(:to_mapquest_notation, ({a_key: 'value'}))).to eq({'aKey' => 'value'})
+      end
+    end
+
+  end
+
+  describe 'UtilMethods' do
+    describe 'camelize_string' do
+      it 'should camelize string and leave the first character lowercase' do
+        expect(MQReader::BaseClass.camelize_string('')).to eq('')
+        expect(MQReader::BaseClass.camelize_string('a_long_string')).to eq('aLongString')
+      end
+    end
+  end
+
+  describe 'configuration' do
+    it 'should be possible to set api_key and retrieve it' do
+      MQReader.configure do |config|
+        config.api_key = "1234567"
+      end
+      expect(MQReader.configuration.api_key).to eq("1234567")
+    end
+  end
+
+  describe 'MQGeocode class' do
+
+    let(:obj) { MQReader::MQGeocode.new("{\"results\":[{\"locations\":[{\"latLng\":{\"lng\":-56.15989,\"lat\":-34.889265},\"adminArea4\":\"\",\"adminArea5Type\":\"City\",\"adminArea4Type\":\"County\",\"adminArea5\":\"Montevideo\",\"street\":\"Avenida 8 de Octubre 2710\",\"adminArea1\":\"UY\",\"adminArea3\":\"Montevideo\",\"type\":\"s\",\"displayLatLng\":{\"lng\":-56.15989,\"lat\":-34.889265},\"linkId\":0,\"postalCode\":\"11600\",\"sideOfStreet\":\"N\",\"dragPoint\":false,\"adminArea1Type\":\"Country\",\"geocodeQuality\":\"POINT\",\"geocodeQualityCode\":\"P1XXX\",\"mapUrl\":\"http://open.mapquestapi.com/staticmap/v4/getmap?key=Fmjtd|luur2g61nl,bl=o5-9az25f&type=map&size=225,160&pois=purple-1,-34.8892649,-56.1598895,0,0|&center=-34.8892649,-56.1598895&zoom=15&rand=1680921967\",\"adminArea3Type\":\"State\"}],\"providedLocation\":{\"location\":\"2710 Avenida 8 de Octubre, Montevideo, Uruguay\"}}],\"options\":{\"ignoreLatLngInput\":false,\"maxResults\":2,\"thumbMaps\":true},\"info\":{\"copyright\":{\"text\":\"© 2014 MapQuest, Inc.\",\"imageUrl\":\"http://api.mqcdn.com/res/mqlogo.gif\",\"imageAltText\":\"© 2014 MapQuest, Inc.\"},\"statuscode\":0,\"messages\":[]}}") }
+
+    describe 'intialization' do
+      context 'request with errors' do
+        it 'should raise an error' do
+          expect{MQReader::MQGeocode.new("{\"info\":{\"statuscode\":1,\"messages\":[\"The request failed.\"]}}")}.to raise_error(StandardError)
+        end
+      end
+
+      context 'request with no errors' do
+        it 'should have methods to access the geocode values' do
+          expect(obj.street).to eq('Avenida 8 de Octubre 2710')
+          expect(obj.geocode_quality).to eq('POINT')
+          expect(obj.address_found?).to be_true
+        end
+        it 'should have methods to access the variables that are not defined in the class. Via method_missing' do
+          expect(obj.street).to eq('Avenida 8 de Octubre 2710')
+          expect(obj.geocode_quality_code).to eq('P1XXX')
+          expect(obj.side_of_street).to eq('N')
+        end
+      end
+    end
+
+    describe 'address_found?' do
+      context 'address found' do
+        it 'should return true' do
+          expect(obj.address_found?).to be_true
+        end
+      end
+      context 'address not found' do
+        it 'should return false' do
+          expect(MQReader::MQGeocode.new("{\"results\":[{\"locations\":[]}], \"info\":{\"statuscode\":0}}").address_found?).to be_false
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require_relative '../lib/mq_reader'
+
+require 'minitest/autorun'
+require 'webmock/rspec'
+require 'cgi'
+WebMock.disable_net_connect!
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+YOUR_API_KEY = "Fmjtd%7Cluur2g61nl%2Cbl%3Do5-9az25f"
+
+def stub_get_geocode_with(fixture)
+  stub_request(:get, "http://open.mapquestapi.com/geocoding/v1/address?key=#{CGI.unescape(YOUR_API_KEY)}&location=2710%20Avenida%208%20de%20Octubre,%20Montevideo,%20Uruguay&maxResults=2").to_return(:status => 200, :body => fixture(fixture))
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: mq_reader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Santiago Piria
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: This is a wrapper for mapquest's geocoding api.
+email:
+- santiago.piria@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/mq_reader.rb
+- lib/mq_reader/mq_reader.rb
+- lib/mq_reader/version.rb
+- mq_reader.gemspec
+- spec/fixtures/address_found.json
+- spec/fixtures/address_not_found.json
+- spec/mq_reader/mq_reader_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubylearning.org/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Mapquest api wrapper
+test_files:
+- spec/fixtures/address_found.json
+- spec/fixtures/address_not_found.json
+- spec/mq_reader/mq_reader_spec.rb
+- spec/spec_helper.rb