parking_ticket 1.0.32 → 1.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683fc243081f913aef89d5424d206710fa0ddadd4eb8cf431f978046732cc57a
-  data.tar.gz: 64ee6ac6aedca57693dcd3266e89fb717abc46128ad5900bcaabf0f92656dc94
+  metadata.gz: '09795e77f08e8705686b748dca9a56b95b3b1418d776b5ec0bfee9f8a00ef5c7'
+  data.tar.gz: 105daaf69de06d509b6349739946fbf361a9945f37a9a0f8acea6204f8870daf
 SHA512:
-  metadata.gz: aa871a2cba4a8364c5c051e599f1cbc4867cfcf4aa1d50ea5a021f876d45bbba019f292cf22500afff59be800e6ed926f5fa9877e6d15339919b3575a637c3d7
-  data.tar.gz: 3e240587339c43d75ccc9bdd48586b92daf1c2d1e51011fb82118d51d0372f358941012119fcab2b55896b3a1ba022b4b698c75a26de2273d4b1a4eec194c0b8
+  metadata.gz: 68a2dd91389a7d7c44744e6908005b3845c38bd20b2102b4b746fd3efbbf4e7d22f464f807efe526d7613bd84d546348850dcd03e3f8e21ff767d5d2932a6fb4
+  data.tar.gz: a6464776d07b60fcf3e87fdaa65d16b6bf3281326fd6a71afefd82ff527079d3e00e8e58918c1832e1455106b148f8edcf898e332dbade70df3a902abaaa11b6

data/Gemfile

@@ -9,6 +9,11 @@ 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,21 +1,28 @@
 PATH
   remote: .
   specs:
-    parking_ticket (1.0.32)
+    parking_ticket (1.0.41)
       faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
     faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
     json_matchers (0.11.1)
       json_schema
     json_schema (0.21.0)
+    public_suffix (5.0.1)
     rake (13.0.6)
+    rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -30,6 +37,11 @@ GEM
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
     ruby2_keywords (0.0.5)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-20
@@ -41,6 +53,8 @@ DEPENDENCIES
   parking_ticket!
   rake (~> 13.0)
   rspec (~> 3.0)
+  vcr (~> 6.0)
+  webmock (~> 3.12)
 
 BUNDLED WITH
-   2.2.32
+   2.4.6

data/lib/clients/adapter.rb

@@ -0,0 +1,63 @@
+module ParkingTicket
+  module Clients
+    class Adapter
+      class << self
+        def parent_module
+          const_get(name.split('::')[0..-2].join('::'))
+        end
+
+        def valid_credentials?(username, password)
+          parent_module::Client.auth(username, password).status == 200
+        end
+      end
+      class Error < StandardError
+      end
+
+      def initialize(username, password)
+        @username = username
+        @password = password
+      end
+
+      def vehicles
+        raise_invalid_credentials! unless valid_credentials?
+        fetch_and_map_vehicles
+      end
+
+      def rate_options(zipcode, license_plate)
+        raise_invalid_credentials! unless valid_credentials?
+        fetch_and_map_rate_options(zipcode, license_plate)
+      end
+
+      def running_ticket(license_plate, zipcode)
+        raise_invalid_credentials! unless valid_credentials?
+        fetch_and_map_running_ticket(license_plate, zipcode)
+      end
+
+      def payment_methods
+        raise_invalid_credentials! unless valid_credentials?
+        fetch_and_map_payment_methods
+      end
+
+      def new_ticket(license_plate, zipcode, rate_option_id, quantity, time_unit, payment_method_id)
+        raise_invalid_credentials! unless valid_credentials?
+        return if running_ticket(license_plate, zipcode)
+
+        request_new_ticket(license_plate, zipcode, rate_option_id, quantity, time_unit, payment_method_id)
+      end
+
+      private
+
+      def client
+        @client ||= self.class.parent_module::Client.new(@username, @password)
+      end
+
+      def valid_credentials?
+        @valid_credentials ||= self.class.valid_credentials?(@username, @password)
+      end
+
+      def raise_invalid_credentials!
+        raise Error, 'Adapter credentials are not valid'
+      end
+    end
+  end
+end

data/lib/clients/pay_by_phone/adapter.rb

@@ -0,0 +1,95 @@
+module ParkingTicket
+  module Clients
+    module PayByPhone
+      class Adapter < Clients::Adapter
+        ACCEPTED_TIME_UNIT_MAPPER = {
+          'Days' => 'days',
+          'Minutes' => 'minutes',
+          'Hours' => 'hours'
+        }.freeze
+
+        PAYMENT_CARD_TYPE_MAPPER = {
+          'MasterCard' => 'master_card',
+          'Visa' => 'visa'
+        }.freeze
+
+        private
+
+        def fetch_and_map_vehicles
+          client.vehicles.map do |vehicle|
+            {
+              client_internal_id: vehicle['vehicleId'],
+              license_plate: vehicle['licensePlate'],
+              type: vehicle['type']
+            }
+          end
+        end
+
+        def fetch_and_map_rate_options(zipcode, license_plate)
+          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
+            {
+              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|
+            ticket.dig('vehicle', 'licensePlate') == license_plate && ticket['locationId'] == zipcode
+          end.map do |ticket|
+            {
+              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_id, quantity, time_unit, payment_method_id)
+          mapped_time_unit = ACCEPTED_TIME_UNIT_MAPPER.key(time_unit)
+          payment_method = fetch_and_map_payment_methods.find do |payment_method|
+            payment_method[:client_internal_id] == payment_method_id
+          end
+          quote = fetch_and_map_quote(rate_option_id, zipcode, license_plate, quantity, mapped_time_unit)
+          client.new_ticket(
+            quote[:client_internal_id],
+            payment_method[:client_internal_id],
+            zipcode,
+            license_plate,
+            quantity,
+            mapped_time_unit,
+            quote[:starts_on]
+          )
+        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)
+          fetched_quote = client.quote(rate_option_id, zipcode, license_plate, quantity, time_unit)
+          {
+            client_internal_id: fetched_quote['quoteId'],
+            starts_on: fetched_quote['parkingStartTime'],
+            ends_on: fetched_quote['parkingExpiryTime']
+          }
+        end
+      end
+    end
+  end
+end

data/lib/clients/pay_by_phone/client.rb

@@ -0,0 +1,157 @@
+require 'faraday'
+module ParkingTicket
+  module Clients
+    module PayByPhone
+      class Client
+        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
+
+          def auth(username, password)
+            conn = Faraday.new('https://auth.paybyphoneapis.com') do |f|
+              f.response :json
+            end
+            conn.post(
+              '/token',
+              URI.encode_www_form({
+                                    grant_type: 'password',
+                                    username: username,
+                                    password: password,
+                                    client_id: 'paybyphone_web'
+                                  }),
+              {
+                'Accept' => 'application/json, text/plain, */*',
+                'X-Pbp-ClientType' => 'WebApp'
+              }
+            )
+          end
+
+          def account_id(token)
+            connection(token).get('/parking/accounts').body.dig(0, 'id')
+          end
+
+          def running_tickets(token, account_id)
+            connection(token).get("/parking/accounts/#{account_id}/sessions?periodType=Current").body
+          end
+
+          def quote(token, account_id, rate_option_id, zipcode, license_plate, quantity, time_unit)
+            connection(token).get(
+              "/parking/accounts/#{account_id}/quote",
+              {
+                locationId: zipcode,
+                licensePlate: license_plate,
+                rateOptionId: rate_option_id,
+                durationTimeUnit: time_unit,
+                durationQuantity: quantity,
+                isParkUntil: false,
+                parkingAccountId: account_id
+              }
+            ).body
+          end
+
+          def new_ticket(token, account_id, quote_id, payment_method_id, zipcode, license_plate, quantity, time_unit, start_time)
+            connection(token).post(
+              "/parking/accounts/#{account_id}/sessions/",
+              {
+                "expireTime": nil,
+                "duration": {
+                  "quantity": quantity,
+                  "timeUnit": time_unit
+                },
+                "licensePlate": license_plate,
+                "locationId": zipcode,
+                "rateOptionId": '75101',
+                "startTime": start_time,
+                "quoteId": quote_id,
+                "parkingAccountId": account_id,
+                "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'
+                    }
+                  }
+                }
+              }.to_json
+            ).body
+          end
+
+          def payment_methods(token)
+            connection(token).get('/payment/v3/accounts').body
+          end
+
+          private
+
+          def connection(token)
+            Faraday.new(
+              url: 'https://consumer.paybyphoneapis.com',
+              headers: {
+                'Content-Type' => 'application/json',
+                'Authorization' => "Bearer #{token}"
+              }
+            ) do |f|
+              f.response :json
+            end
+          end
+        end
+
+        def initialize(username, password)
+          @username = username
+          @password = password
+        end
+
+        def vehicles
+          self.class.vehicles(token)
+        end
+
+        def rate_options(zipcode, license_plate)
+          self.class.rate_options(token, account_id, zipcode, license_plate)
+        end
+
+        def running_tickets
+          self.class.running_tickets(token, account_id)
+        end
+
+        def payment_methods
+          self.class.payment_methods(token)
+        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(quote_id, payment_method_id, zipcode, license_plate, quantity, time_unit, start_time)
+          self.class.new_ticket(token, account_id, quote_id, payment_method_id, zipcode, license_plate, quantity,
+                                time_unit, start_time)
+        end
+
+        private
+
+        def token
+          @token ||= self.class.auth(@username, @password).body['access_token']
+        end
+
+        def account_id
+          @account_id ||= self.class.account_id(token)
+        end
+      end
+    end
+  end
+end

data/lib/parking_ticket/version.rb

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

data/lib/parking_ticket.rb

@@ -4,15 +4,15 @@ require 'parking_ticket/configuration'
 require 'parking_ticket/version'
 
 # PayByPhone wrapper
-require 'client/pay_by_phone/configuration'
-require 'client/pay_by_phone/adapter'
-require 'client/pay_by_phone/request'
+require 'clients/adapter'
+require 'clients/pay_by_phone/adapter'
+require 'clients/pay_by_phone/client'
 
 module ParkingTicket
   class Base
     class << self
       def valid_credentials?(adapter_name, username, password)
-        adapter = Client::PayByPhone::Adapter if adapter_name == 'pay_by_phone'
+        adapter = 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
 
@@ -44,24 +44,30 @@ module ParkingTicket
     class Error < StandardError
     end
 
-    def initialize(adapter_name, configuration_attributes)
+    def initialize(adapter_name, username, password)
       @adapter_name = adapter_name
-      @configuration_attributes = configuration_attributes
-      @result = {}
+      @username = username
+      @password = password
     end
 
-    def adapter
-      @adapter ||= load_adapter!
+    def vehicles
+      adapter.vehicles
+    end
+
+    def rate_options(zipcode, license_plate)
+      adapter.rate_options(zipcode, license_plate)
     end
 
-    def renew
-      adapter.renew unless current_ticket
+    def running_ticket(license_plate, zipcode)
+      adapter.running_ticket(license_plate, zipcode)
     end
 
-    def current_ticket
-      ticket = adapter.current_ticket
-      ticket = self.class.format_ticket(ticket) if self.class.ticket_format && ticket
-      ticket
+    def payment_methods
+      adapter.payment_methods
+    end
+
+    def new_ticket(license_plate, zipcode, rate_option_id, quantity, time_unit, payment_method_id)
+      adapter.new_ticket(license_plate, zipcode, rate_option_id, quantity, time_unit, payment_method_id)
     end
 
     private
@@ -74,24 +80,15 @@ module ParkingTicket
     end
 
     def prepare_pay_by_phone_adapter!
-      configuration = pay_by_phone_configuration
-      return Client::PayByPhone::Adapter.new(configuration) if configuration.completed?
-
-      raise Error, 'Uncompleted configuration'
-    end
-
-    def pay_by_phone_configuration
-      Client::PayByPhone::Configuration.new do |config|
-        config.username = @configuration_attributes[:username]
-        config.password = @configuration_attributes[:password]
-        config.license_plate = @configuration_attributes[:license_plate]
-        config.zipcode = @configuration_attributes[:zipcode]
-        config.card_number = @configuration_attributes[:card_number]
-      end
+      Clients::PayByPhone::Adapter.new(@username, @password)
     end
 
     def prepare_easy_park_adapter!
       raise Error, 'EasyPark will be handled in the next major release'
     end
+
+    def adapter
+      @adapter ||= load_adapter!
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parking_ticket
 version: !ruby/object:Gem::Version
-  version: 1.0.32
+  version: 1.0.41
 platform: ruby
 authors:
 - Tom Ecrepont
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,9 +40,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/client/pay_by_phone/adapter.rb
-- lib/client/pay_by_phone/configuration.rb
-- lib/client/pay_by_phone/request.rb
+- lib/clients/adapter.rb
+- lib/clients/pay_by_phone/adapter.rb
+- lib/clients/pay_by_phone/client.rb
 - lib/parking_ticket.rb
 - lib/parking_ticket/configuration.rb
 - lib/parking_ticket/version.rb

data/lib/client/pay_by_phone/adapter.rb

@@ -1,71 +0,0 @@
-module ParkingTicket
-  module Client
-    module PayByPhone
-      class Adapter
-        class << self
-          def valid_credentials?(username, password)
-            Request.valid_credentials?(username, password)
-          end
-        end
-
-        def initialize(configuration)
-          @configuration = configuration
-        end
-
-        def valid_credentials?(_username, _password)
-          request.valid_credentials?(_username, _password)
-        end
-
-        def covered?
-          !!current_ticket
-        end
-
-        def current_ticket
-          ticket = request.tickets(account_id).find do |ticket|
-            ticket.dig('vehicle', 'licensePlate') == @configuration.license_plate
-          end
-
-          return unless ticket
-
-          {
-            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',
-            client_ticket_id: ticket['parkingSessionId']
-          }
-        end
-
-        def renew
-          return if covered?
-
-          quote = request.new_quote(rate_option_id, account_id)
-          request.new_ticket(account_id, quote['parkingStartTime'], quote['quoteId'], payment_method_id)
-        end
-
-        private
-
-        def request
-          @request ||= Request.new(@configuration)
-        end
-
-        def account_id
-          @account_id ||= request.accounts.dig(0, 'id')
-        end
-
-        def payment_method_id
-          request.payment_methods['items'].find do |payment_method|
-            payment_method['maskedCardNumber'] == @configuration.card_number
-          end['id']
-        end
-
-        def rate_option_id
-          request.rate_options(account_id).find do |rate_option|
-            rate_option['type'] == 'RES' && rate_option['licensePlate'] == @configuration.license_plate
-          end['rateOptionId']
-        end
-      end
-    end
-  end
-end

data/lib/client/pay_by_phone/configuration.rb

@@ -1,9 +0,0 @@
-module ParkingTicket
-  module Client
-    module PayByPhone
-      class Configuration < ParkingTicket::Configuration
-        attr_required :username, :password, :license_plate, :zipcode, :card_number
-      end
-    end
-  end
-end

data/lib/client/pay_by_phone/request.rb

@@ -1,133 +0,0 @@
-require 'faraday'
-module ParkingTicket
-  module Client
-    module PayByPhone
-      class Request
-        class << self
-          def valid_credentials?(username, password)
-            auth(username, password).status == 200
-          end
-
-          private
-
-          def auth(username, password)
-            conn = Faraday.new('https://auth.paybyphoneapis.com') do |f|
-              f.response :json
-            end
-            conn.post(
-              '/token',
-              URI.encode_www_form({
-                                    grant_type: 'password',
-                                    username: username,
-                                    password: password,
-                                    client_id: 'paybyphone_web'
-                                  }),
-              {
-                'Accept' => 'application/json, text/plain, */*',
-                'X-Pbp-ClientType' => 'WebApp'
-              }
-            )
-          end
-        end
-
-        def initialize(configuration)
-          @configuration = configuration
-        end
-
-        def tickets(account_id)
-          connection.get("/parking/accounts/#{account_id}/sessions?periodType=Current").body
-        end
-
-        def new_ticket(account_id, parking_start_time, quote_id, payment_method_id)
-          connection.post(
-            "/parking/accounts/#{account_id}/sessions/",
-            {
-              "expireTime": nil,
-              "duration": {
-                "quantity": '1',
-                "timeUnit": 'days'
-              },
-              "licensePlate": @configuration.license_plate,
-              "locationId": @configuration.zipcode,
-              "rateOptionId": '75101',
-              "startTime": parking_start_time,
-              "quoteId": quote_id,
-              "parkingAccountId": account_id,
-              "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'
-                  }
-                }
-              }
-            }.to_json
-          ).body
-        end
-
-        def accounts
-          connection.get('/parking/accounts').body
-        end
-
-        def vehicles
-          connection.get('/identity/profileservice/v1/members/vehicles/paybyphone').body
-        end
-
-        def rate_options(account_id)
-          connection.get("/parking/locations/#{@configuration.zipcode}/rateOptions",
-                         {
-                           parkingAccountId: account_id,
-                           licensePlate: @configuration.license_plate
-                         }).body
-        end
-
-        def new_quote(rate_option_id, account_id)
-          connection.get(
-            "/parking/accounts/#{account_id}/quote",
-            {
-              locationId: @configuration.zipcode,
-              licensePlate: @configuration.license_plate,
-              rateOptionId: rate_option_id,
-              durationTimeUnit: 'Days',
-              durationQuantity: 1,
-              isParkUntil: false,
-              parkingAccountId: account_id
-            }
-          ).body
-        end
-
-        def member
-          connection.get('/identity/profileservice/v1/members').body
-        end
-
-        def payment_methods
-          connection.get('/payment/v3/accounts').body
-        end
-
-        def connection
-          @connection ||= Faraday.new(
-            url: 'https://consumer.paybyphoneapis.com',
-            headers: {
-              'Content-Type' => 'application/json',
-              'Authorization' => "Bearer #{token}"
-            }
-          ) do |f|
-            f.response :json
-          end
-        end
-
-        def token
-          self.class.send(:auth, @configuration.username, @configuration.password).body['access_token']
-        end
-      end
-    end
-  end
-end