11 Commits

15 changed files with 315 additions and 66 deletions

23
Makefile Normal file
View File

@@ -0,0 +1,23 @@
.PHONY: all install uninstall build
PREFIX ?= /usr
all: bindings build
bindings:
shards install
./bin/gi-crystal
build:
shards build -Dpreview_mt --release --no-debug
install:
install -D -m 0755 bin/wince $(PREFIX)/bin/wince
install -D -m 0644 data/space.quietfeathers.wince.desktop $(PREFIX)/share/applications/space.quietfeathers.wince.desktop
install -D -m 0644 data/img/space.quietfeathers.wince.svg $(PREFIX)/share/icons/hicolor/scalable/apps/space.quietfeathers.wince.svg
gtk-update-icon-cache /usr/share/icons/hicolor
uninstall:
rm -f $(PREFIX)/bin/wince
rm -f $(PREFIX)/share/applications/space.quietfeathers.wince.desktop
rm -f $(PREFIX)/share/icons/hicolor/scalable/apps/space.quietfeathers.wince.svg
gtk-update-icon-cache /usr/share/icons/hicolor

View File

@@ -1,16 +1,25 @@
# Wince
A GTK 4 frontend for yelp
Adaptive GTK4 app for searching local businesses and restaurants. Powered by [Yelp](https://yelp.com).
## Build
You gotta have blueprint installed
### Depenencies
* geoclue
* libshumate
* blueprint-compiler
* libadwaita
* gtk4
* crystal
If you're on arch you can run
```
pacman -S blueprint-compiler crystal shards libadwaita
pacman -S blueprint-compiler crystal shards libadwaita libshumate georclue
```
Then you gotta get an API key from YELP and put it in the file `api_key` at the root of the project
Then you gotta get an API key from Yelp and put it in a file at `~/.config/wince/api_key`
Then you can run the program with
@@ -18,8 +27,10 @@ Then you can run the program with
crystal run src/gtktest.cr
```
You can build for production with
You can build for production with `make` and install with `make install`
```
shards build -Dpreview_mt --release --no-debug
```
## Credits
Map marker icon from [Paomedia on iconfinder](https://www.iconfinder.com/icons/299087/marker_map_icon)
The [Ultimate GTK4 crystal guide](https://ultimate-gtk4-crystal-guide.geopjr.dev/) without which I would not have been able to figure most of this out.

BIN
data/img/marker-icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB

View File

@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="27.495001mm"
height="27.494635mm"
viewBox="0 0 27.495001 27.494636"
version="1.1"
id="svg5"
xml:space="preserve"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg"><defs
id="defs2"><linearGradient
id="linearGradient1299"><stop
style="stop-color:#ff2323;stop-opacity:1;"
offset="0"
id="stop1295" /><stop
style="stop-color:#ca5aaa;stop-opacity:1;"
offset="1"
id="stop1297" /></linearGradient><linearGradient
xlink:href="#linearGradient1299"
id="linearGradient1301"
x1="10.067801"
y1="22.259319"
x2="24.352367"
y2="22.259319"
gradientUnits="userSpaceOnUse"
gradientTransform="translate(-1.5278011,-6.6120943)" /></defs><g
id="layer1"
transform="translate(-1.9349249,-1.8999069)"><circle
style="fill:#2f2d39;fill-opacity:1;stroke:#272730;stroke-width:1.4;stroke-dasharray:none;stroke-opacity:1"
id="path507"
cx="15.682425"
cy="15.647223"
r="11.547338" /><path
id="path3470"
style="fill:url(#linearGradient1301);fill-opacity:1;stroke-width:0.264583"
d="m 18.39274,9.0775417 a 4.431921,4.431921 0 0 0 -4.43228,4.4317693 4.431921,4.431921 0 0 0 0.31264,1.632976 l -5.4518611,4.655529 c -0.33702,0.287828 -0.37671,0.791079 -0.0889,1.128097 l 0.86248,1.009757 c 0.28782,0.337018 0.7910701,0.376712 1.1280901,0.08888 l 5.463231,-4.665865 c 0.002,-0.0014 0.003,-0.0028 0.005,-0.0041 a 4.431921,4.431921 0 0 0 2.20194,0.586527 4.431921,4.431921 0 0 0 4.43177,-4.431771 4.431921,4.431921 0 0 0 -4.43177,-4.4317693 z m -0.0109,1.6903363 a 2.8280926,2.8280926 0 0 1 2.82826,2.827733 2.8280926,2.8280926 0 0 1 -2.82826,2.828251 2.8280926,2.8280926 0 0 1 -2.82773,-2.828251 2.8280926,2.8280926 0 0 1 2.82773,-2.827733 z" /></g></svg>

After

Width:  |  Height:  |  Size: 2.0 KiB

View File

@@ -0,0 +1,9 @@
[Desktop Entry]
Type=Application
StartupWMClass=wince
Exec=wince %F
Name=wince
Comment=Search businesses and restaurants
Terminal=false
Icon=space.quietfeathers.wince
Categories=Utility;

View File

@@ -43,6 +43,14 @@ Adw.ApplicationWindow mainWindow {
label: "Wince is powered by Yelp";
}
Gtk.Label configNotFoundText {
halign: center;
valign: center;
vexpand: true;
visible: false;
label: "API key not found. You must place your yelp api key in ~/.config/wince/api_key";
}
Adw.Leaflet leaflet {
can-navigate-forward: false;
can-navigate-back: true;
@@ -57,9 +65,9 @@ Adw.ApplicationWindow mainWindow {
Gtk.ScrolledWindow detailsScroll {
vexpand: true;
width-request: 300;
Adw.Clamp {
width-request: 300;
maximum-size: 450;
margin-end: 12;
tightening-threshold: 400;
@@ -78,6 +86,7 @@ Adw.ApplicationWindow mainWindow {
Gtk.Label detailsTitle {
halign: start;
wrap: true;
styles ["title-1"]
}
@@ -130,6 +139,14 @@ Adw.ApplicationWindow mainWindow {
}
}
Shumate.SimpleMap detailsMap {
margin-top: 8;
margin-start: 8;
margin-end: 8;
height-request: 220;
show-zoom-buttons: false;
}
Gtk.Label {
styles ["heading"]
halign: start;

View File

@@ -4,5 +4,6 @@
<file compressed="true" preprocess="xml-stripblanks">ui/compiled/main.ui</file>
<file compressed="true" preprocess="xml-stripblanks">ui/compiled/templates/businessrow.ui</file>
<file compressed="true" preprocess="xml-stripblanks">ui/compiled/templates/hourrow.ui</file>
<file compressed="true">img/marker-icon.png</file>
</gresource>
</gresources>

View File

@@ -1,13 +1,13 @@
# NOTICE: This lockfile contains some overrides from shard.override.yml
version: 2.0
shards:
gi-crystal:
gi-crystal: # Overridden
git: https://github.com/hugopl/gi-crystal.git
version: 0.14.0+git.commit.569f8d4b77effe312c642fc60929000e3e9514e2
version: 0.15.0+git.commit.bcf127b37c309a52f4b17566e9663029c16dcbb2
gtk4: # Overridden
git: https://github.com/hugopl/gtk4.cr.git
version: 0.12.0+git.commit.ef2eb03b38b25ea2780e83cf50af3a6807ac6293
version: 0.12.0+git.commit.a46b9295a7cffcc4ed2af596276c17196b2948fb
libadwaita:
git: https://github.com/geopjr/libadwaita.cr.git

View File

@@ -2,3 +2,6 @@ dependencies:
gtk4:
github: hugopl/gtk4.cr
branch: master
gi-crystal:
github: hugopl/gi-crystal
branch: master

View File

@@ -9,10 +9,9 @@ targets:
main: src/wince.cr
dependencies:
gtk4:
github: hugopl/gtk4.cr
libadwaita:
github: GeopJr/libadwaita.cr
branch: main
crystal: 1.6.2

View File

@@ -1,10 +1,27 @@
module Wince::Location
extend self
client = Geoclue::Simple.new()
@@channel = Channel(Geoclue::Simple).new(1)
@@client : Geoclue::Simple? = nil
@@fiber : Fiber = spawn setup_client
def find_location()
location = client.location
[location.latitude, location.longitude]
def setup_client
@@channel.send Geoclue::Simple.new_sync("space.quietfeathers.Wince", Geoclue::AccuracyLevel::Street, nil)
Fiber.yield
end
# returns latlon if available, otherwise empty array
def find_location
if !@@fiber.dead?
return [] of Float64
end
if @@client.nil?
@@client = @@channel.receive
end
location = @@client.try do |c|
[c.location.latitude, c.location.longitude]
end || [] of Float64
end
end

View File

@@ -1,10 +1,74 @@
require "http/client"
require "io"
require "json"
require "../utils/utils.cr"
module Wince::Yelp
extend self
@@token : String = {{ read_file("./api_key") }}
class SearchResponse
include JSON::Serializable
property businesses : Array(Business)?
property error : Error?
end
class Error
include JSON::Serializable
property code : String
property description : String
end
class Business
include JSON::Serializable
property id : String
property name : String
property rating : Float32
property distance : Float32
end
class DetailsResponse
include JSON::Serializable
property error : Error?
property name : String
property price : String?
property display_phone : String?
property location : Location
property coordinates : Coordinates
property url : String
property hours : Array(Hours)
def is_open
hours[0].is_open_now
end
end
class Coordinates
include JSON::Serializable
property latitude : Float32
property longitude : Float32
end
class Location
include JSON::Serializable
property display_address : Array(String)
end
class Hours
include JSON::Serializable
property open : Array(Open)
property is_open_now : Bool
end
class Open
include JSON::Serializable
property is_overnight : Bool
@[JSON::Field(key: "start")]
property open : String
@[JSON::Field(key: "end")]
property close : String
property day : Int32
end
def search_businesses(search : String, location : String)
@@ -19,8 +83,10 @@ module Wince::Yelp
path: "/v3/businesses/search",
query: params
)
headers = HTTP::Headers{ "Authorization" => "Bearer " + @@token }
headers = HTTP::Headers{ "Authorization" => "Bearer " + Utils.api_key }
response = HTTP::Client.get(uri, headers)
{response.status_code, SearchResponse.from_json(response.body)}
end
def get_business_info(id : String)
@@ -30,8 +96,10 @@ module Wince::Yelp
host: "api.yelp.com",
path: "/v3/businesses/#{id}",
)
headers = HTTP::Headers{ "Authorization" => "Bearer " + @@token }
headers = HTTP::Headers{ "Authorization" => "Bearer " + Utils.api_key }
response = HTTP::Client.get(uri, headers)
{response.status_code, DetailsResponse.from_json(response.body)}
end
end

View File

@@ -3,13 +3,15 @@ require "time" # yeah me too
module Wince::Utils
extend self
def hours_for_day(hours_json : JSON::Any, day : Time::DayOfWeek, seperator : String)
open = hours_json[0]["open"].as_a
@@config_path = Path.home.join("/.config/wince/api_key")
@@api_key = ""
def hours_for_day(hours : Yelp::Hours, day : Time::DayOfWeek, seperator : String)
day_number = day_of_week_to_int(day)
formatted_hours = open.select { |hour| hour["day"].as_i == day_number }.map { |hour|
start_hour = hour["start"].as_s
end_hour = hour["end"].as_s
formatted_hours = hours.open.select { |hour| hour.day == day_number }.map { |hour|
start_hour = hour.open
end_hour = hour.close
"#{start_hour.insert(2, ":")}-#{end_hour.insert(2, ":")}"
}.join(seperator)
@@ -34,11 +36,23 @@ module Wince::Utils
end
end
def format_address(display_address_json : JSON::Any)
display_address_json.as_a.map { |line| line.as_s? || "" }.join("\n")
def format_address(display_address : Array(String))
display_address.join("\n")
end
def load_url_to_image(url : String, image : Gtk::Image)
def api_key_exists?
File.exists? @@config_path
end
end
def read_api_key
@@api_key = File.read(@@config_path).strip
end
def api_key
if @@api_key.blank?
read_api_key
end
@@api_key
end
end

View File

@@ -1,8 +1,8 @@
require "json"
require "time"
require "../templates/businessrow.cr"
require "../templates/hourrow.cr"
require "../api/location.cr"
require "../api/yelp.cr"
require "../utils/utils.cr"
@@ -11,6 +11,7 @@ module Wince
@@business_rows = [] of BusinessRow
@@hour_rows = [] of HourRow
@@business_ids = [] of String
@@marker = nil
def activate(app : Adw::Application)
main_window = APP.window_by_id(@@main_window_id)
@@ -38,24 +39,50 @@ module Wince
handle_business_select
end
unless Utils.api_key_exists?
POWERD_BY_TEXT.visible = false
CONFIG_NOT_FOUND_TEXT.visible = true
end
setup_map
Location.setup_client
window.present
end
def setup_map
DETAILS_MAP.map_source = Shumate::MapSourceRegistry
.new_with_defaults().by_id(Shumate::MAP_SOURCE_OSM_MAPNIK)
pixbuf = GdkPixbuf::Pixbuf.new_from_resource("/wince/img/marker-icon.png")
icon = Gtk::Image.new_from_pixbuf(pixbuf)
@@marker = Shumate::Marker.new
@@marker.try do|m|
m.height_request = 64
m.width_request = 64
m.child = icon
marker_layer = Shumate::MarkerLayer.new(DETAILS_MAP.viewport)
marker_layer.add_marker(m)
DETAILS_MAP.add_overlay_layer(marker_layer)
end
end
def handle_geolocate
puts "no, not yet"
latlon = Location.find_location()
if !latlon.empty?
LOCATION_ENTRY.text = "#{latlon[0]}, #{latlon[1]}"
end
end
def yelp_response_to_business_ids(response : JSON::Any)
response["businesses"].as_a.map { |b| b["id"].as_s }
def yelp_response_to_business_ids(businesses : Array(Yelp::Business))
businesses.map { |b| b.id }
end
def yelp_response_to_business_rows(response : JSON::Any)
response["businesses"].as_a.map do |business|
name = business["name"].as_s? || ""
rating = business["rating"].as_f32
distance = business["distance"].as_f32
BusinessRow.new(name, rating, distance)
def yelp_response_to_business_rows(businesses : Array(Yelp::Business))
businesses.map do |business|
BusinessRow.new(business.name, business.rating, business.distance)
end
end
@@ -68,6 +95,10 @@ module Wince
end
def handle_search
unless Utils.api_key_exists?
return
end
search = SEARCH_ENTRY.buffer.text
location = LOCATION_ENTRY.buffer.text
@@ -80,19 +111,23 @@ module Wince
LEAFLET.visible = true
POWERD_BY_TEXT.visible = false
response = Yelp.search_businesses(search, location)
status_code, response = Yelp.search_businesses(search, location)
if response.status_code != 200
if status_code != 200
puts "api call error"
puts response.body
if response.error.is_a? Yelp::Error
puts response.error.as(Yelp::Error).description
end
return #TODO: show a toast here
end
response_json = JSON.parse(response.body)
# this can technically fail if we get a weird case of a 200 response
# but a malformed response, but it's probably fine
businesses = response.businesses.as(Array(Yelp::Business))
clear_business_rows()
@@business_ids = yelp_response_to_business_ids(response_json)
@@business_rows = yelp_response_to_business_rows(response_json)
@@business_ids = yelp_response_to_business_ids(businesses)
@@business_rows = yelp_response_to_business_rows(businesses)
@@business_rows.each do |row|
BUSINESS_LIST.append(row)
end
@@ -102,36 +137,37 @@ module Wince
index = @@business_rows.index(BUSINESS_LIST.selected_row) || 0
id = @@business_ids[index]
response = Yelp.get_business_info(id)
status_code, response = Yelp.get_business_info(id)
if response.status_code != 200
if status_code != 200
puts "api call error"
puts response.body
if response.error.is_a? Yelp::Error
puts response.error.as(Yelp::Error).description
end
return #TODO: show a toast here
end
response_json = JSON.parse(response.body)
DETAILS_TITLE.text = response_json["name"].as_s? || ""
DETAILS_TITLE.text = response.name || ""
is_open = response_json["hours"][0]["is_open_now"].as_bool? || false
if is_open
if response.is_open
DETAILS_IS_OPEN.markup = "<span foreground=\"green\">open</span>"
else
DETAILS_IS_OPEN.markup = "<span foreground=\"red\">closed</span>"
end
DETAILS_CURRENT_HOURS.text = Utils.hours_for_day(response_json["hours"], Time.local.day_of_week, ", ")
DETAILS_PRICING.text = response_json["price"].as_s? || ""
DETAILS_ADDRESS.markup = Utils.format_address(response_json["location"]["display_address"])
DETAILS_PHONE.text = response_json["display_phone"].as_s? || "no phone number"
DETAILS_URL.uri = response_json["url"].as_s? || ""
DETAILS_CURRENT_HOURS.text = Utils.hours_for_day(response.hours[0], Time.local.day_of_week, ", ")
DETAILS_PRICING.text = response.price || ""
DETAILS_ADDRESS.markup = Utils.format_address(response.location.display_address)
DETAILS_PHONE.text = response.display_phone || "no phone number"
DETAILS_URL.uri = response.url || ""
clear_hour_rows()
@@hour_rows = format_hours(response_json["hours"])
@@hour_rows = format_hours(response.hours[0])
@@hour_rows.each { |hour_row| DETAILS_HOURS_BOX.append(hour_row) }
set_map_location(response.coordinates)
# If we're in the small layout we want to show the back button
if LEAFLET.folded
DETAILS_BACK.visible = true
@@ -143,10 +179,18 @@ module Wince
LEAFLET.visible_child = DETAILS_SCROLL
end
def format_hours(hours_json : JSON::Any)
def set_map_location(coordinates : Yelp::Coordinates)
viewport = DETAILS_MAP.viewport
viewport.set_location(coordinates.latitude, coordinates.longitude)
viewport.zoom_level = 16
@@marker.try {|m| m.set_location(coordinates.latitude, coordinates.longitude) }
end
def format_hours(hours : Yelp::Hours)
Time::DayOfWeek.values.map do |day|
hours = Utils.hours_for_day(hours_json, day, "\n")
HourRow.new(day, hours)
hours_for_day = Utils.hours_for_day(hours, day, "\n")
HourRow.new(day, hours_for_day)
end
end

View File

@@ -1,4 +1,6 @@
require "libadwaita"
GICrystal.require("Geoclue", "2.0")
GICrystal.require("Shumate", "1.0")
require "./modules/prerequisites.cr"
require "./modules/views/main.cr"
@@ -25,6 +27,8 @@ module Wince
DETAILS_URL = Gtk::LinkButton.cast(B_UI["detailsUrl"])
DETAILS_BACK = Gtk::Button.cast(B_UI["detailsBack"])
DETAILS_HOURS_BOX = Gtk::ListBox.cast(B_UI["detailsHoursBox"])
DETAILS_MAP = Shumate::SimpleMap.cast(B_UI["detailsMap"])
CONFIG_NOT_FOUND_TEXT = Gtk::Label.cast(B_UI["configNotFoundText"])
APP = Adw::Application.new("dev.wince", Gio::ApplicationFlags::None)
APP = Adw::Application.new("space.quietfeathers.wince", Gio::ApplicationFlags::None)
end