jsonapi_parameters 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3adf5c57a8cbc8326297a9de48e80790d8c40ee19f700684f55fddf09e032dd
-  data.tar.gz: 95e53da4d7f1b29032e77e9943938b7edcd1d1d46965f838e437ceee81a3387d
+  metadata.gz: 140d60d07ed8488d9009e2c0e0757b1fbcf14596d79dc552c48c9212980985fd
+  data.tar.gz: 3480f41f044a29d8d2db32aa64ab10af535997fa5cb772ca1080372abb798e4c
 SHA512:
-  metadata.gz: 43f61c0ed74c5361932b6176d6af51e1d2f7d5b3d3bd638d383323bfc2379393a5ccfb27f46a6422ca5928884c63bdb4390762f59748f61e486d0b9589f8fb5a
-  data.tar.gz: e5cb09df6d9772d5cb854e82da2c8748d074c9413327a35bbb3ebc71d42eeac5f1eb63eb6f21fa4a45898f48c59f2b904556af82aa37e65330517ac40f96528d
+  metadata.gz: 8accb91454be6e686e29b4fbee76e9185df0dc2689ac50292d8098fa4f42fff9f4f8059a7c33aa389455776b7dcf8eb081ed0f472ef1e3fcd19a358f9875dac4
+  data.tar.gz: 39600f7081909c9bd5be6a16694e9db09f70b53e1e8d8126fa41fcacc9666232f68d1e16196993213cb943e7875fde0308ade0dfec889a625f254ff117ef2ad8

data/README.md

@@ -56,9 +56,24 @@ With jsonapi_parameters, the difference is just the params:
 
 ```ruby
 def create_params
-  params.to_jsonapi.require(:model).permit(:name)
+  params.from_jsonapi.require(:model).permit(:name)
 end
-```    
+```
+
+#### Casing
+
+If the input is in a different convention than `:snake`, you should specify that.
+ 
+ You can do it in two ways: 
+ * in an initializer, simply create `initializers/jsonapi_parameters.rb` with contents similar to: 
+ ```ruby
+ # config/initializers/jsonapi_parameters.rb
+  
+  JsonApi::Parameters.ensure_underscore_translation = true
+ 
+ ```
+ 
+ * while calling `.from_jsonapi`, for instance: `.from_jsonapi(:camel)`. **The value does not really matter, as anything different than `:snake` will result in deep keys transformation provided by [ActiveSupport](https://apidock.com/rails/v4.1.8/Hash/deep_transform_keys).**
 
 ### Plain Ruby / outside Rails
 
@@ -76,5 +91,14 @@ translator = Translator.new
 translator.jsonapify(params)
 ```
 
+#### Casing
+
+If the input is in a different convention than `:snake`, you should specify that.
+ 
+ You can do it in two ways:
+ 
+ * by a global setting: `JsonApi::Parameters.ensure_underscore_translation = true` 
+ * while calling `.jsonapify`, for instance: `.jsonapify(params, naming_convention: :camel)`. **The value does not really matter, as anything different than `:snake` will result in deep keys transformation provided by [ActiveSupport](https://apidock.com/rails/v4.1.8/Hash/deep_transform_keys).**
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jsonapi_parameters/core_ext/action_controller/parameters.rb

@@ -3,7 +3,13 @@ require 'action_controller'
 class ActionController::Parameters
   include JsonApi::Parameters
 
-  def to_jsonapi
-    @to_jsonapi ||= self.class.new jsonapify(self)
+  def to_jsonapi(*args)
+    warn "WARNING: #to_jsonapi method is deprecated. Please use #from_jsonapi instead.\n#{caller(1..1).first}"
+
+    from_jsonapi(*args)
+  end
+
+  def from_jsonapi(naming_convention = :snake)
+    @from_jsonapi ||= self.class.new jsonapify(self, naming_convention: naming_convention)
   end
 end

data/lib/jsonapi_parameters/parameters.rb

@@ -1,4 +1,9 @@
 module JsonApi
   module Parameters
+    @ensure_underscore_translation = false
+
+    class << self
+      attr_accessor :ensure_underscore_translation
+    end
   end
 end

data/lib/jsonapi_parameters/translator.rb

@@ -1,16 +1,20 @@
 module JsonApi::Parameters
-  def jsonapify(params)
-    jsonapi_translate(params)
+  def jsonapify(params, naming_convention: :snake)
+    jsonapi_translate(params, naming_convention: naming_convention)
   end
 
   private
 
-  def jsonapi_translate(params)
+  def jsonapi_translate(params, naming_convention:)
     params = params.to_unsafe_h if params.is_a?(ActionController::Parameters)
 
     return params if params.nil? || params.empty?
 
-    @jsonapi_unsafe_hash = params.deep_symbolize_keys
+    @jsonapi_unsafe_hash = if naming_convention != :snake || JsonApi::Parameters.ensure_underscore_translation
+                             params.deep_transform_keys { |key| key.to_s.underscore.to_sym }
+                           else
+                             params.deep_symbolize_keys
+                           end
 
     formed_parameters
   end

data/lib/jsonapi_parameters/version.rb

@@ -1,3 +1,3 @@
 module JsonApi::Parameters
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,29 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
+- Visuality
 - marahin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.11
+        version: 4.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.11
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: json
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +53,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +224,7 @@ dependencies:
 description: JsonApi::Parameters allows you to easily translate JSON:API compliant
   parameters to a structure expected by Rails.
 email:
+- contact@visuality.pl
 - me@marahin.pl
 executables: []
 extensions: []