blockchyp 2.3.5 → 2.6.0

data/lib/blockchyp.rb

@@ -47,7 +47,7 @@ module BlockChyp
   class BlockChyp < BlockChypClient
 
     def heartbeat(test)
-      gateway_request('GET', '/api/heartbeat', {'test' => test})
+      gateway_request('GET', '/api/heartbeat', { test: test })
     end
 
     # Tests connectivity with a payment terminal.
@@ -206,5 +206,10 @@ module BlockChyp
       gateway_request('POST', '/api/tx-history', request)
     end
 
+    # Returns profile information for a merchant.
+    def merchant_profile(request)
+      gateway_request('POST', '/api/public-merchant-profile', request)
+    end
+
   end
 end

data/lib/blockchyp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlockChyp
-  VERSION = '2.3.5'
+  VERSION = '2.6.0'
 end

data/lib/blockchyp_client.rb

@@ -45,6 +45,7 @@ module BlockChyp
     attr_accessor :offline_cache_enabled
     attr_accessor :terminal_connect_timeout
     attr_accessor :route_cache_location
+    attr_accessor :route_cache
 
     def generate_gateway_headers
       nonce = CryptoUtils.generate_nonce
@@ -66,32 +67,28 @@ module BlockChyp
     end
 
     def resolve_gateway_uri(path, request)
-      url = if request.nil? || !request['test']
-              gateway_host
-            else
-              test_gateway_host
-            end
+      url = request.nil? || !request[:test] ? gateway_host : test_gateway_host
 
-      URI.parse(url + path)
+      URI.parse(path.nil? ? url : url + path)
     end
 
     def generate_error_response(msg)
-      [
-        'success' => false,
-        'error' => msg,
-        'responseDescription' => msg
-      ]
+      {
+        success: false,
+        error: msg,
+        responseDescription: msg
+      }
     end
 
     def route_terminal_request(method, terminal_path, gateway_path, request)
-      if request['terminalName'].nil?
+      unless request.key?(:terminalName)
         return gateway_request(method, gateway_path, request)
       end
 
-      route = resolve_terminal_route(request['terminalName'])
+      route = resolve_terminal_route(request[:terminalName])
       if !route
         return generate_error_response('Unkown Terminal')
-      elsif route['cloudRelayEnabled']
+      elsif route[:cloudRelayEnabled]
         return gateway_request(method, gateway_path, request, relay: true)
       end
 
@@ -106,13 +103,13 @@ module BlockChyp
       http.open_timeout = timeout
       http.read_timeout = timeout
 
-      tx_creds = route['transientCredentials']
+      tx_creds = route[:transientCredentials]
 
       wrapped_request = {
-        'apiKey' => tx_creds['apiKey'],
-        'bearerToken' => tx_creds['bearerToken'],
-        'signingKey' => tx_creds['signingKey'],
-        'request' => request
+        apiKey: tx_creds[:apiKey],
+        bearerToken: tx_creds[:bearerToken],
+        signingKey: tx_creds[:signingKey],
+        request: request
       }
 
       req = get_http_request(method, uri)
@@ -127,14 +124,14 @@ module BlockChyp
         response = http.request(req)
       rescue Net::OpenTimeout, Errno::EHOSTDOWN, Errno::EHOSTUNREACH, Errno::ETIMEDOUT, Errno::ENETUNREACH
         if open_retry
-          evict(route['terminalName'])
-          route = resolve_terminal_route(route['terminalName'])
+          evict(route[:terminalName])
+          route = resolve_terminal_route(route[:terminalName])
           return terminal_request(method, route, path, request, false)
         end
         raise
       end
       if response.is_a?(Net::HTTPSuccess)
-        JSON.parse(response.body)
+        JSON.parse(response.body, symbolize_names: true)
       else
         raise response.message
       end
@@ -157,7 +154,7 @@ module BlockChyp
             else
               'http://'
             end
-      url += route['ipAddress']
+      url += route[:ipAddress]
       port = if https
                ':8443'
              else
@@ -192,14 +189,12 @@ module BlockChyp
       response = http.request(req)
 
       if response.is_a?(Net::HTTPSuccess)
-        JSON.parse(response.body)
+        JSON.parse(response.body, symbolize_names: true)
       else
         raise response.message
       end
     end
 
-    attr_accessor :routeCache
-
     def resolve_terminal_route(terminal_name)
       route = route_cache_get(terminal_name, false)
 
@@ -211,8 +206,8 @@ module BlockChyp
 
         ttl = Time.now.utc + (route_cache_ttl * 60)
         route_cache_entry = {}
-        route_cache_entry['route'] = route
-        route_cache_entry['ttl'] = ttl
+        route_cache_entry[:route] = route
+        route_cache_entry[:ttl] = ttl
         @route_cache[api_key + terminal_name] = route_cache_entry
         update_offline_cache(route_cache_entry)
       end
@@ -223,14 +218,14 @@ module BlockChyp
       if offline_cache_enabled
         offline_cache = read_offline_cache
         offline_entry = route_cache_entry.clone
-        route = route_cache_entry['route'].clone
-        tx_creds = route['transientCredentials'].clone
-        tx_creds['apiKey'] = encrypt(tx_creds['apiKey'])
-        tx_creds['bearerToken'] = encrypt(tx_creds['bearerToken'])
-        tx_creds['signingKey'] = encrypt(tx_creds['signingKey'])
-        route['transientCredentials'] = tx_creds
-        offline_entry['route'] = route
-        offline_cache[api_key + route['terminalName']] = offline_entry
+        route = route_cache_entry[:route].clone
+        tx_creds = route[:transientCredentials].clone
+        tx_creds[:apiKey] = encrypt(tx_creds[:apiKey])
+        tx_creds[:bearerToken] = encrypt(tx_creds[:bearerToken])
+        tx_creds[:signingKey] = encrypt(tx_creds[:signingKey])
+        route[:transientCredentials] = tx_creds
+        offline_entry[:route] = route
+        offline_cache[api_key + route[:terminalName]] = offline_entry
         File.write(route_cache_location, offline_cache.to_json)
       end
     end
@@ -270,8 +265,8 @@ module BlockChyp
 
     def request_route_from_gateway(terminal_name)
       route = gateway_request('GET', '/api/terminal-route?terminal=' + CGI.escape(terminal_name))
-      if !route.nil? && !route['ipAddress'].empty?
-        route['exists'] = true
+      if !route.nil? && !route[:ipAddress].empty?
+        route[:exists] = true
       end
       route
     end
@@ -293,25 +288,20 @@ module BlockChyp
       end
 
       if route_cache_entry
-        route = route_cache_entry['route']
-        tx_creds = route['transientCredentials']
-        tx_creds['apiKey'] = decrypt(tx_creds['apiKey'])
-        tx_creds['bearerToken'] = decrypt(tx_creds['bearerToken'])
-        tx_creds['signingKey'] = decrypt(tx_creds['signingKey'])
-        route['transientCredentials'] = tx_creds
-        route_cache_entry['route'] = route
-      end
+        route = route_cache_entry[:route]
+        tx_creds = route[:transientCredentials]
+        tx_creds[:apiKey] = decrypt(tx_creds[:apiKey])
+        tx_creds[:bearerToken] = decrypt(tx_creds[:bearerToken])
+        tx_creds[:signingKey] = decrypt(tx_creds[:signingKey])
+        route[:transientCredentials] = tx_creds
+        route_cache_entry[:route] = route
 
-      if route_cache_entry
-        now = Time.new
-        raw_ttl = route_cache_entry['ttl']
-        if raw_ttl.instance_of?(Time)
-          ttl = raw_ttl
-        else
-          ttl = Time.parse(route_cache_entry['ttl'])
-        end
-        if stale || now < ttl
-          route_cache_entry['route']
+        raw_ttl = route_cache_entry[:ttl]
+
+        ttl = raw_ttl.instance_of?(Time) ? raw_ttl : Time.parse(route_cache_entry[:ttl])
+
+        if stale || Time.new < ttl
+          route_cache_entry[:route]
         end
       end
     end
@@ -322,7 +312,7 @@ module BlockChyp
         config_file = File.open(route_cache_location)
         content = config_file.read
 
-        return JSON.parse(content)
+        return JSON.parse(content, symbolize_names: true)
       end
       {}
     end
@@ -331,16 +321,16 @@ module BlockChyp
       if defined? VERSION
         "BlockChyp-Ruby/#{VERSION}"
       else
-        "BlockChyp-Ruby"
+        'BlockChyp-Ruby'
       end
     end
 
     def get_timeout(request, default)
-      if request.nil? || request['timeout'].nil? || request['timeout'].zero?
+      if request.nil? || !request.key?(:timeout) || request[:timeout].zero?
         return default
       end
 
-      request['timeout']
+      request[:timeout]
     end
   end
 end

data/test/batch_history_test.rb

@@ -14,35 +14,35 @@ module BlockChyp
       config = load_test_config
 
       blockchyp = BlockChyp.new(
-        config['apiKey'],
-        config['bearerToken'],
-        config['signingKey']
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
       )
-      blockchyp.gateway_host = config['gatewayHost']
-      blockchyp.test_gateway_host = config['testGatewayHost']
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
 
       test_delay(blockchyp, 'batch_history_test')
 
       # Set request parameters
       setup_request = {
-        "pan": '4111111111111111',
-        "amount": '25.55',
-        "test": true,
-        "transactionRef": uuid
+        pan: '4111111111111111',
+        amount: '25.55',
+        test: true,
+        transactionRef: uuid
       }
 
       response = blockchyp.charge(setup_request)
 
       # Set request parameters
       request = {
-        "maxResults": 10
+        maxResults: 10
       }
 
       response = blockchyp.batch_history(request)
 
       assert_not_nil(response)
       # response assertions
-      assert(response['success'])
+      assert(response[:success])
     end
   end
 end

data/test/boolean_prompt_test.rb

@@ -14,30 +14,30 @@ module BlockChyp
       config = load_test_config
 
       blockchyp = BlockChyp.new(
-        config['apiKey'],
-        config['bearerToken'],
-        config['signingKey']
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
       )
-      blockchyp.gateway_host = config['gatewayHost']
-      blockchyp.test_gateway_host = config['testGatewayHost']
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
 
       test_delay(blockchyp, 'boolean_prompt_test')
 
       # Set request parameters
       request = {
-        "test": true,
-        "terminalName": 'Test Terminal',
-        "prompt": 'Would you like to become a member?',
-        "yesCaption": 'Yes',
-        "noCaption": 'No'
+        test: true,
+        terminalName: 'Test Terminal',
+        prompt: 'Would you like to become a member?',
+        yesCaption: 'Yes',
+        noCaption: 'No'
       }
 
       response = blockchyp.boolean_prompt(request)
 
       assert_not_nil(response)
       # response assertions
-      assert(response['success'])
-      assert(response['response'])
+      assert(response[:success])
+      assert(response[:response])
     end
   end
 end

data/test/capture_signature_test.rb

@@ -14,27 +14,27 @@ module BlockChyp
       config = load_test_config
 
       blockchyp = BlockChyp.new(
-        config['apiKey'],
-        config['bearerToken'],
-        config['signingKey']
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
       )
-      blockchyp.gateway_host = config['gatewayHost']
-      blockchyp.test_gateway_host = config['testGatewayHost']
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
 
       test_delay(blockchyp, 'capture_signature_test')
 
       # Set request parameters
       request = {
-        "terminalName": 'Test Terminal',
-        "sigFormat": SignatureFormat::PNG,
-        "sigWidth": 200
+        terminalName: 'Test Terminal',
+        sigFormat: SignatureFormat::PNG,
+        sigWidth: 200
       }
 
       response = blockchyp.capture_signature(request)
 
       assert_not_nil(response)
       # response assertions
-      assert(response['success'])
+      assert(response[:success])
     end
   end
 end

data/test/gateway_timeout_test.rb

@@ -14,22 +14,22 @@ module BlockChyp
       config = load_test_config
 
       blockchyp = BlockChyp.new(
-        config['apiKey'],
-        config['bearerToken'],
-        config['signingKey']
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
       )
-      blockchyp.gateway_host = config['gatewayHost']
-      blockchyp.test_gateway_host = config['testGatewayHost']
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
 
       test_delay(blockchyp, 'gateway_timeout_test')
 
       # Set request parameters
       request = {
-        "timeout": 1,
-        "pan": '5555555555554444',
-        "amount": '25.55',
-        "test": true,
-        "transactionRef": uuid
+        timeout: 1,
+        pan: '5555555555554444',
+        amount: '25.55',
+        test: true,
+        transactionRef: uuid
       }
 
       assert_raise Net::ReadTimeout do

data/test/get_customer_test.rb

@@ -14,23 +14,23 @@ module BlockChyp
       config = load_test_config
 
       blockchyp = BlockChyp.new(
-        config['apiKey'],
-        config['bearerToken'],
-        config['signingKey']
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
       )
-      blockchyp.gateway_host = config['gatewayHost']
-      blockchyp.test_gateway_host = config['testGatewayHost']
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
 
       test_delay(blockchyp, 'get_customer_test')
 
       # Set request parameters
       setup_request = {
-        "customer": {
-          "firstName": 'Test',
-          "lastName": 'Customer',
-          "companyName": 'Test Company',
-          "emailAddress": 'support@blockchyp.com',
-          "smsNumber": '(123) 123-1234'
+        customer: {
+          firstName: 'Test',
+          lastName: 'Customer',
+          companyName: 'Test Company',
+          emailAddress: 'support@blockchyp.com',
+          smsNumber: '(123) 123-1234'
         }
       }
 
@@ -38,14 +38,14 @@ module BlockChyp
 
       # Set request parameters
       request = {
-        "customerId": response['customer']['id']
+        customerId: response[:customer][:id]
       }
 
       response = blockchyp.customer(request)
 
       assert_not_nil(response)
       # response assertions
-      assert(response['success'])
+      assert(response[:success])
     end
   end
 end