geoclue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 274f5899e09763cc0f4824b24d12bf4f65b4c92176f117f32aeaa4d3236fe3af
+  data.tar.gz: 835eba7f05e7f8de523cc8fc8b947ecc1ef90306eb9abe2a0e5d42c33d8fd602
+SHA512:
+  metadata.gz: 1586f95753c3af230e65b810137f03470fcbe898aa4b35e10dd3823074ada5a7f7451978f4fa3b3436bb66f83a8b70086dc21f19ef3dd5e2afddc11caea39bf3
+  data.tar.gz: 4125ccfcebc3cfd00586c54032cc97ce15ab77d6b5534a571128ed82795ec5fb39169a8b761704b74eecee159bed5d2ade0656845ee344f0ef6a607f3870aaf5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to the project will be documented here.
+
+## [0.1.0] - 2019-06-08
+
+Initial implementation
+
+### Added
+- Fetch coordinates from GeoClue via DBus
+- Reverse geocode coordinates to an address
+- CLI to access this functionality
+- Tests, mostly related to cache

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in geoclue.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    geoclue (0.1.0)
+      ruby-dbus (~> 0.15.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    ruby-dbus (0.15.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  geoclue!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jacob Evan Shreve
+
+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,53 @@
+# GeoClue Ruby Client
+
+This library allows you to interact with GeoClue via D-Bus. This allows you to get the physical location of your computer just based on your WiFi connection.
+
+For further reference:
+
+* [GeoClue Project Description](https://gitlab.freedesktop.org/geoclue/geoclue/wikis/home)
+* [The GeoClue D-Bus API](https://www.freedesktop.org/software/geoclue/docs/)
+
+This project is currently only developed and tested on Arch Linux, with plans to port to Ubuntu in the near future. It exists on Arch first because the Ubuntu GeoClue provider is so easy to use, I originally used it from [a simple bash script](https://github.com/shreve/dotfiles/blob/master/bin/location).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geoclue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geoclue
+
+Make sure that you have GeoClue installed and running:
+
+    $ sudo systemctl status geoclue
+
+If not, it should be available from your distro's package manager:
+
+    $ pacman -S geoclue
+
+## Usage
+
+Run the executable to get your coordinates
+
+    $ geoclue
+    42.12345,-83.12345
+
+## Development
+
+I recommend having a D-Bus debugger tool like [d-feet](https://wiki.gnome.org/Apps/DFeet) in order to inspect the service API. This tool relies entirely on the `org.freedesktop.GeoClue2` system service.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shreve/geoclue-ruby.
+
+## 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,10 @@
+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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geoclue"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/geoclue

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geoclue"
+
+if (ARGV & %w[-h --help]).any?
+  puts "Usage:"
+  puts "  geoclue [option flags]"
+  puts ""
+  puts "  Running with no options will print comma-separated coordinates."
+  puts ""
+  puts "  -h --help\t\t print this message"
+  puts ""
+  puts "INFORMATION OPTIONS"
+  puts "  -f --full\t\t fetch all location information"
+  puts "  -a --address\t\t fetch address information (requires fetching coordinates)"
+  puts "  -c --coordinates\t fetch your coordinates from GeoClue"
+  puts ""
+  puts "CONFIGURATION OPTIONS"
+  puts "  -t --timeout [int]\t set the timeout for each operation"
+  puts "  -n --no-cache\t\t don't use the cache"
+  puts "  -d --print-config\t print out all configuration"
+  puts "     --format [fmt]\t output format of data in named printf format"
+  puts "                   \t named options include \"tab\" and \"pipe\""
+  puts "                   \t default is \"%<key>s: %<val>s\\n\""
+  exit 0
+end
+
+def has_arg(*names)
+  (ARGV & names).any?
+end
+
+def fetch_arg(*names, default)
+  names.each do |name|
+    index = ARGV.index(name)
+    next unless index
+    return ARGV[index + 1] || default
+  end
+  default
+end
+
+GeoClue.config do |c|
+  c.skip_cache = has_arg('-n', '--no-cache')
+  c.timeout = fetch_arg('-t', '--timeout', 10).to_i
+  c.format = fetch_arg('--format', "%<key>s: %<val>s\n")
+  c.format = case c.format
+             when "tab"
+               "%<key>s\t%<val>s\n"
+             when "pipe"
+               "%<key>s|%<val>s\n"
+             else
+               c.format
+             end
+
+end
+
+if has_arg('-d', '--print-config')
+  puts GeoClue.config.inspect
+  puts ""
+end
+
+print_pair = -> (key, val) {
+  printf GeoClue.config.format, { key: key, val: val }
+}
+
+begin
+  if has_arg('-f', '--full')
+    GeoClue.full_location.each_pair(&print_pair)
+  elsif has_arg('-a', '--address')
+    GeoClue.address.each_pair(&print_pair)
+  elsif has_arg('-c', '--coordinates')
+    GeoClue.coordinates.each_pair(&print_pair)
+  else
+    data = GeoClue.coordinates
+    puts "#{data["latitude"]},#{data["longitude"]}"
+  end
+rescue => e
+  puts e.message
+  exit 1
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/geoclue.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "geoclue/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "geoclue"
+  spec.version       = GeoClue::VERSION
+  spec.authors       = ["Jacob Evan Shreve"]
+  spec.email         = ["github@shreve.io"]
+
+  spec.summary       = %q{Access your computer's geographic coordinates}
+  spec.description   = %q{Use GeoClue to get geographic coordinates for your computer based soely on your WiFi connection}
+  spec.homepage      = "https://github.com/shreve/geoclue-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-dbus", "~> 0.15.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/geoclue.rb

@@ -0,0 +1,31 @@
+require "geoclue/version"
+require "geoclue/cache"
+require "geoclue/config"
+require "geoclue/client"
+require "geoclue/reverse_geocoder"
+
+module GeoClue
+  class << self
+    def coordinates
+      client.coordinates
+    end
+
+    def address
+      client.address
+    end
+
+    def full_location
+      client.full_location
+    end
+
+    def client
+      @client ||= Client.new
+    end
+
+    def config(&block)
+      @config ||= Config.new
+      @config.evaluate(&block)
+      @config
+    end
+  end
+end

data/lib/geoclue/cache.rb

@@ -0,0 +1,67 @@
+require 'json'
+
+module GeoClue
+  class Cache
+    attr_accessor :data
+
+    def initialize
+      @data = {}
+      read if valid?
+    end
+
+    def read
+      @data = JSON.parse(File.read(filepath))
+    end
+
+    def save(data)
+      @data.merge!(data)
+      write!
+    end
+
+    def write!
+      File.write(filepath, JSON.dump(@data))
+    end
+
+    def coordinates
+      @data.slice(*Client::COORD_KEYS)
+    end
+
+    def address
+      @data.slice(*Client::ADDR_KEYS)
+    end
+
+    def has_coordinates?
+      valid? and Client::COORD_KEYS.all? { |key| @data.key?(key) }
+    end
+
+    def has_address?
+      valid? and Client::ADDR_KEYS.all? { |key| @data.key?(key) }
+    end
+
+    def valid?
+      exists? and recent? and full?
+    end
+
+    def exists?
+      File.exist?(filepath)
+    end
+
+    def recent?
+      (Time.now - File.mtime(filepath)) < 600
+    end
+
+    def full?
+      File.stat(filepath).size > 0
+    end
+
+    def filepath
+      File.expand_path(
+        File.join(
+          ENV.fetch('XDG_CACHE_HOME',
+                    File.join(ENV.fetch('HOME', '~/'),'.cache')),
+          'geoclue-cache.json'
+        )
+      )
+    end
+  end
+end

data/lib/geoclue/client.rb

@@ -0,0 +1,82 @@
+require 'dbus'
+
+module GeoClue
+  class Client
+    COORD_KEYS = %w[latitude longitude accuracy].freeze
+    ADDR_KEYS = %w[house_number road city county state country postcode country_code].freeze
+
+    def initialize
+      @data = {}
+    end
+
+    def full_location
+      coordinates.merge(address)
+    end
+
+    def coordinates(skip_cache: GeoClue.config.skip_cache)
+      return cache.coordinates if !skip_cache && cache.has_coordinates?
+
+      client.Start
+      start = Time.now
+      loop do
+        sleep 0.1
+        break if @data.key?("accuracy") and @data["accuracy"] < 500
+        break if Time.now - start > GeoClue.config.timeout
+      end
+
+      result = @data.slice(*COORD_KEYS)
+      raise "Unable to find location" if result.empty?
+
+      cache.save(@data)
+      result
+    end
+
+    def address(skip_cache: GeoClue.config.skip_cache)
+      return cache.address if !skip_cache && cache.has_address?
+
+      addr = ReverseGeocoder.geocode(coordinates).slice(*ADDR_KEYS)
+      cache.save(addr)
+      addr
+    end
+
+    def cache
+      @cache ||= Cache.new
+    end
+
+    def service
+      @service ||= DBus.system_bus["org.freedesktop.GeoClue2"]
+    end
+
+    def manager
+      @manager ||= begin
+                     object = service["/org/freedesktop/GeoClue2/Manager"]
+                     interface = object["org.freedesktop.GeoClue2.Manager"]
+                     object
+                   end
+    end
+
+    def client_id
+      @client_id ||= manager.CreateClient
+    end
+
+    def client
+      @client ||= begin
+                    object = service[client_id]
+                    interface = object["org.freedesktop.GeoClue2.Client"]
+                    interface["DesktopId"] = "geoclue-ruby"
+                    interface["RequestedAccuracyLevel"] = ['u', 8]
+                    interface.on_signal("LocationUpdated") do
+                      handle_location_update(interface["Location"])
+                    end
+                    Thread.new { interface["Location"] }
+                    object
+                  end
+    end
+
+    def handle_location_update(location_id)
+      location = service[location_id]
+      interface = location["org.freedesktop.GeoClue2.Location"]
+      @data = location.GetAll("org.freedesktop.GeoClue2.Location").transform_keys(&:downcase)
+    end
+  end
+end

data/lib/geoclue/config.rb

@@ -0,0 +1,21 @@
+module GeoClue
+  class Config
+    attr_accessor :timeout, :format, :skip_cache
+
+    def initialize
+      self.timeout = 10
+      self.skip_cache = false
+    end
+
+    def evaluate(&block)
+      return unless block_given?
+      instance_eval(&block)
+    end
+
+    def inspect
+      %i[timeout format skip_cache].each.map do |var|
+        "#{var}: #{send(var).inspect}"
+      end.join("\n")
+    end
+  end
+end

data/lib/geoclue/reverse_geocoder.rb

@@ -0,0 +1,14 @@
+require 'net/http'
+
+module GeoClue
+  module ReverseGeocoder
+    class << self
+      def geocode(coords)
+        url =  "https://locationiq.com/v1/reverse_sandbox.php?format=json&lat=#{coords["latitude"]}&lon=#{coords["longitude"]}"
+        uri = URI(url)
+        result = Net::HTTP.get(uri)
+        JSON.parse(result)["address"]
+      end
+    end
+  end
+end

data/lib/geoclue/version.rb

@@ -0,0 +1,3 @@
+module GeoClue
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: geoclue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Evan Shreve
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-dbus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Use GeoClue to get geographic coordinates for your computer based soely
+  on your WiFi connection
+email:
+- github@shreve.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/geoclue
+- bin/setup
+- geoclue.gemspec
+- lib/geoclue.rb
+- lib/geoclue/cache.rb
+- lib/geoclue/client.rb
+- lib/geoclue/config.rb
+- lib/geoclue/reverse_geocoder.rb
+- lib/geoclue/version.rb
+homepage: https://github.com/shreve/geoclue-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shreve/geoclue-ruby
+  source_code_uri: https://github.com/shreve/geoclue-ruby
+  changelog_uri: https://github.com/shreve/geoclue-ruby/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Access your computer's geographic coordinates
+test_files: []