levelup 0.9.2

data/lib/levelup/endpoints/user_orders.rb

@@ -0,0 +1,18 @@
+module Levelup
+  module Endpoints
+    # 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)
+      end
+
+      private
+
+      def path
+        'users/orders'
+      end
+    end
+  end
+end

data/lib/levelup/endpoints/users.rb

@@ -0,0 +1,16 @@
+module Levelup
+  module Endpoints
+    # The endpoint serving as a bucket for all user-related functions.
+    class Users < Base
+      def orders
+        UserOrders.new
+      end
+
+      private
+
+      def path
+        'users'
+      end
+    end
+  end
+end

data/lib/levelup/errors/invalid_request.rb

@@ -0,0 +1,8 @@
+module Levelup
+  module Errors
+    # An error generated by the LevelUp client when the user attempts a request
+    # that is in some way of invalid format.
+    class InvalidRequest < StandardError
+    end
+  end
+end

data/lib/levelup/errors/unauthenticated.rb

@@ -0,0 +1,8 @@
+module Levelup
+  module Errors
+    # An error generated by the LevelUp client when the user attempts to
+    # perform an authorized action without an access token.
+    class Unauthenticated < StandardError
+    end
+  end
+end

data/lib/levelup/requests/authenticate_app.rb

@@ -0,0 +1,19 @@
+module Levelup
+  module Requests
+    # Represents a request to generate an app access token.
+    class AuthenticateApp < Base
+      # The API key assigned to your app
+      attr_accessor :api_key
+      # The secret code assigned to your app
+      attr_accessor :client_secret
+
+      def auth_type
+        :none
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['access_token'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/authenticate_merchant.rb

@@ -0,0 +1,26 @@
+module Levelup
+  module Requests
+    # 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
+      # The username used to log into your merchant account
+      attr_accessor :username
+      # Your merchant account's password
+      attr_accessor :password
+
+      def auth_type
+        :none
+      end
+
+      def body
+        { access_token: to_hash }
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['access_token'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/base.rb

@@ -0,0 +1,87 @@
+module Levelup
+  module Requests
+    # The class containing the base functionality of all requests.
+    class Base < Templates::DataParcel
+      ALLOWED_REQUEST_METHODS = [:delete, :get, :post, :put]
+
+      # One of :none, :merchant, :app, :merchant_and_user
+      def auth_type
+        raise NotImplementedError, 'Auth type not defined for request.'
+      end
+
+      # Returns the body of the request to send as a hash. By default, sends
+      # a hash of all assigned instance variables in the object.
+      def body
+        to_hash
+      end
+
+      # Contains any additional headers passed in a request to the API.
+      # Builds the headers for a request out of a request object.
+      # Extending classes wishing to add additional headers should build their
+      # headers hash and return my_headers.merge(super)
+      def headers
+        headers = DEFAULT_HEADERS.dup
+
+        auth = auth_header_value
+        if auth
+          headers['Authorization'] = auth
+        end
+
+        headers
+      end
+
+      # default values to exclude from request hashes (header values)
+      def self.instance_variables_excluded_from_hash
+        @excluded ||= super.concat([:app_access_token, :merchant_access_token,
+          :user_access_token])
+      end
+
+      def response_from_hash
+        raise NotImplementedError, 'Response generator not defined.'
+      end
+
+      # Makes a call by the specified method to the specified endpoint, sending
+      # this request object. If successful, builds a response object according
+      # to response_from_hash. If unsuccessful, simply returns an ErrorResponse.
+      def send_to_api(method, endpoint)
+        unless ALLOWED_REQUEST_METHODS.include?(method)
+          raise Errors::InvalidRequest, 'Attempted to send a request to'\
+          " LevelUp API via invalid method #{method}"
+        end
+
+        response = HTTParty.public_send(method, endpoint,
+          body: JSON.generate(body), headers: headers)
+
+        if response.success?
+          response_from_hash(response.parsed_response)
+        else
+          Responses::Error.new(response.headers, response.parsed_response,
+            response.code)
+        end
+      end
+
+      private
+
+      DEFAULT_HEADERS = {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      def auth_header_value
+        case auth_type
+        when :app
+          %{token #{app_access_token}}
+        when :merchant
+          %{token merchant="#{merchant_access_token}"}
+        when :merchant_v14
+          %{token #{merchant_access_token}}
+        when :merchant_and_user
+          %{token merchant="#{merchant_access_token}", } +
+            %{user="#{user_access_token}"}
+        when :user
+          %{token user="#{user_access_token}"}
+        end
+      end
+    end
+  end
+end

data/lib/levelup/requests/create_address.rb

@@ -0,0 +1,19 @@
+ module Levelup
+  module Requests
+    # 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
+
+      def body
+        { user_address: to_hash }
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['user_address'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/create_card.rb

@@ -0,0 +1,21 @@
+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.
+    class CreateCard < Base
+      include Templates::UserAuthenticated
+
+      attr_accessor :encrypted_cvv, :encrypted_expiration_month,
+        :encrypted_expiration_year, :encrypted_number, :postal_code
+
+      def body
+        { credit_card: to_hash }
+      end
+
+      def response_from_hash(hash)
+        Response::Success.new(hash['credit_card'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/create_order.rb

@@ -0,0 +1,33 @@
+module Levelup
+  module Requests
+    # 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
+      # items purchased by this order.
+      attr_accessor :items
+      # A merchant-supplied unique ID for this order. Optional.
+      attr_accessor :identifier_from_merchant
+      # The LevelUp ID for the location from which this order was requested.
+      attr_accessor :location_id
+      # The total amount (in cents) spent on this order.
+      attr_accessor :spend_amount
+
+      def body
+        items = @items.map do |item|
+          { item: item }
+        end
+
+        order_hash = to_hash
+        order_hash[:items] = items
+
+        { order: order_hash }
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['order'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/create_user.rb

@@ -0,0 +1,34 @@
+module Levelup
+  module Requests
+    # Represents a request to create a new user with the specified list of
+    # permissions.
+    class CreateUser < Base
+      attr_accessor :app_access_token
+      # 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
+
+      def auth_type
+        :app
+      end
+
+      def body
+        user_hash = {
+          email: email,
+          first_name: first_name,
+          last_name: last_name
+        }
+        { user: user_hash, permission_keynames: permission_keynames }
+      end
+
+      def response_from_hash(hash)
+        hash['user'] = OpenStruct.new(hash['user'])
+
+        Responses::Success.new(hash)
+      end
+    end
+  end
+end

data/lib/levelup/requests/get_order.rb

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

data/lib/levelup/requests/get_qr_code.rb

@@ -0,0 +1,16 @@
+module Levelup
+  module Requests
+    # Represents a request to get a QR code for a user.
+    class GetQrCode < Base
+      include Templates::UserAuthenticated
+
+      def body
+        {}
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['qr_code'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/get_user.rb

@@ -0,0 +1,17 @@
+module Levelup
+  module Requests
+    # Represents a request to get information about a user.
+    # User access token must have the read_user_basic_info permission.
+    class GetUser < Base
+      include Templates::UserAuthenticated
+
+      def body
+        {}
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['user'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/give_merchant_credit.rb

@@ -0,0 +1,23 @@
+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.
+    class GiveMerchantCredit < Base
+      include Templates::MerchantAuthenticated
+      attr_accessor :email, :value_amount
+
+      def auth_type
+        :merchant
+      end
+
+      def body
+        { merchant_funded_credit: to_hash }
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new
+      end
+    end
+  end
+end

data/lib/levelup/requests/list_addresses.rb

@@ -0,0 +1,20 @@
+ module Levelup
+  module Requests
+    # 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
+
+      def body
+        {}
+      end
+
+      def response_from_hash(hash)
+        addresses = hash.map { |address| address['user_address'] }
+        Responses::Success.new(addresses: addresses)
+      end
+    end
+  end
+end

data/lib/levelup/requests/list_locations.rb

@@ -0,0 +1,24 @@
+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.
+    class ListLocations < Base
+      include Templates::MerchantAuthenticated
+
+      def auth_type
+        :merchant_v14
+      end
+
+      def response_from_hash(hash)
+        if hash.nil? # no locations found for this merchant
+          Responses::Success.new(locations: [])
+        else
+          locations =
+            hash.map { |location| OpenStruct.new(location['location']) }
+          Responses::Success.new(locations: locations)
+        end
+      end
+    end
+  end
+end

data/lib/levelup/requests/list_orders.rb

@@ -0,0 +1,23 @@
+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.
+    class ListOrders < Base
+      include Templates::MerchantAuthenticated
+
+      def auth_type
+        :merchant_v14
+      end
+
+      def response_from_hash(hash)
+        if hash.nil? # no orders found for this location
+          Responses::Success.new(orders: [])
+        else
+          orders = hash.map { |order| OpenStruct.new(order['order']) }
+          Responses::Success.new(orders: orders)
+        end
+      end
+    end
+  end
+end