sora_geocoding 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cccbe927ebc316c0b92d678bb685dfa4be47613aa6f1c2c002b383cae68e21fa
-  data.tar.gz: ab1b13c1e34e5344a802f79ce827621d2ae0d4085b7477fc173181c65adb07d4
+  metadata.gz: 49a29a7ba7a53ef21bd7959e05d0f0b3381891f52970dc41b0e7ef20506034aa
+  data.tar.gz: 5260b9777d6b6a2a280903ecdd24bbea597d2122fbde0d1432e36392d7d633e1
 SHA512:
-  metadata.gz: 3b2f09cac420de0006952689898560f28584314657e56f5e6866f6d8d34f0ae315d35c815217cf0faa0849a959418cd9ef96b4043e7c3991c6a3c9fc6bcd2e04
-  data.tar.gz: b9a326d9f73e1e6a37351fdff724cca4b0906ad86936b5b3f58038b4b8eee42fb340e449b686a585a02c6d4f4d6e2026890c79ef8ffed305e3256190295b702c
+  metadata.gz: be6193b493832c887e824d2b35470830a0303309cd8e78c0516c9bfdb621bc71512af9bf6ffe32671894308899cab2106f803e4ccdd053bd6686ff574883d190
+  data.tar.gz: 59038b5a336e3705fbd0fcb25cadf30d3a68d131294bfd89a3185fead48ee50ad26544e40c9faa18e53791204384acb3d619217f7b8800523201a06311e0c161

data/.github/workflows/ruby.yml

@@ -0,0 +1,30 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sora_geocoding (0.1.0)
+    sora_geocoding (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/Guardfile

@@ -1,5 +1,6 @@
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/sora_geocoding/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,9 +1,5 @@
 # SoraGeocoding
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sora_geocoding`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -60,15 +56,38 @@ SoraGeocoding.coordinates('東京都', {site: 'yahoo', yahoo_appid: 'xxxxxxxxx'}
 => {:site=>"yahoo", :coordinates=>{:lat=>"35.64657460", :lon=>"139.65324950"}}
 ```
 
+### Geohash
+- Specify the latitude and longitude
+```
+SoraGeocoding.geohash("35.676192", "139.650311")
+=> "xn76cydkbh5h"
+```
+
+### Some Options
+| option       | Description                              | Default        |
+|:------------:|:-----------------------------------------|:---------------|
+| timeout      | timeout (secs)                           | 3              |
+| http_headers | HTTP headers                             | {}             |
+| use_https    | use HTTPS for requests?                  | false          |
+| http_proxy   | HTTP proxy server (user:pass@host:port)  | nil            |
+| https_proxy  | HTTPS proxy server (user:pass@host:port) | nil            |
+| basic_auth   | user and password for basic auth ({:user => "user", :password => "password"}) | {} |
+| site         | Specify 'geocoding' or 'yahoo'           | nil            |
+| yahoo_appid  | API key for Yahoo Geocoder API           | nil            |
+| logger_level | log level, if kernel logger is used      | ::Logger::WARN |
+| always_raise | Always handle errors. ex) :all, SocketError, Timeout::Error | [] |
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+If you want to modify the source code while checking the tests, run the `bundle exec guard` in another console.
 
 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 tags, 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/[USERNAME]/sora_geocoding. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sorainc/sora_geocoding. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -76,7 +95,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SoraGeocoding project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sora_geocoding/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SoraGeocoding project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sorainc/sora_geocoding/blob/master/CODE_OF_CONDUCT.md).
 
 ## Reference
 - https://github.com/alexreisner/geocoder
+- https://github.com/masuidrive/pr_geohash

data/lib/sora_geocoding.rb

@@ -6,6 +6,7 @@ require 'sora_geocoding/base'
 require 'sora_geocoding/query'
 require 'sora_geocoding/url'
 require 'sora_geocoding/request'
+require 'sora_geocoding/geohash'
 require 'sora_geocoding/results/geocoding'
 require 'sora_geocoding/results/yahoo_geocoder'
 
@@ -32,6 +33,14 @@ module SoraGeocoding
     { site: results[:site], coordinates: site_specific_coordinates(results[:site], results[:data]) }
   end
 
+  #
+  # Generate a Geohash from latitude and longitude.
+  #
+  def self.geohash(latitude, longitude)
+    geohash = Geohash.new(latitude, longitude)
+    geohash.encode
+  end
+
   class << self
     private
       def site_specific_coordinates(site, data)

data/lib/sora_geocoding/geohash.rb

@@ -0,0 +1,88 @@
+require 'open-uri'
+require 'sora_geocoding/base'
+
+module SoraGeocoding
+  #
+  # generate Geohash
+  # - https://ja.wikipedia.org/wiki/%E3%82%B8%E3%82%AA%E3%83%8F%E3%83%83%E3%82%B7%E3%83%A5
+  #
+  class Geohash < Base
+    BASE32 = '0123456789bcdefghjkmnpqrstuvwxyz'.freeze
+    REFINED_RANGE = [[-90, 90], [-180, 180]].freeze
+
+    def initialize(lat, lon)
+      @lat = lat
+      @lon = lon
+    end
+
+    def encode
+      calc_geohash(
+        convert_byte(@lat, REFINED_RANGE[0][0], REFINED_RANGE[0][1], range(@lat)),
+        convert_byte(@lon, REFINED_RANGE[1][0], REFINED_RANGE[1][1], range(@lon))
+      )
+    end
+
+    private
+      def range(val)
+        size = calc_size(val)
+        range = calc_range(size)
+        max_range(range)
+      end
+
+      def max_range(range)
+        [range, calc_range(-6)].max
+      end
+
+      def calc_range(size)
+        10**size
+      end
+
+      def calc_size(val)
+        val.to_s.split('.')[-1].size * -1
+      end
+
+      def convert_byte(val, min, max, range)
+        bits = []
+        while (min - max).abs > range
+          mid = calc_mid(min, max)
+          bit = calc_bit(val, mid)
+
+          if bit.zero?
+            max = mid
+          else
+            min = mid
+          end
+
+          bits.push bit
+        end
+        bits.join
+      end
+
+      def calc_mid(min, max)
+        (min + max).to_f / 2
+      end
+
+      def calc_bit(val, mid)
+        val.to_f > mid ? 1 : 0
+      end
+
+      def calc_geohash(lat, lon)
+        bytes = split_bits(lat, lon)
+        bytes[-1] = bytes[-1].ljust(5, '0')
+        bytes.map { |v| BASE32[convert_to_decimal(v), 1] }.join
+      end
+
+      def integrate_bits(odd_bit, even_bit)
+        even_bit.chars.zip(odd_bit.chars).flatten.join
+      end
+
+      def split_bits(odd_bit, even_bit)
+        bytes = integrate_bits(odd_bit, even_bit)
+        bytes.chars.each_slice(5).map(&:join)
+      end
+
+      def convert_to_decimal(val)
+        "0b#{val}".to_i(0)
+      end
+  end
+end

data/lib/sora_geocoding/version.rb

@@ -1,3 +1,3 @@
 module SoraGeocoding
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sora_geocoding
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - hirontan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -83,6 +84,7 @@ files:
 - lib/sora_geocoding/base.rb
 - lib/sora_geocoding/configuration.rb
 - lib/sora_geocoding/exceptions.rb
+- lib/sora_geocoding/geohash.rb
 - lib/sora_geocoding/logger.rb
 - lib/sora_geocoding/query.rb
 - lib/sora_geocoding/request.rb