plenty_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ff37ac81ad08b66efcf7d3bf22de8bd7c044f63e9075049cfa12e48e79e67d
-  data.tar.gz: 32bcc7518200db454ff6723807e4f895669a6a96bbc3855376a90b2af23aa965
+  metadata.gz: 468471d1063a081184202e28692e3b8f6f2a8f99011cbcd52ad11dcc57a2dff3
+  data.tar.gz: 8b3dfd65b46808a089ec788576d9d1d0db196148d032d6c977e3f53d27f03ffb
 SHA512:
-  metadata.gz: a544191236f9de2a8ea7b57e50015e73ade83a0fde9225844a71308439151ffb9121dd1681fbe8fe4616f130c008f3e10057bcd2f3e348cf0c823bb6167a6297
-  data.tar.gz: 1b02c33c9ca78d69435186cccf3851c4e2cc02d75cd9d66a83c6a6d9685d0b68e85afbcf516e26b9f7a217a061daf24e63fa25840365f16a281414159316a583
+  metadata.gz: 40c8107ab4b4e6d46f5fff6bcaa008e7c587f875955e8cd42977d8e8f313d833791a57d48f4dcf0c04d509eabebed3221ce9acdb0cffd52804a7fab31118f6ce
+  data.tar.gz: d13f2f3ac98937ade8439d9fac70374869c831f4675cbc1b51cd86b98edfe90c8e20e9c158199be84207a4963dede77cb39efb16abf968ec29b9fe4afb567941

data/lib/plenty_client/concerns/rest_routes.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Quickly extends boilerplate paths that comply with the schema:
+# POST BASE_PATH => create
+# GET BASE_PATH/:id => find
+# PUT BASE_PATH/:id => update
+# DELETE BASE_PATH/:id => destroy
+# You can undefine unnecessary methods by adding a call to
+# #skip_rest_routes in the class body:
+# class Someclass
+#   skip_rest_routes :find, :destroy
+# end
+
+# Usage:
+# Extend this module in your class/module and define `self.base_path`
+# Do keep in mind that this method should be private or protected.
+#
+# class Someclass
+#   extend PlentyClient::Concerns::RestRoutes
+#
+#   # method definition returns method name as a Symbol
+#   private_class_method def self.base_path
+#     '/my_base_path'
+#   end
+#
+#   # or
+#   def self.base_path
+#     '/my_base_path'
+#   end
+#   private_class_method :base_path
+#
+#   # or
+#   class << self
+#     private
+#
+#     def base_path
+#       '/my_base_path'
+#     end
+#   end
+# end
+
+module PlentyClient
+  module Concerns
+    module RestRoutes
+      # Undefines class methods in modules/classes extending this module.
+      # You don't have to do it if you overload the method explicitly.
+      def skip_rest_routes(*paths)
+        instance_exec(paths) do |p|
+          p.each { |mn| undef :"#{mn}" }
+        end
+      end
+
+      def create(headers = {}, &block)
+        post(base_path, headers, &block)
+      end
+
+      def list(headers = {}, &block)
+        get(base_path, headers, &block)
+      end
+
+      def find(id, headers = {}, &block)
+        get(single_path(id), headers, &block)
+      end
+
+      def update(id, headers = {}, &block)
+        put(single_path(id), headers, &block)
+      end
+
+      def destroy(id, headers = {}, &block)
+        delete(single_path(id), headers, &block)
+      end
+
+      private
+
+      def single_path(id)
+        base_path + "/#{id}"
+      end
+    end
+  end
+end

data/lib/plenty_client/listing/market/history.rb

@@ -7,11 +7,12 @@ module PlentyClient
         include PlentyClient::Endpoint
         include PlentyClient::Request
 
-        FIND_LISTING_MARKET_HISTORY   = '/listings/markets/histories/{marketListingHistoryId}'
-        LIST_LISTING_MARKET_HISTORIES = '/listings/markets/histories'
-        END_LISTING_MARKET_HISTORY    = '/listings/markets/histories/end/{marketListingHistoryId}'
-        RELIST_LISTING_MARKET_HISTORY = '/listings/markets/histories/relist/{marketListingHistoryId}'
-        UPDATE_LISTING_MARKET_HISTORY = '/listings/markets/histories/update/{marketListingHistoryId}'
+        FIND_LISTING_MARKET_HISTORY     = '/listings/markets/histories/{marketListingHistoryId}'
+        LIST_LISTING_MARKET_HISTORIES   = '/listings/markets/histories'
+        END_LISTING_MARKET_HISTORY      = '/listings/markets/histories/end/{marketListingHistoryId}'
+        RELIST_LISTING_MARKET_HISTORY   = '/listings/markets/histories/relist/{marketListingHistoryId}'
+        UPDATE_LISTING_MARKET_HISTORY   = '/listings/markets/histories/update/{marketListingHistoryId}'
+        UPDATE_LISTING_MARKET_HISTORIES = '/listings/markets/histories/update'
 
         class << self
           def find(market_listing_history_id, headers = {}, &block)
@@ -34,6 +35,10 @@ module PlentyClient
           def update(market_listing_history_id, body = {})
             put(build_endpoint(UPDATE_LISTING_MARKET_HISTORY, market_listing_history: market_listing_history_id), body)
           end
+
+          def update_many(body = {})
+            put(build_endpoint(UPDATE_LISTING_MARKET_HISTORIES), body)
+          end
         end
       end
     end

data/lib/plenty_client/request.rb

@@ -14,8 +14,11 @@ module PlentyClient
 
         attempts = PlentyClient::Config.attempt_count
         attempts.times do
-          response = perform(http_method, path, params)
-          return response if response
+          begin
+            response = perform(http_method, path, params)
+            return response if response
+          rescue Faraday::ConnectionFailed => e
+          end
         end
         raise PlentyClient::AttemptsExceeded, "unable to get valid response after #{attempts} attempts"
       end

data/lib/plenty_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlentyClient
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/plenty_client/warehouse/location/dimension.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# PlentyClient::Warehouse::Location::Dimension
+module PlentyClient
+  module Warehouse
+    module Location
+      module Dimension
+        include PlentyClient::Request
+        extend PlentyClient::Concerns::RestRoutes
+
+        LIST_URL = '/warehouses/%<warehouse_id>d/locations/dimensions'
+
+        class << self
+          def list(warehouse_id, body = {}, &block)
+            get(format(LIST_URL, warehouse_id: warehouse_id), body, &block)
+          end
+
+          private
+
+          def base_path
+            '/warehouses/locations/dimensions'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plenty_client/warehouse/location/level.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# PlentyClient::Warehouse::Location::Level
+module PlentyClient
+  module Warehouse
+    module Location
+      module Level
+        include PlentyClient::Request
+        extend PlentyClient::Concerns::RestRoutes
+
+        LIST_URL = '/warehouses/%<warehouse_id>d/locations/levels'
+
+        class << self
+          def list(warehouse_id, body = {}, &block)
+            get(format(LIST_URL, warehouse_id: warehouse_id), body, &block)
+          end
+
+          private
+
+          def base_path
+            '/warehouses/locations/levels'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plenty_client/warehouse/location.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# PlentyClient::Warehouse::Location
+module PlentyClient
+  module Warehouse
+    module Location
+      include PlentyClient::Request
+      extend PlentyClient::Concerns::RestRoutes
+
+      LIST_URL = '/warehouses/%<warehouse_id>d/locations'
+
+      class << self
+        def list(warehouse_id, body = {}, &block)
+          get(format(LIST_URL, warehouse_id: warehouse_id), body, &block)
+        end
+
+        private
+
+        def base_path
+          '/warehouses/locations'
+        end
+      end
+    end
+  end
+end

data/lib/plenty_client/warehouse.rb

@@ -2,25 +2,13 @@
 
 module PlentyClient
   module Warehouse
-    include PlentyClient::Endpoint
     include PlentyClient::Request
+    extend PlentyClient::Concerns::RestRoutes
 
-    LIST_WAREHOUSES  = '/stockmanagement/warehouses'
-    FIND_WAREHOUSE   = '/stockmanagement/warehouses/{warehouseId}'
-    CREATE_WAREHOUSE = '/stockmanagement/warehouses'
+    skip_rest_routes :update, :destroy
 
-    class << self
-      def list(headers = {}, &block)
-        get(build_endpoint(LIST_WAREHOUSES), headers, &block)
-      end
-
-      def find(warehouse_id, headers = {}, &block)
-        get(build_endpoint(FIND_WAREHOUSE, warehouse: warehouse_id), headers, &block)
-      end
-
-      def create(body = {})
-        post(build_endpoint(CREATE_WAREHOUSE), body)
-      end
+    private_class_method def self.base_path
+      '/stockmanagement/warehouses'
     end
   end
 end

data/lib/plenty_client.rb

@@ -29,6 +29,10 @@ module PlentyClient
   autoload :Warehouse,      'plenty_client/warehouse'
   autoload :Webstore,       'plenty_client/webstore'
 
+  module Concerns
+    autoload :RestRoutes, 'plenty_client/concerns/rest_routes'
+  end
+
   module Account
     autoload :Contact, 'plenty_client/account/contact'
     autoload :Address, 'plenty_client/account/address'
@@ -200,11 +204,11 @@ module PlentyClient
   module Warehouse
     autoload :Stock,      'plenty_client/warehouse/stock'
     autoload :Management, 'plenty_client/warehouse/management'
+    autoload :Location,   'plenty_client/warehouse/location'
 
-    module Management
-      autoload :Rack,             'plenty_client/warehouse/management/rack'
-      autoload :Shelf,            'plenty_client/warehouse/management/shelf'
-      autoload :StorageLocation,  'plenty_client/warehouse/management/storage_location'
+    module Location
+      autoload :Dimension,  'plenty_client/warehouse/location/dimension'
+      autoload :Level,      'plenty_client/warehouse/location/level'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plenty_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dariusch Ochlast
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,6 +183,7 @@ files:
 - lib/plenty_client/category/branch.rb
 - lib/plenty_client/category/template.rb
 - lib/plenty_client/comment.rb
+- lib/plenty_client/concerns/rest_routes.rb
 - lib/plenty_client/config.rb
 - lib/plenty_client/constants.rb
 - lib/plenty_client/document.rb
@@ -289,10 +290,10 @@ files:
 - lib/plenty_client/ticket.rb
 - lib/plenty_client/version.rb
 - lib/plenty_client/warehouse.rb
+- lib/plenty_client/warehouse/location.rb
+- lib/plenty_client/warehouse/location/dimension.rb
+- lib/plenty_client/warehouse/location/level.rb
 - lib/plenty_client/warehouse/management.rb
-- lib/plenty_client/warehouse/management/rack.rb
-- lib/plenty_client/warehouse/management/shelf.rb
-- lib/plenty_client/warehouse/management/storage_location.rb
 - lib/plenty_client/warehouse/stock.rb
 - lib/plenty_client/webstore.rb
 - plenty_client.gemspec

data/lib/plenty_client/warehouse/management/rack.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module PlentyClient
-  module Warehouse
-    module Management
-      class Rack
-        include PlentyClient::Endpoint
-        include PlentyClient::Request
-
-        WM_WAREHOUSE_MGMT_BASE_PATH = '/stockmanagement/warehouses/{warehouseId}/management'
-
-        WM_LIST_RACKS     = '/racks'
-        WM_FIND_RACKS     = '/racks/{rackId}'
-        WM_CREATE_RACK    = '/racks'
-
-        class << self
-          def list(warehouse_id, headers = {}, &block)
-            get(build_endpoint("#{WM_WAREHOUSE_MGMT_BASE_PATH}#{WM_LIST_RACKS}",
-                               warehouse: warehouse_id),
-                headers, &block)
-          end
-
-          def find(warehouse_id, rack_id, headers = {}, &block)
-            get(build_endpoint("#{WM_WAREHOUSE_MGMT_BASE_PATH}#{WM_FIND_RACKS}",
-                               warehouse: warehouse_id,
-                               rack: rack_id),
-                headers, &block)
-          end
-
-          def create(warehouse_id, body = {})
-            post(build_endpoint("#{WM_WAREHOUSE_MGMT_BASE_PATH}#{WM_CREATE_RACK}", warehouse: warehouse_id), body)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/plenty_client/warehouse/management/shelf.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module PlentyClient
-  module Warehouse
-    module Management
-      class Shelf
-        include PlentyClient::Endpoint
-        include PlentyClient::Request
-
-        WM_WAREHOUSE_MGMT_BASE_PATH = '/stockmanagement/warehouses/{warehouseId}/management'
-
-        WM_LIST_SHELF   = '/racks/{rackId}/shelves'
-        WM_FIND_SHELF   = '/racks/{rackId}/shelves/{shelfId}'
-        WM_CREATE_SHELF = '/racks/{rackId}/shelves'
-
-        class << self
-          def list(warehouse_id, rack_id, headers = {}, &block)
-            get(build_endpoint("#{WM_WAREHOUSE_MGMT_BASE_PATH}#{WM_LIST_SHELF}",
-                                warehouse: warehouse_id, rack: rack_id),
-                 headers, &block)
-          end
-
-          def find(warehouse_id, rack_id, shelf_id, headers = {}, &block)
-            get(build_endpoint("#{WM_WAREHOUSE_MGMT_BASE_PATH}#{WM_FIND_SHELF}",
-                               warehouse: warehouse_id,
-                               rack: rack_id,
-                               shelf: shelf_id),
-                headers, &block)
-          end
-
-          def create(warehouse_id, rack_id, body = {})
-            post(build_endpoint("#{WM_WAREHOUSE_MGMT_BASE_PATH}#{WM_CREATE_SHELF}",
-                                warehouse: warehouse_id, rack: rack_id),
-                 body)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/plenty_client/warehouse/management/storage_location.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module PlentyClient
-  module Warehouse
-    module Management
-      class StorageLocation
-        include PlentyClient::Endpoint
-        include PlentyClient::Request
-
-        WM_STORAGE_LOCATION_BASE_PATH = '/stockmanagement/warehouses/{warehouseId}/management'
-        WM_SL_LIST_STORAGE_LOCATIONS  = '/racks/{rackId}/shelves/{shelfId}/storageLocations'
-        WM_SL_FIND_STORAGE_LOCATIONS  = '/racks/{rackId}/shelves/{shelfId}/storageLocations/{storageLocationId}'
-        WM_SL_CREATE_STORAGE_LOCATION = '/racks/{rackId}/shelves/{shelfId}/storageLocations'
-
-        class << self
-          def list(warehouse_id, rack_id, shelf_id, headers = {}, &block)
-            get(build_endpoint("#{WM_STORAGE_LOCATION_BASE_PATH}#{WM_SL_LIST_STORAGE_LOCATIONS}",
-                               warehouse: warehouse_id,
-                               rack: rack_id,
-                               shelf: shelf_id),
-                headers, &block)
-          end
-
-          def find(warehouse_id, rack_id, shelf_id, storage_location_id, headers = {}, &block)
-            get(build_endpoint("#{WM_STORAGE_LOCATION_BASE_PATH}#{WM_SL_FIND_STORAGE_LOCATIONS}",
-                               warehouse: warehouse_id,
-                               rack: rack_id,
-                               shelf: shelf_id,
-                               storage_location: storage_location_id),
-                headers, &block)
-          end
-
-          def create(warehouse_id, rack_id, shelf_id, body = {})
-            post(build_endpoint("#{WM_STORAGE_LOCATION_BASE_PATH}#{WM_SL_CREATE_STORAGE_LOCATION}",
-                                warehouse: warehouse_id,
-                                rack: rack_id,
-                                shelf: shelf_id),
-                 body)
-          end
-        end
-      end
-    end
-  end
-end