remote_record 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a744d661d889b63488c0cae5a44803d4215e384f39d7c7d0671cae12c4e04600
-  data.tar.gz: cef3b04a970a6cf4a48a966beb6e935525a72c2697367f81d2bf64a3ce21f9e9
+  metadata.gz: 285bbd2e1d94c57c73399a83c336404b2eb190e4b08e14287671152cf36dc866
+  data.tar.gz: 9b3ce895695588e43516e86a9498ed64d33ad76771afa13e739835dc12175abb
 SHA512:
-  metadata.gz: f580bbc02f2ea512f80101a0f4dc7d1b0c293db974c75b820b18e680a48c674a9d266b1542e42eb4988b366a111e30fbf342a59e4e47a3d93ba4658137096e81
-  data.tar.gz: '0792f2b3d53c925c348b500b768587eb7de9fea53cf80543f6cb3c4bb945749ad4be33006cb49e82fb17b46c53773e7e64bbd31df28988e19a22e4e8426a0109'
+  metadata.gz: d9105b2bd550f9553e2c04c8caa2a1ca1933628e51c3ccf318bc19c62721be4302d1ca490f29ab194dee971642ebb045f102b8e5a8179e3362cb630c7ae8db0a
+  data.tar.gz: 24966ceeb7d708fedaf6413e98496c485f77314d1837ca15cc5d7db9cd1d2e6ed0f3c06d50f7f709cc77f430e36b3f66d18e09e3970b246813b3e2e1c057d528

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
 ```
@@ -106,3 +109,8 @@ By default, this'll only make a request on initialize. For services that manage
 caching by way of expiry or ETags, I recommend using `faraday-http-cache` for
 your clients and setting `memoize` to `false`. Remote Record will eventually
 gain support for caching.
+
+### Forcing a fresh request
+
+You might want to force a fresh request in some instances, even if you're using
+`memoize`. To do this, call `fresh` on a reference, and it'll be repopulated.

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 |transformed_data, transformer|
+        transformer.new(transformed_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/reference.rb

@@ -25,8 +25,12 @@ module RemoteRecord
       end
     end
 
+    # rubocop:disable Metrics/BlockLength
     included do
+      attr_accessor :fetching
+
       after_initialize do |reference|
+        reference.fetching = true if reference.fetching.nil?
         config = reference.class.remote_record_class.default_config.merge(
           reference.class.remote_record_config.to_h
         )
@@ -39,20 +43,20 @@ module RemoteRecord
       def method_missing(method_name, *_args, &_block)
         fetch_remote_resource unless @remote_record_config.memoize
 
-        @instance.public_send(method_name)
+        instance.public_send(method_name)
       end
 
       def respond_to_missing?(method_name, _include_private = false)
         instance.respond_to?(method_name, false)
       end
 
-      def initialize(**args)
-        @attrs = HashWithIndifferentAccess.new
-        super
+      def fetch_remote_resource
+        instance.fetch if fetching
       end
 
-      def fetch_remote_resource
+      def fresh
         instance.fetch
+        self
       end
 
       private
@@ -61,5 +65,6 @@ module RemoteRecord
         @instance ||= @remote_record_config.remote_record_class.new(self, @remote_record_config)
       end
     end
+    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/remote_record/transformers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'remote_record/transformers/base'
+require 'remote_record/transformers/snake_case'
+
+module RemoteRecord
+  # Classes responsible for transforming the hash of data returned by API calls.
+  module Transformers
+  end
+end

data/lib/remote_record/transformers/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RemoteRecord
+  module Transformers
+    # Base transformer class. Inherit from this and implement `#transform`.
+    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,29 @@
+# frozen_string_literal: true
+
+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(key)
+        key.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.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Simon Fish
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -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: