lucid_shopify-cache 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4bd3b8c8f5fdfbb220f971f45871968a8757ef35c465ea1966dfc28f458d2aa
+  data.tar.gz: 4c41f6c64d5c66da2f6aa5a4056748dcff2823dcba1189ba9d9f8fe22ce14622
+SHA512:
+  metadata.gz: 7f40200770a8bb8083ebf69a8c78d2619ca30db89934aaee3f70d17459a8126b8c4c1f8cff8a41adb578c87ba53f0c61917cc0867bc2539f02e1f25228e0ac5d
+  data.tar.gz: 44e66e48b13e4a3670d1e432fd278a9683235f42fa61e65b6e173bc759feb02d2cb4eda7d1603ad841ceb12ebc84541e93205b299b4affea30707665d1c9f5ae

data/README.md

@@ -0,0 +1,51 @@
+lucid_shopify-cache
+===================
+
+Installation
+------------
+
+Add the following lines to your ‘Gemfile’:
+
+    git_source :lucid { |r| "https://github.com/lucidnz/gem-lucid_#{r}.git" }
+
+    gem 'lucid_shopify-cache', lucid: 'shopify-cache'
+
+
+Usage
+-----
+
+### Make a cached GET request
+
+    require 'lucid_shopify/cached_get'
+
+    cached_get = LucidShopify::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)['shop']
+
+
+### 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,7 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  class Cache
+    VERSION = '0.3.1'
+  end
+end

data/lib/lucid_shopify/cache.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module LucidShopify
+  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 { defined?(Redis) && 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_json]
+    #
+    # @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 && JSON.parse(val)
+    end
+
+    #
+    # @param key [String]
+    # @param val [#to_json]
+    # @param ttl [Integer]
+    #
+    # @return [Object]
+    #
+    private def cache(key, val, ttl)
+      redis_client.set(key, val.to_json)
+      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

data/lib/lucid_shopify/cached_get.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+
+require 'lucid_shopify/cache'
+
+module LucidShopify
+  class CachedGet
+    extend Dry::Initializer
+
+    # @return [Cache]
+    option :cache, default: proc { Cache.new }
+    # @return [LucidShopify::Client]
+    option :client, default: proc { Client.new }
+
+    #
+    # @see {LucidShopify::Client#get}
+    #
+    # @param ttl [Integer]
+    #
+    def call(*get_args, ttl: Cache::TTL)
+      cache.(key(*get_args), ttl: ttl) { client.get(*get_args) }.freeze
+    end
+
+    #
+    # @see {LucidShopify::Client#get}
+    #
+    # @return [self]
+    #
+    def clear(*get_args)
+      cache.clear(key(*get_args))
+
+      self
+    end
+
+    #
+    # @see {LucidShopify::Client#get}
+    #
+    private def key(credentials, path, params = {})
+      [
+        credentials.myshopify_domain,
+        path,
+        params,
+      ].join(':')
+    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,90 @@
+--- !ruby/object:Gem::Specification
+name: lucid_shopify-cache
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Kelsey Judson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Cache Shopify API data
+test_files: []