json_api_server 0.0.1

data/lib/json_api_server/sort_configs.rb

@@ -0,0 +1,63 @@
+module JsonApiServer # :nodoc:
+  # Configs that can be specified in a controller to enable sorting on attributes.
+  # Specify permitted attributes for sorting. If an alias is used instead of an
+  # attribute name, it can be mapped (see :created in example below).
+  #
+  # Example sort configuration:
+  #
+  # before_action do |c|
+  #   c.sort_options = {
+  #     permitted: [
+  #       :id,
+  #       :body,
+  #       { created: { col_name: :created_at} }
+  #     ],
+  #     default: { id: :desc }
+  #   }
+  # end
+  #
+  # Config requirements - :permitted, :col_name and :default must be symbols.
+  class SortConfigs
+    # Config - permitted
+    def initialize(configs)
+      @configs = configs
+    end
+
+    # Attributes API users can sort against. Arrray of hashes -
+    # [{attr: <required - attr as string>, col_name: <optional key - database column name as string> }, ...]
+    def permitted
+      @permitted ||= begin
+        return [] unless @configs[:permitted].is_a?(Array)
+        @configs[:permitted].map { |c| configs_from(c) }
+      end
+    end
+
+    # Returns the config spec for an attributes. Returns nil if attribute
+    # isn't permitted.
+    def config_for(attr)
+      permitted.find { |elem| elem[:attr] == attr.to_s }
+    end
+
+    def permitted?(attr)
+      config_for(attr.to_s) != nil
+    end
+
+    # Default order specified in 'options' accessor. Specify ActiveRecord order params,
+    # i.e., { id: :desc }
+    # Defaults to empty array if none specified.
+    def default_order
+      @default = @configs[:default] || []
+    end
+
+    protected
+
+    def configs_from(config)
+      if config.respond_to?(:keys)
+        key, value = config.first
+        { attr: key.to_s, col_name: (value[:col_name] || key).to_s }
+      else
+        { attr: config.to_s }
+      end
+    end
+  end
+end

data/lib/json_api_server/validation_errors.rb

@@ -0,0 +1,51 @@
+module JsonApiServer # :nodoc:
+  # Converts ActiveModel validations to JSON API Errors.
+  # Spec:  http://jsonapi.org/format/#error-objects.
+  #
+  # Calling <tt>render_422(model_instance)</tt> in a controller will create an instance of
+  # this class and render with appropriate headers.
+  #
+  # i.e,
+  #
+  #   def create
+  #     topic = Topic.new(topic_params)
+  #
+  #     if topic.save
+  #      serializer = TopicSerializer.new(topic)
+  #      render json: serializer.to_json, status: :created
+  #    else
+  #      render_422(topic)
+  #    end
+  #   end
+  class ValidationErrors
+    include JsonApiServer::Serializer
+    include JsonApiServer::ApiVersion
+
+    def initialize(model)
+      errors = get_errors(model)
+      @errors = JsonApiServer::Errors.new(errors)
+    end
+
+    def as_json
+      @errors.as_json
+    end
+
+    protected
+
+    # Grabs the first error per attribute.
+    # Spec -> status: the HTTP status code applicable to this problem, expressed as a string value.
+    # http://jsonapi.org/format/#error-objects
+    def get_errors(model)
+      if model.respond_to?(:errors) && model.errors.respond_to?(:full_messages_for)
+        model.errors.keys.map do |field|
+          {
+            'status' => '422',
+            'source' => { 'pointer' => "/data/attributes/#{field}" },
+            'title' => 'Invalid Attribute',
+            'detail' => model.errors.full_messages_for(field).first
+          }
+        end
+      end
+    end
+  end
+end

data/lib/json_api_server/version.rb

@@ -0,0 +1,3 @@
+module JsonApiServer # :nodoc:
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: json_api_server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ed.mare
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.47'
+description: For building JSON APIs.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- docker-compose.yml
+- json_api_server.gemspec
+- lib/json_api_server.rb
+- lib/json_api_server/api_version.rb
+- lib/json_api_server/attributes_builder.rb
+- lib/json_api_server/base_serializer.rb
+- lib/json_api_server/builder.rb
+- lib/json_api_server/cast.rb
+- lib/json_api_server/configuration.rb
+- lib/json_api_server/controller/error_handling.rb
+- lib/json_api_server/engine.rb
+- lib/json_api_server/error.rb
+- lib/json_api_server/errors.rb
+- lib/json_api_server/exceptions.rb
+- lib/json_api_server/fields.rb
+- lib/json_api_server/filter.rb
+- lib/json_api_server/filter_builders.rb
+- lib/json_api_server/filter_config.rb
+- lib/json_api_server/filter_parser.rb
+- lib/json_api_server/include.rb
+- lib/json_api_server/meta_builder.rb
+- lib/json_api_server/mime_types.rb
+- lib/json_api_server/pagination.rb
+- lib/json_api_server/paginator.rb
+- lib/json_api_server/relationships_builder.rb
+- lib/json_api_server/resource_serializer.rb
+- lib/json_api_server/resources_serializer.rb
+- lib/json_api_server/serializer.rb
+- lib/json_api_server/sort.rb
+- lib/json_api_server/sort_configs.rb
+- lib/json_api_server/validation_errors.rb
+- lib/json_api_server/version.rb
+homepage: https://github.com/ed-mare/json_api_server
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+- "--exclude"
+- spec
+- "--exclude"
+- bin
+- "--exclude"
+- Dockerfile
+- "--exclude"
+- Gemfile
+- "--exclude"
+- Gemfile.lock
+- "--exclude"
+- Rakefile
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Implements JSON API 1.0 - data, errors, meta, pagination, sort, filters,
+  sparse fieldsets and inclusion of related resources.
+test_files: []