remote_record 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50ea0ab82ff4f54ea0a877f85d2077f8e735da22b607d191dee6dad31a592a5c
-  data.tar.gz: d9a28e40ed1b61915e77d80e544aab33f9acf934c941a6fee3a38d08429928a4
+  metadata.gz: d657d0ec1a8c4606cc656d2c557e592637fa50d165cd95e118a8efa3094bc7a7
+  data.tar.gz: 6bd9609c2617e49b9701e84cd1011236978233856864791e7126c221228addf3
 SHA512:
-  metadata.gz: b1d370cfea855f1144e77ef2baacb4fcff519a00455e865b6beb6d8a280534e59f075b947c2775859a0f3d50d70d8c812463c4ce3d31857a00918a3c0f0c7072
-  data.tar.gz: 35c957d7a2e7f2a1075e375ca75d9ed2266b399d0c24d7ea83a9248f1ba40fe3f68e2cabd3901d92e302f92987e289c96ebe851672d143eeeb3f369e54908b76
+  metadata.gz: 4a115d1e2e29d138e67a70c574d66cb7efca0c1ab239d9f47146d8e157410c68d700c8c4bf2c19db647d45a3831f669984117db4823b16691d53af07245ccec1
+  data.tar.gz: 7325785485edb863a7d5c91e10b80b8119c93c1ec8b5ff7b1f570ffd498ac297b4c1ba8e3e86549d19ba654e6a578dc2f705a0470fbc2c19aac9e6f5bf49d488

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
 
@@ -110,7 +124,126 @@ 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.
 
+### `remote_all` and `remote_where`
+
+If you're able to fetch multiple records at once from the API, implement the
+`self.all` method on your remote record class. This should return an array of
+hashes that can be used to initialize a set of references.
+
+This can optionally take a block
+for authorization - note that it won't use the auth you've configured and that
+you'll always have to supply that inline. For example:
+
+```ruby
+module RemoteRecord
+  module GitHub
+    # :nodoc:
+    class User < RemoteRecord::Base
+      def get
+        client.user(remote_resource_id)
+      end
+
+      def self.all
+        Octokit::Client.new(access_token: yield).users
+      end
+
+      private
+
+      def client
+        Octokit::Client.new(access_token: authorization)
+      end
+    end
+  end
+end
+```
+
+Now you can call `remote_all` on remote reference classes that use
+`RemoteRecord::GitHub::User`, like this:
+
+```ruby
+GitHub::UserReference.remote_all { GITHUB_PERSONAL_ACCESS_TOKEN }
+```
+
+`remote_where` works in the same way, but with a parameter:
+
+```ruby
+module RemoteRecord
+  module GitHub
+    # :nodoc:
+    class User < RemoteRecord::Base
+      def get
+        client.user(remote_resource_id)
+      end
+
+      def self.all
+        Octokit::Client.new(access_token: yield).users
+      end
+
+      def self.where(query)
+        Octokit::Client.new(access_token: yield).search_users(query)
+      end
+
+      private
+
+      def client
+        Octokit::Client.new(access_token: authorization)
+      end
+    end
+  end
+end
+```
+
+Now you can call `remote_where` on remote reference classes that use
+`RemoteRecord::GitHub::User`, like this:
+
+```ruby
+GitHub::UserReference.remote_where('q=tom+repos:%3E42+followers:%3E1000') { GITHUB_PERSONAL_ACCESS_TOKEN }
+```
+
+It's recommended that you include something in `self.where` to filter incoming
+params. Ideally, you want to expose an interface that's as ActiveRecord-like as
+possible, e.g.:
+
+```ruby
+GitHub::UserReference.remote_where(q: 'tom', repos: '>42', followers: '>1000') { GITHUB_PERSONAL_ACCESS_TOKEN }
+```
+
+It's recommended that you write a `Transformer` to do this. Check out
+`RemoteRecord::Transformers::SnakeCase` for an example.
+
+### `initial_attrs`
+
+Behind the scenes, `remote_all` initializes references with a set of
+`initial_attrs`. You can do the same! If you've already fetched the data for an
+object, just pass it to `new` for your reference class under the
+`initial_attrs:`  keyword parameter, like this:
+
+```ruby
+todo = { id: 1, title: 'Hello world' }
+TodoReference.new(remote_resource_id: todo[:id], initial_attrs: todo)
+```
+
 ### 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` when creating or initializing references to make sure the
+resource isn't fetched.
+
+When querying for records using ActiveRecord alone, you might want to do so
+within a `no_fetching` context:
+
+```ruby
+TodoReference.no_fetching { |model| model.where(remote_resource_id: 1) }
+```
+
+Any records initialized within a `no_fetching` context won't be requested. It's
+sort of like a `Faraday` cage, pun entirely intended.
+
+If you're using `remote_all` or `remote_where` to fetch using your API, that'll
+automatically use this behind the scenes, then set `attrs` to the response
+value.

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,14 +3,16 @@
 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
 
-    def initialize(reference, options)
+    def initialize(reference, options = default_config, initial_attrs = {})
       @reference = reference
-      @options = options.presence || default_config
-      @attrs = HashWithIndifferentAccess.new
+      @options = options
+      @attrs = HashWithIndifferentAccess.new(initial_attrs)
     end
 
     def method_missing(method_name, *_args, &_block)
@@ -27,10 +29,22 @@ module RemoteRecord
       raise NotImplementedError.new, '#get should return a hash of data that represents the remote record.'
     end
 
+    def self.all
+      raise NotImplementedError.new, '#all should return an array of hashes of data that represent remote records.'
+    end
+
+    def self.where(_params)
+      raise NotImplementedError.new, '#where should return an array of hashes of data that represent remote records.'
+    end
+
     def fetch
       @attrs.update(get)
     end
 
+    def attrs=(new_attrs)
+      @attrs.update(new_attrs)
+    end
+
     private
 
     def transform(data)

data/lib/remote_record/reference.rb

@@ -9,7 +9,9 @@ module RemoteRecord
   module Reference
     extend ActiveSupport::Concern
 
-    class_methods do
+    class_methods do # rubocop:disable Metrics/BlockLength
+      attr_accessor :fetching
+
       def remote_record_class
         ClassLookup.new(self).remote_record_class(
           remote_record_config.to_h[:remote_record_class]&.to_s
@@ -23,17 +25,57 @@ module RemoteRecord
       def remote_record_config
         Config.new
       end
+
+      def fetching
+        @fetching = true if @fetching.nil?
+        @fetching
+      end
+
+      # Disable fetching for all records initialized in the block.
+      def no_fetching
+        self.fetching = false
+        block_return_value = yield(self)
+        self.fetching = true
+        block_return_value
+      end
+
+      def remote_all(&authz_proc)
+        no_fetching do
+          remote_record_class.all(&authz_proc).map do |remote_resource|
+            where(remote_resource_id: remote_resource['id']).first_or_initialize.tap do |record|
+              record.attrs = remote_resource
+            end
+          end
+        end
+      end
+
+      def remote_where(params, &authz_proc)
+        no_fetching do
+          remote_record_class.where(params, &authz_proc).map do |remote_resource|
+            where(remote_resource_id: remote_resource['id']).first_or_initialize.tap do |record|
+              record.attrs = remote_resource
+            end
+          end
+        end
+      end
     end
 
     # rubocop:disable Metrics/BlockLength
     included do
-      attr_accessor :fetching
+      include ActiveSupport::Rescuable
+      attribute :fetching, :boolean, default: -> { fetching }
+      attr_accessor :initial_attrs
 
       after_initialize do |reference|
+        reference.fetching = false if reference.initial_attrs.present?
         config = reference.class.remote_record_class.default_config.merge(
           reference.class.remote_record_config.to_h
         )
         reference.instance_variable_set('@remote_record_config', config)
+        reference.instance_variable_set('@instance',
+                                        @remote_record_config.remote_record_class.new(
+                                          self, @remote_record_config, reference.initial_attrs.presence || {}
+                                        ))
         reference.fetch_remote_resource
       end
 
@@ -42,20 +84,17 @@ 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(fetching: true, **args)
-        @fetching = fetching
-        super
-      end
-
       def fetch_remote_resource
-        instance.fetch if @fetching
+        instance.fetch if fetching
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        rescue_with_handler(e) || raise
       end
 
       def fresh
@@ -65,6 +104,8 @@ module RemoteRecord
 
       private
 
+      delegate :attrs=, to: :@instance
+
       def instance
         @instance ||= @remote_record_config.remote_record_class.new(self, @remote_record_config)
       end

data/lib/remote_record/transformers/base.rb

@@ -4,8 +4,11 @@ module RemoteRecord
   module Transformers
     # Base transformer class. Inherit from this and implement `#transform`.
     class Base
-      def initialize(data)
+      def initialize(data, direction = :up)
+        raise ArgumentError, 'The direction should be one of :up or :down.' unless %i[up down].include? direction
+
         @data = data
+        @direction = direction
       end
 
       def transform

data/lib/remote_record/transformers/snake_case.rb

@@ -15,14 +15,19 @@ module RemoteRecord
         when Array
           value.map { |v| convert_hash_keys(v) }
         when Hash
-          Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+          Hash[value.map { |k, v| [transform_key(k), convert_hash_keys(v)] }]
         else
           value
         end
       end
 
-      def underscore_key(key)
-        key.to_s.underscore.to_sym
+      def transform_key(key)
+        case @direction
+        when :up
+          key.to_s.underscore.to_sym
+        when :down
+          key.to_s.camelize(:lower).to_sym
+        end
       end
     end
   end

data/lib/remote_record/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Simon Fish
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,20 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement