remote_record 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a0631c2b3e0edcedb6cbe8b8c82898fcf9fd2c7ccb79f3ed81e636d22c1d7e2
-  data.tar.gz: 903e0ee0541c3f7165f117d5589977b45e6f99c2964541fcd130ebcc602913f2
+  metadata.gz: b7549ee998e94aff531c514ec0b95041d659624a8996cd0966d1769c32ee9e2f
+  data.tar.gz: 95220700e2ccdd2159f3be5929b0329cf177278cf8e346889deee4f55747fb50
 SHA512:
-  metadata.gz: '0487c9c421d736e9bb4b3e65d105a7963339c3a05ceb30bf31ebe1fcda345e96aac094f8ed91deeacf3825534e1dbe3079f4a6c5abd40c3ca3c076a73dfa5f1a'
-  data.tar.gz: dfb4cbeca331e5a3ff84465046d055aefb36f52662060b98ab221a385c395c06162e38062be007539594b6643d53e771a179882067377f94339117f256f5c84f
+  metadata.gz: 045011fafc339148f07ad89834b86a36b46d1a8fa963a7922628eb5bb927a6e719fb4fa3189ebb6abafff3782141685a242cc77a1e6fec7eb5df7b571fdb7b2e
+  data.tar.gz: 5a37f46bf4eab3a9aee940447e8e6b34f0692064073333cc228799f46e1164e2e098a96374d11e7e71dc678158e3f78abf5975d6f44c9079e7b78194dead297f

data/README.md

@@ -109,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/base.rb

@@ -34,8 +34,8 @@ module RemoteRecord
     private
 
     def transform(data)
-      transformers.reduce(data) do |data, transformer|
-        transformer.new(data).transform
+      transformers.reduce(data) do |transformed_data, transformer|
+        transformer.new(transformed_data).transform
       end
     end
 

data/lib/remote_record/reference.rb

@@ -25,6 +25,7 @@ module RemoteRecord
       end
     end
 
+    # rubocop:disable Metrics/BlockLength
     included do
       after_initialize do |reference|
         config = reference.class.remote_record_class.default_config.merge(
@@ -55,11 +56,17 @@ module RemoteRecord
         instance.fetch
       end
 
+      def fresh
+        fetch_remote_resource
+        self
+      end
+
       private
 
       def instance
         @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

@@ -1,8 +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

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module RemoteRecord
   module Transformers
+    # Base transformer class. Inherit from this and implement `#transform`.
     class Base
       def initialize(data)
         @data = data

data/lib/remote_record/transformers/snake_case.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRecord
   module Transformers
     # Converts keys to snake case.
@@ -19,8 +21,8 @@ module RemoteRecord
         end
       end
 
-      def underscore_key(k)
-        k.to_s.underscore.to_sym
+      def underscore_key(key)
+        key.to_s.underscore.to_sym
       end
     end
   end

data/lib/remote_record/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Simon Fish