json_api_responders 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b60a50fdf2f25e998fede1a0427fb04bdb37c630
-  data.tar.gz: 3611346f4409eedbc1c9c521a8ce9a495cfaafda
+  metadata.gz: 7d9223310e0bc824e94e72d5724cb531009adce1
+  data.tar.gz: 3fca5112b3b31228a5a9a59772a341c203206bc2
 SHA512:
-  metadata.gz: d27abc9d632fbd7844dd555e7b50093793d12f595e3a660a33aa3101e381d9ab6fe6b8bc5805a29b6c96ad2fe5de4329a93edfe5f8a6137ed1b376f56a06afb1
-  data.tar.gz: a3bf66eaf91447a813551b2c11579bd659d540e2e27e06106b0c8f8e6dacc45edab48a47b16001088574f44badd9b402b6a4cf8cb12628f3d5c63057d650ab5c
+  metadata.gz: f4bde721bbf3b652dc37157227cc5d50756ef87cb337c156b39a6d6c0b0d74007500494e4b10cc7f00086fba4eafadb6bae13bcdc108c999f1a05e10e7085487
+  data.tar.gz: 42a5cd9abeecc0ffed50c3eb7e28e960d025c1289e62210c272a6127281bde6843ad1da9f6731bddfdf9b959551d0526acbdb6cc3b5534b5b1353931de31ea7f

data/README.md

@@ -28,7 +28,19 @@ And then execute:
 
 whatever can be passed to controller.render can be passed here:
 
-        respond_with user, serializer: UserSerializer
+    respond_with user, serializer: UserSerializer
+
+## Configuration
+Currently you can only configure which options are required to be passed through the `respond_with` method. Bellow you can find an example:
+
+    JsonApiResponders.configure do |config|
+        config.required_options = [:foo]
+    end
+    ...
+    user = User.first
+    respond_with user, foo: :bar
+
+If `:foo` was left out of the `respond_with` method you would see the `JsonApiResponders::Errors::RequiredOptionMissingError` be raised.
 
 ## Responses
 

data/lib/json_api_responders.rb

@@ -1,8 +1,21 @@
 require 'json_api_responders/version'
 require 'json_api_responders/errors'
 require 'json_api_responders/responder'
+require 'json_api_responders/config'
 
 module JsonApiResponders
+  class << self
+    attr_writer :config
+  end
+
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  def self.config
+    @config ||= JsonApiResponders::Config.new
+  end
+
   def self.included(base)
     base.rescue_from ActiveRecord::RecordNotFound, with: :record_not_found!
     base.rescue_from ActionController::ParameterMissing, with: :parameter_missing!
@@ -10,6 +23,7 @@ module JsonApiResponders
 
   def respond_with(resource, options = {})
     options = { params: params }.merge(options)
+    JsonApiResponders.config.check_required_options(options)
     Responder.new(self, resource, options).respond!
   end
 

data/lib/json_api_responders/config.rb

@@ -0,0 +1,16 @@
+module JsonApiResponders
+  class Config
+    attr_reader :required_options
+
+    def required_options=(opts = [])
+      @required_options = opts
+    end
+
+    def check_required_options(options)
+      return if @required_options.nil?
+      @required_options.each do |key|
+        raise JsonApiResponders::Errors::RequiredOptionMissingError, key unless options.key? key
+      end
+    end
+  end
+end

data/lib/json_api_responders/errors.rb

@@ -20,6 +20,19 @@ module JsonApiResponders
       end
     end
 
+    class RequiredOptionMissingError < StandardError
+      attr_reader :required_option
+
+      def initialize(required_option)
+        @required_option = required_option
+        super(message)
+      end
+
+      def message
+        "Option '#{required_option}' is missing."
+      end
+    end
+
     class UnknownAction < StandardError
       attr_reader :action
 

data/lib/json_api_responders/version.rb

@@ -1,6 +1,6 @@
 module JsonApiResponders
   MAJOR = 2
-  MINOR = 0
-  PATCH = 2
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_responders
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Stanko Krtalić Rusendić
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,6 +127,7 @@ files:
 - bin/setup
 - json_api_responders.gemspec
 - lib/json_api_responders.rb
+- lib/json_api_responders/config.rb
 - lib/json_api_responders/errors.rb
 - lib/json_api_responders/responder.rb
 - lib/json_api_responders/responder/actions.rb