levelup 0.9.4 → 0.9.5

data/lib/levelup/endpoints/merchant_funded_credits.rb

@@ -1,18 +1,16 @@
 module Levelup
   module Endpoints
-    # The endpoint holding all functions relating to managing merchant-funded
-    # credit.
+    # The endpoint holding all functions relating to managing merchant-funded credit.
     class MerchantFundedCredits < Base
       def give(give_credit_request)
-        request = build_request(give_credit_request,
-          Requests::GiveMerchantCredit)
-        request.send_to_api(:post, endpoint_path)
+        build_request(give_credit_request, Requests::GiveMerchantCredit).
+          send_to_api(:post, endpoint_path)
       end
 
       private
 
       def path
-        "merchant_funded_credits"
+        'merchant_funded_credits'
       end
     end
   end

data/lib/levelup/endpoints/merchant_locations.rb

@@ -1,28 +1,23 @@
 module Levelup
   module Endpoints
-    # The endpoint holding all functions relating to a single merchant's
-    # locations. This is a v14 endpoint and should not be expected to remain
-    # functional indefinitely.
+    # The endpoint holding all functions relating to a single merchant's locations. This is a v14
+    # endpoint and should not be expected to remain functional indefinitely.
     class MerchantLocations < Base
       def initialize(merchant_id)
         @id = merchant_id
       end
 
-      # Provides a list of locations controlled by this merchant. This list is
-      # not paginated.
+      # Provides a list of locations controlled by this merchant. This list is not paginated.
       #
-      # [merchant_auth_token]
-      #   An authorization token with permission to view
-      #   this merchant.
-      def list(merchant_auth_token)
-        request = Requests::ListLocations.new(
-          merchant_access_token: merchant_auth_token)
-        request.send_to_api(:get, endpoint_path(:v14))
+      # @param merchant_access_token [string] An access token for a user that manages this location.
+      def list(merchant_access_token)
+        Requests::ListLocations.new(merchant_access_token: merchant_access_token).
+          send_to_api(:get, endpoint_path(:v14))
       end
 
       private
 
-      attr_reader :id
+      attr_accessor :id
 
       def path
         "merchants/#{id}/locations"

data/lib/levelup/endpoints/merchant_orders.rb

@@ -1,24 +1,22 @@
 module Levelup
   module Endpoints
     # The endpoint holding all functions relating to a single merchant's orders.
-    # This is a v14 endpoint and should not be expected to remain functional
-    # indefinitely.
+    # This is a v14 endpoint and should not be expected to remain functional indefinitely.
     class MerchantOrders < Base
       def initialize(merchant_id)
-        @id = merchant_id
+        self.id = merchant_id
       end
 
       # Provides merchant-facing details about a specific order. For more
-      # information about the parameters, see OrderDetailsRequest.
+      # information about the parameters, @see Requests::CreateOrderDetails.
       def details(uuid, merchant_access_token)
-        request = Requests::CreateOrderDetails.new(
-          merchant_access_token: merchant_access_token)
-        request.send_to_api(:get, endpoint_path(:v14) + "/#{uuid}")
+        Requests::CreateOrderDetails.new(merchant_access_token: merchant_access_token).
+          send_to_api(:get, endpoint_path(:v14) + "/#{uuid}")
       end
 
       private
 
-      attr_reader :id
+      attr_accessor :id
 
       def path
         "merchants/#{id}/orders"

data/lib/levelup/endpoints/orders.rb

@@ -3,10 +3,10 @@ module Levelup
     # The class holding all functions related to orders that do not specify a
     # specific order. For single-order functions, see SpecificOrder.
     class Orders < Base
-      # Creates an order. See OrderRequest for more info about the parameters.
+      # Creates an order. See Requests::CreateOrder for more info about the parameters.
       def create(order_request)
-        request = build_request(order_request, Requests::CreateOrder)
-        request.send_to_api(:post, endpoint_path)
+        build_request(order_request, Requests::CreateOrder).
+          send_to_api(:post, endpoint_path)
       end
 
       private

data/lib/levelup/endpoints/permissions_requests.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Endpoints
-    # The endpoint holding all functions related to managing permissions
-    # requests.
+    # The endpoint holding all functions related to managing permissions requests.
     class PermissionsRequests < Base
       def initialize(app_access_token)
         self.app_access_token = app_access_token

data/lib/levelup/endpoints/qr_codes.rb

@@ -8,11 +8,10 @@ module Levelup
         self.tip_percent = options[:tip_percent] || 0
       end
 
-      # Retrieves the specified user's QR code using parameters specified
-      # in the endpoint.
+      # Retrieves the specified user's QR code using parameters specified in the endpoint.
       def get(user_access_token)
-        request = Requests::GetQrCode.new(user_access_token: user_access_token)
-        request.send_to_api(:get, endpoint_path)
+        Requests::GetQrCode.new(user_access_token: user_access_token).
+          send_to_api(:get, endpoint_path)
       end
 
       private

data/lib/levelup/endpoints/specific_app.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Endpoints
-    # The endpoint serving as a bucket for all functions related to a specific
-    # app.
+    # The endpoint serving as a bucket for all functions related to a specific app.
     class SpecificApp < Base
       def initialize(id)
         self.id = id

data/lib/levelup/endpoints/specific_location.rb

@@ -1,25 +1,30 @@
 module Levelup
   module Endpoints
     # The endpoint holding all functions relating to a specific location.
-    # This is a v14 endpoint and should not be expected to remain functional
-    # indefinitely.
+    # This is a v14 endpoint and should not be expected to remain functional indefinitely.
     class SpecificLocation < Base
-      attr_reader :id
+      attr_accessor :id
 
       def initialize(location_id)
-        @id = location_id
-      end
-
-      def orders
-        LocationOrders.new(id)
+        self.id = location_id
       end
 
       def credit
         LocationCredit.new(id)
       end
 
+      def merchant_funded_credit
+        LocationMerchantFundedCredit.new(id)
+      end
+
+      def orders
+        LocationOrders.new(id)
+      end
+
       private
 
+      attr_accessor :id
+
       def path
         "locations/#{id}"
       end

data/lib/levelup/endpoints/specific_merchant.rb

@@ -1,13 +1,10 @@
 module Levelup
   module Endpoints
     # The endpoint holding all functions relating to a single merchant. This is
-    # a v14 endpoint and should not be expected to remain functional
-    # indefinitely.
+    # a v14 endpoint and should not be expected to remain functional indefinitely.
     class SpecificMerchant < Base
-      attr_reader :id
-
       def initialize(merchant_id)
-        @id = merchant_id
+        self.id = merchant_id
       end
 
       def locations
@@ -20,6 +17,8 @@ module Levelup
 
       private
 
+      attr_accessor :id
+
       def path
         "merchants/#{id}"
       end

data/lib/levelup/endpoints/specific_order.rb

@@ -7,14 +7,10 @@ module Levelup
       end
 
       # Refunds the order specified by this endpoint.
-      #
-      # [merchant_auth_token]
-      #   A merchant access token with permissions to
-      #   refund orders made at the location where this order was placed.
-      def refund(merchant_auth_token)
-        request = Requests::RefundOrder.new(
-          merchant_access_token: merchant_auth_token)
-        request.send_to_api(:post, endpoint_path + '/refund')
+      # @param merchant_access_token [string] An access token for a user that manages this location.
+      def refund(merchant_access_token)
+        Requests::RefundOrder.new(merchant_access_token: merchant_access_token).
+          send_to_api(:post, endpoint_path + '/refund')
       end
 
       private

data/lib/levelup/endpoints/specific_permissions_request.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Endpoints
-    # The endpoint holding all functions related to accessing a specified
-    # permissions request.
+    # The endpoint holding all functions related to accessing a specified permissions request.
     class SpecificPermissionsRequest < Base
       def initialize(request_id, app_access_token)
         self.app_access_token = app_access_token
@@ -9,9 +8,8 @@ module Levelup
       end
 
       def show(app_token = nil)
-        request = Requests::ShowPermissionsRequest.
-          new(app_access_token: app_access_token || app_token)
-        request.send_to_api(:get, endpoint_path)
+        Requests::ShowPermissionsRequest.new(app_access_token: app_access_token || app_token).
+          send_to_api(:get, endpoint_path)
       end
 
       private

data/lib/levelup/endpoints/user_addresses.rb

@@ -2,17 +2,16 @@ module Levelup
   module Endpoints
     # Endpoint holding all functions relating to user addresses.
     class UserAddresses < Base
-      # Creates a specified user address. For more information on parameters,
-      # see UserAddressRequest.
+      # Creates a specified user address. For more information on parameters, see
+      # UserAddressRequest.
       def create(user_address_request)
-        request = build_request(user_address_request,
-          Requests::CreateAddress)
-        request.send_to_api(:post, endpoint_path)
+        build_request(user_address_request, Requests::CreateAddress).
+          send_to_api(:post, endpoint_path)
       end
 
       def list(user_access_token)
-        request = Requests::ListAddresses(user_access_token: user_access_token)
-        request.send_to_api(:get, endpoint_path)
+        Requests::ListAddresses(user_access_token: user_access_token).
+          send_to_api(:get, endpoint_path)
       end
 
       private

data/lib/levelup/endpoints/user_orders.rb

@@ -3,9 +3,8 @@ module Levelup
     # The endpoint holding all functions related to orders for a specified user.
     class UserOrders < Base
       def list(user_access_token)
-        request = Requests::ListUserOrders.
-          new(user_access_token: user_access_token)
-        request.send_to_api(:get, endpoint_path)
+        Requests::ListUserOrders.new(user_access_token: user_access_token).
+          send_to_api(:get, endpoint_path)
       end
 
       private

data/lib/levelup/endpoints/users.rb

@@ -2,6 +2,11 @@ module Levelup
   module Endpoints
     # The endpoint serving as a bucket for all user-related functions.
     class Users < Base
+      def get(user_access_token)
+        Requests::GetUser.new(user_access_token: user_access_token).
+          send_to_api(:get, endpoint_path)
+      end
+
       def orders
         UserOrders.new
       end

data/lib/levelup/requests/authenticate_merchant.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Requests
-    # Represents a request to generate a merchant access
-    # token.
+    # Represents a request to generate a merchant access token.
     class AuthenticateMerchant < Base
       # Your merchant's API key (accepts app API key as well)
       attr_accessor :api_key

data/lib/levelup/requests/create_address.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.
     class CreateAddress < Base
       include Templates::UserAddressData
       include Templates::UserAuthenticated

data/lib/levelup/requests/create_card.rb

@@ -1,8 +1,7 @@
 module Levelup
   module Requests
-    # Represents a request to add the first credit card to a specified user
-    # account. User access token must have the create_first_credit_card
-    # permission.
+    # Represents a request to add the first credit card to a specified user account.
+    # User access token must have the create_first_credit_card permission.
     class CreateCard < Base
       include Templates::UserAuthenticated
 

data/lib/levelup/requests/create_order.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Requests
-    # Represents a request to create an order for the specified user at the
-    # specified merchant.
+    # Represents a request to create an order for the specified user at the specified merchant.
     class CreateOrder < Base
       include Templates::MerchantAndUserAuthenticated
       # An array of Item objects (or hashes representing them) representing all

data/lib/levelup/requests/create_user.rb

@@ -1,23 +1,14 @@
 module Levelup
   module Requests
-    # Represents a request to create a new user with the specified list of
-    # permissions.
+    # Represents a request to create a new user with the specified list of permissions.
     class CreateUser < Base
       include Templates::AppAuthenticated
-      # An array of Item objects (or hashes representing them) representing all
-      # items purchased by this order.
-      attr_accessor :email
-      attr_accessor :first_name
-      attr_accessor :last_name
       attr_accessor :permission_keynames
+      attr_accessor :api_key
+      attr_accessor :user
 
       def body
-        user_hash = {
-          email: email,
-          first_name: first_name,
-          last_name: last_name
-        }
-        { user: user_hash, permission_keynames: permission_keynames }
+        { api_key: api_key, user: user, permission_keynames: permission_keynames }
       end
 
       def response_from_hash(hash)

data/lib/levelup/requests/get_location_credit.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Requests
-    # Represents a request to access information about a
-    # specific order under a merchant.
+    # Represents a request to access information about a specific order under a merchant.
     class GetLocationCredit < Base
       include Templates::UserAuthenticated
 

data/lib/levelup/requests/get_location_merchant_funded_credit.rb

@@ -0,0 +1,16 @@
+module Levelup
+  module Requests
+    # Represents a request to access information about a specific order under a merchant.
+    class GetLocationMerchantFundedCredit < Base
+      include Templates::MerchantAuthenticated
+
+      def auth_type
+        :merchant_v14
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new hash['merchant_funded_credit']
+      end
+    end
+  end
+end

data/lib/levelup/requests/get_order.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Requests
-    # Represents a request to access information about a
-    # specific order under a merchant.
+    # Represents a request to access information about a specific order under a merchant.
     class GetOrder < Base
       include Templates::MerchantAuthenticated
 

data/lib/levelup/requests/give_merchant_credit.rb

@@ -1,8 +1,7 @@
 module Levelup
   module Requests
     # Represents a request to grant merchant-funded credit to a user.
-    # Merchant access token must have the give_merchant_funded_credit
-    # permission.
+    # Merchant access token must have the give_merchant_funded_credit permission.
     class GiveMerchantCredit < Base
       include Templates::MerchantAuthenticated
       attr_accessor :email, :value_amount

data/lib/levelup/requests/list_addresses.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 manage_user_addresses permission.
     class ListAddresses < Base
       include Templates::UserAuthenticated

data/lib/levelup/requests/list_app_locations.rb

@@ -1,7 +1,6 @@
 module Levelup
   module Requests
-    # Represents a request to list all locations under
-    # a specified app. The list is paginated.
+    # Represents a request to list all locations under a specified app. The list is paginated.
     class ListAppLocations < Base
       def auth_type
         :none

data/lib/levelup/requests/list_locations.rb

@@ -1,8 +1,7 @@
 module Levelup
   module Requests
-    # Represents a request to list all locations under
-    # a specified merchant. This is a v14 endpoint and should not be expected to
-    # remain functional indefinitely.
+    # Represents a request to list all locations under a specified merchant.
+    # This is a v14 endpoint and should not be expected to remain functional indefinitely.
     class ListLocations < Base
       include Templates::MerchantAuthenticated