akeneo 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a4e07e19a36d3d570b8dc21b683910d558e2876755d8cb0c2e604155d8a70a
-  data.tar.gz: cfc04059a593500dacb17106847bcc9b2ef8b7c90967693ef193dfda63128c28
+  metadata.gz: a82b6a9e634b7a0546533a4f38fe55a8d7d535332a1426b675c6a963d1dbd165
+  data.tar.gz: 86fc515d5ac913e36213f8e3e34b28aebe59face66e52655bc28410ca619b3f7
 SHA512:
-  metadata.gz: 8b1171a0cab489133295291cd3d8163de7651b8b9e9ba6fd0c5e34ddf66b54b566c85fdf536768759b88a81d4d6515ca09959bdc57096c7191805488c032181e
-  data.tar.gz: 2d5972a171f1a369d95c73770f472e31abd18be22630cc6aa00fc089b010cd3cd5aeb3339ebadc2c99fa066f3ebc7ad857e2077ad8d1fdf004bc84bec2ace242
+  metadata.gz: 46fea6aa7926d012898b73b5e5bd00df2de2d763eeb8e99f8fd7155e47dc389d93182dff0ec9226ff2071184f668f29b14f31406e8efb21274631a4ff6f107d0
+  data.tar.gz: 86f85f185ca25353bd532c938a41bf5ae73af585fa77a73f5f01832fe6fed5d24f8f5d84cea257f8ccecf4bbbecfadc9948eeea748190b745dfc6c9d5108ba17

data/Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     akeneo (1.0.0)
       httparty
+      redis
       semantic_logger
 
 GEM
@@ -31,6 +32,7 @@ GEM
     public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (12.3.2)
+    redis (4.1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -73,4 +75,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -1,4 +1,5 @@
 # akeneo
+
 API client for accessing Akeneo.
 
 Usage:
@@ -17,3 +18,15 @@ client = Akeneo::API.new(
 client.product(511707)
 # => {"identifier"=>"511707", "family"=>"simple_product", "parent"=>nil, "groups"=>[]...
 ```
+
+## Configuration
+
+### Caching
+
+If you want to use redis as a caching layer you have to set the `REDIS_URL` ENV variable.
+By default the request will be cached for 5 Minutes.
+You can alter the cache expiration via the `AKENEO_CACHE_EXPIRES_IN` ENV variable.
+
+Caching is enabled by default whenever you have redis running.
+You can disable caching completely by setting
+`Akeneo::Cache.disabled = true` before you use the service.

data/akeneo.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'webmock'
   spec.add_dependency 'httparty'
+  spec.add_dependency 'redis'
   spec.add_dependency 'semantic_logger'
 end

data/lib/akeneo.rb

@@ -3,5 +3,5 @@
 require 'akeneo/api'
 
 module Akeneo
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/akeneo/cache.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+module Akeneo
+  module Cache
+    DEFAULT_EXPIRES_IN = 5 * 60
+
+    @@disabled = false # rubocop:disable Style/ClassVars
+
+    def self.disabled=(value)
+      @@disabled = value # rubocop:disable Style/ClassVars
+    end
+
+    module ClassMethods
+      def redis
+        @redis ||= Redis.new
+      end
+    end
+
+    def self.prepended(base)
+      base.extend(ClassMethods)
+    end
+
+    def get_request(path, options = {})
+      return super if disabled?
+
+      key = path.downcase
+      key << options[:query].to_s if defined? options[:query]
+
+      cached_response = read(key)
+      return cached_response unless cached_response.nil?
+
+      response = super
+
+      write(key, response)
+      response
+    rescue Redis::CannotConnectError
+      super
+    end
+
+    private
+
+    def read(key)
+      serialized_response = self.class.redis.get("akeneo:#{key}")
+      load_response(serialized_response) if serialized_response
+    end
+
+    def write(key, response)
+      self.class.redis.set("akeneo:#{key}", serialize_response(response), ex: expires_in)
+    end
+
+    def serialize_response(response)
+      Marshal.dump(response)
+    end
+
+    def load_response(serialized_response)
+      Marshal.load(serialized_response) # rubocop:disable Security/MarshalLoad
+    end
+
+    def disabled?
+      @@disabled
+    end
+
+    def expires_in
+      ENV.fetch('AKENEO_CACHE_EXPIRES_IN', DEFAULT_EXPIRES_IN)
+    end
+  end
+end

data/lib/akeneo/service_base.rb

@@ -3,8 +3,12 @@
 require 'httparty'
 require 'semantic_logger'
 
+require_relative './cache'
+
 module Akeneo
   class ServiceBase
+    prepend Cache
+
     DEFAULT_PAGINATION_TYPE = :search_after
     DEFAULT_PAGINATION_LIMIT = 100
 
@@ -23,8 +27,11 @@ module Akeneo
       { 'Authorization' => "Bearer #{@access_token}" }.merge(json_headers)
     end
 
-    def get_request(path)
-      HTTParty.get("#{@url}/api/rest/v1/#{path}", headers: default_request_headers)
+    def get_request(path, options = {})
+      HTTParty.get(
+        "#{@url}/api/rest/v1/#{path}",
+        options.merge(headers: default_request_headers)
+      )
     end
 
     def pagination_param

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akeneo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - AWN Dev Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: semantic_logger
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - lib/akeneo/api.rb
 - lib/akeneo/attribute_service.rb
 - lib/akeneo/authorization_service.rb
+- lib/akeneo/cache.rb
 - lib/akeneo/category_service.rb
 - lib/akeneo/family_service.rb
 - lib/akeneo/image_service.rb
@@ -147,8 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: API client for accessing Akeneo