ballparc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d934824d3e25fcc65341b37ebdc52f5e859f6a6b8fa43c0bb3818bc7fe7722
-  data.tar.gz: 87c202e396dfc575a0b9642f25e2d96834d8710d30d5a1c862c88a1437b55779
+  metadata.gz: 2ea22c1b29ab377f2d5147282a85a2862fb0ab9736322c038f3e697994c7fd02
+  data.tar.gz: 6507cb0005195e4ea567ba27ab217da7d7116777eb0cea8eb5d205d1c9acc78e
 SHA512:
-  metadata.gz: a1719ebc2baa5a26d20321bd02952fc0866f9e75baf63a25e89c4d8b389bdf9d317072a96594d270f0d8154eb12b16c7b5008bef1d67b8ae6cb0de2cc14b3947
-  data.tar.gz: 93786fa33285cf1f30bff3c606ef03e52e5d9b4bb64c6dcacde69010fe8dbaf74ec7ca23338879039a7de2c51fddbd18d6ed12ccedfc500c2bb12a96388902a3
+  metadata.gz: e2c72e5e329d8145a499ee5b067943cf1d7ecf431c257a71a98e7a36a9a8a2937a7ccba49ed62a714f7607ef62c28af1e6ec07002b0285e9f94ea4b9fb08e6f0
+  data.tar.gz: a0d71fcf725bc974dc49b29ac7678d234b7480ce8d84233208e7de7a0590e3bef2f4033906d8c9bd0421aaf74c638a89fd90e69416bb2f568189e8070e3a4fa1

data/Gemfile.lock

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

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,18 +21,57 @@ 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(endpoint, integration, body_data)
+
+For deactivating parking_session in ballparc use this method:
+
+    Ballparc.deactivate_parking_session(endpoint, integration, paid_vehicle_id)
+
+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
+
+    https://private-anon-71ed75e81f-ballparcv2.apiary-mock.com/
+
+Example for creating paid vehicle use this mock server endpoint:
+
+    https://private-anon-71ed75e81f-ballparcv2.apiary-mock.com/enforcement/paid_vehicles
+
+For production you can replace mock server domain with the production domain.
+Example:
+
+    production_domain/enforcement/paid_vehicles
 
-## Development
+b). Integration is a row of table that must contain a column with 'header' name, and header must contain these key and value:
 
-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.
+    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" }
 
-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).
+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.
 
-## Contributing
+c). Data is data required by the ballparc API.
+Example:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ballparc.
+    {
+    '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"
+    }
 
+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.0"
+  VERSION = "0.1.1"
 end

data/lib/ballparc.rb

@@ -16,11 +16,9 @@ module Ballparc
     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(integration)
+    response = http.request(@req)
 
     result = JSON.parse(response.body)
     if response.code == '200' && result['data'].present?
@@ -36,11 +34,10 @@ module Ballparc
     url = URI("#{endpoint}?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(integration)
+    response = http.request(@req)
+
     result = JSON.parse(response.body)
     if response.code == '200' && result['data'].present?
       { message: 'Violation found.', ballparc_result: result, status: :ok }
@@ -55,11 +52,10 @@ module Ballparc
     url = URI("#{endpoint}/#{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(integration)
+    response = http.request(@req)
+
     if response.code == '204'
       { message: 'Successfully deactivated paid vehicle', result_code: response.code.to_i, status: :ok }
     else
@@ -68,4 +64,10 @@ module Ballparc
   rescue StandardError => e
     { message: e.message, status: :internal_server_error }
   end
+
+  def self.add_headers(integration)
+    integration.header.each do |key, value|
+      @req[key] = value
+    end
+  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.1
 platform: ruby
 authors:
 - Plecco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-02 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies: []
 description: Will be used for the Ballparc API integration.
 email: