lucid-shopify-cache 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ef20427c5125fb223b136013a38723bee687bff7553b7697170c9e67460c81d
+  data.tar.gz: 6881caeceae19fe21dde3118db714872c2f72f445022a23f759151a4512dc293
+SHA512:
+  metadata.gz: 6dab0956886319573cf9088b2b1c565be0c08617c8131f6d5a32e1d4bb22f4118242a9f68d175090c56d20a0f03732358cd7322d7fc1d2ad6e10df62a7800520
+  data.tar.gz: d3d534a53f07996c4ce7960b49b8af96d622cf53b520d533739c58d0911c2d03bf057d678e496e797d591838c4e8da980368fadb331d2fa90334aa966c09ce17

data/README.md

@@ -0,0 +1,50 @@
+lucid-shopify-cache
+===================
+
+Installation
+------------
+
+Add the gem to your ‘Gemfile’:
+
+    gem 'lucid-shopify'
+    gem 'lucid-shopify-cache'
+
+
+Usage
+-----
+
+### Make a cached GET request
+
+    require 'lucid/shopify/cached_get'
+
+    cached_get = Lucid::Shopify::CachedGet.new
+    
+    args = [request_credentials, 'orders', fields: %w(id tags)]
+    
+    cached_get.(*args)
+    cached_get.(*args) # fetched from the cache
+
+To clear the cache:
+
+    cached_get.clear(*args)
+
+
+### Example: shop attributes
+
+    args = [request_credentials, 'shop', {}]
+
+    cached_get.(*args)['shop']
+
+For the next hour, the data will be cached.
+
+You might want to set the TTL to a high value and clear it only
+when shop data actually changes. In this case, set up a ‘shop/update’
+webhook which calls:
+
+    cached_get.clear(*args).(*args)
+
+
+### TTL
+
+The default cache TTL is 3600 seconds (one hour), but this can be
+changed by setting the environment variable ‘LUCID_SHOPIFY_CACHE_TTL’.

data/lib/lucid/shopify/cache/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Lucid
+  module Shopify
+    class Cache
+      VERSION = '0.10.0'
+    end
+  end
+end

data/lib/lucid/shopify/cache.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'cbor' # less parsing overhead, and smaller than JSON
+
+module Lucid
+  module Shopify
+    class Cache
+      TTL = ENV['LUCID_SHOPIFY_CACHE_TTL'] || 3600
+
+      extend Dry::Initializer
+
+      # @return [String]
+      param :namespace, default: proc { 'lucid/shopify-cache' }
+      # @return [Redis]
+      option :redis_client, default: proc { Redis.current }
+
+      # Create a new instance with a new namespace appended to the current one.
+      #
+      # @param new_namespace [String]
+      #
+      # @return [Cache]
+      #
+      # @example
+      #   cache.add_namespace(myshopify_domain)
+      #
+      # @example Using the {+} operator alias
+      #   cache + myshopify_domain
+      def add_namespace(new_namespace)
+        self.class.new("#{namespace}:#{new_namespace}", redis_client)
+      end
+
+      alias_method :+, :add_namespace
+
+      # Fetch value from the cache, falling back to the given block when the cache
+      # is empty.
+      #
+      # @param key [String]
+      # @param ttl [Integer]
+      #
+      # @yieldreturn [#to_cbor]
+      #
+      # @return [Object]
+      def call(key, ttl: TTL)
+        key = namespaced_key(key)
+
+        fetch(key) || cache(key, yield, ttl)
+      end
+
+      # @param key [String]
+      #
+      # @return [Object, nil]
+      private def fetch(key)
+        val = redis_client.get(key)
+
+        val && CBOR.decode(val)
+      end
+
+      # @param key [String]
+      # @param val [#to_cbor]
+      # @param ttl [Integer]
+      #
+      # @return [Object]
+      private def cache(key, val, ttl)
+        redis_client.set(key, CBOR.encode(val))
+        redis_client.expire(key, ttl)
+
+        val
+      end
+
+      # @param key [String]
+      #
+      # @return [String]
+      private def namespaced_key(key)
+        "#{namespace}:#{key}"
+      end
+
+      # @param key [String]
+      def clear(key)
+        redis_client.del(namespaced_key(key))
+      end
+    end
+  end
+end

data/lib/lucid/shopify/cached_get.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'net/http'
+require 'uri'
+
+require 'lucid/shopify/cache'
+
+module Lucid
+  module Shopify
+    class CachedGet
+      extend Dry::Initializer
+
+      # @return [Cache]
+      option :cache, default: proc { Cache.new }
+      # @return [Lucid::Shopify::Client]
+      option :client, default: proc { Client.new }
+
+      # @see {Lucid::Shopify::Client#get}
+      #
+      # @param ttl [Integer]
+      def call(*get_args, ttl: Cache::TTL)
+        cache.(key(*get_args), ttl: ttl) { client.get(*get_args).to_h }.freeze
+      end
+
+      # @see {Lucid::Shopify::Client#get}
+      #
+      # @return [self]
+      def clear(*get_args)
+        cache.clear(key(*get_args))
+
+        self
+      end
+
+      # @see {Lucid::Shopify::Client#get}
+      private def key(credentials, path, params = {})
+        Digest::MD5.hexdigest([
+          credentials.myshopify_domain,
+          path,
+          params,
+        ].join("\x1f")) # ASCII unit separator
+      end
+    end
+  end
+end

data/lib/lucid-shopify-cache.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Primarily for Bundler.
+
+require 'lucid/shopify/cache'
+require 'lucid/shopify/cached_get'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: lucid-shopify-cache
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Kelsey Judson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.67'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.67'
+- !ruby/object:Gem::Dependency
+  name: cbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: lucid-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: 
+email: kelsey@lucid.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/lucid-shopify-cache.rb
+- lib/lucid/shopify/cache.rb
+- lib/lucid/shopify/cache/version.rb
+- lib/lucid/shopify/cached_get.rb
+homepage: https://github.com/lucidnz/gem-lucid-shopify-cache
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Cache Shopify API data
+test_files: []