parking_ticket 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 906db147921e6dd895fb32a8a19655f32534cd5e2fd0b1dde3994993bcf363a0
-  data.tar.gz: 9e8a41a807f6554296ad6af378d9013f7e53d092cfac81a835a151c778e0b52c
+  metadata.gz: b2316d548e3f47bee94290a6e0b4399150d1db6948217c4a0434cae0b3ab5ebd
+  data.tar.gz: 31cbaee19c0e458085ef5ab1c142d2fe5f24a82ff152e9e797c1a8e4ddd03782
 SHA512:
-  metadata.gz: 644057915b6735bde424f2ced14484adc60cda036224b9c9865ba20626dab10efcd36728726b5130be34d82f12c955faa2aa1cebb01dfc06d6034dd82e79f582
-  data.tar.gz: f46361fced56944c3926ab1cbdd48ba2534879c32693d7b4427b7d2338b3c07c82414978331464547732502d20c43d50c0b8bbc10e689a9b2696564fd01d5831
+  metadata.gz: e5c572a25ce7df3ab41f449dbaf1999df4efde403ccad560c87bf284ceb1e08ae3c072a4950a06244ffe94086b147fb0fb56d779a16315cdae05a34e5f39450f
+  data.tar.gz: a1e55ec8f66f0909c49bd53d5cc89ceb243cd6f72d6070befe77f9f57c8b10d4650a396a5f7054cdec7959400e0cb2dd64f42415300bf168f74ebed8715d6e2a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parking_ticket (0.1.2)
+    parking_ticket (1.0.0)
       faraday
 
 GEM
@@ -33,6 +33,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   faraday (~> 2.7, >= 2.7.2)

data/README.md

@@ -1,8 +1,6 @@
 # ParkingTicket
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/parking_ticket`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is a wrapper around the majors residential parking tickets api (for now only PayByPhone is supported).
 
 ## Installation
 
@@ -22,22 +20,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To make the gem work above your parking account you need set some environment variables : 
 
-## Development
+#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)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#Other apis to come
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Two methods comes with the gem : 
 
-## Contributing
+#`ParkingTicket.current_ticket`
+=> returns an object representing a currently running residential ticket for your car. It returns nil if no ticket are found.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/parking_ticket. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/parking_ticket/blob/master/CODE_OF_CONDUCT.md).
+#`ParkingTicket.renew`
+=> register a new residential ticket for your car, this won't work if current_ticket returns something.
 
-## License
+Then you can create a scrypt like this one :
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```
+#your_scrypt.rb
+require 'parking_ticket'
 
-## Code of Conduct
+ticket_client = ParkingTicket.new
+
+unless ticket_client.current_ticket
+  ticket_client.renew
+end
+
+```
 
-Everyone interacting in the ParkingTicket project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/parking_ticket/blob/master/CODE_OF_CONDUCT.md).
+And play 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)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/client/pay_by_phone/adapter.rb

@@ -1,71 +1,61 @@
-require_relative '../pay_by_phone'
-
-class PayByPhone::Adapter
-  class Error < StandardError; end
-
-  def initialize
-    check_required_configuarion!
-  end
-
-  def covered?
-    !!current_ticket
-  end
-
-  def current_ticket
-    ticket = client.tickets(account_id).find do |ticket|
-      ticket.dig('vehicle', 'licensePlate') == ENV['PAYBYPHONE_LICENSEPLATE']
+module ParkingTicket
+  module Client
+    module PayByPhone
+      class Adapter
+        def initialize(configuration)
+          @configuration = configuration
+        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
-    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 = client.new_quote(rate_option_id, account_id)
-    puts client.new_ticket(account_id, quote['parkingStartTime'], quote['quoteId'], payment_method_id)
-  end
-
-  private
-
-  def client
-    @client ||= PayByPhone.new
-  end
-
-  def account_id
-    @account_id ||= client.accounts.dig(0, 'id')
-  end
-
-  def payment_method_id
-    client.payment_methods['items'].find do |payment_method|
-      payment_method['maskedCardNumber'] == ENV['PAYBYPHONE_CARDNUMBER']
-    end['id']
-  end
-
-  def rate_option_id
-    client.rate_options(account_id).find do |rate_option|
-      rate_option['type'] == 'RES' && rate_option['licensePlate'] == ENV['PAYBYPHONE_LICENSEPLATE']
-    end['rateOptionId']
-  end
-
-  def check_required_configuarion!
-    return if %w[
-      PAYBYPHONE_PASSWORD
-      PAYBYPHONE_USERNAME
-      PAYBYPHONE_LICENSEPLATE
-      PAYBYPHONE_ZIPCODE
-      PAYBYPHONE_CARDNUMBER
-    ].all? { |required_environement_variable| ENV[required_environement_variable] }
-
-    raise Error,
-          'The required configuation are not set properly, the following environnment variable must be set : PAYBYPHONE_PASSWORD, PAYBYPHONE_USERNAME, PAYBYPHONE_LICENSEPLATE, PAYBYPHONE_ZIPCODE, PAYBYPHONE_CARDNUMBER'
   end
 end

data/lib/client/pay_by_phone/configuration.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,121 @@
+require 'faraday'
+module ParkingTicket
+  module Client
+    module PayByPhone
+      class Request
+        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
+          conn = Faraday.new('https://auth.paybyphoneapis.com') do |f|
+            f.response :json
+          end
+          conn.post(
+            '/token',
+            URI.encode_www_form({
+                                  grant_type: 'password',
+                                  username: @configuration.username,
+                                  password: @configuration.password,
+                                  client_id: 'paybyphone_web'
+                                }),
+            {
+              'Accept' => 'application/json, text/plain, */*',
+              'X-Pbp-ClientType' => 'WebApp'
+            }
+          ).body['access_token']
+        end
+      end
+    end
+  end
+end

data/lib/parking_ticket/configuration.rb

@@ -0,0 +1,26 @@
+module ParkingTicket
+  class Configuration
+    def self.attr_required(*configuration_keys)
+      define_method('attr_required') do
+        configuration_keys
+      end
+      configuration_keys.each do |configuration_key|
+        define_method configuration_key.to_s do
+          instance_variable_get("@#{configuration_key}")
+        end
+        define_method "#{configuration_key}=" do |value|
+          instance_variable_set("@#{configuration_key}", value)
+        end
+      end
+    end
+
+    def initialize
+      @attr_required = defined?(attr_required) ? attr_required : []
+      yield(self)
+    end
+
+    def completed?
+      @attr_required.all? { |attribute_required| instance_variable_get("@#{attribute_required}") }
+    end
+  end
+end

data/lib/parking_ticket/version.rb

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

data/lib/parking_ticket.rb

@@ -1,28 +1,66 @@
 # frozen_string_literal: true
 
-require_relative 'parking_ticket/version'
-require_relative 'client/pay_by_phone'
-require_relative 'client/pay_by_phone/adapter'
+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'
 
 module ParkingTicket
-  class Error < StandardError; end
+  class Base
+    attr_reader :configuration
 
-  def self.renew
-    if current_ticket
-      puts '❌ Can not renew ticket as already covered by a ticket at this time'
-    else
-      puts '🔄 Renewing ticket'
-      adapter.renew
-      puts '✅ Ticket renewed'
+    class Error < StandardError
     end
-  end
 
-  def self.current_ticket
-    puts '🕵️ Retrieving current_ticket'
-    adapter.current_ticket
-  end
+    def initialize(adapter_name, configuration_attributes)
+      @adapter_name = adapter_name
+      @configuration_attributes = configuration_attributes
+      @result = {}
+    end
+
+    def adapter
+      @adapter ||= load_adapter!
+    end
+
+    def renew
+      adapter.renew unless current_ticket
+    end
+
+    def current_ticket
+      adapter.current_ticket
+    end
 
-  def self.adapter
-    @@adapter ||= PayByPhone::Adapter.new
+    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!
+      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
+    end
+
+    def prepare_easy_park_adapter!
+      raise Error, 'EasyPark will be handled in the next major release'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parking_ticket
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Ecrepont
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,12 +40,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/client/pay_by_phone.rb
 - lib/client/pay_by_phone/adapter.rb
+- lib/client/pay_by_phone/configuration.rb
+- lib/client/pay_by_phone/request.rb
 - lib/parking_ticket.rb
-- lib/parking_ticket/ticket.rb
+- lib/parking_ticket/configuration.rb
 - lib/parking_ticket/version.rb
-- parking_ticket.gemspec
 homepage: https://github.com/troptropcontent/parking_ticket
 licenses:
 - MIT

data/lib/client/pay_by_phone.rb

@@ -1,113 +0,0 @@
-require 'faraday'
-class PayByPhone
-  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": ENV['PAYBYPHONE_LICENSEPLATE'],
-        "locationId": ENV['PAYBYPHONE_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/#{ENV['PAYBYPHONE_ZIPCODE']}/rateOptions",
-                   {
-                     parkingAccountId: account_id,
-                     licensePlate: ENV['PAYBYPHONE_LICENSEPLATE']
-                   }).body
-  end
-
-  def new_quote(rate_option_id, account_id)
-    connection.get(
-      "/parking/accounts/#{account_id}/quote",
-      {
-        locationId: ENV['PAYBYPHONE_ZIPCODE'],
-        licensePlate: ENV['PAYBYPHONE_LICENSEPLATE'],
-        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
-
-  private
-
-  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
-    conn = Faraday.new('https://auth.paybyphoneapis.com') do |f|
-      f.response :json
-    end
-    conn.post(
-      '/token',
-      URI.encode_www_form({
-                            grant_type: 'password',
-                            username: ENV['PAYBYPHONE_USERNAME'],
-                            password: ENV['PAYBYPHONE_PASSWORD'],
-                            client_id: 'paybyphone_web'
-                          }),
-      {
-        'Accept' => 'application/json, text/plain, */*',
-        'X-Pbp-ClientType' => 'WebApp'
-      }
-    ).body['access_token']
-  end
-end

data/lib/parking_ticket/ticket.rb

@@ -1,21 +0,0 @@
-class ParkingTicket::Ticket
-  def initialize(attributes)
-    @starts_on = attributes[:starts_on]
-    @ends_on = attributes[:ends_on]
-    @license_plate = attributes[:license_plate]
-    @cost = attributes[:cost]
-    @client = attributes[:client]
-    @client_ticket_id = attributes[:client_ticket_id]
-  end
-
-  def to_h
-    {
-      starts_on: @starts_on,
-      ends_on: @ends_on,
-      license_plate: @license_plate,
-      cost: @cost,
-      client: @client,
-      client_ticket_id: @client_ticket_id
-    }
-  end
-end

data/parking_ticket.gemspec

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/parking_ticket/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'parking_ticket'
-  spec.version = ParkingTicket::VERSION
-  spec.authors = ['Tom Ecrepont']
-  spec.email = ['tomecrepont@gmail.com']
-
-  spec.summary = 'Never forget to take a parking ticket again.'
-  spec.description = 'Automatically renew your parking ticket when it expires.'
-  spec.homepage = 'https://github.com/troptropcontent/parking_ticket'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.0.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/troptropcontent/parking_ticket'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # dependancies
-  spec.add_dependency 'faraday'
-end