caprese 0.2.0

data/lib/caprese/serializer/concerns/links.rb

@@ -0,0 +1,96 @@
+require 'active_support/concern'
+
+module Caprese
+  class Serializer < ActiveModel::Serializer
+    module Links
+      extend ActiveSupport::Concern
+
+      included do
+        # Add a links[:self] to this resource
+        #
+        # @example
+        #   object = Order<@token='asd27h'>
+        #   links = { self: '/api/v1/orders/asd27hß' }
+        link :self do
+          if respond_to?(url = serializer.version_name("#{object.class.name.underscore}_url"))
+            send(url, object.read_attribute(Caprese.config.resource_primary_key))
+          end
+        end
+      end
+
+      module ClassMethods
+        # Overridden so we can define relationship links without any code in a specific
+        # serializer
+        def has_many(name, options = {}, &block)
+          super name, options, &build_association_block(name)
+        end
+
+        # @see has_many
+        def has_one(name, options = {}, &block)
+          super name, options, &build_association_block(name)
+        end
+
+        # @see has_many
+        def belongs_to(name, options = {}, &block)
+          super name, options, &build_association_block(name)
+        end
+
+        private
+
+        # Builds a block that is passed into an association when it is defined in a specific serializer
+        # The block is run, and links are added to each association so when it is rendered in the
+        # `relationships` object of the `data` for record, it contains links to the particular association
+        #
+        # @example
+        #   object = Order<@token=5, @product_id=10>
+        #   reflection_name = 'product'
+        #   # => {
+        #     id: 'asd27h',
+        #     type: 'orders',
+        #     relationships: {
+        #       product: {
+        #         id: 'hy7sql',
+        #         type: 'products',
+        #         links: {
+        #           self: '/api/v1/orders/asd27h/relationships/product',
+        #           related: '/api/v1/orders/asd27h/product'
+        #         }
+        #       }
+        #     }
+        #   }
+        #
+        # @param [String] reflection_name the name of the relationship
+        # @return [Block] a block to build links for the relationship
+        def build_association_block(reflection_name)
+          primary_key = Caprese.config.resource_primary_key
+
+          Proc.new do |serializer|
+            link :self do
+              url = "relationship_definition_#{serializer.version_name("#{object.class.name.underscore}_url")}"
+              if respond_to? url
+                send(
+                  url,
+                  primary_key => object.read_attribute(primary_key),
+                  relationship: reflection_name
+                )
+              end
+            end
+
+            link :related do
+              url = "relationship_data_#{serializer.version_name("#{object.class.name.underscore}_url")}"
+              if respond_to? url
+                send(
+                  url,
+                  primary_key => object.read_attribute(primary_key),
+                  relationship: reflection_name
+                )
+              end
+            end
+
+            :nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caprese/serializer/concerns/lookup.rb

@@ -0,0 +1,37 @@
+require 'active_support/concern'
+
+module Caprese
+  class Serializer < ActiveModel::Serializer
+    module Lookup
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Gets a versioned serializer for a given record
+        #
+        # @note Overrides the default since the default does not do namespaced lookup
+        #
+        # @param [ActiveRecord::Base] record the record to get a serializer for
+        # @param [Hash] options options for `super` to use when getting the serializer
+        # @return [Serializer,Nil] the serializer for the given record
+        def serializer_for(record, options = {})
+          get_serializer_for(record.class) || super
+        end
+
+        private
+
+        # Gets a serializer for a klass, either as the serializer explicitly defined
+        # for this class, or as a serializer defined for one of the klass's parents
+        #
+        # @param [Class] klass the klass to get the serializer for
+        # @return [Serializer] the serializer for the class
+        def get_serializer_for(klass)
+          begin
+            version_module("#{klass.name}Serializer").constantize
+          rescue NameError => e
+            get_serializer_for(klass.superclass) if klass.superclass
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caprese/serializer/error_serializer.rb

@@ -0,0 +1,13 @@
+require 'caprese/serializer'
+
+module Caprese
+  class Serializer
+    class ErrorSerializer < ActiveModel::Serializer::ErrorSerializer
+      delegate :as_json, to: :object
+
+      def resource_errors?
+        object.try(:record).present?
+      end
+    end
+  end
+end

data/lib/caprese/serializer.rb

@@ -0,0 +1,13 @@
+require 'active_model_serializers'
+require 'caprese/concerns/versioning'
+require 'caprese/serializer/concerns/links'
+require 'caprese/serializer/concerns/lookup'
+
+module Caprese
+  class Serializer < ActiveModel::Serializer
+    extend Versioning
+    include Versioning
+    include Links
+    include Lookup
+  end
+end

data/lib/caprese/version.rb

@@ -0,0 +1,3 @@
+module Caprese
+  VERSION = '0.2.0'
+end

data/lib/caprese.rb

@@ -0,0 +1,35 @@
+require 'caprese/controller'
+require 'caprese/record'
+require 'caprese/routing/caprese_resources'
+require 'caprese/serializer'
+require 'caprese/version'
+
+module Caprese
+  def self.config
+    Controller.config
+  end
+
+  # Defines the primary key to use when querying records
+  config.resource_primary_key ||= :id
+
+  # Defines the ActiveModelSerializers adapter to use when serializing
+  config.adapter ||= :json_api
+
+  # Define URL options for use in UrlHelpers
+  config.default_url_options ||= {}
+
+  # If true, relationship data will not be serialized unless it is in `include`
+  config.optimize_relationships ||= true
+
+  # If true, links will be rendered as `only_path: true`
+  config.only_path_links ||= true
+
+  # Defines the translation scope for model and controller errors
+  config.i18n_scope ||= '' # 'api.v1.errors'
+
+  # The default size of any page queried
+  config.default_page_size ||= 10
+
+  # The maximum size of any page queried
+  config.max_page_size ||= 100
+end

metadata

@@ -0,0 +1,273 @@
+--- !ruby/object:Gem::Specification
+name: caprese
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nick Landgrebe
+- Pelle ten Cate
+- Kieran Klaassen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: factory_girl
+  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: coveralls
+  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: database_cleaner
+  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: pry-byebug
+  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: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-rails
+  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: 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'
+description: 
+email:
+- nick@landgre.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- caprese.gemspec
+- lib/caprese.rb
+- lib/caprese/adapter/json_api.rb
+- lib/caprese/adapter/json_api/error.rb
+- lib/caprese/adapter/json_api/json_pointer.rb
+- lib/caprese/adapter/json_api/jsonapi.rb
+- lib/caprese/adapter/json_api/link.rb
+- lib/caprese/adapter/json_api/meta.rb
+- lib/caprese/adapter/json_api/pagination_links.rb
+- lib/caprese/adapter/json_api/relationship.rb
+- lib/caprese/adapter/json_api/resource_identifier.rb
+- lib/caprese/concerns/versioning.rb
+- lib/caprese/controller.rb
+- lib/caprese/controller/concerns/callbacks.rb
+- lib/caprese/controller/concerns/errors.rb
+- lib/caprese/controller/concerns/persistence.rb
+- lib/caprese/controller/concerns/query.rb
+- lib/caprese/controller/concerns/relationships.rb
+- lib/caprese/controller/concerns/rendering.rb
+- lib/caprese/controller/concerns/typing.rb
+- lib/caprese/error.rb
+- lib/caprese/errors.rb
+- lib/caprese/record.rb
+- lib/caprese/record/errors.rb
+- lib/caprese/routing/caprese_resources.rb
+- lib/caprese/serializer.rb
+- lib/caprese/serializer/concerns/links.rb
+- lib/caprese/serializer/concerns/lookup.rb
+- lib/caprese/serializer/error_serializer.rb
+- lib/caprese/version.rb
+homepage: https://github.com/nicklandgrebe/caprese
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Opinionated Rails library for writing RESTful APIs
+test_files: []