ballparc 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d934824d3e25fcc65341b37ebdc52f5e859f6a6b8fa43c0bb3818bc7fe7722
-  data.tar.gz: 87c202e396dfc575a0b9642f25e2d96834d8710d30d5a1c862c88a1437b55779
+  metadata.gz: bf504281ce08b9faef0a59d1fddde69597a969746ec1e1f02b216e5c7a187eb6
+  data.tar.gz: ff5c93be2ea132f5c7cf5b665818b3d9e148439d08ad7fccdd1ad664c5cb6ba8
 SHA512:
-  metadata.gz: a1719ebc2baa5a26d20321bd02952fc0866f9e75baf63a25e89c4d8b389bdf9d317072a96594d270f0d8154eb12b16c7b5008bef1d67b8ae6cb0de2cc14b3947
-  data.tar.gz: 93786fa33285cf1f30bff3c606ef03e52e5d9b4bb64c6dcacde69010fe8dbaf74ec7ca23338879039a7de2c51fddbd18d6ed12ccedfc500c2bb12a96388902a3
+  metadata.gz: 88af63c04e10bf963acf567febdc29f53fe4d4e033fd3b7d47a383f4e542e345cddeacb7d7e0bac735b9e8a046304edf6a76850f919add2d2a4eb681c9ea83ca
+  data.tar.gz: b9aa10aec6eebda09a64af6eebcf454bd70db5a80feb7b614de9e0432609d9782bc082871063d9d3975551a7723de691701a9486e2234d6cd7d18ff75e2bf43b

data/Gemfile.lock

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

data/README.md

@@ -1,12 +1,17 @@
 # Ballparc
+This gem is for implementing the ballparc API for managing vehicle in ballparc Parking Management System. We used the ballparc API in this gem to create, update and deactivate vehicles also we can view violation using this gem. For now this gem can only create, deactivate and can view violation event using this gem methods.
 
-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/ballparc`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Installation
+For adding this gem in application you can add gem name in gemfile and run the bundle command.
+In gemfile add this line:
 
-TODO: Delete this and the text above, and describe your gem
+    gem ballparc
 
-## Installation
+In console run this command after adding gem in gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+    bundle
+
+Also you can install the gem and add to the application's Gemfile by executing:
 
     $ bundle add ballparc
 
@@ -16,17 +21,54 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+For creating parking_session in ballparc use this method:
+
+    Ballparc.create_parking_session(body_data, debug = true)
+
+For deactivating parking_session in ballparc use this method:
+
+    Ballparc.deactivate_parking_session(paid_vehicle_id, debug = true)
+
+To view violation in ballparc use this method:
+
+    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"
+    }
+
+Example 2: For view violation.
+
+    data = {start_date: '2024-01-21', end_date: '2024-01-23', plate_number: 'ABC12'}
+
+Example 3: For deactivate parking_session, we need to pass the ballparc paid vehicle's id.
+
+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.
+
+    Example: Ballparc.create_parking_session(body_data, debug = true)
 
-## Development
+If we will not pass the debug in argument then gem will use the Ballparc's production server.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    Example: Ballparc.create_parking_session(body_data)
 
-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).
+For making this gem work we need to add two environment variables in our application with these names:
 
-## Contributing
+    BALLPARC_KEY=abcxyz
+    BALLPARC_SECRET=abcxyz
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ballparc.
+For more information please see the Ballparc documentation [here](https://developer.ballparc.com/)
 
 ## License
 

data/lib/ballparc/version.rb

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

data/lib/ballparc.rb

@@ -6,21 +6,23 @@ 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)
-    integration.header.each do |key, value|
-      req[key] = value
-    end
-    response = http.request(req)
+    @req = Net::HTTP::Post.new(url)
+    add_headers
+    response = http.request(@req)
 
     result = JSON.parse(response.body)
     if response.code == '200' && result['data'].present?
@@ -32,15 +34,15 @@ 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)
-    integration.header.each do |key, value|
-      req[key] = value
-    end
-    response = http.request(req)
+    @req = Net::HTTP::Get.new(url)
+    add_headers
+    response = http.request(@req)
+
     result = JSON.parse(response.body)
     if response.code == '200' && result['data'].present?
       { message: 'Violation found.', ballparc_result: result, status: :ok }
@@ -51,15 +53,15 @@ 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)
-    integration.header.each do |key, value|
-      req[key] = value
-    end
-    response = http.request(req)
+    @req = Net::HTTP::Delete.new(url)
+    add_headers
+    response = http.request(@req)
+
     if response.code == '204'
       { message: 'Successfully deactivated paid vehicle', result_code: response.code.to_i, status: :ok }
     else
@@ -68,4 +70,15 @@ module Ballparc
   rescue StandardError => e
     { message: e.message, status: :internal_server_error }
   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.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Plecco
+- PLECCO Technologies
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-02 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.