remote_record 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a744d661d889b63488c0cae5a44803d4215e384f39d7c7d0671cae12c4e04600
-  data.tar.gz: cef3b04a970a6cf4a48a966beb6e935525a72c2697367f81d2bf64a3ce21f9e9
+  metadata.gz: 0a0631c2b3e0edcedb6cbe8b8c82898fcf9fd2c7ccb79f3ed81e636d22c1d7e2
+  data.tar.gz: 903e0ee0541c3f7165f117d5589977b45e6f99c2964541fcd130ebcc602913f2
 SHA512:
-  metadata.gz: f580bbc02f2ea512f80101a0f4dc7d1b0c293db974c75b820b18e680a48c674a9d266b1542e42eb4988b366a111e30fbf342a59e4e47a3d93ba4658137096e81
-  data.tar.gz: '0792f2b3d53c925c348b500b768587eb7de9fea53cf80543f6cb3c4bb945749ad4be33006cb49e82fb17b46c53773e7e64bbd31df28988e19a22e4e8426a0109'
+  metadata.gz: '0487c9c421d736e9bb4b3e65d105a7963339c3a05ceb30bf31ebe1fcda345e96aac094f8ed91deeacf3825534e1dbe3079f4a6c5abd40c3ca3c076a73dfa5f1a'
+  data.tar.gz: dfb4cbeca331e5a3ff84465046d055aefb36f52662060b98ab221a385c395c06162e38062be007539594b6643d53e771a179882067377f94339117f256f5c84f

data/README.md

@@ -55,6 +55,7 @@ Calling `remote_record` in addition to this lets you set some options:
 | id_field      | `:remote_resource_id`    | The field on the reference that contains the remote resource ID                                                                                                                    |
 | authorization | `''`                     | An object that can be used by the remote record class to authorize a request. This can be a value, or a proc that returns a value that can be used within the remote record class. |
 | memoize       | true                     | Whether reference instances should memoize the response that populates them                                                                                                        |
+| transform     | []                       | Whether the response should be put through a transformer (under RemoteRecord::Transformers). Currently, only `[:snake_case]` is available.                                         |
 
 ```ruby
 module GitHub
@@ -68,6 +69,7 @@ module GitHub
       # c.id_field :remote_resource_id
       # c.klass RemoteRecord::GitHub::User, # Inferred from module and class name
       # c.memoize true
+      # c.transform []
     end
   end
 end
@@ -85,6 +87,7 @@ class JsonPlaceholderAPIReference < ApplicationRecord
     # c.id_field :remote_resource_id
     # c.klass RemoteRecord::JsonPlaceholderAPI, # Inferred from module and class name
     # c.memoize true
+    # c.transform []
   # end
 end
 ```

data/lib/remote_record.rb

@@ -7,6 +7,7 @@ require 'remote_record/config'
 require 'remote_record/dsl'
 require 'remote_record/reference'
 require 'remote_record/version'
+require 'remote_record/transformers'
 
 # Generic interface for resources stored on external services.
 module RemoteRecord

data/lib/remote_record/base.rb

@@ -14,7 +14,7 @@ module RemoteRecord
     end
 
     def method_missing(method_name, *_args, &_block)
-      @attrs.fetch(method_name)
+      transform(@attrs).fetch(method_name)
     rescue KeyError
       super
     end
@@ -33,6 +33,19 @@ module RemoteRecord
 
     private
 
+    def transform(data)
+      transformers.reduce(data) do |data, transformer|
+        transformer.new(data).transform
+      end
+    end
+
+    # Robots in disguise.
+    def transformers
+      @options.transform.map do |transformer_name|
+        "RemoteRecord::Transformers::#{transformer_name.to_s.camelize}".constantize
+      end
+    end
+
     def authorization
       authz = @options.authorization
       authz.respond_to?(:call) ? authz.call(@reference, @options) : authz

data/lib/remote_record/config.rb

@@ -7,7 +7,7 @@ module RemoteRecord
   # defaults of the remote record class and the overrides set when
   # `remote_record` is called.
   class Config
-    OPTIONS = %i[remote_record_class authorization memoize id_field].freeze
+    OPTIONS = %i[remote_record_class authorization memoize id_field transform].freeze
 
     def initialize(**options)
       @options = options
@@ -17,7 +17,8 @@ module RemoteRecord
       new(
         authorization: '',
         memoize: true,
-        id_field: :remote_resource_id
+        id_field: :remote_resource_id,
+        transform: []
       )
     end
 

data/lib/remote_record/transformers.rb

@@ -0,0 +1,8 @@
+require 'remote_record/transformers/base'
+require 'remote_record/transformers/snake_case'
+
+module RemoteRecord
+  module Transformers
+    
+  end
+end

data/lib/remote_record/transformers/base.rb

@@ -0,0 +1,13 @@
+module RemoteRecord
+  module Transformers
+    class Base
+      def initialize(data)
+        @data = data
+      end
+
+      def transform
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/remote_record/transformers/snake_case.rb

@@ -0,0 +1,27 @@
+module RemoteRecord
+  module Transformers
+    # Converts keys to snake case.
+    class SnakeCase < RemoteRecord::Transformers::Base
+      def transform
+        convert_hash_keys(@data)
+      end
+
+      private
+
+      def convert_hash_keys(value)
+        case value
+        when Array
+          value.map { |v| convert_hash_keys(v) }
+        when Hash
+          Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+        else
+          value
+        end
+      end
+
+      def underscore_key(k)
+        k.to_s.underscore.to_sym
+      end
+    end
+  end
+end

data/lib/remote_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemoteRecord
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Simon Fish
@@ -195,6 +195,9 @@ files:
 - lib/remote_record/config.rb
 - lib/remote_record/dsl.rb
 - lib/remote_record/reference.rb
+- lib/remote_record/transformers.rb
+- lib/remote_record/transformers/base.rb
+- lib/remote_record/transformers/snake_case.rb
 - lib/remote_record/version.rb
 homepage: https://github.com/raisedevs/remote_record
 licenses: