wcc-api 0.1.0 → 0.5.0

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,296 @@
+# 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 '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
+
+      describe 'post' do
+        it 'performs a post with body' do
+          stub_request(:post, 'https://cdn.contentful.com/spaces/1234/entries')
+            .with(body: '{"test":"data"}')
+            .to_return(status: 204)
+
+          # act
+          resp = client.post('entries', { 'test' => 'data' })
+
+          # assert
+          resp.assert_ok!
+          expect(resp.status).to eq(204)
+        end
+      end
+
+      describe 'put' do
+        it 'performs a put with body' do
+          stub_request(:put, 'https://cdn.contentful.com/spaces/1234/entries/123')
+            .with(body: '{"test":"data"}')
+            .to_return(body: '{"test":"data"}')
+
+          # act
+          resp = client.put('entries/123', { 'test' => 'data' })
+
+          # assert
+          resp.assert_ok!
+          expect(resp.status).to eq(200)
+          expect(resp.body).to eq({ 'test' => 'data' })
+        end
+      end
+
+      describe 'delete' do
+        it 'performs a delete' do
+          stub_request(:delete, 'https://cdn.contentful.com/spaces/1234/entries/123')
+            .to_return(status: 204)
+
+          # act
+          resp = client.delete('entries/123')
+
+          # assert
+          resp.assert_ok!
+          expect(resp.status).to eq(204)
+        end
+      end
+    end
+  end
+end

data/wcc-api.gemspec

@@ -1,25 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wcc/api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "wcc-api"
+  spec.name          = 'wcc-api'
   spec.version       = WCC::API::VERSION
-  spec.authors       = ["Watermark Dev Team"]
-  spec.email         = ["dev@watermark.org"]
-  spec.summary       = %q{Holds common code used in our applications that host APIs.}
-  spec.description   = %q{holds common code used in our applications that host APIs.}
-  spec.homepage      = "https://github.com/watermarkchurch/wcc-api"
-  spec.license       = "MIT"
+  spec.authors       = ['Watermark Dev']
+  spec.email         = ['dev@watermark.org']
+  spec.summary =
+    spec.description = 'Holds common code used in our applications that host ' \
+    'APIs and those that consume them.'
+  spec.homepage      = 'https://github.com/watermarkchurch/wcc-api'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "wcc-base"
+  spec.add_dependency 'wcc-base'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'dotenv', '~> 0.10.0'
+  spec.add_development_dependency 'faraday', '~> 0.9'
+  spec.add_development_dependency 'guard', '~> 2.15'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3'
+  spec.add_development_dependency 'httplog', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
+  spec.add_development_dependency 'rubocop', '0.69.0'
+  spec.add_development_dependency 'typhoeus', '~> 1.3'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
-- Watermark Dev Team
-autorequire: 
+- Watermark Dev
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wcc-base
@@ -38,48 +38,224 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: httplog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.69.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.69.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: holds common code used in our applications that host APIs.
+        version: '3.0'
+description: Holds common code used in our applications that host APIs and those that
+  consume them.
 email:
 - dev@watermark.org
-executables: []
+executables:
+- rspec
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".env.example"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rspec
 - lib/wcc/api.rb
+- lib/wcc/api/active_record_shim.rb
 - lib/wcc/api/base_query.rb
+- lib/wcc/api/controller_helpers.rb
 - lib/wcc/api/json.rb
 - lib/wcc/api/json/pagination.rb
 - lib/wcc/api/railtie.rb
+- lib/wcc/api/rest_client.rb
+- lib/wcc/api/rest_client/api_error.rb
+- lib/wcc/api/rest_client/builder.rb
+- lib/wcc/api/rest_client/http_adapter.rb
+- lib/wcc/api/rest_client/response.rb
+- lib/wcc/api/rest_client/typhoeus_adapter.rb
 - lib/wcc/api/rspec.rb
+- lib/wcc/api/rspec/cache_header_examples.rb
 - lib/wcc/api/rspec/collection_matchers.rb
 - lib/wcc/api/rspec/pagination_examples.rb
 - lib/wcc/api/version.rb
 - lib/wcc/api/view_helpers.rb
+- spec/fixtures/contentful/entries.json
+- spec/spec_helper.rb
+- spec/support/fixtures_helper.rb
+- spec/wcc/api/rest_client_spec.rb
 - wcc-api.gemspec
 homepage: https://github.com/watermarkchurch/wcc-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,9 +270,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.5.2.3
+signing_key:
 specification_version: 4
-summary: Holds common code used in our applications that host APIs.
-test_files: []
+summary: Holds common code used in our applications that host APIs and those that
+  consume them.
+test_files:
+- spec/fixtures/contentful/entries.json
+- spec/spec_helper.rb
+- spec/support/fixtures_helper.rb
+- spec/wcc/api/rest_client_spec.rb