akeneo 1.5.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e23e9957d939ac3ec1b78110e9c1488e9b7603661a635bb2c0ea6ec7ea6de067
-  data.tar.gz: 03c61f430ae6e7df2ea18d687b6a0a4fbe969d983bcfca02fe8c72e27d213a4f
+  metadata.gz: 0e2c55807f94475e39690f1ac2eb6782379f501a3c89e8fa6a45b8073199bd70
+  data.tar.gz: 332e8bf0c5ccb96d735e40bc602b48da245b0970e5dc9716c908feb8974638bc
 SHA512:
-  metadata.gz: 24adead0b454a21ba3f9d5e01c08f8bfc03284451b29deedafa6ff1b971d030839d0f66fd3a0e5264e7c92accf24e3aee2f7a0c837e320eced2b469f1acaffaf
-  data.tar.gz: 1b73fae84742e1e1a94066f96db9186e5795a31d28d0a6c9db5b41cbe1ad18ca1b3cec0697b115634d00d54b406114d29d5a96fcf5f4b0ce0e20c12e70cf4c97
+  metadata.gz: 7ea4ddf2d9aa56a77c05697140fdea805e349da2736ef7c8e90097eb0d6c6ae3c7e959375f0ea7df29e04abd464044ccabd4ce9dbeabef0a07e717e3fb40bab6
+  data.tar.gz: 0e7b75d0a365852842118be5c027ca7cbb7cb16c337feaadc0c76a137a114b29d95fd86953bef567e3a14e5c1571e275674d8351740dc6bff93391ae73bb2695

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    akeneo (1.5.0)
-      httparty
+    akeneo (1.7.1)
+      httparty (~> 0.17.0)
       mime-types
       redis
       semantic_logger
@@ -13,18 +13,18 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     hashdiff (0.3.8)
-    httparty (0.16.4)
+    httparty (0.17.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     jaro_winkler (1.5.2)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2019.0331)
     multi_xml (0.6.0)
     parallel (1.12.1)
     parser (2.5.3.0)
@@ -32,8 +32,8 @@ GEM
     powerpack (0.1.2)
     public_suffix (3.0.3)
     rainbow (3.0.0)
-    rake (12.3.2)
-    redis (4.1.0)
+    rake (13.0.1)
+    redis (4.1.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -57,7 +57,7 @@ GEM
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
-    semantic_logger (4.4.0)
+    semantic_logger (4.5.0)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.4.1)
     webmock (3.5.1)

data/README.md

@@ -19,6 +19,29 @@ client = Akeneo::API.new(
 
 client.product(511707)
 # => {"identifier"=>"511707", "family"=>"simple_product", "parent"=>nil, "groups"=>[]...
+
+Some methods with parameters is inside services classes, and be called that way
+client.family_service.all
+# => Returns a Enumeration to list all families
+
+client.product_service.create(object)
+# => Returns a JSON with status code relative to what happened
+201: CREATED
+"{"line":1,"identifier":"bot","status_code":201}"
+
+204: NO CONTENT/UPDATED
+"{"line":1,"identifier":"top","status_code":204}"
+
+422: UNPROCESSABLE ENTITY/ERROR
+In this case, returns message too
+"{"line":1,"identifier":"bot","status_code":422,"message":"Validation failed.","errors":[{"property":"values","message":"The value Top 2 vezes is already set on another product for the unique attribute nome_marketing","attribute":"nome_marketing","locale":null,"scope":null}]}"
+```
+
+Returns options from attribute
+```
+options = client.attribute_service.options(codigo_do_atributo)
+
+options["_embedded"]["items"].map{|a| [a['code'], a['labels']]}
 ```
 
 ## Configuration

data/akeneo.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'akeneo'
-  spec.version       = '1.5.0'
+  spec.version       = '1.8.0'
   spec.authors       = ['AWN Dev Team']
   spec.email         = ['edv@awn.de']
 
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'webmock'
-  spec.add_dependency 'httparty'
+  spec.add_dependency 'httparty', '~> 0.17.0'
   spec.add_dependency 'mime-types'
   spec.add_dependency 'redis'
   spec.add_dependency 'semantic_logger'

data/lib/akeneo/api.rb

@@ -12,24 +12,23 @@ module Akeneo
 
     def initialize(url:, client_id:, secret:, username:, password:)
       @url = url
-      authorization_service.authorize!(
-        client_id: client_id,
-        secret: secret,
-        username: username,
-        password: password
-      )
+      authorization_service.authorize!(client_id: client_id, secret: secret, username: username, password: password)
     end
 
     def fresh_access_token
       authorization_service.fresh_access_token
     end
 
-    def product(sku)
-      product_service.find(sku)
+    def product(code)
+      product_service.find(code)
     end
 
-    def products(with_family: nil)
-      product_service.all(with_family: with_family)
+    def products(with_family: nil, with_completeness: nil, updated_after: nil)
+      product_service.all(
+        with_family: with_family,
+        with_completeness: with_completeness,
+        updated_after: updated_after
+      )
     end
 
     def published_products(updated_after: nil)
@@ -44,6 +43,10 @@ module Akeneo
       product_service.create_or_update(code, options)
     end
 
+    def create_product(options:)
+      product_service.create(options)
+    end
+
     def create_or_update_product_model(code:, options:)
       product_model_service.create_or_update(code, options)
     end
@@ -79,8 +82,8 @@ module Akeneo
       product_model_service.find(product_parent['parent'])
     end
 
-    def family(family_code)
-      family_service.find(family_code)
+    def family(code)
+      family_service.find(code)
     end
 
     def family_variant(family_code, family_variant_code)
@@ -91,14 +94,11 @@ module Akeneo
       family_variant = family_service.variant(family_code, family_variant_code)
       return [] unless family_variant
 
-      [
-        find_attribute_code_for_level(family_variant, 1),
-        find_attribute_code_for_level(family_variant, 2)
-      ].compact
+      [find_attribute_code_for_level(family_variant, 1), find_attribute_code_for_level(family_variant, 2)].compact
     end
 
-    def brothers_and_sisters(id)
-      product_service.brothers_and_sisters(id)
+    def brothers_and_sisters(code)
+      product_service.brothers_and_sisters(code)
     end
 
     def attribute(code)

data/lib/akeneo/attribute_service.rb

@@ -4,12 +4,31 @@ require_relative './service_base.rb'
 
 module Akeneo
   class AttributeService < ServiceBase
+    def all
+      Enumerator.new do |attributes|
+        request_url = "/attributes?#{limit_param}"
+
+        loop do
+          response = get_request(request_url)
+          extract_collection_items(response).each { |attribute| attributes << attribute }
+          request_url = extract_next_page_path(response)
+          break unless request_url
+        end
+      end
+    end
+
     def find(code)
       response = get_request("/attributes/#{code}")
 
       response.parsed_response if response.success?
     end
 
+    def options(attribute_code)
+      response = get_request("/attributes/#{attribute_code}/options")
+
+      response.parsed_response if response.success?
+    end
+
     def option(code, option_code)
       response = get_request("/attributes/#{code}/options/#{option_code}")
 

data/lib/akeneo/category_service.rb

@@ -4,6 +4,19 @@ require_relative './service_base.rb'
 
 module Akeneo
   class CategoryService < ServiceBase
+    def all
+      Enumerator.new do |categories|
+        request_url = "/categories?#{limit_param}"
+
+        loop do
+          response = get_request(request_url)
+          extract_collection_items(response).each { |category| categories << category }
+          request_url = extract_next_page_path(response)
+          break unless request_url
+        end
+      end
+    end
+
     def find(code)
       response = get_request("/categories/#{code}")
 

data/lib/akeneo/family_service.rb

@@ -4,6 +4,19 @@ require_relative './service_base.rb'
 
 module Akeneo
   class FamilyService < ServiceBase
+    def all
+      Enumerator.new do |families|
+        request_url = "/families?#{limit_param}"
+
+        loop do
+          response = get_request(request_url)
+          extract_collection_items(response).each { |family| families << family }
+          request_url = extract_next_page_path(response)
+          break unless request_url
+        end
+      end
+    end
+
     def find(code)
       response = get_request("/families/#{code}")
 

data/lib/akeneo/product_service.rb

@@ -27,10 +27,9 @@ module Akeneo
       load_products(akeneo_product, akeneo_product['family'], parents)
     end
 
-    def all(with_family: nil)
+    def all(with_family: nil, with_completeness: nil, updated_after: nil)
       Enumerator.new do |products|
-        path = "/products?#{pagination_param}&#{limit_param}"
-        path += search_with_family_param(with_family) if with_family
+        path = build_path(with_family, with_completeness, updated_after)
 
         loop do
           response = get_request(path)
@@ -45,10 +44,23 @@ module Akeneo
       patch_request("/products/#{code}", body: options.to_json)
     end
 
+    def create(options)
+      post_request('/products', body: options.to_json)
+    end
+
+    def create_several(product_objects)
+      patch_for_collection_request('/products', body: product_objects.to_json)
+    end
+
     private
 
-    def search_with_family_param(family)
-      "&search={\"family\":[{\"operator\":\"IN\",\"value\":[\"#{family}\"]}]}"
+    def build_path(family, completeness, updated_after)
+      path = "/products?#{pagination_param}&#{limit_param}"
+      path + search_params(
+        family: family,
+        completeness: completeness,
+        updated_after: updated_after
+      )
     end
 
     def load_akeneo_parent(code)
@@ -58,7 +70,8 @@ module Akeneo
     end
 
     def load_parents(family, akeneo_parent, akeneo_grand_parent)
-      return [] if akeneo_parent.nil? || akeneo_grand_parent.nil?
+      return [] if akeneo_parent.nil?
+      return [akeneo_parent] if akeneo_grand_parent.nil?
 
       @product_model_service.all(with_family: family).select do |parent|
         parent['parent'] == akeneo_grand_parent['code']

data/lib/akeneo/published_product_service.rb

@@ -12,7 +12,7 @@ module Akeneo
     def published_products(updated_after: nil)
       Enumerator.new do |products|
         path = "/published-products?#{pagination_param}"
-        path += "&#{search_param(updated_after)}" if updated_after
+        path += search_params(updated_after: updated_after)
 
         loop do
           response = get_request(path)

data/lib/akeneo/service_base.rb

@@ -9,6 +9,7 @@ module Akeneo
   class ServiceBase
     prepend Cache
 
+    API_VERSION = 'v1'
     DEFAULT_PAGINATION_TYPE = :search_after
     DEFAULT_PAGINATION_LIMIT = 100
 
@@ -19,10 +20,28 @@ module Akeneo
 
     private
 
+    def search_params(family: nil, completeness: nil, updated_after: nil)
+      return '' if family.nil? && completeness.nil? && updated_after.nil?
+
+      "&search=#{search_params_hash(family, completeness, updated_after).to_json}"
+    end
+
+    def search_params_hash(family, completeness, updated_after)
+      {}.tap do |hash|
+        hash[:family] = [{ operator: 'IN', value: [family] }] if family
+        hash[:completeness] = [completeness] if completeness
+        hash[:updated] = [{ operator: '>', value: updated_after.strftime('%F %T') }] if updated_after
+      end
+    end
+
     def json_headers
       { 'Content-Type' => 'application/json' }
     end
 
+    def akeneo_collection_headers
+      { 'Content-Type' => 'application/vnd.akeneo.collection+json' }
+    end
+
     def authorization_headers
       { 'Authorization' => "Bearer #{@access_token}" }
     end
@@ -31,20 +50,38 @@ module Akeneo
       authorization_headers.merge(json_headers)
     end
 
+    def collection_request_headers
+      authorization_headers.merge(akeneo_collection_headers)
+    end
+
     def get_request(path, options = {})
       HTTParty.get(
-        "#{@url}/api/rest/v1#{path}",
+        build_url(path),
         options.merge(headers: default_request_headers)
       )
     end
 
     def patch_request(path, options = {})
       HTTParty.patch(
-        "#{@url}/api/rest/v1#{path}",
+        build_url(path),
+        options.merge(headers: default_request_headers)
+      )
+    end
+
+    def post_request(path, options = {})
+      HTTParty.post(
+        build_url(path),
         options.merge(headers: default_request_headers)
       )
     end
 
+    def patch_for_collection_request(path, options = {})
+      HTTParty.patch(
+        build_url(path),
+        options.merge(headers: collection_request_headers)
+      )
+    end
+
     def pagination_param
       "pagination_type=#{DEFAULT_PAGINATION_TYPE}"
     end
@@ -63,7 +100,17 @@ module Akeneo
       return unless response.success?
 
       url = response.parsed_response.dig('_links', 'next', 'href')
-      url.to_s.split('/api/rest/v1').last
+      url.to_s.split("/api/rest/#{API_VERSION}").last
+    end
+
+    def build_url(path)
+      "#{@url}/api/rest/#{API_VERSION}#{escape_path(path)}"
+    end
+
+    def escape_path(path)
+      return if path.nil?
+
+      path.to_s.gsub(' ', '%20')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akeneo
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.8.0
 platform: ruby
 authors:
 - AWN Dev Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -70,16 +70,16 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API client for accessing Akeneo