pagseguro-sdk 2.6.2

data/lib/pagseguro/subscription_transaction.rb

@@ -0,0 +1,29 @@
+module PagSeguro
+  class SubscriptionTransaction
+    include Extensions::MassAssignment
+
+    STATUSES = {
+      waiting_payment: 1,
+      in_review: 2,
+      paid: 3,
+      available: 4,
+      in_dispute: 5,
+      returned: 6,
+      canceled: 7,
+      charged: 8,
+      temporary_retention: 9
+    }
+
+    attr_accessor :code
+    attr_accessor :status
+    attr_accessor :date
+
+    def status_code
+      STATUSES[status.to_sym]
+    end
+
+    def ==(object)
+      [code, status, date] == [object.code, object.status, object.date]
+    end
+  end
+end

data/lib/pagseguro/subscription_transactions.rb

@@ -0,0 +1,5 @@
+module PagSeguro
+  class SubscriptionTransactions
+    include Extensions::CollectionObject
+  end
+end

data/lib/pagseguro/transaction.rb

@@ -0,0 +1,215 @@
+module PagSeguro
+  class Transaction
+    ONE_DAY_IN_SECONDS = 86400
+    FIFTEEN_MINUTES_IN_SECONDS = 900
+
+    include Extensions::MassAssignment
+    include Extensions::EnsureType
+    include Extensions::Credentiable
+
+    # When the payment request was created.
+    attr_accessor :created_at
+
+    # The transaction code.
+    attr_accessor :code
+
+    # The reference code identifies the order you placed on the payment request.
+    # It's used by the store and can be something like the order id.
+    attr_accessor :reference
+
+    # The transaction type.
+    attr_accessor :type_id
+
+    # The last notification's update.
+    attr_accessor :updated_at
+
+    # The transaction status.
+    attr_reader :status
+
+    # The payment method.
+    attr_reader :payment_method
+
+    # The boleto payment url.
+    attr_accessor :payment_link
+
+    # The gross amount.
+    attr_accessor :gross_amount
+
+    # The discount amount.
+    attr_accessor :discount_amount
+
+    # The charged fees.
+    attr_reader :creditor_fees
+
+    # The net amount.
+    attr_accessor :net_amount
+
+    # Set the extra amount applied to the transaction's total.
+    # It's considered as an extra charge when positive, or a discount if
+    # negative.
+    attr_accessor :extra_amount
+
+    # The installment count.
+    attr_accessor :installments
+
+    # The payer information (who is sending money).
+    attr_reader :sender
+
+    # The shipping information.
+    attr_reader :shipping
+
+    # The cancellation source.
+    attr_accessor :cancellation_source
+
+    # The escrow end date.
+    attr_accessor :escrow_end_date
+
+    # Set the transaction errors.
+    attr_reader :errors
+
+    # Find a transaction by its transactionCode
+    # Return a PagSeguro::Transaction instance
+    def self.find_by_code(code, options = {})
+      load_from_response send_request("transactions/#{code}", options)
+    end
+
+    # Find a transaction by its notificationCode.
+    # Return a PagSeguro::Transaction instance.
+    def self.find_by_notification_code(code, options = {})
+      load_from_response send_request("transactions/notifications/#{code}", options)
+    end
+
+    # Search transactions within a date range.
+    # Return a PagSeguro::SearchByDate instance
+    #
+    # Options:
+    #
+    # # +starts_at+: the starting date. Defaults to the last 24-hours.
+    # # +ends_at+: the ending date.
+    # # +page+: the current page.
+    # # +per_page+: the result limit.
+    #
+    def self.find_by_date(options = {}, page = 0)
+      options = {
+        starts_at: Time.now - ONE_DAY_IN_SECONDS,
+        ends_at: Time.now,
+        per_page: 50
+      }.merge(options)
+      SearchByDate.new("transactions", options, page)
+    end
+
+    # Search a transaction by its reference code
+    # Return a PagSeguro::SearchByReference instance
+    #
+    # Options:
+    #
+    # # +reference+: the transaction reference code
+    #
+    def self.find_by_reference(reference, options = {})
+      SearchByReference.new("transactions", { reference: reference }.merge(options))
+    end
+
+    # Get abandoned transactions.
+    # Return a PagSeguro::SearchByDate instance
+    #
+    # Options:
+    #
+    # # +starts_at+: the starting date. Defaults to the last 24-hours.
+    # # +ends_at+: the ending date. Defaults to 15 minutes ago. **Attention:** you have to set it this to <tt>Time.now - 15 minutes</tt>, otherwise the "finalDate must be lower than allowed limit" error will be returned.
+    # # +page+: the current page.
+    # # +per_page+: the result limit.
+    #
+    def self.find_abandoned(options = {}, page = 0)
+      options = {
+        starts_at: Time.now - ONE_DAY_IN_SECONDS,
+        ends_at: Time.now - FIFTEEN_MINUTES_IN_SECONDS,
+        per_page: 50
+      }.merge(options)
+
+      SearchAbandoned.new("transactions/abandoned", options, page)
+    end
+
+    # Normalize creditor fees object
+    def creditor_fees=(creditor_fees)
+      @creditor_fees = ensure_type(CreditorFee, creditor_fees)
+    end
+
+    # Normalize the sender object.
+    def sender=(sender)
+      @sender = ensure_type(Sender, sender)
+    end
+
+    # Normalize the shipping object.
+    def shipping=(shipping)
+      @shipping = ensure_type(Shipping, shipping)
+    end
+
+    # Hold the transaction's payments
+    def payment_releases
+      @payment_releases ||= PaymentReleases.new
+    end
+
+    # Normalize the transaction's payments list
+    def payment_releases=(_payments)
+      _payments.each { |payment| payment_releases << payment }
+    end
+
+    # Hold the transaction's items.
+    def items
+      @items ||= Items.new
+    end
+
+    # Normalize the items list.
+    def items=(_items)
+      _items.each {|item| items << item }
+    end
+
+    # Normalize the payment method.
+    def payment_method=(payment_method)
+      @payment_method = ensure_type(PaymentMethod, payment_method)
+    end
+
+    # Normalize the payment status.
+    def status=(status)
+      @status = ensure_type(PaymentStatus, status)
+    end
+
+    # Set errors.
+    def errors
+      @errors ||= Errors.new
+    end
+
+    # Update all attributes
+    def update_attributes(attrs)
+      attrs.each { |name, value| send("#{name}=", value) }
+    end
+
+    # Serialize the XML object.
+    def self.load_from_xml(xml) # :nodoc:
+      new Serializer.new(xml).serialize
+    end
+
+    private
+    def self.api_version
+      'v3'
+    end
+
+    def after_initialize
+      @errors = Errors.new
+    end
+
+    # Serialize the HTTP response into data.
+    def self.load_from_response(request) # :nodoc:
+      transaction = new
+      response = Response.new(request, transaction)
+      response.serialize
+
+      transaction
+    end
+
+    # Send a get request to v3 API version, with the path given
+    def self.send_request(path, options = {})
+      Request.get(path, api_version, options)
+    end
+  end
+end

data/lib/pagseguro/transaction/collection.rb

@@ -0,0 +1,20 @@
+module PagSeguro
+  class Transaction
+    class Collection
+      extend Forwardable
+
+      def_delegators :@transactions, :each, :empty?, :any?
+
+      def transactions=(objects)
+        @transactions = objects
+      end
+
+      def errors
+        @errors ||= Errors.new
+      end
+
+      # PagSeguro::TransactionStatus instances.
+      attr_reader :transactions
+    end
+  end
+end

data/lib/pagseguro/transaction/response.rb

@@ -0,0 +1,45 @@
+module PagSeguro
+  class Transaction
+    class Response
+      def initialize(response, object)
+        @response = response
+        @object = object
+      end
+
+      def serialize
+        if success?
+          object.update_attributes(Serializer.new(xml).serialize)
+        else
+          object.errors.add response
+        end
+
+        object
+      end
+
+      def serialize_statuses
+        if success?
+          object.statuses = Serializer.new(xml).serialize_status_history
+        else
+          object.errors.add(response)
+        end
+
+        object
+      end
+
+      def success?
+        response.success? && response.xml?
+      end
+
+      # The http response.
+      attr_reader :response
+
+      # Set the that will receive errors or updates
+      attr_reader :object
+
+      private
+      def xml
+        Nokogiri::XML(response.body)
+      end
+    end
+  end
+end

data/lib/pagseguro/transaction/search.rb

@@ -0,0 +1,121 @@
+module PagSeguro
+  class Search
+    # Set the report options.
+    #
+    # # +per_page+: the page size.
+    # # +starts_at+: the report's starting date. Can't be older than 6 months.
+    # # +ends_at+: the report's ending date. Can't be greater than 30 days from the starting date.
+    #
+    attr_reader :options
+
+    # Set the errors from the report request.
+    attr_reader :errors
+
+    # Return the current page.
+    attr_reader :page
+
+    def initialize(path, options, page = 0)
+      @path = path
+      @options = options
+      @page = page
+    end
+
+    # Return the list of transactions.
+    # Each item will be wrapped in a PagSeguro::Transaction instance.
+    # Notice that transactions instantiated by the report won't have all attributes.
+    # If you need additional attributes, do a PagSeguro::Transaction.find_by_notification_code
+    # call. Remember that this will perform an additional HTTP request.
+    def transactions
+      xml do |xml|
+        xml.css("transactionSearchResult > transactions > transaction").map do |node|
+          Transaction.load_from_xml(node)
+        end
+      end
+    end
+
+    # The report's creation date.
+    def created_at
+      xml do |xml|
+        @created_at ||= Time.parse xml.css("transactionSearchResult > date").text
+      end
+    end
+
+    # How many results the report returned on the given page.
+    def results
+      xml do |xml|
+        @results ||= xml.css("transactionSearchResult > resultsInThisPage").text.to_i
+      end
+    end
+
+    # How many pages the report returned.
+    def total_pages
+      xml do |xml|
+        @total_pages ||= xml.css("transactionSearchResult > totalPages").text.to_i
+      end
+    end
+
+    # Detect if the report has a next page.
+    def next_page?
+      page.zero? || page < total_pages
+    end
+
+    # Detect if the report has a previous page.
+    def previous_page?
+      page > 1
+    end
+
+    # Move the page pointer to the next page.
+    def next_page!
+      return unless next_page?
+      @page += 1
+      clear!
+    end
+
+    # Move the page pointer to the previous page.
+    def previous_page!
+      return unless previous_page?
+      @page -= 1
+      clear!
+    end
+
+    # Detect if the report request returned errors.
+    def valid?
+      fetch { errors.empty? }
+    end
+
+    private
+    def perform_request_and_serialize
+      raise NotImplementedError.new("'.perform_request_and_serialize' must be implemented in specific search class")
+    end
+
+    # The default PagSeguro API version
+    def api_version
+      'v3'
+    end
+
+    def fetched?
+      @fetched
+    end
+
+    def fetched!
+      @fetched = true
+    end
+
+    def clear!
+      @fetched = false
+    end
+
+    def fetch(&block)
+      unless fetched?
+        perform_request_and_serialize
+        fetched!
+      end
+
+      instance_eval(&block)
+    end
+
+    def xml(&block)
+      valid? && block.call(@response.data)
+    end
+  end
+end

data/lib/pagseguro/transaction/search/search_abandoned.rb

@@ -0,0 +1,20 @@
+module PagSeguro
+  class SearchAbandoned < PagSeguro::Search
+    private
+    def perform_request_and_serialize
+      @response = Request.get(@path, api_version,
+        {
+          initialDate: options[:starts_at].xmlschema,
+          finalDate: options[:ends_at].xmlschema,
+          page: page,
+          maxPageResults: options.fetch(:per_page, 50),
+          credentials: options[:credentials]
+        })
+      @errors = Errors.new(@response)
+    end
+
+    def api_version
+      'v2'
+    end
+  end
+end