wcc-api 0.1.0 → 0.5.0

data/lib/wcc/api/rest_client/http_adapter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+gem 'http'
+require 'http'
+
+module WCC::API
+  class RestClient
+    class HttpAdapter
+      def call(url, query, headers = {}, proxy = {})
+        if proxy[:host]
+          HTTP[headers].via(proxy[:host], proxy[:port], proxy[:username], proxy[:password])
+            .get(url, params: query)
+        else
+          HTTP[headers].get(url, params: query)
+        end
+      end
+    end
+  end
+end

data/lib/wcc/api/rest_client/response.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'api_error'
+
+module WCC::API
+  class RestClient
+    class AbstractResponse
+      extend ::Forwardable
+
+      attr_reader :raw_response
+      attr_reader :raw_body
+      attr_reader :client
+      attr_reader :request
+
+      def_delegators :raw_response, :status, :headers
+      alias_method :code, :status
+
+      def body
+        @body ||= ::JSON.parse(raw_body)
+      end
+      alias_method :to_json, :body
+
+      def initialize(client, request, raw_response)
+        @client = client
+        @request = request
+        @raw_response = raw_response
+        @raw_body = raw_response.body.to_s
+      end
+
+      def skip
+        throw new NotImplementedError, 'Please implement "skip" parsing in response class'
+      end
+
+      def count
+        throw new NotImplementedError, 'Please implement "count" parsing in response class'
+      end
+
+      def collection_response?
+        page_items.nil? ? false : true
+      end
+
+      def page_items
+        throw new NotImplementedError, 'Please implement "page_items" parsing in response class'
+      end
+
+      def error_message
+        parsed_message =
+          begin
+            body.dig('error', 'message') || body.dig('message')
+          rescue ::JSON::ParserError
+            nil
+          end
+        parsed_message || "#{code}: #{raw_response.body}"
+      end
+
+      def next_page?
+        return false unless collection_response?
+        return false if count.nil?
+
+        page_items.length + skip < count
+      end
+
+      def next_page
+        return unless next_page?
+
+        @next_page ||= @client.get(
+          @request[:url],
+          (@request[:query] || {}).merge(next_page_query)
+        )
+        @next_page.assert_ok!
+      end
+
+      def assert_ok!
+        return self if code >= 200 && code < 300
+
+        raise ApiError[code], self
+      end
+
+      # This method has a bit of complexity that is better kept in one location
+      def each_page(&block)
+        raise ArgumentError, 'Not a collection response' unless collection_response?
+
+        ret =
+          Enumerator.new do |y|
+            y << self
+
+            if next_page?
+              next_page.each_page.each do |page|
+                y << page
+              end
+            end
+          end
+
+        if block_given?
+          ret.map(&block)
+        else
+          ret.lazy
+        end
+      end
+
+      def items
+        return unless collection_response?
+
+        each_page.flat_map(&:page_items)
+      end
+
+      def first
+        raise ArgumentError, 'Not a collection response' unless collection_response?
+
+        page_items.first
+      end
+
+      def next_page_query
+        return unless collection_response?
+
+        {
+          skip: page_items.length + skip
+        }
+      end
+    end
+
+    class DefaultResponse < AbstractResponse
+      def skip
+        body['skip']
+      end
+
+      def count
+        body['total']
+      end
+
+      def page_items
+        body['items']
+      end
+    end
+  end
+end

data/lib/wcc/api/rest_client/typhoeus_adapter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+gem 'typhoeus'
+require 'typhoeus'
+
+class WCC::API::RestClient::TyphoeusAdapter
+  def get(url, params = {}, headers = {})
+    req = OpenStruct.new(params: params, headers: headers)
+    yield req if block_given?
+    Response.new(
+      Typhoeus.get(
+        url,
+        params: req.params,
+        headers: req.headers
+      )
+    )
+  end
+
+  def post(url, body, headers = {})
+    Response.new(
+      Typhoeus.post(
+        url,
+        body: body.is_a?(String) ? body : body.to_json,
+        headers: headers
+      )
+    )
+  end
+
+  def put(url, body, headers = {})
+    Response.new(
+      Typhoeus.put(
+        url,
+        body: body.is_a?(String) ? body : body.to_json,
+        headers: headers
+      )
+    )
+  end
+
+  def delete(url, query = {}, headers = {})
+    Response.new(
+      Typhoeus.delete(
+        url,
+        headers: headers
+      )
+    )
+  end
+
+  class Response < SimpleDelegator
+    def raw
+      __getobj__
+    end
+
+    def to_s
+      body&.to_s
+    end
+
+    def status
+      code
+    end
+  end
+end
+

data/lib/wcc/api/rspec.rb

@@ -1,3 +1,5 @@
-require 'wcc/api/rspec/pagination_examples'
-require 'wcc/api/rspec/collection_matchers'
+# frozen_string_literal: true
 
+require 'wcc/api/rspec/cache_header_examples'
+require 'wcc/api/rspec/collection_matchers'
+require 'wcc/api/rspec/pagination_examples'

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'cached resource defaults' do
+  it 'sets etag' do
+    expect(response.etag).to_not be_nil
+  end
+
+  it 'sets public: true' do
+    expect(response.cache_control[:public]).to be_truthy
+  end
+end
+
+RSpec.shared_examples_for 'cached member resource' do
+  include_examples 'cached resource defaults'
+
+  it 'sets last modified' do
+    expect(response.last_modified).to_not be_nil
+  end
+
+  it 'does not set max age' do
+    expect(response.cache_control[:max_age]).to be_nil
+  end
+
+  it 'does not set must_revalidate' do
+    expect(response.cache_control[:must_revalidate]).to be_nil
+  end
+end
+
+RSpec.shared_examples_for 'cached collection resource' do |max_age|
+  include_examples 'cached resource defaults'
+
+  it 'sets max age' do
+    expect(response.cache_control[:max_age]).to eq(max_age.to_s)
+  end
+
+  it 'sets must_revalidate: true' do
+    expect(response.cache_control[:must_revalidate]).to be_truthy
+  end
+
+  it 'does not set last modified' do
+    expect(response.last_modified).to be_nil
+  end
+end

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

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module WCC::API::RSpec
   module CollectionMatchers
     def collection_match(coll1, coll2, matcher = :eq)
-      coll1, coll2 = coll1.to_a, coll2.to_a
+      coll1 = coll1.to_a
+      coll2 = coll2.to_a
       expect(coll1.size).to eq(coll2.size)
 
       coll1.zip(coll2).each do |actual, expected|
@@ -10,4 +13,3 @@ module WCC::API::RSpec
     end
   end
 end
-

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.1.0"
+    VERSION = '0.5.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