levelup 0.9.2

data/lib/levelup/requests/list_user_orders.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 read_user_orders permission.
+    class ListUserOrders < Base
+      include Templates::UserAuthenticated
+
+      def body
+        {}
+      end
+
+      def response_from_hash(hash)
+        orders = hash.map { |order| OpenStruct.new(order['order']) }
+        Responses::Success.new(orders: orders)
+      end
+    end
+  end
+end

data/lib/levelup/requests/refund_order.rb

@@ -0,0 +1,21 @@
+module Levelup
+  module Requests
+    # Represents a request to refund a specified order.
+    # Merchant access token must have the manage_merchant_orders permission.
+    class RefundOrder < Base
+      include Templates::MerchantAuthenticated
+
+      # If your merchant account is configured to require one, a confirmation
+      # code permitting this refund.
+      attr_accessor :manager_confirmation
+
+      def body
+        { refund: to_hash }
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['order'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/request_permissions.rb

@@ -0,0 +1,27 @@
+module Levelup
+  module Requests
+    # Represents a request to request a set of permissions
+    # from a specified account (merchant or user).
+    class RequestPermissions < Base
+      attr_accessor :app_access_token
+      # The email address of the requested user or merchant.
+      attr_accessor :email
+      # An array of strings representing desired permissions from the user or
+      # merchant. Common permissions include 'create_orders' and
+      # 'manage_merchant_orders'
+      attr_accessor :permission_keynames
+
+      def auth_type
+        :app
+      end
+
+      def body
+        { permissions_request: to_hash }
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['permissions_request'])
+      end
+    end
+  end
+end

data/lib/levelup/requests/show_permissions_request.rb

@@ -0,0 +1,21 @@
+module Levelup
+  module Requests
+    # Represents a request to show the status of a specified permissions
+    # request.
+    class ShowPermissionsRequest < Base
+      attr_accessor :app_access_token
+
+      def auth_type
+        :app
+      end
+
+      def body
+        {}
+      end
+
+      def response_from_hash(hash)
+        Responses::Success.new(hash['permissions_request'])
+      end
+    end
+  end
+end

data/lib/levelup/responses/error.rb

@@ -0,0 +1,36 @@
+module Levelup
+  module Responses
+    # Encapsulates a response to an unsuccessful request.
+    class Error < Templates::DataParcel
+      # An array of error hashes with the properties 'object' (the LevelUp API
+      # object causing the error), 'property' (the property of that object
+      # causing the error), and 'message' (a human-readable error message).
+      attr_reader :errors
+      # The HTTP status code returned by the API
+      attr_reader :status_code
+      # Any HTTP headers returned by the API, in hash form.
+      attr_reader :headers
+
+      # Builds the error from the raw JSON response and the specified status
+      # code.
+      def initialize(headers, errors, status_code)
+        @headers = headers
+
+        if errors.is_a?(Array) || !errors
+          @errors = (errors || []).map do |error|
+            OpenStruct.new(error['error'])
+          end
+        else
+          @errors = [{ message: 'Could not parse error body' }]
+        end
+
+        @status_code = status_code
+      end
+
+      # Errors are always unsuccessful.
+      def success?
+        false
+      end
+    end
+  end
+end

data/lib/levelup/responses/success.rb

@@ -0,0 +1,11 @@
+module Levelup
+  module Responses
+    # Class that encapsulates a successful response from the LevelUp API.
+    class Success < OpenStruct
+      # Whether the response represents a successful API call.
+      def success?
+        true
+      end
+    end
+  end
+end

data/lib/levelup/templates/data_parcel.rb

@@ -0,0 +1,41 @@
+module Levelup
+  module Templates
+    # A series of methods used to convert objects to/from hashes.
+    class DataParcel
+      def initialize(hash = {})
+        assign_instance_variables_from_hash hash
+      end
+
+      # Determines if the specified instance variable is excluded from this
+      # object's generated hash.
+      def self.excluded?(instance_variable)
+        instance_variables_excluded_from_hash.include? instance_variable
+      end
+
+      def self.instance_variables_excluded_from_hash
+        [:excluded_from_hash]
+      end
+
+      private
+
+      # hash: A hash mapping instance variable names to their desired values
+      def assign_instance_variables_from_hash(hash)
+        hash.each { |key, value| public_send("#{key}=", value) }
+      end
+
+      def to_hash
+        body = {}
+
+        instance_variables.each do |variable|
+          instance_variable_name = variable.to_s.delete('@').to_sym
+
+          unless self.class.excluded?(instance_variable_name)
+            body[instance_variable_name] = instance_variable_get(variable)
+          end
+        end
+
+        body
+      end
+    end
+  end
+end

data/lib/levelup/templates/merchant_and_user_authenticated.rb

@@ -0,0 +1,21 @@
+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.
+    module MerchantAndUserAuthenticated
+      # 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.
+      attr_accessor :user_access_token
+
+      def auth_type
+        :merchant_and_user
+      end
+    end
+  end
+end

data/lib/levelup/templates/merchant_authenticated.rb

@@ -0,0 +1,19 @@
+module Levelup
+  module Templates
+    # 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.
+    module MerchantAuthenticated
+      # An access token for a merchant that has granted you
+      # 'manage_merchant_orders' permissions.
+      attr_accessor :merchant_access_token
+
+      def auth_type
+        :merchant
+      end
+    end
+  end
+end

data/lib/levelup/templates/user_address_data.rb

@@ -0,0 +1,20 @@
+module Levelup
+  module Templates
+    # Apply this template to any request/response that handles all data for a
+    # user address.
+    module UserAddressData
+      # The 'type' of this address, e.g. 'home' or 'work'.
+      attr_accessor :address_type
+      # The number and street name of this address.
+      attr_accessor :street_address
+      # The second line of the address, e.g. 'Suite #40'.
+      attr_accessor :extended_address
+      # The city (or some equivalent) of this address.
+      attr_accessor :locality
+      # The state, province, or some other equivalent for this address.
+      attr_accessor :region
+      # The postal code for this address.
+      attr_accessor :postal_code
+    end
+  end
+end

data/lib/levelup/templates/user_authenticated.rb

@@ -0,0 +1,17 @@
+module Levelup
+  module Templates
+    # A template to apply to any requests requiring user authentication.
+    #
+    # Authentication template - only apply one authentication template per
+    # request.
+    module Templates::UserAuthenticated
+      # An access token for a user that has granted you appropriate
+      # permissions.
+      attr_accessor :user_access_token
+
+      def auth_type
+        :user
+      end
+    end
+  end
+end

data/spec/data_objects/requests/authenticate_app_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::AuthenticateApp' do
+  before do
+    @test_authenticate_request = Levelup::Requests::AuthenticateApp.new
+  end
+
+  describe '#auth_type' do
+    it 'returns :none' do
+      expect(@test_authenticate_request.auth_type).to eq(:none)
+    end
+  end
+end

data/spec/data_objects/requests/authenticate_merchant_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::AuthenticateMerchant' do
+  before do
+    @test_merchant_authenticate_request = \
+      Levelup::Requests::AuthenticateMerchant.new({})
+  end
+
+  describe '#auth_type' do
+    it 'returns :none' do
+      expect(@test_merchant_authenticate_request.auth_type).to be :none
+    end
+  end
+end

data/spec/data_objects/requests/create_order_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::CreateOrder' do
+  before do
+    @test_app_order_request = Levelup::Requests::CreateOrder.new(
+        user_access_token: 'some access token', location_id: 256)
+  end
+
+  describe '#auth_type' do
+    it 'returns :merchant_and_user' do
+      expect(@test_app_order_request.auth_type).to be :merchant_and_user
+    end
+  end
+end

data/spec/data_objects/requests/get_order_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::GetOrder' do
+  before do
+    @test_order_deets_request = Levelup::Requests::GetOrder.new
+  end
+
+  describe '#auth_type' do
+    it 'returns :merchant_v14' do
+      expect(@test_order_deets_request.auth_type).to eq(:merchant_v14)
+    end
+  end
+end

data/spec/data_objects/requests/list_locations_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::ListLocations' do
+  before do
+    @test_list_locs_request = Levelup::Requests::ListLocations.new
+  end
+
+  describe '#auth_type' do
+    it 'returns :merchant_v14' do
+      @test_list_locs_request.auth_type.should eq(:merchant_v14)
+    end
+  end
+end

data/spec/data_objects/requests/list_orders_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::ListOrders' do
+  before do
+    @test_list_orders_request = Levelup::Requests::ListOrders.new
+  end
+
+  describe '#auth_type' do
+    it 'returns :merchant_v14' do
+      @test_list_orders_request.auth_type.should eq(:merchant_v14)
+    end
+  end
+end

data/spec/data_objects/requests/refund_order_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::RefundOrder' do
+  before do
+    @test_app_refund_request = Levelup::Requests::RefundOrder.new({})
+  end
+
+  describe '#auth_type' do
+    it 'returns :merchant' do
+      expect(@test_app_refund_request.auth_type).to be :merchant
+    end
+  end
+
+  describe '#body' do
+    it 'returns a hash wrapped in a refund tag' do
+      expect(@test_app_refund_request.body[:refund]).to_not be_nil
+    end
+  end
+end

data/spec/data_objects/requests/request_permissions_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe 'Levelup::Requests::RequestPermissions' do
+  before do
+    @test_user_permissions_request =
+      Levelup::Requests::RequestPermissions.new({})
+  end
+
+  describe '#auth_type' do
+    it 'returns :app' do
+      expect(@test_user_permissions_request.auth_type).to be :app
+    end
+  end
+
+  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
+    end
+  end
+end

data/spec/data_objects/responses/error_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe 'Levelup::Responses::Error' do
+  before do
+    @empty_response = Levelup::Responses::Error.new({}, [], 404)
+
+    @nonempty_response = Levelup::Responses::Error.new(
+      {
+        'header' => 'value',
+        'otherHeader' => 'secondValue'
+      },
+      [{
+        'error' => {
+          'property' => 'whatever',
+          'object' => 'Elbereth',
+          'message' => 'some message'
+        }
+      },
+      {
+        'error' => {
+          'property' => 'some_prop',
+          'object' => 'some_object',
+          'message' => 'some other message'
+        }
+      }],
+      404)
+  end
+
+  describe '#errors' do
+    context 'for an object with no body hash' do
+      it 'has no errors' do
+        expect(@empty_response.errors).to eq([])
+      end
+    end
+
+    context 'for an object with two full errors in its body hash' do
+      it 'has two full errors' do
+        expect(@nonempty_response).to have(2).errors
+        @nonempty_response.errors.each do |error|
+          expect(error['property']).to_not be_nil
+          expect(error['object']).to_not be_nil
+          expect(error['message']).to_not be_nil
+        end
+      end
+    end
+  end
+
+  describe '#headers' do
+    context 'for an object with an empty supplied header' do
+      it 'has empty headers' do
+        expect(@empty_response.headers).to eq({})
+      end
+    end
+
+    context 'for an object with a nonempty supplied header' do
+      it 'has non-empty headers' do
+        expect(@nonempty_response.headers).to_not be_empty
+      end
+    end
+  end
+
+  describe '#success?' do
+    it 'returns false' do
+      expect(@empty_response.success?).to be_false
+    end
+  end
+end