geogle 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 420f8dc09e9f029c43118d8657382817e7c3c4f8
+  data.tar.gz: 307cf748f3fcb120c21f6022dc11613e84b4c140
+SHA512:
+  metadata.gz: 7dbffd7b45e1688419d70177f8b3762050bb499b766fff93838886706f3cb568fd81ccf69c4701114f0ef88cd83c6851bb8223e9fff8002bd0d5e44e00c2f603
+  data.tar.gz: fc46aa55ac9c5126a4001132f81a4d83b369a6bb587a8e6c6e8499a85d20b6059aca31b613db433250f6dd1ca6babe687459ab23f5b463252c7ded7fc8f48464

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--require byebug
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geogle.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 yone_lc
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Geogle
+
+[![wercker status](https://app.wercker.com/status/6122e4f0966ee255949e2eb465aefd10/m "wercker status")](https://app.wercker.com/project/bykey/6122e4f0966ee255949e2eb465aefd10)
+
+Still in development. Ruby wrapper for the Geocoding service provided from the Google Maps API.
+
+
+Documentation
+https://developers.google.com/maps/documentation/geocoding/
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geogle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geogle
+
+## Usage
+
+When creating the Geogle::Client instance you can pass:
+
+* sensor: true or false (false by default)
+* language: ("en" by default).
+
+In case you wanna use Google Maps API for Business, you'll need to pass the following attributes in order to sign the URL.
+* client_id: ID of the client. It starts with "gme-" prefix.
+* crypto_key: Criptographic key.
+
+Here's more information about Google Maps API for Business:
+https://developers.google.com/maps/documentation/business/webservices
+
+### Geocode by address with non-Business account
+
+    $ client = Geogle::Client.new({ sensor: false, language: "es" })
+    $ client.address("Blasco Ibañez, Valencia")
+
+### Geocode by address making use of the components
+
+    $ client = Geogle::Client.new({ sensor: false, language: "es" })
+    $ components = { country: 'ES' }
+    $ client.address("Blasco Ibañez, Valencia", components)
+
+  Available components to be used can be found here:
+  https://developers.google.com/maps/documentation/geocoding/#ComponentFiltering
+
+### Using a business account
+
+    $ client = Geogle::Client.new({ client_id: "gme-client-id", crypto_key: "crypto-key" })
+    $ Geogle::Client.new.latlng(39.5073225, -0.2914778)
+
+  The signature required to do the request will be included in the URL.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+

data/geogle.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geogle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "geogle"
+  spec.version       = Geogle::VERSION
+  spec.authors       = ["yone_lc"]
+  spec.email         = ["yonelacort@gmail.com"]
+  spec.description   = %q{Ruby wrapper for Google MAPS API V3 geocode interface}
+  spec.summary       = %q{Provides a Ruby interface to geocode requests to Google Maps API V3 and parse the response}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'virtus'
+  spec.add_dependency 'ruby-hmac'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/geogle.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+module Geogle
+  require "geogle/version"
+  require "geogle/model"
+  require "geogle/base"
+  require "geogle/geocoder"
+  require "geogle/error"
+  require "geogle/error_handler"
+  require "geogle/parametizer"
+  require "geogle/parser"
+  require "geogle/url"
+  require "geogle/url_builder"
+end

data/lib/geogle/base.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+require "faraday"
+require "json"
+
+module Geogle
+  class Base
+    def initialize(args = {})
+      @args        = args
+      @parametizer = Parametizer.new(args)
+      @conn        = Faraday.new
+    end
+
+    protected
+
+    def request(url, params)
+      response = @conn.get(UrlBuilder.new(url, @args).build(params))
+      body = JSON.parse(response.body)
+      ErrorHandler.check(body['status'])
+      body
+    end
+  end
+end

data/lib/geogle/directions.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Geogle
+  class Directions < Base
+
+  end
+end

data/lib/geogle/error.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+module Geogle
+  class Error < StandardError;end
+
+  class BadRequestError < Error; end
+  class RequestDeniedError < Error; end
+  class OverQueryError < Error; end
+  class InvalidKeyError  < Error; end
+end

data/lib/geogle/error_handler.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module Geogle
+  module ErrorHandler
+    def self.check(status)
+      case status
+      when 'REQUEST_DENIED'
+        raise RequestDeniedError
+      when 'INVALID_REQUEST'
+        raise BadRequestError
+      when 'OVER_QUERY_LIMIT'
+        raise OverQueryError
+      end
+    end
+  end
+end

data/lib/geogle/geocoder.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+module Geogle
+  class Geocoder < Base
+    def address(address, components = {})
+      executor(:address, address, components)
+    end
+
+    def latlng(lat, lng)
+      executor(:latlng, lat, lng)
+    end
+
+    private
+
+    def executor(method, arg1, arg2)
+      body = request(URL::GEOCODE, @parametizer.send(method, arg1, arg2))
+      Parser.places(body["results"])
+    end
+  end
+end

data/lib/geogle/model.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+module Geogle
+  module Model
+    require "geogle/model/address"
+    require "geogle/model/area"
+    require "geogle/model/coordinates"
+    require "geogle/model/geometry"
+    require "geogle/model/place"
+  end
+end

data/lib/geogle/model/address.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+require 'virtus'
+
+module Geogle
+  module Model
+
+    class Address
+      include Virtus.model
+
+      attribute :street_number,     String
+      attribute :street,            String
+      attribute :locality,          String
+      attribute :area_level_1,      String
+      attribute :area_level_1_code, String
+      attribute :area_level_2,      String
+      attribute :area_level_2_code, String
+      attribute :country,           String
+      attribute :country_code,      String
+      attribute :formatted,         String
+    end
+
+  end
+end

data/lib/geogle/model/area.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+require 'virtus'
+require_relative 'coordinates'
+
+module Geogle
+  module Model
+    class Area
+      include Virtus.model
+
+      attribute :northeast, Coordinates
+      attribute :southwest, Coordinates
+    end
+  end
+end

data/lib/geogle/model/coordinates.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'virtus'
+
+module Geogle
+  module Model
+    class Coordinates
+      include Virtus.model
+
+      attribute :lat, Float
+      attribute :lng, Float
+
+      def to_s
+        "#{lat},#{lng}"
+      end
+    end
+  end
+end

data/lib/geogle/model/geometry.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'virtus'
+require_relative 'area'
+require_relative 'coordinates'
+
+module Geogle
+  module Model
+    class Geometry
+      include Virtus.model
+
+      attribute :location,      Coordinates
+      attribute :location_type, String
+      attribute :bounds,        Area
+      attribute :viewport,      Area
+    end
+  end
+end

data/lib/geogle/model/place.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+
+require 'virtus'
+require_relative 'address'
+require_relative 'geometry'
+
+module Geogle
+  module Model
+    class Place
+      include Virtus.model
+
+      TYPES = %w(street_address
+                 route political
+                 country
+                 administrative_area_level_1
+                 administrative_area_level_2
+                 administrative_area_level_3
+                 colloquial_area
+                 locality
+                 sublocality
+                 neighborhood
+                 premise
+                 subpremise
+                 postal_code
+                 natural_feature
+                 airport
+                 park
+                 point_of_interest
+                 post_box
+                 street_number
+                 floor
+                 room)
+
+      attribute :geometry, Geometry
+      attribute :address,  Address
+
+      def geo_location
+        geometry.location
+      end
+
+      def street
+        address.street
+      end
+
+      def locality
+        address.locality
+      end
+
+      def city
+        address.area_level_2
+      end
+
+      def state
+        address.area_level_1
+      end
+
+      def country
+        address.country
+      end
+
+      def country_code
+        address.country_code
+      end
+
+      def method_missing(method, &block)
+        if method.to_s =~ /^is_(.+?)?$/ && TYPES.include?(method)
+          is_type?($1)
+        else
+          super
+        end
+      end
+
+      private
+
+      def is_type?(type)
+        # TODO
+      end
+
+    end
+  end
+end