promisepay 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 720f65f4244539bf6ba85c933da844e316175e79
-  data.tar.gz: 51b022522725cc0d87a93de9a39ec92d59e1bef9
+  metadata.gz: 174ed6f8678e430701da0c172bfc2bc1fc48d93e
+  data.tar.gz: e7cf1118146b2dbcf34157b299258b7522ffe75f
 SHA512:
-  metadata.gz: c986f0beea300497a1d8ae57b1d662739e822189efd3d1e7de7ed2dd19a76a9c19445f1f7c86fc579420b5d99ce53a874b8cf6fcff3b6986f3ec45ee2cea783f
-  data.tar.gz: 0e76772a62fa67e0ff7e6ba8794dfe29c530f3d7b4efb37f80e164f8f722476259182e44b3dcb1e4c70295a76e5eee69774285f0f740d4208d152f9ac29b96ce
+  metadata.gz: 59c33e45e95b0d7c718631f3f44f2ad83c32b5d421a6cb9f26eefe29d989cf5bb8bc496a4f56dc8b944cdb59f9efbd61c24a14cab6634a11c0f0640f2d63907e
+  data.tar.gz: 00135493b031cff9e61de1c06acad38cc82edc6bf48c187c5deebe8ccc1fb40a0c4936fd567fc637bc55d9951edefd5b0c966fb241cb35de2bc391c28c153383

data/README.md

@@ -274,6 +274,10 @@ item.request_refund(
   refund_message: 'because'
 )
 ```
+#####Decline refund
+```ruby
+item.decline_refund
+```
 #####Refund
 ```ruby
 item.refund(
@@ -281,6 +285,30 @@ item.refund(
   refund_message: 'because'
 )
 ```
+#####Raise dispute
+```ruby
+item.raise_dispute(user_id: '5830def0-ffe8-11e5-86aa-5e5517507c66')
+```
+#####Request resolve dispute
+```ruby
+item.request_resolve_dispute
+```
+#####Resolve dispute
+```ruby
+item.resolve_dispute
+```
+#####Escalate dispute
+```ruby
+item.escalate_dispute
+```
+#####Send tax invoice
+```ruby
+item.send_tax_invoice
+```
+#####Request tax invoice
+```ruby
+item.request_tax_invoice
+```
 ##Card Accounts
 #####Create a card account
 ```ruby
@@ -527,6 +555,22 @@ dda = client.direct_debit_authorities.find('8f233e04-ffaa-4c9d-adf9-244853848e21
 dda.delete
 ```
 
+##Tools
+#####Health check
+```ruby
+client.tools.health_check
+```
+##Marketplace
+```ruby
+client.marketplace
+```
+
+##Token
+#####Generate
+```ruby
+client.generate_token(token_type: 'card', user_id: '5830def0-ffe8-11e5-86aa-5e5517507c66')
+```
+
 _Check out the [online documentation](http://promisepay.github.io/promisepay-ruby/) to get a full list of available resources and methods._
 
 #4. Contributing

data/lib/promisepay/client.rb

@@ -27,6 +27,7 @@ require_relative 'resources/token_resource'
 require_relative 'resources/transaction_resource'
 require_relative 'resources/user_resource'
 require_relative 'resources/wallet_account_resource'
+require_relative 'tool'
 require 'json'
 require 'faraday'
 
@@ -112,6 +113,15 @@ module Promisepay
       response
     end
 
+    # Show details of your Platform.
+    #
+    # @see https://reference.promisepay.com/#show-marketplace
+    #
+    # @return [Hash]
+    def marketplace
+      JSON.parse(get('marketplace').body)['marketplaces']
+    end
+
     # Available resources for {Client}
     #
     # @return [Hash]
@@ -128,6 +138,7 @@ module Promisepay
         transactions: TransactionResource,
         users: UserResource,
         tokens: TokenResource,
+        tools: Tool,
         wallet_accounts: WalletAccountResource
       }
     end
@@ -150,10 +161,23 @@ module Promisepay
       @resources ||= {}
     end
 
+    # Create a card token that can be used with the PromisePay.js package
+    # to securely send PromisePay credit card details.
+    #
+    # @param options [Hash] Optional options.
+    # @option options [String] :token_type token type ID.
+    # @option user_id [String] :user_id Buyer or Seller ID (already created).
+    #
+    # @return [Hash]
+    def generate_token(options)
+      response = JSON.parse(post("token_auths", options).body)
+      response['token_auth']
+    end
+
     private
 
     def on_complete(response)
-      fail Promisepay::Error.from_response(response) unless response.success?
+      fail Promisepay::Error.from_response(response, @errors_format) unless response.success?
     end
   end
 end

data/lib/promisepay/configurable.rb

@@ -12,8 +12,10 @@ module Promisepay
     # @!attribute username
     #   @see http://docs.promisepay.com/v2.2/docs/overview-2
     #   @return [String] Promisepay username for Basic Authentication.
+    # @!attribute errors_format
+    #   @return [String] {'processed', 'raw'} format to be used for exception messages.
 
-    attr_accessor :api_domain, :environment, :token, :username
+    attr_accessor :api_domain, :environment, :token, :username, :errors_format
 
     class << self
       # List of configurable keys for {Promisepay::Client}.
@@ -24,7 +26,8 @@ module Promisepay
           :environment,
           :api_domain,
           :token,
-          :username
+          :username,
+          :errors_format
         ]
       end
     end

data/lib/promisepay/default.rb

@@ -42,6 +42,13 @@ module Promisepay
       def username
         ENV['PROMISEPAY_USERNAME']
       end
+
+      # Default username from ENV.
+      #
+      # @return [String]
+      def errors_format
+        ENV['PROMISEPAY_ERRORS_FORMAT'] || 'processed'
+      end
     end
   end
 end

data/lib/promisepay/error.rb

@@ -5,7 +5,7 @@ module Promisepay
     #
     # @param [Faraday::Response] response Faraday HTTP response
     # @return [Promisepay::Error]
-    def self.from_response(response)
+    def self.from_response(response, errors_format = nil)
       klass = case response.status
               when 400      then Promisepay::BadRequest
               when 401      then Promisepay::Unauthorized
@@ -22,11 +22,12 @@ module Promisepay
               when 503      then Promisepay::ServiceUnavailable
               when 500..599 then Promisepay::ServerError
               end
-      (klass) ? klass.new(response) : new(response)
+      (klass) ? klass.new(response, errors_format) : new(response, errors_format)
     end
 
-    def initialize(response = nil)
+    def initialize(response = nil, errors_format = nil)
       @response = response
+      @errors_format =  errors_format
       super(build_error_message)
     end
 
@@ -35,14 +36,18 @@ module Promisepay
     def build_error_message
       return nil if @response.nil? || @response.body.nil?
 
-      json_response = JSON.parse(@response.body)
-      message = ''
-      message << json_response['message'] if json_response.key?('message')
-      if json_response.key?('errors')
-        message << json_response['errors'].map{|attribute, content| "#{attribute}: #{content}"}.join(", ")
+      case @errors_format
+      when 'raw'
+        @response.body
+      else
+        json_response = JSON.parse(@response.body)
+        message = ''
+        message << json_response['message'] if json_response.key?('message')
+        if json_response.key?('errors')
+          message << json_response['errors'].map{|attribute, content| "#{attribute}: #{content}"}.join(", ")
+        end
+        message
       end
-
-      message
     end
   end
 

data/lib/promisepay/models/item.rb

@@ -184,6 +184,17 @@ module Promisepay
       true
     end
 
+    # Decline a refund request for an Item.
+    #
+    # @see https://reference.promisepay.com/#decline-refund
+    #
+    # @return [Boolean]
+    def decline_refund
+      response = JSON.parse(@client.patch("items/#{send(:id)}/decline_refund").body)
+      @attributes = response['items']
+      true
+    end
+
     # Refund an Item’s funds held in escrow.
     #
     # @see https://reference.promisepay.com/#refund
@@ -195,6 +206,50 @@ module Promisepay
       true
     end
 
+    # Raise a dispute for the Item.
+    #
+    # @see https://reference.promisepay.com/#raise-dispute
+    #
+    # @return [Boolean]
+    def raise_dispute(options = {})
+      response = JSON.parse(@client.patch("items/#{send(:id)}/raise_dispute", options).body)
+      @attributes = response['items']
+      true
+    end
+
+    # Request that the dispute be resolved.
+    #
+    # @see https://reference.promisepay.com/#request-dispute-resolution
+    #
+    # @return [Boolean]
+    def request_resolve_dispute
+      response = JSON.parse(@client.patch("items/#{send(:id)}/request_resolve_dispute").body)
+      @attributes = response['items']
+      true
+    end
+
+    # Resolve a dispute.
+    #
+    # @see https://reference.promisepay.com/#resolve-dispute
+    #
+    # @return [Boolean]
+    def resolve_dispute
+      response = JSON.parse(@client.patch("items/#{send(:id)}/resolve_dispute").body)
+      @attributes = response['items']
+      true
+    end
+
+    # Escalate a dispute raised against an Item.
+    #
+    # @see https://reference.promisepay.com/#escalate-dispute
+    #
+    # @return [Boolean]
+    def escalate_dispute
+      response = JSON.parse(@client.patch("items/#{send(:id)}/escalate_dispute").body)
+      @attributes = response['items']
+      true
+    end
+
     # Cancel an Item.
     #
     # @see https://reference.promisepay.com/#cancel
@@ -205,5 +260,27 @@ module Promisepay
       @attributes = response['items']
       true
     end
+
+    # Email a Tax Invoice to the Users associated with the Item.
+    #
+    # @see https://reference.promisepay.com/#send-tax-invoice
+    #
+    # @return [Boolean]
+    def send_tax_invoice
+      response = JSON.parse(@client.patch("items/#{send(:id)}/send_tax_invoice").body)
+      @attributes = response['items']
+      true
+    end
+
+    # Request a Tax Invoice be sent to the Users associated with an Item.
+    #
+    # @see https://reference.promisepay.com/#request-tax-invoice
+    #
+    # @return [Boolean]
+    def request_tax_invoice
+      response = JSON.parse(@client.patch("items/#{send(:id)}/request_tax_invoice").body)
+      @attributes = response['items']
+      true
+    end
   end
 end

data/lib/promisepay/tool.rb

@@ -0,0 +1,17 @@
+module Promisepay
+  # Resource for the Tools API
+  class Tool
+    def initialize(client)
+      @client = client
+    end
+
+    # Displays a health check of the PromisePay service.
+    #
+    # @see https://reference.promisepay.com/#health-check
+    #
+    # @return [Hash]
+    def health_check
+      JSON.parse(@client.get('status').body)
+    end
+  end
+end

data/lib/promisepay/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module Promisepay
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promisepay
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Romain Vigo Benia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,7 @@ files:
 - lib/promisepay/resources/transaction_resource.rb
 - lib/promisepay/resources/user_resource.rb
 - lib/promisepay/resources/wallet_account_resource.rb
+- lib/promisepay/tool.rb
 - lib/promisepay/version.rb
 - promisepay.gemspec
 homepage: https://github.com/PromisePay/promisepay-ruby