parking_ticket 1.0.46 → 1.0.49

data/lib/clients/pay_by_phone/client.rb

@@ -1,21 +1,16 @@
+# typed: true
+# frozen_string_literal: true
+
 require 'faraday'
+
 module ParkingTicket
   module Clients
     module PayByPhone
       class Client
+        extend T::Sig
         class << self
-          def rate_options(token, account_id, zipcode, license_plate)
-            connection(token).get("/parking/locations/#{zipcode}/rateOptions",
-                                  {
-                                    parkingAccountId: account_id,
-                                    licensePlate: license_plate
-                                  }).body
-          end
-
-          def vehicles(token)
-            connection(token).get('/identity/profileservice/v1/members/vehicles/paybyphone').body
-          end
-
+          extend T::Sig
+          sig { params(username: String, password: String).returns(Faraday::Response) }
           def auth(username, password)
             conn = Faraday.new('https://auth.paybyphoneapis.com') do |f|
               f.response :json
@@ -35,14 +30,41 @@ module ParkingTicket
             )
           end
 
+          sig { params(token: String, account_id: String, zipcode: String, license_plate: String).returns(Array) }
+          def rate_options(token, account_id, zipcode, license_plate)
+            connection(token).get("/parking/locations/#{zipcode}/rateOptions",
+                                  {
+                                    parkingAccountId: account_id,
+                                    licensePlate: license_plate
+                                  }).body
+          end
+
+          sig { params(token: String).returns(T::Array[T::Hash[String, T.untyped]]) }
+          def vehicles(token)
+            connection(token).get('/identity/profileservice/v1/members/vehicles/paybyphone').body
+          end
+
+          sig { params(token: String).returns(String) }
           def account_id(token)
             connection(token).get('/parking/accounts').body.dig(0, 'id')
           end
 
+          sig { params(token: String, account_id: String).returns(T::Array[T::Hash[String, T.untyped]]) }
           def running_tickets(token, account_id)
             connection(token).get("/parking/accounts/#{account_id}/sessions?periodType=Current").body
           end
 
+          sig do
+            params(
+              token: String,
+              account_id: String,
+              rate_option_id: String,
+              zipcode: String,
+              license_plate: String,
+              quantity: Integer,
+              time_unit: String
+            ).returns(T::Hash[String, T.untyped])
+          end
           def quote(token, account_id, rate_option_id, zipcode, license_plate, quantity, time_unit)
             connection(token).get(
               "/parking/accounts/#{account_id}/quote",
@@ -58,35 +80,50 @@ module ParkingTicket
             ).body
           end
 
-          def new_ticket(token, account_id, license_plate:, zipcode:, rate_option_client_internal_id:, quantity:, time_unit:, quote_client_internal_id:, starts_on:, payment_method_id:)
+          sig do
+            params(
+              token: String,
+              account_id: String,
+              license_plate: String,
+              zipcode: String,
+              rate_option_client_internal_id: String,
+              quantity: Integer,
+              time_unit: String,
+              quote_client_internal_id: String,
+              starts_on: DateTime,
+              payment_method_id: T.nilable(String)
+            ).void
+          end
+          def new_ticket(token, account_id, license_plate:, zipcode:, rate_option_client_internal_id:, quantity:,
+                         time_unit:, quote_client_internal_id:, starts_on:, payment_method_id:)
             base_data = {
-              "expireTime": nil,
-              "duration": {
-                "quantity": quantity.to_s,
-                "timeUnit": time_unit
+              expireTime: nil,
+              duration: {
+                quantity: quantity.to_s,
+                timeUnit: time_unit
               },
-              "licensePlate": license_plate,
-              "locationId": zipcode,
-              "rateOptionId": rate_option_client_internal_id,
-              "startTime": starts_on,
-              "quoteId": quote_client_internal_id,
-              "parkingAccountId": account_id
+              licensePlate: license_plate,
+              locationId: zipcode,
+              rateOptionId: rate_option_client_internal_id,
+              startTime: starts_on,
+              quoteId: quote_client_internal_id,
+              parkingAccountId: account_id
             }
 
             payment_data = {
-              "paymentMethod": {
-                "paymentMethodType": 'PaymentAccount',
-                "payload": {
-                  "paymentAccountId": payment_method_id,
-                  "clientBrowserDetails": {
-                    "browserAcceptHeader": 'text/html',
-                    "browserColorDepth": '30',
-                    "browserJavaEnabled": 'false',
-                    "browserLanguage": 'fr-FR',
-                    "browserScreenHeight": '900',
-                    "browserScreenWidth": '1440',
-                    "browserTimeZone": '-60',
-                    "browserUserAgent": 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36'
+              paymentMethod: {
+                paymentMethodType: 'PaymentAccount',
+                payload: {
+                  paymentAccountId: payment_method_id,
+                  clientBrowserDetails: {
+                    browserAcceptHeader: 'text/html',
+                    browserColorDepth: '30',
+                    browserJavaEnabled: 'false',
+                    browserLanguage: 'fr-FR',
+                    browserScreenHeight: '900',
+                    browserScreenWidth: '1440',
+                    browserTimeZone: '-60',
+                    browserUserAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36'
                   }
                 }
               }
@@ -96,16 +133,18 @@ module ParkingTicket
 
             connection(token).post(
               "/parking/accounts/#{account_id}/sessions/",
-              final_data.to_json
+              JSON.generate(final_data)
             ).body
           end
 
+          sig { params(token: String).returns(T::Hash[String, T::Array[T::Hash[String, T.untyped]]]) }
           def payment_methods(token)
             connection(token).get('/payment/v3/accounts').body
           end
 
           private
 
+          sig { params(token: String).returns(Faraday::Connection) }
           def connection(token)
             Faraday.new(
               url: 'https://consumer.paybyphoneapis.com',
@@ -124,27 +163,49 @@ module ParkingTicket
           @password = password
         end
 
+        sig { returns(T::Array[T::Hash[String, T.untyped]]) }
         def vehicles
           self.class.vehicles(token)
         end
 
+        sig { params(zipcode: String, license_plate: String).returns(T::Array[T::Hash[String, T.untyped]]) }
         def rate_options(zipcode, license_plate)
           self.class.rate_options(token, account_id, zipcode, license_plate)
         end
 
+        sig { returns(T::Array[T::Hash[String, T.untyped]]) }
         def running_tickets
           self.class.running_tickets(token, account_id)
         end
 
+        sig { returns(T::Hash[String, T::Array[T::Hash[String, T.untyped]]]) }
         def payment_methods
           self.class.payment_methods(token)
         end
 
+        sig do
+          params(rate_option_id: String, zipcode: String, license_plate: String, quantity: Integer,
+                 time_unit: String).returns(T::Hash[String, T.untyped])
+        end
         def quote(rate_option_id, zipcode, license_plate, quantity, time_unit)
           self.class.quote(token, account_id, rate_option_id, zipcode, license_plate, quantity, time_unit)
         end
 
-        def new_ticket(license_plate:, zipcode:, rate_option_client_internal_id:, quantity:, time_unit:, quote_client_internal_id:, starts_on:, payment_method_id:)
+        sig do
+          params(
+            license_plate: String,
+            zipcode: String,
+            rate_option_client_internal_id: String,
+            quantity: Integer,
+            time_unit: String,
+            quote_client_internal_id: String,
+            starts_on: DateTime,
+            payment_method_id: T.nilable(String)
+          )
+            .void
+        end
+        def new_ticket(license_plate:, zipcode:, rate_option_client_internal_id:, quantity:, time_unit:,
+                       quote_client_internal_id:, starts_on:, payment_method_id:)
           self.class.new_ticket(token, account_id,
                                 license_plate: license_plate,
                                 zipcode: zipcode,
@@ -158,10 +219,12 @@ module ParkingTicket
 
         private
 
+        sig { returns(String) }
         def token
           @token ||= self.class.auth(@username, @password).body['access_token']
         end
 
+        sig { returns(String) }
         def account_id
           @account_id ||= self.class.account_id(token)
         end

data/lib/parking_ticket/configuration.rb

@@ -1,3 +1,6 @@
+# typed: false
+# frozen_string_literal: true
+
 module ParkingTicket
   class Configuration
     def self.attr_required(*configuration_keys)

data/lib/parking_ticket/version.rb

@@ -1,5 +1,6 @@
+# typed: false
 # frozen_string_literal: true
 
 module ParkingTicket
-  VERSION = '1.0.46'
+  VERSION = '1.0.49'
 end

data/lib/parking_ticket.rb

@@ -1,73 +1,113 @@
+# typed: strict
 # frozen_string_literal: true
 
-require 'parking_ticket/configuration'
+# requires
+require 'date'
+
+# sorbet
+require 'sorbet-runtime'
+
+# gem version
 require 'parking_ticket/version'
 
-# PayByPhone wrapper
-require 'clients/adapter'
-require 'clients/pay_by_phone/adapter'
+# models
+require 'clients/models/structuraly_comparable'
+require 'clients/models/vehicle'
+require 'clients/models/rate_option'
+require 'clients/models/ticket'
+require 'clients/models/payment_method'
+require 'clients/models/quote'
+
+# pay_by_phone_subclasses
 require 'clients/pay_by_phone/client'
+require 'clients/pay_by_phone/adapter'
 
 module ParkingTicket
   class Base
+    extend T::Sig
     class << self
+      extend T::Sig
+
+      sig do
+        params(
+          adapter_name: String,
+          username: String,
+          password: String
+        )
+          .returns(T::Boolean)
+      end
       def valid_credentials?(adapter_name, username, password)
-        adapter = Clients::PayByPhone::Adapter if adapter_name == 'pay_by_phone'
+        adapter_class = Clients::PayByPhone::Adapter if adapter_name == 'pay_by_phone'
         raise Error, 'EasyPark will be handled in the next major release' if adapter_name == 'easy_park'
-        raise Error, "Unhandled adapter : #{adapter_name}" unless adapter
-
-        adapter.valid_credentials?(username, password)
-      end
+        raise Error, "Unhandled adapter : #{adapter_name}" unless adapter_class
 
-      def config
-        yield(self)
-      end
-
-      attr_accessor :ticket_format
-
-      def format_ticket(ticket)
-        return unless ticket_format
-
-        ticket_format.each_with_object({}) do |element, acumulator|
-          if element.is_a?(Hash)
-            original_key = element.keys.first
-            target_key = element.values.first
-            acumulator[target_key] = ticket[original_key]
-          else
-            acumulator[element] = ticket[element]
-          end
-        end
+        adapter_class.valid_credentials?(username, password)
       end
     end
-    attr_reader :configuration
 
     class Error < StandardError
     end
 
+    sig do
+      params(
+        adapter_name: String,
+        username: String,
+        password: String
+      )
+        .void
+    end
     def initialize(adapter_name, username, password)
-      @adapter_name = adapter_name
       @username = username
       @password = password
+      @adapter = T.let(load_adapter!(adapter_name), ParkingTicket::Clients::PayByPhone::Adapter)
     end
 
+    sig { returns(T::Array[ParkingTicket::Clients::Models::Vehicle]) }
     def vehicles
-      adapter.vehicles
+      @adapter.vehicles
     end
 
+    sig { params(zipcode: String, license_plate: String).returns(T::Array[ParkingTicket::Clients::Models::RateOption]) }
     def rate_options(zipcode, license_plate)
-      adapter.rate_options(zipcode, license_plate)
+      @adapter.rate_options(zipcode, license_plate)
     end
 
+    sig { params(license_plate: String, zipcode: String).returns(T.nilable(ParkingTicket::Clients::Models::Ticket)) }
     def running_ticket(license_plate, zipcode)
-      adapter.running_ticket(license_plate, zipcode)
+      @adapter.running_ticket(license_plate, zipcode)
     end
 
+    sig { returns(T::Array[ParkingTicket::Clients::Models::PaymentMethod]) }
     def payment_methods
-      adapter.payment_methods
+      @adapter.payment_methods
     end
 
+    sig do
+      params(
+        rate_option_id: String,
+        zipcode: String,
+        license_plate: String,
+        quantity: Integer,
+        time_unit: String
+      )
+        .returns(ParkingTicket::Clients::Models::Quote)
+    end
+    def quote(rate_option_id, zipcode, license_plate, quantity, time_unit)
+      @adapter.quote(rate_option_id, zipcode, license_plate, quantity, time_unit)
+    end
+
+    sig do
+      params(
+        license_plate: String,
+        zipcode: String,
+        rate_option_client_internal_id: String,
+        quantity: Integer,
+        time_unit: String,
+        payment_method_id: T.nilable(String)
+      ).void
+    end
     def new_ticket(license_plate:, zipcode:, rate_option_client_internal_id:, quantity:, time_unit:, payment_method_id:)
-      adapter.new_ticket(
+      @adapter.new_ticket(
         license_plate: license_plate,
         zipcode: zipcode,
         rate_option_client_internal_id: rate_option_client_internal_id,
@@ -77,29 +117,14 @@ module ParkingTicket
       )
     end
 
-    def quote(rate_option_id, zipcode, license_plate, quantity, time_unit)
-      adapter.quote(rate_option_id, zipcode, license_plate, quantity, time_unit)
-    end
-
     private
 
-    def load_adapter!
-      return prepare_pay_by_phone_adapter! if @adapter_name == 'pay_by_phone'
-      return prepare_easy_park_adapter! if @adapter_name == 'easy_park'
-
-      raise Error, "Unhandled adapter : #{@adapter_name}"
-    end
-
-    def prepare_pay_by_phone_adapter!
-      Clients::PayByPhone::Adapter.new(@username, @password)
-    end
-
-    def prepare_easy_park_adapter!
-      raise Error, 'EasyPark will be handled in the next major release'
-    end
+    sig { params(adapter_name: String).returns(ParkingTicket::Clients::PayByPhone::Adapter) }
+    def load_adapter!(adapter_name)
+      return Clients::PayByPhone::Adapter.new(@username, @password) if adapter_name == 'pay_by_phone'
+      raise Error, 'EasyPark will be handled in the next major release' if adapter_name == 'easy_park'
 
-    def adapter
-      @adapter ||= load_adapter!
+      raise Error, "Unhandled adapter : #{adapter_name}"
     end
   end
 end

data/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore=tmp/
+--ignore=vendor/

data/sorbet/rbi/annotations/faraday.rbi

@@ -0,0 +1,17 @@
+# typed: strict
+
+# DO NOT EDIT MANUALLY
+# This file was pulled from a central RBI files repository.
+# Please run `bin/tapioca annotations` to update it.
+
+module Faraday
+  class << self
+    sig { params(url: T.untyped, options: T::Hash[Symbol, T.untyped], block: T.nilable(T.proc.params(connection: Faraday::Connection).void)).returns(Faraday::Connection) }
+    def new(url = nil, options = {}, &block); end
+  end
+end
+
+class Faraday::Response
+  sig { returns(T::Boolean) }
+  def success?; end
+end