wcc-api 0.2.0 → 0.3.0

data/lib/wcc/api/rspec/pagination_examples.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 RSpec.shared_examples_for :linked_pagination_object do |url_method, base_options, total|
-  it "includes link to current page" do
+  it 'includes link to current page' do
     url = public_send(
       url_method,
       base_options.merge(limit: 2, offset: 2)
@@ -9,20 +11,19 @@ RSpec.shared_examples_for :linked_pagination_object do |url_method, base_options
     expect(subject['_links']['self']).to eq(url)
   end
 
-  it "includes link to next page when there is a next page" do
+  it 'includes link to next page when there is a next page' do
     get public_send(url_method, limit: 2)
     url = public_send(url_method,
-      base_options.merge(limit: 2, offset: 2)
-    )
+      base_options.merge(limit: 2, offset: 2))
     expect(subject['_links']['next']).to eq(url)
   end
 
-  it "does not include link to next page when this is the last page" do
+  it 'does not include link to next page when this is the last page' do
     get public_send(url_method, limit: 2, offset: total - 1)
     expect(subject['_links']['next']).to be_nil
   end
 
-  it "includes link to previous page when there is a previous page" do
+  it 'includes link to previous page when there is a previous page' do
     get public_send(url_method, limit: 2, offset: 2)
     url = public_send(
       url_method,
@@ -31,9 +32,8 @@ RSpec.shared_examples_for :linked_pagination_object do |url_method, base_options
     expect(subject['_links']['previous']).to eq(url)
   end
 
-  it "does not include link to next page when this is the last page" do
+  it 'does not include link to next page when this is the last page' do
     get public_send(url_method, limit: 2)
     expect(subject['_links']['previous']).to be_nil
   end
 end
-

data/lib/wcc/api/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module WCC
   module API
-    VERSION = "0.2.0"
+    VERSION = '0.3.0'
   end
 end

data/lib/wcc/api/view_helpers.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module WCC::API
   module ViewHelpers
-
     def api_pagination_for(query:)
       WCC::API::JSON::Pagination.new(
         query,
-        url_for: -> (params) { url_for(params) }
+        url_for: ->(params) { url_for(params) }
       ).to_builder
     end
-
   end
 end

data/spec/fixtures/contentful/entries.json

@@ -0,0 +1,80 @@
+{
+  "sys": {
+    "type": "Array"
+  },
+  "total": 63,
+  "skip": 0,
+  "limit": 2,
+  "items": [
+    {
+      "sys": {
+        "space": {
+          "sys": {
+            "type": "Link",
+            "linkType": "Space",
+            "id": "hw5pse7y1ojx"
+          }
+        },
+        "id": "6xJzDTX2HCo0u4QKIuGCOu",
+        "type": "Entry",
+        "createdAt": "2018-11-02T19:09:46.884Z",
+        "updatedAt": "2018-11-02T19:09:46.884Z",
+        "environment": {
+          "sys": {
+            "id": "gburgett",
+            "type": "Link",
+            "linkType": "Environment"
+          }
+        },
+        "revision": 1,
+        "contentType": {
+          "sys": {
+            "type": "Link",
+            "linkType": "ContentType",
+            "id": "menuButton"
+          }
+        },
+        "locale": "en-US"
+      },
+      "fields": {
+        "text": "What We Believe",
+        "externalLink": "http://www.watermark.org/fort-worth/about/beliefs"
+      }
+    },
+    {
+      "sys": {
+        "space": {
+          "sys": {
+            "type": "Link",
+            "linkType": "Space",
+            "id": "hw5pse7y1ojx"
+          }
+        },
+        "id": "5yozzvgItUSYu4eI8yQ0ee",
+        "type": "Entry",
+        "createdAt": "2018-11-02T19:09:51.627Z",
+        "updatedAt": "2018-11-02T19:09:51.627Z",
+        "environment": {
+          "sys": {
+            "id": "gburgett",
+            "type": "Link",
+            "linkType": "Environment"
+          }
+        },
+        "revision": 1,
+        "contentType": {
+          "sys": {
+            "type": "Link",
+            "linkType": "ContentType",
+            "id": "section-block-text"
+          }
+        },
+        "locale": "en-US"
+      },
+      "fields": {
+        "internalTitle": "Frisco - Life Stage: Kids' Ministry",
+        "body": "## Kids' Ministry\n\nKids' Ministry is availible for infants and children through 5th grade at both 9 AM and 11 AM services. "
+      }
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+SPEC_DIR = File.dirname(__FILE__)
+FIXTURES_DIR = File.join(SPEC_DIR, 'fixtures')
+
+$LOAD_PATH.unshift File.join(SPEC_DIR, '..', 'lib')
+$LOAD_PATH.unshift SPEC_DIR
+
+require 'dotenv'
+Dotenv.load
+
+require 'webmock/rspec'
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+require 'wcc/api'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.include FixturesHelper
+end

data/spec/support/fixtures_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FixturesHelper
+  def load_fixture(file_name)
+    file = "#{File.dirname(__FILE__)}/../fixtures/#{file_name}"
+    return File.read(file) if File.exist?(file)
+  end
+end

data/spec/wcc/api/rest_client_spec.rb

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'wcc/api/rest_client'
+
+RSpec.describe WCC::API::RestClient do
+  describe 'initialize' do
+    after do
+      described_class::ADAPTERS = {
+        typhoeus: ['typhoeus', '~> 1.0'],
+        http: ['http', '> 1.0', '< 3.0']
+      }.freeze
+    end
+
+    it 'fails to load when no adapter gem found' do
+      expect do
+        described_class::ADAPTERS = {
+          asdf: ['asdf', '~> 1.0']
+        }.freeze
+
+        described_class.new(
+          api_url: 'https://cdn.contentful.com'
+        )
+      end.to raise_error(ArgumentError)
+    end
+
+    it 'fails to load when gem is wrong version' do
+      expect do
+        described_class::ADAPTERS = {
+          http: ['http', '< 1.0']
+        }.freeze
+
+        described_class.new(
+          api_url: 'https://cdn.contentful.com'
+        )
+      end.to raise_error(ArgumentError)
+    end
+
+    it 'loads proc as adapter' do
+      described_class::ADAPTERS = {}.freeze
+      resp = double(body: 'test body', code: 200)
+
+      # act
+      client = described_class.new(
+        api_url: 'https://cdn.contentful.com',
+        adapter: proc { resp }
+      )
+      resp = client.get('http://asdf.com')
+
+      # assert
+      expect(resp.raw_body).to eq('test body')
+    end
+
+    it 'fails to load when adapter is not invokeable' do
+      described_class::ADAPTERS = {}.freeze
+
+      expect do
+        described_class::ADAPTERS = {
+          http: ['http', '< 1.0']
+        }.freeze
+
+        described_class.new(
+          api_url: 'https://cdn.contentful.com',
+          adapter: :whoopsie
+        )
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  described_class::ADAPTERS.keys.each do |adapter|
+    context "with #{adapter} adapter" do
+      subject(:client) do
+        described_class.new(
+          api_url: 'https://cdn.contentful.com/spaces/1234',
+          adapter: adapter
+        )
+      end
+
+      let(:entries) do
+        ::JSON.parse(load_fixture('contentful/entries.json'))
+      end
+
+      describe 'get' do
+        it 'gets entries with query params' do
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries?limit=2')
+            .to_return(body: load_fixture('contentful/entries.json'))
+
+          # act
+          resp = client.get('entries', limit: 2)
+
+          # assert
+          resp.assert_ok!
+          expect(resp.code).to eq(200)
+          expect(resp.to_json['items'].map { |i| i.dig('sys', 'id') }).to eq(
+            %w[6xJzDTX2HCo0u4QKIuGCOu 5yozzvgItUSYu4eI8yQ0ee]
+          )
+        end
+
+        it 'can query entries with query param' do
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: {
+              'content_type' => 'menuButton',
+              'fields.text' => 'Ministries'
+            })
+            .to_return(body: load_fixture('contentful/entries.json'))
+
+          # act
+          resp = client.get('entries',
+            content_type: 'menuButton',
+            'fields.text' => 'Ministries')
+
+          # assert
+          resp.assert_ok!
+          expect(resp.code).to eq(200)
+          expect(resp.to_json['items'].map { |i| i.dig('sys', 'id') }).to eq(
+            %w[6xJzDTX2HCo0u4QKIuGCOu 5yozzvgItUSYu4eI8yQ0ee]
+          )
+        end
+
+        it 'follows redirects' do
+          stub_request(:get, 'http://jtj.watermark.org/api')
+            .to_return(status: 301, headers: { 'Location' => 'https://jtj.watermark.org/api' })
+          stub_request(:get, 'https://jtj.watermark.org/api')
+            .to_return(body: '{ "links": { "entries": "/entries" } }')
+
+          client = described_class.new(
+            api_url: 'http://jtj.watermark.org/'
+          )
+
+          # act
+          resp = client.get('/api')
+
+          # assert
+          resp.assert_ok!
+          expect(resp.to_json['links']).to_not be_nil
+        end
+
+        it 'paginates directly when block given' do
+          page1 = entries.merge('total' => 7)
+          page2 = entries.merge('total' => 7, 'skip' => 2)
+          page3 = entries.merge('total' => 7, 'skip' => 4)
+          page4 = entries.merge('total' => 7, 'skip' => 6)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2 })
+            .to_return(body: page1.to_json)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 2 })
+            .to_return(body: page2.to_json)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 4 })
+            .to_return(body: page3.to_json)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 6 })
+            .to_return(body: page4.to_json)
+
+          # act
+          resp = client.get('entries', limit: 2)
+
+          # assert
+          resp.assert_ok!
+          num_pages = 0
+          resp.each_page do |page|
+            expect(page.to_json['items'].length).to be <= 2
+            num_pages += 1
+          end
+          expect(num_pages).to eq(4)
+        end
+
+        it 'does lazy pagination' do
+          page1 = entries.merge('total' => 7)
+          page2 = entries.merge('total' => 7, 'skip' => 2)
+          page3 = entries.merge('total' => 7, 'skip' => 4)
+          page4 = entries.merge('total' => 7, 'skip' => 6, 'items' => [entries['items'][0]])
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2 })
+            .to_return(body: page1.to_json)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 2 })
+            .to_return(body: page2.to_json)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 4 })
+            .to_return(body: page3.to_json)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 6 })
+            .to_return(body: page4.to_json)
+
+          # act
+          resp = client.get('entries', limit: 2)
+
+          # assert
+          resp.assert_ok!
+          pages = resp.each_page
+          expect(pages).to be_a(Enumerator::Lazy)
+          pages =
+            pages.map do |page|
+              expect(page.to_json['items'].length).to be <= 2
+              page.to_json['items']
+            end
+          pages = pages.force
+          expect(pages.length).to eq(4)
+          expect(pages.flatten.map { |c| c.dig('sys', 'id') })
+            .to eq(%w[
+                     6xJzDTX2HCo0u4QKIuGCOu
+                     5yozzvgItUSYu4eI8yQ0ee
+                     6xJzDTX2HCo0u4QKIuGCOu
+                     5yozzvgItUSYu4eI8yQ0ee
+                     6xJzDTX2HCo0u4QKIuGCOu
+                     5yozzvgItUSYu4eI8yQ0ee
+                     6xJzDTX2HCo0u4QKIuGCOu
+                   ])
+        end
+
+        it 'does not paginate if only the first page is taken' do
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2 })
+            .to_return(body: load_fixture('contentful/entries.json'))
+
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 2 })
+            .to_raise(StandardError.new('Should not execute request for second page'))
+
+          # act
+          resp = client.get('entries', limit: 2)
+
+          # assert
+          resp.assert_ok!
+          items = resp.items.take(2)
+          expect(items.map { |c| c.dig('sys', 'id') }.force)
+            .to eq(%w[
+                     6xJzDTX2HCo0u4QKIuGCOu
+                     5yozzvgItUSYu4eI8yQ0ee
+                   ])
+        end
+
+        it 'memoizes pages' do
+          page1 = entries.merge('total' => 4)
+          page2 = entries.merge('total' => 4, 'skip' => 2)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2 })
+            .to_return(body: page1.to_json)
+            .times(1)
+          stub_request(:get, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(query: { 'limit' => 2, 'skip' => 2 })
+            .to_return(body: page2.to_json)
+            .times(1)
+
+          # act
+          resp = client.get('entries', limit: 2)
+
+          # assert
+          resp.assert_ok!
+          # first pagination
+          expect(resp.items.count).to eq(4)
+          # should be memoized
+          expect(resp.items.map { |c| c.dig('sys', 'id') }.force)
+            .to eq(%w[
+                     6xJzDTX2HCo0u4QKIuGCOu
+                     5yozzvgItUSYu4eI8yQ0ee
+                     6xJzDTX2HCo0u4QKIuGCOu
+                     5yozzvgItUSYu4eI8yQ0ee
+                   ])
+        end
+      end
+    end
+  end
+end