pagseguro-oficial 2.0.5

data/lib/pagseguro/payment_request.rb

@@ -0,0 +1,96 @@
+module PagSeguro
+  class PaymentRequest
+    include Extensions::MassAssignment
+    include Extensions::EnsureType
+
+    # Set the payment currency.
+    # Defaults to BRL.
+    attr_accessor :currency
+
+    # Get the payment sender.
+    attr_reader :sender
+
+    # Get the shipping info.
+    attr_reader :shipping
+
+    # Set the redirect url.
+    # The URL that will be used by PagSeguro to redirect the user after
+    # the payment information is processed. Typically this is a
+    # confirmation page on your web site.
+    attr_accessor :redirect_url
+
+    # Set the extra amount to be applied to the transaction's total.
+    # This value can be used to add an extra charge to the transaction
+    # or provide a discount, if negative.
+    attr_accessor :extra_amount
+
+    # Set the reference code.
+    # Optional. You can use the reference code to store an identifier so you can
+    # associate the PagSeguro transaction to a transaction in your system.
+    # Tipically this is the order id.
+    attr_accessor :reference
+
+    # Set the payment request duration, in seconds.
+    attr_accessor :max_age
+
+    # How many times the payment redirect uri returned by the payment
+    # web service can be accessed.
+    # Optional. After this payment request is submitted, the payment
+    # redirect uri returned by the payment web service will remain valid
+    # for the number of uses specified here.
+    attr_accessor :max_uses
+
+    # Determines for which url PagSeguro will send the order related
+    # notifications codes.
+    # Optional. Any change happens in the transaction status, a new notification
+    # request will be send to this url. You can use that for update the related
+    # order.
+    attr_accessor :notification_url
+
+    # Determines for which url PagSeguro will send the buyer when he doesn't
+    # complete the payment.
+    attr_accessor :abandon_url
+
+    # The email that identifies the request. Defaults to PagSeguro.email
+    attr_accessor :email
+
+    # The token that identifies the request. Defaults to PagSeguro.token
+    attr_accessor :token
+
+
+    # Products/items in this payment request.
+    def items
+      @items ||= Items.new
+    end
+
+    # Set the payment sender.
+    def sender=(sender)
+      @sender = ensure_type(Sender, sender)
+    end
+
+    # Set the shipping info.
+    def shipping=(shipping)
+      @shipping = ensure_type(Shipping, shipping)
+    end
+
+    # Calls the PagSeguro web service and register this request for payment.
+    def register
+      params = Serializer.new(self).to_params.merge({
+        email: email,
+        token: token
+      })
+      Response.new Request.post("checkout", params)
+    end
+
+    private
+    def before_initialize
+      self.currency = "BRL"
+      self.email    = PagSeguro.email
+      self.token    = PagSeguro.token
+    end
+
+    def endpoint
+      PagSeguro.api_url("checkout")
+    end
+  end
+end

data/lib/pagseguro/payment_status.rb

@@ -0,0 +1,33 @@
+module PagSeguro
+  class PaymentStatus
+    STATUSES = {
+      "0" => :initiated,
+      "1" => :waiting_payment,
+      "2" => :in_analysis,
+      "3" => :paid,
+      "4" => :available,
+      "5" => :in_dispute,
+      "6" => :refunded,
+      "7" => :cancelled,
+    }.freeze
+
+    # The payment status id.
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    # Dynamically define helpers.
+    STATUSES.each do |id, _status|
+      define_method "#{_status}?" do
+        _status == status
+      end
+    end
+
+    # Return a readable status.
+    def status
+      STATUSES.fetch(id.to_s) { raise "PagSeguro::PaymentStatus#id isn't mapped" }
+    end
+  end
+end

data/lib/pagseguro/phone.rb

@@ -0,0 +1,12 @@
+module PagSeguro
+  class Phone
+    include Extensions::MassAssignment
+
+    # Set the area code.
+    attr_accessor :area_code
+
+    # Set the phone number.
+    # Must have 7-9 numbers.
+    attr_accessor :number
+  end
+end

data/lib/pagseguro/report.rb

@@ -0,0 +1,124 @@
+module PagSeguro
+  class Report
+    # 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(item_class, path, options, page = 0)
+      @item_class = item_class
+      @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|
+        @transactions ||= xml.css("transactionSearchResult 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
+      @response = Request.get(@path, {
+        initialDate: options[:starts_at].xmlschema,
+        finalDate: options[:ends_at].xmlschema,
+        page: page,
+        maxPageResults: options.fetch(:per_page, 50)
+      })
+
+      @errors = Errors.new(@response)
+    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/request.rb

@@ -0,0 +1,78 @@
+module PagSeguro
+  module Request
+    extend self
+    extend Forwardable
+
+    # Delegates the <tt>:config</tt> and <tt>:configure</tt> methods
+    # to the <tt>:request</tt> method, which returns a Aitch::Namespace instance.
+    def_delegators :request, :config, :configure
+
+    # Perform a GET request.
+    #
+    # # +path+: the path that will be requested. Must be something like <tt>"transactions/code/739D69-79C052C05280-55542D9FBB33-CAB2B1"</tt>.
+    # # +data+: the data that will be sent as query string. Must be a Hash.
+    # # +headers+: any additional header that will be sent through the request.
+    #
+    def get(path, data = {}, headers = {})
+      execute :get, path, data, headers
+    end
+
+    # Perform a POST request.
+    #
+    # # +path+: the path that will be requested. Must be something like <tt>"checkout"</tt>.
+    # # +data+: the data that will be sent as body data. Must be a Hash.
+    # # +headers+: any additional header that will be sent through the request.
+    #
+    def post(path, data = {}, headers = {})
+      execute :post, path, data, headers
+    end
+
+    # Perform the specified HTTP request. It will include the API credentials,
+    # encoding and additional headers.
+    def execute(request_method, path, data, headers) # :nodoc:
+      request.public_send(
+        request_method,
+        PagSeguro.api_url(path),
+        extended_data(data),
+        extended_headers(request_method, headers)
+      )
+    end
+
+    private
+    def request
+      @request ||= Aitch::Namespace.new
+    end
+
+    def extended_data(data)
+      data.merge(
+        email: data[:email] || PagSeguro.email,
+        token: data[:token] || PagSeguro.token,
+        charset: PagSeguro.encoding
+      )
+    end
+
+    def extended_headers(request_method, headers)
+      headers.merge __send__("headers_for_#{request_method}")
+    end
+
+    def headers_for_post
+      {
+        "Accept-Charset" => PagSeguro.encoding,
+        "Content-Type" => "application/x-www-form-urlencoded; charset=#{PagSeguro.encoding}"
+      }
+    end
+
+    def headers_for_get
+      {
+        "Accept-Charset" => PagSeguro.encoding
+      }
+    end
+  end
+
+  Request.configure do |config|
+    config.default_headers = {
+      "lib-description"             => "ruby:#{PagSeguro::VERSION}",
+      "language-engine-description" => "ruby:#{RUBY_VERSION}"
+    }
+  end
+end

data/lib/pagseguro/sender.rb

@@ -0,0 +1,23 @@
+module PagSeguro
+  class Sender
+    include Extensions::MassAssignment
+    include Extensions::EnsureType
+
+    # Get the sender phone.
+    attr_reader :phone
+
+    # Set the sender name.
+    attr_accessor :name
+
+    # Set the sender e-mail.
+    attr_accessor :email
+
+    # Set the CPF document.
+    attr_accessor :cpf
+
+    # Set the sender phone.
+    def phone=(phone)
+      @phone = ensure_type(Phone, phone)
+    end
+  end
+end

data/lib/pagseguro/shipping.rb

@@ -0,0 +1,57 @@
+module PagSeguro
+  class Shipping
+    # Set the available shipping type.
+    TYPE = {
+      pac: 1,
+      sedex: 2,
+      not_specified: 3
+    }
+
+    # Define the error class for invalid type assignment.
+    InvalidShippingTypeError = Class.new(StandardError)
+
+    include Extensions::MassAssignment
+    include Extensions::EnsureType
+
+    # Define the shipping type id.
+    attr_reader :type_id
+
+    # Get the shipping type name.
+    attr_reader :type_name
+
+    # Get the address object.
+    attr_reader :address
+
+    # Set the shipping cost.
+    attr_accessor :cost
+
+    # Set the shipping address info.
+    def address=(address)
+      @address = ensure_type(Address, address)
+    end
+
+    # Set the shipping type.
+    # It raises the PagSeguro::Shipping::InvalidShippingTypeError exception
+    # when trying to assign an invalid type name.
+    def type_name=(type_name)
+      type_name = type_name.to_sym
+      @type_id = TYPE.fetch(type_name) {
+        raise InvalidShippingTypeError, "invalid #{type_name.inspect} type name"
+      }
+      @type_name = type_name
+    end
+
+    # Set the shipping type id.
+    # It raises the PagSeguro::Shipping::InvalidShippingTypeError exception
+    # when trying to assign an invalid type id.
+    def type_id=(id)
+      type_id = id.to_i
+
+      raise InvalidShippingTypeError,
+        "invalid #{id.inspect} type id" unless TYPE.value?(type_id)
+
+      @type_id = type_id
+      @type_name = TYPE.key(type_id)
+    end
+  end
+end

data/lib/pagseguro/transaction/response.rb

@@ -0,0 +1,12 @@
+module PagSeguro
+  class Transaction
+    class Response
+      # Set the response errors.
+      attr_reader :errors
+
+      def initialize(errors = Errors.new)
+        @errors = errors
+      end
+    end
+  end
+end