jsonapionify 0.0.1.pre → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9e665303dde3d55816598fa79a9e6df58fc8281
-  data.tar.gz: fd43d532d153eb7c3cc7061eaed2259c23887d97
+  metadata.gz: 515e9924931d33894090d68b518e2fe0e1509ab4
+  data.tar.gz: eb62428441716cfc4012d90f3b3af2bb6013e158
 SHA512:
-  metadata.gz: 1b5a3455e4617b3600f888a70f775d04cc100773714021c69f3ef3a6ae9b7e91278ff4df78f6d4ba84f864daa199cfdec39c1e3389a3b8d10d3ebe74633fb2c0
-  data.tar.gz: 2fc676ba38dc4c5cd89b3efbdb5ec114565439b2e50b063fa2c106d6c998d6067d4cdc9581551344a23b79af397f433113280c2dc378fc8f7f1028eb14d1a194
+  metadata.gz: eea64da6a6862c3a985fd63c8a2458fdf7c162777ca0f5116e8d20f81982fe1aafbc3023c02c4cac89b1003fe85e70e219476f53c2ebe999c8fe096c7c1ed59a
+  data.tar.gz: c84cd475c778481ad492c7ed220b3195315e23ff8f7a1223721ce74004792273f06340b1f3738132bfc3dcd69ad715784cdd4141f43a3d65f2f68fef87eb9a8a

data/.editorconfig

@@ -0,0 +1,35 @@
+root = true
+
+[*]
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+# Ruby Files
+[{*.rb, Gemfile*, config.ru, Rakefile, *.rake}]
+indent_style = space
+indent_size = 2
+
+# SQL
+[*.sql]
+indent_style = space
+indent_size = 4
+
+# Makefiles
+[{Makefile, *.mk}]
+indent_style = tab
+indent_size = 1
+
+# ERB
+[*.erb]
+indent_style = space
+indent_size = 2
+
+# Yaml
+[*.yml]
+indent_style = space
+indent_size = 2
+
+# Markdown uses trailing whitespace for linebreaks.
+[{*.markdown, *.md}]
+trim_trailing_whitespace = false

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.3.0

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 sudo: false
-rvm:
-  - 2.2.3
 before_install: gem install bundler -v 1.10.6
 script: bundle exec rspec
 cache: bundler

data/Guardfile

@@ -1,6 +1,6 @@
 guard :rspec, cmd: "bundle exec rspec" do
   require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
+  dsl   = Guard::RSpec::Dsl.new(self)
 
   # RSpec files
   rspec = dsl.rspec

data/README.md

@@ -1,10 +1,19 @@
 # JSONAPIonify
-[![Version](http://allthebadges.io/brandfolder/jsonapionify/badge_fury.png)](http://allthebadges.io/brandfolder/jsonapionify/badge_fury)
+[![Gem Version](https://badge.fury.io/rb/jsonapionify.svg)](https://badge.fury.io/rb/jsonapionify)
 [![Build Status](https://travis-ci.org/brandfolder/jsonapionify.svg?branch=master)](https://travis-ci.org/brandfolder/jsonapionify)
 [![Code Climate](https://codeclimate.com/repos/5672446f137f95309c0067c6/badges/a369f0a182ce111c8fcd/gpa.svg)](https://codeclimate.com/repos/5672446f137f95309c0067c6/feed)
 [![Test Coverage](https://codeclimate.com/repos/5672446f137f95309c0067c6/badges/a369f0a182ce111c8fcd/coverage.svg)](https://codeclimate.com/repos/5672446f137f95309c0067c6/coverage)
 
-TODO: Write Description
+JSONAPIonify is a framework for building JSONApi 1.0 compliant
+APIs. It can run as a standalone rack app or as part of a larger framework such
+as rails. In addition, it auto-generates beautiful documentation.
+
+Live Example:
+
+* [Resource](https://api.brandfolder.com/v2/slug/brandfolder)
+* [Documentation](https://api.brandfolder.com/v2/docs) (screenshot below)
+
+  [![Documentation Example](https://api.url2png.com/v6/P3CAE278FC306AA/50ef2ba09c77f6fb25dd7f179de2a704/png/?thumbnail_max_width=500&url=https%3A%2F%2Fapi.brandfolder.com%2Fv2%2Fdocs)](https://api.brandfolder.com/v2/docs)
 
 ## Installation
 
@@ -18,13 +27,10 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install jsonapionify
-
 ## Usage
 
-TODO: Write usage instructions here
+Refer to the [wiki](https://github.com/brandfolder/jsonapionify/wiki) for detailed
+information on how to use the framework.
 
 ## Development
 
@@ -40,4 +46,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/brandf
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -17,6 +17,16 @@ task :missing_specs do
   end
 end
 
+desc 'Remove empty specs'
+task :prune_specs do
+  empty_specs = Dir.glob("./spec/**/*_spec.rb").select do |f|
+    File.read(f).empty?
+  end
+  empty_specs.each do |f|
+    FileUtils.rm f
+  end
+end
+
 STATS_DIRECTORIES = [
   %w(Structure        lib/jsonapionify/structure),
   %w(Server           lib/jsonapionify/api),

data/config.ru

@@ -4,12 +4,12 @@ require 'jsonapionify'
 require 'navigable_hash'
 require 'json'
 
-api = NavigableHash.new JSON.load File.read 'fixtures/documentation.json'
-docs = JSONAPIonify::Documentation.new(api)
+api    = NavigableHash.new JSON.load File.read 'fixtures/documentation.json'
+docs   = JSONAPIonify::Documentation.new(api)
 result = docs.result
 
 run ->(_) {
   response = Rack::Response.new
   response.write result
   response.finish
-}
+}

data/index.html

@@ -0,0 +1 @@
+My Page

data/jsonapionify.gemspec

@@ -4,21 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jsonapionify/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jsonapionify"
-  spec.version       = JSONAPIonify::VERSION
-  spec.authors       = ["Jason Waldrip"]
-  spec.email         = ["jason@waldrip.net"]
+  spec.name    = "jsonapionify"
+  spec.version = JSONAPIonify::VERSION
+  spec.authors = ["Jason Waldrip"]
+  spec.email   = ["jason@waldrip.net"]
 
-  spec.summary       = %q{Ruby object structure conforming to the JSON API spec.}
-  spec.homepage      = "https://github.com/brandfolder/jsonapionify"
-  spec.license       = "MIT"
+  spec.summary  = %q{Ruby object structure conforming to the JSON API spec.}
+  spec.homepage = "https://github.com/brandfolder/jsonapionify"
+  spec.license  = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(vendor|spec)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.2'
+  version_file               = File.expand_path '../.ruby-version', __FILE__
+  spec.required_ruby_version = "~> #{File.read(version_file).strip.sub(/\-p[0-9]+$/, '')}"
 
   spec.add_dependency "activesupport", "~> 4.2"
   spec.add_dependency "faraday", "~> 0.9"
@@ -27,6 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "oj"
   spec.add_dependency "rack-test"
   spec.add_dependency 'faker'
+  spec.add_dependency 'possessive'
+  spec.add_dependency 'unstrict_proc'
+  spec.add_dependency 'enumerable_observer'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rocco'
@@ -47,4 +51,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'ruby-prof'
   spec.add_development_dependency 'bcrypt'
   spec.add_development_dependency 'thin'
+  spec.add_development_dependency 'memory_model'
 end

data/lib/jsonapionify/api/action.rb

@@ -3,10 +3,16 @@ module JSONAPIonify::Api
     attr_reader :name, :request_block, :content_type, :responses, :prepend,
                 :path, :request_method, :only_associated
 
-    def self.stub(&block)
+    def self.dummy(&block)
       new(nil, nil, &block)
     end
 
+    def self.error(name, &block)
+      dummy do
+        error_now name, &block
+      end
+    end
+
     def initialize(name, request_method, path = nil, require_body = nil, example_type = :resource, content_type: nil, prepend: nil, only_associated: false, &block)
       @request_method  = request_method
       @require_body    = require_body.nil? ? %w{POST PUT PATCH}.include?(@request_method) : require_body
@@ -54,17 +60,16 @@ module JSONAPIonify::Api
       request.path_info.match(path_regex(base, name, include_path))
     end
 
-    def documentation_object(resource, base, name, include_path)
-      @documentation_object ||= begin
-        url = build_path(base, name, include_path)
-        OpenStruct.new(
-          name:            self.name.to_s,
-          sample_requests: example_requests(resource, url)
-        )
-      end
+    def documentation_object(base, resource, name, include_path, label)
+      url  = build_path(base, name.to_s, include_path)
+      path = URI.parse(url).path
+      OpenStruct.new(
+        id:              [request_method, path].join('-').parameterize,
+        label:           label,
+        sample_requests: example_requests(resource, url)
+      )
     end
 
-
     def example_requests(resource, url)
       responses.map do |response|
         opts                      = {}
@@ -76,7 +81,7 @@ module JSONAPIonify::Api
                                       { 'data' => resource.build_resource(request, resource.example_instance, relationships: false, links: false).as_json }.to_json
                                     when :resource_identifier
                                       { 'data' => resource.build_resource_identifier(resource.example_instance).as_json }.to_json
-                                    end if @content_type == 'application/vnd.api+json'
+                                    end if @content_type == 'application/vnd.api+json' && !%w{GET DELETE}.include?(request_method)
         request                   = Server::Request.env_for(url, request_method, opts)
         response                  = Server::MockResponse.new(*sample_request(resource, request))
 
@@ -88,8 +93,7 @@ module JSONAPIonify::Api
     end
 
     def supports_content_type?(request)
-      @content_type == request.content_type ||
-        (request.content_type.nil? && !request.has_body?)
+      @content_type == request.content_type || !request.has_body?
     end
 
     def supports_request_method?(request)
@@ -137,57 +141,63 @@ module JSONAPIonify::Api
     end
 
     def call(resource, request)
-      action              = dup
-      cache_hit_exception = Class.new StandardError
-      cache_options       = {}
+      action        = dup
+      cache_options = {}
       resource.new.instance_eval do
         # Bootstrap the Action
-        callbacks = resource.callbacks_for(action.name).new
-        context   = ContextDelegate.new(request, self, self.class.context_definitions)
-
-        define_singleton_method :action_name do
-          action.name
-        end
+        context = ContextDelegate.new(request, self, self.class.context_definitions)
 
+        # Define Singletons
         define_singleton_method :cache do |key, **options|
+          raise Errors::DoubleCacheError, "Cache was already called for this action" if @called
+          @called = true
           cache_options.merge! options
-          cache_options[:key] = [*{
-            api:          [self.class.api.name, self.class.api.resource_signature].join('@'),
-            resource:     self.class.type,
-            content_type: request.content_type || '*',
-            accept:       request.accept.join(','),
-            params:       context.params.to_param
-          }.map { |kv| kv.join(':') }, key].join('|')
-          raise cache_hit_exception, cache_options[:key] if self.class.cache_store.exist?(cache_options[:key])
-        end if request.get?
 
-        # Define Shared Singletons
-        [self, callbacks].each do |target|
-          target.define_singleton_method :errors do
-            context.errors
+          # Build the cache key, and obscure it.
+          context.meta[:cache_key] =
+            cache_options[:key] =
+              Base64.urlsafe_encode64(
+                {
+                  dsl:    JSONAPIonify.digest,
+                  api:    self.class.api.signature,
+                  path:   request.path,
+                  accept: request.accept,
+                  params: context.params,
+                  key:    key,
+                }.to_json
+              )
+          # If the cache exists, then fail to cache miss
+          if self.class.cache_store.exist?(cache_options[:key])
+            raise Errors::CacheHit, cache_options[:key]
           end
+        end if request.get?
 
-          define_singleton_method :response_headers do
-            context.response_headers
-          end
+        define_singleton_method :action_name do
+          action.name
+        end
 
-          target.define_singleton_method :error_exception do
-            context.error_exception
-          end
+        define_singleton_method :errors do
+          context.errors
+        end
+
+        define_singleton_method :response_headers do
+          context.response_headers
         end
 
         begin
           # Run Callbacks
-          case callbacks.run_callbacks(:request, context) { errors.present? }
-          when true # Boolean true means errors
-            raise error_exception
-          when nil # nil means no result, callback failed
-            error_now :internal_server_error
+          [:request, action.name].each do |callback|
+            case run_callbacks(callback, context) { errors.present? }
+            when true # Boolean true means errors
+              raise Errors::RequestError
+            when nil # nil means no result, callback failed
+              error_now :internal_server_error
+            end if action.name
           end
 
           # Start the request
           instance_exec(context, &action.request_block)
-          fail error_exception if errors.present?
+          fail Errors::RequestError if errors.present?
           response_definition =
             action.responses.find { |response| response.accept? request } ||
               error_now(:not_acceptable)
@@ -196,11 +206,11 @@ module JSONAPIonify::Api
               cache_options[:key],
               [status, headers, body.body],
               **cache_options.except(:key)
-            ) if request.get?
+            ) if request.get? && cache_options.present?
           end
-        rescue error_exception
+        rescue Errors::RequestError
           error_response
-        rescue cache_hit_exception
+        rescue Errors::CacheHit
           self.class.cache_store.read cache_options[:key]
         rescue Exception => exception
           rescued_response exception

data/lib/jsonapionify/api/attribute.rb

@@ -1,8 +1,12 @@
+require 'unstrict_proc'
+
 module JSONAPIonify::Api
   class Attribute
+    using UnstrictProc
     attr_reader :name, :type, :description, :read, :write, :required
 
     def initialize(name, type, description, read: true, write: true, required: false, example: nil)
+      raise ArgumentError, 'required attributes must be writable' if required && !write
       unless type.is_a? JSONAPIonify::Types::BaseType
         raise TypeError, "#{type} is not a valid JSON type"
       end
@@ -20,6 +24,13 @@ module JSONAPIonify::Api
         self.name == other.name
     end
 
+    def options_json
+      {
+        name:     name,
+        required: required
+      }
+    end
+
     def required?
       !!@required
     end
@@ -36,10 +47,10 @@ module JSONAPIonify::Api
       !!@write
     end
 
-    def example
+    def example(*args)
       case @example
       when Proc
-        type.dump @example.call
+        type.dump @example.unstrict.call(*args)
       when nil
         type.dump type.sample(name)
       else

data/lib/jsonapionify/api/base/app_builder.rb

@@ -1,6 +1,17 @@
 module JSONAPIonify::Api
   module Base::AppBuilder
 
+    def self.extended(klass)
+      klass.class_eval do
+        extend JSONAPIonify::InheritedAttributes
+        inherited_array_attribute :middleware
+      end
+    end
+
+    def use(*args, &block)
+      middleware << [args, block]
+    end
+
     def call(env)
       app.call(env)
     end
@@ -15,16 +26,20 @@ module JSONAPIonify::Api
         use Base::Reloader unless ENV['RACK_ENV'] == 'production'
         map "/docs" do
           run ->(env) {
-            request    = JSONAPIonify::Api::Server::Request.new env
+            request = JSONAPIonify::Api::Server::Request.new env
             if request.path_info.present?
               return [301, { 'location' => request.path.chomp(request.path_info) }, []]
             end
-            response   = Rack::Response.new
+            response = Rack::Response.new
             response.write api.documentation_output(request)
             response.finish
           }
         end
         map "/" do
+          use Rack::MethodOverride
+          api.middleware.each do |args, block|
+            use *args, &block
+          end
           run JSONAPIonify::Api::Server.new(api)
         end
       end

data/lib/jsonapionify/api/base/class_methods.rb

@@ -4,45 +4,57 @@ module JSONAPIonify::Api
   module Base::ClassMethods
 
     def self.extended(klass)
-      klass.class_attribute :load_path
+      klass.class_attribute :load_path, :load_file
     end
 
     def resource_files
-      Dir.glob File.join(load_path, '**/*.rb')
+      files = Dir.glob(File.join(load_path, '**/*.rb'))
+      files.concat(superclass < JSONAPIonify::Api::Base ? superclass.resource_files : []).sort
     end
 
     def resource_signature
-      Digest::SHA2.hexdigest resource_files.map { |file| File.read file }.join
+      Digest::SHA2.hexdigest [*resource_files, load_file].map { |file| File.read file }.join
+    end
+
+    def signature
+      [name, resource_signature].join('@')
     end
 
     def load_resources
-      return unless load_path
-      if @last_signature != resource_signature
-        @documentation_output = nil
-        @last_signature       = resource_signature
-        $".delete_if { |s| s.start_with? load_path }
-        resource_files.each do |file|
-          require file
-        end
+      return unless load_path || resources_loaded?
+      @documentation_output = nil
+      @last_signature       = resource_signature
+      $".delete_if { |s| s.start_with? load_path }
+      resource_files.each do |file|
+        require file
       end
     end
 
-    def resource_class
-      const_get(:ResourceBase, false)
+    def resources_loaded?
+      @last_signature == resource_signature
+    end
+
+    def http_error(action, request)
+      Action.error(action).call(resource_class, request)
     end
 
-    def documentation_order(resources_in_order)
-      @documentation_order = resources_in_order
+    def root_url(request)
+      URI.parse(request.root_url).tap do |uri|
+        sticky_params = sticky_params(request.params)
+        uri.query     = sticky_params.to_param if sticky_params.present?
+      end.to_s
     end
 
     def process_index(request)
       headers                    = ContextDelegate.new(request, resource_class.new, resource_class.context_definitions).response_headers
       obj                        = JSONAPIonify.new_object
       obj[:meta]                 = { resources: {} }
-      obj[:links]                = { self: request.root_url }
+      obj[:links]                = { self: request.url }
       obj[:meta][:documentation] = File.join(request.root_url, 'docs')
       obj[:meta][:resources]     = resources.each_with_object({}) do |resource, hash|
-        hash[resource.type] = resource.get_url(request.root_url)
+        if resource.actions.any? { |action| action.name == :list }
+          hash[resource.type] = resource.get_url(root_url(request))
+        end
       end
       Rack::Response.new.tap do |response|
         response.status = 200
@@ -66,6 +78,10 @@ module JSONAPIonify::Api
       @cache_store = store
     end
 
+    def eager_load
+      resources.each(&:eager_load)
+    end
+
     def cache_store
       @cache_store ||= JSONAPIonify.cache_store
     end

data/lib/jsonapionify/api/base/delegation.rb

@@ -5,7 +5,10 @@ module JSONAPIonify::Api
       klass.class_eval do
         class << self
           delegate :context, :response_header, :helper, :rescue_from, :error,
-                   :pagination, :before, :param, :request_header, :sorting,
+                   :enable_pagination, :before, :param, :request_header,
+                   :define_pagination_strategy, :define_sorting_strategy,
+                   :sticky_params, :authentication, :on_exception,
+                   :example_id_generator,
                    to: :resource_class
         end
       end

data/lib/jsonapionify/api/base/doc_helper.rb

@@ -1,5 +1,6 @@
 module JSONAPIonify::Api
   module Base::DocHelper
+    Link = Struct.new(:title, :href)
 
     def self.extended(klass)
       klass.class_eval do
@@ -8,8 +9,12 @@ module JSONAPIonify::Api
       end
     end
 
-    def link(href)
-      links << href
+    def documentation_order(resources_in_order)
+      @documentation_order = resources_in_order
+    end
+
+    def link(title, href)
+      links << Link.new(title, href)
     end
 
     def title(title)
@@ -21,12 +26,16 @@ module JSONAPIonify::Api
     end
 
     def documentation_output(request)
-      @documentation_output ||= JSONAPIonify::Documentation.new(documentation_object(request)).result
+      #cache_store.fetch(resource_signature) do
+      JSONAPIonify::Documentation.new(documentation_object(request)).result
+      #end
     end
 
     def resources_in_order
       indexes = @documentation_order || []
-      resources.sort_by { |resource| indexes.index(resource.name) || indexes.length }
+      resources.sort_by(&:name).sort_by do |resource|
+        indexes.map(&:to_s).index(resource.type) || indexes.length
+      end
     end
 
     def documentation_object(request)

data/lib/jsonapionify/api/base/resource_definitions.rb

@@ -11,12 +11,16 @@ module JSONAPIonify::Api
     def resource(type)
       raise ArgumentError, 'type required' if type.nil?
       type       = type.to_sym
-      const_name = type.to_s.camelcase
+      const_name = type.to_s.camelcase + 'Resource'
       return const_get(const_name, false) if const_defined?(const_name, false)
       raise Errors::ResourceNotFound, "Resource not defined: #{type}" unless resource_defined?(type)
       klass = Class.new(resource_class, &resource_definitions[type]).set_type(type)
       param(:fields, type)
       const_set const_name, klass
+    rescue Errors::ResourceNotFound => e
+      raise e if resources_loaded?
+      load_resources
+      retry
     end
 
     def resource_defined?(name)
@@ -30,10 +34,17 @@ module JSONAPIonify::Api
     end
 
     def define_resource(name, &block)
-      const_name = name.to_s.camelcase
+      const_name = name.to_s.camelcase + 'Resource'
       remove_const(const_name) if const_defined? const_name
       resource_definitions[name.to_sym] = block
     end
 
+    def extend_resource(name, &block)
+      old                               = resource_definitions[name.to_sym]
+      resource_definitions[name.to_sym] = proc do
+        [old, block].each { |b| class_eval(&b) }
+      end
+    end
+
   end
 end

data/lib/jsonapionify/api/base.rb

@@ -13,12 +13,28 @@ module JSONAPIonify::Api
 
     def self.inherited(subclass)
       super(subclass)
-      file           = caller.reject { |f| f.start_with? JSONAPIonify.path }[0].split(/\:\d/)[0]
-      dir            = File.expand_path File.dirname(file)
-      basename       = File.basename(file, File.extname(file))
-      self.load_path = File.join(dir, basename)
-      subclass.const_set(:ResourceBase, Class.new(Resource).set_api(subclass))
-      load_resources
+      subclass.instance_exec(self) do |superclass|
+        const_set(:ResourceBase, Class.new(superclass.resource_class))
+        resource_class.set_api(self)
+
+        file           = caller.reject { |f| f.start_with? JSONAPIonify.path }[0].split(/\:\d/)[0]
+        dir            = File.expand_path File.dirname(file)
+        basename       = File.basename(file, File.extname(file))
+        self.load_path = File.join(dir, basename)
+        self.load_file = file
+
+        @title               = superclass.instance_variable_get(:@title)
+        @description         = superclass.instance_variable_get(:@description)
+        @documentation_order = superclass.instance_variable_get(:@documentation_order)
+      end
+    end
+
+    def self.resource_class
+      if const_defined?(:ResourceBase, false)
+        const_get(:ResourceBase, false)
+      else
+        const_set(:ResourceBase, Class.new(Resource))
+      end
     end
 
   end