paypal-sdk-rest 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5c7274698b9bb853894c15bc58b7396cef9607f
-  data.tar.gz: f897393c936db98771b3b07e747ae33044867be1
+  metadata.gz: 38b4da25c343ab05d78dd621d36bb49078596118
+  data.tar.gz: 34cfe1f759ef25430f2473191ce6a6df937c56c4
 SHA512:
-  metadata.gz: 8f14a3a24092aca8356609f67ee38a59a82e478746e0b058c779e21c94b9d7f3f8628a6a542a2fcc0783d664be66d0f8daf141384b7c3d906b3bb8a79f88e07b
-  data.tar.gz: 6ade26596828a8216ad4c340c7e0b376ecef2e7412fa62dd70352c3902d358fa18309100b46ad2e0e9e63226a5d3564092075e3c9bc7e8bc8d4fd2ea53bb985d
+  metadata.gz: 8a2b39a7bf199f4f636a332b096862edd7172c0d94751f783a2627eaef95ad9b8b246879597a0bfdced3be0e8c0ffd4f21b846cc492629250deaa3bfc13c1481
+  data.tar.gz: e5000ed76b0d7d699f3977b56470129e6ebfeb91a3636cf85b29b8ea9045381d23965e1c1c88e47f2600fd164833bba01218693c5f3f061b132705fe0b4eb916

data/lib/paypal-sdk/rest/data_types.rb

@@ -1,5 +1,6 @@
 require 'paypal-sdk-core'
 require 'uuidtools'
+require 'multi_json'
 
 module PayPal::SDK
   module REST
@@ -1011,6 +1012,161 @@ module PayPal::SDK
         end
       end
 
+      class WebhooksEventType < Base
+
+        def self.load_members
+          array_of :event_types, EventType
+        end
+
+        include RequestDataType
+
+        class << self
+          def all(options = {})
+            path = "v1/notifications/webhooks-event-types"
+            EventTypeList.new(api.get(path, options))
+          end
+        end
+      end
+
+      class EventTypeList < Base
+        def self.load_members
+          array_of  :event_types, EventType
+        end
+      end
+
+      class WebhookList < Base
+        def self.load_members
+          array_of  :webhooks, Webhook
+        end
+      end
+
+      class EventType < Base
+        def self.load_members
+          object_of :name, String
+          object_of :description, String
+        end
+      end
+
+      class WebhookEventList < Base
+        def self.load_members
+          object_of :count, Integer
+          array_of  :events, WebhookEvent
+          array_of :links, Links
+        end
+      end
+
+      class WebhookEvent < Base
+        def self.load_members
+          object_of :id, String
+          object_of :create_time, String
+          object_of :resource_type, String
+          object_of :event_type, String
+          object_of :summary, String
+          object_of :resource, Hash
+          array_of :links, Links
+        end
+
+        def resend()
+          path = "v1/notifications/webhooks-events/#{self.id}/resend"
+          WebhookEvent.new(api.post(path))
+        end
+
+        def get_resource()
+          webhook_resource_type = self.resource_type
+          resource_class = self.class.get_resource_class(webhook_resource_type)
+          if resource_class
+            return Object::const_get(resource_class).new(self.resource)
+          else
+            return self.resource
+          end
+        end
+
+        include RequestDataType
+
+        class << self
+
+          def get_resource_class(name)
+            class_array = PayPal::SDK::REST.constants.select {|c| Class === PayPal::SDK::REST.const_get(c)}
+            class_array.each do |classname|
+              if (classname.to_s.downcase == name.downcase)
+                return classname
+              end
+            end
+          end
+
+          def search(page_size, start_time, end_time)
+            path = "v1/notifications/webhooks-events"
+            options = { :page_size => page_size, :start_time => start_time, :end_time => end_time }
+            WebhookEventList.new(api.get(path, options))
+          end
+
+          def get(webhook_event_id)
+            raise ArgumentError.new("webhook_event_id required") if webhook_event_id.to_s.strip.empty?
+            path = "v1/notifications/webhooks-events/#{webhook_event_id}"
+            WebhookEvent.new(api.get(path))
+          end
+        end
+      end
+
+      class Webhook < Base
+
+        def self.load_members
+          object_of :id, String
+          object_of :url, String
+          array_of :event_types, EventType
+          array_of :links, Links
+        end
+
+        include RequestDataType
+
+        def create()
+          path = "v1/notifications/webhooks"
+          response = api.post(path, self.to_hash, http_header)
+          self.merge!(response)
+          Webhook.new(response)
+        end
+
+        def update(patch)
+          patch = Patch.new(patch) unless patch.is_a? Patch
+          patch_request = Array.new(1, patch.to_hash)
+          path = "v1/notifications/webhooks/#{self.id}"
+          response = api.patch(path, patch_request, http_header)
+          self.merge!(response)
+          success?
+        end
+
+        def delete()
+          path = "v1/notifications/webhooks/#{self.id}"
+          response = api.delete(path, {})
+          self.merge!(response)
+          success?
+        end
+
+        class << self
+          def get(webhook_id)
+            raise ArgumentError.new("webhook_id required") if webhook_id.to_s.strip.empty?
+            path = "v1/notifications/webhooks/#{webhook_id}"
+            Webhook.new(api.get(path))
+          end
+          def get_event_types(webhook_id)
+            raise ArgumentError.new("webhook_id required") if webhook_id.to_s.strip.empty?
+            path = "v1/notifications/webhooks/#{webhook_id}/event-types"
+            EventTypeList.new(api.get(path))
+          end
+          def all(options={})
+            path = "v1/notifications/webhooks"
+            WebhookList.new(api.get(path))
+          end
+
+          def simulate_event(webhook_id, url, event_type)
+            path = "v1/notifications/simulate-event"
+            options = { :webhook_id => webhook_id, :url => url, :event_type => event_type }
+            response = api.post(path, options)
+            WebhookEvent.new(response)
+          end
+        end
+      end
+
       class Payout < Base
 
         def self.load_members
@@ -1531,7 +1687,6 @@ module PayPal::SDK
 
         def execute()
           path = "v1/payments/billing-agreements/#{self.token}/agreement-execute"
-          puts path
           response = api.post(path, {}, http_header)
           self.merge!(response)
           success?

data/lib/paypal-sdk/rest/version.rb

@@ -1,7 +1,7 @@
 module PayPal
   module SDK
     module REST
-      VERSION = "1.1.3"
+      VERSION = "1.2.0"
     end
   end
 end

data/spec/log/rest_http.log

@@ -2,40 +2,38 @@ opening connection to api.sandbox.paypal.com:443...
 opened
 starting SSL for api.sandbox.paypal.com:443...
 SSL established
-<- "GET /v1/payments/payment/PAY-1234 HTTP/1.1\r\nX-Paypal-Sandbox-Email-Address: Platform.sdk.seller@gmail.com\r\nAuthorization: Bearer A015ZyrqDqUwads.muwOVYUAKx74DlwGYa04fIfu0xHAbW4\r\nContent-Type: application/json\r\nUser-Agent: PayPalSDK/rest-sdk-ruby 1.1.3 (paypal-sdk-core 1.1.3; ruby 2.1.2p95-x86_64-darwin13.0)\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nHost: api.sandbox.paypal.com\r\n\r\n"
+<- "GET /v1/payments/payment/PAY-1234 HTTP/1.1\r\nX-Paypal-Sandbox-Email-Address: Platform.sdk.seller@gmail.com\r\nAuthorization: Bearer A015p9UmS9bbjBKvXFguSGxuZxGMlvD8iJdSLcI6dBVCi2c\r\nContent-Type: application/json\r\nUser-Agent: PayPalSDK/rest-sdk-ruby 1.1.2 (paypal-sdk-core 1.1.2; ruby 2.1.2p95-x86_64-darwin13.0)\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nHost: api.sandbox.paypal.com\r\n\r\n"
 -> "HTTP/1.1 404 Not Found\r\n"
 -> "Server: Apache-Coyote/1.1\r\n"
--> "PROXY_SERVER_INFO: host=slcsbplatformapiserv3001.slc.paypal.com;threadId=7182\r\n"
--> "Paypal-Debug-Id: e632ea9d7d8f6\r\n"
--> "SERVER_INFO: paymentsplatformserv:v1.payments.payment&CalThreadId=6491&TopLevelTxnStartTime=14c948cca8d&Host=slcsbpaymentsplatformserv3001.slc.paypal.com&pid=10160\r\n"
+-> "PROXY_SERVER_INFO: host=slcsbplatformapiserv3002.slc.paypal.com;threadId=6008\r\n"
+-> "Paypal-Debug-Id: c8f86460d1f6d\r\n"
 -> "Content-Language: *\r\n"
--> "Date: Tue, 07 Apr 2015 15:43:16 GMT\r\n"
+-> "Date: Tue, 05 May 2015 14:30:04 GMT\r\n"
 -> "Content-Type: application/json\r\n"
 -> "Content-Length: 207\r\n"
 -> "\r\n"
 reading 207 bytes...
--> "{\"name\":\"INVALID_RESOURCE_ID\",\"message\":\"The requested resource ID was not found\",\"information_link\":\"https://developer.paypal.com/webapps/developer/docs/api/#INVALID_RESOURCE_ID\",\"debug_id\":\"e632ea9d7d8f6\"}"
+-> "{\"name\":\"INVALID_RESOURCE_ID\",\"message\":\"The requested resource ID was not found\",\"information_link\":\"https://developer.paypal.com/webapps/developer/docs/api/#INVALID_RESOURCE_ID\",\"debug_id\":\"c8f86460d1f6d\"}"
 read 207 bytes
 Conn keep-alive
 opening connection to api.sandbox.paypal.com:443...
 opened
 starting SSL for api.sandbox.paypal.com:443...
 SSL established
-<- "POST /v1/payments/payment HTTP/1.1\r\nX-Paypal-Sandbox-Email-Address: Platform.sdk.seller@gmail.com\r\nAuthorization: Bearer A015ZyrqDqUwads.muwOVYUAKx74DlwGYa04fIfu0xHAbW4\r\nContent-Type: application/json\r\nUser-Agent: PayPalSDK/rest-sdk-ruby 1.1.3 (paypal-sdk-core 1.1.3; ruby 2.1.2p95-x86_64-darwin13.0)\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nHost: api.sandbox.paypal.com\r\nContent-Length: 2\r\n\r\n"
+<- "POST /v1/payments/payment HTTP/1.1\r\nX-Paypal-Sandbox-Email-Address: Platform.sdk.seller@gmail.com\r\nAuthorization: Bearer A015p9UmS9bbjBKvXFguSGxuZxGMlvD8iJdSLcI6dBVCi2c\r\nContent-Type: application/json\r\nUser-Agent: PayPalSDK/rest-sdk-ruby 1.1.2 (paypal-sdk-core 1.1.2; ruby 2.1.2p95-x86_64-darwin13.0)\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nHost: api.sandbox.paypal.com\r\nContent-Length: 2\r\n\r\n"
 <- "{}"
 -> "HTTP/1.1 400 Bad Request\r\n"
 -> "Server: Apache-Coyote/1.1\r\n"
--> "PROXY_SERVER_INFO: host=slcsbplatformapiserv3002.slc.paypal.com;threadId=2269\r\n"
--> "Paypal-Debug-Id: 383fe0c9634bd\r\n"
--> "SERVER_INFO: paymentsplatformserv:v1.payments.payment&CalThreadId=468&TopLevelTxnStartTime=14c948cccca&Host=slcsbpaymentsplatformserv3002.slc.paypal.com&pid=22334\r\n"
+-> "PROXY_SERVER_INFO: host=slcsbplatformapiserv3002.slc.paypal.com;threadId=5913\r\n"
+-> "Paypal-Debug-Id: 3be36c95d1d44\r\n"
 -> "Content-Language: *\r\n"
--> "Date: Tue, 07 Apr 2015 15:43:17 GMT\r\n"
+-> "Date: Tue, 05 May 2015 14:30:05 GMT\r\n"
 -> "Connection: close\r\n"
 -> "Content-Type: application/json\r\n"
 -> "Content-Length: 306\r\n"
 -> "Connection: close\r\n"
 -> "\r\n"
 reading 306 bytes...
--> "{\"name\":\"VALIDATION_ERROR\",\"details\":[{\"field\":\"intent\",\"issue\":\"Required field missing\"},{\"field\":\"payer\",\"issue\":\"Required field missing\"}],\"message\":\"Invalid request - see details\",\"information_link\":\"https://developer.paypal.com/webapps/developer/docs/api/#VALIDATION_ERROR\",\"debug_id\":\"383fe0c9634bd\"}"
+-> "{\"name\":\"VALIDATION_ERROR\",\"details\":[{\"field\":\"payer\",\"issue\":\"Required field missing\"},{\"field\":\"intent\",\"issue\":\"Required field missing\"}],\"message\":\"Invalid request - see details\",\"information_link\":\"https://developer.paypal.com/webapps/developer/docs/api/#VALIDATION_ERROR\",\"debug_id\":\"3be36c95d1d44\"}"
 read 306 bytes
 Conn close

data/spec/webhooks_examples_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+require "securerandom"
+
+describe "Webhooks", :integration => true do
+
+  webhookAttributes = {
+    :url => "https://www.yeowza.com/paypal_webhook_"+SecureRandom.hex(8),
+    :event_types => [
+        {
+            :name => "PAYMENT.AUTHORIZATION.CREATED"
+        },
+        {
+            :name => "PAYMENT.AUTHORIZATION.VOIDED"
+        }
+    ]
+  }
+
+  it "create webhook" do
+    $webhook = PayPal::SDK::REST::Webhook.new(webhookAttributes)
+    expect($webhook.create).to be_truthy
+  end
+
+  it "get webhook" do
+    $result = PayPal::SDK::REST::Webhook.get($webhook.id)
+    expect($result).to be_a PayPal::SDK::REST::Webhook
+    expect($result.id).to eql $webhook.id
+  end
+
+  it "get all webhooks" do
+    $webhooks_list = PayPal::SDK::REST::Webhook.all()
+    expect($webhooks_list.webhooks.length).not_to be_nil
+  end
+
+  it "get subscribed webhook event types" do
+    $webhook_event_types = PayPal::SDK::REST::Webhook.get_event_types($webhook.id)
+    expect($webhook_event_types.event_types.length).to eql $webhook.event_types.length
+  end
+
+  it "delete webhook" do
+    expect($webhook.delete).to be_truthy
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal-sdk-rest
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -139,6 +139,7 @@ files:
 - spec/subscription_examples_spec.rb
 - spec/support/sample_data.rb
 - spec/web_profile_examples_spec.rb
+- spec/webhooks_examples_spec.rb
 homepage: https://developer.paypal.com
 licenses:
 - PayPal SDK License
@@ -183,3 +184,4 @@ test_files:
 - spec/subscription_examples_spec.rb
 - spec/support/sample_data.rb
 - spec/web_profile_examples_spec.rb
+- spec/webhooks_examples_spec.rb