paypal-sdk-rest 1.7.6 → 2.0.0.rc1

data/spec/spec_helper.rb

@@ -1,37 +1,106 @@
-require 'bundler/setup'
-
-if ENV['COVERAGE']
-  require 'simplecov'
-  require 'coveralls'
-  Coveralls.wear!
-  SimpleCov.start do
-    add_filter "/spec/"
+require_relative "../lib/lib.rb"
+require 'pp'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
-end
 
-Bundler.require :default, :test
-PayPal::SDK::Core::Config.load(File.expand_path('../config/paypal.yml', __FILE__), 'test')
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
 
-require 'paypal-sdk-rest'
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
 
-include PayPal::SDK::REST
-include PayPal::SDK::Core::Logging
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
 
-require 'logger'
-PayPal::SDK.load('spec/config/paypal.yml', 'test')
-PayPal::SDK.logger = Logger.new(STDERR)
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
 
-Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f }
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
 
-# Set logger for http
-http_log = File.open(File.expand_path('../log/http.log', __FILE__), "w")
-Payment.api.http.set_debug_output(http_log)
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
 
-RSpec.configure do |config|
-  config.filter_run_excluding :integration => true
-  config.filter_run_excluding :disabled => true
-  config.include SampleData
-  # config.include PayPal::SDK::REST::DataTypes
-end
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
 
-WebMock.allow_net_connect!
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/unit/paypal_http_client_spec.rb

@@ -0,0 +1,264 @@
+require_relative '../../lib/paypal/core/version'
+require 'webmock/rspec'
+
+include WebMock::API
+
+describe PayPal::PayPalHttpClient do
+  before do
+    WebMock.disable!
+    @environment = PayPal::SandboxEnvironment.new('clientId', 'clientSecret')
+    @httpClient = PayPal::PayPalHttpClient.new(@environment)
+  end
+
+  # Helpers
+  def stubAccessToken
+    access_token_json = JSON.generate({
+      :access_token => "simple-access-token",
+      :expires_in => 3600,
+      :token_type => 'Bearer',
+    })
+
+    stub_request(:any, @environment.base_url + "/v1/oauth2/token").
+      to_return(body: access_token_json, status: 200,
+                headers: {'content-type' => "application/json"})
+  end
+
+  def stubRefreshToken
+    access_token_json = JSON.generate({
+      :access_token => "refresh-access-token",
+      :expires_in => 3600,
+      :token_type => 'Bearer',
+    })
+
+    stub_request(:any, @environment.base_url + "/v1/oauth2/token")
+      .to_return(body: access_token_json, status: 200, headers: {'content-type' => "application/json"})
+  end
+
+  describe 'execute' do
+    before(:each) do
+      WebMock.enable!
+    end
+
+    it 'fetches access token if not yet fetched' do
+      access_token_stub = stubAccessToken
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      stub_request(:get, @environment.base_url + "/path")
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/path"})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result.some_key).to eq("some_value")
+      assert_requested(access_token_stub)
+    end
+
+    it 'does not fetch access token if not expired and valid' do
+      access_token_stub = stubAccessToken
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      response_stub = stub_request(:any, @environment.base_url)
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/"})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result[:some_key]).to eq("some_value")
+
+      resp = @httpClient.execute(req)
+
+      assert_requested(access_token_stub, times: 1)
+      assert_requested(response_stub, times: 2)
+    end
+
+    it 'fetches access token if expired' do
+      expired_access_token_json = JSON.generate({
+        :access_token => "expired-access-token",
+        :expires_in => -1,
+        :token_type => 'Bearer',
+      })
+
+      access_token_json = JSON.generate({
+        :access_token => "simple-access-token",
+        :expires_in => 3600,
+        :token_type => 'Bearer',
+      })
+
+      access_token_stub = stub_request(:any, @environment.base_url + "/v1/oauth2/token")
+        .to_return(body: expired_access_token_json, status: 200, headers: {'content-type' => "application/json"})
+        .times(1)
+        .then
+        .to_return(body: access_token_json, status: 200, headers: {'content-type' => "application/json"})
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      response_stub = stub_request(:any, @environment.base_url)
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/"})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result[:some_key]).to eq("some_value")
+
+      resp = @httpClient.execute(req)
+
+      assert_requested(access_token_stub, times: 2)
+      assert_requested(response_stub, times: 2)
+    end
+
+    it 'fetches access token with refresh token not yet fetched' do
+      @httpClient = PayPal::PayPalHttpClient.new(@environment, "refresh-token")
+      refresh_token_stub = stubRefreshToken
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      stub_request(:any, @environment.base_url)
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/"})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result[:some_key]).to eq("some_value")
+      assert_requested(refresh_token_stub)
+    end
+
+    it 'fetches access token with refresh token if expired' do
+      @httpClient = PayPal::PayPalHttpClient.new(@environment, "refresh-token")
+
+      expired_access_token_json = JSON.generate({
+        :access_token => "expired-access-token",
+        :expires_in => -1,
+        :token_type => 'Bearer',
+      })
+
+      access_token_json = JSON.generate({
+        :access_token => "refresh-access-token",
+        :expires_in => 3600,
+        :token_type => 'Bearer',
+      })
+
+      access_token_stub = stub_request(:any, @environment.base_url + "/v1/oauth2/token")
+        .to_return(body: expired_access_token_json, status: 200, headers: {'content-type' => "application/json"})
+        .times(1)
+        .then
+        .to_return(body: access_token_json, status: 200, headers: {'content-type' => "application/json"})
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      response_stub = stub_request(:any, @environment.base_url)
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/"})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result[:some_key]).to eq("some_value")
+
+      resp = @httpClient.execute(req)
+
+      assert_requested(access_token_stub, times: 2)
+      assert_requested(response_stub, times: 2)
+    end
+
+    it 'does not fetch access token if authorization header already present' do
+      @httpClient = PayPal::PayPalHttpClient.new(@environment)
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      stub_request(:get, @environment.base_url + "/path")
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/path", :headers => {'Authorization' => 'custom-header-value'}})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result[:some_key]).to eq("some_value")
+
+      expect(WebMock).to have_requested(:get, @environment.base_url + '/path')
+                           .with(headers: {'Authorization' => "custom-header-value"})
+    end
+
+    it 'sets Authorization header with access token value' do
+      access_token_stub = stubAccessToken
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      stub_request(:get, @environment.base_url + "/path")
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/path"})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result.some_key).to eq("some_value")
+      assert_requested(access_token_stub)
+
+      expect(WebMock).to have_requested(:get, @environment.base_url + '/path')
+                           .with(headers: {'Authorization' => "Bearer simple-access-token"})
+    end
+
+    it 'sets User-Agent header properly' do
+      access_token_stub = stubAccessToken
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      request_stub = stub_request(:any, @environment.base_url)
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      resp = @httpClient.execute(OpenStruct.new({:verb => "GET", :path => "/"}))
+
+      user_agent_regex = /^PayPalSDK\/rest-sdk-ruby #{PayPal::VERSION} \(paypal-sdk-core .*; ruby [\d\.?]*p\d+-.*;OpenSSL.*\)$/
+      expect(WebMock).to have_requested(:get, @environment.base_url)
+                           .with(headers: {'User-Agent' => user_agent_regex})
+    end
+
+    it 'sets Accept-Encoding header to gzip' do
+      access_token_stub = stubAccessToken
+
+      return_json = JSON.generate({
+        :some_key => "some_value",
+      })
+
+      request_stub = stub_request(:any, @environment.base_url)
+        .to_return(body: return_json, status: 200, headers: {'content-type' => "application/json"})
+
+      req = OpenStruct.new({:verb => "GET", :path => "/"})
+
+      resp = @httpClient.execute(req)
+
+      expect(resp.status_code).to eq(200)
+      expect(resp.result[:some_key]).to eq("some_value")
+      expect(WebMock).to have_requested(:get, @environment.base_url)
+                           .with(headers: {'Accept-Encoding' => 'gzip'})
+    end
+  end
+end