wcc-jsonapi 0.1.0 → 0.2.0

metadata

@@ -1,244 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: wcc-jsonapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Watermark Dev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: openapi_parser
+  name: actionpack-action_caching
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rails
   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: '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
+        version: '4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Generates ruby clients for OpenAPI endpoints conformingto the JsonAPI
-  convention
+        version: '4'
+description: Helpers for creating APIs which conform to the JsonAPI standard
 email:
 - dev@watermark.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/wcc/json_api/client_generator.rb
-- lib/wcc/json_api/active_record_shim.rb
-- lib/wcc/json_api/base_client.rb
-- lib/wcc/json_api/base_client/api_error.rb
-- lib/wcc/json_api/base_client/base_response.rb
-- lib/wcc/json_api/base_client/http_adapter.rb
-- lib/wcc/json_api/base_client/typhoeus_adapter.rb
-- lib/wcc/json_api/version.rb
-- wcc-jsonapi.gemspec
-homepage: https://github.com/watermarkchurch/wcc-api
+- lib/wcc-jsonapi.rb
+- lib/wcc/jsonapi.rb
+- lib/wcc/jsonapi/concerns/api_action_caching.rb
+- lib/wcc/jsonapi/concerns/pagination_helper.rb
+- lib/wcc/jsonapi/concerns/serializer_with_caching.rb
+- lib/wcc/jsonapi/rspec.rb
+- lib/wcc/jsonapi/rspec/api_cache_control_examples.rb
+- lib/wcc/jsonapi/rspec/snapshot_helper.rb
+- lib/wcc/jsonapi/version.rb
+homepage: https://www.github.com/watermarkchurch/paper-signs
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -253,9 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.5.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
-summary: Generates ruby clients for OpenAPI endpoints conformingto the JsonAPI convention
+summary: Helpers for creating APIs which conform to the JsonAPI standard
 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,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in wcc-api.gemspec
-gemspec

data/lib/generators/wcc/json_api/client_generator.rb

@@ -1,9 +0,0 @@
-module WCC::JsonAPI
-  class ClientGenerator < Rails::Generators::Base
-    desc "Generates a client from an OpenAPI specification"
-
-    def do_something
-      puts self.inspect
-    end
-  end
-end

data/lib/wcc/json_api/active_record_shim.rb

@@ -1,54 +0,0 @@
-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 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
-
-      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/json_api/base_client/api_error.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module WCC::JsonAPI
-  class BaseClient
-    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/json_api/base_client/base_response.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require_relative 'api_error'
-
-module WCC::JsonAPI
-  class BaseClient
-    class BaseResponse
-      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
-        body.dig('meta', 'skip')
-      end
-
-      def count
-        body.dig('meta', 'total')
-      end
-
-      def data
-        body['data']
-      end
-
-      def links
-        @links ||= OpenStruct.new(body['links'])
-      end
-
-      def collection_response?
-        data.is_a?(Array) ? true : false
-      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
-  end
-end

data/lib/wcc/json_api/base_client/http_adapter.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-gem 'http'
-require 'http'
-
-module WCC::JsonAPI
-  class BaseClient
-    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/json_api/base_client/typhoeus_adapter.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-gem 'typhoeus'
-require 'typhoeus'
-
-class WCC::JsonAPI::BaseClient::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
-