geokit_aws_geoplaces 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7b6a91eb14109e3e9e66a57d04861293a9200a8348a7a3627df8f618218f6e3
+  data.tar.gz: 246a5051dd552f2922e922bfe7f01505db762bd47ecf35fdb707d33a5ca32481
+SHA512:
+  metadata.gz: b462e66a8e3f950d918fda6159d7628b1afa32c2b768d69b98d652f851e8a7245618c8a0d5f85e35d7a1bd1939ca1fb93bbf38918bd44045091e6236da5c47b2
+  data.tar.gz: 798ecbe13e512e4c4798664b624bfdb486d88d58b980ad6d467816fedf484050624141beee9e617dd870ec7f93a7dbc0651135dcefec91483677f9905ee503bf

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    geokit_aws_geoplaces (0.0.1)
+      aws-sdk-geoplaces
+      geokit
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.4.0)
+    aws-partitions (1.1126.0)
+    aws-sdk-core (3.226.2)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.992.0)
+      aws-sigv4 (~> 1.9)
+      base64
+      jmespath (~> 1, >= 1.6.1)
+      logger
+    aws-sdk-geoplaces (1.8.0)
+      aws-sdk-core (~> 3, >= 3.225.0)
+      aws-sigv4 (~> 1.5)
+    aws-sigv4 (1.12.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+    base64 (0.3.0)
+    geokit (1.14.0)
+    jmespath (1.6.2)
+    logger (1.7.0)
+    rake (13.3.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  geokit_aws_geoplaces!
+  rake
+
+BUNDLED WITH
+   2.6.2

data/README.md

@@ -0,0 +1,50 @@
+# geokit_aws_geoplaces
+Geokit module to use AWS GeoPlaces service for geocoding
+
+
+Custom [geokit](https://github.com/geokit/geokit) geocoder for [AWS Geoplaces](https://aws.amazon.com/location/) service.
+
+[API Documentation](https://docs.aws.amazon.com/cli/latest/reference/geo-places/)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geokit_aws_geoplaces'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geokit_aws_geoplaces
+
+## Configuration
+
+
+```ruby
+    # This is your AWS credentials. Setting it up is beyond the scope of this
+    # document, but be sure that your IAM profile is allowed to use the GeoPlaces service
+    # See https://aws.amazon.com/location/
+    Geokit::Geocoders::AwsGeospacesGeocoder.region = 'your-aws-region (us-east-1?)'
+    Geokit::Geocoders::AwsGeospacesGeocoder.access_key_id = 'YOUR_ACCESS_KEY_ID'
+    Geokit::Geocoders::AwsGeospacesGeocoder.secret_access_key = 'YOUR_SECRET_ACCESS_KEY'
+```
+
+
+## Usage
+
+```ruby
+    # use :aws_geospaces to specify this geocoder in your list of geocoders.
+    Geokit::Geocoders::AwsGeospacesGeocoder.geocode("Sunnyvale, CA")
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/adamtao/geokit_aws_geospaces/fork )
+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 a new Pull Request

data/geokit_aws_geoplaces.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "geokit_aws_geoplaces"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Adam Anderson"]
+  spec.email         = ["adam@makeascene.com"]
+  spec.summary       = %q{Geokit custom geocoder for AWS GeoPlaces service}
+  spec.description   = %q{Geokit custom geocoder for AWS GeoPlaces service}
+  spec.homepage      = "https://github.com/adamtao/geokit_aws_geoplaces.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "geokit"
+  spec.add_dependency "aws-sdk-geoplaces"
+
+end

data/lib/geokit_aws_geoplaces.rb

@@ -0,0 +1,100 @@
+require 'aws-sdk-geoplaces'
+require 'geokit'
+
+module Geokit
+  module Geocoders
+
+    # and use :aws_geoplaces to specify this geocoder in your list of geocoders.
+    class AwsGeoplacesGeocoder < Geocoder
+
+      # Use via:
+      #   Geokit::Geocoders::AwsGeoplacesGeocoder.region = "<your aws region>"
+      #   Geokit::Geocoders::AwsGeoplacesGeocoder.access_key_id = "<your key>"
+      #   Geokit::Geocoders::AwsGeoplacesGeocoder.secret_access_key = "<your secret>"
+      config :region, :access_key_id, :secret_access_key
+
+      private
+
+      def self.do_geocode(address, options = {})
+        client = Aws::GeoPlaces::Client.new(
+          region: region,
+          credentials: Aws::Credentials.new( access_key_id, secret_access_key )
+        )
+        res = client.geocode(query_text: address)
+        return GeoLoc.new unless res.successful?
+
+        parse_response res
+      end
+
+      def self.parse_response(res)
+        return GeoLoc.new unless res.result_items.size > 0
+        result_item = res.result_items.first
+
+        extract_geoloc result_item
+      end
+
+      def self.extract_geoloc(result_item)
+        loc = new_loc
+        loc.lat = result_item.position[1]
+        loc.lng = result_item.position[0]
+
+        set_address_components(result_item, loc)
+        set_precision(result_item, loc)
+        set_bounds(result_item, loc)
+
+        loc.success  = true
+        loc
+      end
+
+      def self.set_address_components(result_item, loc)
+        address = result_item.address
+
+        loc.country      = address.country.name
+        loc.country_code = address.country.code_2
+        loc.city         = address.locality
+        loc.district     = address.district
+        loc.zip          = address.postal_code
+
+        if address.region.present?
+          loc.state_code = address.region.code
+          loc.state_name = address.region.name
+          loc.state      = address.region.name
+        end
+
+        if address.sub_region.present?
+          loc.county     = address.sub_region.name
+        end
+
+        if result_item.place_type.to_s == "PointAddress"
+          loc.street_address = "#{address.address_number} #{address.street}"
+          loc.street_name    = address.street
+          loc.street_number  = address.address_number
+          loc.full_address   = address.label
+        end
+      end
+
+      PRECISION_MAP = {
+        "PointAddress" => "address",
+        "Street"       => "street",
+        "Locality"     => "city",
+        "PostalCode"   => "zip",
+        "Region"       => "state",
+        "Country"      => "country"
+      }
+
+      def self.set_precision(result_item, loc)
+        loc.precision = PRECISION_MAP[result_item.place_type] || 'unknown'
+      end
+
+      def self.set_bounds(result_item, loc)
+        map_view = result_item.map_view
+
+        loc.suggested_bounds = Bounds.normalize(
+          [ map_view[1], map_view[0] ],
+          [ map_view[3], map_view[2] ]
+        )
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: geokit_aws_geoplaces
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Anderson
+bindir: bin
+cert_chain: []
+date: 2025-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-geoplaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Geokit custom geocoder for AWS GeoPlaces service
+email:
+- adam@makeascene.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- geokit_aws_geoplaces.gemspec
+- lib/geokit_aws_geoplaces.rb
+homepage: https://github.com/adamtao/geokit_aws_geoplaces.git
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Geokit custom geocoder for AWS GeoPlaces service
+test_files: []