wcc-jsonapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0508ec8a9f9a06c3e595e95fc0858fb223c5d5d
+  data.tar.gz: eb6da7214a9f625b6a59e6f04a7873f46f762ce5
+SHA512:
+  metadata.gz: 7bdf2b4539b048ba97d79f462c8752dcff1974b3863e38b5569cfce071b33d9cb5e677cbf184ed973ba33d4fb2cf7d68e78d7f69af01d577f9e27ea59ec126b4
+  data.tar.gz: 25aca96f9d68022dd7fa2e244d6fde81e4c42492e70fabfd02f5c135314870988c22df21127f764c4f99b9ea54661201b41f76105d0b58cb8a1d4791f5be9c65

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,127 @@
+# 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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,63 @@
+# 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
+

data/lib/wcc/json_api/base_client.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'wcc'
+require_relative 'base_client/response'
+require_relative 'base_client/builder'
+require_relative 'active_record_shim'
+
+module WCC::JsonAPI
+  class BaseClient
+    attr_reader :api_url
+
+    def initialize(api_url:, headers: nil, **options)
+      # normalizes a URL to have a slash on the end
+      @api_url = api_url.gsub(/\/+$/, '') + '/'
+
+      @adapter = BaseClient.load_adapter(options[:adapter])
+
+      @options = options
+      @query_defaults = {}
+      @headers = {
+        'Accept' => 'application/json'
+      }.merge(headers || {}).freeze
+      @response_class = options[:response_class] || BaseResponse
+    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 'base_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
+  end
+end

data/lib/wcc/json_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WCC
+  module JsonAPI
+    VERSION = '0.1.0'
+  end
+end

data/wcc-jsonapi.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wcc/json_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wcc-jsonapi'
+  spec.version       = WCC::JsonAPI::VERSION
+  spec.authors       = ['Watermark Dev']
+  spec.email         = ['dev@watermark.org']
+  spec.summary =
+    spec.description = 'Generates ruby clients for OpenAPI endpoints conforming'\
+      'to the JsonAPI convention'
+  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.add_dependency "openapi_parser", ">= 0.11.1", "< 1.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

@@ -0,0 +1,261 @@
+--- !ruby/object:Gem::Specification
+name: wcc-jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Watermark Dev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openapi_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  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'
+- !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: '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: '3.0'
+description: Generates ruby clients for OpenAPI endpoints conformingto the JsonAPI
+  convention
+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
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.5.2.3
+signing_key:
+specification_version: 4
+summary: Generates ruby clients for OpenAPI endpoints conformingto the JsonAPI convention
+test_files: []