paypal-sdk-rest 1.7.6 → 2.0.0.rc1

data/spec/integration/v1/billing_plans/plan_create_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../../test_harness'
+require_relative './plan_helper'
+
+include PayPal::V1::BillingPlans
+
+describe PlanCreateRequest do
+  it 'successfully makes a request' do
+    resp = PlanHelper::create_plan
+    expect(resp.status_code).to eq(201)
+    expect(resp.result).not_to be_nil
+  end
+end

data/spec/integration/v1/billing_plans/plan_get_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../../test_harness'
+require_relative './plan_helper'
+
+include PayPal::V1::BillingPlans
+
+describe PlanGetRequest do
+  it 'successfully makes a request' do
+    create_response = PlanHelper::create_plan
+
+    get_response = PlanHelper::get_plan(create_response.result.id)
+
+    expect(get_response.status_code).to eq(200)
+    expect(get_response.result).not_to be_nil
+    expect(get_response.result.id).to eq(create_response.result.id)
+  end
+end

data/spec/integration/v1/billing_plans/plan_helper.rb

@@ -0,0 +1,71 @@
+require_relative '../../test_harness'
+
+include PayPal::V1::BillingPlans
+
+module PlanHelper
+  class << self
+    def activate_plan(plan_id)
+      request_body = [
+        {
+          :op => 'replace',
+          :path => '/',
+          :value => {
+            :state => 'ACTIVE',
+          },
+        },
+      ]
+
+      activate_request = PlanUpdateRequest.new(plan_id)
+      activate_request.request_body(request_body)
+
+      TestHarness::client.execute(activate_request)
+    end
+
+    def create_plan
+      request_body = {
+        "payment_definitions": [{
+          "amount": {
+            "value": "100",
+            "currency": "USD",
+          },
+          "frequency": "MONTH",
+          "cycles": "12",
+          "frequency_interval": "2",
+          "type": "REGULAR",
+          "name": "Regular Payments",
+          "charge_models": [{
+            "type": "SHIPPING",
+            "amount": {
+              "value": "10",
+              "currency": "USD",
+            },
+          }, {
+            "type": "TAX",
+            "amount": {
+              "value": "12",
+              "currency": "USD",
+            },
+          }],
+        }],
+        "merchant_preferences": {
+          "return_url": "http://localhost:3000/subscription/success",
+          "cancel_url": "http://localhost:3000/subscription/cancel",
+        },
+        "name": "T-Shirt of the Month Club Plan",
+        "description": "Template creation.",
+        "type": "fixed",
+      }
+
+      request = PlanCreateRequest.new()
+      request.request_body(request_body)
+
+      TestHarness::client.execute(request)
+    end
+
+    def get_plan(plan_id)
+      request = PlanGetRequest.new(plan_id)
+
+      TestHarness::client.execute(request)
+    end
+  end
+end

data/spec/integration/v1/billing_plans/plan_list_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../../test_harness'
+require_relative './plan_helper'
+
+include PayPal::V1::BillingPlans
+
+describe PlanListRequest do
+  it 'successfully makes a request' do
+    PlanHelper::create_plan
+
+    request = PlanListRequest.new()
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+  end
+end

data/spec/integration/v1/billing_plans/plan_update_spec.rb

@@ -0,0 +1,19 @@
+require_relative '../../test_harness'
+require_relative './plan_helper'
+
+include PayPal::V1::BillingPlans
+
+describe PlanUpdateRequest do
+  it 'successfully makes a request' do
+    create_response = PlanHelper::create_plan
+    plan_id = create_response.result.id
+
+    activate_response = PlanHelper::activate_plan(plan_id)
+
+    expect(activate_response.status_code).to eq(200)
+
+    get_response = PlanHelper::get_plan(plan_id)
+
+    expect(get_response.result.state).to eq('ACTIVE')
+  end
+end

data/spec/integration/v1/identity/userinfo_get_spec.rb

@@ -0,0 +1,65 @@
+require_relative '../../test_harness'
+require 'uri'
+require 'cgi'
+
+include PayPal::V1::Identity
+
+describe UserinfoGetRequest do
+
+  it 'builds user consent url' do
+    builder = UserConsent.new(TestHarness::environment)
+    builder.response_type('code')
+    builder.scope('profile+email+openid+address')
+    builder.redirect_uri('http://example.com')
+    builder.state('some-state')
+    builder.nonce('some-nonce')
+
+    url = builder.build
+
+    parsed = URI(url)
+
+    expect(parsed.scheme).to eq('https')
+    expect(parsed.host).to eq('sandbox.paypal.com')
+    expect(parsed.path).to eq('/signin/authorize')
+
+    query = CGI::parse(parsed.query)
+    expect(query['response_type'][0]).to eq('code')
+    expect(query['scope'][0]).to eq('profile email openid address')
+    expect(query['redirect_uri'][0]).to eq('http://example.com')
+    expect(query['state'][0]).to eq('some-state')
+    expect(query['nonce'][0]).to eq('some-nonce')
+  end
+
+  it 'gets refresh token from code', :skip => 'This test is an example of how to obtain user consent' do
+    builder = UserConsent.new(TestHarness::environment)
+    builder.redirect_uri(CGI::escape('http://requestbin.fullcontact.com/15a7bhu1'))
+    builder.response_type('code')
+    builder.scope('profile+email+openid+address')
+
+    url = builder.build
+
+    # Fetched from visiting the `url` and signing in w/ PayPal account
+    code = 'C21AAHkGGpGk-g8ZbMuKwTtisc6mkv18Tplrvu9RZR-_zmNQS0xthson09WpKA8vYi4G7ESo3fu694FXm3sxVRclBwg24b1MA'
+
+    environment = TestHarness::environment
+    refresh_token_request = PayPal::RefreshTokenRequest.new(environment, code)
+    token_response = TestHarness::exec(refresh_token_request)
+
+    expect(token_response.status_code).to eq(200)
+    expect(token_response.result).not_to be_nil
+  end
+
+  it 'gets user info' do
+    # Fetched using the above example
+    refresh_token = 'R23AAEWf7GghkOpcrCXhiDkS2IpGPR-r_jMIez_gcTzrstXCsro0ZC2P8xEnv5lm4A8h2QXFhMhIcKI8Ak5lP8kIyZzCxqjg_JbX8QI7KJoXrbn57U19_tlfs-Z-seXHtK74OeGhJyGxfRTBLbOIw'
+
+    scoped_http_client = PayPal::PayPalHttpClient.new(TestHarness::environment, refresh_token)
+
+    request = UserinfoGetRequest.new()
+    request.schema('openid')
+
+    resp = scoped_http_client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+  end
+end

data/spec/integration/v1/invoices/invoice_cancel_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceCancelRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+    InvoiceHelper::send_invoice(create_response.result.id)
+
+    request = InvoiceCancelRequest.new(create_response.result.id)
+    request.request_body({
+      :subject => 'Past Due',
+      :note => 'nevermind',
+      :send_to_merchant => true,
+      :send_to_payer => true,
+    })
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(204)
+  end
+end

data/spec/integration/v1/invoices/invoice_create_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceCreateRequest do
+  it 'successfully makes a request' do
+    invoice_create_response = InvoiceHelper::create_invoice
+
+    expect(invoice_create_response.status_code).to eq(201)
+    expect(invoice_create_response.result).not_to be_nil
+    expect(invoice_create_response.result.merchant_info.first_name).to eq('Dennis')
+  end
+end

data/spec/integration/v1/invoices/invoice_delete_external_payment_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+
+include PayPal::V1::Invoices
+
+describe InvoiceDeleteExternalPaymentRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+    id = create_response.result.id
+    InvoiceHelper::record_payment(id)
+
+    get_response = InvoiceHelper::get_invoice(id)
+
+    txn_id = get_response.result.payments[0].transaction_id
+    request = InvoiceDeleteExternalPaymentRequest.new(id, txn_id)
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(204)
+
+    get_response = InvoiceHelper::get_invoice(id)
+    expect(get_response.result.payments).to be_nil
+  end
+end

data/spec/integration/v1/invoices/invoice_delete_external_refund_spec.rb

@@ -0,0 +1,21 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+
+include PayPal::V1::Invoices
+
+describe InvoiceDeleteExternalRefundRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+    id = create_response.result.id
+
+    InvoiceHelper::record_refund(id)
+
+    get_response = InvoiceHelper::get_invoice(id)
+    refund_id = get_response.result.refunds[0].transaction_id
+
+    request = InvoiceDeleteExternalRefundRequest.new(id, refund_id)
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(204)
+  end
+end

data/spec/integration/v1/invoices/invoice_delete_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceDeleteRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+
+    request = InvoiceDeleteRequest.new(create_response.result.id)
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(204)
+  end
+end

data/spec/integration/v1/invoices/invoice_get_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+
+include PayPal::V1::Invoices
+
+describe InvoiceGetRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+
+    request = InvoiceGetRequest.new(create_response.result.id)
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+
+    expect(resp.result.id).to eq(create_response.result.id)
+  end
+end

data/spec/integration/v1/invoices/invoice_helper.rb

@@ -0,0 +1,171 @@
+require_relative '../../test_harness'
+
+include PayPal::V1::Invoices
+
+module InvoiceHelper
+  class << self
+    def create_invoice
+      body = {
+        "merchant_info": {
+          "email": "team-dx-clients-facilitator@getbraintree.com",
+          "first_name": "Dennis",
+          "last_name": "Doctor",
+          "business_name": "Medical Professionals, LLC",
+          "phone": {
+            "country_code": "001",
+            "national_number": "5032141716",
+          },
+          "address": {
+            "line1": "1234 Main St.",
+            "city": "Portland",
+            "state": "OR",
+            "postal_code": "97217",
+            "country_code": "US",
+          },
+        },
+        "billing_info": [{
+          "email": "example@example.com",
+        }],
+        "items": [{
+          "name": "Sutures",
+          "quantity": 100.0,
+          "unit_price": {
+            "currency": "USD",
+            "value": 5,
+          },
+        }],
+        "note": "Medical Invoice 16 Jul, 2013 PST",
+        "payment_term": {
+          "term_type": "NET_45",
+        },
+        "shipping_info": {
+          "first_name": "Sally",
+          "last_name": "Patient",
+          "business_name": "Not applicable",
+          "phone": {
+            "country_code": "001",
+            "national_number": "5039871234",
+          },
+          "address": {
+            "line1": "1234 Broad St.",
+            "city": "Portland",
+            "state": "OR",
+            "postal_code": "97216",
+            "country_code": "US",
+          },
+        },
+        "tax_inclusive": false,
+        "total_amount": {
+          "currency": "USD",
+          "value": "500.00",
+        },
+      }
+
+      TestHarness::exec(InvoiceCreateRequest.new, body)
+    end
+
+    def get_invoice(id)
+      TestHarness::exec(InvoiceGetRequest.new(id))
+    end
+
+    def send_invoice(id)
+      req = InvoiceSendRequest.new(id)
+      req.notify_merchant(true)
+
+      TestHarness::exec(req)
+    end
+
+    def record_payment(id)
+      send_invoice(id)
+
+      request = InvoiceRecordPaymentRequest.new(id)
+      request.request_body({
+        :method => 'CASH',
+        :date => '2017-07-11 00:01:00 PST',
+        :amount => {
+          :value => '10',
+          :currency => 'USD',
+        },
+      })
+
+      TestHarness::exec(request)
+    end
+
+    def record_refund(id)
+      record_payment(id)
+
+      req = InvoiceRecordRefundRequest.new(id)
+      body = {
+        :amount => {
+          :value => '10',
+          :currency => 'USD',
+        },
+      }
+
+      TestHarness::exec(req, body)
+    end
+
+    def create_template
+      body = {
+        "name": "Hours Template_ruby#{Random.new.rand(1000000)}",
+        "default": true,
+        "unit_of_measure": "Hours",
+        "template_data": {
+          "items": [
+            {
+              "name": "Nutri Bullet",
+              "quantity": 1,
+              "unit_price": {
+                "currency": "USD",
+                "value": "50.00",
+              },
+            },
+          ],
+          "merchant_info": {
+            "email": "team-dx-clients-facilitator@getbraintree.com",
+          },
+          "tax_calculated_after_discount": false,
+          "tax_inclusive": false,
+          "note": "Thank you for your business.",
+          "logo_url": "https://pics.paypal.com/v1/images/redDot.jpeg",
+          "allow_tip": true,
+        },
+        "settings": [
+          {
+            "field_name": "items.date",
+            "display_preference": {
+              "hidden": true,
+            },
+          },
+          {
+            "field_name": "custom",
+            "display_preference": {
+              "hidden": true,
+            },
+          },
+        ],
+      }
+
+      TestHarness::exec(TemplateCreateRequest.new, body)
+    end
+
+    def get_template(id)
+      TestHarness::exec(TemplateGetRequest.new(id))
+    end
+
+    def delete_templates
+      list_resp = TestHarness::exec(TemplateListRequest.new)
+
+      puts "Deleting #{list_resp.result.templates.count} templates"
+
+      list_resp.result.templates.each do |template|
+        begin
+          TestHarness::exec(TemplateDeleteRequest.new(template.template_id))
+          puts "deleted #{template.template_id}"
+        rescue Exception => e
+          puts "Could not delete #{template.template_id}"
+        end
+      end
+    end
+  end
+end

data/spec/integration/v1/invoices/invoice_list_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+
+include PayPal::V1::Invoices
+
+describe InvoiceListRequest do
+  it 'successfully makes a request' do
+    InvoiceHelper::create_invoice
+
+    request = InvoiceListRequest.new
+    request.page(8)
+    request.page_size(7)
+    request.total_count_required(true)
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+    expect(resp.result.total_count > 0).to be(true)
+  end
+end

data/spec/integration/v1/invoices/invoice_next_invoice_number_spec.rb

@@ -0,0 +1,14 @@
+require_relative '../../test_harness'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceNextInvoiceNumberRequest do
+  it 'successfully makes a request' do
+    request = InvoiceNextInvoiceNumberRequest.new()
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+  end
+end

data/spec/integration/v1/invoices/invoice_qr_code_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+
+include PayPal::V1::Invoices
+
+describe InvoiceQrCodeRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+
+    request = InvoiceQrCodeRequest.new(create_response.result.id)
+    request.height(300)
+    request.width(200)
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+  end
+end

data/spec/integration/v1/invoices/invoice_record_payment_spec.rb

@@ -0,0 +1,14 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceRecordPaymentRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+    record_response = InvoiceHelper::record_payment(create_response.result.id)
+
+    expect(record_response.status_code).to eq(204)
+  end
+end

data/spec/integration/v1/invoices/invoice_record_refund_spec.rb

@@ -0,0 +1,14 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceRecordRefundRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+    refund_response = InvoiceHelper::record_refund(create_response.result.id)
+
+    expect(refund_response.status_code).to eq(204)
+  end
+end

data/spec/integration/v1/invoices/invoice_remind_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+
+include PayPal::V1::Invoices
+
+describe InvoiceRemindRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+    id = create_response.result.id
+    InvoiceHelper::send_invoice(id)
+
+    request = InvoiceRemindRequest.new(id)
+    request.request_body({
+      :subject => 'PAST DUE',
+      :note => 'pony up!',
+      :send_to_merchant => true,
+    })
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(202)
+  end
+end

data/spec/integration/v1/invoices/invoice_search_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+
+include PayPal::V1::Invoices
+
+describe InvoiceSearchRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+
+    request = InvoiceSearchRequest.new()
+    request.request_body({
+      :number => create_response.result.number,
+    })
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+    expect(resp.result.invoices[0].id).to eq(create_response.result.id)
+  end
+end

data/spec/integration/v1/invoices/invoice_send_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceSendRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+
+    send_response = InvoiceHelper::send_invoice(create_response.result.id)
+
+    expect(send_response.status_code).to eq(202)
+  end
+end

data/spec/integration/v1/invoices/invoice_update_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../../test_harness'
+require_relative './invoice_helper'
+require 'json'
+
+include PayPal::V1::Invoices
+
+describe InvoiceUpdateRequest do
+  it 'successfully makes a request' do
+    create_response = InvoiceHelper::create_invoice
+
+    request = InvoiceUpdateRequest.new(create_response.result.id)
+    request.notify_merchant(false)
+    request.request_body({
+      :merchant_info => {
+        :email => 'team-dx-clients-facilitator@getbraintree.com',
+      },
+      :terms => 'Consider this invoice updated',
+    })
+
+    resp = TestHarness::client.execute(request)
+    expect(resp.status_code).to eq(200)
+    expect(resp.result).not_to be_nil
+    expect(resp.result.merchant_info.email).to eq('team-dx-clients-facilitator@getbraintree.com')
+    expect(resp.result.terms).to eq('Consider this invoice updated')
+  end
+end