remote_record 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a0631c2b3e0edcedb6cbe8b8c82898fcf9fd2c7ccb79f3ed81e636d22c1d7e2
-  data.tar.gz: 903e0ee0541c3f7165f117d5589977b45e6f99c2964541fcd130ebcc602913f2
+  metadata.gz: 4bf471bd03525a3f6dfdfedc1d88e2681264c85e98447607259fec7a94d56ddd
+  data.tar.gz: 076113352a325ee80c09cca58a00cdd8e703a584392319f008393fdae90ddbc2
 SHA512:
-  metadata.gz: '0487c9c421d736e9bb4b3e65d105a7963339c3a05ceb30bf31ebe1fcda345e96aac094f8ed91deeacf3825534e1dbe3079f4a6c5abd40c3ca3c076a73dfa5f1a'
-  data.tar.gz: dfb4cbeca331e5a3ff84465046d055aefb36f52662060b98ab221a385c395c06162e38062be007539594b6643d53e771a179882067377f94339117f256f5c84f
+  metadata.gz: 3dc11719e885adf6220ef9b351b1605943ce25220c3e95ee0ee8820175685783777ed7f1bd43f22249f83cb95e8031509e2b85f8be04b65dc33aaab0c4fdca22
+  data.tar.gz: 478180ddc5b281c7a9873313608ad62368f9c947125fd1095b1c61a88e9cce5147637ca1391c801a0af1c2f53e4ac34418256a38563893f926a4f55ee37d62b4

data/README.md

@@ -1,6 +1,20 @@
-# RemoteRecord
+![RemoteRecord: Ready-made remote resource structures.](doc/header.svg)
 
-Ready-made remote resource structures.
+---
+
+![Remote Record](https://github.com/raisedevs/remote_record/workflows/Remote%20Record/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/remote_record.svg)](https://badge.fury.io/rb/remote_record)
+
+Every API speaks a different language. Maybe it's REST, maybe it's SOAP, maybe
+it's GraphQL. Maybe it's got its own Ruby client, or maybe you need to roll your
+own. But what if you could just pretend it existed in your database?
+
+RemoteRecord provides a consistent ActiveRecord inspired interface for all of
+your application's APIs. Store remote resources by ID, and RemoteRecord will
+auto-populate instances of your ActiveRecord model with their attributes from
+the API. Whether you're dealing with a user on GitHub, a track on Spotify, a
+place on Google Maps, or a resource on your internal infrastructure, you can use
+RemoteRecord to wrap fetching it.
 
 ## Setup
 
@@ -109,3 +123,12 @@ 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.
+
+### Skip fetching
+
+You might not want to make a request on initialize sometimes. In this case, pass `fetching: false` to your query or `new` to make sure the resource isn't fetched.

data/lib/remote_record.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/concern'
+require 'active_support/rescuable'
 require 'remote_record/base'
 require 'remote_record/class_lookup'
 require 'remote_record/config'

data/lib/remote_record/base.rb

@@ -3,6 +3,8 @@
 module RemoteRecord
   # Remote record classes should inherit from this class and define #get.
   class Base
+    include ActiveSupport::Rescuable
+
     def self.default_config
       Config.defaults.merge(remote_record_class: self)
     end
@@ -34,8 +36,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,8 +25,13 @@ module RemoteRecord
       end
     end
 
+    # rubocop:disable Metrics/BlockLength
     included do
+      include ActiveSupport::Rescuable
+      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 +44,22 @@ 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
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        rescue_with_handler(e) || raise
       end
 
-      def fetch_remote_resource
+      def fresh
         instance.fetch
+        self
       end
 
       private
@@ -61,5 +68,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

@@ -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.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.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