web_fetch 0.1.3 → 0.2.0

data/spec/resources_spec.rb

@@ -24,7 +24,7 @@ describe WebFetch::Resources do
     end
   end
 
-  describe 'retrieve' do
+  describe '.retrieve' do
     it 'gives 404 not found when unrecognised uid requested' do
       result = described_class.retrieve(server, uid: '123')
       expect(result[:status]).to eql 404
@@ -39,4 +39,20 @@ describe WebFetch::Resources do
       expect(error).to eql I18n.t(:hash_not_found)
     end
   end
+
+  describe '.find' do
+    it 'gives 404 not found when unrecognised uid requested' do
+      result = described_class.find(server, uid: '123')
+      expect(result[:status]).to eql 404
+      error = result[:payload][:error]
+      expect(error).to eql I18n.t(:uid_not_found)
+    end
+
+    it 'gives 404 not found when unrecognised hash requested' do
+      result = described_class.find(server, hash: 'abc')
+      expect(result[:status]).to eql 404
+      error = result[:payload][:error]
+      expect(error).to eql I18n.t(:hash_not_found)
+    end
+  end
 end

data/spec/result_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.describe WebFetch::Result do
+  let(:result) do
+    described_class.new(
+      body: 'abc123',
+      headers: { 'Foo' => 'Bar' },
+      status: 200,
+      pending: false,
+      success: false,
+      error: 'foo error happened',
+      uid: 'uid123'
+    )
+  end
+
+  subject { result }
+
+  it { is_expected.to be_a described_class }
+  its(:body) { is_expected.to eql 'abc123' }
+  its(:headers) { are_expected.to eql('Foo' => 'Bar') }
+  its(:status) { is_expected.to eql 200 }
+  its(:pending?) { is_expected.to be false }
+  its(:complete?) { is_expected.to be true }
+  its(:success?) { is_expected.to be false }
+  its(:error) { is_expected.to eql 'foo error happened' }
+  its(:uid) { is_expected.to eql 'uid123' }
+end

data/spec/retriever_spec.rb

@@ -5,31 +5,34 @@ describe WebFetch::Retriever do
   let(:valid_params) { { uid: 'abc123' } }
 
   it 'is initialisable with params' do
-    expect(described_class.new(server, valid_params)).to be_a described_class
+    expect(described_class.new(server, valid_params, {}))
+      .to be_a described_class
   end
 
   describe 'validation' do
     context 'valid' do
       it 'is valid when `uid` given' do
-        retriever = described_class.new(server, uid: 'abc123')
+        retriever = described_class.new(server, { uid: 'abc123' }, {})
         expect(retriever.valid?).to be true
       end
 
       it 'is valid when `hash` given' do
-        retriever = described_class.new(server, hash: 'def456')
+        retriever = described_class.new(server, { hash: 'def456' }, {})
         expect(retriever.valid?).to be true
       end
     end
 
     context 'invalid' do
       it 'is invalid if both `hash` and `uid` given' do
-        retriever = described_class.new(server, hash: 'def456', uid: 'abc123')
+        retriever = described_class.new(
+          server, { hash: 'def456', uid: 'abc123' }, {}
+        )
         expect(retriever.valid?).to be false
         expect(retriever.errors).to include I18n.t(:hash_or_uid_but_not_both)
       end
 
       it 'is invalid if neither `hash` nor `uid` given' do
-        retriever = described_class.new(server, {})
+        retriever = described_class.new(server, {}, {})
         expect(retriever.valid?).to be false
         expect(retriever.errors).to include I18n.t(:missing_hash_and_uid)
       end
@@ -38,12 +41,12 @@ describe WebFetch::Retriever do
 
   describe '#find' do
     it 'returns `nil` when given uid has not been requested' do
-      retriever = described_class.new(server, uid: 'nope')
+      retriever = described_class.new(server, { uid: 'nope' }, {})
       expect(retriever.find).to be_nil
     end
 
     it 'returns `nil` when given hash has not been requested' do
-      retriever = described_class.new(server, hash: 'also nope')
+      retriever = described_class.new(server, { hash: 'also nope' }, {})
       expect(retriever.find).to be_nil
     end
 
@@ -61,7 +64,7 @@ describe WebFetch::Retriever do
       expect(server).to receive(:storage)
         .and_return(uid => { body: 'fake body' })
 
-      retriever = described_class.new(server, uid: uid)
+      retriever = described_class.new(server, { uid: uid }, {})
       expect(retriever.find[:body]).to eql 'fake body'
     end
   end

data/spec/router_spec.rb

@@ -20,7 +20,12 @@ describe WebFetch::Router do
 
     it 'provides a route to GET /retrieve' do
       expect(WebFetch::Resources).to receive(:retrieve).and_return('hello')
-      expect(router.route('/retrieve', method: 'GET')).to eql 'hello'
+      expect(router.route('/retrieve/123', method: 'GET')).to eql 'hello'
+    end
+
+    it 'provides a route to GET /find' do
+      expect(WebFetch::Resources).to receive(:find).and_return('hello')
+      expect(router.route('/find/123', method: 'GET')).to eql 'hello'
     end
 
     it 'decodes `json` parameter and merges into request params' do

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'web_fetch'
 require 'pp'
 require 'byebug'
 require 'webmock/rspec'
+require 'rspec/its'
 
 WebMock.disable_net_connect!(allow_localhost: true)
 

data/spec/storage_spec.rb

@@ -14,11 +14,14 @@ describe WebFetch::Storage do
       described_class.store(:key, :value)
       expect(described_class.fetch(:key)).to eql :value
     end
+  end
 
-    it 'removes item from storage after retrieval' do
+  describe '.delete' do
+    it 'deletes stored values' do
       described_class.store(:key, :value)
-      described_class.fetch(:key)
-      expect(described_class.fetch(:key)).to be_nil
+      expect(described_class.fetch(:key)).to eql :value
+      described_class.delete(:key)
+      expect(described_class.fetch(:key)).to eql nil
     end
   end
 end

data/swagger.yaml

@@ -22,7 +22,7 @@ paths:
               application:
                 type: string
                 description: WebFetch
-                
+
   /gather:
     post:
       summary: Initiate fetching one or more HTTP entities.
@@ -42,11 +42,11 @@ paths:
           description: An array of objects providing job IDs and original parameters.
           schema:
             $ref: '#/definitions/GatherResponse'
-              
+
 
   /retrieve/{id}:
     get:
-      summary: Retrieve a gathered HTTP entity.
+      summary: Retrieve a gathered HTTP entity (blocking).
       description: |
         Receives a unique identifier and returns the previously requested HTTP entity. This action will block until the entity has been successfully downloaded.
       parameters:
@@ -62,7 +62,26 @@ paths:
             type: object
             items:
               $ref: '#/definitions/Retrieved'
-    
+
+  /find/{id}:
+    get:
+      summary: Retrieve a gathered HTTP entity (non-blocking).
+      description: |
+        Receives a unique identifier and returns the previously requested HTTP entity. This action will return immediately and provide a pending status if the entity has not finished downloading.
+      parameters:
+        - name: id
+          in: path
+          type: string
+          description: Unique identifier for HTTP entity.
+          required: true
+      responses:
+        200:
+          description: An object containing HTTP entity elements.
+          schema:
+            type: object
+            items:
+              $ref: '#/definitions/Found'
+
 definitions:
   Request:
     type: object
@@ -98,7 +117,24 @@ definitions:
             type: object
           status:
             type: integer
-            
+  Found:
+    type: object
+    properties:
+      response:
+        type: object
+        description: Requested HTTP entity elements.
+        properties:
+          success:
+            type: boolean
+          body:
+            type: string
+          headers:
+            type: object
+          status:
+            type: integer
+          pending:
+            type: boolean
+
   GatherResponse:
     type: array
     items:
@@ -112,4 +148,4 @@ definitions:
           description: SHA1 hash of request based on url, query parameters, headers, method [currently this serves no purpose].
         request:
           type: object
-          description: Original requested HTTP parameters.
+          description: Original requested HTTP parameters.

data/web_fetch.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'byebug', '~> 9.0'
   s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'rspec-its', '~> 1.2'
   s.add_development_dependency 'rubocop', '~> 0.59.2'
   s.add_development_dependency 'webmock', '~> 3.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web_fetch
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Bob Farrell
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -255,18 +269,26 @@ files:
 - bin/web_fetch_control
 - bin/web_fetch_server
 - config/locales/en.yml
-- doc/client_example.rb
+- doc/examples/blocking_requests.rb
+- doc/examples/non_blocking_requests.rb
+- doc/examples/use_uid_for_request.rb
 - doc/web_fetch_architecture.png
+- docker/Dockerfile
 - lib/web_fetch.rb
 - lib/web_fetch/client.rb
+- lib/web_fetch/concerns/client_http.rb
 - lib/web_fetch/concerns/http_helpers.rb
 - lib/web_fetch/concerns/validatable.rb
+- lib/web_fetch/errors.rb
 - lib/web_fetch/event_machine_helpers.rb
 - lib/web_fetch/gatherer.rb
 - lib/web_fetch/helpers.rb
 - lib/web_fetch/http_helpers.rb
 - lib/web_fetch/logger.rb
+- lib/web_fetch/promise.rb
+- lib/web_fetch/request.rb
 - lib/web_fetch/resources.rb
+- lib/web_fetch/result.rb
 - lib/web_fetch/retriever.rb
 - lib/web_fetch/router.rb
 - lib/web_fetch/server.rb
@@ -278,7 +300,10 @@ files:
 - spec/gatherer_spec.rb
 - spec/helpers_spec.rb
 - spec/i18n_spec.rb
+- spec/promise_spec.rb
+- spec/request_spec.rb
 - spec/resources_spec.rb
+- spec/result_spec.rb
 - spec/retriever_spec.rb
 - spec/router_spec.rb
 - spec/server_spec.rb

data/doc/client_example.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Run me with:
-# bundle exec ruby doc/client_example.rb
-require 'web_fetch'
-begin
-  cli = WebFetch::Client.create('localhost', 8077)
-  results = cli.gather([
-                         { url: 'http://localhost:8077/' },
-                         { url: 'http://yahoo.com/' },
-                         { url: 'http://lycos.com/' },
-                         { url: 'http://google.com/' }
-                       ])
-  results.each do |res|
-    p cli.retrieve_by_uid(res[:uid])
-  end
-ensure
-  cli.stop
-end