remote_record 0.1.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7549ee998e94aff531c514ec0b95041d659624a8996cd0966d1769c32ee9e2f
-  data.tar.gz: 95220700e2ccdd2159f3be5929b0329cf177278cf8e346889deee4f55747fb50
+  metadata.gz: 8b0ea2bc5ed71919334a2a22d53f70a38ad06b116c7e76679e76bb0aeeb9ec9c
+  data.tar.gz: 4874762ea7e61fc354e99faa8d4cf6e79ba9b1451dcf5eefb029e2c173911b13
 SHA512:
-  metadata.gz: 045011fafc339148f07ad89834b86a36b46d1a8fa963a7922628eb5bb927a6e719fb4fa3189ebb6abafff3782141685a242cc77a1e6fec7eb5df7b571fdb7b2e
-  data.tar.gz: 5a37f46bf4eab3a9aee940447e8e6b34f0692064073333cc228799f46e1164e2e098a96374d11e7e71dc678158e3f78abf5975d6f44c9079e7b78194dead297f
+  metadata.gz: 603cbf7ecd366f2e3ba00c0be7d1ef793a484948a4940ddae511ab7e99583620d405cee4068958099dcf44aec52bdcc0df612771fc9b9243db530b643d5f1220
+  data.tar.gz: d5edee74efd6afd30db89d237674c5deb6953279636accc3e22b28b95e866f769631dc4a13fa70b30982e8f1422f2707bd9ccac2b0b1bdca2de5824e21e9c732

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,112 @@ 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` 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,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,6 +29,14 @@ 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

data/lib/remote_record/reference.rb

@@ -23,15 +23,37 @@ module RemoteRecord
       def remote_record_config
         Config.new
       end
+
+      def remote_all(&authz_proc)
+        remote_record_class.all(&authz_proc).map do |remote_resource|
+          where(remote_resource_id: remote_resource['id']).first_or_initialize(initial_attrs: remote_resource)
+        end
+      end
+
+      def remote_where(params, &authz_proc)
+        remote_record_class.where(params, &authz_proc).map do |remote_resource|
+          where(remote_resource_id: remote_resource['id']).first_or_initialize(initial_attrs: remote_resource)
+        end
+      end
     end
 
     # rubocop:disable Metrics/BlockLength
     included do
+      include ActiveSupport::Rescuable
+      attr_accessor :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
 
@@ -40,24 +62,21 @@ 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
-      end
-
       def fetch_remote_resource
-        instance.fetch
+        instance.fetch if fetching
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        rescue_with_handler(e) || raise
       end
 
       def fresh
-        fetch_remote_resource
+        instance.fetch
         self
       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.1.2'
+  VERSION = '0.6.0'
 end

metadata

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