remote_record 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e6b11dd488bf26b81544c37471498737a26598429ba8290e4e9c8e0f6d79a0
-  data.tar.gz: cb125226d35be488de6d72651bb1249539d4d2dec487f75e242fc949593b008c
+  metadata.gz: 8e59abdc5071a945f3bff2c49d9601fd0a5963fe8476c7df38cae943fe960e67
+  data.tar.gz: 469a8ba9bdbf28f3b5ab8a9ac8513dda3720bfb122d6adfb09639429454d0ee6
 SHA512:
-  metadata.gz: '08872bedccc7008cbf05129c2e9e791ee73c88bdc222dbaab1ff973bf32b0e24a284690072394c4b6e9a5126f7c0c851e6a2ffbf7ef855909397fbc77d870cbd'
-  data.tar.gz: d86cd65b6db39f4191d39b0be6e954b56b118daa02534eb0b8c20e10fcf988d9e07ada0fef2fc418e787b1a112dfc300b31df2f7afde199df88bb3fab68d04ca
+  metadata.gz: 7865d6b9f270fb7ffeeb2a8d7cfc7ce298cbfc94f7d1414848dc913b913f71762b1214ab95a9cf1c5e46dbefa9da371fbf25fdf9b75a22aceede815d998f54f7
+  data.tar.gz: 3c472901d7748ec97086a8e9516d8d8edcb10a49cc9a963f5615a146d431f26622c3020cb0367a17f13c5e4df75848c753cde2ac3da0dd06b471bd53dd7e215b

data/README.md

@@ -247,3 +247,23 @@ 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/reference.rb

@@ -47,6 +47,13 @@ module RemoteRecord
         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
+
       private
 
       def find_or_initialize_all(remote_resources)

data/lib/remote_record/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Simon Fish
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord