pagseguro-oficial 2.5.0 → 2.6.0

data/lib/pagseguro/subscription/subscription_search.rb

@@ -0,0 +1,135 @@
+module PagSeguro
+  class SubscriptionSearch
+    # 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)
+      @path = path
+      @page = options.delete(:page) || 0
+      @options = options
+      @errors = Errors.new
+    end
+
+    # Return the list of subscriptions.
+    # Each item will be wrapped in a PagSeguro::Subscription instance.
+    # Notice that subscriptions instantiated by the report won't have all attributes.
+    # If you need additional attributes, do a PagSeguro::Subscription.find_by_code
+    # call. Remember that this will perform an additional HTTP request.
+    def subscriptions
+      xml do |xml|
+        xml.css("preApprovalSearchResult > preApprovals > preApproval").map do |node|
+          Subscription.load_from_xml(node)
+        end
+      end
+    end
+
+    # The report's creation date.
+    def created_at
+      xml do |xml|
+        @created_at ||= Time.parse xml.css("preApprovalSearchResult > date").text
+      end
+    end
+
+    # How many results the report returned on the given page.
+    def results
+      xml do |xml|
+        @results = xml.css("preApprovalSearchResult > resultsInThisPage").text.to_i
+      end
+    end
+
+    # How many pages the report returned.
+    def total_pages
+      xml do |xml|
+        @total_pages ||= xml.css("preApprovalSearchResult > 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, api_version, params)
+      @errors = Errors.new(@response)
+    end
+
+    # The params that will be sent
+    def params
+      {}.tap do |param|
+        param[:credentials] = options[:credentials]
+        param[:page] = page unless page.zero?
+        param[:maxPageResults] = options[:per_page]
+        param[:initialDate] = options[:starts_at].xmlschema if options[:starts_at]
+        param[:finalDate] = options[:ends_at].xmlschema if options[:ends_at]
+        param[:interval] = options[:interval] if options[:interval]
+      end
+    end
+
+    # The default PagSeguro API version
+    def api_version
+      :v2
+    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/subscription_canceller.rb

@@ -0,0 +1,30 @@
+module PagSeguro
+  class SubscriptionCanceller
+    API_VERSION = :v2
+
+    include Extensions::MassAssignment
+    include Extensions::Credentiable
+
+    # The code of subscription, not the plan
+    attr_accessor :subscription_code
+
+    # Set errors
+    def errors
+      @errors ||= Errors.new
+    end
+
+    def save
+      request = Request.get_with_auth_on_url("pre-approvals/cancel/#{subscription_code}", API_VERSION, credentials)
+
+      Response.new(request, self).serialize
+
+      self
+    end
+
+    private
+
+    def after_initialize
+      @errors = Errors.new
+    end
+  end
+end

data/lib/pagseguro/subscription_canceller/response.rb

@@ -0,0 +1,34 @@
+module PagSeguro
+  class SubscriptionCanceller
+    class Response
+      # The http response.
+      attr_reader :response
+
+      # Set the object that will receive errors or updates
+      attr_reader :object
+
+      def initialize(response, object)
+        @response = response
+        @object = object
+      end
+
+      def serialize
+        unless success?
+          object.errors.add response
+        end
+
+        object
+      end
+
+      def success?
+        response.success? && response.xml?
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML(response.body)
+      end
+    end
+  end
+end

data/lib/pagseguro/subscription_change_payment.rb

@@ -0,0 +1,46 @@
+module PagSeguro
+  class SubscriptionChangePayment
+    include Extensions::Credentiable
+    include Extensions::EnsureType
+    include Extensions::MassAssignment
+
+    attr_accessor :subscription_code
+
+    attr_reader :sender
+    attr_reader :subscription_payment_method
+
+    def sender=(sender)
+      @sender = ensure_type(Sender, sender)
+    end
+
+    def holder=(holder)
+      @holder = ensure_type(Holder, holder)
+    end
+
+    def subscription_payment_method=(payment_method)
+      @subscription_payment_method = ensure_type(SubscriptionPaymentMethod, payment_method)
+    end
+
+    def errors
+      @errors ||= Errors.new
+    end
+
+    def update
+      request = Request.put_xml("pre-approvals/#{subscription_code}/payment-method", credentials, params)
+
+      Response.new(request, self).serialize
+
+      self
+    end
+
+    private
+
+    def params
+      RequestSerializer.new(self).serialize
+    end
+
+    def after_initialize
+      @errors = Errors.new
+    end
+  end
+end

data/lib/pagseguro/subscription_change_payment/request_serializer.rb

@@ -0,0 +1,80 @@
+module PagSeguro
+  class SubscriptionChangePayment
+    class RequestSerializer
+      extend Forwardable
+
+      def_delegators :object, :subscription_payment_method
+      def_delegators :subscription_payment_method, :holder
+      def_delegators :holder, :billing_address
+
+      attr_reader :object
+
+      def initialize(object)
+        @object = object
+      end
+
+      def serialize
+        build.to_xml(save_with:
+          Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS |
+          Nokogiri::XML::Node::SaveOptions::FORMAT
+        )
+      end
+
+      private
+
+      def build
+        Nokogiri::XML::Builder.new(encoding: PagSeguro.encoding) do |xml|
+          xml.send(:paymentMethod) {
+            xml.send(:type, 'CREDITCARD')
+
+            if object.sender
+              xml.send(:sender) {
+                xml.send(:hash_, object.sender.hash)
+                xml.send(:ip, object.sender.ip)
+              }
+            end
+
+            if object.subscription_payment_method
+              xml.send(:creditCard) {
+                xml.send(:token, subscription_payment_method.token)
+                if holder
+                  xml.send(:holder) {
+                    xml.send(:name, holder.name)
+                    xml.send(:birthDate, holder.birth_date.strftime("%d/%m/%Y"))
+
+                    if holder.phone
+                      xml.send(:phone) {
+                        xml.send(:areaCode, holder.phone.area_code)
+                        xml.send(:number, holder.phone.number)
+                      }
+                    end
+
+                    if holder.document
+                      xml.send(:document) {
+                        xml.send(:type, holder.document.type)
+                        xml.send(:value, holder.document.value)
+                      }
+                    end
+
+                    if billing_address
+                      xml.send(:billingAddress) {
+                        xml.send(:street, billing_address.street)
+                        xml.send(:number, billing_address.number)
+                        xml.send(:complement, billing_address.complement)
+                        xml.send(:district, billing_address.district)
+                        xml.send(:city, billing_address.city)
+                        xml.send(:state, billing_address.state)
+                        xml.send(:country, billing_address.country)
+                        xml.send(:postalCode, billing_address.postal_code)
+                      }
+                    end
+                  }
+                end
+              }
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/pagseguro/subscription_change_payment/response.rb

@@ -0,0 +1,26 @@
+module PagSeguro
+  class SubscriptionChangePayment
+    class Response
+
+      attr_reader :response
+      attr_reader :object
+
+      def initialize(response, object)
+        @response = response
+        @object = object
+      end
+
+      def serialize
+        unless success?
+          object.errors.add response
+        end
+
+        object
+      end
+
+      def success?
+        response.success? && response.xml?
+      end
+    end
+  end
+end

data/lib/pagseguro/subscription_change_status.rb

@@ -0,0 +1,50 @@
+module PagSeguro
+  class SubscriptionChangeStatus
+    include Extensions::MassAssignment
+    include Extensions::Credentiable
+
+    # Now, just available ACTIVE and SUSPENDED
+    STATUSES = {
+      active: 'ACTIVE',
+      suspended: 'SUSPENDED'
+    }
+
+    # Subscription's code that will be changed
+    attr_reader :code
+
+    # The status that will be set
+    attr_reader :status
+
+    def initialize(code, status)
+      @code = code
+      @status = status
+    end
+
+    # Set errors
+    def errors
+      @errors ||= Errors.new
+    end
+
+    def save
+      request = Request.put_xml("pre-approvals/#{code}/status", credentials, params)
+
+      Response.new(request, self).serialize
+
+      self
+    end
+
+    def status_text
+      STATUSES[status]
+    end
+
+    private
+
+    def params
+      RequestSerializer.new(self).serialize
+    end
+
+    def after_initialize
+      @errors = Errors.new
+    end
+  end
+end

data/lib/pagseguro/subscription_change_status/request_serializer.rb

@@ -0,0 +1,28 @@
+module PagSeguro
+  class SubscriptionChangeStatus
+    class RequestSerializer
+      attr_reader :object
+
+      def initialize(object)
+        @object = object
+      end
+
+      def serialize
+        build.to_xml(save_with:
+          Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS |
+          Nokogiri::XML::Node::SaveOptions::FORMAT
+        )
+      end
+
+      private
+
+      def build
+        Nokogiri::XML::Builder.new(encoding: PagSeguro.encoding) do |xml|
+          xml.send(:directPreApproval) {
+            xml.send(:status, object.status_text)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/pagseguro/subscription_change_status/response.rb

@@ -0,0 +1,26 @@
+module PagSeguro
+  class SubscriptionChangeStatus
+    class Response
+
+      attr_reader :response
+      attr_reader :object
+
+      def initialize(response, object)
+        @response = response
+        @object = object
+      end
+
+      def serialize
+        unless success?
+          object.errors.add response
+        end
+
+        object
+      end
+
+      def success?
+        response.success? && response.xml?
+      end
+    end
+  end
+end