csv_geocoder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24a4af0aa83c6666e2cbdc6182e0797ddfc6766a42ea128022e3340317126dd9
+  data.tar.gz: cf3179775514d96ab8d6a3a8e17db8117114067aadfbc5ba1e4e478936b5bfc4
+SHA512:
+  metadata.gz: 93fb3a781b60b4733f7fffb76f760df17d6dd784566579ef1e3961626e923bd4edd4d4a7af63484aed5e713242742cecafb181281532573525ca211917527fb1
+  data.tar.gz: 1b498fed39eb284e56da9197e017af9c5060cababbd2ea294f9b68edbd9ccca19e5ea383827cbba96ddcf795fa1aaf2004997e94b9933441edf35f25f9e10ae1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-04
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in csv_geocoder.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    csv_geocoder (0.1.0)
+      geocoder (~> 1.8)
+      tty-progressbar (~> 0.18)
+      tty-prompt (~> 0.23)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    geocoder (1.8.0)
+    minitest (5.16.2)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (13.0.6)
+    strings-ansi (0.2.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-progressbar (0.18.2)
+      strings-ansi (~> 0.2)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      unicode-display_width (>= 1.6, < 3.0)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.2.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  csv_geocoder!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Arthur Cheek
+
+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,47 @@
+# CSVGeocoder
+
+**Simple CSV geocoder CLI**
+
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/29695801/182960263-f41b3762-fa00-45eb-a8bf-d461916bbfcb.gif" alt="animated" />
+</p>
+
+## Usage
+
+Simply run
+
+    $ csvgeocode
+
+1. Provide a path to your CSV
+2. Choose your output path
+3. Choose your geocoding method
+4. Choose your output columns
+5. Enjoy your geocoded CSV
+
+## Geocoding methods
+
+#### Lattitude & Longitude [preferred]
+
+Just provide the CLI with your lat & lng columns
+
+#### Address
+
+Just provide the CLI with your address column
+
+## Installation
+
+    $ gem install csv_geocoder
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/madesuper/csv_geocoder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/bin/csvgeocode

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'csv_geocoder'
+puts CSVGeocoder.run

data/geocoded.csv

@@ -0,0 +1,3 @@
+Name,Address line 1,Address line 2,Postal zip code,City,Region,Country,Tags,Services Tags,Products Tags,Phone number,Email,Image Src,Website,Page title,Page description,Meta title,Meta description,Lat,Lng,Mon,Tue,Wed,Thu,Fri,Sat,Sun,Custom Instagram,Custom Twitter
+Apple HQ,1 Infinite Loop,,95014,Cupertino,California,United States,"Tag1, Tag2","iCare, Itunes","iPhone, iPad, iPod",0800 028 2329,hq@apple.com,https://images.unsplash.com/photo-1524046997286-863495b9638e?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=2832&q=80,https://apple.com,,,,,,,09:00 - 17:00,09:00 - 17:00,09:00 - 17:00,09:00 - 17:00,09:00 - 17:00,,,https://instagram.com/apple,https://twitter.com/apple
+Microsoft HQ,One Microsoft Way,,98052,Redmond,Washington,United States,"Tag3, Tag4",Repairs,"Windows, Surface",0344 800 2400,hq@microsoft.com,https://images.unsplash.com/photo-1570063578733-6a33b69d1439?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=2374&q=80,https://microsoft.com,,,,,,,,,,,,,,,

data/lib/csv_geocoder/cli.rb

@@ -0,0 +1,56 @@
+require_relative "sources/csv"
+require_relative "sources/csv_row"
+require_relative "geocode_methods/retriever"
+require_relative "output_path_retriever"
+require_relative "output_columns_retriever"
+require "tty-prompt"
+require "tty-progressbar"
+
+module CSVGeocoder
+  class CLI
+    def initialize
+      @prompt = TTY::Prompt.new(interrupt: :exit)
+    end
+
+    def run
+      @csv = Sources::CSV.new(@prompt).ask
+      puts
+      @prompt.say "Thanks! I now need to know where to output your CSV", color: :bold
+      @output_path = OutputPathRetriever.new(@prompt).ask_for_output_path
+      puts
+      @prompt.say "Great! I now need to know how you would like to geocode your CSV", color: :bold
+      @geocode_method = GeocodeMethods::Retriever.new(@prompt).ask_for_type(@csv)
+      puts
+      @prompt.say "Awesome! I now need to know where you would like me to put the geocoded columns", color: :bold
+      @output_columns = OutputColumnsRetriever.new(@prompt).ask_for_output_columns(@csv.headers)
+      puts
+      if @prompt.yes? "Start geocoding?"
+        puts
+        start_geocoding
+      end 
+    end
+
+    def start_geocoding
+      bars = TTY::ProgressBar::Multi.new("[:bar] :percent :current/:total", style: { top: "", middle: "", bottom: ""})
+      geocode_progress = bars.register(":from -> :to", total: @csv.length)
+
+      CSV.open(@output_path, "wb") do |new_csv|
+        new_csv << @csv.headers
+        @csv.each.with_index do |row, row_num|
+
+          new_row = Sources::CSVRow.new(row, @geocode_method)  
+          new_row.update_columns!(@output_columns)
+          new_csv << new_row.to_ary
+
+          geocode_progress.advance(
+            from: new_row.searching_by.to_s,
+            to: new_row.output_string
+          )
+        end
+      end
+
+      puts
+      @prompt.ok "Completed!"
+    end
+  end
+end

data/lib/csv_geocoder/geocode_methods/address.rb

@@ -0,0 +1,17 @@
+module CSVGeocoder
+  module GeocodeMethods
+    class Address
+      def initialize(csv_headers)
+        @csv_headers = csv_headers
+      end
+
+      def ask_for_required_headers(prompt)
+        @address_header = prompt.select("Please select the address header", @csv_headers, filter: true)
+      end
+
+      def search_string(row)
+        row[@address_header]
+      end
+    end
+  end
+end

data/lib/csv_geocoder/geocode_methods/coordinates.rb

@@ -0,0 +1,18 @@
+module CSVGeocoder
+  module GeocodeMethods
+    class Coordinates
+      def initialize(csv_headers)
+        @csv_headers = csv_headers
+      end
+
+      def ask_for_required_headers(prompt)
+        @lat_header = prompt.select("Please select the latitude header", @csv_headers, filter: true)
+        @lng_header = prompt.select("Please select the longitude header", @csv_headers, filter: true)  
+      end
+
+      def search_string(row)
+        [ row[@lat_header], row[@lng_header] ]
+      end
+    end
+  end
+end

data/lib/csv_geocoder/geocode_methods/retriever.rb

@@ -0,0 +1,24 @@
+require_relative "address"
+require_relative "coordinates"
+
+module CSVGeocoder
+  module GeocodeMethods
+    class Retriever
+      GEOCODE_METHODS = {
+        "Latitude / Longitude": Coordinates,
+        "Address": Address
+      }
+
+      def initialize(prompt)
+        @prompt = prompt
+      end
+
+      def ask_for_type(csv)
+        geocode_type = @prompt.select("How are we geocoding today?", GEOCODE_METHODS.keys)
+        geocoder = GEOCODE_METHODS[geocode_type].new(csv.headers)
+        geocoder.ask_for_required_headers(@prompt)
+        geocoder
+      end
+    end
+  end
+end

data/lib/csv_geocoder/geocode_result.rb

@@ -0,0 +1,31 @@
+module CSVGeocoder
+  class GeocodeResult
+    def initialize(result)
+      @result = result
+    end
+
+    def address
+      [
+        "#{@result.house_number} #{@result.street}".strip,
+        @result.village,
+        @result.town
+      ].select{|res| res }.join(", ")
+    end
+
+    def city
+      @result.city
+    end
+
+    def region
+      @result.state || @result.county || @result.suburb || @result.neighbourhood
+    end
+
+    def country
+      @result.country
+    end
+
+    def postcode
+      @result.postal_code
+    end
+  end
+end

data/lib/csv_geocoder/output_columns_retriever.rb

@@ -0,0 +1,17 @@
+module CSVGeocoder
+  class OutputColumnsRetriever
+    def initialize(prompt)
+      @prompt = prompt
+    end
+
+    def ask_for_output_columns(select_options)
+      @prompt.collect do
+        key(:city_header).select("Please select the city header", select_options, filter: true)
+        key(:region_header).select("Please select the region header", select_options, filter: true)
+        key(:country_header).select("Please select the country header", select_options, filter: true)
+        key(:postcode_header).select("Please select the postcode header", select_options, filter: true)
+        key(:address_header).select("Please select the address header", select_options, filter: true)
+      end
+    end
+  end
+end

data/lib/csv_geocoder/output_path_retriever.rb

@@ -0,0 +1,15 @@
+module CSVGeocoder
+  class OutputPathRetriever
+    def initialize(prompt)
+      @prompt = prompt
+    end
+
+    def ask_for_output_path
+      @prompt.ask("Where do you want to save the new CSV?",
+        required: true,
+        value: "./geocoded.csv",
+        convert: :path
+      )
+    end
+  end
+end

data/lib/csv_geocoder/sources/csv.rb

@@ -0,0 +1,24 @@
+require "csv"
+module CSVGeocoder
+  module Sources
+    class CSV
+      def initialize(prompt)
+        @prompt = prompt
+      end
+
+      def ask
+        csv = nil
+        until csv
+          begin
+            csv_path = @prompt.ask("Hi, whats the path to your CSV?", required: true)
+            csv ||= ::CSV.read(csv_path, headers: true)
+          rescue Errno::ENOENT
+            @prompt.error "Thats not a valid CSV path, please enter it again"
+            @prompt.warn "If you're on mac, right click the file, hold option, then click copy as pathname"
+          end
+        end
+        csv
+      end
+    end
+  end
+end

data/lib/csv_geocoder/sources/csv_row.rb

@@ -0,0 +1,43 @@
+require "geocoder"
+require_relative "../geocode_result"
+module CSVGeocoder
+  module Sources
+    class CSVRow
+      def initialize(row, geocode_method)
+        @row = row
+        @geocode_method = geocode_method
+      end
+
+      def geocoded_result
+        return @geocoded_result if @geocoded_result
+        search_result = Geocoder.search(searching_by).first
+        return nil unless search_result
+        @geocoded_result = GeocodeResult.new(search_result)
+      end
+
+      def update_columns!(output_columns)
+        return false unless geocoded_result
+
+        @row[output_columns[:address_header]] = geocoded_result.address
+        @row[output_columns[:city_header]] = geocoded_result.city
+        @row[output_columns[:region_header]] = geocoded_result.region
+        @row[output_columns[:country_header]] = geocoded_result.country
+        @row[output_columns[:postcode_header]] = geocoded_result.postcode
+        true
+      end
+
+      def to_ary
+        @row.to_ary.map(&:last)
+      end
+
+      def output_string
+        return "COULDN'T GEOCODE" unless geocoded_result
+        "#{geocoded_result.address}"
+      end
+
+      def searching_by
+        @geocode_method.search_string(@row)
+      end
+    end
+  end
+end

data/lib/csv_geocoder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CSVGeocoder
+  VERSION = "0.1.0"
+end

data/lib/csv_geocoder.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "csv_geocoder/version"
+require_relative "csv_geocoder/cli"
+
+module CSVGeocoder
+  def self.run
+    CLI.new.run
+  end
+end

data/sig/csv_geocoder.rbs

@@ -0,0 +1,4 @@
+module CSVGeocoder
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: csv_geocoder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arthur Cheek
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Write a longer description or delete this line.
+email:
+- artyrcheek@gmail.com
+executables:
+- csvgeocode
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/csvgeocode
+- geocoded.csv
+- lib/csv_geocoder.rb
+- lib/csv_geocoder/cli.rb
+- lib/csv_geocoder/geocode_methods/address.rb
+- lib/csv_geocoder/geocode_methods/coordinates.rb
+- lib/csv_geocoder/geocode_methods/retriever.rb
+- lib/csv_geocoder/geocode_result.rb
+- lib/csv_geocoder/output_columns_retriever.rb
+- lib/csv_geocoder/output_path_retriever.rb
+- lib/csv_geocoder/sources/csv.rb
+- lib/csv_geocoder/sources/csv_row.rb
+- lib/csv_geocoder/version.rb
+- sig/csv_geocoder.rbs
+homepage: https://arthurcheek.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://arthurcheek.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.6
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []