px-service-client 1.0.1

data/spec/px/service/client/future_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+describe Px::Service::Client::Future do
+  subject { Px::Service::Client::Future.new }
+  let(:value) { "value" }
+
+  describe '#complete' do
+    it "calls any pending methods on the response" do
+      expect(value).to receive(:size)
+      called = false
+      subject
+
+      Fiber.new do
+        subject.size
+        called = true
+      end.resume
+
+      Fiber.new do
+        subject.complete(value)
+      end.resume
+
+      expect(called).to eq(true)
+    end
+  end
+
+  describe '#completed?' do
+    context "when the future is completed" do
+      it "returns true" do
+        Fiber.new do
+          subject.complete(value)
+        end.resume
+
+        expect(subject.completed?).to eq(true)
+      end
+    end
+
+    context "when the future is not completed" do
+      it "returns false" do
+        expect(subject.completed?).to eq(false)
+      end
+    end
+  end
+
+  describe '#value' do
+    context "when the future is not complete" do
+      it "does not call the method on the value" do
+        called = false
+        Fiber.new do
+          subject.size
+          called = true
+        end.resume
+
+        expect(called).to eq(false)
+      end
+    end
+
+    context "when the future is already complete" do
+      it "returns the value" do
+        subject.complete(value)
+        expect(subject.value).to eq(value)
+      end
+    end
+
+    context "when the value is an exception" do
+      it "returns the exception" do
+        Fiber.new do
+          expect(subject.value).to be_a(ArgumentError)
+        end.resume
+
+        Fiber.new do
+          subject.complete(ArgumentError.new("Error"))
+        end.resume
+      end
+    end
+
+    context "when the method returns a value" do
+      it "returns the value" do
+        Fiber.new do
+          expect(subject.value).to eq(value)
+        end.resume
+
+        Fiber.new do
+          subject.complete(value)
+        end.resume
+      end
+    end
+  end
+
+  describe '#method_missing' do
+    context "when the future is already complete" do
+      context "when the method raised an exception" do
+        before :each do
+          subject.complete(nil)
+        end
+
+        it "raises the exception" do
+          Fiber.new do
+            expect {
+              subject.size
+            }.to raise_error(NoMethodError)
+          end.resume
+        end
+      end
+
+      context "when the method doesn't exist" do
+        before :each do
+          subject.complete("I am a string")
+        end
+
+        it "raises an exception" do
+          Fiber.new do
+            expect {
+              subject.not_exist
+            }.to raise_error(NoMethodError)
+          end.resume
+        end
+      end
+
+      context "when the method returns a value" do
+        before :each do
+          subject.complete(value)
+        end
+
+        it "returns the value" do
+          Fiber.new do
+            expect(subject.size).to eq(value.size)
+          end.resume
+        end
+      end
+    end
+
+    context "when the future is not complete" do
+      it "does not call the method on the value" do
+        expect(value).not_to receive(:size)
+
+        Fiber.new do
+          subject.size
+        end.resume
+      end
+
+      context "when the method raised an exception" do
+        it "raises the exception" do
+          Fiber.new do
+            expect {
+              subject.size
+            }.to raise_error(NoMethodError)
+          end.resume
+
+          Fiber.new do
+            subject.complete(nil)
+          end.resume
+        end
+      end
+
+      context "when the method doesn't exist on the eventual value" do
+        it "raises an exception" do
+          Fiber.new do
+            expect {
+              subject.not_exist
+            }.to raise_error(NoMethodError)
+          end.resume
+
+          Fiber.new do
+            subject.complete("I am a string")
+          end.resume
+        end
+      end
+
+      context "when the method returns a value" do
+        it "returns the value" do
+          Fiber.new do
+            expect(subject.size).to eq(value.size)
+          end.resume
+
+          Fiber.new do
+            subject.complete(value)
+          end.resume
+        end
+      end
+    end
+  end
+end

data/spec/px/service/client/list_response_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe Px::Service::Client::ListResponse do
+  let (:response) do
+    {
+      "current_page" => 5,
+      "total_pages" => 1,
+      "total_items" => 3,
+      "took" => 123,
+      "results" => [
+        { "id" => 1, "type" => "photo", "score" => 1},
+        { "id" => 2, "type" => "photo", "score" => 1},
+        { "id" => 3, "type" => "photo", "score" => 1},
+      ],
+    }
+  end
+
+  let (:empty_response) do
+    {
+      "current_page" => 1,
+      "total_pages" => 1,
+      "total_items" => 0,
+      "took" => 123,
+      "results" => [],
+    }
+  end
+
+  subject { Px::Service::Client::ListResponse.new(20, response, "results", name: "value") }
+
+  describe '#results' do
+    it "results the results" do
+      expect(subject.results).to eq(response["results"])
+    end
+  end
+
+
+  describe '#per_page' do
+    it "returns the page size" do
+      expect(subject.per_page).to be(20)
+    end
+  end
+
+  describe '#current_page' do
+    it "returns the current page" do
+      expect(subject.current_page).to be(5)
+    end
+  end
+
+  describe '#total_entries' do
+    it "returns the total number of entries" do
+      expect(subject.total_entries).to be(3)
+    end
+  end
+
+  describe '#total_pages' do
+    it "returns the total number of pages" do
+      expect(subject.total_pages).to be(1)
+    end
+  end
+
+  describe '#offset' do
+    it "returns the offset" do
+      expect(subject.offset).to be(80)
+    end
+  end
+
+  describe '#empty?' do
+    context "when there are results" do
+      it "returns false" do
+        expect(subject.empty?).to be_falsey
+      end
+    end
+
+    context "when there are no results" do
+      subject { Px::Service::Client::ListResponse.new(20, empty_response, "results", name: "value") }
+
+      it "returns true" do
+        expect(subject.empty?).to be_truthy
+      end
+    end
+  end
+
+  describe '#==' do
+    let(:other_search) { Px::Service::Client::ListResponse.new(20, response, "results", name: "value") }
+
+    context "when compared with another response" do
+      it "returns true" do
+        expect(subject == other_search).to be_truthy
+      end
+    end
+
+    context "when compared with an array" do
+      it "returns true" do
+        expect(subject == other_search.to_a).to be_truthy
+      end
+    end
+
+    context "when compared with nil" do
+      it "returns false" do
+        expect(subject == nil).to be_falsey
+      end
+    end
+
+    context "when compared with something else" do
+      it "returns false" do
+        expect(subject == "stuff").to be_falsey
+      end
+    end
+  end
+
+  describe '#each' do
+    it "iterates over the list of results" do
+      subject.each do |result|
+        expect(result).to be_a(Hash)
+      end
+    end
+  end
+end

data/spec/px/service/client/multiplexer_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Px::Service::Client::Multiplexer do
+  let(:client) { Px::Service::Client::Base.send(:new) }
+
+  context '.new' do
+    it 'should work with no argments' do
+      expect {
+        Px::Service::Client::Multiplexer.new
+      }.not_to raise_error
+    end
+  end
+
+  context 'with one request', vcr: true do
+    let(:req1) { client.send(:make_request, :get, 'http://localhost:3000/status') }
+
+    it "returns a ResponseFuture" do
+      subject.context do
+        resp1 = subject.do(req1)
+
+        expect(resp1).to be_a(Px::Service::Client::RetriableResponseFuture)
+      end.run
+    end
+
+    it "runs the requests" do
+      subject.context do
+        resp1 = subject.do(req1)
+
+        expect(resp1.body).to eq("OK")
+      end.run
+    end
+  end
+
+  context 'with multiple requests', vcr: true do
+    let(:req1) { client.send(:make_request, :get, 'http://localhost:3000/status') }
+    let(:req2) { client.send(:make_request, :get, 'http://localhost:3000/status') }
+
+    context "when the requests don't depend on each other" do
+      it "runs the requests" do
+        subject.context do
+          resp1 = subject.do(req1)
+          resp2 = subject.do(req2)
+
+          expect(resp2.body).to eq("OK")
+          expect(resp1.body).to eq("OK")
+        end.run
+      end
+    end
+
+    context "when the requests depend on each other" do
+      it "runs the requests" do
+        subject.context do
+          resp1 = subject.do(req1)
+          client.send(:make_request, :get, "http://localhost:3000/status?#{resp1.body}")
+          resp2 = subject.do(req2)
+
+          expect(resp2.body).to eq("OK")
+          expect(resp1.body).to eq("OK")
+        end.run
+      end
+    end
+  end
+end

data/spec/px/service/client/retriable_response_future_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Px::Service::Client::RetriableResponseFuture do
+  let(:request) { Typhoeus::Request.new('http://localhost:3000/status') }
+  let(:response) do
+    Typhoeus::Response.new(
+      code: 200,
+      body: { status: 200, message: "Success"}.to_json,
+      headers: { "Content-Type" => "application/json"} )
+  end
+  let(:hydra) { Typhoeus::Hydra.new }
+  subject { Px::Service::Client::RetriableResponseFuture.new(request) }
+
+  before :each do
+    Typhoeus.stub(/status/).and_return(response)
+  end
+
+  describe '#hydra=' do
+    it "queues the request on the hydra" do
+      expect(hydra).to receive(:queue).with(request)
+
+      subject.hydra = hydra
+    end
+  end
+
+  describe '#method_missing' do
+    context "when the request is still in progress" do
+      it "does not call the method on the response" do
+        Fiber.new do
+          expect(response).not_to receive(:body)
+
+          subject.hydra = hydra
+
+          subject.body
+        end.resume
+      end
+    end
+
+    context "when the request status is an error" do
+      let(:response) do
+        Typhoeus::Response.new(
+          code: 500,
+          body: { status: 500, error: "Failed"}.to_json,
+          headers: { "Content-Type" => "application/json"} )
+      end
+
+      it "completes the future only once" do
+        Fiber.new do
+          expect {
+            subject.total_time
+          }.to raise_error(Px::Service::ServiceError, "Failed")
+        end.resume
+
+        Fiber.new do
+          subject.hydra = hydra
+          hydra.run
+        end.resume
+      end
+
+      it "retries the request" do
+        f = Px::Service::Client::RetriableResponseFuture.new(retries: 3)
+
+        Fiber.new do
+          expect {
+            f.response_code
+          }.to raise_error(Px::Service::ServiceError, "Failed")
+        end.resume
+
+        Fiber.new do
+          expect(hydra).to receive(:queue).with(request).exactly(4).times.and_call_original
+          f.request = request
+
+          f.hydra = hydra
+          hydra.run
+        end.resume
+      end
+    end
+
+    context "when the request completes" do
+      it "calls any pending methods on the response" do
+        expect(response).to receive(:total_time)
+        called = false
+
+        Fiber.new do
+          subject.total_time
+          called = true
+        end.resume
+
+        Fiber.new do
+          subject.hydra = hydra
+          hydra.run
+        end.resume
+
+        expect(called).to eq(true)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'px/service/client'
+require 'timecop'
+require 'vcr'
+
+##
+# VCR config
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr'
+  c.hook_into :typhoeus, :webmock
+  c.allow_http_connections_when_no_cassette = true
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Typhoeus::Expectation.clear
+  end
+
+  config.after(:each) do
+    Timecop.return
+  end
+end

data/spec/vcr/Px_Service_Client_Multiplexer/with_multiple_requests/when_the_requests_depend_on_each_other/runs_the_requests.yml

@@ -0,0 +1,91 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/status
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Type:
+      - text/html; charset=utf-8
+      X-UA-Compatible:
+      - IE=Edge
+      ETag:
+      - "\"e0aa021e21dddbd6d8cecec71e9cf564\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - landing_page=%2Fstatus; path=/
+      - referrer_type=other; path=/
+      - _hpx1=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTNkODFkMDk4MzEyZDExYWI0MTE1YzAwNWYzZTAxM2ZiBjsAVEkiCWhvc3QGOwBGIg5sb2NhbGhvc3Q%3D--85ef4ecf15347d5b26bf5a0c3adae2ff744341aa;
+        path=/; HttpOnly
+      X-Request-Id:
+      - 7dbb973d1e14238a8749e5febcafa9f9
+      X-Runtime:
+      - '0.017194'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: UTF-8
+      string: OK
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://localhost:3000/status
+  recorded_at: Tue, 11 Nov 2014 20:22:51 GMT
+- request:
+    method: get
+    uri: http://localhost:3000/status
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Type:
+      - text/html; charset=utf-8
+      X-UA-Compatible:
+      - IE=Edge
+      ETag:
+      - "\"e0aa021e21dddbd6d8cecec71e9cf564\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - landing_page=%2Fstatus; path=/
+      - referrer_type=other; path=/
+      - _hpx1=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTA1ODdiZDhkOWE2MTk4OWYxMjJhZWM2MjdkZDRkMGNhBjsAVEkiCWhvc3QGOwBGIg5sb2NhbGhvc3Q%3D--61cd8e3e21637857a0eb745049adb6d9e172c1fc;
+        path=/; HttpOnly
+      X-Request-Id:
+      - c8ce1b4570fe232431ca9716a6ee90ea
+      X-Runtime:
+      - '0.018474'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: UTF-8
+      string: OK
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://localhost:3000/status
+  recorded_at: Tue, 11 Nov 2014 20:22:51 GMT
+recorded_with: VCR 2.9.3

data/spec/vcr/Px_Service_Client_Multiplexer/with_multiple_requests/when_the_requests_don_t_depend_on_each_other/runs_the_requests.yml

@@ -0,0 +1,91 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/status
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Type:
+      - text/html; charset=utf-8
+      X-UA-Compatible:
+      - IE=Edge
+      ETag:
+      - "\"e0aa021e21dddbd6d8cecec71e9cf564\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - landing_page=%2Fstatus; path=/
+      - referrer_type=other; path=/
+      - _hpx1=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTRiMWVlZjEyYTA3ZmQ2NTA5NzMzNThlZmRjODUwOTJlBjsAVEkiCWhvc3QGOwBGIg5sb2NhbGhvc3Q%3D--70cae34deed03c594c3ab738150b3d7e20b32fb2;
+        path=/; HttpOnly
+      X-Request-Id:
+      - 7dae1a92439fed487abb36164364741a
+      X-Runtime:
+      - '0.017075'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: UTF-8
+      string: OK
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://localhost:3000/status
+  recorded_at: Tue, 11 Nov 2014 20:22:51 GMT
+- request:
+    method: get
+    uri: http://localhost:3000/status
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Type:
+      - text/html; charset=utf-8
+      X-UA-Compatible:
+      - IE=Edge
+      ETag:
+      - "\"e0aa021e21dddbd6d8cecec71e9cf564\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - landing_page=%2Fstatus; path=/
+      - referrer_type=other; path=/
+      - _hpx1=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTgyMjA5OGEzN2Y3YTczN2ViMzk0ODRjOTk4MTEyNDIzBjsAVEkiCWhvc3QGOwBGIg5sb2NhbGhvc3Q%3D--972313d92247acf7eff13cc669f2c8b4c481e92c;
+        path=/; HttpOnly
+      X-Request-Id:
+      - 8ac3f0a3228f949c5599419f2996d8ca
+      X-Runtime:
+      - '0.016529'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: UTF-8
+      string: OK
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://localhost:3000/status
+  recorded_at: Tue, 11 Nov 2014 20:22:51 GMT
+recorded_with: VCR 2.9.3