starling-ruby 0.1.0 → 0.2.0

data/lib/starling/resources/address_resource.rb

@@ -0,0 +1,26 @@
+module Starling
+  module Resources
+    # A resource representing an address in the response from the Addresses API
+    class AddressResource < BaseResource
+      # @return [String] the city where the address is located
+      def city
+        parsed_data['city']
+      end
+
+      # @return [String] the country where the addresses is located (e.g. "GBR")
+      def country
+        parsed_data['country']
+      end
+
+      # @return [String] the postcode of the address
+      def postcode
+        parsed_data['postcode']
+      end
+
+      # @return [String] the street address of the address
+      def street_address
+        parsed_data['streetAddress']
+      end
+    end
+  end
+end

data/lib/starling/resources/addresses_resource.rb

@@ -0,0 +1,18 @@
+module Starling
+  module Resources
+    # A resource representing a response from the Addresses API
+    class AddressesResource < BaseResource
+      # @return [AddressResource] the user's current address
+      def current
+        AddressResource.new(parsed_data: parsed_data['current'])
+      end
+
+      # @return [Array<AddressResource>] a list of the user's previous addresses
+      def previous
+        parsed_data['previous'].map do |address|
+          AddressResource.new(parsed_data: address)
+        end
+      end
+    end
+  end
+end

data/lib/starling/resources/base_resource.rb

@@ -1,38 +1,63 @@
 require 'json'
 require 'time'
+require 'date'
 
 module Starling
   module Resources
+    # A basic implementation of a resource representing a response from the Starling Bank
+    # API
     class BaseResource
-      # A resource can be instantiated with either a Faraday::Response, including a
-      # #body, or with a Hash pre-parsed from JSON
+      # A resource can be instantiated with either a Faraday::Response (including a
+      # #body), or with a Hash pre-parsed from JSON.
+      #
+      # An alternative possible approach to our resources would be to parse out the
+      # attributes we care about at initialisation, and then just add `attr_reader`s,
+      # rather than looking into the parsed JSON hash. The current solution is probably
+      # preferable, since it defers delving into the hash until a parameter is actually
+      # wanted, and keeps instance variables to a minimum.
+      #
+      # @param response [Faraday::Response] The complete HTTP response, returned by
+      #                                     {Request#make_request}
+      # @param parsed_data [Hash] The pre-parsed data for the resource, useful for
+      #                           building resources from list resources we've already
+      #                           parsed
       def initialize(response: nil, parsed_data: nil)
-        if response.nil? && parsed_data.nil?
+        unless response || parsed_data
           raise ArgumentError, 'Either response or parsed_data must be provided to ' \
                                'instantiate a resource'
         end
 
         @response = response
-        @parsed_data = parsed_data
+        @parsed_data = parsed_data || JSON.parse(response.body)
       end
 
       private
 
+      attr_reader :parsed_data
+
       def present_datetime(iso8601_string)
         Time.parse(iso8601_string)
       end
 
+      def present_date(string)
+        Date.parse(string)
+      end
+
+      # Many fields returned in the API (e.g. transaction amounts) can be either integers
+      # or more complex values with decimal places. The JSON parser will turn these into
+      # Integer (Fixnum in Ruby versions before 2.4) and Float objects respectively. For
+      # consistency, we will convert anything that *could* be a Float into a Float.
+      def present_float(number)
+        Float(number)
+      end
+
       # Some strings returned by the API are specified as Enum types, with a specified
       # set of possible values. These are best represented in Ruby as symbols (e.g.
       # the Transaction API's `source` can have the value MASTER_CARD, which will become
       # :master_card.
-      def symbolize_enum_string(enum_string)
+      def present_enum(enum_string)
         enum_string.downcase.to_sym
       end
-
-      def parsed_data
-        @parsed_data ||= JSON.parse(@response.body)
-      end
     end
   end
 end

data/lib/starling/resources/card_resource.rb

@@ -0,0 +1,46 @@
+module Starling
+  module Resources
+    # A resource representing a response from the Card API
+    class CardResource < BaseResource
+      # @return [String] the Starling internal ID of the card
+      def id
+        parsed_data['id']
+      end
+
+      # @return [String] the name on the front of the card
+      def name_on_card
+        parsed_data['nameOnCard']
+      end
+
+      # @return [String] the type of the card (e.g. "ContactlessDebitMastercard")
+      def type
+        parsed_data['type']
+      end
+
+      # @return [true, false] whether the card is enabled
+      def enabled
+        parsed_data['enabled']
+      end
+
+      # @return [true, false] whether the card has been cancelled
+      def cancelled
+        parsed_data['cancelled']
+      end
+
+      # @return [true, false] whether the card's activation has been requested
+      def activation_requested
+        parsed_data['activationRequested']
+      end
+
+      # @return [true, false] whether the card has been activated
+      def activated
+        parsed_data['activated']
+      end
+
+      # @return [Date] when the card was dispatched by post to the user
+      def dispatch_date
+        present_date(parsed_data['dispatchDate'])
+      end
+    end
+  end
+end

data/lib/starling/resources/contact_account_resource.rb

@@ -0,0 +1,31 @@
+module Starling
+  module Resources
+    # A resource representing a Contact Account returned from the Contact Accounts API
+    class ContactAccountResource < BaseResource
+      # @return [String] the Starling internal ID of the contact account
+      def id
+        parsed_data['id']
+      end
+
+      # @return [String] the name of the contact account
+      def name
+        parsed_data['name']
+      end
+
+      # @return [Symbol] the type of the contact account (e.g. `:domestic`)
+      def type
+        present_enum(parsed_data['type'])
+      end
+
+      # @return [String] the account number of the contact account
+      def account_number
+        parsed_data['accountNumber']
+      end
+
+      # @return [String] the sort code of the contact account
+      def sort_code
+        parsed_data['sortCode']
+      end
+    end
+  end
+end

data/lib/starling/resources/contact_resource.rb

@@ -0,0 +1,16 @@
+module Starling
+  module Resources
+    # A resource representing a Contact returned from the Contacts API
+    class ContactResource < BaseResource
+      # @return [String] the Starling internal ID of the contact
+      def id
+        parsed_data['id']
+      end
+
+      # @return [String] the name of the contact
+      def name
+        parsed_data['name']
+      end
+    end
+  end
+end

data/lib/starling/resources/customer_resource.rb

@@ -0,0 +1,36 @@
+module Starling
+  module Resources
+    # A resource representing the response returned from the Customer API
+    class CustomerResource < BaseResource
+      # @return [String] the Starling internal ID of the customer
+      def customer_uid
+        parsed_data['customerUid']
+      end
+
+      # @return [String] the first name of the customer
+      def first_name
+        parsed_data['firstName']
+      end
+
+      # @return [String] the last name of the customer
+      def last_name
+        parsed_data['lastName']
+      end
+
+      # @return [Date] the date of birth of the customer
+      def date_of_birth
+        present_date(parsed_data['dateOfBirth'])
+      end
+
+      # @return [String] the email address of the customer
+      def email
+        parsed_data['email']
+      end
+
+      # @return [String] the phone number of the customer
+      def phone
+        parsed_data['phone']
+      end
+    end
+  end
+end

data/lib/starling/resources/direct_debit_mandate_resource.rb

@@ -0,0 +1,43 @@
+module Starling
+  module Resources
+    # A resource representing a Direct Debit mandate returned from the Direct Debit
+    # Mandates API
+    class DirectDebitMandateResource < BaseResource
+      # @return [String] the Starling internal ID of the Direct Debit mandate
+      def uid
+        parsed_data['uid']
+      end
+
+      # @return [String] the reference of the Direct Debit mandate
+      def reference
+        parsed_data['reference']
+      end
+
+      # @return [Symbol] the status of the mandate (e.g. `:live`)
+      def status
+        present_enum(parsed_data['status'])
+      end
+
+      # @return [Symbol] the source of the mandate (e.g. `:electronic` or `paper)
+      def source
+        present_enum(parsed_data['source'])
+      end
+
+      # @return [Time] the date when the mandate was created
+      def created
+        present_datetime(parsed_data['created'])
+      end
+      alias created_at created
+
+      # @return [String] the name of the Direct Debit mandate's originator
+      def originator_name
+        parsed_data['originatorName']
+      end
+
+      # @return [String] the Starling internal ID of the Direct Debit mandate's originator
+      def originator_uid
+        parsed_data['originatorUid']
+      end
+    end
+  end
+end

data/lib/starling/resources/direct_debit_transaction_resource.rb

@@ -0,0 +1,54 @@
+module Starling
+  module Resources
+    # A resource representing a Transaction returned from the Transaction Direct Debit
+    # API
+    class DirectDebitTransactionResource < BaseResource
+      # @return [String] the Starling internal ID of the transaction
+      def id
+        parsed_data['id']
+      end
+
+      # @return [String] the currency of the transaction (e.g. "GBP" or "UAH")
+      def currency
+        parsed_data['currency']
+      end
+
+      # @return [Float] the amount of the transaction
+      def amount
+        present_float(parsed_data['amount'])
+      end
+
+      # @return [Symbol] the direction of the transaction (e.g. `:outbound`)
+      def direction
+        present_enum(parsed_data['direction'])
+      end
+
+      # @return [Time] the date and time when the transaction was recorded
+      def created
+        present_datetime(parsed_data['created'])
+      end
+      alias created_at created
+
+      # @return [String] the narrative of the transaction
+      def narrative
+        parsed_data['narrative']
+      end
+
+      # @return [Symbol] the source of the transaction (e.g. `:master_card`)
+      def source
+        present_enum(parsed_data['source'])
+      end
+
+      # @return [String] the Starling internal ID of the Direct Debit mandate
+      def mandate_id
+        parsed_data['mandateId']
+      end
+
+      # @return [Symbol] the type of the transaction
+      #                  (e.g. `:first_payment_of_direct_debit` or `:direct_debit`)
+      def type
+        present_enum(parsed_data['type'])
+      end
+    end
+  end
+end

data/lib/starling/resources/inbound_faster_payments_transaction_resource.rb

@@ -0,0 +1,56 @@
+module Starling
+  module Resources
+    # A resource representing a Transaction returned from the Transactions Faster
+    # Payments In API
+    class InboundFasterPaymentsTransactionResource < BaseResource
+      # @return [String] the Starling internal ID of the transaction
+      def id
+        parsed_data['id']
+      end
+
+      # @return [String] the currency of the transaction (e.g. "GBP" or "UAH")
+      def currency
+        parsed_data['currency']
+      end
+
+      # @return [Float] the amount of the transaction
+      def amount
+        present_float(parsed_data['amount'])
+      end
+
+      # @return [Symbol] the direction of the transaction (e.g. `:outbound`)
+      def direction
+        present_enum(parsed_data['direction'])
+      end
+
+      # @return [Time] the date and time when the transaction was recorded
+      def created
+        present_datetime(parsed_data['created'])
+      end
+      alias created_at created
+
+      # @return [String] the narrative of the transaction
+      def narrative
+        parsed_data['narrative']
+      end
+
+      # @return [Symbol] the source of the transaction (e.g. `:master_card`)
+      def source
+        present_enum(parsed_data['source'])
+      end
+
+      # @return [String, nil] the Starling internal ID of the contact who sent the
+      #                       payment, or nil if they are not one of the user's contacts
+      def sending_contact_id
+        parsed_data['sendingContactId']
+      end
+
+      # @return [String, nil] the Starling internal ID of the contact account which sent
+      #                       the payment, or nil if they are not one of the user's
+      #                       contacts
+      def sending_contact_account_id
+        parsed_data['sendingContactAccountId']
+      end
+    end
+  end
+end

data/lib/starling/resources/mastercard_transaction_resource.rb

@@ -0,0 +1,73 @@
+module Starling
+  module Resources
+    # A resource representing a Transaction returned from the Transactions Mastercard API
+    class MastercardTransactionResource < BaseResource
+      # @return [String] the Starling internal ID of the transaction
+      def id
+        parsed_data['id']
+      end
+
+      # @return [String] the currency of the transaction (e.g. "GBP" or "UAH")
+      def currency
+        parsed_data['currency']
+      end
+
+      # @return [Float] the amount of the transaction
+      def amount
+        present_float(parsed_data['amount'])
+      end
+
+      # @return [Symbol] the direction of the transaction (e.g. `:outbound`)
+      def direction
+        present_enum(parsed_data['direction'])
+      end
+
+      # @return [Time] the date and time when the transaction was recorded
+      def created
+        present_datetime(parsed_data['created'])
+      end
+      alias created_at created
+
+      # @return [String] the narrative of the transaction
+      def narrative
+        parsed_data['narrative']
+      end
+
+      # @return [Symbol] the source of the transaction (e.g. `:master_card`)
+      def source
+        present_enum(parsed_data['source'])
+      end
+
+      # @return [Symbol] the MasterCard transaction method of the transaction (e.g.
+      #                  `:contactless`)
+      def mastercard_transaction_method
+        present_enum(parsed_data['mastercardTransactionMethod'])
+      end
+
+      # @return [Symbol] the status of the transaction (e.g. `:settled`)
+      def status
+        present_enum(parsed_data['status'])
+      end
+
+      # @return [String] the source currency of the transaction (e.g. "GBP" or "UAH")
+      def source_currency
+        parsed_data['sourceCurrency']
+      end
+
+      # @return [Float] the source amount of the transaction
+      def source_amount
+        present_float(parsed_data['sourceAmount'])
+      end
+
+      # @return [String] the Starling internal ID of the merchant
+      def merchant_id
+        parsed_data['merchantId']
+      end
+
+      # @return [String] the Starling internal ID of the merchant location
+      def merchant_location_id
+        parsed_data['merchantLocationId']
+      end
+    end
+  end
+end