parking_ticket 1.0.47 → 1.0.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47190c2379c7c918b9b1e523468356733a8e95f35f28b9f82a2b51e42711b6ff
-  data.tar.gz: '03789c5ef1ddf7705635aa3a7fa8040c759ee6579e322343921a9401055718cb'
+  metadata.gz: bf677104f4a7521da8b2fd6f29067e05da2b6561f2a9ca66d548b38a85d4a7ae
+  data.tar.gz: 2a1f110540182ddfd469c0a6866cd9d080231f3d71b308e9009815a17458093c
 SHA512:
-  metadata.gz: e42de2271ba5e618055f3d89cb1dc991eecbdaf3d3b5bc8a21badee98f962d7060c38143248bb8c00f8b60414a8b6ee20d62238a1ef6b1a595686f4326e09ae2
-  data.tar.gz: ffdab5a02a2b4f826585ac8aa09f6e1d3c264ec6c0d47b6276d455cc410aa2b820f37280df16584655c15b24ddf5b1a3a3d887608063bfbead58ecbaa5ae0460
+  metadata.gz: 91b0d25a297292d067a76e77b67530410c5b82ad03a169049388c5b072e6056eeb27be51c684f690f998a6500e2e515209435b8edb354d8d5733601ad2af1bdf
+  data.tar.gz: '0983f1b743c0de20665039cc0058ce0db8a0954688c6c3674d6dc002d0ce5d6ba8d95a8beb9c8ec9c00ff1499ddba0f355d39f06db1537dd67226b0d7510baab'

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require:
+  - rubocop-sorbet
+AllCops:
+    NewCops: enable

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "ruby.rubocop.onSave": false
+}

data/Gemfile

@@ -1,19 +1,4 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in parking_ticket.gemspec
 gemspec
-
-gem 'rake', '~> 13.0'
-
-gem 'rspec', '~> 3.0'
-
-# VCR, save test suite's http requests and replay them
-gem 'vcr', '~> 6.0'
-# Mock web requests in tests
-gem 'webmock', '~> 3.12'
-
-gem 'faraday', '~> 2.7', '>= 2.7.2'
-
-gem 'json_matchers'

data/Gemfile.lock

@@ -1,27 +1,42 @@
 PATH
   remote: .
   specs:
-    parking_ticket (1.0.46)
-      faraday
+    parking_ticket (1.0.49)
+      faraday (>= 2.7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
+    amazing_print (1.4.0)
+    ast (2.4.2)
+    byebug (11.1.3)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    faraday (2.7.2)
+    faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     hashdiff (1.0.1)
+    json (2.6.3)
     json_matchers (0.11.1)
       json_schema
     json_schema (0.21.0)
+    netrc (0.11.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
     public_suffix (5.0.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    rbi (0.0.16)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -36,23 +51,76 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-sorbet (0.7.0)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    sorbet (0.5.10746)
+      sorbet-static (= 0.5.10746)
+    sorbet-runtime (0.5.10746)
+    sorbet-static (0.5.10746-universal-darwin-20)
+    sorbet-static-and-runtime (0.5.10746)
+      sorbet (= 0.5.10746)
+      sorbet-runtime (= 0.5.10746)
+    spoom (1.2.1)
+      sorbet (>= 0.5.10187)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.11.4)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.0.0, >= 0.0.16)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.2.0, >= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    unicode-display_width (2.4.2)
+    unparser (0.6.7)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
     vcr (6.1.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.8.0)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
 
 PLATFORMS
   arm64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
-  faraday (~> 2.7, >= 2.7.2)
+  amazing_print
+  byebug
   json_matchers
   parking_ticket!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop
+  rubocop-sorbet
+  sorbet
+  sorbet-runtime
+  tapioca
+  unparser
   vcr (~> 6.0)
   webmock (~> 3.12)
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "parking_ticket"
+require 'bundler/setup'
+require 'parking_ticket'
 
 # 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.
@@ -11,5 +11,5 @@ require "parking_ticket"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tapioca', 'tapioca')

data/lib/clients/models/payment_method.rb

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+module ParkingTicket
+  module Clients
+    module Models
+      class PaymentMethod < T::Struct
+        include ParkingTicket::Clients::Models::StructuralyComparable
+        const :client_internal_id, String
+        const :anonymised_card_number, String
+        const :payment_card_type, String
+      end
+    end
+  end
+end

data/lib/clients/models/quote.rb

@@ -0,0 +1,16 @@
+# typed: true
+# frozen_string_literal: true
+
+module ParkingTicket
+  module Clients
+    module Models
+      class Quote < T::Struct
+        include ParkingTicket::Clients::Models::StructuralyComparable
+        const :client_internal_id, String
+        const :starts_on, DateTime
+        const :ends_on, DateTime
+        const :cost, Float
+      end
+    end
+  end
+end

data/lib/clients/models/rate_option.rb

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module ParkingTicket
+  module Clients
+    module Models
+      class RateOption < T::Struct
+        include ParkingTicket::Clients::Models::StructuralyComparable
+
+        const :client_internal_id, String
+        const :name, String
+        const :type, String
+        const :accepted_time_units, T::Array[String]
+
+        prop :free, T.nilable(T::Boolean)
+      end
+    end
+  end
+end

data/lib/clients/models/structuraly_comparable.rb

@@ -0,0 +1,14 @@
+# typed: false
+# frozen_string_literal: true
+
+module ParkingTicket
+  module Clients
+    module Models
+      module StructuralyComparable
+        def ==(other)
+          serialize == other.serialize
+        end
+      end
+    end
+  end
+end

data/lib/clients/models/ticket.rb

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module ParkingTicket
+  module Clients
+    module Models
+      class Ticket < T::Struct
+        include ParkingTicket::Clients::Models::StructuralyComparable
+
+        const :client_internal_id, String
+        const :starts_on, DateTime
+        const :ends_on, DateTime
+        const :license_plate, String
+        const :cost, Float
+        const :client, String
+      end
+    end
+  end
+end

data/lib/clients/models/vehicle.rb

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+module ParkingTicket
+  module Clients
+    module Models
+      class Vehicle < T::Struct
+        include ParkingTicket::Clients::Models::StructuralyComparable
+
+        const :client_internal_id, String
+        const :license_plate, String
+        const :vehicle_type, String
+        const :vehicle_description, T.nilable(String)
+      end
+    end
+  end
+end

data/lib/clients/pay_by_phone/adapter.rb

@@ -1,106 +1,162 @@
+# typed: strict
+# frozen_string_literal: true
+
 module ParkingTicket
   module Clients
     module PayByPhone
-      class Adapter < Clients::Adapter
-        ACCEPTED_TIME_UNIT_MAPPER = {
+      class Adapter
+        extend T::Sig
+
+        class << self
+          extend T::Sig
+          sig { returns(T.class_of(ParkingTicket::Clients::PayByPhone::Client)) }
+          def client_class
+            ParkingTicket::Clients::PayByPhone::Client
+          end
+
+          sig { params(username: String, password: String).returns(T::Boolean) }
+          def valid_credentials?(username, password)
+            client_class.auth(username, password).status == 200
+          end
+        end
+
+        ACCEPTED_TIME_UNIT_MAPPER = T.let({
           'Days' => 'days',
           'Minutes' => 'minutes',
           'Hours' => 'hours'
-        }.freeze
+        }.freeze, T::Hash[String, String])
 
-        PAYMENT_CARD_TYPE_MAPPER = {
+        PAYMENT_CARD_TYPE_MAPPER = T.let({
           'MasterCard' => 'master_card',
           'Visa' => 'visa'
-        }.freeze
+        }.freeze, T::Hash[String, String])
 
-        VEHICLE_TYPE_MAPPER = {
+        VEHICLE_TYPE_MAPPER = T.let({
           'Car' => 'combustion_car',
           'ElectricMotorcycle' => 'electric_motorcycle'
-        }.freeze
+        }.freeze, T::Hash[String, String])
 
-        private
+        class Error < StandardError; end
+
+        sig { params(username: String, password: String).void }
+        def initialize(username, password)
+          @username = username
+          @password = password
+          @valid_credentials = T.let(self.class.valid_credentials?(username, password), T::Boolean)
+          @client = T.let(self.class.client_class.new(@username, @password), ParkingTicket::Clients::PayByPhone::Client)
+        end
 
-        def fetch_and_map_vehicles
-          client.vehicles.map do |vehicle|
-            {
+        sig { returns(T::Array[ParkingTicket::Clients::Models::Vehicle]) }
+        def vehicles
+          raise_invalid_credentials! unless @valid_credentials
+          @client.vehicles.map do |vehicle|
+            ParkingTicket::Clients::Models::Vehicle.new(
               client_internal_id: vehicle['vehicleId'],
               license_plate: vehicle['licensePlate'],
-              vehicle_type: VEHICLE_TYPE_MAPPER[vehicle['type']],
-              vehicle_description: vehicle.dig("profile", "description"),
-            }
+              vehicle_type: T.must(VEHICLE_TYPE_MAPPER[vehicle['type']]),
+              vehicle_description: vehicle.dig('profile', 'description')
+            )
           end
         end
 
-        def fetch_and_map_rate_options(zipcode, license_plate)
-          client.rate_options(zipcode, license_plate).map do |rate_option|
+        sig do
+          params(zipcode: String, license_plate: String).returns(T::Array[ParkingTicket::Clients::Models::RateOption])
+        end
+        def rate_options(zipcode, license_plate)
+          raise_invalid_credentials! unless @valid_credentials
+          @client.rate_options(zipcode, license_plate).map do |rate_option|
             mapped_time_units = rate_option['acceptedTimeUnits'].map do |accepted_time_unit|
               ACCEPTED_TIME_UNIT_MAPPER[accepted_time_unit]
             end
-            {
+            ParkingTicket::Clients::Models::RateOption.new(
               client_internal_id: rate_option['rateOptionId'],
               name: rate_option['name'],
               type: rate_option['type'],
               accepted_time_units: mapped_time_units
-            }
+            )
           end
         end
 
-        def fetch_and_map_running_ticket(license_plate, zipcode)
-          client.running_tickets.filter do |ticket|
+        sig do
+          params(license_plate: String, zipcode: String).returns(T.nilable(ParkingTicket::Clients::Models::Ticket))
+        end
+        def running_ticket(license_plate, zipcode)
+          raise_invalid_credentials! unless @valid_credentials
+          @client.running_tickets.filter do |ticket|
             ticket.dig('vehicle', 'licensePlate') == license_plate && ticket['locationId'] == zipcode
           end.map do |ticket|
-            {
+            ParkingTicket::Clients::Models::Ticket.new(
               client_internal_id: ticket['parkingSessionId'],
               starts_on: DateTime.parse(ticket['startTime']),
               ends_on: DateTime.parse(ticket['expireTime']),
               license_plate: ticket.dig('vehicle', 'licensePlate'),
               cost: ticket.dig('segments', 0, 'cost'),
               client: 'PayByPhone'
-            }
+            )
           end.first
         end
 
-        def request_new_ticket(license_plate:, zipcode:, rate_option_client_internal_id:, quantity:, time_unit:, payment_method_id:)
-          mapped_time_unit = ACCEPTED_TIME_UNIT_MAPPER.key(time_unit)
+        sig do
+          returns(T::Array[ParkingTicket::Clients::Models::PaymentMethod])
+        end
+        def payment_methods
+          raise_invalid_credentials! unless @valid_credentials
+          @client.payment_methods.fetch('items').map do |payment_method|
+            ParkingTicket::Clients::Models::PaymentMethod.new(
+              client_internal_id: payment_method['id'],
+              anonymised_card_number: payment_method['maskedCardNumber'][-4..],
+              payment_card_type: PAYMENT_CARD_TYPE_MAPPER.fetch(payment_method['paymentCardType'])
+            )
+          end
+        end
 
-          quote = fetch_and_map_quote(rate_option_client_internal_id, zipcode, license_plate, quantity,
-                                      time_unit)
+        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)
+          raise_invalid_credentials! unless @valid_credentials
+          mapped_time_unit = T.must(ACCEPTED_TIME_UNIT_MAPPER.key(time_unit))
+          fetched_quote = @client.quote(rate_option_id, zipcode, license_plate, quantity, mapped_time_unit)
 
-          client.new_ticket(
+          ParkingTicket::Clients::Models::Quote.new(
+            client_internal_id: fetched_quote['quoteId'],
+            starts_on: DateTime.parse(fetched_quote['parkingStartTime']),
+            ends_on: DateTime.parse(fetched_quote['parkingExpiryTime']),
+            cost: fetched_quote.dig('totalCost', 'amount').to_f
+          )
+        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:)
+          raise_invalid_credentials! unless @valid_credentials
+
+          mapped_time_unit = ACCEPTED_TIME_UNIT_MAPPER.invert.fetch(time_unit)
+
+          quote = quote(rate_option_client_internal_id, zipcode, license_plate, quantity,
+                        time_unit)
+
+          @client.new_ticket(
             license_plate: license_plate,
             zipcode: zipcode,
             rate_option_client_internal_id: rate_option_client_internal_id,
             quantity: quantity,
             time_unit: mapped_time_unit,
-            quote_client_internal_id: quote[:client_internal_id],
-            starts_on: quote[:starts_on],
+            quote_client_internal_id: quote.client_internal_id,
+            starts_on: quote.starts_on,
             payment_method_id: payment_method_id
           )
         end
 
-        def fetch_and_map_payment_methods
-          client.payment_methods['items'].map do |payment_method|
-            {
-              client_internal_id: payment_method['id'],
-              anonymised_card_number: payment_method['maskedCardNumber'][-4..],
-              payment_card_type: PAYMENT_CARD_TYPE_MAPPER[payment_method['paymentCardType']]
-            }
-          end
-        end
-
-        def fetch_and_map_quote(rate_option_id, zipcode, license_plate, quantity, time_unit)
-          mapped_time_unit = ACCEPTED_TIME_UNIT_MAPPER.key(time_unit)
-          fetched_quote = client.quote(rate_option_id, zipcode, license_plate, quantity, mapped_time_unit)
-
-          {
-            client_internal_id: fetched_quote['quoteId'],
-            starts_on: fetched_quote['parkingStartTime'],
-            ends_on: fetched_quote['parkingExpiryTime'],
-            cost: fetched_quote.dig('totalCost', 'amount')
-          }
+        sig { void }
+        def raise_invalid_credentials!
+          raise Error, 'Adapter credentials are not valid'
         end
       end
     end
   end
 end
-