rest-client-wrapper 3.0.1

data/lib/rest_client_wrapper/version.rb

@@ -0,0 +1,23 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestClientWrapper
+
+  VERSION = "3.0.1".freeze
+
+end

data/rest-client-wrapper.gemspec

@@ -0,0 +1,51 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rest_client_wrapper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rest-client-wrapper"
+  s.version     = RestClientWrapper::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["University of Adelaide"]
+  s.email       = ["myuni.admin@adelaide.edu.au"]
+  s.homepage    = "https://github.com/universityofadelaide/rest-client-wrapper"
+  s.summary     = "Rest client wrapper"
+  s.description = "Generic REST client wrapper"
+  s.license     = "GPL 3.0"
+  s.required_ruby_version = ">= 2.4.0"
+
+  s.add_runtime_dependency "json", "~> 1.8", ">= 1.8.3"
+  s.add_runtime_dependency "oauth2", "~> 1.2"
+  s.add_runtime_dependency "rack", "~> 2.0.5"
+  s.add_runtime_dependency "rest-client", "~> 2.0.2"
+  s.add_runtime_dependency "typhoeus", "~> 1.0", ">= 1.0.1"
+
+  s.add_development_dependency "colorize", "~> 0.7", ">= 0.7.0"
+  s.add_development_dependency "geminabox", "~> 0.13.0"
+  s.add_development_dependency "rspec", "~> 3.4", ">= 3.4.0"
+
+  s.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  s.files = Dir.glob("lib/**/*.{rake,rb}") + ["#{ s.name }.gemspec", "README.md"]
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/authenticators/oauth_spec.rb

@@ -0,0 +1,103 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "spec_helper"
+
+# Authenticator::Oauth Specs
+module RestClientWrapper
+
+  describe Authenticator::Oauth do
+
+    before(:context) do
+      @client_id = "client_id"
+      @client_secret = "client_secret"
+      @api_token_uri = URI.parse("http://fake_oauth_token.com/token_url_path")
+    end
+
+    describe "::get_access_token" do
+
+      before(:example) do
+        WebMock.reset_executed_requests!
+        @oauth = Authenticator::Oauth.new(
+          {
+            site:           "#{ @api_token_uri.scheme }://#{ @api_token_uri.host }",
+            token_url_path: @api_token_uri.path,
+            client_id:      @client_id,
+            client_secret:  @client_secret
+          }
+        )
+        @current_token = FactoryBot.build(:token).token
+        request = FactoryBot.build(:oauth_token_request, { headers: FactoryBot.build(:request_headers, { host: @api_token_uri.host }).to_h }).to_h
+        response = FactoryBot.build(:auth_token_response).to_h
+        @response_body = response[:body]
+        response[:body] = lambda { |_request|
+          sleep 1 # Simulate network latency.
+          @response_body
+        }
+        @authenticate_request = stub_request(:post, @api_token_uri.to_s).with(request).to_return(response)
+      end
+
+      context "when multiple threads are trying to authenticate" do
+
+        it "will only make one API request to renew the access token" do
+          t1 = Thread.new do
+            Authenticator::Oauth.authenticate({ client_id: @client_id })
+          end
+
+          sleep(1) # Give t1 a head start so that it can get the lock before t2 does
+          t2 = Thread.new do
+            Authenticator::Oauth.authenticate({ client_id: @client_id, access_token: @current_token })
+          end
+
+          t1.join
+          t2.join
+
+          parsed_response = JSON.parse(@response_body).symbolize_keys
+
+          expect(@oauth.tokens[@client_id][:access_token]).to eq(parsed_response[:access_token])
+          # Only expect one request as thread 1 (t1) has already got a new token thread 2 (t2) will use the new token.
+          expect(@authenticate_request).to have_been_requested.times(1)
+        end
+
+      end
+
+      context "when token is expired" do
+
+        before(:example) do
+          WebMock.reset_executed_requests!
+          @expired_token = FactoryBot.build(:token).token
+          @request = FactoryBot.build(:oauth_token_request, { headers: FactoryBot.build(:request_headers, { host: @api_token_uri.host }).to_h }).to_h
+          @response = FactoryBot.build(:auth_token_response).to_h
+          @authenticate_request = stub_request(:post, @api_token_uri.to_s).with(@request).to_return(@response)
+        end
+
+        it "will make an API call to get a new token" do
+          Authenticator::Oauth.authenticate({ client_id: @client_id, access_token: @expired_token })
+          parsed_response = JSON.parse(@response[:body]).symbolize_keys
+
+          expect(@oauth.tokens[@client_id][:access_token]).to eq(parsed_response[:access_token])
+          expect(@authenticate_request).to have_been_requested.times(1)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/factories/request.rb

@@ -0,0 +1,48 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+FactoryBot.define do
+  factory :request, { class: OpenStruct } do |f|
+    skip_create
+    f.body    { FactoryBot.build(:request_body).to_h }
+    f.headers { FactoryBot.build(:request_headers).to_h }
+  end
+
+  factory :oauth_token_request, { class: OpenStruct } do |f|
+    skip_create
+    f.body    { FactoryBot.build(:oauth_request_body).to_h }
+    f.headers { FactoryBot.build(:request_headers).to_h }
+  end
+
+  factory :oauth_request_body, { class: OpenStruct } do |f|
+    skip_create
+    f.client_id     { "client_id" }
+    f.client_secret { "client_secret" }
+    f.grant_type    { "client_credentials" }
+  end
+
+  factory :request_body, { class: OpenStruct } do |f|
+    skip_create
+    f.course_id { Faker::Hipster.sentence(5) }
+  end
+
+  factory :request_headers, { class: OpenStruct } do |f|
+    skip_create
+    f.host { "fake_oauth_token.com" }
+  end
+end

data/spec/factories/response.rb

@@ -0,0 +1,47 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+FactoryBot.define do
+  factory :auth_token_response, { class: OpenStruct } do |f|
+    skip_create
+    f.status { 200 }
+    f.body { "{\"token_type\":\"Bearer\",\"access_token\":\"#{ FactoryBot.build(:token).token }\",\"expires_in\":3600,\"refresh_token\":\"#{ FactoryBot.build(:token).token }\"}" }
+    f.headers { { content_type: "application/json; charset=utf-8" } }
+  end
+
+  factory :response, { class: OpenStruct } do |f|
+    skip_create
+    f.status { 200 }
+    f.body { "{\"result\":\"success\"}" }
+    f.headers { { content_type: "application/json; charset=utf-8" } }
+  end
+
+  factory :paginated_response, { class: OpenStruct } do |_f|
+    status { 200 }
+    body { "{\"result\":\"success\"}" }
+    headers do
+      { content_type: "application/json; charset=utf-8",
+        link:         "" }
+    end
+  end
+
+  factory :token, { class: OpenStruct } do |f|
+    skip_create
+    f.token { Faker::Crypto.sha1 }
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,185 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "spec_helper"
+
+# Request Specs
+module RestClientWrapper # rubocop:disable Metrics/ModuleLength
+
+  describe Request do
+    before(:context) do
+      @api_uri = URI.parse("http://fake_site.com")
+      @param_hash = { key: "value" }
+      @non_hash_value = 1
+    end
+
+    describe "#http_method" do
+
+      before(:example) do
+        @non_http_method = :test
+        @non_symbol_value = 1
+      end
+
+      context "when http_method is not a valid http method" do
+
+        it "will raise TypeError" do
+          expect { Request.new({ http_method: @non_http_method, uri: @api_uri }) }.to raise_error(ArgumentError)
+        end
+
+      end
+
+      context "when http_method is not a symbol" do
+
+        it "will raise TypeError" do
+          expect { Request.new({ http_method: @non_symbol_value, uri: @api_uri }) }.to raise_error(TypeError)
+        end
+
+      end
+
+      context "when http method :get is assigned" do
+
+        it "value is assigned to request http_method" do
+          request = Request.new({ http_method: :get, uri: @api_uri })
+          expect(request.http_method).to eq(:get)
+        end
+
+      end
+
+      context "when http method :post is assigned" do
+
+        it "value is assigned to request http_method" do
+          request = Request.new({ http_method: :post, uri: @api_uri })
+          expect(request.http_method).to eq(:post)
+        end
+
+      end
+
+      context "when http method :put is assigned" do
+
+        it "value is assigned to request http_method" do
+          request = Request.new({ http_method: :put, uri: @api_uri })
+          expect(request.http_method).to eq(:put)
+        end
+
+      end
+
+      context "when http method :delete is assigned" do
+
+        it "value is assigned to request http_method" do
+          request = Request.new({ http_method: :delete, uri: @api_uri })
+          expect(request.http_method).to eq(:delete)
+        end
+
+      end
+
+      context "when http method :connect is assigned" do
+
+        it "value is assigned to request http_method" do
+          request = Request.new({ http_method: :connect, uri: @api_uri })
+          expect(request.http_method).to eq(:connect)
+        end
+
+      end
+
+      context "when http method :options is assigned" do
+
+        it "value is assigned to request http_method" do
+          request = Request.new({ http_method: :options, uri: @api_uri })
+          expect(request.http_method).to eq(:options)
+        end
+
+      end
+
+      context "when http method :trace is assigned" do
+
+        it "value is assigned to request http_method" do
+          request = Request.new({ http_method: :trace, uri: @api_uri })
+          expect(request.http_method).to eq(:trace)
+        end
+
+      end
+
+    end
+
+    describe "#segment_params" do
+
+      context "when segment_params is not a hash" do
+
+        it "will raise TypeError" do
+          expect { Request.new({ http_method: :get, uri: @api_uri, segment_params: @non_hash_value }) }.to raise_error(TypeError)
+        end
+
+      end
+
+      context "when segment_params is a hash" do
+
+        it "value is assigned to request segment_params" do
+          request = Request.new({ http_method: :get, uri: @api_uri, segment_params: @param_hash })
+          expect(request.segment_params).to eq(@param_hash)
+        end
+
+      end
+
+    end
+
+    describe "#payload" do
+
+      context "when payload is not a hash" do
+
+        it "will raise TypeError" do
+          expect { Request.new({ http_method: :get, uri: @api_uri, segment_params: @param_hash, payload: @non_hash_value }) }.to raise_error(TypeError)
+        end
+
+      end
+
+      context "when payload is a hash" do
+
+        it "value is assigned to request payload" do
+          request = Request.new({ http_method: :get, uri: @api_uri, segment_params: @param_hash, payload: @param_hash })
+          expect(request.payload).to eq(@param_hash)
+        end
+
+      end
+
+    end
+
+    describe "#headers" do
+
+      context "when headers is not a hash" do
+
+        it "will raise TypeError" do
+          request = Request.new({ http_method: :get, uri: @api_uri, segment_params: @param_hash, payload: @param_hash })
+          expect { request.headers = @non_hash_value }.to raise_error(TypeError)
+        end
+
+      end
+
+      context "when headers is a hash" do
+
+        it "value is assigned to request header" do
+          request = Request.new({ http_method: :get, uri: @api_uri, segment_params: @param_hash, payload: @param_hash })
+          expect(request.payload).to eq(@param_hash)
+        end
+
+      end
+
+    end
+
+  end
+
+end