levelup 0.9.4 → 0.9.5

data/lib/levelup/requests/list_orders.rb

@@ -1,8 +1,7 @@
 module Levelup
   module Requests
-    # Represents a request to list all orders made at a
-    # specified location. This is a v14 request and should not be expected to
-    # remain functional indefinitely.
+    # Represents a request to list all orders made at a specified location.
+    # This is a v14 request and should not be expected to remain functional indefinitely.
     class ListOrders < Base
       include Templates::MerchantAuthenticated
 

data/lib/levelup/requests/list_user_orders.rb

@@ -1,8 +1,7 @@
- module Levelup
+module Levelup
   module Requests
-    # Represents a request to create an address for a
-    # specific user. For information about its parameters, see UserAddressData
-    # and UserAuthenticated.
+    # Represents a request to create an address for a specific user.
+    # For information about its parameters, see UserAddressData and UserAuthenticated.
     # User access token must have the read_user_orders permission.
     class ListUserOrders < Base
       include Templates::UserAuthenticated

data/lib/levelup/requests/show_permissions_request.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Requests
-    # Represents a request to show the status of a specified permissions
-    # request.
+    # Represents a request to show the status of a specified permissions request.
     class ShowPermissionsRequest < Base
       include Templates::AppAuthenticated
 

data/lib/levelup/responses/success_paginated.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Responses
-    # Class that encapsulates a successful response from a paginated endpoint
-    # of the LevelUp API.
+    # Class that encapsulates a successful response from a paginated endpoint of the LevelUp API.
     class SuccessPaginated < Success
       attr_writer :next_page_request, :next_page
 

data/lib/levelup/templates/app_authenticated.rb

@@ -1,9 +1,7 @@
 module Levelup
   module Templates
     # A template to apply to any requests requiring app authentication.
-    #
-    # Authentication template - only apply one authentication template per
-    # request.
+    # Authentication template - only apply one authentication template per request.
     module AppAuthenticated
       # An access token for an app.
       attr_accessor :app_access_token

data/lib/levelup/templates/merchant_and_user_authenticated.rb

@@ -1,16 +1,11 @@
 module Levelup
   module Templates
-    # A template to apply to any requests requiring both merchant and user
-    # authentication.
-    #
-    # Authentication template - only apply one authentication template per
-    # request.
+    # A template to apply to any requests requiring both merchant and user authentication.
+    # Authentication template - only apply one authentication template per request.
     module MerchantAndUserAuthenticated
-      # An access token for a merchant that has granted you
-      # 'manage_merchant_orders' permissions.
+      # An access token for a merchant that has granted you 'manage_merchant_orders' permissions.
       attr_accessor :merchant_access_token
-      # An access token for a user that has granted you 'create_orders'
-      # permissions.
+      # An access token for a user that has granted you 'create_orders' permissions.
       attr_accessor :user_access_token
 
       def auth_type

data/lib/levelup/templates/merchant_authenticated.rb

@@ -3,12 +3,9 @@ module Levelup
     # A template to apply to any requests requiring v15 merchant authentication.
     # If your request requires v14 merchant authentication, include this module
     # and define auth_type as :merchant_v14.
-    #
-    # Authentication template - only apply one authentication template per
-    # request.
+    # Authentication template - only apply one authentication template per request.
     module MerchantAuthenticated
-      # An access token for a merchant that has granted you
-      # 'manage_merchant_orders' permissions.
+      # An access token for a merchant that has granted you 'manage_merchant_orders' permissions.
       attr_accessor :merchant_access_token
 
       def auth_type

data/lib/levelup/utils/payment_calculator.rb

@@ -0,0 +1,83 @@
+module Levelup
+  module Utils
+    # This is a tool to allow integrators to calculate various values to discount and tender
+    class PaymentCalculator
+      # @param discount_applied [Integer] The total LevelUp discount applied to the check.
+      # @param gift_card_credit_available [Integer] The total available amount of LevelUp gift card
+      #   credit.
+      # @param spend_amount_returned_from_levelup [Integer] The amount of spend returned from the
+      #   LevelUp API.
+      # @param tip_returned_from_levelup [Integer] The tip returned from the LevelUp API.
+      def initialize(discount_applied:, gift_card_credit_available:,
+          spend_amount_returned_from_levelup:, tip_returned_from_levelup:)
+        @discount_applied = discount_applied
+        @gift_card_credit_available = gift_card_credit_available
+        @spend_amount_returned_from_levelup = spend_amount_returned_from_levelup
+        @tip_returned_from_levelup = tip_returned_from_levelup
+      end
+
+      # Calculates the LevelUp discount to apply based on the arguments passed
+      # @param check_total_due_including_tax [Integer] Grand total of check balance in cents
+      # @param exempted_item_total [Integer] Combined total of exempted items in cents
+      # @param merchant_funded_credit_available [Integer] Total amount of merchant funded credit
+      #   available in cents
+      # @param payment_amount_requested [Integer] Spend amount requested from LevelUp API order
+      #   endpoint in cents
+      # @param tax_amount_due [Integer] Total amount of tax due on the check
+      def self.levelup_discount_to_apply(check_total_due_including_tax:, exempted_item_total:,
+          merchant_funded_credit_available:, payment_amount_requested:, tax_amount_due:)
+        total_due_without_tax = check_total_due_including_tax - tax_amount_due
+        max_discount = [payment_amount_requested, total_due_without_tax].min
+        max_discount_less_exemptions = [0,  max_discount - exempted_item_total].max
+        [merchant_funded_credit_available, max_discount_less_exemptions].min
+      end
+
+      # Cent amount of LevelUp gift card payment to apply NOT including tip
+      def gift_card_payment_to_apply
+        [spend_amount_after_discount, @gift_card_credit_available].min
+      end
+
+      # Remaining balance in cents on LevelUp gift card after gift card payment has been applied
+      def gift_card_remaining_balance_after_payment
+        [0, @gift_card_credit_available - total_gift_card_payment_to_apply_including_tip].max
+      end
+
+      # Cent amount of LevelUp gift card tip to apply NOT including LevelUp gift card payment
+      def gift_card_tip_to_apply
+        total_gift_card_payment_to_apply_including_tip - gift_card_payment_to_apply
+      end
+
+      # Cent amount of LevelUp payment to apply NOT including the tip amount
+      def levelup_payment_to_apply
+        [0, spend_amount_after_discount - @gift_card_credit_available].max
+      end
+
+      # Cent amount of LevelUp tip to apply NOT including payment amount
+      def levelup_tip_to_apply
+        total_levelup_payment_to_apply_including_tip - levelup_payment_to_apply
+      end
+
+      # Total amount in cents of LevelUp payment to apply including both tip AND payment amounts
+      def total_levelup_payment_to_apply_including_tip
+        [0, total_amount_after_discount - @gift_card_credit_available].max
+      end
+
+      private
+
+      # Spend amount in cents after discount is subtracted
+      def spend_amount_after_discount
+        [0, @spend_amount_returned_from_levelup - @discount_applied].max
+      end
+
+      # Total amount in cents including tip after discount is subtracted
+      def total_amount_after_discount
+        spend_amount_after_discount + @tip_returned_from_levelup
+      end
+
+      # Total amount in cents of LevelUp gift card payment to apply including tip
+      def total_gift_card_payment_to_apply_including_tip
+        [total_amount_after_discount, @gift_card_credit_available].min
+      end
+    end
+  end
+end

data/spec/endpoints/access_tokens_spec.rb

@@ -58,8 +58,7 @@ describe 'Levelup::Endpoints::AccessTokens', vcr: true do
             password: TestConfig.merchant_password
           )
 
-        response = @test_client.access_tokens.
-          create_for_merchant(merchant_auth_request)
+        response = @test_client.access_tokens.create_for_merchant(merchant_auth_request)
         expect(response).to be_success
         expect(response.token).to_not be_nil
       end
@@ -72,8 +71,7 @@ describe 'Levelup::Endpoints::AccessTokens', vcr: true do
           username: 'username_wrong',
           password: 'password1'
         )
-        response = @test_client.access_tokens.
-          create_for_merchant(merchant_auth_request)
+        response = @test_client.access_tokens.create_for_merchant(merchant_auth_request)
         expect(response).to_not be_success
       end
     end

data/spec/endpoints/app_users_spec.rb

@@ -11,9 +11,12 @@ describe 'Levelup::Endpoints::AppUsers', vcr: true do
   describe '#create' do
     it 'creates a user' do
       response = @test_client.apps.users.create(
-        email: 'some@email.com',
-        first_name: 'firstname',
-        last_name: 'lastname',
+        api_key: TestConfig.api_key_valid,
+        user: {
+          email: 'some' + SecureRandom.hex(3) + '@example.com',
+          first_name: 'firstname',
+          last_name: 'lastname'
+        },
         permission_keynames: ['create_orders']
       )
 
@@ -21,23 +24,4 @@ describe 'Levelup::Endpoints::AppUsers', vcr: true do
       expect(response.user.last_name).to eq('lastname')
     end
   end
-
-  describe '#get' do
-    context 'with an invalid access token' do
-      it 'returns an error response' do
-        response = @test_client.apps.users.get('invalid')
-        expect(response).to_not be_success
-      end
-    end
-
-    context 'with a valid access token' do
-      it 'returns the user\'s info' do
-        response = @test_client.apps.users.get(
-          TestConfig.user_token_with_read_info_perms)
-
-        expect(response).to be_success
-        expect(response.email).to_not be_nil
-      end
-    end
-  end
 end

data/spec/endpoints/location_credit_spec.rb

@@ -13,8 +13,7 @@ describe 'Levelup::Endpoints::LocationCredit', vcr: true do
 
     context 'with an invalid user token' do
       it 'returns an error response' do
-        response = @test_client.locations(TestConfig.location_id).credit.
-          get('1234')
+        response = @test_client.locations(TestConfig.location_id).credit.get('1234')
         expect(response).to_not be_success
       end
     end

data/spec/endpoints/location_merchant_funded_credit_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Levelup::Endpoints::LocationMerchantFundedCredit', vcr: true do
+  describe '#get' do
+    it 'gets a users credit' do
+      response = @test_client.locations(TestConfig.location_id).merchant_funded_credit.
+        get(TestConfig.user_qr_code, TestConfig.merchant_token_with_manage_orders_perms)
+
+      expect(response).to be_success
+    end
+  end
+end

data/spec/endpoints/location_orders_spec.rb

@@ -16,8 +16,8 @@ describe 'Levelup::Endpoints::LocationOrders', vcr: true do
   describe '#list' do
     context 'with a valid location' do
       it 'returns a list of orders' do
-        response = @test_client.locations(TestConfig.location_id).
-          orders.list(@test_merchant_auth_token)
+        response = @test_client.locations(TestConfig.location_id).orders.
+          list(@test_merchant_auth_token)
         expect(response).to be_success
         expect(response.orders).to_not be_nil
       end
@@ -25,8 +25,7 @@ describe 'Levelup::Endpoints::LocationOrders', vcr: true do
 
     context 'with an invalid location' do
       it 'returns an error response' do
-        response = @test_client.locations(-25).orders.
-          list(@test_merchant_auth_token)
+        response = @test_client.locations(-25).orders.list(@test_merchant_auth_token)
         expect(response).to_not be_success
       end
     end

data/spec/endpoints/merchant_funded_credits_spec.rb

@@ -6,8 +6,7 @@ describe 'Levelup::Endpoints::MerchantFundedCredits', vcr: true do
       response = @test_client.merchant_funded_credits.give(
         email: 'pos@thelevelup.com',
         value_amount: 5,
-        merchant_access_token: TestConfig.
-          merchant_token_with_grant_credit_perms
+        merchant_access_token: TestConfig.merchant_token_with_grant_credit_perms
       )
 
       expect(response).to be_success

data/spec/endpoints/merchant_locations_spec.rb

@@ -17,8 +17,8 @@ describe 'Levelup::Endpoints::MerchantLocations', vcr: true do
   describe '#list' do
     context 'with a valid merchant' do
       it 'returns a successful list-locations response' do
-        response = @test_client.merchants(@test_merchant_id).locations.
-          list(@test_merchant_auth_token)
+        response = @test_client.merchants(@test_merchant_id).locations.list(
+          @test_merchant_auth_token)
         expect(response).to be_success
         expect(response.locations).to_not be_nil
       end
@@ -26,8 +26,8 @@ describe 'Levelup::Endpoints::MerchantLocations', vcr: true do
 
     context 'with an invalid merchant' do
       it 'returns an error response' do
-        response = @test_client.merchants(-25).locations.
-          list(@test_merchant_auth_token)
+        response = @test_client.merchants(-25).locations.list(
+          @test_merchant_auth_token)
         expect(response).to_not be_success
       end
     end

data/spec/endpoints/qr_codes_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 describe 'Levelup::Endpoints::QrCodes', vcr: true do
   describe '#get' do
     it 'retrieves a user\'s QR code' do
-      response = @test_client.qr_codes.get(TestConfig.
-        user_token_with_read_qr_perms)
+      response = @test_client.qr_codes.get(TestConfig.user_token_with_read_qr_perms)
       expect(response).to be_success
       expect(response.code).to_not be_nil
     end

data/spec/endpoints/specific_order_spec.rb

@@ -4,8 +4,7 @@ describe 'Levelup::Endpoints::SpecificOrder', vcr: true do
   describe '#refund' do
     context 'with an invalid UUID' do
       it 'returns an error response' do
-        response = @test_client.orders('0').
-          refund(@merchant_token_with_create_privs)
+        response = @test_client.orders('0').refund(@merchant_token_with_create_privs)
         expect(response).to_not be_success
       end
     end
@@ -23,8 +22,8 @@ describe 'Levelup::Endpoints::SpecificOrder', vcr: true do
         )
         expect(order_response).to be_success
 
-        refund_response = @test_client.orders(order_response.uuid).
-          refund(TestConfig.merchant_token_with_manage_orders_perms)
+        refund_response = @test_client.orders(order_response.uuid).refund(
+          TestConfig.merchant_token_with_manage_orders_perms)
         expect(refund_response).to be_success
         expect(refund_response.uuid).to eq(order_response.uuid)
       end

data/spec/endpoints/specific_permissions_request_spec.rb

@@ -15,8 +15,7 @@ describe 'Levelup::Endpoints::SpecificPermissionsRequest', vcr: true do
         permission_keynames: ['read_user_basic_info']
       )
 
-      response = @test_client.apps.permissions_requests(perms_request.id).
-        show
+      response = @test_client.apps.permissions_requests(perms_request.id).show
       expect(response).to be_success
       expect(response.permission_keynames).to eq(['read_user_basic_info'])
     end

data/spec/endpoints/user_addresses_spec.rb

@@ -33,8 +33,7 @@ describe 'Levelup::Endpoints::UserAddresses', vcr: true do
           TestConfig.user_token_with_manage_addresses_perms
         response = @test_client.user_addresses.create(test_request)
         expect(response).to be_success
-        expect(response.street_address).
-          to eq(@test_address_hash[:street_address])
+        expect(response.street_address).to eq(@test_address_hash[:street_address])
       end
     end
   end

data/spec/endpoints/user_orders_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 describe 'Levelup::Endpoints::UserOrders', vcr: true do
   describe '#list' do
     it 'returns a user\'s order history' do
-      response = @test_client.users.orders.
-        list(TestConfig.user_token_with_read_orders_perms)
+      response = @test_client.users.orders.list(TestConfig.user_token_with_read_orders_perms)
       expect(response).to be_success
       expect(response.orders).to_not be_nil
     end

data/spec/endpoints/users_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Levelup::Endpoints::GetUsers', vcr: true do
+  describe '#get' do
+    context 'with an invalid access token' do
+      it 'returns an error response' do
+        response = @test_client.users.get('invalid')
+        expect(response).to_not be_success
+      end
+    end
+
+    context 'with a valid access token' do
+      it 'returns the user\'s info' do
+        response = @test_client.users.get(
+          TestConfig.user_token_with_read_info_perms)
+
+        expect(response).to be_success
+        expect(response.email).to_not be_nil
+      end
+    end
+  end
+end

data/spec/{data_objects/requests → requests}/request_permissions_spec.rb

@@ -14,8 +14,7 @@ describe 'Levelup::Requests::RequestPermissions' do
 
   describe '#body' do
     it 'returns a hash wrapped in a permissions_request tag' do
-      expect(@test_user_permissions_request.body[:permissions_request]).
-        to_not be_nil
+      expect(@test_user_permissions_request.body[:permissions_request]).to eq({})
     end
   end
 end

data/spec/{data_objects/responses → responses}/success_paginated_spec.rb

@@ -35,8 +35,7 @@ describe 'Levelup::Responses::SuccessPaginated', vcr: true do
   describe '#next' do
     context 'with no next page' do
       it 'raises an InvalidRequest error' do
-        expect { @no_next_response.next }.
-          to raise_error(Levelup::Errors::InvalidRequest)
+        expect { @no_next_response.next }.to raise_error(Levelup::Errors::InvalidRequest)
       end
     end
 

data/spec/utils/payment_calculator/payment_calculator_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+describe 'Utils::PaymentCalculator::Calculate' do
+  describe '#calculate_levelup_discount_to_apply' do
+    context 'with merchant_funded_credit_available and no exemptions' do
+      it 'returns the proper amount of credit to apply' do
+        calculator = Levelup::Utils::PaymentCalculator.levelup_discount_to_apply(
+          check_total_due_including_tax: 110,
+          exempted_item_total: 0,
+          merchant_funded_credit_available: 50,
+          payment_amount_requested: 100,
+          tax_amount_due: 10
+        )
+        expect(calculator).to eq(50)
+      end
+    end
+
+    context 'with merchant_funded_credit_available with overriding exemptions' do
+      it 'returns the proper credit to apply minus exemptions' do
+        calculator = Levelup::Utils::PaymentCalculator.levelup_discount_to_apply(
+          check_total_due_including_tax: 110,
+          exempted_item_total: 80,
+          merchant_funded_credit_available: 50,
+          payment_amount_requested: 100,
+          tax_amount_due: 10
+        )
+        expect(calculator).to eq(20)
+      end
+    end
+
+    context 'with no merchant_funded_credit_available' do
+      it 'returns no credit to apply' do
+        calculator = Levelup::Utils::PaymentCalculator.levelup_discount_to_apply(
+          check_total_due_including_tax: 110,
+          exempted_item_total: 80,
+          merchant_funded_credit_available: 0,
+          payment_amount_requested: 100,
+          tax_amount_due: 10
+        )
+        expect(calculator).to eq(0)
+      end
+    end
+
+    context 'with more merchant_funded_credit available than amount due' do
+      it 'returns the max allowable mfc amount' do
+         calculator = Levelup::Utils::PaymentCalculator.levelup_discount_to_apply(
+          check_total_due_including_tax: 110,
+          exempted_item_total: 0,
+          merchant_funded_credit_available: 500,
+          payment_amount_requested: 100,
+          tax_amount_due: 10
+        )
+        expect(calculator).to eq(100)
+      end
+    end
+  end
+
+  describe '#calculate_tenders_and_tips' do
+    context 'with discount' do
+      it 'returns the proper tenders and values' do
+        calculator = Levelup::Utils::PaymentCalculator.new(
+          discount_applied: 1000,
+          gift_card_credit_available: 0,
+          spend_amount_returned_from_levelup: 1000,
+          tip_returned_from_levelup: 0
+        )
+        expect(calculator.gift_card_payment_to_apply).to be(0)
+        expect(calculator.gift_card_tip_to_apply).to be(0)
+        expect(calculator.levelup_payment_to_apply).to be(0)
+        expect(calculator.levelup_tip_to_apply).to be(0)
+      end
+    end
+
+    context 'with discount and gift card with tip' do
+      it 'returns the proper tenders and values' do
+        calculator = Levelup::Utils::PaymentCalculator.new(
+          discount_applied: 500,
+          gift_card_credit_available: 1000,
+          spend_amount_returned_from_levelup: 1000,
+          tip_returned_from_levelup: 500
+        )
+        expect(calculator.gift_card_payment_to_apply).to be(500)
+        expect(calculator.gift_card_tip_to_apply).to be(500)
+        expect(calculator.levelup_payment_to_apply).to be(0)
+        expect(calculator.levelup_tip_to_apply).to be(0)
+      end
+    end
+
+    context 'with discount and gift card and levelup tender' do
+      it 'returns the proper tenders and values' do
+        calculator = Levelup::Utils::PaymentCalculator.new(
+          discount_applied: 500,
+          gift_card_credit_available: 1000,
+          spend_amount_returned_from_levelup: 1000,
+          tip_returned_from_levelup: 500
+        )
+        expect(calculator.gift_card_payment_to_apply).to be(500)
+        expect(calculator.gift_card_tip_to_apply).to be(500)
+        expect(calculator.levelup_payment_to_apply).to be(0)
+        expect(calculator.levelup_tip_to_apply).to be(0)
+      end
+    end
+
+    context 'with discount, gift card, levelup tender and levelup tip' do
+      it 'returns the proper tenders and values' do
+        calculator = Levelup::Utils::PaymentCalculator.new(
+          discount_applied: 50,
+          gift_card_credit_available: 60,
+          spend_amount_returned_from_levelup: 150,
+          tip_returned_from_levelup: 50
+        )
+        expect(calculator.gift_card_payment_to_apply).to be(60)
+        expect(calculator.gift_card_tip_to_apply).to be(0)
+        expect(calculator.levelup_payment_to_apply).to be(40)
+        expect(calculator.levelup_tip_to_apply).to be(50)
+      end
+    end
+
+    context 'with gift card, levelup tender' do
+      it 'returns the proper tenders and values' do
+        calculator = Levelup::Utils::PaymentCalculator.new(
+          discount_applied: 0,
+          gift_card_credit_available: 500,
+          spend_amount_returned_from_levelup: 1000,
+          tip_returned_from_levelup: 0
+        )
+        expect(calculator.gift_card_payment_to_apply).to be(500)
+        expect(calculator.gift_card_tip_to_apply).to be(0)
+        expect(calculator.levelup_payment_to_apply).to be(500)
+        expect(calculator.levelup_tip_to_apply).to be(0)
+      end
+    end
+
+    context 'with gift card, levelup tender and levelup tip' do
+      it 'returns the proper tenders and values' do
+        calculator = Levelup::Utils::PaymentCalculator.new(
+          discount_applied: 0,
+          gift_card_credit_available: 500,
+          spend_amount_returned_from_levelup: 1000,
+          tip_returned_from_levelup: 500
+        )
+        expect(calculator.gift_card_payment_to_apply).to be(500)
+        expect(calculator.gift_card_tip_to_apply).to be(0)
+        expect(calculator.levelup_payment_to_apply).to be(500)
+        expect(calculator.levelup_tip_to_apply).to be(500)
+      end
+    end
+
+    context 'with levelup tender and levelup tip' do
+      it 'returns the proper tenders and values' do
+        calculator = Levelup::Utils::PaymentCalculator.new(
+          discount_applied: 500,
+          gift_card_credit_available: 0,
+          spend_amount_returned_from_levelup: 2000,
+          tip_returned_from_levelup: 500
+        )
+        expect(calculator.gift_card_payment_to_apply).to be(0)
+        expect(calculator.gift_card_tip_to_apply).to be(0)
+        expect(calculator.levelup_payment_to_apply).to be(1500)
+        expect(calculator.levelup_tip_to_apply).to be(500)
+      end
+    end
+  end
+end