remote_record 0.5.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf471bd03525a3f6dfdfedc1d88e2681264c85e98447607259fec7a94d56ddd
-  data.tar.gz: 076113352a325ee80c09cca58a00cdd8e703a584392319f008393fdae90ddbc2
+  metadata.gz: b0cee90c4d3ebf7acd0d02efebc3285ed4f568e8d42dae1b591a49d6a243bc9c
+  data.tar.gz: b2810727cc559a069b0905f55fb89fe5d3e6d63887cf6a5ef7b4bf8b0b738990
 SHA512:
-  metadata.gz: 3dc11719e885adf6220ef9b351b1605943ce25220c3e95ee0ee8820175685783777ed7f1bd43f22249f83cb95e8031509e2b85f8be04b65dc33aaab0c4fdca22
-  data.tar.gz: 478180ddc5b281c7a9873313608ad62368f9c947125fd1095b1c61a88e9cce5147637ca1391c801a0af1c2f53e4ac34418256a38563893f926a4f55ee37d62b4
+  metadata.gz: 86e914f8f66772ae586c17dca8d68e1a0a9b238a11461ff9a302bf8b14f8d9512496a0d0eb516c59746ba2f4dd963314452fe35ff5a16aa6d008016114538e79
+  data.tar.gz: d6c3207d6bf433b98174e1ba87304d6271b8242cdd27960cfe406b71cd16b07e6881371b8c1318d7c5b6be7f9f7917a63dfdc0064ef7db79e9f482eaf41a5056

data/README.md

@@ -124,6 +124,105 @@ 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
@@ -131,4 +230,40 @@ You might want to force a fresh request in some instances, even if you're using
 
 ### 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.
+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.
+
+### Finding a record without having its canonical ID
+
+On many platforms, you might find yourself searching for users by email or
+username. Those aren't canonical IDs - they could change. But searching for them
+by either of those things is a safe bet as a user, nine times out of ten.
+
+Similarly, you (or your users) might not always have a remote resource's ID
+upfront. You might, however, have something unique enough to discern it from
+other records, like a user-facing ID. A good example is a pull request reference
+on GitHub - using the repo name, owner's username, and pull request ID, you can
+find a pull request.
+
+Of course, that shouldn't be your canonical source, because two of those things
+could change. You could change your username, and you could rename the repo. But
+it's useful to be able to search by those things, right?
+
+Implement `find_by` on your remote_record class, and RemoteRecord will use it.
+If you don't, RemoteRecord will fall back to `remote_where`. This takes the same
+params as other class-level RemoteRecord methods, including an auth proc.

data/lib/remote_record/base.rb

@@ -9,10 +9,10 @@ module RemoteRecord
       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)
@@ -29,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

@@ -6,10 +6,12 @@ module RemoteRecord
   # record class (a descendant of RemoteRecord::Base). This is done on
   # initialize by calling #get on an instance of the remote record class. These
   # attributes are then accessible on the reference thanks to #method_missing.
-  module Reference
+  module Reference # rubocop:disable Metrics/ModuleLength
     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,19 +25,104 @@ 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)
+        find_or_initialize_all(remote_record_class.all(&authz_proc))
+      end
+
+      def remote_where(params, &authz_proc)
+        find_or_initialize_all(remote_record_class.where(params, &authz_proc))
+      end
+
+      def remote_find_by(params, &authz_proc)
+        return remote_where(params, &authz_proc).first unless remote_record_class.respond_to?(:find_by)
+
+        resource = remote_record_class.find_by(params, &authz_proc)
+        new(remote_resource_id: resource['id'], initial_attrs: resource)
+      end
+
+      def remote_find_or_initialize_by(params, &authz_proc)
+        return remote_where(params, &authz_proc).first unless remote_record_class.respond_to?(:find_by)
+
+        resource = remote_record_class.find_by(params, &authz_proc)
+        find_or_initialize_one(id: resource['id'], initial_attrs: resource)
+      end
+
+      private
+
+      def find_or_initialize_one(id:, initial_attrs:)
+        existing_record = no_fetching { find_by(remote_resource_id: id) }
+        return existing_record.tap { |r| r.attrs = initial_attrs } if existing_record.present?
+
+        new(remote_resource_id: id, initial_attrs: initial_attrs)
+      end
+
+      def find_or_initialize_all(remote_resources)
+        no_fetching do
+          pair_remote_resources_with_records(remote_resources) do |unsaved_resources, relation|
+            new_resources = unsaved_resources.map do |resource|
+              new(remote_resource_id: resource['id']).tap { |record| record.attrs = resource }
+            end
+            relation.to_a + new_resources
+          end
+        end
+      end
+
+      def pair_remote_resources_with_records(remote_resources)
+        # get resource ids
+        ids = remote_resource_ids(remote_resources)
+        # get what exists in the database
+        relation = where(remote_resource_id: ids)
+        # for each record, set its attrs
+        relation.map do |record|
+          record.attrs = remote_resources.find do |r|
+            r['id'].to_s == record.remote_resource_id.to_s
+          end
+        end
+        unsaved_resources = resources_without_persisted_references(remote_resources, relation)
+        yield(unsaved_resources, relation)
+      end
+
+      def remote_resource_ids(remote_resources)
+        remote_resources.map { |remote_resource| remote_resource['id'] }
+      end
+
+      def resources_without_persisted_references(remote_resources, relation)
+        remote_resources.reject do |resource|
+          relation.pluck(:remote_resource_id).include? resource['id']
+        end
+      end
     end
 
     # rubocop:disable Metrics/BlockLength
     included do
       include ActiveSupport::Rescuable
-      attr_accessor :fetching
+      attribute :fetching, :boolean, default: -> { fetching }
+      attr_accessor :initial_attrs
 
       after_initialize do |reference|
-        reference.fetching = true if reference.fetching.nil?
+        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
 
@@ -62,7 +149,7 @@ module RemoteRecord
         self
       end
 
-      private
+      delegate :attrs=, to: :@instance
 
       def instance
         @instance ||= @remote_record_config.remote_record_class.new(self, @remote_record_config)

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.5.0'
+  VERSION = '0.8.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Simon Fish
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-02-24 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