paypkg 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af42bba52af920b74d5f2643e3f8689f5d893e0
-  data.tar.gz: 10e1c7dd26eb17d6d568c379ffe614190e13f278
+  metadata.gz: 04971f9b28415697d2b097efbd0d33fa26e1cba8
+  data.tar.gz: f569dacfcd0f7e0fa5a869779cf689505c8ab8de
 SHA512:
-  metadata.gz: eb1498285a83bde51951541cb1f7a005682ca8b88e7712bccb62a78782e4e72848a8df4b8d4a90564fcc9b0bbaf10c4b9a6f3f5b39b7d38eaf774782d4ae9ee8
-  data.tar.gz: b7b5d96cbaeb9dee35515acbf592b5496fa38270e3810c241618697a6d683fce5c1009b4d171b9e3fec220a51c1a0ea977aa493418a553012bedc4ff91a03a36
+  metadata.gz: 9941a82ddbdaa08ba00955680394614b5f0cb39cf29187be894aadb77d29093cd78a4dd50572f9269e27860a83f0b0c958c756527a6e8acf4a19a7714a686a0f
+  data.tar.gz: e00e4f1c0b547d006551df380876e7b8a5a18581ec8450a7bb04719dec24aef8c29e03fb349746968db01fac4b3950fdc2bc8f00b18dd94616297e18aba33d81

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.1.5
+* Moved the release date into the same file as the version so as not to forget to change it along with the version number.
+
+0.1.4
+-----
+* Added a new method 'error_data' which returns a standardized error response.
+  This method should only be called when 'call_paypal' returns false.
+
 0.1.3
 -----
 * Removed unused parameter from accept_pp_payment.

data/lib/paypkg.rb

@@ -152,6 +152,84 @@ public
   def response
     if hash.last then PaypkgResponse.new(hash.last) else nil end
   end
+
+  # This method collects the response data in such a way as to guarantee
+  # valid Ruby stuctures will be generated, i.e., you won't get a
+  # runtime error because of nil, etc.
+  #
+  # It produces 3 outputs:
+  #  (1) A non-nil error hash
+  #   {
+  #     :name => "VALIDATION_ERROR",
+  #     :details => [
+  #       {
+  #         :field => "payer.funding_instruments[0].credit_card.number",
+  #         :issue => "Value is invalid"
+  #       },
+  #       {
+  #         :field => "payer.funding_instruments[0].credit_card.number",
+  #         :issue => "Number is crap"
+  #       }
+  #     ],
+  #     :message => "Invalid request - see details",
+  #     :information_link => "https://developer.paypal.com/webapps/developer/docs/api/#VALIDATION_ERROR",
+  #     :debug_id => "88dcf0c1730bb"
+  #   }
+  #  (2) A non-nil response object
+  #    <PaypkgResponse:0x00000001e60040 @name="VALIDATION_ERROR",
+  #      @details=[
+  #        <PaypkgResponse:0x00000001e73e10 @field="payer.funding_instruments[0].credit_card.number", @issue="Value is invalid">, \
+  #        <PaypkgResponse:0x00000001e73988 @field="payer.funding_instruments[0].credit_card.number", @issue="Invalid card type"> \
+  #      ],
+  #     @message="Invalid request - see details", \
+  #     @information_link="https://developer.paypal.com/webapps/developer/docs/api/#VALIDATION_ERROR", \
+  #     @debug_id="88dcf0c1730bb"
+  #    >
+  #  (3) A non-nil details array
+  #    [
+  #      {
+  #        :field => "payer.funding_instruments[0].credit_card.number",
+  #        :issue => "Value is invalid"
+  #      },
+  #      {
+  #        :field => "payer.funding_instruments[0].credit_card.number",
+  #        :issue => "Number is crap"
+  #      }
+  #    ]
+  def error_data
+      conditioned_details = []
+      if @hash.last
+        conditioned_hash = @hash.last
+        # sometimes there's details, sometimes not
+        if conditioned_hash.has_key?(:details)
+          # process errors
+          conditioned_hash[:details].each do |detail|
+            conditioned_details << detail
+          end
+        end
+      else
+        status = @status.last
+        case status[0]
+        when '4'
+          name = "CLIENT ERROR"
+          message = "The request sent to PayPal was invalid"
+        when '5'
+          name = "SERVER ERROR"
+          message = "PayPay's servers had a problem"
+        else
+          name = "UNKNOWN ERROR"
+          message = ""
+        end
+        conditioned_hash = {
+            :name => name,
+            :message => "%s. PayPal returned status code %s"%[message,status],
+            :information_link => "https://developer.paypal.com/webapps/developer/docs/api",
+            :debug_id => "0000000000000"
+          }
+      end
+      conditioned_response = PaypkgResponse.new(conditioned_hash)
+      return conditioned_hash, conditioned_response, conditioned_details
+  end
 end
 
 # This require loop has to be after the Paypkg class.

data/lib/paypkg/version.rb

@@ -1,3 +1,4 @@
 module Version
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
+  MODIFIED = "2014-07-22"
 end

data/paypkg.gemspec

@@ -2,11 +2,10 @@ require_relative File.dirname(__FILE__) + '/lib/paypkg/version'
 include Version
 Gem::Specification.new do |s|
   s.name          = 'paypkg'
-  # when changing version, also change the lib/paypkg.rb
   s.version       = VERSION
-  s.date          = '2014-04-22'
+  s.date          = MODIFIED
   s.summary       = 'Simple PayPal Connection for Ruby'
-  s.description   = "This gem uses Net::HTTP to communicate with the PayPal servers. It has calls for the most common PayPal functions to simplify using PayPal in a Ruby application."
+  s.description   = "This gem uses Net::HTTP to communicate with the PayPal servers. It has calls for the most common PayPal functions to simplify using PayPal in a Ruby application. I developed this package as a way to call PayPal's REST API with greater transparancy than the paypal-sdk-rest gem has, making development easier. This package can be easily extended by simply adding additional methods (as files) to the lib/paypkg folder. Contributions welcome."
   s.authors       = ["Michael J. Welch, Ph.D."]
   s.email         = 'rubygems@czarmail.com'
   s.files         = Dir.glob(["paypkg.gemspec", "config/paypkg.yml", "CHANGELOG.md", "README.md", "README.html", "lib/paypkg.rb", "lib/paypkg/*", "test/*", "test/paypkg_test/*" ])

metadata

@@ -1,17 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: paypkg
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Michael J. Welch, Ph.D.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies: []
 description: This gem uses Net::HTTP to communicate with the PayPal servers. It has
   calls for the most common PayPal functions to simplify using PayPal in a Ruby application.
+  I developed this package as a way to call PayPal's REST API with greater transparancy
+  than the paypal-sdk-rest gem has, making development easier. This package can be
+  easily extended by simply adding additional methods (as files) to the lib/paypkg
+  folder. Contributions welcome.
 email: rubygems@czarmail.com
 executables: []
 extensions: []