ballparc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea22c1b29ab377f2d5147282a85a2862fb0ab9736322c038f3e697994c7fd02
-  data.tar.gz: 6507cb0005195e4ea567ba27ab217da7d7116777eb0cea8eb5d205d1c9acc78e
+  metadata.gz: bf504281ce08b9faef0a59d1fddde69597a969746ec1e1f02b216e5c7a187eb6
+  data.tar.gz: ff5c93be2ea132f5c7cf5b665818b3d9e148439d08ad7fccdd1ad664c5cb6ba8
 SHA512:
-  metadata.gz: e2c72e5e329d8145a499ee5b067943cf1d7ecf431c257a71a98e7a36a9a8a2937a7ccba49ed62a714f7607ef62c28af1e6ec07002b0285e9f94ea4b9fb08e6f0
-  data.tar.gz: a0d71fcf725bc974dc49b29ac7678d234b7480ce8d84233208e7de7a0590e3bef2f4033906d8c9bd0421aaf74c638a89fd90e69416bb2f568189e8070e3a4fa1
+  metadata.gz: 88af63c04e10bf963acf567febdc29f53fe4d4e033fd3b7d47a383f4e542e345cddeacb7d7e0bac735b9e8a046304edf6a76850f919add2d2a4eb681c9ea83ca
+  data.tar.gz: b9aa10aec6eebda09a64af6eebcf454bd70db5a80feb7b614de9e0432609d9782bc082871063d9d3975551a7723de691701a9486e2234d6cd7d18ff75e2bf43b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ballparc (0.1.1)
+    ballparc (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -39,4 +39,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.5.5
+   2.3.21

data/README.md

@@ -23,55 +23,53 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 For creating parking_session in ballparc use this method:
 
-    Ballparc.create_parking_session(endpoint, integration, body_data)
+    Ballparc.create_parking_session(body_data, debug = true)
 
 For deactivating parking_session in ballparc use this method:
 
-    Ballparc.deactivate_parking_session(endpoint, integration, paid_vehicle_id)
+    Ballparc.deactivate_parking_session(paid_vehicle_id, debug = true)
 
 To view violation in ballparc use this method:
 
-    Ballparc.view_violation(endpoint, integration, data)
-
-In above methods we pass 3 arguments:
-a). Endpoint is a ballparc API that we need to use, for testing we can use prefix mock server domain
+    Ballparc.view_violation(body_data, debug = true)
+
+In above methods we pass 2 arguments:
+a). Data is fields required by the ballparc API.
+Example 1: For create parking session.
+
+    data:
+    {   'location_id': "Ballparc Location ID",
+        'source': "Your Company API",
+        'start_time': "2019-02-02 14:39:20",
+        'end_time': "2019-02-03 14:39:20",
+        'space_number': Space number,
+        'plate_number': "123XYZ",
+        'plate_state': "TN",
+        'external_key': "A101"
+    }
 
-    https://private-anon-71ed75e81f-ballparcv2.apiary-mock.com/
+Example 2: For view violation.
 
-Example for creating paid vehicle use this mock server endpoint:
+    data = {start_date: '2024-01-21', end_date: '2024-01-23', plate_number: 'ABC12'}
 
-    https://private-anon-71ed75e81f-ballparcv2.apiary-mock.com/enforcement/paid_vehicles
+Example 3: For deactivate parking_session, we need to pass the ballparc paid vehicle's id.
 
-For production you can replace mock server domain with the production domain.
-Example:
+b). Debug is an optional argument and it's a boolean flag for testing purpose only.
+If debug is true then it will use the Ballparc's mock server to return actual response data so we can see the response data structure.
 
-    production_domain/enforcement/paid_vehicles
+    Example: Ballparc.create_parking_session(body_data, debug = true)
 
-b). Integration is a row of table that must contain a column with 'header' name, and header must contain these key and value:
+If we will not pass the debug in argument then gem will use the Ballparc's production server.
 
-    header:
-    {   "accept"=>"application/x.ballparc.v2+json",
-        "x-api-key"=>"Your ballparc API key",
-        "content_type"=>"application/json",
-        "x-api-secret"=>"Your ballparc API secret key" }
+    Example: Ballparc.create_parking_session(body_data)
 
-Note: You can send these headers in a variable, but make sure key must be same as above so you don't require a table.
+For making this gem work we need to add two environment variables in our application with these names:
 
-c). Data is data required by the ballparc API.
-Example:
-
-    {
-    'location_id': "Ballparc Location ID",
-    'source': "Your Company API",
-    'start_time': "2019-02-02 14:39:20",
-    'end_time': "2019-02-03 14:39:20",
-    'space_number': Space number,
-    'plate_number': "123XYZ",
-    'plate_state': "TN",
-    'external_key': "A101"
-    }
+    BALLPARC_KEY=abcxyz
+    BALLPARC_SECRET=abcxyz
 
 For more information please see the Ballparc documentation [here](https://developer.ballparc.com/)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ballparc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ballparc
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/ballparc.rb

@@ -6,18 +6,22 @@ require 'json'
 require 'uri'
 
 module Ballparc
-  def self.create_parking_session(endpoint, integration, body_data)
-    endpoint += '?'
+  PROD_SERVER_DOMAIN = 'https://api.ballparc.com/enforcement'
+  MOCK_SERVER_DOMAIN = 'https://private-anon-b4097ff57b-ballparcv2.apiary-mock.com/enforcement'
+
+  def self.create_parking_session(body_data, for_debug = false)
+    check_endpoint(for_debug)
+    @endpoint += '/paid_vehicles?'
     body_data.each do |key, value|
-      endpoint += "#{key}=#{value}&"
+      @endpoint += "#{key}=#{value}&"
     end
-    endpoint.chop!
+    @endpoint.chop!
 
-    url = URI(endpoint)
+    url = URI(@endpoint)
     http = Net::HTTP.new(url.host, url.port)
     http.use_ssl = true
     @req = Net::HTTP::Post.new(url)
-    add_headers(integration)
+    add_headers
     response = http.request(@req)
 
     result = JSON.parse(response.body)
@@ -30,12 +34,13 @@ module Ballparc
     { message: e.message, status: :internal_server_error }
   end
 
-  def self.view_violation(endpoint, integration, data)
-    url = URI("#{endpoint}?start_date=#{data[:start_date]}&end_date=#{data[:end_date]}&plate_number=#{data[:plate_number]}")
+  def self.view_violation(data, for_debug = false)
+    check_endpoint(for_debug)
+    url = URI("#{@endpoint}/violations?start_date=#{data[:start_date]}&end_date=#{data[:end_date]}&plate_number=#{data[:plate_number]}")
     http = Net::HTTP.new(url.host, url.port)
     http.use_ssl = true
     @req = Net::HTTP::Get.new(url)
-    add_headers(integration)
+    add_headers
     response = http.request(@req)
 
     result = JSON.parse(response.body)
@@ -48,12 +53,13 @@ module Ballparc
     { message: e.message, status: :internal_server_error }
   end
 
-  def self.deactivate_parking_session(endpoint, integration, paid_vehicle_id)
-    url = URI("#{endpoint}/#{paid_vehicle_id}")
+  def self.deactivate_parking_session(paid_vehicle_id, for_debug = false)
+    check_endpoint(for_debug)
+    url = URI("#{@endpoint}/paid_vehicles/#{paid_vehicle_id}")
     http = Net::HTTP.new(url.host, url.port)
     http.use_ssl = true
     @req = Net::HTTP::Delete.new(url)
-    add_headers(integration)
+    add_headers
     response = http.request(@req)
 
     if response.code == '204'
@@ -65,9 +71,14 @@ module Ballparc
     { message: e.message, status: :internal_server_error }
   end
 
-  def self.add_headers(integration)
-    integration.header.each do |key, value|
-      @req[key] = value
-    end
+  def self.add_headers
+    @req['accept'] = 'application/x.ballparc.v2+json'
+    @req['content_type'] = 'application/json'
+    @req['x-api-key'] = ENV['BALLPARC_KEY']
+    @req['x-api-secret'] = ENV['BALLPARC_SECRET']
+  end
+
+  def self.check_endpoint(for_debug)
+    @endpoint = for_debug ? MOCK_SERVER_DOMAIN : PROD_SERVER_DOMAIN
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ballparc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- Plecco
+- PLECCO Technologies
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies: []
 description: Will be used for the Ballparc API integration.
 email:
@@ -46,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Will be used for the Ballparc API integration.