parking_ticket 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2316d548e3f47bee94290a6e0b4399150d1db6948217c4a0434cae0b3ab5ebd
-  data.tar.gz: 31cbaee19c0e458085ef5ab1c142d2fe5f24a82ff152e9e797c1a8e4ddd03782
+  metadata.gz: 46eea131e0a69fa49115d452afc9ee575b52a06084eb8a026bf115b33b2d46f6
+  data.tar.gz: 735ffb052fecb3599af5bf71ec7a28c60e48e8ed2025e8cb7923e7f6bb570851
 SHA512:
-  metadata.gz: e5c572a25ce7df3ab41f449dbaf1999df4efde403ccad560c87bf284ceb1e08ae3c072a4950a06244ffe94086b147fb0fb56d779a16315cdae05a34e5f39450f
-  data.tar.gz: a1e55ec8f66f0909c49bd53d5cc89ceb243cd6f72d6070befe77f9f57c8b10d4650a396a5f7054cdec7959400e0cb2dd64f42415300bf168f74ebed8715d6e2a
+  metadata.gz: 21652de95a323f337d244d5c652a826b5cda0de762c4d3e4f7be31bcf9b62a2e5e7d14eaf7744b48ac9c7aae1de0c03984e1fe3be76cf4cd34b9a4012e785857
+  data.tar.gz: bfdc6306def10532b510639fe275c7e948f274797e99f4eb314e06a3af98502713e40e57e23756959137f51a0c7b4252caf1e26eaa8f8d6dd738ee02caf6e44a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parking_ticket (1.0.0)
+    parking_ticket (1.0.1)
       faraday
 
 GEM

data/README.md

@@ -1,3 +1,4 @@
+![example workflow](https://github.com/troptropcontent/parking_ticket/actions/workflows/main.yml/badge.svg)
 # ParkingTicket
 
 This gem is a wrapper around the majors residential parking tickets api (for now only PayByPhone is supported).
@@ -22,22 +23,45 @@ Or install it yourself as:
 
 To make the gem work above your parking account you need set some environment variables : 
 
-#PayByPhone : 
-- `PAYBYPHONE_PASSWORD` : your PayByPhone password
-- `PAYBYPHONE_USERNAME` : your PayByPhone username (usually your phone number)
-- `PAYBYPHONE_LICENSEPLATE` : tyhe license plate of the car that must be covered 
-- `PAYBYPHONE_ZIPCODE` : the zipcode you're resident in 
-- `PAYBYPHONE_CARDNUMBER` : the credit card used to pay parking tickets (must be formated as folow xxxxxx------xxxx)
+This give you access to a bunch of classes but the most important one is the ParkingTicket::Base. 
 
-#Other apis to come
+This class can be instanciated as follow : 
 
-Two methods comes with the gem : 
+```
+parking_ticket = ParkingTicket::Base.new(
+  'pay_by_phone',
+  {
+    username: your_pay_by_phone_username,
+    password: your_pay_by_phone_password,
+    license_plate: your_license_plate,
+    zipcode: the_zipcode_where_you_are_resident,
+    card_number: the_card_number_registered_on_pay_by_phone_you_want_to_use, # must be in the format : xxxxxx------xxxx
+  }
+)
+```
+
+Once instanciated and configured correctly (the methods won't work if the is a missing key in the confguration hash), you can use the two instance methods to do what you have to do : 
 
-#`ParkingTicket.current_ticket`
-=> returns an object representing a currently running residential ticket for your car. It returns nil if no ticket are found.
+- #current_ticket
+This checks if a ticket is currently running for the license_plate. 
+Returns :
+```
+#if a ticket is found : 
+{
+  starts_on: 2023-01-11 15:40:22 UTC,
+  ends_on: 2023-01-18 15:40:22 UTC,
+  cost: 9.0,
+  license_plate: your_license_plate,
+  client: "PayByPhone",
+  client_ticket_id: the_id_returned_by_the_adapter,
+}
+
+#if no ticket is found
+nil
+```
 
-#`ParkingTicket.renew`
-=> register a new residential ticket for your car, this won't work if current_ticket returns something.
+- #renew
+This will trigger the renewal of your ticket, works only if no current_ticket is found
 
 Then you can create a scrypt like this one :
 
@@ -45,7 +69,16 @@ Then you can create a scrypt like this one :
 #your_scrypt.rb
 require 'parking_ticket'
 
-ticket_client = ParkingTicket.new
+ticket_client = ParkingTicket::Base.new(
+  'pay_by_phone',
+  {
+    username: your_pay_by_phone_username,
+    password: your_pay_by_phone_password,
+    license_plate: your_license_plate,
+    zipcode: the_zipcode_where_you_are_resident,
+    card_number: the_card_number_registered_on_pay_by_phone_you_want_to_use, # must be in the format : xxxxxx------xxxx
+  }
+)
 
 unless ticket_client.current_ticket
   ticket_client.renew
@@ -53,7 +86,7 @@ end
 
 ```
 
-And play as often as you want to ensure that you always have a ticket for your car.
+And play it as often as you want to ensure that you always have a ticket for your car.
 (But this is very HTTP request consuming, a lot of wasted request will be performed, i am sure that you can do better than that.)
 
 Exemple of application : [parkautomat](https://github.com/troptropcontent/parkautomat)

data/lib/client/pay_by_phone/request.rb

@@ -11,7 +11,7 @@ module ParkingTicket
           connection.get("/parking/accounts/#{account_id}/sessions?periodType=Current").body
         end
 
-        def new_ticket(_account_id, _parking_start_time, _quote_id, _payment_method_id)
+        def new_ticket(account_id, parking_start_time, quote_id, payment_method_id)
           connection.post(
             "/parking/accounts/#{account_id}/sessions/",
             {

data/lib/parking_ticket/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ParkingTicket
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parking_ticket
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tom Ecrepont
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,6 +46,7 @@ files:
 - lib/parking_ticket.rb
 - lib/parking_ticket/configuration.rb
 - lib/parking_ticket/version.rb
+- parking_ticket-1.0.0.gem
 homepage: https://github.com/troptropcontent/parking_ticket
 licenses:
 - MIT