wcc-api 0.1.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d0d85a20f019b951bef1ae2da1975d22c541af6
-  data.tar.gz: adb5cd3c3c01bc1492488a56125429c9ba0647d8
+  metadata.gz: 0c0b6f43132217782441bec2a54a9d046110bf83
+  data.tar.gz: dba5e3f10029efa9cb252474bd7763a3764cd9e4
 SHA512:
-  metadata.gz: 74a49e4005e9a8b621aae1fb71513b30aa965e3a1575d58efaa1b7e2e7d03a967953a8b77c95eefbe56637510a870d3e168410fd2ef74cbfc2f024b038e93bd8
-  data.tar.gz: f65f84b847eb889eeb9e66284465427ccb73f072706a43dbaf02390461676f066b94f814ecb4c7905cac57a9d6b079c2a29a82b8b315df245acbb61967642797
+  metadata.gz: 725780f28f63a96972d70e5c7cd4596c5e4a8bb22955123db4f8d0f30c9ed30aec5cba14a1ccc65359cb0178f1c487d2e431967861f20e87f4fa8a93b2b215e1
+  data.tar.gz: f46f334b4a6c7c202f22898039350a54e7ccd8de6724c9e88cfe19fe3333db6d09c0fa6a4ae80a4f473a42439e513d2327b4e40dc82f6141f9577c4a153364ef

data/lib/wcc/api.rb

@@ -1,17 +1,16 @@
+# frozen_string_literal: true
+
 require 'wcc'
 require 'wcc/api/version'
 
-module WCC
-  module API
-    PROJECT_ROOT = File.expand_path(File.join(__FILE__, '..', '..', '..'))
-  end
+module WCC::API
+  PROJECT_ROOT = File.expand_path(File.join(__FILE__, '..', '..', '..'))
 end
 
-if defined?(Rails)
-  require 'wcc/api/railtie'
-end
+require 'wcc/api/railtie' if defined?(Rails)
 
 require 'wcc/api/base_query'
 require 'wcc/api/json'
+require 'wcc/api/controller_helpers'
+require 'wcc/api/rest_client'
 require 'wcc/api/view_helpers'
-

data/lib/wcc/api/active_record_shim.rb

@@ -0,0 +1,69 @@
+module WCC::API::ActiveRecordShim
+  def self.included(base)
+    base.public_send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module InstanceMethods
+    def attributes
+      raw.keys.each_with_object({}) do |key, h|
+        next unless respond_to?(key)
+
+        val = public_send(key)
+        h[key] =
+          if val.is_a? Array
+            val.map { |v| v.respond_to?(:to_h) ? v.to_h : v }
+          else
+            val.respond_to?(:to_h) ? val.to_h : val
+          end
+      end
+    end
+  end
+
+  module ClassMethods
+    def find(id)
+      client.public_send(endpoint).find(id)
+    end
+
+    def find_all(**filters)
+      client.public_send(endpoint).list(filters)
+    end
+
+    def find_by(**filters)
+      raise ArgumentError, "You must provide at least one filter" if filters.empty?
+
+      find_all(filters).first
+    end
+
+    def model_name
+      name
+    end
+
+    def table_name
+      endpoint
+    end
+
+    def unscoped
+      yield
+    end
+
+    def find_in_batches(options, &block)
+      options = options ? options.dup : {}
+      batch_size = options.delete(:batch_size) || 1000
+      skip_param = [:skip, :offset]
+
+      filter = {
+        limit: batch_size,
+        offset: options.delete(:start) || 0
+      }
+
+      find_all(filter).each_slice(batch_size, &block)
+    end
+
+    def where(**conditions)
+      # TODO: return a Query object that implements more of the ActiveRecord query interface
+      # https://guides.rubyonrails.org/active_record_querying.html#conditions
+      find_all(conditions)
+    end
+  end
+end

data/lib/wcc/api/base_query.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module WCC::API
   class BaseQuery
-    attr_reader :scope, :paging
-    attr_accessor :limit, :offset
+    attr_reader :scope, :paging, :limit, :offset
     attr_accessor :filter
 
     MAX_LIMIT = 50
@@ -15,7 +16,7 @@ module WCC::API
     end
 
     def permitted_keys
-      %i(limit offset filter)
+      %i[limit offset filter]
     end
 
     def default_scope
@@ -27,11 +28,11 @@ module WCC::API
       @paging = paging
       set_defaults
       permitted_keys.each do |key|
-        self.public_send("#{key}=", params[key]) if params.has_key?(key)
+        public_send("#{key}=", params[key]) if params.key?(key)
       end
     end
 
-    def call(scope=self.scope)
+    def call(scope = self.scope)
       scope = scope.dup
       scope = paged(scope)
       scope = ordered(scope)
@@ -39,7 +40,7 @@ module WCC::API
       scope
     end
 
-    def paged(scope=self.scope)
+    def paged(scope = self.scope)
       if paging
         scope
           .limit(limit)
@@ -49,11 +50,11 @@ module WCC::API
       end
     end
 
-    def ordered(scope=self.scope)
+    def ordered(scope = self.scope)
       scope
     end
 
-    def filtered(scope=self.scope)
+    def filtered(scope = self.scope)
       scope
     end
 
@@ -65,7 +66,7 @@ module WCC::API
 
     def limit=(new_limit)
       new_limit = new_limit.to_i
-      @limit = (new_limit > MAX_LIMIT) ? MAX_LIMIT : new_limit
+      @limit = new_limit > MAX_LIMIT ? MAX_LIMIT : new_limit
     end
 
     def offset=(new_offset)
@@ -85,4 +86,3 @@ module WCC::API
     end
   end
 end
-

data/lib/wcc/api/controller_helpers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WCC::API
+  module ControllerHelpers
+    private
+
+    def set_cache_headers(scope_or_record, options = {})
+      options = { public: true, must_revalidate: true }.merge!(options)
+
+      if expiry = options.delete(:expiry)
+        expires_in expiry, options.slice(:public, :must_revalidate)
+      end
+
+      fresh_when scope_or_record, options.slice(:etag, :public, :last_modified)
+    end
+  end
+end

data/lib/wcc/api/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WCC::API
   module JSON
   end

data/lib/wcc/api/json/pagination.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WCC::API::JSON
   class Pagination
     attr_reader :query, :url_for
@@ -19,12 +21,12 @@ module WCC::API::JSON
         json.sort query.sort if query.respond_to?(:sort)
         json.filter query.filter
         json._links do
-          json.self url_for.(base_url_params)
+          json.self url_for.call(base_url_params)
           if has_previous_page?
-            json.previous url_for.(base_url_params.merge(offset: query.offset - query.limit))
+            json.previous url_for.call(base_url_params.merge(offset: query.offset - query.limit))
           end
           if has_next_page?
-            json.next url_for.(base_url_params.merge(offset: query.offset + query.limit))
+            json.next url_for.call(base_url_params.merge(offset: query.offset + query.limit))
           end
         end
       end
@@ -41,17 +43,18 @@ module WCC::API::JSON
     end
 
     def base_url_params
-      @base_url_params ||= {
-        filter: query.filter,
-        only_path: false
-      }.tap do |params|
-        if query.paging
-          params[:limit] = query.limit
-          params[:offset] = query.offset
+      @base_url_params ||=
+        {
+          filter: query.filter,
+          only_path: false
+        }.tap do |params|
+          if query.paging
+            params[:limit] = query.limit
+            params[:offset] = query.offset
+          end
+          params[:order_by] = query.order_by if query.respond_to?(:order_by)
+          params[:sort] = query.sort if query.respond_to?(:sort)
         end
-        params[:order_by] = query.order_by if query.respond_to?(:order_by)
-        params[:sort] = query.sort if query.respond_to?(:sort)
-      end
     end
   end
 end

data/lib/wcc/api/railtie.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'wcc/api'
 
 module WCC
   module API
     class Railtie < Rails::Railtie
-      initializer 'wcc.api railtie initializer', group: :all do |app|
+      initializer 'wcc.api railtie initializer', group: :all do |_app|
         ActiveSupport::Inflector.inflections(:en) do |inflect|
           inflect.acronym 'API'
         end

data/lib/wcc/api/rest_client.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+require 'wcc'
+require_relative 'rest_client/response'
+require_relative 'rest_client/builder'
+require_relative 'active_record_shim'
+
+module WCC::API
+  class RestClient
+    attr_reader :api_url
+
+    class << self
+      attr_reader :resources, :params
+
+      def rest_client(&block)
+        builder = Builder.new(self)
+        builder.instance_exec(&block)
+        builder.apply
+      end
+    end
+
+    def initialize(api_url:, headers: nil, **options)
+      # normalizes a URL to have a slash on the end
+      @api_url = api_url.gsub(/\/+$/, '') + '/'
+
+      @adapter = RestClient.load_adapter(options[:adapter])
+
+      @options = options
+      @query_defaults = {}
+      @headers = {
+        'Accept' => 'application/json'
+      }.merge(headers || {}).freeze
+      @response_class = options[:response_class] || DefaultResponse
+    end
+
+    # performs an HTTP GET request to the specified path within the configured
+    # space and environment.  Query parameters are merged with the defaults and
+    # appended to the request.
+    def get(path, query = {})
+      url = URI.join(@api_url, path)
+
+      @response_class.new(self,
+        { url: url, query: query },
+        get_http(url, query))
+    end
+
+    def post(path, body = {})
+      url = URI.join(@api_url, path)
+
+      @response_class.new(self,
+        { url: url },
+        post_http(url,
+          body.to_json,
+          headers: { 'Content-Type': 'application/json' }))
+    end
+
+    def put(path, body = {})
+      url = URI.join(@api_url, path)
+
+      @response_class.new(self,
+        { url: url },
+        put_http(url,
+          body.to_json,
+          headers: { 'Content-Type': 'application/json' }))
+    end
+
+    def delete(path)
+      url = URI.join(@api_url, path)
+
+      @response_class.new(self,
+        { url: url },
+        delete_http(url))
+    end
+
+    ADAPTERS = {
+      faraday: ['faraday', '~> 0.9'],
+      typhoeus: ['typhoeus', '~> 1.0']
+    }.freeze
+
+    def self.load_adapter(adapter)
+      case adapter
+      when nil
+        ADAPTERS.each do |a, spec|
+          begin
+            gem(*spec)
+            return load_adapter(a)
+          rescue Gem::LoadError
+            next
+          end
+        end
+        raise ArgumentError, 'Unable to load adapter!  Please install one of '\
+          "#{ADAPTERS.values.map(&:join).join(',')}"
+      when :faraday
+        require 'faraday'
+        ::Faraday.new do |faraday|
+          faraday.response :logger, (Rails.logger if defined?(Rails)), { headers: false, bodies: false }
+          faraday.adapter :net_http
+        end
+      when :typhoeus
+        require_relative 'rest_client/typhoeus_adapter'
+        TyphoeusAdapter.new
+      else
+        unless adapter.respond_to?(:get)
+          raise ArgumentError, "Adapter #{adapter} is not invokeable!  Please "\
+            "pass use one of #{ADAPTERS.keys} or create a Faraday-compatible adapter"
+        end
+        adapter
+      end
+    end
+
+    private
+
+    def get_http(url, query, headers = {})
+      headers = @headers.merge(headers || {})
+
+      q = @query_defaults.dup
+      q = q.merge(query) if query
+
+      resp = @adapter.get(url, q, headers)
+
+      resp = get_http(resp.headers['location'], nil, headers) if [301, 302, 307].include?(resp.status) && !@options[:no_follow_redirects]
+      resp
+    end
+
+    def post_http(url, body, headers: {})
+      headers = @headers.merge(headers || {})
+
+      resp = @adapter.post(url, body, headers)
+
+      resp = get_http(resp.headers['location'], nil, headers) if [301, 302, 307].include?(resp.status) && !@options[:no_follow_redirects]
+      resp
+    end
+
+    def put_http(url, body, headers: {})
+      headers = @headers.merge(headers || {})
+
+      resp = @adapter.put(url, body, headers)
+
+      resp = get_http(resp.headers['location'], nil, headers) if [301, 302, 307].include?(resp.status) && !@options[:no_follow_redirects]
+      resp
+    end
+
+    def delete_http(url, headers: {})
+      headers = @headers.merge(headers || {})
+
+      resp = @adapter.delete(url, {}, headers)
+
+      resp = get_http(resp.headers['location'], nil, headers) if [301, 302, 307].include?(resp.status) && !@options[:no_follow_redirects]
+      resp
+    end
+
+    class Resource
+      attr_reader :client, :endpoint, :model, :options
+
+      def initialize(client, endpoint, model, options)
+        @client = client
+        @endpoint = endpoint
+        @model = model
+        @options = options
+      end
+
+      def find(id, query = {})
+        query = (options[:query] || {}).merge(query)
+        resp = client.get("#{endpoint}/#{id}", query)
+        resp.assert_ok!
+        body = options[:key] ? resp.body[options[:key]] : resp.body
+        model.new(body, resp.headers.freeze)
+      end
+
+      def list(**filters)
+        query = extract_params(filters)
+        query = (options[:query] || {}).merge(query)
+        query = query.merge!(apply_filters(filters, options[:filters]))
+        resp = client.get(endpoint, query)
+        resp.assert_ok!
+        resp.items.map { |s| model.new(s) }
+      end
+
+      def create(body)
+        resp = client.post(endpoint, body)
+        resp.assert_ok!
+        maybe_model_from_response(resp)
+      end
+
+      def update(id, body)
+        resp = client.put("#{endpoint}/#{id}", body)
+        resp.assert_ok!
+        maybe_model_from_response(resp)
+      end
+
+      def destroy(id)
+        resp = client.delete("#{endpoint}/#{id}")
+        resp.assert_ok!
+        maybe_model_from_response(resp)
+      end
+
+      protected
+
+      def maybe_model_from_response(resp)
+        return true if resp.status == 204
+        return true unless resp.raw_body.present?
+
+        body = options[:key] ? resp.body[options[:key]] : resp.body
+        return true unless body.present?
+
+        model.new(body, resp.headers.freeze)
+      end
+
+      def extract_params(filters)
+        filters.each_with_object({}) do |(k, _v), h|
+          k_s = k.to_s
+          h[k_s] = filters.delete(k) if client.class.params.include?(k_s)
+        end
+      end
+
+      def filter_key(filter_name)
+        filter_name
+      end
+
+      def apply_filters(filters, expected_filters)
+        defaults = default_filters(expected_filters) || {}
+        filters.each_with_object(defaults) do |(k, v), h|
+          k = k.to_s
+          raise ArgumentError, "Unknown filter '#{k}'" unless expected_filters.include?(k)
+
+          h[filter_key(k)] = v
+        end
+      end
+
+      def default_filters(expected_filters)
+        options[:default_filters]&.each_with_object({}) do |(k, v), h|
+          k = k.to_s
+          h[filter_key(k)] = v if expected_filters.include?(k)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module WCC::API
+  class RestClient
+    class ApiError < StandardError
+      attr_reader :response
+
+      def self.[](code)
+        case code
+        when 404
+          NotFoundError
+        else
+          ApiError
+        end
+      end
+
+      def initialize(response)
+        @response = response
+        super(response.error_message)
+      end
+    end
+
+    class NotFoundError < ApiError
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module WCC::API
+  class RestClient
+    class Builder
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def params(*params)
+        @params = params.map(&:to_s)
+      end
+
+      attr_writer :resource_class
+      def resource_class
+        @resource_class ||=
+          @klass.const_get("Resource") || WCC::API::RestClient::Resource
+      end
+
+      def resource(endpoint, model:, **options, &block)
+        @resources ||= {}
+
+        resource_class = options[:resource_class] || self.resource_class
+        if block_given?
+          resource_class = Class.new(resource_class, &block)
+        end
+        @resources[endpoint] = options.merge({
+          resource_class: resource_class,
+          model: model,
+        })
+      end
+
+      def apply
+        closed_params = (@params || []).freeze
+        resources = @resources
+        klass = @klass
+
+        klass.class_exec do
+          define_singleton_method :params do
+            closed_params
+          end
+
+          define_singleton_method :default do
+            @default ||= new
+          end
+
+          define_singleton_method :default= do |client|
+            @default = client
+          end
+
+          resources.each do |(endpoint, options)|
+            attr_name = options[:attribute] || endpoint.downcase
+            resource_class = options[:resource_class]
+
+            define_method attr_name do
+              instance_variable_get("@#{attr_name}") ||
+                instance_variable_set("@#{attr_name}", 
+                  resource_class.new(self, endpoint, options[:model], @options.merge(options))
+                )
+            end
+          end
+        end
+
+        resources.each do |(endpoint, options)|
+          options[:model].class_exec do
+            define_singleton_method :client do
+              klass.default
+            end
+
+            define_singleton_method :endpoint do
+              endpoint
+            end
+
+            define_singleton_method :key do
+              options[:key]
+            end
+          end
+
+          options[:model].send(:include, WCC::API::ActiveRecordShim)
+        end
+      end
+    end
+  end
+end

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.1"
+    VERSION = '0.5.1'
   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/wcc-api.gemspec

@@ -1,25 +1,37 @@
-# 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.files         = Dir['lib/**/*'] + %w[LICENSE.txt README.md wcc-api.gemspec]
   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.1
+  version: 0.5.1
 platform: ruby
 authors:
-- Watermark Dev Team
-autorequire: 
+- Watermark Dev
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wcc-base
@@ -38,38 +38,199 @@ 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: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - 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
@@ -79,7 +240,7 @@ homepage: https://github.com/watermarkchurch/wcc-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,9 +255,10 @@ 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.6.11
+signing_key:
 specification_version: 4
-summary: Holds common code used in our applications that host APIs.
+summary: Holds common code used in our applications that host APIs and those that
+  consume them.
 test_files: []

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in wcc-api.gemspec
-gemspec

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-