simple_jsonapi_client 0.1.0

data/bin/rails

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+docker-compose run -p 3000:3000 jsonapi_app_console rails "$@"

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+docker-compose build
+bin/rails db:setup

data/bin/wait_for_it

@@ -0,0 +1,178 @@
+#!/usr/bin/env bash
+#   Use this script to test if a given TCP host/port are available
+#   Credit: https://github.com/vishnubob/wait-for-it/blob/db049716e42767d39961e95dd9696103dca813f1/wait-for-it.sh
+
+cmdname=$(basename $0)
+
+echoerr() { if [[ $QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
+
+usage()
+{
+    cat << USAGE >&2
+Usage:
+    $cmdname host:port [-s] [-t timeout] [-- command args]
+    -h HOST | --host=HOST       Host or IP under test
+    -p PORT | --port=PORT       TCP port under test
+                                Alternatively, you specify the host and port as host:port
+    -s | --strict               Only execute subcommand if the test succeeds
+    -q | --quiet                Don't output any status messages
+    -t TIMEOUT | --timeout=TIMEOUT
+                                Timeout in seconds, zero for no timeout
+    -- COMMAND ARGS             Execute command with args after the test finishes
+USAGE
+    exit 1
+}
+
+wait_for()
+{
+    if [[ $TIMEOUT -gt 0 ]]; then
+        echoerr "$cmdname: waiting $TIMEOUT seconds for $HOST:$PORT"
+    else
+        echoerr "$cmdname: waiting for $HOST:$PORT without a timeout"
+    fi
+    start_ts=$(date +%s)
+    while :
+    do
+        if [[ $ISBUSY -eq 1 ]]; then
+            nc -z $HOST $PORT
+            result=$?
+        else
+            (echo > /dev/tcp/$HOST/$PORT) >/dev/null 2>&1
+            result=$?
+        fi
+        if [[ $result -eq 0 ]]; then
+            end_ts=$(date +%s)
+            echoerr "$cmdname: $HOST:$PORT is available after $((end_ts - start_ts)) seconds"
+            break
+        fi
+        sleep 1
+    done
+    return $result
+}
+
+wait_for_wrapper()
+{
+    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
+    if [[ $QUIET -eq 1 ]]; then
+        timeout $BUSYTIMEFLAG $TIMEOUT $0 --quiet --child --host=$HOST --port=$PORT --timeout=$TIMEOUT &
+    else
+        timeout $BUSYTIMEFLAG $TIMEOUT $0 --child --host=$HOST --port=$PORT --timeout=$TIMEOUT &
+    fi
+    PID=$!
+    trap "kill -INT -$PID" INT
+    wait $PID
+    RESULT=$?
+    if [[ $RESULT -ne 0 ]]; then
+        echoerr "$cmdname: timeout occurred after waiting $TIMEOUT seconds for $HOST:$PORT"
+    fi
+    return $RESULT
+}
+
+# process arguments
+while [[ $# -gt 0 ]]
+do
+    case "$1" in
+        *:* )
+        hostport=(${1//:/ })
+        HOST=${hostport[0]}
+        PORT=${hostport[1]}
+        shift 1
+        ;;
+        --child)
+        CHILD=1
+        shift 1
+        ;;
+        -q | --quiet)
+        QUIET=1
+        shift 1
+        ;;
+        -s | --strict)
+        STRICT=1
+        shift 1
+        ;;
+        -h)
+        HOST="$2"
+        if [[ $HOST == "" ]]; then break; fi
+        shift 2
+        ;;
+        --host=*)
+        HOST="${1#*=}"
+        shift 1
+        ;;
+        -p)
+        PORT="$2"
+        if [[ $PORT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --port=*)
+        PORT="${1#*=}"
+        shift 1
+        ;;
+        -t)
+        TIMEOUT="$2"
+        if [[ $TIMEOUT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --timeout=*)
+        TIMEOUT="${1#*=}"
+        shift 1
+        ;;
+        --)
+        shift
+        CLI=("$@")
+        break
+        ;;
+        --help)
+        usage
+        ;;
+        *)
+        echoerr "Unknown argument: $1"
+        usage
+        ;;
+    esac
+done
+
+if [[ "$HOST" == "" || "$PORT" == "" ]]; then
+    echoerr "Error: you need to provide a host and port to test."
+    usage
+fi
+
+TIMEOUT=${TIMEOUT:-15}
+STRICT=${STRICT:-0}
+CHILD=${CHILD:-0}
+QUIET=${QUIET:-0}
+
+# check to see if timeout is from busybox?
+# check to see if timeout is from busybox?
+TIMEOUT_PATH=$(realpath $(which timeout))
+if [[ $TIMEOUT_PATH =~ "busybox" ]]; then
+        ISBUSY=1
+        BUSYTIMEFLAG="-t"
+else
+        ISBUSY=0
+        BUSYTIMEFLAG=""
+fi
+
+if [[ $CHILD -gt 0 ]]; then
+    wait_for
+    RESULT=$?
+    exit $RESULT
+else
+    if [[ $TIMEOUT -gt 0 ]]; then
+        wait_for_wrapper
+        RESULT=$?
+    else
+        wait_for
+        RESULT=$?
+    fi
+fi
+
+if [[ $CLI != "" ]]; then
+    if [[ $RESULT -ne 0 && $STRICT -eq 1 ]]; then
+        echoerr "$cmdname: strict mode, refusing to execute subprocess"
+        exit $RESULT
+    fi
+    exec "${CLI[@]}"
+else
+    exit $RESULT
+fi

data/docker-compose.yml

@@ -0,0 +1,50 @@
+version: '3'
+services:
+  db:
+    image: postgres
+  spec:
+    build: .
+    entrypoint: bin/wait_for_it jsonapi_app_spec:3001 -t 30 --
+    command: bundle exec rspec
+    volumes:
+      - .:/simple_jsonapi_client
+    depends_on:
+      - jsonapi_app_spec
+    environment:
+      API_URL: jsonapi_app_spec
+      API_PORT: 3001
+  jsonapi_app_spec:
+    build: ./spec/jsonapi_app
+    entrypoint: bin/wait_for_it db:5432 -t 30 --
+    volumes:
+      - ./spec/jsonapi_app:/jsonapi_app
+      - /jsonapi_app/tmp/
+    command: bundle exec rails s -p 3001 -b '0.0.0.0'
+    ports:
+      - "3001:3001"
+    environment:
+      API_PORT: 3001
+    depends_on:
+      - db
+  console:
+    build: .
+    entrypoint: bin/wait_for_it jsonapi_app_console:3002 -t 30 --
+    command: bin/development_start
+    volumes:
+      - .:/simple_jsonapi_client
+    depends_on:
+      - jsonapi_app_console
+    environment:
+      API_URL: jsonapi_app_console
+      API_PORT: 3002
+  jsonapi_app_console:
+    build: ./spec/jsonapi_app
+    entrypoint: bin/wait_for_it db:5432 -t 30 --
+    volumes:
+      - ./spec/jsonapi_app:/jsonapi_app
+      - /jsonapi_app/tmp/
+    command: bundle exec rails s -p 3002 -b '0.0.0.0'
+    ports:
+      - "3002:3002"
+    depends_on:
+      - db

data/lib/simple_jsonapi_client.rb

@@ -0,0 +1,5 @@
+require 'simple_jsonapi_client/version'
+
+module SimpleJSONAPIClient
+  require 'simple_jsonapi_client/base'
+end

data/lib/simple_jsonapi_client/base.rb

@@ -0,0 +1,325 @@
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/transform_values'
+require 'simple_jsonapi_client/error'
+require 'simple_jsonapi_client/relationships/relationship'
+require 'simple_jsonapi_client/redirection/fetch_all'
+
+module SimpleJSONAPIClient
+  class Base
+    class << self
+      def relationships
+        @relationships ||= {}
+      end
+
+      def _attributes
+        @_attributes ||= {}
+      end
+
+      def attributes(*attrs)
+        attrs.each do |attr|
+          define_method(attr) { attributes[attr] }
+          define_method("#{attr}=") { |x| attributes[attr] = x }
+          _attributes[attr] = true
+        end
+      end
+
+      def meta(*attrs)
+        attrs.each do |attr|
+          define_method(attr) { meta[attr] }
+          define_method("#{attr}=") { |x| meta[attr] = x }
+        end
+      end
+
+      def has_many(relationship_name, opts)
+        model_class = opts.fetch(:class) { opts.fetch(:class_name) }
+        define_relationship_methods!(relationship_name)
+        relationships[relationship_name.to_sym] =
+          Relationships::HasManyRelationship.new(model_class)
+      end
+
+      def has_one(relationship_name, opts)
+        define_relationship_methods!(relationship_name)
+        model_class = opts.fetch(:class) { opts.fetch(:class_name) }
+        relationships[relationship_name.to_sym] =
+          Relationships::HasOneRelationship.new(model_class)
+      end
+
+      def fetch(opts)
+        operation(:fetch_request, :singular, opts)
+      end
+
+      def fetch_all(opts)
+        Redirection::FetchAll.new(opts) do |request_opts|
+          operation(:fetch_all_request, :plural, request_opts)
+        end
+      end
+
+      def create(opts)
+        operation(:create_request, :singular, opts)
+      end
+
+      def update(opts)
+        operation(:update_request, :singular, opts)
+      end
+
+      def delete(opts)
+        operation(:delete_request, :empty, opts)
+        true
+      end
+
+      def model_from(record, included, connection, context = nil)
+        return unless record
+        new(
+          meta: record['meta'],
+          id: record['id'],
+          attributes: record.fetch('attributes', {}),
+          relationships: record.fetch('relationships', {}),
+          context: context,
+          included: included,
+          connection: connection
+        )
+      end
+
+      def interpreted_included(records, included)
+        {}.tap do |included_hash|
+          include_records(included_hash, records)
+          include_records(included_hash, included)
+        end
+      end
+
+      def include_records(included_hash, records)
+        records.to_a.each do |record|
+          included_hash[{ 'id' => record['id'], 'type' => record['type'] }] = record
+        end
+      end
+
+      def template(id: nil, attributes:, relationships: {})
+        data = {
+          type: self::TYPE,
+          attributes: attributes,
+          relationships: interpreted_relationships(relationships)
+        }
+        data[:id] = id if id
+        { data: data }
+      end
+
+      private
+
+      def define_relationship_methods!(relationship_name)
+        define_method(relationship_name) { relationships[relationship_name] }
+        define_method("#{relationship_name}=") { |x| relationships[relationship_name] = x }
+      end
+
+      def operation(request_method, response_type, opts)
+        response = send(request_method, opts)
+        handling_error(response) do
+          send(:"interpret_#{response_type}_response", response, opts[:connection])
+        end
+      end
+
+      def create_request(connection:,
+                         url_opts: {},
+                         url: self::COLLECTION_URL % url_opts,
+                         attributes: {},
+                         relationships: {},
+                         **attrs)
+        attributes, relationships = extract_attrs(attrs, attributes, relationships)
+        body = template(attributes: attributes, relationships: relationships)
+        connection.post(url, body)
+      end
+
+      def update_request(connection:,
+                         id:,
+                         url_opts: {},
+                         attributes: {},
+                         relationships: {},
+                         **attrs)
+        attributes, relationships = extract_attrs(attrs, attributes, relationships)
+        connection.patch(self::INDIVIDUAL_URL % url_opts) do |request|
+          request.body = template(
+            id: id,
+            attributes: attributes,
+            relationships: relationships
+          )
+        end
+      end
+
+      def delete_request(connection:, url_opts: {})
+        connection.delete(self::INDIVIDUAL_URL % url_opts)
+      end
+
+      def fetch_request(connection:,
+                        url_opts: {},
+                        filter_opts: {},
+                        url: self::INDIVIDUAL_URL % url_opts,
+                        includes: [])
+        params = {}
+        params[:include] = includes.join(',') unless includes.empty?
+        params[:filter] = filter_opts unless filter_opts.empty?
+        connection.get(url, params)
+      end
+
+      def fetch_all_request(connection:,
+                            url_opts: {},
+                            url: self::COLLECTION_URL % url_opts,
+                            filter_opts: {},
+                            includes: [])
+        params = {}
+        params[:include] = includes.join(',') unless includes.empty?
+        params[:filter] = filter_opts unless filter_opts.empty?
+        connection.get(url, params)
+      end
+
+      def extract_attrs(attrs, attributes, relationships)
+        attrs.each do |attr, value|
+          if _attributes.key?(attr)
+            attributes[attr] = value
+          elsif self.relationships.key?(attr)
+            relationships[attr] = value
+          else
+            raise ArgumentError, %{Invalid attribute "#{attr}"}
+          end
+        end
+        [attributes, relationships]
+      end
+
+      def interpret_singular_response(response, connection)
+        body = response.body
+        record = body['data']
+        records = [record].compact
+        included = interpreted_included(records, body['included'])
+        model_from(record, included, connection, response)
+      end
+
+      def interpret_plural_response(response, connection)
+        body = response.body
+        records = body['data']
+        included = interpreted_included(records, body['included'])
+        {
+          'links' => body['links'],
+          'data' => records.map { |record|
+            model_from(record, included, connection, response)
+          }
+        }
+      end
+
+      def interpret_empty_response(response, connection)
+      end
+
+      def interpreted_relationships(relationships)
+        relationships.transform_values { |value|
+          if (relationship = relationship_from(value))
+            { data: relationship }
+          end
+        }
+      end
+
+      def relationship_from(value)
+        if value.respond_to?(:to_relationship)
+          value.to_relationship
+        elsif value.respond_to?(:map)
+          value.map(&:to_relationship)
+        elsif !value.nil?
+          raise ArgumentError, "#{value} cannot be converted to relationship!"
+        end
+      end
+
+      def handling_error(response)
+        if response.success?
+          yield
+        else
+          raise ::SimpleJSONAPIClient::Errors::APIError.generate(response)
+        end
+      end
+    end
+
+    attr_reader :id, :context
+
+    def initialize(meta: nil, id:, attributes: nil, relationships: nil, included: {}, connection:, context: nil)
+      @meta = meta.symbolize_keys if meta
+      @id = id
+      @included = included
+      @connection = connection
+      @context = context
+      @attributes = attributes.symbolize_keys if attributes
+      @input_relationships = relationships
+    end
+
+    def to_relationship
+      { type: self.class::TYPE, id: id }
+    end
+
+    def same_record_as?(other)
+      to_relationship == other.to_relationship
+    end
+
+    def attributes
+      @attributes ||= loaded_record.attributes
+    end
+
+    def meta
+      @meta ||= loaded_record.meta
+    end
+
+    def relationships
+      @relationships ||=
+        begin
+          if input_relationships
+            relationships_to_models(input_relationships.symbolize_keys)
+          else
+            loaded_record.relationships
+          end
+        end
+    end
+
+    def update(**attrs)
+       self.class.update(
+         connection: connection,
+         id: id,
+         url_opts: { id: id },
+         **attrs
+       )
+    end
+
+    def delete
+      self.class.delete(
+        connection: connection,
+        url_opts: { id: id }
+      )
+    end
+
+    def as_json
+      self.class.template(
+        id: id,
+        attributes: attributes,
+        relationships: relationships
+      )
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+
+    def inspect
+      parsed_attributes = attributes.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
+      parsed_attributes = " #{parsed_attributes}" unless parsed_attributes.empty?
+      parsed_relationships = relationships.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
+      parsed_relationships = " #{parsed_relationships}" unless parsed_relationships.empty?
+      "#<#{self.class.name} id=#{id}#{parsed_attributes}#{parsed_relationships}>"
+    end
+
+    private
+    attr_reader :input_relationships, :included, :connection
+
+    def relationships_to_models(relationships)
+      relationships.each_with_object({}) do |(relationship, info), memo|
+        next unless implementation = self.class.relationships[relationship]
+        memo[relationship] = implementation.call(info, included, connection)
+      end
+    end
+
+    def loaded_record
+      @loaded_record ||= self.class.fetch(connection: connection, url_opts: { id: id })
+    end
+  end
+end