citypay_api_client 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 850a1d1f9a63c3637a70b7d7f766fab91b2c0f2052f41a01970e3d0c42b54a5c
-  data.tar.gz: 54f1d9013d20448319ab3db2766014e2695499d22d02c7a21b625b6602f54924
+  metadata.gz: abee74941401eb70778cfb9a7413a2549c18490e1df25aa0f473ab8b532d89ff
+  data.tar.gz: 527d19c9d9e9601cfdb29c37bdb2fbc63fd127568e88d77d3b79c64fc5768d8a
 SHA512:
-  metadata.gz: 52e1c157f646c683e3d5b21c270124104d5f16d42553819ab07f54cb9af028ee0c8abd26b5738132bad78886e639105dc366eeaddafaa2b81e67aa54c2b80621
-  data.tar.gz: a980f50a46a4ba1cc254cd80daed48c0f4c91f068d8e17fb58c16bd911ac27eedfb4a3874e2a2cefeb5b5d2003c38b4e60a9fa774610c5cf87bc9a31761bf179
+  metadata.gz: 425f3616ef037ceef95fc1417710d105b7f96546e9a6b7742924512340a21a4d5808428e7d4504ddf55cf858c08711f30c089d5656825a066a946a2bc2e1f3ff
+  data.tar.gz: b50ec7b42bb64d7e7215b89d2e13eda64bf1f07551707856482d085454610a2e5957b9e3ea622342df8dc920ab79f162e596d813b605a5ec2066299af83c8309

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    citypay_api_client (1.0.1)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.13.1)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (3.2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  citypay_api_client!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,4 +1,4 @@
-# citypay_api_client
+# CityPay API Client for Ruby
 
 CityPayApiClient - the Ruby gem for the CityPay Payment API
 
@@ -39,6 +39,11 @@ For more information, please visit [https://citypay.com/customer-centre/technica
 
 ## Installation
 
+### Install from rubygems.org
+```shell
+gem install citypay_api_client
+```
+
 ### Build a gem
 
 To build the Ruby code into a gem:
@@ -85,10 +90,7 @@ require 'citypay_api_client'
 
 # Setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: "YourClientId", licence_key: "YourLicenceKey").generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new

data/citypay_api_client.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/citypay/citypay-api-client-ruby"
   s.summary     = "A ruby wrapper for the CityPay API"
   s.description = "CityPay API Client for Ruby"
-  s.license     = "Unlicense"
+  s.license     = "MIT"
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'

data/docs/CardHolderAccountApi.md

@@ -31,10 +31,7 @@ Deletes a card from the account. The card will be marked for deletion before a s
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -87,10 +84,7 @@ Allows for a card to be registered for the account. The card will be added for f
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -143,10 +137,7 @@ Updates the status of a card for processing. The following values are available
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -201,10 +192,7 @@ Allows for the ability to change the contact details for an account.
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -257,10 +245,7 @@ Creates a new card holder account and initialises the account ready for adding c
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -311,10 +296,7 @@ Allows for the deletion of an account. The account will marked for deletion and
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -365,10 +347,7 @@ Allows for the retrieval of a card holder account for the given `id`. Should dup
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -419,10 +398,7 @@ Updates the status of an account. An account can have the following statuses app
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
@@ -475,10 +451,7 @@ A charge process obtains an authorisation using a tokenised value which represen
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new

data/docs/OperationalApi.md

@@ -24,10 +24,7 @@ An operational request to list current merchants for a client.  ### Sorting  Sor
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::OperationalApi.new
@@ -78,10 +75,7 @@ A ping request which performs a connection and authentication test to the CityPa
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::OperationalApi.new

data/docs/PaymentProcessingApi.md

@@ -28,10 +28,7 @@ An authorisation process performs a standard transaction authorisation based on
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::PaymentProcessingApi.new
@@ -82,10 +79,7 @@ The CRes request performs authorisation processing once a challenge request has
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::PaymentProcessingApi.new
@@ -136,10 +130,7 @@ _The capture process only applies to transactions which have been pre-authorised
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::PaymentProcessingApi.new
@@ -190,10 +181,7 @@ The Payer Authentication Response (PaRes) is an operation after the result of au
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::PaymentProcessingApi.new
@@ -244,10 +232,7 @@ A retrieval request which allows an integration to obtain the result of a transa
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::PaymentProcessingApi.new
@@ -298,10 +283,7 @@ _The void process generally applies to transactions which have been pre-authoris
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  # Configure API key authorization: cp-api-key
-  config.api_key['cp-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::PaymentProcessingApi.new

data/lib/citypay_api_client.rb

@@ -1,7 +1,7 @@
 =begin
 #CityPay Payment API
 
-# This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.  ## Compliance and Security <aside class=\"notice\">   Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely   and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside>  * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+# This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.  ## Compliance and Security <aside class=\"notice\">   Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely   and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside>  * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities.
 
 The version of the OpenAPI document: 6.0.0
 Contact: support@citypay.com
@@ -22,6 +22,7 @@ require 'citypay_api_client/models/account_status'
 require 'citypay_api_client/models/acknowledgement'
 require 'citypay_api_client/models/airline_advice'
 require 'citypay_api_client/models/airline_segment'
+require 'citypay_api_client/models/api_key'
 require 'citypay_api_client/models/auth_reference'
 require 'citypay_api_client/models/auth_references'
 require 'citypay_api_client/models/auth_request'

data/lib/citypay_api_client/models/api_key.rb

@@ -1,14 +1,14 @@
 require 'date'
 require 'openssl'
-require 'Base64'
+require 'base64'
 
 module CityPayApiClient
-  class AuthReference
+  class ApiKey
 
-    def initialize(client_id: , licence_key: )
+    def initialize(client_id:, licence_key:)
       @client_id, @licence_key = client_id, licence_key
-      @nonce = []
-      @datetime = DateTime.now()
+      @nonce = Random.new().bytes(16).bytes
+      @datetime = DateTime.now.new_offset(0)
     end
 
     def client_id
@@ -16,37 +16,40 @@ module CityPayApiClient
     end
 
     def nonce=(nonce)
-      @nonce = nonce
+      if nonce.is_a? String
+        @nonce = nonce.scan(/../).map { |x| x.hex.chr }.join.bytes
+      else
+        @nonce = nonce
+      end
+
     end
 
     def datetime=(datetime)
       @datetime = datetime
     end
 
+    private def hex_to_bytes(str)
+      str.scan(/../).map { |x| x.hex.chr }.join.bytes
+    end
+
     def generate
-      ds = datetime.strftime("%Y%m%d%H%M")
-
-      # ds = dt.strftime("%Y%m%d%H%M")
-      # message = bytearray()
-      # message += bytes(client_id, 'utf-8')
-      # message += nonce
-      # message += bytes.fromhex(ds)
-      digest = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, msg)
-      # digest = hmac.new(bytes(licence_key, 'utf-8'),
-      #                   msg=message,
-      #                   digestmod=hashlib.sha256).digest()
-      # dest = bytearray()
-      # dest += bytes(client_id, 'utf-8')
-      # dest += b'\x3A'
-      # dest += bytes(nonce.hex().upper(), 'utf-8')
-      # dest += b'\x3A'
-      # dest += digest
-      # return base64.b64encode(dest).decode('utf-8')
-
-      # dt = datetime.strptime("2020-01-01 09:23:12", "%Y-%m-%d %H:%M:%S")
-      # key = api_key_generate_for("PC2", "7G79TG62BAJTK669", bytearray.fromhex("acb875aef083de292299bd69fcdeb5c5"), dt)
-      # self.assertEqual("UEMyOkFDQjg3NUFFRjA4M0RFMjkyMjk5QkQ2OUZDREVCNUM1Ol6Q3tCMPsYvqNhFelRD2zQHYlZquBGCY/6ZpZ0AngTF",key)
-      "not yet"
+
+      ds = @datetime.strftime("%Y%m%d%H%M")
+      message = []
+      message.push(*@client_id.bytes)
+      message.push(*@nonce)
+      message.push(*hex_to_bytes(ds))
+      # message = message.join
+      digest = OpenSSL::HMAC.digest('sha256', @licence_key, message.pack("c*"))
+
+      dest = []
+      dest.push(*@client_id.bytes)
+      dest.push(*"\x3A".bytes)
+      dest.push(*@nonce.each_entry.map { |b| '%02X' % (b & 0xFF) }.join.upcase.bytes)
+      dest.push(*"\x3A".bytes)
+      dest.push(*digest.bytes)
+      Base64.strict_encode64(dest.pack("c*"))
+
     end
 
   end

data/lib/citypay_api_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.0.0-SNAPSHOT
 =end
 
 module CityPayApiClient
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/models/api_key_spec.rb

@@ -0,0 +1,78 @@
+require 'date'
+require 'citypay_api_client/models/api_key'
+
+describe 'ApiKey' do
+  before do
+    @instance = CityPayApiClient::ApiKey.new(client_id: "PC2", licence_key: "7G79TG62BAJTK669")
+  end
+
+  describe 'test generation' do
+    it 'should generate a new api key based on algorithm' do
+      expect(@instance).to be_instance_of(CityPayApiClient::ApiKey)
+      @instance.nonce = "acb875aef083de292299bd69fcdeb5c5"
+      @instance.datetime = DateTime.new(2020, 1, 1, 9, 23, 12, 0)
+      @instance.generate.should eq("UEMyOkFDQjg3NUFFRjA4M0RFMjkyMjk5QkQ2OUZDREVCNUM1Ol6Q3tCMPsYvqNhFelRD2zQHYlZquBGCY/6ZpZ0AngTF")
+    end
+  end
+
+
+  describe 'generate from initialize' do
+
+    it 'should generate a new key' do
+      @instance.generate
+    end
+
+  end
+
+  describe('standard generation validation') do
+
+    #noinspection RubyLiteralArrayInspection
+    data = [
+        ["aP","0FLSuYlRk5lLFK46","0172D48B3E020EB68CB177DC4BE537E6","2020-08-01T23:04:23","YVA6MDE3MkQ0OEIzRTAyMEVCNjhDQjE3N0RDNEJFNTM3RTY6mSUTOBc1Y4xSorAZUMtOZWD4vN0ZwAbn77+v+Z5Jbco="],
+        ["6oh","IhitVGHjw8WIkafD","C50C8B11123AC2F9B04399EE02EDB7FA","2020-07-14T06:04:10","Nm9oOkM1MEM4QjExMTIzQUMyRjlCMDQzOTlFRTAyRURCN0ZBOo7kVI+jynP7HV1lxO6LopvJJaUVzTxeGu7PCOWvFLFw"],
+        ["ZLM","qwHq9BS0vOW1ian5","E571174876229B467CCFCED5648DFB4B","2020-06-25T13:03:57","WkxNOkU1NzExNzQ4NzYyMjlCNDY3Q0NGQ0VENTY0OERGQjRCOsQAA3LtdHidGqrAEf39rLCSLBMB74uX+IWjKiSL/Fry"],
+        ["JAnSB","CGqRnPns7rDuNyK7","F58B52303248328766B800021E3AAC32","2020-06-06T20:03:44","SkFuU0I6RjU4QjUyMzAzMjQ4MzI4NzY2QjgwMDAyMUUzQUFDMzI69S5jD67gT/aL8K/9mIH9ZvcznC91iVFK1i1QL/RSZGY="],
+        ["9CYH","YIwtokm5HJX4HRyW","A149441E8633C07BBEA44E98064207F4","2020-05-19T03:03:31","OUNZSDpBMTQ5NDQxRTg2MzNDMDdCQkVBNDRFOTgwNjQyMDdGNDrbGQt+S7L28X4tzA5M5c8uuKDlE19po3s0KcT9U07+xA=="],
+        ["ntF","QyNlLl5E0VI8yZFW","FBD4F6E51F021FD6FFB84B7A5394F1EE","2020-04-30T10:03:18","bnRGOkZCRDRGNkU1MUYwMjFGRDZGRkI4NEI3QTUzOTRGMUVFOlOnNTEul+L2da3PG6Do4JKuWy/14no8gdQ/Yn0O+Bgp"],
+        ["5G","Ij2sltQQIxrX9JNh","B5230BAC144AF5DECBC7FF1DA5FBFD36","2020-04-11T17:03:05","NUc6QjUyMzBCQUMxNDRBRjVERUNCQzdGRjFEQTVGQkZEMzY6YGoTAbvDq8gpui9SgRwBxXkEGjRfP69WfozTBi+51pE="],
+        ["kpGivRFGP","kAfYfNsW3g8RN3LE","DF2CC2B598AAABA7237166A0CD18695F","2020-03-24T00:02:52","a3BHaXZSRkdQOkRGMkNDMkI1OThBQUFCQTcyMzcxNjZBMENEMTg2OTVGOjUgfRSOU2IpTYmogi6M6NG4p2l3FKDZUrnLQx+bA1ag"],
+        ["sw7Ue9gDC","D8cSOeuiVbLlKkAm","642FD45F8CFBC8CB8C340F96131B80E9","2020-03-05T07:02:39","c3c3VWU5Z0RDOjY0MkZENDVGOENGQkM4Q0I4QzM0MEY5NjEzMUI4MEU5Oj1yc6kNtdZWQrwAhIGgKg2+MfM1cy4LloYD39NWfOms"],
+        ["mYCWPXSx8","eDsEdnL9Ic4AJKve","7129F032ABC0C0038A5DE2CD61DC0435","2020-02-15T14:02:26","bVlDV1BYU3g4OjcxMjlGMDMyQUJDMEMwMDM4QTVERTJDRDYxREMwNDM1Ovsnt3Dzh8e5n9CpiZX8PSJ4JqtajRGDZUIAxZxAoynr"],
+        ["lmtv9HsWI","JOt5dH41lMrSUZJi","5BE9868B5F42C61B986BD3D654BF6613","2020-01-27T21:02:13","bG10djlIc1dJOjVCRTk4NjhCNUY0MkM2MUI5ODZCRDNENjU0QkY2NjEzOoUAiGITnda4EB2YHx/8zGP3FBgIHYkVU0d3PKYk3Paj"],
+        ["ANWG7Vm0M","nCg3HeqhaDps6TZW","D3CF885E78D029AFFF6556B671EA5218","2020-01-09T04:02","QU5XRzdWbTBNOkQzQ0Y4ODVFNzhEMDI5QUZGRjY1NTZCNjcxRUE1MjE4OsBwvBUChvSNpwfUDhiojDldWGSi/X4/TyEIlWH7sf4m"],
+        ["8M9drxQ8S","SfHLDlkF3ITHumKP","32948557E8846D6D50405510EB6361EF","2019-12-21T11:01:47","OE05ZHJ4UThTOjMyOTQ4NTU3RTg4NDZENkQ1MDQwNTUxMEVCNjM2MUVGOnGfxF1TmrtTGXr7wBlnhlvfcUCPHQnuvPsQNh+2iXt9"],
+        ["PeA2oninT","xqs5MiXQMAq9vkO3","48D1E13E27C7CDA944465B53AF0215C2","2019-12-02T18:01:34","UGVBMm9uaW5UOjQ4RDFFMTNFMjdDN0NEQTk0NDQ2NUI1M0FGMDIxNUMyOugLjVkPR/iaRizSSFnAA01h8Ta7qlPf57K8wRx27FGC"],
+        ["HDrdtwL2N","4WvdGVEj1d3eguPJ","0FD35319FEF366A019971715703122E1","2019-11-14T01:01:21","SERyZHR3TDJOOjBGRDM1MzE5RkVGMzY2QTAxOTk3MTcxNTcwMzEyMkUxOkgBNqCfcWnlSP1MtmULpRVm4RbVY+gAaIKx6wTNKwZS"],
+        ["IvNuNrAns","KTodzmawZlql3lwt","6B315F760CF4F1503FCD697DE6F7707F","2019-10-26T08:01:08","SXZOdU5yQW5zOjZCMzE1Rjc2MENGNEYxNTAzRkNENjk3REU2Rjc3MDdGOlTnuUcLSpMVtK6a10hrQBeornjKy7KwPA/I3h20FsYt"],
+        ["5e0V6iMOr","vsVvLLOTQcQWfuPe","1F3E63C31ADBDEB3F5C922CCA3895CD8","2019-10-07T15:00:55","NWUwVjZpTU9yOjFGM0U2M0MzMUFEQkRFQjNGNUM5MjJDQ0EzODk1Q0Q4Osl239n0tQLwq3MgzdqJmqqySMRYcx6rbG6vw2+I8B1h"],
+        ["Zw6vcdEB6","MvjxOH6gDF8cByud","91B4FE721B9E39C5B078687541D01A8F","2019-09-18T22:00:42","Wnc2dmNkRUI2OjkxQjRGRTcyMUI5RTM5QzVCMDc4Njg3NTQxRDAxQThGOji6+2vTwoR8OjrMpbJ9VY+HrDlRk7BXe1zJAWZxoR3m"],
+        ["v26Otxsyz","iUltF2cHM8kwBOxO","F33A3AAA272685E583E542C363D5FD96","2019-08-31T05:00:29","djI2T3R4c3l6OkYzM0EzQUFBMjcyNjg1RTU4M0U1NDJDMzYzRDVGRDk2Og1NJjSdJec/W0HdPkFPY8reYq3eK2ow3fEmPmwKKeJg"],
+        ["SgnphnJP6","zgV5VlZL2zDGEHyG","FC08F615D14E4396DBB63EB87E6DBD91","2019-08-12T12:00:16","U2ducGhuSlA2OkZDMDhGNjE1RDE0RTQzOTZEQkI2M0VCODdFNkRCRDkxOnta4KFmRnx/yxxMSEYauBN8YwG/rDdJS7UOiLRY+n8t"],
+        ["G7kd2YHP2","W5WP1tbKYu1o9dqS","3FAA3261E9EED86070F2C99BF3131847","2019-07-24T19:00:03","RzdrZDJZSFAyOjNGQUEzMjYxRTlFRUQ4NjA3MEYyQzk5QkYzMTMxODQ3OggmHx3ty1IlKr+IQnqakqVLYFcLO5wd5EYy0cxVjV/f"],
+        ["6Q3WoEfYC","J5gI4aUpHVtA5Suf","EBB8C8905DDB2C4081FAFF20818A73F6","2019-07-06T01:59:50","NlEzV29FZllDOkVCQjhDODkwNUREQjJDNDA4MUZBRkYyMDgxOEE3M0Y2OnTpx4Gc8B6UHpRxxmZuLmCmWn1dbuPL6NeFV8pxN31v"],
+        ["auijI3nyS","OU4Z7Svh7hKZImXX","6DE371427723FF6CE9D604925C610333","2019-06-17T08:59:37","YXVpakkzbnlTOjZERTM3MTQyNzcyM0ZGNkNFOUQ2MDQ5MjVDNjEwMzMzOiE83C7NO90jyE0Rpo9Kb0UuMoEcUuUZRtULazrvzBKP"],
+        ["94JCLlSzp","fkKMaZlisNWEQzJ7","F9929A12E86121D75BD40B6F9D0A7783","2019-05-29T15:59:24","OTRKQ0xsU3pwOkY5OTI5QTEyRTg2MTIxRDc1QkQ0MEI2RjlEMEE3NzgzOoioe2F/SEDYMU1RRqAph8+xpOomlct3PtqT0GsZdEeO"],
+        ["7y2nWixPc","Z4U3Ly0yls1Bygkd","213E32F0F98BF6AA9F5C201B3F1683C8","2019-05-10T22:59:11","N3kybldpeFBjOjIxM0UzMkYwRjk4QkY2QUE5RjVDMjAxQjNGMTY4M0M4OrWF87svGfZJdQyXuUQqrdS0+Y27qiHuub0eqg5J3IQ5"],
+        ["IN4k12HJz","EmBqZaOktTC4vVJE","257FA0020CC89727D1996053EC48D427","2019-04-22T05:58:58","SU40azEySEp6OjI1N0ZBMDAyMENDODk3MjdEMTk5NjA1M0VDNDhENDI3OsO/hAllOkfhZOr7tZop8Z8FRFQeqL8eqJ2GGjs7M2qQ"],
+        ["G60QusAjJ","VVazjlgrgGxqV1Np","EEA45C78A28B2849270EA1E67BC22BBF","2019-04-03T12:58:45","RzYwUXVzQWpKOkVFQTQ1Qzc4QTI4QjI4NDkyNzBFQTFFNjdCQzIyQkJGOi/RQgaWXQqYs9GHh5oSy+WkC3Pzwzgu0Ua+vlHxqLni"],
+        ["pgM3vQwvZ","XcIF5R7tMbsOu3fs","5FFE3AD3D912F75CEFD5BBBDF51DA8FD","2019-03-15T19:58:32","cGdNM3ZRd3ZaOjVGRkUzQUQzRDkxMkY3NUNFRkQ1QkJCREY1MURBOEZEOhNlEQUDcGsIgQtObT5I/ZCuK9DrVjX4sytrn43JfefS"],
+        ["gX1zl94d8","ycvUWcoU6FnWptVZ","3FBD83CDFDBC53B89F8E9C101DC52577","2019-02-25T02:58:19","Z1gxemw5NGQ4OjNGQkQ4M0NERkRCQzUzQjg5RjhFOUMxMDFEQzUyNTc3OkkeurytcvmHh6JlmPx1TxorZ4mka6XhJzgO91Wbx1q9"],
+        ["ncicPapCa","ZpsDUzIZzAeLHgIJ","019B54A4AFC5E4C7187BC863871BA98C","2019-02-06T09:58:06","bmNpY1BhcENhOjAxOUI1NEE0QUZDNUU0QzcxODdCQzg2Mzg3MUJBOThDOmJIPoiFJj3rDuRyUoGu87DBqDpYWsMxNSbT1Z5PZ9Np"],
+        ["2VCCeWYII","1NpLprJI4EXPr7lw","034931F44CFAD6072B5D69972E10E934","2019-01-18T16:57:53","MlZDQ2VXWUlJOjAzNDkzMUY0NENGQUQ2MDcyQjVENjk5NzJFMTBFOTM0OvrsfsZhD1VSxwlWKd43QsvuNi5KulQ5JbdCWbgaUL6Z"]
+    ]
+
+    data.each_with_index do |item, index|
+      it "should test data for item #{index}" do
+        expect(item.size).to eq(5)
+        key = CityPayApiClient::ApiKey.new(client_id: item[0], licence_key: item[1])
+        key.nonce = item[2]
+        key.datetime = DateTime.parse(item[3], "%Y-%m-dT%H:%M:%S")
+        key.generate.should eq(item[4])
+      end
+    end
+
+
+  end
+
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: citypay_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - citypay
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -78,8 +78,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
+- citypay_api-1.0.1.gem
 - citypay_api_client.gemspec
 - docs/AccountCreate.md
 - docs/AccountStatus.md
@@ -164,6 +166,7 @@ files:
 - spec/models/acknowledgement_spec.rb
 - spec/models/airline_advice_spec.rb
 - spec/models/airline_segment_spec.rb
+- spec/models/api_key_spec.rb
 - spec/models/auth_reference_spec.rb
 - spec/models/auth_references_spec.rb
 - spec/models/auth_request_spec.rb
@@ -192,9 +195,9 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/citypay/citypay-api-client-ruby
 licenses:
-- Unlicense
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A ruby wrapper for the CityPay API
 test_files:
@@ -231,6 +234,7 @@ test_files:
 - spec/models/c_res_auth_request_spec.rb
 - spec/models/airline_segment_spec.rb
 - spec/models/card_spec.rb
+- spec/models/api_key_spec.rb
 - spec/models/auth_references_spec.rb
 - spec/models/list_merchants_response_spec.rb
 - spec/models/void_request_spec.rb