digital-payments-sdk 1.0.0

data/lib/shell_ev.rb

@@ -0,0 +1,85 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'shell_ev/api_helper'
+require_relative 'shell_ev/client'
+
+# Utilities
+require_relative 'shell_ev/utilities/file_wrapper'
+require_relative 'shell_ev/utilities/date_time_helper'
+
+# Http
+require_relative 'shell_ev/http/http_call_back'
+require_relative 'shell_ev/http/http_method_enum'
+require_relative 'shell_ev/http/http_request'
+require_relative 'shell_ev/http/http_response'
+
+# Logger
+require_relative 'shell_ev/http/auth/mpp_token'
+require_relative 'shell_ev/http/auth/o_auth_token_post'
+
+# Models
+require_relative 'shell_ev/models/base_model'
+require_relative 'shell_ev/models/collecting_company'
+require_relative 'shell_ev/models/mobile_payment_registration_request'
+require_relative 'shell_ev/models/around_location_array'
+require_relative 'shell_ev/models/payment_enablement_response'
+require_relative 'shell_ev/models/access_token_response'
+require_relative 'shell_ev/models/mpp_acces_token_response'
+require_relative 'shell_ev/models/prepare_fueling_request'
+require_relative 'shell_ev/models/loyalty_details'
+require_relative 'shell_ev/models/payment_details_items'
+require_relative 'shell_ev/models/payment_properties'
+require_relative 'shell_ev/models/prepare_fueling_response'
+require_relative 'shell_ev/models/cancel_fueling_error_response'
+require_relative 'shell_ev/models/mpp_error'
+require_relative 'shell_ev/models/fault_response'
+require_relative 'shell_ev/models/finalise_fueling_request'
+require_relative 'shell_ev/models/cancel_fueling_request'
+require_relative 'shell_ev/models/oauth_token_post_request_body'
+require_relative 'shell_ev/models/mpp_token_request_body'
+require_relative 'shell_ev/models/partner_token_request_body'
+require_relative 'shell_ev/models/around_location_array_data_items'
+require_relative 'shell_ev/models/around_location_array_data_items_loc'
+require_relative 'shell_ev/models/' \
+                 'around_location_array_data_items_opening_hours_items'
+require_relative 'shell_ev/models/prepare_fueling_request_device_details_items'
+require_relative 'shell_ev/models/fault_response_fault'
+require_relative 'shell_ev/models/fault_response_fault_detail'
+require_relative 'shell_ev/models/finalise_fueling_request_payment'
+require_relative 'shell_ev/models/finalise_fueling_request_products_items'
+
+# Exceptions
+require_relative 'shell_ev/exceptions/api_exception'
+require_relative 'shell_ev/exceptions/' \
+                 'payment_enablement_error_response_exception'
+require_relative 'shell_ev/exceptions/access_token_error_exception'
+require_relative 'shell_ev/exceptions/mpp_acces_token_error_response_exception'
+require_relative 'shell_ev/exceptions/station_locator_unauthorized_exception'
+require_relative 'shell_ev/exceptions/station_locator_bad_request_exception'
+require_relative 'shell_ev/exceptions/station_locator_not_found_exception'
+require_relative 'shell_ev/exceptions/station_locator_forbidden_exception'
+require_relative 'shell_ev/exceptions/' \
+                 'station_locator_internal_server_error_exception'
+require_relative 'shell_ev/exceptions/' \
+                 'cancel_fueling_error_response_error_exception'
+
+require_relative 'shell_ev/configuration'
+
+# Controllers
+require_relative 'shell_ev/controllers/base_controller'
+require_relative 'shell_ev/controllers/' \
+                 'shell_api_platform_security_authentication_controller'
+require_relative 'shell_ev/controllers/digital_payment_enablement_controller'
+require_relative 'shell_ev/controllers/station_locator_controller'
+require_relative 'shell_ev/controllers/fueling_controller'
+require_relative 'shell_ev/controllers/partner_notification_controller'

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,29 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'shell_ev'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include ShellEv
+  include CoreLibrary
+
+  # Create configuration and set any test parameters
+  def create_configuration
+    Configuration.new(http_callback: HttpResponseCatcher.new)
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+  end
+end

data/test/controllers/test_fueling_controller.rb

@@ -0,0 +1,61 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class FuelingControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.fueling
+    @response_catcher = @controller.http_call_back
+  end
+
+  # The Digital Payments Service enables 3rd Parties to trigger the refuel process which, if successful, will unlock a pump/nozzle ready for fuelling. Enables a 3rd party to request an access token to start using fueling.
+  #   APIs
+  def test_mpp_token
+    # Parameters for the API call
+    grant_type = 'client_credentials'
+    client_id = 'b2bmpp-cli'
+    client_secret = 'f20935d8f14a44bd1f0923cc4c4fa63f7b25922330cd5080f735f1a2769ece77ce245cfe8ba4cbd2a58544ee5113c200b8e37a7be33311e4b6f3c785bf3f37d2'
+
+    # Perform the API call through the SDK function
+    result = @controller.mpp_token(grant_type, client_id, client_secret)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+  # Enables a partner user to cancel pump reservation from the App
+  def test_mpp_cancel_fueling
+    # Parameters for the API call
+    mpp_transaction_id = '000000001C48'
+
+    # Perform the API call through the SDK function
+    @controller.mpp_cancel_fueling(mpp_transaction_id)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  end
+
+  # Enables a partner user to cancel pump reservation from the App
+  def test_mpp_cancel_fueling1
+    # Parameters for the API call
+    mpp_transaction_id = '000000001C48'
+
+    # Perform the API call through the SDK function
+    @controller.mpp_cancel_fueling(mpp_transaction_id)
+
+    # Test response code
+    assert_equal(204, @response_catcher.response.status_code)
+  end
+
+end

data/test/controllers/test_partner_notification_controller.rb

@@ -0,0 +1,60 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class PartnerNotificationControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.partner_notification
+    @response_catcher = @controller.http_call_back
+  end
+
+  # To access the Partner’s endpoints, for sending callback messages, Shell will need to connect to the Partner API end points. It is recemmended that the partner offers OAuth 2.0 as a standard for call back APIs and will require the OAuth 2.0 token for authentication. Note this needs to be implemented over HTTPS
+  def test_partner_token
+    # Parameters for the API call
+    grant_type = 'client_credentials'
+    client_id = 'SOFflRakNlwnWlxfOXQ4GHDVyqGawuKA'
+    client_secret = 'cRnWgw7gACqM3gVS'
+
+    # Perform the API call through the SDK function
+    result = @controller.partner_token(grant_type, client_id, client_secret)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+  # Enables Shell to inform partner of the successful completion of a transaction. Note this needs to be implemented over HTTPS
+  def test_finalise_fueling
+    # Parameters for the API call
+    body = nil
+
+    # Perform the API call through the SDK function
+    @controller.finalise_fueling(body: body)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  end
+
+  # Enables Shell to inform partner that a Mobile Payment transaction has been cancelled by Shell as an error/issue occured. Note this needs to be implemented over HTTPS
+  def test_cancel_fueling
+    # Parameters for the API call
+    body = nil
+
+    # Perform the API call through the SDK function
+    @controller.cancel_fueling(body: body)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  end
+
+end

data/test/controllers/test_shell_api_platform_security_authentication_controller.rb

@@ -0,0 +1,36 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class ShellAPIPlatformSecurityAuthenticationControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.shell_api_platform_security_authentication
+    @response_catcher = @controller.http_call_back
+  end
+
+  # To obtain APIGEE access token
+  def test_oauth_token_post
+    # Parameters for the API call
+    grant_type = 'client_credentials'
+    client_id = 'SOFflRakNlwnWlxfOXQ4GHDVyqGawuKA'
+    client_secret = 'cRnWgw7gACqM3gVS'
+
+    # Perform the API call through the SDK function
+    result = @controller.oauth_token_post(grant_type, client_id, client_secret)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+end

data/test/controllers/test_station_locator_controller.rb

@@ -0,0 +1,44 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class StationLocatorControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.station_locator
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Returns all sites within specified radius of specified GPS location. Sites of all Types are returned. This call must be used when attempting to establish the station the user is located at as part of fuelling journey (i.e. user has to be within 300m of station to be considered located at the station). This API could also be used as a general query to find nearby Shell locations
+  def test_stationlocator_v1_stations_get_around_location
+    # Parameters for the API call
+    m = 'aroundLocation'
+    lon = 77.6730103
+    lat = 12.9132169
+    radius = 0.3
+    offer_code = nil
+    n = nil
+    amenities = nil
+    countries = nil
+
+    # Perform the API call through the SDK function
+    result = @controller.stationlocator_v1_stations_get_around_location(
+      m, lon, lat, radius, offer_code: offer_code, n: n, amenities: amenities,
+      countries: countries
+    )
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < ShellEv::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: digital-payments-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- developer sdksio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apimatic_core_interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: apimatic_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: apimatic_faraday_client_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: The APIs detailed within this SDK will enable Shell's Fleet Solutions
+  Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles
+  at Shell Stations.
+email:
+- developer+sdksio@apimatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/shell_ev.rb
+- lib/shell_ev/api_helper.rb
+- lib/shell_ev/client.rb
+- lib/shell_ev/configuration.rb
+- lib/shell_ev/controllers/base_controller.rb
+- lib/shell_ev/controllers/digital_payment_enablement_controller.rb
+- lib/shell_ev/controllers/fueling_controller.rb
+- lib/shell_ev/controllers/partner_notification_controller.rb
+- lib/shell_ev/controllers/shell_api_platform_security_authentication_controller.rb
+- lib/shell_ev/controllers/station_locator_controller.rb
+- lib/shell_ev/exceptions/access_token_error_exception.rb
+- lib/shell_ev/exceptions/api_exception.rb
+- lib/shell_ev/exceptions/cancel_fueling_error_response_error_exception.rb
+- lib/shell_ev/exceptions/mpp_acces_token_error_response_exception.rb
+- lib/shell_ev/exceptions/payment_enablement_error_response_exception.rb
+- lib/shell_ev/exceptions/station_locator_bad_request_exception.rb
+- lib/shell_ev/exceptions/station_locator_forbidden_exception.rb
+- lib/shell_ev/exceptions/station_locator_internal_server_error_exception.rb
+- lib/shell_ev/exceptions/station_locator_not_found_exception.rb
+- lib/shell_ev/exceptions/station_locator_unauthorized_exception.rb
+- lib/shell_ev/http/auth/mpp_token.rb
+- lib/shell_ev/http/auth/o_auth_token_post.rb
+- lib/shell_ev/http/http_call_back.rb
+- lib/shell_ev/http/http_method_enum.rb
+- lib/shell_ev/http/http_request.rb
+- lib/shell_ev/http/http_response.rb
+- lib/shell_ev/models/access_token_response.rb
+- lib/shell_ev/models/around_location_array.rb
+- lib/shell_ev/models/around_location_array_data_items.rb
+- lib/shell_ev/models/around_location_array_data_items_loc.rb
+- lib/shell_ev/models/around_location_array_data_items_opening_hours_items.rb
+- lib/shell_ev/models/base_model.rb
+- lib/shell_ev/models/cancel_fueling_error_response.rb
+- lib/shell_ev/models/cancel_fueling_request.rb
+- lib/shell_ev/models/collecting_company.rb
+- lib/shell_ev/models/fault_response.rb
+- lib/shell_ev/models/fault_response_fault.rb
+- lib/shell_ev/models/fault_response_fault_detail.rb
+- lib/shell_ev/models/finalise_fueling_request.rb
+- lib/shell_ev/models/finalise_fueling_request_payment.rb
+- lib/shell_ev/models/finalise_fueling_request_products_items.rb
+- lib/shell_ev/models/loyalty_details.rb
+- lib/shell_ev/models/mobile_payment_registration_request.rb
+- lib/shell_ev/models/mpp_acces_token_response.rb
+- lib/shell_ev/models/mpp_error.rb
+- lib/shell_ev/models/mpp_token_request_body.rb
+- lib/shell_ev/models/oauth_token_post_request_body.rb
+- lib/shell_ev/models/partner_token_request_body.rb
+- lib/shell_ev/models/payment_details_items.rb
+- lib/shell_ev/models/payment_enablement_response.rb
+- lib/shell_ev/models/payment_properties.rb
+- lib/shell_ev/models/prepare_fueling_request.rb
+- lib/shell_ev/models/prepare_fueling_request_device_details_items.rb
+- lib/shell_ev/models/prepare_fueling_response.rb
+- lib/shell_ev/utilities/date_time_helper.rb
+- lib/shell_ev/utilities/file_wrapper.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_fueling_controller.rb
+- test/controllers/test_partner_notification_controller.rb
+- test/controllers/test_shell_api_platform_security_authentication_controller.rb
+- test/controllers/test_station_locator_controller.rb
+- test/http_response_catcher.rb
+homepage: https://www.shell.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: SDK for using Shell Digital Payments APIs
+test_files: []